Changeset 3

Timestamp:

10/07/08 11:12:56 (3 years ago)

Author:

blundeln

Message:

Tidied up the code a bit. I thought that, since its now under illuminate's new version control system, I'd better
write nicer code ;)

Files:

• drupal/modules/simple_maps/trunk/TODO (modified) (1 diff)
• drupal/modules/simple_maps/trunk/simple_maps.info (modified) (1 diff)
• drupal/modules/simple_maps/trunk/simple_maps.module (modified) (6 diffs)

drupal/modules/simple_maps/trunk/TODO

@@ -1 @@
-
-
+

drupal/modules/simple_maps/trunk/simple_maps.info

@@ -1 +1 @@
-name = Simple Maps
-
+  Simply add an address and/or postcode CCK field to any node and it will be geocoded when saved.
-package = IlluminateICT
-dependencies = gmap
-.
+-

drupal/modules/simple_maps/trunk/simple_maps.module

@@ -1 +1 @@
-<?php
-
+
+
+
+
+
+
+
+
+
+
-define(PROXIMITY_THRESHOLD, 0.0565);
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function simple_maps_menu($may_cache) {
-  $items = array();
@@ -37 +64 @@
-}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-function simple_maps_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
-
@@ -173 +76 @@
-}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function view_map($viewName=Null) {
-  $output = "";
@@ -234 +108 @@
-}
-
-
-
-
-
+
+
-function test_page() {
-  $testAddress = "CVSC<br/> 6th floor<br> market way, coventry</p> cv1 1ea";
@@ -272 +144 @@
-}
-
+
+/*
+ * ===============================
+ * MAIN FUNCTIONS
+ * ===============================
+ */
+
+/* Looks at permutations of the address and postcode to try to improve accuracy of google api. */
+function _smart_geocode($address, $areaCode=Null) {
+  
+  // Get area code (eg. postcode).
+  $areaLoc = gmap_geocode($areaCode);
+  $areaLoc = _validateUKLocation($areaLoc);
+  $addressLoc = Null;
+  
+  // Normalise address into lines.
+  $nAddress = _normaliseAddress($address);
+  $addressLines = split("[\n]+", $nAddress);
+  //d("addressLines", $addressLines, True);
+
+
+  /* Sometimes the postcode throws google api off, so if we have an explicit postcode, remove it from address. */
+  //if (preg_match('/^[0-9]*$/i', $addressLines[count($addressLines)-1])) {
+  //  $addressLines[count($addressLines)-1] = "";
+  //}
+
+  /* Google doesn't like the things at the top of address (e.g. company name, building), so prune it down, line-by-line. */
+  while ($addressLines) {
+    
+    /* Create comma seperated part-address */
+    $partAddress = implode(", ", $addressLines);
+
+    /* Do a lookup */
+    $partLoc = gmap_geocode($partAddress);
+    $partLoc = _validateUKLocation($partLoc);
+
+    if ($partLoc["status"] != 200) {
+      // pass: google could not find it.
+    } else {
+      /*  If we have a postcode, use it as a reference point for finding more accurate location nearby. */
+      if ($areaLoc) {
+        $dist = _location_dist($areaLoc, $partLoc);
+      } else {
+        $dist = PROXIMITY_THRESHOLD * 0.5;
+      }
+
+      if ($dist < PROXIMITY_THRESHOLD) {
+        if ($addressLoc) {
+          if ($partLoc["accuracy"] > $addressLoc["accuracy"]) {
+            $addressLoc = $partLoc;
+          }
+        } else {
+          $addressLoc = $partLoc;
+        }
+      }
+    } 
+
+    //d("partAddress $partAddress", $partLoc, True);
+    /* Prune a line from the top of the address. */
+    array_shift($addressLines);
+  }
+  
+  // Return the most accurate location.
+  if ($addressLoc and !$areaLoc) {
+    return $addressLoc;
+  } else if ($areaLoc and !$addressLoc) {
+    return $areaLoc;
+  } else if ($addressLoc and $areaLoc) {
+    if ($addressLoc["accuracy"] > $areaLoc["accuracy"]) {
+      return $addressLoc;
+    } else {
+      return $areaLoc;
+    }
+  }
+
+  return Null;
+}
+
+/* This automatically tries to find a location for a node, based on a CCK field called 'address' or on a 'postcode' field. */
+function _set_node_geocode(&$node) {
+  
+  $addressField = variable_get("simplemap.addressfield", "field_address");
+  eval("\$address = \$node->".$addressField."[0]['value'];");
+
+  // Try to find a postcode cck field.
+  $postcode = $node->field_postcode[0]["value"];
+
+  /* If no address info could be find, remove the location var for this node - if there was one. */
+  if (!$address and !$postcode) {
+    variable_del("simplemap.nloc-$node->nid");
+    return;
+  }
+  
+  // Do geocode lookup.
+  $location = _smart_geocode($address, $postcode);
+  //d("lookup of $address/$postcode", $location);
+
+  /* If the lookcup failed, unset the location info for this node. */
+  if ($location["status"] != "200") {
+    variable_del("simplemap.nloc-$node->nid");
+    return;
+  }
+   
+  /* Store the location info for this node. */
+  variable_set("simplemap.nloc-$node->nid", $location);
+  drupal_set_message("The geographic location of '$node->title' has been found and set.");
+}
+
+
+/* Gets the location of this node, if there is one. */
+function _get_node_location($nid) {
+  // Gets the geographic location of a node with nid.
+  return variable_get("simplemap.nloc-$nid", Null);
+}
+
+
+
+/*
+ * ===============================
+ * UTILITY FUNCTIONS
+ * ===============================
+ */
+
+
+/* Normalises an geographical address so that it has newlines for easier parsing. */
+function _normaliseAddress($address) {
+  $nAddress = strtolower($address);
+  
+  if (stristr($nAddress, "<br/>")) { $nAddress = str_replace("<br/>", "\n", $nAddress); }
+  if (stristr($nAddress, "<br>")) { $nAddress = str_replace("<br>", "\n", $nAddress); }
+  if (stristr($nAddress, "</p>")) { $nAddress = str_replace("</p>", "\n", $nAddress); }
+  if (stristr($nAddress, ",")) { $nAddress = str_replace(",", "\n", $nAddress); }
+
+  //d("nAddress: $nAddress",Null, True);
+  return $nAddress;
+}
+
+
+/* Sanity check that a location lies in or around the UK. */
+function _validateUKLocation($loc) {
+  
+  if ($loc["status"] != 200) {
+    return Null;
+  }
+
+  if ($loc["latitude"] > 62.0 or $loc["latitude"] < 50.0) {
+    return Null;
+  }
+
+  if ($loc["longitude"] < -12.0 or $loc["longitude"] > 4.0) {
+    return Null;
+  }
+
+  return $loc;
+}
+
+
+/* Given a view, returns a list of gmap markers of node locations in the view. */
+function _get_markers($view) {
+ 
+  global $base_url;
+
+  $markers = array();
+  $viewResults = views_build_view('items', $view, Null, false, $view->nodes_per_block);
+  foreach ($viewResults['items'] as $i => $item) {
+    //d("item",$item);
+    $location = _get_node_location($item->nid);
+    //$location = _smart_geocode("Warwickshire Association of Youth Clubs Jubilee House, Westlea Road Leamington Spa, CV31 3JE");
+    //$location = _smart_geocode("Westlea Road Leamington Spa CV31 3JE");
+    //$location = _smart_geocode("CV31 3JE");
+    if (!$location) {
+      d("$item->node_title as no location");
+      continue;
+    }
+   
+    $url = "$base_url/node/$item->nid";
+
+    $markers[] = array(
+      'latitude' => $location["latitude"],
+      'longitude' => $location["longitude"],
+      'markername' => "",
+      'text' => "<a href='$url'>".$item->node_title."</a>",
+      'offset' => 0,
+    );
+  }
+
+  //d("markers",$markers);
+  return $markers;
+}
+
+/* Renders a gmap to diaply the specified markers. */
+function _render_map($markers=Null) {
+  $output = "";
+  $map = gmap_defaults();
+  
+  if ($markers) {
+    $map["markers"] = $markers;
+  }
+  //d("",$map);
+  $output .= theme('gmap', array('#settings' => $map));
+
+  return $output;
+}
+
+/* Calculates the distance between two locations. */
+function _location_dist($loc1, $loc2) {
+  return sqrt(pow($loc2["latitude"] - $loc1["latitude"], 2) + pow($loc2["longitude"] - $loc1["longitude"], 2));
+}
+
+/* Update the locations of all nodes in the site - for debug really. */
-function _update_locations() {
-  $results = db_query('SELECT nid FROM {node}');
@@ -281 +363 @@
-}
-
-function simple_maps_init() {
-  cache_clear_all('*', 'cache_menu', TRUE);
-  //_tests();
-  //_update_locations();
-}
-
-?>