public $username = null;
public $token = null;
public $expiry = 7776000; // 90-day expiry
+ public $timeout = 2; // Web service timeout in seconds.
+ public $timeoutWindow = 60; // Further lookups in this process will be disabled for N seconds after a timeout.
+ public $cachePrefix = null; // Optional shared memcache prefix override
+ // to share lookups between local instances.
+
+ protected $lastTimeout = null; // timestamp of last web service timeout
/**
* convert a name into a Location object
$loc = $this->getCache(array('name' => $name,
'language' => $language));
- if (!empty($loc)) {
+ if ($loc !== false) {
$location = $loc;
return false;
}
- $client = HTTPClient::start();
-
- // XXX: break down a name by commas, narrow by each
-
- $result = $client->get($this->wsUrl('search',
- array('maxRows' => 1,
- 'q' => $name,
- 'lang' => $language,
- 'type' => 'json')));
-
- if (!$result->isOk()) {
- $this->log(LOG_WARNING, "Error code " . $result->code .
- " from " . $this->host . " for $name");
+ 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;
}
- $rj = json_decode($result->getBody());
-
- if (count($rj->geonames) <= 0) {
- $this->log(LOG_WARNING, "No results in response from " .
- $this->host . " for $name");
+ if (count($geonames) == 0) {
+ // no results
+ $this->setCache(array('name' => $name,
+ 'language' => $language),
+ null);
return true;
}
- $n = $rj->geonames[0];
+ $n = $geonames[0];
$location = new Location();
- $location->lat = $n->lat;
- $location->lon = $n->lng;
- $location->names[$language] = $n->name;
- $location->location_id = $n->geonameId;
+ $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;
$this->setCache(array('name' => $name,
$loc = $this->getCache(array('id' => $id));
- if (!empty($loc)) {
+ if ($loc !== false) {
$location = $loc;
return false;
}
- $client = HTTPClient::start();
-
- $result = $client->get($this->wsUrl('hierarchyJSON',
- array('geonameId' => $id,
- 'lang' => $language)));
-
- if (!$result->isOk()) {
- $this->log(LOG_WARNING,
- "Error code " . $result->code .
- " from " . $this->host . " for ID $id");
- return false;
- }
-
- $rj = json_decode($result->getBody());
-
- if (count($rj->geonames) <= 0) {
- $this->log(LOG_WARNING,
- "No results in response from " .
- $this->host . " for ID $id");
+ 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;
}
$parts = array();
- foreach ($rj->geonames as $level) {
+ foreach ($geonames as $level) {
if (in_array($level->fcode, array('PCLI', 'ADM1', 'PPL'))) {
- $parts[] = $level->name;
+ $parts[] = (string)$level->name;
}
}
- $last = $rj->geonames[count($rj->geonames)-1];
+ $last = $geonames[count($geonames)-1];
if (!in_array($level->fcode, array('PCLI', 'ADM1', 'PPL'))) {
- $parts[] = $last->name;
+ $parts[] = (string)$last->name;
}
$location = new Location();
- $location->location_id = $last->geonameId;
+ $location->location_id = (string)$last->geonameId;
$location->location_ns = self::LOCATION_NS;
- $location->lat = $last->lat;
- $location->lon = $last->lng;
+ $location->lat = $this->canonical($last->lat);
+ $location->lon = $this->canonical($last->lng);
+
$location->names[$language] = implode(', ', array_reverse($parts));
- $this->setCache(array('id' => $last->geonameId),
+ $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)
{
- $lat = rtrim($lat, "0");
- $lon = rtrim($lon, "0");
+ // Make sure they're canonical
+
+ $lat = $this->canonical($lat);
+ $lon = $this->canonical($lon);
$loc = $this->getCache(array('lat' => $lat,
'lon' => $lon));
- if (!empty($loc)) {
+ if ($loc !== false) {
$location = $loc;
return false;
}
- $client = HTTPClient::start();
-
- $result =
- $client->get($this->wsUrl('findNearbyPlaceNameJSON',
- array('lat' => $lat,
- 'lng' => $lon,
- 'lang' => $language)));
-
- if (!$result->isOk()) {
- $this->log(LOG_WARNING,
- "Error code " . $result->code .
- " from " . $this->host . " for coords $lat, $lon");
+ 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;
}
- $rj = json_decode($result->getBody());
-
- if (count($rj->geonames) <= 0) {
- $this->log(LOG_WARNING,
- "No results in response from " .
- $this->host . " for coords $lat, $lon");
+ if (count($geonames) == 0) {
+ // no results
+ $this->setCache(array('lat' => $lat,
+ 'lon' => $lon),
+ null);
return true;
}
- $n = $rj->geonames[0];
+ $n = $geonames[0];
$parts = array();
$location = new Location();
- $parts[] = $n->name;
+ $parts[] = (string)$n->name;
if (!empty($n->adminName1)) {
- $parts[] = $n->adminName1;
+ $parts[] = (string)$n->adminName1;
}
if (!empty($n->countryName)) {
- $parts[] = $n->countryName;
+ $parts[] = (string)$n->countryName;
}
- $location->location_id = $n->geonameId;
+ $location->location_id = (string)$n->geonameId;
$location->location_ns = self::LOCATION_NS;
- $location->lat = $lat;
- $location->lon = $lon;
+ $location->lat = $this->canonical($n->lat);
+ $location->lon = $this->canonical($n->lng);
$location->names[$language] = implode(', ', $parts);
return true;
}
- $n = $this->getCache(array('id' => $location->location_id,
+ $id = $location->location_id;
+
+ $n = $this->getCache(array('id' => $id,
'language' => $language));
- if (!empty($n)) {
+ if ($n !== false) {
$name = $n;
return false;
}
- $client = HTTPClient::start();
-
- $result = $client->get($this->wsUrl('hierarchyJSON',
- array('geonameId' => $location->location_id,
- 'lang' => $language)));
-
- if (!$result->isOk()) {
- $this->log(LOG_WARNING,
- "Error code " . $result->code .
- " from " . $this->host . " for ID " . $location->location_id);
+ 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->getBody());
-
- if (count($rj->geonames) <= 0) {
- $this->log(LOG_WARNING,
- "No results " .
- " from " . $this->host . " for ID " . $location->location_id);
+ if (count($geonames) == 0) {
+ $this->setCache(array('id' => $id,
+ 'language' => $language),
+ null);
return false;
}
$parts = array();
- foreach ($rj->geonames as $level) {
+ foreach ($geonames as $level) {
if (in_array($level->fcode, array('PCLI', 'ADM1', 'PPL'))) {
- $parts[] = $level->name;
+ $parts[] = (string)$level->name;
}
}
- $last = $rj->geonames[count($rj->geonames)-1];
+ $last = $geonames[count($geonames)-1];
if (!in_array($level->fcode, array('PCLI', 'ADM1', 'PPL'))) {
- $parts[] = $last->name;
+ $parts[] = (string)$last->name;
}
if (count($parts)) {
$name = implode(', ', array_reverse($parts));
- $this->setCache(array('id' => $location->location_id,
+ $this->setCache(array('id' => $id,
'language' => $language),
$name);
}
}
/**
- * Human-readable name for a location
+ * Human-readable URL for a location
*
* Given a location, we try to retrieve a geonames.org URL.
*
return true;
}
- $url = 'http://sw.geonames.org/' . $location->location_id . '/';
+ $url = 'http://sws.geonames.org/' . $location->location_id . '/';
// it's been filled, so don't process further.
return false;
function cacheKey($attrs)
{
- return common_cache_key('geonames:'.
- implode(',', array_keys($attrs)) . ':'.
- common_keyize(implode(',', array_values($attrs))));
+ $key = 'geonames:' .
+ implode(',', array_keys($attrs)) . ':'.
+ common_keyize(implode(',', array_values($attrs)));
+ if ($this->cachePrefix) {
+ return $this->cachePrefix . ':' . $key;
+ } else {
+ return common_cache_key($key);
+ }
}
function wsUrl($method, $params)
$params['token'] = $this->token;
}
- $str = http_build_query($params);
+ $str = http_build_query($params, null, '&');
return 'http://'.$this->host.'/'.$method.'?'.$str;
}
+
+ function getGeonames($method, $params)
+ {
+ if ($this->lastTimeout && (time() - $this->lastTimeout < $this->timeoutWindow)) {
+ throw new Exception("skipping due to recent web service timeout");
+ }
+
+ $client = HTTPClient::start();
+ $client->setConfig('connect_timeout', $this->timeout);
+ $client->setConfig('timeout', $this->timeout);
+
+ try {
+ $result = $client->get($this->wsUrl($method, $params));
+ } catch (Exception $e) {
+ common_log(LOG_ERR, __METHOD__ . ": " . $e->getMessage());
+ $this->lastTimeout = time();
+ throw $e;
+ }
+
+ if (!$result->isOk()) {
+ throw new Exception("HTTP error code " . $result->getStatus());
+ }
+
+ $body = $result->getBody();
+
+ if (empty($body)) {
+ throw new Exception("Empty HTTP body in response");
+ }
+
+ // This will throw an exception if the XML is mal-formed
+
+ $document = new SimpleXMLElement($body);
+
+ // No children, usually no results
+
+ $children = $document->children();
+
+ if (count($children) == 0) {
+ return array();
+ }
+
+ 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