class GeonamesPlugin extends Plugin
{
- const NAMESPACE = 1;
+ const LOCATION_NS = 1;
+
+ public $host = 'ws.geonames.org';
+ public $username = null;
+ public $token = null;
+ public $expiry = 7776000; // 90-day expiry
/**
* convert a name into a Location object
function onLocationFromName($name, $language, &$location)
{
- $client = HTTPClient::start();
+ $loc = $this->getCache(array('name' => $name,
+ 'language' => $language));
- // XXX: break down a name by commas, narrow by each
+ if ($loc !== false) {
+ $location = $loc;
+ return false;
+ }
- $str = http_build_query(array('maxRows' => 1,
- 'q' => $name,
- 'lang' => $language,
- 'type' => 'json'));
+ try {
+ $geonames = $this->getGeonames('search',
+ array('maxRows' => 1,
+ 'q' => $name,
+ 'lang' => $language,
+ 'type' => 'xml'));
+ } catch (Exception $e) {
+ $this->log(LOG_WARNING, "Error for $name: " . $e->getMessage());
+ return true;
+ }
- $result = $client->get('http://ws.geonames.org/search?'.$str);
+ if (count($geonames) == 0) {
+ // no results
+ $this->setCache(array('name' => $name,
+ 'language' => $language),
+ null);
+ return true;
+ }
- if ($result->code == "200") {
- $rj = json_decode($result->body);
- if (count($rj->geonames) > 0) {
- $n = $rj->geonames[0];
+ $n = $geonames[0];
- $location = new Location();
+ $location = new Location();
- $location->lat = $n->lat;
- $location->lon = $n->lng;
- $location->names[$language] = $n->name;
- $location->location_id = $n->geonameId;
- $location->location_ns = self::NAMESPACE;
+ $location->lat = $this->canonical($n->lat);
+ $location->lon = $this->canonical($n->lng);
+ $location->names[$language] = (string)$n->name;
+ $location->location_id = (string)$n->geonameId;
+ $location->location_ns = self::LOCATION_NS;
- // handled, don't continue processing!
- return false;
- }
- }
+ $this->setCache(array('name' => $name,
+ 'language' => $language),
+ $location);
- // Continue processing; we don't have the answer
- return true;
+ // handled, don't continue processing!
+ return false;
}
/**
function onLocationFromId($id, $ns, $language, &$location)
{
- if ($ns != self::NAMESPACE) {
+ if ($ns != self::LOCATION_NS) {
// It's not one of our IDs... keep processing
return true;
}
- $client = HTTPClient::start();
-
- $str = http_build_query(array('geonameId' => $id,
- 'lang' => $language));
+ $loc = $this->getCache(array('id' => $id));
- $result = $client->get('http://ws.geonames.org/hierarchyJSON?'.$str);
+ if ($loc !== false) {
+ $location = $loc;
+ return false;
+ }
- if ($result->code == "200") {
+ try {
+ $geonames = $this->getGeonames('hierarchy',
+ array('geonameId' => $id,
+ 'lang' => $language));
+ } catch (Exception $e) {
+ $this->log(LOG_WARNING, "Error for ID $id: " . $e->getMessage());
+ return false;
+ }
- $rj = json_decode($result->body);
+ $parts = array();
- if (count($rj->geonames) > 0) {
+ foreach ($geonames as $level) {
+ if (in_array($level->fcode, array('PCLI', 'ADM1', 'PPL'))) {
+ $parts[] = (string)$level->name;
+ }
+ }
- $parts = array();
+ $last = $geonames[count($geonames)-1];
- foreach ($rj->geonames as $level) {
- if (in_array($level->fcode, array('PCLI', 'ADM1', 'PPL'))) {
- $parts[] = $level->name;
- }
- }
+ if (!in_array($level->fcode, array('PCLI', 'ADM1', 'PPL'))) {
+ $parts[] = (string)$last->name;
+ }
- $last = $rj->geonames[count($rj->geonames)-1];
+ $location = new Location();
- if (!in_array($level->fcode, array('PCLI', 'ADM1', 'PPL'))) {
- $parts[] = $last->name;
- }
+ $location->location_id = (string)$last->geonameId;
+ $location->location_ns = self::LOCATION_NS;
+ $location->lat = $this->canonical($last->lat);
+ $location->lon = $this->canonical($last->lng);
- $location = new Location();
+ $location->names[$language] = implode(', ', array_reverse($parts));
- $location->location_id = $last->geonameId;
- $location->location_ns = self::NAMESPACE;
- $location->lat = $last->lat;
- $location->lon = $last->lng;
- $location->names[$language] = implode(', ', array_reverse($parts));
- }
- }
+ $this->setCache(array('id' => (string)$last->geonameId),
+ $location);
- // We're responsible for this NAMESPACE; nobody else
+ // We're responsible for this namespace; nobody else
// can resolve it
return false;
function onLocationFromLatLon($lat, $lon, $language, &$location)
{
- $client = HTTPClient::start();
-
- $str = http_build_query(array('lat' => $lat,
- 'lng' => $lon,
- 'lang' => $language));
+ // Make sure they're canonical
- $result =
- $client->get('http://ws.geonames.org/findNearbyPlaceNameJSON?'.$str);
+ $lat = $this->canonical($lat);
+ $lon = $this->canonical($lon);
- if ($result->code == "200") {
+ $loc = $this->getCache(array('lat' => $lat,
+ 'lon' => $lon));
- $rj = json_decode($result->body);
+ if ($loc !== false) {
+ $location = $loc;
+ return false;
+ }
- if (count($rj->geonames) > 0) {
+ try {
+ $geonames = $this->getGeonames('findNearbyPlaceName',
+ array('lat' => $lat,
+ 'lng' => $lon,
+ 'lang' => $language));
+ } catch (Exception $e) {
+ $this->log(LOG_WARNING, "Error for coords $lat, $lon: " . $e->getMessage());
+ return true;
+ }
- $n = $rj->geonames[0];
+ if (count($geonames) == 0) {
+ // no results
+ $this->setCache(array('lat' => $lat,
+ 'lon' => $lon),
+ null);
+ return true;
+ }
- $parts = array();
+ $n = $geonames[0];
- $location = new Location();
+ $parts = array();
- $parts[] = $n->name;
+ $location = new Location();
- if (!empty($n->adminName1)) {
- $parts[] = $n->adminName1;
- }
+ $parts[] = (string)$n->name;
- if (!empty($n->countryName)) {
- $parts[] = $n->countryName;
- }
+ if (!empty($n->adminName1)) {
+ $parts[] = (string)$n->adminName1;
+ }
- $location->location_id = $n->geonameId;
- $location->location_ns = self::NAMESPACE;
- $location->lat = $lat;
- $location->lon = $lon;
+ if (!empty($n->countryName)) {
+ $parts[] = (string)$n->countryName;
+ }
- $location->names[$language] = implode(', ', $parts);
+ $location->location_id = (string)$n->geonameId;
+ $location->location_ns = self::LOCATION_NS;
+ $location->lat = $this->canonical($n->lat);
+ $location->lon = $this->canonical($n->lng);
- // Success! We handled it, so no further processing
+ $location->names[$language] = implode(', ', $parts);
- return false;
- }
- }
+ $this->setCache(array('lat' => $lat,
+ 'lon' => $lon),
+ $location);
- // For some reason we don't know, so pass.
+ // Success! We handled it, so no further processing
- return true;
+ return false;
}
/**
function onLocationNameLanguage($location, $language, &$name)
{
- if ($location->location_ns != self::NAMESPACE) {
+ if ($location->location_ns != self::LOCATION_NS) {
// It's not one of our IDs... keep processing
return true;
}
+ $id = $location->location_id;
+
+ $n = $this->getCache(array('id' => $id,
+ 'language' => $language));
+
+ if ($n !== false) {
+ $name = $n;
+ return false;
+ }
+
+ try {
+ $geonames = $this->getGeonames('hierarchy',
+ array('geonameId' => $id,
+ 'lang' => $language));
+ } catch (Exception $e) {
+ $this->log(LOG_WARNING, "Error for ID $id: " . $e->getMessage());
+ return false;
+ }
+
+ if (count($geonames) == 0) {
+ $this->setCache(array('id' => $id,
+ 'language' => $language),
+ null);
+ return false;
+ }
+
+ $parts = array();
+
+ foreach ($geonames as $level) {
+ if (in_array($level->fcode, array('PCLI', 'ADM1', 'PPL'))) {
+ $parts[] = (string)$level->name;
+ }
+ }
+
+ $last = $geonames[count($geonames)-1];
+
+ if (!in_array($level->fcode, array('PCLI', 'ADM1', 'PPL'))) {
+ $parts[] = (string)$last->name;
+ }
+
+ if (count($parts)) {
+ $name = implode(', ', array_reverse($parts));
+ $this->setCache(array('id' => $id,
+ 'language' => $language),
+ $name);
+ }
+
+ return false;
+ }
+
+ /**
+ * Human-readable URL for a location
+ *
+ * Given a location, we try to retrieve a geonames.org URL.
+ *
+ * @param Location $location Location to get the url for
+ * @param string &$url Place to put the url
+ *
+ * @return boolean whether to continue
+ */
+
+ function onLocationUrl($location, &$url)
+ {
+ if ($location->location_ns != self::LOCATION_NS) {
+ // It's not one of our IDs... keep processing
+ return true;
+ }
+
+ $url = 'http://www.geonames.org/' . $location->location_id;
+
+ // it's been filled, so don't process further.
+ return false;
+ }
+
+ /**
+ * Machine-readable name for a location
+ *
+ * Given a location, we try to retrieve a geonames.org URL.
+ *
+ * @param Location $location Location to get the url for
+ * @param string &$url Place to put the url
+ *
+ * @return boolean whether to continue
+ */
+
+ function onLocationRdfUrl($location, &$url)
+ {
+ if ($location->location_ns != self::LOCATION_NS) {
+ // It's not one of our IDs... keep processing
+ return true;
+ }
+
+ $url = 'http://sw.geonames.org/' . $location->location_id . '/';
+
+ // it's been filled, so don't process further.
+ return false;
+ }
+
+ function getCache($attrs)
+ {
+ $c = common_memcache();
+
+ if (empty($c)) {
+ return null;
+ }
+
+ $key = $this->cacheKey($attrs);
+
+ $value = $c->get($key);
+
+ return $value;
+ }
+
+ function setCache($attrs, $loc)
+ {
+ $c = common_memcache();
+
+ if (empty($c)) {
+ return null;
+ }
+
+ $key = $this->cacheKey($attrs);
+
+ $result = $c->set($key, $loc, 0, time() + $this->expiry);
+
+ return $result;
+ }
+
+ function cacheKey($attrs)
+ {
+ return common_cache_key('geonames:'.
+ implode(',', array_keys($attrs)) . ':'.
+ common_keyize(implode(',', array_values($attrs))));
+ }
+
+ function wsUrl($method, $params)
+ {
+ if (!empty($this->username)) {
+ $params['username'] = $this->username;
+ }
+
+ if (!empty($this->token)) {
+ $params['token'] = $this->token;
+ }
+
+ $str = http_build_query($params, null, '&');
+
+ return 'http://'.$this->host.'/'.$method.'?'.$str;
+ }
+
+ function getGeonames($method, $params)
+ {
$client = HTTPClient::start();
- $str = http_build_query(array('geonameId' => $id,
- 'lang' => $language));
+ $result = $client->get($this->wsUrl($method, $params));
- $result = $client->get('http://ws.geonames.org/hierarchyJSON?'.$str);
+ if (!$result->isOk()) {
+ throw new Exception("HTTP error code " . $result->code);
+ }
- if ($result->code == "200") {
+ $body = $result->getBody();
- $rj = json_decode($result->body);
+ if (empty($body)) {
+ throw new Exception("Empty HTTP body in response");
+ }
- if (count($rj->geonames) > 0) {
+ // This will throw an exception if the XML is mal-formed
- $parts = array();
+ $document = new SimpleXMLElement($body);
- foreach ($rj->geonames as $level) {
- if (in_array($level->fcode, array('PCLI', 'ADM1', 'PPL'))) {
- $parts[] = $level->name;
- }
- }
+ // No children, usually no results
- $last = $rj->geonames[count($rj->geonames)-1];
+ $children = $document->children();
- if (!in_array($level->fcode, array('PCLI', 'ADM1', 'PPL'))) {
- $parts[] = $last->name;
- }
+ if (count($children) == 0) {
+ return array();
+ }
- if (count($parts)) {
- $name = implode(', ', array_reverse($parts));
- return false;
- }
- }
+ if (isset($document->status)) {
+ throw new Exception("Error #".$document->status['value']." ('".$document->status['message']."')");
}
+ // Array of elements, >0 elements
+
+ return $document->geoname;
+ }
+
+ function onPluginVersion(&$versions)
+ {
+ $versions[] = array('name' => 'Geonames',
+ 'version' => STATUSNET_VERSION,
+ 'author' => 'Evan Prodromou',
+ 'homepage' => 'http://status.net/wiki/Plugin:Geonames',
+ 'rawdescription' =>
+ _m('Uses <a href="http://geonames.org/">Geonames</a> service to get human-readable '.
+ 'names for locations based on user-provided lat/long pairs.'));
return true;
}
+
+ function canonical($coord)
+ {
+ $coord = rtrim($coord, "0");
+ $coord = rtrim($coord, ".");
+
+ return $coord;
+ }
}
projects / quix0rs-gnu-social.git / blobdiff