lib/ReverseGeocode.php

   1 <?php
   2
   3 namespace Nominatim;
   4
   5 require_once(CONST_BasePath.'/lib/Result.php');
   6
   7 class ReverseGeocode
   8 {
   9     protected $oDB;
  10     protected $iMaxRank = 28;
  11
  12
  13     public function __construct(&$oDB)
  14     {
  15         $this->oDB =& $oDB;
  16     }
  17
  18
  19     public function setZoom($iZoom)
  20     {
  21         // Zoom to rank, this could probably be calculated but a lookup gives fine control
  22         $aZoomRank = array(
  23                       0 => 2, // Continent / Sea
  24                       1 => 2,
  25                       2 => 2,
  26                       3 => 4, // Country
  27                       4 => 4,
  28                       5 => 8, // State
  29                       6 => 10, // Region
  30                       7 => 10,
  31                       8 => 12, // County
  32                       9 => 12,
  33                       10 => 17, // City
  34                       11 => 17,
  35                       12 => 18, // Town / Village
  36                       13 => 18,
  37                       14 => 22, // Suburb
  38                       15 => 22,
  39                       16 => 26, // Street, TODO: major street?
  40                       17 => 26,
  41                       18 => 30, // or >, Building
  42                       19 => 30, // or >, Building
  43                      );
  44         $this->iMaxRank = (isset($iZoom) && isset($aZoomRank[$iZoom]))?$aZoomRank[$iZoom]:28;
  45     }
  46
  47     /**
  48      * Find the closest interpolation with the given search diameter.
  49      *
  50      * @param string $sPointSQL   Reverse geocoding point as SQL
  51      * @param float  $fSearchDiam Search diameter
  52      *
  53      * @return Record of the interpolation or null.
  54      */
  55     protected function lookupInterpolation($sPointSQL, $fSearchDiam)
  56     {
  57         $sSQL = 'SELECT place_id, parent_place_id, 30 as rank_search,';
  58         $sSQL .= '  ST_LineLocatePoint(linegeo,'.$sPointSQL.') as fraction,';
  59         $sSQL .= '  startnumber, endnumber, interpolationtype,';
  60         $sSQL .= '  ST_Distance(linegeo,'.$sPointSQL.') as distance';
  61         $sSQL .= ' FROM location_property_osmline';
  62         $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';
  63         $sSQL .= ' and indexed_status = 0 and startnumber is not NULL ';
  64         $sSQL .= ' ORDER BY distance ASC limit 1';
  65
  66         return chksql(
  67             $this->oDB->getRow($sSQL),
  68             'Could not determine closest housenumber on an osm interpolation line.'
  69         );
  70     }
  71
  72     protected function noPolygonFound($sPointSQL, $iMaxRank)
  73     {
  74         // searches for polygon in table country_osm_grid which contains the searchpoint
  75         $sSQL = 'SELECT * FROM country_osm_grid';
  76         $sSQL .= ' WHERE ST_CONTAINS (geometry, '.$sPointSQL.' )';
  77
  78         $aPoly = chksql(
  79             $this->oDB->getRow($sSQL),
  80             'Could not determine polygon containing the point.'
  81         );
  82         if ($aPoly) {
  83             $sCountryCode = $aPoly['country_code'];
  84
  85             $sSQL = 'SELECT *, ST_distance('.$sPointSQL.', geometry) as distance';
  86             $sSQL .= ' FROM placex';
  87             $sSQL .= ' WHERE osm_type = \'N\'';
  88             $sSQL .= ' AND country_code = \''.$sCountryCode.'\'';
  89             $sSQL .= ' AND rank_address > 0';
  90             $sSQL .= ' AND rank_address <= ' .Min(25, $iMaxRank);
  91             $sSQL .= ' AND type != \'postcode\'';
  92             $sSQL .= ' AND name IS NOT NULL ';
  93             $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
  94             $sSQL .= ' ORDER BY distance ASC, rank_address DESC';
  95             $sSQL .= ' LIMIT 1';
  96
  97             if (CONST_Debug) var_dump($sSQL);
  98             $aPlacNode = chksql(
  99                 $this->oDB->getRow($sSQL),
 100                 'Could not determine place node.'
 101             );
 102             if ($aPlacNode) {
 103                 return $aPlacNode;
 104             }
 105         }
 106     }
 107
 108     protected function lookupPolygon($sPointSQL, $iMaxRank)
 109     {
 110
 111         $oResult = null;
 112         $aPlace = null;
 113
 114         $sSQL = 'SELECT * FROM';
 115         $sSQL .= '(select place_id,parent_place_id,rank_address, rank_search, country_code, geometry';
 116         $sSQL .= ' FROM placex';
 117         $sSQL .= ' WHERE ST_GeometryType(geometry) in (\'ST_Polygon\', \'ST_MultiPolygon\')';
 118         $sSQL .= ' AND rank_address <= ' .Min(25, $iMaxRank);
 119         $sSQL .= ' AND geometry && '.$sPointSQL;
 120         $sSQL .= ' AND type != \'postcode\' ';
 121         $sSQL .= ' AND name is not null';
 122         $sSQL .= ' AND indexed_status = 0 and linked_place_id is null';
 123         $sSQL .= ' ORDER BY rank_address DESC LIMIT 50 ) as a';
 124         $sSQL .= ' WHERE ST_CONTAINS(geometry, '.$sPointSQL.' )';
 125         $sSQL .= ' ORDER BY rank_address DESC LIMIT 1';
 126
 127         $aPoly = chksql(
 128             $this->oDB->getRow($sSQL),
 129             'Could not determine polygon containing the point.'
 130         );
 131         if ($aPoly) {
 132             $iParentPlaceID = $aPoly['parent_place_id'];
 133             $iRankAddress = $aPoly['rank_address'];
 134             $iRankSearch = $aPoly['rank_search'];
 135             $iPlaceID = $aPoly['place_id'];
 136
 137             if ($iRankAddress != $iMaxRank) {
 138                 $sSQL = 'SELECT *';
 139                 $sSQL .= ' FROM (';
 140                 $sSQL .= ' SELECT place_id, rank_address,country_code, geometry,';
 141                 $sSQL .= ' ST_distance('.$sPointSQL.', geometry) as distance';
 142                 $sSQL .= ' FROM placex';
 143                 $sSQL .= ' WHERE osm_type = \'N\'';
 144                 if ($iRankAddress = 16){
 145                 //  using rank_search because of a better differentiation for place nodes at rank_address 16
 146                     $sSQL .= ' AND rank_search > '.$iRankSearch;
 147                     $sSQL .= ' AND rank_search <= ' .Min(25, $iMaxRank);
 148                     $sSQL .= ' AND class = \'place\'';
 149                 }else{
 150                     $sSQL .= ' AND rank_address > '.$iRankAddress;
 151                     $sSQL .= ' AND rank_address <= ' .Min(25, $iMaxRank);
 152                 }
 153                 $sSQL .= ' AND type != \'postcode\'';
 154                 $sSQL .= ' AND name IS NOT NULL ';
 155                 $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
 156                 // preselection through bbox
 157                 $sSQL .= ' AND (SELECT geometry FROM placex WHERE place_id = '.$iPlaceID.') && geometry';
 158                 $sSQL .= ' ORDER BY distance ASC,';
 159                 $sSQL .= ' rank_address DESC';
 160                 $sSQL .= ' limit 500) as a';
 161                 $sSQL .= ' WHERE ST_CONTAINS((SELECT geometry FROM placex WHERE place_id = '.$iPlaceID.'), geometry )';
 162                 $sSQL .= ' ORDER BY distance ASC, rank_address DESC';
 163                 $sSQL .= ' LIMIT 1';
 164
 165                 if (CONST_Debug) var_dump($sSQL);
 166                 $aPlacNode = chksql(
 167                     $this->oDB->getRow($sSQL),
 168                     'Could not determine place node.'
 169                 );
 170                 if ($aPlacNode) {
 171                     return $aPlacNode;
 172                 }
 173             }
 174         }
 175         return $aPoly;
 176     }
 177
 178     public function lookup($fLat, $fLon, $bDoInterpolation = true)
 179     {
 180         return $this->lookupPoint(
 181             'ST_SetSRID(ST_Point('.$fLon.','.$fLat.'),4326)',
 182             $bDoInterpolation
 183         );
 184     }
 185
 186     public function lookupPoint($sPointSQL, $bDoInterpolation = true)
 187     {
 188
 189         $iMaxRank = $this->iMaxRank;
 190
 191         // Find the nearest point
 192         $fSearchDiam = 0.006;
 193         $oResult = null;
 194         $aPlace = null;
 195         $fMaxAreaDistance = 1;
 196         $bIsTigerStreet = false;
 197
 198         // try with interpolations before continuing
 199         if ($bDoInterpolation && $iMaxRank >= 30) {
 200             $aHouse = $this->lookupInterpolation($sPointSQL, $fSearchDiam/3);
 201
 202             if ($aHouse) {
 203                 $oResult = new Result($aHouse['place_id'], Result::TABLE_OSMLINE);
 204                 $oResult->iHouseNumber = closestHouseNumber($aHouse);
 205
 206                 $aPlace = $aHouse;
 207                 $iParentPlaceID = $aHouse['parent_place_id']; // the street
 208                 $iMaxRank = 30;
 209
 210                 return $oResult;
 211             }
 212         }// no interpolation found, continue search
 213
 214         // for POI or street level
 215         if ($iMaxRank >= 26) {
 216             $sSQL = 'select place_id,parent_place_id,rank_address,country_code,';
 217             $sSQL .= 'CASE WHEN ST_GeometryType(geometry) in (\'ST_Polygon\',\'ST_MultiPolygon\') THEN ST_distance('.$sPointSQL.', centroid)';
 218             $sSQL .= ' ELSE ST_distance('.$sPointSQL.', geometry) ';
 219             $sSQL .= ' END as distance';
 220             $sSQL .= ' FROM ';
 221             $sSQL .= ' placex';
 222             $sSQL .= '   WHERE ST_DWithin('.$sPointSQL.', geometry, '.$fSearchDiam.')';
 223             $sSQL .= '   AND';
 224             // only streets
 225             if ($iMaxRank == 26) {
 226                 $sSQL .= ' rank_address = 26';
 227             } else {
 228                 $sSQL .= ' rank_address >= 26';
 229             }
 230             $sSQL .= ' and (name is not null or housenumber is not null';
 231             $sSQL .= ' or rank_address between 26 and 27)';
 232             $sSQL .= ' and class not in (\'waterway\',\'railway\',\'tunnel\',\'bridge\',\'man_made\')';
 233             $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
 234             $sSQL .= ' and (ST_GeometryType(geometry) not in (\'ST_Polygon\',\'ST_MultiPolygon\') ';
 235             $sSQL .= ' OR ST_DWithin('.$sPointSQL.', centroid, '.$fSearchDiam.'))';
 236             $sSQL .= ' ORDER BY distance ASC limit 1';
 237             if (CONST_Debug) var_dump($sSQL);
 238             $aPlace = chksql(
 239                 $this->oDB->getRow($sSQL),
 240                 'Could not determine closest place.'
 241             );
 242
 243             if ($aPlace) {
 244                     $iPlaceID = $aPlace['place_id'];
 245                     $oResult = new Result($iPlaceID);
 246                     $iParentPlaceID = $aPlace['parent_place_id'];
 247                     // if street and maxrank > streetlevel
 248                 if (($aPlace['rank_address'] == 26 || $aPlace['rank_address'] == 27)&& $iMaxRank > 27) {
 249                     // find the closest object (up to a certain radius) of which the street is a parent of
 250                     $sSQL = ' select place_id,parent_place_id,rank_address,country_code,';
 251                     $sSQL .= ' ST_distance('.$sPointSQL.', geometry) as distance';
 252                     $sSQL .= ' FROM ';
 253                     $sSQL .= ' placex';
 254                     // radius ?
 255                     $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', geometry, 0.001)';
 256                     $sSQL .= ' AND parent_place_id = '.$iPlaceID;
 257                     $sSQL .= ' and rank_address != 28';
 258                     $sSQL .= ' and (name is not null or housenumber is not null';
 259                     $sSQL .= ' or rank_address between 26 and 27)';
 260                     $sSQL .= ' and class not in (\'waterway\',\'railway\',\'tunnel\',\'bridge\',\'man_made\')';
 261                     $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
 262                     $sSQL .= ' ORDER BY distance ASC limit 1';
 263                     if (CONST_Debug) var_dump($sSQL);
 264                     $aStreet = chksql(
 265                         $this->oDB->getRow($sSQL),
 266                         'Could not determine closest place.'
 267                     );
 268                     if ($aStreet) {
 269                         $iPlaceID = $aStreet['place_id'];
 270                         $oResult = new Result($iPlaceID);
 271                         $iParentPlaceID = $aStreet['parent_place_id'];
 272                     }
 273                 }
 274             } else {
 275                 $aPlace = $this->lookupPolygon($sPointSQL, $iMaxRank);
 276                 if ($aPlace) {
 277                     $oResult = new Result($aPlace['place_id']);
 278                 } elseif(!$aPlace && $iMaxRank > 4)  {
 279                     $aPlace = $this->noPolygonFound($sPointSQL, $iMaxRank);
 280                     if ($aPlace) {
 281                         $oResult = new Result($aPlace['place_id']);
 282                     }
 283                 }
 284             }
 285             // lower than street level ($iMaxRank < 26 )
 286         } else {
 287             $aPlace = $this->lookupPolygon($sPointSQL, $iMaxRank);
 288             if ($aPlace) {
 289                 $oResult = new Result($aPlace['place_id']);
 290             } elseif(!$aPlace && $iMaxRank > 4) {
 291                 $aPlace = $this->noPolygonFound($sPointSQL, $iMaxRank);
 292                 if ($aPlace) {
 293                     $oResult = new Result($aPlace['place_id']);
 294                 }
 295             }
 296         }
 297         return $oResult;
 298     }
 299 }