<?php
- class ReverseGeocode
- {
- protected $oDB;
- protected $fLat;
- protected $fLon;
- protected $iMaxRank = 28;
+namespace Nominatim;
- protected $aLangPrefOrder = array();
+require_once(CONST_BasePath.'/lib/Result.php');
- protected $bIncludePolygonAsPoints = false;
- protected $bIncludePolygonAsText = false;
- protected $bIncludePolygonAsGeoJSON = false;
- protected $bIncludePolygonAsKML = false;
- protected $bIncludePolygonAsSVG = false;
- protected $fPolygonSimplificationThreshold = 0.0;
+class ReverseGeocode
+{
+ protected $oDB;
+ protected $iMaxRank = 28;
- function ReverseGeocode(&$oDB)
- {
- $this->oDB =& $oDB;
- }
+ public function __construct(&$oDB)
+ {
+ $this->oDB =& $oDB;
+ }
- function setLanguagePreference($aLangPref)
- {
- $this->aLangPrefOrder = $aLangPref;
- }
- function setLatLon($fLat, $fLon)
- {
- $this->fLat = (float)$fLat;
- $this->fLon = (float)$fLon;
- }
+ public function setZoom($iZoom)
+ {
+ // Zoom to rank, this could probably be calculated but a lookup gives fine control
+ $aZoomRank = array(
+ 0 => 2, // Continent / Sea
+ 1 => 2,
+ 2 => 2,
+ 3 => 4, // Country
+ 4 => 4,
+ 5 => 8, // State
+ 6 => 10, // Region
+ 7 => 10,
+ 8 => 12, // County
+ 9 => 12,
+ 10 => 17, // City
+ 11 => 17,
+ 12 => 18, // Town / Village
+ 13 => 18,
+ 14 => 22, // Suburb
+ 15 => 22,
+ 16 => 26, // Street, TODO: major street?
+ 17 => 26,
+ 18 => 30, // or >, Building
+ 19 => 30, // or >, Building
+ );
+ $this->iMaxRank = (isset($iZoom) && isset($aZoomRank[$iZoom]))?$aZoomRank[$iZoom]:28;
+ }
- function setRank($iRank)
- {
- $this->iMaxRank = $iRank;
- }
+ /**
+ * Find the closest interpolation with the given search diameter.
+ *
+ * @param string $sPointSQL Reverse geocoding point as SQL
+ * @param float $fSearchDiam Search diameter
+ * @param integer $iParentPlaceID Id of parent object
+ *
+ * @return Record of the interpolation or null.
+ */
+ protected function lookupInterpolation($sPointSQL, $fSearchDiam, $iParentPlaceID = null)
+ {
+ $sSQL = 'SELECT place_id, parent_place_id, 30 as rank_search,';
+ $sSQL .= ' ST_LineLocatePoint(linegeo,'.$sPointSQL.') as fraction,';
+ $sSQL .= ' startnumber, endnumber, interpolationtype,';
+ $sSQL .= ' ST_Distance(linegeo,'.$sPointSQL.') as distance';
+ $sSQL .= ' FROM location_property_osmline';
+ $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';
+ $sSQL .= ' and indexed_status = 0 and startnumber is not NULL ';
+ if (isset($iParentPlaceID)) {
+ $sSQL .= ' and parent_place_id = '.$iParentPlaceID;
+ }
+ $sSQL .= ' ORDER BY distance ASC limit 1';
- function setZoom($iZoom)
- {
- // Zoom to rank, this could probably be calculated but a lookup gives fine control
- $aZoomRank = array(
- 0 => 2, // Continent / Sea
- 1 => 2,
- 2 => 2,
- 3 => 4, // Country
- 4 => 4,
- 5 => 8, // State
- 6 => 10, // Region
- 7 => 10,
- 8 => 12, // County
- 9 => 12,
- 10 => 17, // City
- 11 => 17,
- 12 => 18, // Town / Village
- 13 => 18,
- 14 => 22, // Suburb
- 15 => 22,
- 16 => 26, // Street, TODO: major street?
- 17 => 26,
- 18 => 30, // or >, Building
- 19 => 30, // or >, Building
- );
- $this->iMaxRank = (isset($iZoom) && isset($aZoomRank[$iZoom]))?$aZoomRank[$iZoom]:28;
- }
+ return chksql(
+ $this->oDB->getRow($sSQL),
+ 'Could not determine closest housenumber on an osm interpolation line.'
+ );
+ }
+
+ protected function polygonFunctions($sPointSQL, $iMaxRank)
+ {
+ $oResult = null;
+
+ $aPlace = $this->lookupPolygon($sPointSQL, $iMaxRank);
+ if ($aPlace) {
+ $oResult = new Result($aPlace['place_id']);
+ } elseif (!$aPlace && $iMaxRank > 4) {
+ $aPlace = $this->noPolygonFound($sPointSQL, $iMaxRank);
+ if ($aPlace) {
+ $oResult = new Result($aPlace['place_id']);
+ }
+ }
+ return $oResult;
+ }
+
+ protected function noPolygonFound($sPointSQL, $iMaxRank)
+ {
+ // searches for polygon in table country_osm_grid which contains the searchpoint
+ $sSQL = 'SELECT * FROM country_osm_grid';
+ $sSQL .= ' WHERE ST_CONTAINS (geometry, '.$sPointSQL.' )';
+
+ $aPoly = chksql(
+ $this->oDB->getRow($sSQL),
+ 'Could not determine polygon containing the point.'
+ );
+ if ($aPoly) {
+ $sCountryCode = $aPoly['country_code'];
+
+ $sSQL = 'SELECT *, ST_distance('.$sPointSQL.', geometry) as distance';
+ $sSQL .= ' FROM placex';
+ $sSQL .= ' WHERE osm_type = \'N\'';
+ $sSQL .= ' AND country_code = \''.$sCountryCode.'\'';
+ $sSQL .= ' AND rank_address > 0';
+ $sSQL .= ' AND rank_address <= ' .Min(25, $iMaxRank);
+ $sSQL .= ' AND type != \'postcode\'';
+ $sSQL .= ' AND name IS NOT NULL ';
+ $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
+ $sSQL .= ' ORDER BY distance ASC, rank_address DESC';
+ $sSQL .= ' LIMIT 1';
+
+ if (CONST_Debug) var_dump($sSQL);
+ $aPlacNode = chksql(
+ $this->oDB->getRow($sSQL),
+ 'Could not determine place node.'
+ );
+ if ($aPlacNode) {
+ return $aPlacNode;
+ }
+ }
+ }
+
+ protected function lookupPolygon($sPointSQL, $iMaxRank)
+ {
+ $sSQL = 'SELECT * FROM';
+ $sSQL .= '(select place_id,parent_place_id,rank_address, rank_search, country_code, geometry';
+ $sSQL .= ' FROM placex';
+ $sSQL .= ' WHERE ST_GeometryType(geometry) in (\'ST_Polygon\', \'ST_MultiPolygon\')';
+ $sSQL .= ' AND rank_address <= ' .Min(25, $iMaxRank);
+ $sSQL .= ' AND geometry && '.$sPointSQL;
+ $sSQL .= ' AND type != \'postcode\' ';
+ $sSQL .= ' AND name is not null';
+ $sSQL .= ' AND indexed_status = 0 and linked_place_id is null';
+ $sSQL .= ' ORDER BY rank_address DESC LIMIT 50 ) as a';
+ $sSQL .= ' WHERE ST_CONTAINS(geometry, '.$sPointSQL.' )';
+ $sSQL .= ' ORDER BY rank_address DESC LIMIT 1';
- function setIncludePolygonAsPoints($b = true)
- {
- $this->bIncludePolygonAsPoints = $b;
- }
+ $aPoly = chksql(
+ $this->oDB->getRow($sSQL),
+ 'Could not determine polygon containing the point.'
+ );
+ if ($aPoly) {
+ $iParentPlaceID = $aPoly['parent_place_id'];
+ $iRankAddress = $aPoly['rank_address'];
+ $iRankSearch = $aPoly['rank_search'];
+ $iPlaceID = $aPoly['place_id'];
+
+ if ($iRankAddress != $iMaxRank) {
+ $sSQL = 'SELECT *';
+ $sSQL .= ' FROM (';
+ $sSQL .= ' SELECT place_id, rank_address,country_code, geometry,';
+ $sSQL .= ' ST_distance('.$sPointSQL.', geometry) as distance';
+ $sSQL .= ' FROM placex';
+ $sSQL .= ' WHERE osm_type = \'N\'';
+ if ($iRankAddress = 16) {
+ // using rank_search because of a better differentiation for place nodes at rank_address 16
+ $sSQL .= ' AND rank_search > '.$iRankSearch;
+ $sSQL .= ' AND rank_search <= ' .Min(25, $iMaxRank);
+ $sSQL .= ' AND class = \'place\'';
+ } else {
+ $sSQL .= ' AND rank_address > '.$iRankAddress;
+ $sSQL .= ' AND rank_address <= ' .Min(25, $iMaxRank);
+ }
+ $sSQL .= ' AND type != \'postcode\'';
+ $sSQL .= ' AND name IS NOT NULL ';
+ $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
+ // preselection through bbox
+ $sSQL .= ' AND (SELECT geometry FROM placex WHERE place_id = '.$iPlaceID.') && geometry';
+ $sSQL .= ' ORDER BY distance ASC,';
+ $sSQL .= ' rank_address DESC';
+ $sSQL .= ' limit 500) as a';
+ $sSQL .= ' WHERE ST_CONTAINS((SELECT geometry FROM placex WHERE place_id = '.$iPlaceID.'), geometry )';
+ $sSQL .= ' ORDER BY distance ASC, rank_address DESC';
+ $sSQL .= ' LIMIT 1';
+
+ if (CONST_Debug) var_dump($sSQL);
+ $aPlacNode = chksql(
+ $this->oDB->getRow($sSQL),
+ 'Could not determine place node.'
+ );
+ if ($aPlacNode) {
+ return $aPlacNode;
+ }
+ }
+ }
+ return $aPoly;
+ }
+
- function getIncludePolygonAsPoints()
- {
- return $this->bIncludePolygonAsPoints;
- }
+ public function lookup($fLat, $fLon, $bDoInterpolation = true)
+ {
+ return $this->lookupPoint(
+ 'ST_SetSRID(ST_Point('.$fLon.','.$fLat.'),4326)',
+ $bDoInterpolation
+ );
+ }
- function setIncludePolygonAsText($b = true)
- {
- $this->bIncludePolygonAsText = $b;
- }
+ public function lookupPoint($sPointSQL, $bDoInterpolation = true)
+ {
+
+ $iMaxRank = $this->iMaxRank;
- function getIncludePolygonAsText()
- {
- return $this->bIncludePolygonAsText;
- }
+ // Find the nearest point
+ $fSearchDiam = 0.006;
+ $oResult = null;
+ $aPlace = null;
+ $fMaxAreaDistance = 1;
+ $bIsTigerStreet = false;
+
+ // for POI or street level
+ if ($iMaxRank >= 26) {
+ $sSQL = 'select place_id,parent_place_id,rank_address,country_code,';
+ $sSQL .= 'CASE WHEN ST_GeometryType(geometry) in (\'ST_Polygon\',\'ST_MultiPolygon\') THEN ST_distance('.$sPointSQL.', centroid)';
+ $sSQL .= ' ELSE ST_distance('.$sPointSQL.', geometry) ';
+ $sSQL .= ' END as distance';
+ $sSQL .= ' FROM ';
+ $sSQL .= ' placex';
+ $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', geometry, '.$fSearchDiam.')';
+ $sSQL .= ' AND';
+ // only streets
+ if ($iMaxRank == 26) {
+ $sSQL .= ' rank_address = 26';
+ } else {
+ $sSQL .= ' rank_address between 26 and '.$iMaxRank;
+ }
+ $sSQL .= ' and (name is not null or housenumber is not null';
+ $sSQL .= ' or rank_address between 26 and 27)';
+ $sSQL .= ' and class not in (\'railway\',\'tunnel\',\'bridge\',\'man_made\')';
+ $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
+ $sSQL .= ' and (ST_GeometryType(geometry) not in (\'ST_Polygon\',\'ST_MultiPolygon\') ';
+ $sSQL .= ' OR ST_DWithin('.$sPointSQL.', centroid, '.$fSearchDiam.'))';
+ $sSQL .= ' ORDER BY distance ASC limit 1';
+ if (CONST_Debug) var_dump($sSQL);
+ $aPlace = chksql(
+ $this->oDB->getRow($sSQL),
+ 'Could not determine closest place.'
+ );
+
+ if ($aPlace) {
+
+ $iDistance = $aPlace['distance'];
+ $iPlaceID = $aPlace['place_id'];
+ $oResult = new Result($iPlaceID);
+ $iParentPlaceID = $aPlace['parent_place_id'];
+
+ if ($bDoInterpolation && $iMaxRank >= 30) {
+ if ($aPlace['rank_address'] <=27) {
+ $iDistance = 0.001;
+ }
+ $aHouse = $this->lookupInterpolation($sPointSQL, $iDistance);
- function setIncludePolygonAsGeoJSON($b = true)
- {
- $this->bIncludePolygonAsGeoJSON = $b;
- }
+ if ($aHouse) {
+ $oResult = new Result($aHouse['place_id'], Result::TABLE_OSMLINE);
+ $oResult->iHouseNumber = closestHouseNumber($aHouse);
+ }
+ }
+
+ // if street and maxrank > streetlevel
+ if (($aPlace['rank_address'] <=27)&& $iMaxRank > 27) {
+ // find the closest object (up to a certain radius) of which the street is a parent of
+ $sSQL = ' select place_id,parent_place_id,rank_address,country_code,';
+ $sSQL .= ' ST_distance('.$sPointSQL.', geometry) as distance';
+ $sSQL .= ' FROM ';
+ $sSQL .= ' placex';
+ // radius ?
+ $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', geometry, 0.001)';
+ $sSQL .= ' AND parent_place_id = '.$iPlaceID;
+ $sSQL .= ' and rank_address != 28';
+ $sSQL .= ' and (name is not null or housenumber is not null)';
+ $sSQL .= ' and class not in (\'railway\',\'tunnel\',\'bridge\',\'man_made\')';
+ $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
+ $sSQL .= ' ORDER BY distance ASC limit 1';
+ if (CONST_Debug) var_dump($sSQL);
+ $aStreet = chksql(
+ $this->oDB->getRow($sSQL),
+ 'Could not determine closest place.'
+ );
+ if ($aStreet) {
+ $iDistance = $aStreet['distance'];
+ $iPlaceID = $aStreet['place_id'];
+ $oResult = new Result($iPlaceID);
+ $iParentPlaceID = $aStreet['parent_place_id'];
+
+ if ($bDoInterpolation && $iMaxRank >= 30) {
+ $aHouse = $this->lookupInterpolation($sPointSQL, $iDistance, $iParentPlaceID);
- function setIncludePolygonAsKML($b = true)
- {
- $this->bIncludePolygonAsKML = $b;
- }
-
- function setIncludePolygonAsSVG($b = true)
- {
- $this->bIncludePolygonAsSVG = $b;
- }
-
- function setPolygonSimplificationThreshold($f)
- {
- $this->fPolygonSimplificationThreshold = $f;
- }
-
- // returns { place_id =>, type => '(osm|tiger)' }
- // fails if no place was found
- function lookup()
- {
- $sPointSQL = 'ST_SetSRID(ST_Point('.$this->fLon.','.$this->fLat.'),4326)';
- $iMaxRank = $this->iMaxRank;
- $iMaxRank_orig = $this->iMaxRank;
-
- // Find the nearest point
- $fSearchDiam = 0.0004;
- $iPlaceID = null;
- $aArea = false;
- $fMaxAreaDistance = 1;
- $bIsInUnitedStates = false;
- $bPlaceIsTiger = false;
- while(!$iPlaceID && $fSearchDiam < $fMaxAreaDistance)
- {
- $fSearchDiam = $fSearchDiam * 2;
-
- // If we have to expand the search area by a large amount then we need a larger feature
- // then there is a limit to how small the feature should be
- if ($fSearchDiam > 2 && $iMaxRank > 4) $iMaxRank = 4;
- if ($fSearchDiam > 1 && $iMaxRank > 9) $iMaxRank = 8;
- if ($fSearchDiam > 0.8 && $iMaxRank > 10) $iMaxRank = 10;
- if ($fSearchDiam > 0.6 && $iMaxRank > 12) $iMaxRank = 12;
- if ($fSearchDiam > 0.2 && $iMaxRank > 17) $iMaxRank = 17;
- if ($fSearchDiam > 0.1 && $iMaxRank > 18) $iMaxRank = 18;
- if ($fSearchDiam > 0.008 && $iMaxRank > 22) $iMaxRank = 22;
- if ($fSearchDiam > 0.001 && $iMaxRank > 26) $iMaxRank = 26;
-
- $sSQL = 'select place_id,parent_place_id,rank_search,calculated_country_code';
- $sSQL .= ' FROM placex';
- $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', geometry, '.$fSearchDiam.')';
- $sSQL .= ' and rank_search != 28 and rank_search >= '.$iMaxRank;
- $sSQL .= ' and (name is not null or housenumber is not null)';
- $sSQL .= ' and class not in (\'waterway\',\'railway\',\'tunnel\',\'bridge\',\'man_made\')';
- $sSQL .= ' and indexed_status = 0 ';
- $sSQL .= ' and (ST_GeometryType(geometry) not in (\'ST_Polygon\',\'ST_MultiPolygon\') ';
- $sSQL .= ' OR ST_DWithin('.$sPointSQL.', centroid, '.$fSearchDiam.'))';
- $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', geometry) ASC limit 1';
- if (CONST_Debug) var_dump($sSQL);
- $aPlace = $this->oDB->getRow($sSQL);
- if (PEAR::IsError($aPlace))
- {
- failInternalError("Could not determine closest place.", $sSQL, $aPlace);
- }
- $iPlaceID = $aPlace['place_id'];
- $iParentPlaceID = $aPlace['parent_place_id'];
- $bIsInUnitedStates = ($aPlace['calculated_country_code'] == 'us');
- }
-
- // Only street found? If it's in the US we can check TIGER data for nearest housenumber
- if ($bIsInUnitedStates && $iMaxRank_orig >= 28 && $iPlaceID && ($aPlace['rank_search'] == 26 || $aPlace['rank_search'] == 27 ))
- {
- $fSearchDiam = 0.001;
- $sSQL = 'SELECT place_id,parent_place_id,30 as rank_search, ST_line_locate_point(linegeo,'.$sPointSQL.') as fraction';
- //if (CONST_Debug) { $sSQL .= ', housenumber, ST_distance('.$sPointSQL.', centroid) as distance, st_y(centroid) as lat, st_x(centroid) as lon'; }
- $sSQL .= ' FROM location_property_tiger WHERE parent_place_id = '.$iPlaceID;
- $sSQL .= ' AND ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')'; //no centroid anymore in Tiger data, now we have lines
- $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', linegeo) ASC limit 1';
-
-
- // print all house numbers in the parent (street)
- /*if (CONST_Debug)
- {
- $sSQL = preg_replace('/limit 1/', 'limit 100', $sSQL);
- var_dump($sSQL);
-
- $aAllHouses = $this->oDB->getAll($sSQL);
- foreach($aAllHouses as $i)
- {
- echo $i['housenumber'] . ' | ' . $i['distance'] * 1000 . ' | ' . $i['lat'] . ' | ' . $i['lon']. ' | '. "<br>\n";
- }
- }*/
-
- $aPlaceTiger = $this->oDB->getRow($sSQL);
- if (PEAR::IsError($aPlace))
- {
- failInternalError("Could not determine closest Tiger place.", $sSQL, $aPlaceTiger);
- }
- if ($aPlaceTiger)
- {
- if (CONST_Debug) var_dump('found Tiger place', $aPlaceTiger);
- $bPlaceIsTiger = true;
- $aPlace = $aPlaceTiger;
- $iPlaceID = $aPlaceTiger['place_id'];
- $iParentPlaceID = $aPlaceTiger['parent_place_id']; // the street
- $iFraction = $aPlaceTiger['fraction'];
- }
- }
-
- // The point we found might be too small - use the address to find what it is a child of
- if ($iPlaceID && $iMaxRank < 28)
- {
- if ($aPlace['rank_search'] > 28 && $iParentPlaceID && !$bPlaceIsTiger)
- {
- $iPlaceID = $iParentPlaceID;
- }
- $sSQL = 'select address_place_id';
- $sSQL .= ' FROM place_addressline';
- $sSQL .= " WHERE place_id = $iPlaceID";
- $sSQL .= " ORDER BY abs(cached_rank_address - $iMaxRank) asc,cached_rank_address desc,isaddress desc,distance desc";
- $sSQL .= ' LIMIT 1';
- $iPlaceID = $this->oDB->getOne($sSQL);
- if (PEAR::IsError($iPlaceID))
- {
- failInternalError("Could not get parent for place.", $sSQL, $iPlaceID);
- }
- if (!$iPlaceID)
- {
- $iPlaceID = $aPlace['place_id'];
- }
- }
-
- return array('place_id' => $iPlaceID,
- 'type' => $bPlaceIsTiger ? 'tiger' : 'osm');
- }
-
- }
-?>
+ if ($aHouse) {
+ $oResult = new Result($aHouse['place_id'], Result::TABLE_OSMLINE);
+ $oResult->iHouseNumber = closestHouseNumber($aHouse);
+ }
+ }
+ }
+ }
+
+ // In the US we can check TIGER data for nearest housenumber
+ if (CONST_Use_US_Tiger_Data && $aPlace['country_code'] == 'us' && $this->iMaxRank >= 28) {
+ $fSearchDiam = $aPlace['rank_search'] > 28 ? $aPlace['distance'] : 0.001;
+ $sSQL = 'SELECT place_id,parent_place_id,30 as rank_search,';
+ $sSQL .= 'ST_LineLocatePoint(linegeo,'.$sPointSQL.') as fraction,';
+ $sSQL .= 'ST_distance('.$sPointSQL.', linegeo) as distance,';
+ $sSQL .= 'startnumber,endnumber,interpolationtype';
+ $sSQL .= ' FROM location_property_tiger WHERE parent_place_id = '.$oResult->iId;
+ $sSQL .= ' AND ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';
+ $sSQL .= ' ORDER BY distance ASC limit 1';
+ if (CONST_Debug) var_dump($sSQL);
+ $aPlaceTiger = chksql(
+ $this->oDB->getRow($sSQL),
+ 'Could not determine closest Tiger place.'
+ );
+ if ($aPlaceTiger) {
+ if (CONST_Debug) var_dump('found Tiger housenumber', $aPlaceTiger);
+ $aPlace = $aPlaceTiger;
+ $oResult = new Result($aPlace['place_id'], Result::TABLE_TIGER);
+ $oResult->iHouseNumber = closestHouseNumber($aPlaceTiger);
+ }
+ }
+ // if no POI or street is found ...
+ } else {
+ $oResult = $this->PolygonFunctions($sPointSQL, $iMaxRank);
+ }
+ // lower than street level ($iMaxRank < 26 )
+ } else {
+ $oResult = $this->PolygonFunctions($sPointSQL, $iMaxRank);
+ }
+ return $oResult;
+ }
+}