Skip to content

Commit

Permalink
Merge pull request #1252 from ditorelo/794
Browse files Browse the repository at this point in the history 
Adding Nominatin as a geocoder option (Issue #794)
  • Loading branch information
@rjmackay
rjmackay committed Nov 18, 2013
2 parents 1f4734b + 3bead62 commit 6f555a0
Show file tree
Hide file tree
Showing 5 changed files with 371 additions and 73 deletions.
6 changes: 6 additions & 0 deletions application/config/map.php
View file
Expand Up @@ -80,3 +80,9 @@






/**
* Determines which geocoding engine to use
* Options are google or nominatim
*/

$config['geocode'] = "nominatim";
300 changes: 300 additions & 0 deletions application/helpers/geocode.php
View file
@@ -0,0 +1,300 @@
<?php defined('SYSPATH') OR die('No direct access allowed.');
/**
* Geocode helper class
*
* Portions of this class credited to: zzolo, phayes, tmcw, brynbellomy, bdragon
*
* @package Geocode
* @author Ushahidi Team
* @copyright (c) 2008 Ushahidi Team
* @license http://www.ushahidi.com/license.html
*/


class geocode_Core {

/**
* Geocoding function. Will receive an address and call service configured on map.geocode config
*
* @param string Address
* @return string[]|boolean Location information [country, country_id, location_name, latitude, longitude], FALSE if unsucessful
*
*/
static public function geocode($address = NULL) {
$service = Kohana::config('map.geocode');

if ($address)
{
if (! method_exists('geocode_Core', $service)) {
throw new Kohana_Exception("'" . $service . "' is not a valid geocode service");
return FALSE;
}

return self::$service($address);
}
else
{
return FALSE;
}
}

/**
* Geocoding function that uses nominatin engine.
*
* @param string Address
* @return string[]|boolean Location information [country, country_id, location_name, latitude, longitude], FALSE if unsucessful
*
*/
static public function nominatim($address) {
$payload = FALSE;
$result = FALSE;

$params = array(
"format" => "json",
"addressdetails" => 1,
"accept-language" => "en_US", // force country names to come back as english,
"q" => $address,
"zoom" => 200
);

$url = "http://nominatim.openstreetmap.org/search/?" . http_build_query($params);

$url_request = new HttpClient($url);

if ($result = $url_request->execute())
{
$payload = json_decode($result);
}
else
{
Kohana::log('error', "Geocode - Nominatin\n" . $url_request->get_error_msg());
}

// TODO: Nomaninatins documentation on error returning is poor - this could be improved to have meaningful error messages
if (!$payload || count($payload) == 0)
{
return FALSE;
}

$result = array_pop($payload);

$country_name = isset($result->address->country) ? $result->address->country : $result->display_name;

$country = self::getCountryId($country_name);

// if we can't find the country by name, try finding it by code
if ($country == 0 && isset($result->address->country_code))
{
$country = self::getCountryIdByCode($result->address->country_code);
}

$geocodes = array(
'country' => $country_name,
'country_id' => $country,
'location_name' => $result->display_name,
'latitude' => $result->lat,
'longitude' => $result->lon
);

return $geocodes;
}

/**
* Geocoding function that uses google engine.
*
* @param string Address
* @return string[]|boolean Location information [country, country_id, location_name, latitude, longitude], FALSE if unsucessful
*
*/
static public function google($address) {
$payload = FALSE;

$url = Kohana::config('config.external_site_protocol').'://maps.google.com/maps/api/geocode/json?sensor=false&address='.rawurlencode($address);
$result = FALSE;

$url_request = new HttpClient($url);

if ($result = $url_request->execute())
{
$payload = json_decode($result);
}
else
{
Kohana::log('error', "Geocode - Google\n" . $url_request->get_error_msg());
}

// Verify that the request succeeded
if (! isset($payload->status)) return FALSE;
if ($payload->status != 'OK')
{
if ($payload->status != 'ZERO_RESULTS')
{
// logs anything different from OK or ZERO_RESULTS
Kohana::log('error', "Geocode - Google: " . $payload->status);
}

return FALSE;
}

// Convert the Geocoder's results to an array
$all_components = json_decode(json_encode($payload->results), TRUE);

$result = array_pop($all_components);
$location = $result['geometry']['location'];

// Find the country
$address_components = $result['address_components'];
$country_name = NULL;
foreach ($address_components as $component)
{
if (in_array('country', $component['types']))
{
$country_name = $component['long_name'];
break;
}
}

// If no country has been found, use the formatted address
if (empty($country_name))
{
$country_name = $result['formatted_address'];
}

$geocodes = array(
'country' => $country_name,
'country_id' => self::getCountryId($country_name),
'location_name' => $result['formatted_address'],
'latitude' => $location['lat'],
'longitude' => $location['lng']
);

return $geocodes;
}

/**
* Finds country on deployment database by name
* @param string Country Name
* @return int Country Id if exists, 0 if not
*
*/
static function getCountryId($country_name) {
// Grab country_id
$country = Country_Model::get_country_by_name($country_name);
return ( ! empty($country) AND $country->loaded)? $country->id : 0;
}

/**
* Finds country on deployment database by code
* @param string Country Name
* @return int Country Id if exists, 0 if not
*
*/
static function getCountryIdByCode($country_code) {
// Grab country_id
$country = Country_Model::get_country_by_code($country_code);
return ( ! empty($country) AND $country->loaded)? $country->id : 0;
}


/**
* Reverse Geocode a point
*
* @author
* @param double $latitude
* @param double $longitude
* @return string closest approximation of the point as a display name
*/
static function reverseGeocode($latitude, $longitude) {
if ($latitude && $longitude)
{
$function = "reverse" . ucfirst($service);

if (! method_exists('geocode_Core', $function)) {
throw new Kohana_Exception("'" . $service . "' is not a valid geocode service");
return FALSE;
}

return self::$service($address);
}
else
{
return FALSE;
}
}

/**
* Reverse Geocode a point using Nominatin
*
* @author
* @param double $latitude
* @param double $longitude
* @return string closest approximation of the point as a display name
*/
static function reverseNominatim($lat, $lng) {
if ($lat && $lng)
{
$url = 'http://nominatim.openstreetmap.org/reverse?format=json&lat=' . $lat . '&lon=' . $lng;

$request = new HttpClient($url);
if ( ! $json = $request->execute()) {
Kohana::log('error', "Geocode - reverseNominatin\n" . $url_request->get_error_msg());

return FALSE;
}

$location = json_decode($json, FALSE);

return $location->display_name;
}
else
{
return FALSE;
}
}

/**
* Reverse Geocode a point using Google Geocode
*
* @author
* @param double $latitude
* @param double $longitude
* @return string closest approximation of the point as a display name
*/
static function reverseGoogle($lat, $lng) {
if ($lat && $lng)
{
$url = Kohana::config('config.external_site_protocol') . '://maps.googleapis.com/maps/api/geocode/json?sensor=false&latlng=' . $lat . "," . $lng;

$request = new HttpClient($url);
if ( ! $json = $request->execute()) {
Kohana::log('error', "Geocode - reverseGoogle\n" . $url . "\n" . $request->get_error_msg());

return FALSE;
}

$location = json_decode($json);

if ($location->status != 'OK')
{
// logs anything different from OK
Kohana::log('error', "Geocode - reverseGoogle: " . $location->status . " - " . $location->error_message);

return FALSE;
}

if (count($location->results) == 0)
{
return FALSE;
}

return $location->results[0]->formatted_address;
}
else
{
return FALSE;
}
}



}

0 comments on commit 6f555a0

Please sign in to comment.