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      * @param integer $iParentPlaceID Id of parent object
  53      *
  54      * @return Record of the interpolation or null.
  55      */
  56     protected function lookupInterpolation($sPointSQL, $fSearchDiam, $iParentPlaceID = null)
  57     {
  58         $sSQL = 'SELECT place_id, parent_place_id, 30 as rank_search,';
  59         $sSQL .= '  ST_LineLocatePoint(linegeo,'.$sPointSQL.') as fraction,';
  60         $sSQL .= '  startnumber, endnumber, interpolationtype,';
  61         $sSQL .= '  ST_Distance(linegeo,'.$sPointSQL.') as distance';
  62         $sSQL .= ' FROM location_property_osmline';
  63         $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';
  64         $sSQL .= ' and indexed_status = 0 and startnumber is not NULL ';
  65         if (isset($iParentPlaceID)) {
  66             $sSQL .= ' and parent_place_id = '.$iParentPlaceID;
  67         }
  68         $sSQL .= ' ORDER BY distance ASC limit 1';
  69
  70         return chksql(
  71             $this->oDB->getRow($sSQL),
  72             'Could not determine closest housenumber on an osm interpolation line.'
  73         );
  74     }
  75
  76     protected function polygonFunctions($sPointSQL, $iMaxRank)
  77     {
  78         // starts the nopolygonFound function if no polygon is found with the lookupPolygon function
  79         $oResult = null;
  80
  81         $aPlace = $this->lookupPolygon($sPointSQL, $iMaxRank);
  82         if ($aPlace) {
  83             $oResult = new Result($aPlace['place_id']);
  84         // if no polygon which contains the searchpoint is found,
  85         // the noPolygonFound function searches in the country_osm_grid table for a polygon
  86         } elseif (!$aPlace && $iMaxRank > 4) {
  87             $aPlace = $this->noPolygonFound($sPointSQL, $iMaxRank);
  88             if ($aPlace) {
  89                 $oResult = new Result($aPlace['place_id']);
  90             }
  91         }
  92         return $oResult;
  93     }
  94
  95     protected function noPolygonFound($sPointSQL, $iMaxRank)
  96     {
  97         // searches for polygon in table country_osm_grid which contains the searchpoint
  98         // and searches for the nearest place node to the searchpoint in this polygon
  99         $sSQL = 'SELECT country_code FROM country_osm_grid';
 100         $sSQL .= ' WHERE ST_CONTAINS (geometry, '.$sPointSQL.') limit 1';
 101
 102         $aPoly = chksql(
 103             $this->oDB->getRow($sSQL),
 104             'Could not determine polygon containing the point.'
 105         );
 106         if ($aPoly) {
 107             $sCountryCode = $aPoly['country_code'];
 108
 109             // look for place nodes with the given country code
 110             $sSQL = 'SELECT place_id FROM';
 111             $sSQL .= ' (SELECT place_id, rank_search,';
 112             $sSQL .= '         ST_distance('.$sPointSQL.', geometry) as distance';
 113             $sSQL .= ' FROM placex';
 114             $sSQL .= ' WHERE osm_type = \'N\'';
 115             $sSQL .= ' AND country_code = \''.$sCountryCode.'\'';
 116             $sSQL .= ' AND rank_search > 4';
 117             $sSQL .= ' AND rank_search <= ' .min(25, $iMaxRank);
 118             $sSQL .= ' AND type != \'postcode\'';
 119             $sSQL .= ' AND name IS NOT NULL ';
 120             $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
 121             $sSQL .= ' AND ST_DWithin('.$sPointSQL.', geometry, 5.0)) p ';
 122             $sSQL .= 'WHERE distance <= reverse_place_diameter(rank_search)';
 123             $sSQL .= ' ORDER BY rank_search DESC, distance ASC';
 124             $sSQL .= ' LIMIT 1';
 125
 126             if (CONST_Debug) var_dump($sSQL);
 127             $aPlacNode = chksql(
 128                 $this->oDB->getRow($sSQL),
 129                 'Could not determine place node.'
 130             );
 131             if ($aPlacNode) {
 132                 return $aPlacNode;
 133             }
 134
 135             // still nothing, then return the country object
 136             $sSQL = 'SELECT place_id, ST_distance('.$sPointSQL.', centroid) as distance';
 137             $sSQL .= ' FROM placex';
 138             $sSQL .= ' WHERE country_code = \''.$sCountryCode.'\'';
 139             $sSQL .= ' AND rank_search = 4 AND rank_address = 4';
 140             $sSQL .= ' AND class in (\'boundary\',  \'place\')';
 141             $sSQL .= ' ORDER BY distance ASC';
 142
 143             if (CONST_Debug) var_dump($sSQL);
 144             $aPlacNode = chksql(
 145                 $this->oDB->getRow($sSQL),
 146                 'Could not determine place node.'
 147             );
 148             if ($aPlacNode) {
 149                 return $aPlacNode;
 150             }
 151         }
 152     }
 153
 154     protected function lookupPolygon($sPointSQL, $iMaxRank)
 155     {
 156         // searches for polygon where the searchpoint is within
 157         // if a polygon is found, placenodes with a higher rank are searched inside the polygon
 158
 159         // polygon search begins at suburb-level
 160         if ($iMaxRank > 25) $iMaxRank = 25;
 161         // no polygon search over country-level
 162         if ($iMaxRank < 5) $iMaxRank = 5;
 163         // search for polygon
 164         $sSQL = 'SELECT place_id, parent_place_id, rank_address, rank_search FROM';
 165         $sSQL .= '(select place_id, parent_place_id, rank_address, rank_search, country_code, geometry';
 166         $sSQL .= ' FROM placex';
 167         $sSQL .= ' WHERE ST_GeometryType(geometry) in (\'ST_Polygon\', \'ST_MultiPolygon\')';
 168         $sSQL .= ' AND rank_address Between 5 AND ' .$iMaxRank;
 169         $sSQL .= ' AND geometry && '.$sPointSQL;
 170         $sSQL .= ' AND type != \'postcode\' ';
 171         $sSQL .= ' AND name is not null';
 172         $sSQL .= ' AND indexed_status = 0 and linked_place_id is null';
 173         $sSQL .= ' ORDER BY rank_address DESC LIMIT 50 ) as a';
 174         $sSQL .= ' WHERE ST_CONTAINS(geometry, '.$sPointSQL.' )';
 175         $sSQL .= ' ORDER BY rank_address DESC LIMIT 1';
 176
 177         $aPoly = chksql(
 178             $this->oDB->getRow($sSQL),
 179             'Could not determine polygon containing the point.'
 180         );
 181         if ($aPoly) {
 182         // if a polygon is found, search for placenodes begins ...
 183             $iParentPlaceID = $aPoly['parent_place_id'];
 184             $iRankAddress = $aPoly['rank_address'];
 185             $iRankSearch = $aPoly['rank_search'];
 186             $iPlaceID = $aPoly['place_id'];
 187
 188             if ($iRankAddress != $iMaxRank) {
 189                 $sSQL = 'SELECT place_id FROM ';
 190                 $sSQL .= '(SELECT place_id, rank_search, country_code, geometry,';
 191                 $sSQL .= ' ST_distance('.$sPointSQL.', geometry) as distance';
 192                 $sSQL .= ' FROM placex';
 193                 $sSQL .= ' WHERE osm_type = \'N\'';
 194                 // using rank_search because of a better differentiation
 195                 // for place nodes at rank_address 16
 196                 $sSQL .= ' AND rank_search > '.$iRankSearch;
 197                 $sSQL .= ' AND rank_search <= ' .$iMaxRank;
 198                 $sSQL .= ' AND class = \'place\'';
 199                 $sSQL .= ' AND type != \'postcode\'';
 200                 $sSQL .= ' AND name IS NOT NULL ';
 201                 $sSQL .= ' AND indexed_status = 0 AND linked_place_id is null';
 202                 // preselection through bbox
 203                 $sSQL .= ' AND (SELECT geometry FROM placex WHERE place_id = '.$iPlaceID.') && geometry';
 204                 $sSQL .= ' ORDER BY distance ASC,';
 205                 $sSQL .= ' rank_address DESC';
 206                 $sSQL .= ' limit 500) as a';
 207                 $sSQL .= ' WHERE ST_CONTAINS((SELECT geometry FROM placex WHERE place_id = '.$iPlaceID.'), geometry )';
 208                 $sSQL .= ' AND distance <= reverse_place_diameter(rank_search)';
 209                 $sSQL .= ' ORDER BY distance ASC, rank_search DESC';
 210                 $sSQL .= ' LIMIT 1';
 211
 212                 if (CONST_Debug) var_dump($sSQL);
 213                 $aPlacNode = chksql(
 214                     $this->oDB->getRow($sSQL),
 215                     'Could not determine place node.'
 216                 );
 217                 if ($aPlacNode) {
 218                     return $aPlacNode;
 219                 }
 220             }
 221         }
 222         return $aPoly;
 223     }
 224
 225
 226     public function lookup($fLat, $fLon, $bDoInterpolation = true)
 227     {
 228         return $this->lookupPoint(
 229             'ST_SetSRID(ST_Point('.$fLon.','.$fLat.'),4326)',
 230             $bDoInterpolation
 231         );
 232     }
 233
 234     public function lookupPoint($sPointSQL, $bDoInterpolation = true)
 235     {
 236         // starts if the search is on POI or street level,
 237         // searches for the nearest POI or street,
 238         // if a street is found and a POI is searched for,
 239         // the nearest POI which the found street is a parent of is choosen.
 240         $iMaxRank = $this->iMaxRank;
 241
 242         // Find the nearest point
 243         $fSearchDiam = 0.006;
 244         $oResult = null;
 245         $aPlace = null;
 246         $fMaxAreaDistance = 1;
 247         $bIsTigerStreet = false;
 248
 249         // for POI or street level
 250         if ($iMaxRank >= 26) {
 251             $sSQL = 'select place_id,parent_place_id,rank_address,country_code,';
 252             $sSQL .= 'CASE WHEN ST_GeometryType(geometry) in (\'ST_Polygon\',\'ST_MultiPolygon\') THEN ST_distance('.$sPointSQL.', centroid)';
 253             $sSQL .= ' ELSE ST_distance('.$sPointSQL.', geometry) ';
 254             $sSQL .= ' END as distance';
 255             $sSQL .= ' FROM ';
 256             $sSQL .= ' placex';
 257             $sSQL .= '   WHERE ST_DWithin('.$sPointSQL.', geometry, '.$fSearchDiam.')';
 258             $sSQL .= '   AND';
 259             // only streets
 260             if ($iMaxRank == 26) {
 261                 $sSQL .= ' rank_address = 26';
 262             } else {
 263                 $sSQL .= ' rank_address between 26 and '.$iMaxRank;
 264             }
 265             $sSQL .= ' and (name is not null or housenumber is not null';
 266             $sSQL .= ' or rank_address between 26 and 27)';
 267             $sSQL .= ' and class not in (\'railway\',\'tunnel\',\'bridge\',\'man_made\')';
 268             $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
 269             $sSQL .= ' and (ST_GeometryType(geometry) not in (\'ST_Polygon\',\'ST_MultiPolygon\') ';
 270             $sSQL .= ' OR ST_DWithin('.$sPointSQL.', centroid, '.$fSearchDiam.'))';
 271             $sSQL .= ' ORDER BY distance ASC limit 1';
 272             if (CONST_Debug) var_dump($sSQL);
 273             $aPlace = chksql(
 274                 $this->oDB->getRow($sSQL),
 275                 'Could not determine closest place.'
 276             );
 277
 278             if ($aPlace) {
 279                 $iDistance = $aPlace['distance'];
 280                 $iPlaceID = $aPlace['place_id'];
 281                 $oResult = new Result($iPlaceID);
 282                 $iParentPlaceID = $aPlace['parent_place_id'];
 283
 284                 if ($bDoInterpolation && $iMaxRank >= 30) {
 285                     if ($aPlace['rank_address'] <=27) {
 286                         $iDistance = 0.001;
 287                     }
 288                     $aHouse = $this->lookupInterpolation($sPointSQL, $iDistance);
 289
 290                     if ($aHouse) {
 291                         $oResult = new Result($aHouse['place_id'], Result::TABLE_OSMLINE);
 292                         $oResult->iHouseNumber = closestHouseNumber($aHouse);
 293                     }
 294                 }
 295
 296                 // if street and maxrank > streetlevel
 297                 if (($aPlace['rank_address'] <=27)&& $iMaxRank > 27) {
 298                     // find the closest object (up to a certain radius) of which the street is a parent of
 299                     $sSQL = ' select place_id,parent_place_id,rank_address,country_code,';
 300                     $sSQL .= ' ST_distance('.$sPointSQL.', geometry) as distance';
 301                     $sSQL .= ' FROM ';
 302                     $sSQL .= ' placex';
 303                     // radius ?
 304                     $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', geometry, 0.001)';
 305                     $sSQL .= ' AND parent_place_id = '.$iPlaceID;
 306                     $sSQL .= ' and rank_address != 28';
 307                     $sSQL .= ' and (name is not null or housenumber is not null)';
 308                     $sSQL .= ' and class not in (\'railway\',\'tunnel\',\'bridge\',\'man_made\')';
 309                     $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
 310                     $sSQL .= ' ORDER BY distance ASC limit 1';
 311                     if (CONST_Debug) var_dump($sSQL);
 312                     $aStreet = chksql(
 313                         $this->oDB->getRow($sSQL),
 314                         'Could not determine closest place.'
 315                     );
 316                     if ($aStreet) {
 317                         $iDistance = $aStreet['distance'];
 318                         $iPlaceID = $aStreet['place_id'];
 319                         $oResult = new Result($iPlaceID);
 320                         $iParentPlaceID = $aStreet['parent_place_id'];
 321
 322                         if ($bDoInterpolation && $iMaxRank >= 30) {
 323                             $aHouse = $this->lookupInterpolation($sPointSQL, $iDistance, $iParentPlaceID);
 324
 325                             if ($aHouse) {
 326                                 $oResult = new Result($aHouse['place_id'], Result::TABLE_OSMLINE);
 327                                 $oResult->iHouseNumber = closestHouseNumber($aHouse);
 328                             }
 329                         }
 330                     }
 331                 }
 332
 333                   // In the US we can check TIGER data for nearest housenumber
 334                 if (CONST_Use_US_Tiger_Data && $aPlace['country_code'] == 'us' && $this->iMaxRank >= 28) {
 335                     $fSearchDiam = $aPlace['rank_address'] > 28 ? $aPlace['distance'] : 0.001;
 336                     $sSQL = 'SELECT place_id,parent_place_id,30 as rank_search,';
 337                     $sSQL .= 'ST_LineLocatePoint(linegeo,'.$sPointSQL.') as fraction,';
 338                     $sSQL .= 'ST_distance('.$sPointSQL.', linegeo) as distance,';
 339                     $sSQL .= 'startnumber,endnumber,interpolationtype';
 340                     $sSQL .= ' FROM location_property_tiger WHERE parent_place_id = '.$oResult->iId;
 341                     $sSQL .= ' AND ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';
 342                     $sSQL .= ' ORDER BY distance ASC limit 1';
 343                     if (CONST_Debug) var_dump($sSQL);
 344                     $aPlaceTiger = chksql(
 345                         $this->oDB->getRow($sSQL),
 346                         'Could not determine closest Tiger place.'
 347                     );
 348                     if ($aPlaceTiger) {
 349                         if (CONST_Debug) var_dump('found Tiger housenumber', $aPlaceTiger);
 350                         $aPlace = $aPlaceTiger;
 351                         $oResult = new Result($aPlace['place_id'], Result::TABLE_TIGER);
 352                         $oResult->iHouseNumber = closestHouseNumber($aPlaceTiger);
 353                     }
 354                 }
 355             // if no POI or street is found ...
 356             } else {
 357                 $oResult = $this->PolygonFunctions($sPointSQL, $iMaxRank);
 358             }
 359             // lower than street level ($iMaxRank < 26 )
 360         } else {
 361             $oResult = $this->PolygonFunctions($sPointSQL, $iMaxRank);
 362         }
 363         return $oResult;
 364     }
 365 }