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