lib-php/ReverseGeocode.php

   1 <?php
   2 /**
   3  * SPDX-License-Identifier: GPL-2.0-only
   4  *
   5  * This file is part of Nominatim. (https://nominatim.org)
   6  *
   7  * Copyright (C) 2022 by the Nominatim developer community.
   8  * For a full list of authors see the git log.
   9  */
  10
  11 namespace Nominatim;
  12
  13 require_once(CONST_LibDir.'/Result.php');
  14
  15 class ReverseGeocode
  16 {
  17     protected $oDB;
  18     protected $iMaxRank = 28;
  19
  20
  21     public function __construct(&$oDB)
  22     {
  23         $this->oDB =& $oDB;
  24     }
  25
  26
  27     public function setZoom($iZoom)
  28     {
  29         // Zoom to rank, this could probably be calculated but a lookup gives fine control
  30         $aZoomRank = array(
  31                       0 => 2, // Continent / Sea
  32                       1 => 2,
  33                       2 => 2,
  34                       3 => 4, // Country
  35                       4 => 4,
  36                       5 => 8, // State
  37                       6 => 10, // Region
  38                       7 => 10,
  39                       8 => 12, // County
  40                       9 => 12,
  41                       10 => 17, // City
  42                       11 => 17,
  43                       12 => 18, // Town
  44                       13 => 19, // Village
  45                       14 => 22, // Neighbourhood
  46                       15 => 25, // Locality
  47                       16 => 26, // major street
  48                       17 => 27, // minor street
  49                       18 => 30, // or >, Building
  50                       19 => 30, // or >, Building
  51                      );
  52         $this->iMaxRank = (isset($iZoom) && isset($aZoomRank[$iZoom]))?$aZoomRank[$iZoom]:28;
  53     }
  54
  55     /**
  56      * Find the closest interpolation with the given search diameter.
  57      *
  58      * @param string $sPointSQL   Reverse geocoding point as SQL
  59      * @param float  $fSearchDiam Search diameter
  60      *
  61      * @return Record of the interpolation or null.
  62      */
  63     protected function lookupInterpolation($sPointSQL, $fSearchDiam)
  64     {
  65         Debug::newFunction('lookupInterpolation');
  66         $sSQL = 'SELECT place_id, parent_place_id, 30 as rank_search,';
  67         $sSQL .= '  (CASE WHEN endnumber != startnumber';
  68         $sSQL .= '        THEN (endnumber - startnumber) * ST_LineLocatePoint(linegeo,'.$sPointSQL.')';
  69         $sSQL .= '        ELSE startnumber END) as fhnr,';
  70         $sSQL .= '  startnumber, endnumber, step,';
  71         $sSQL .= '  ST_Distance(linegeo,'.$sPointSQL.') as distance';
  72         $sSQL .= ' FROM location_property_osmline';
  73         $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';
  74         $sSQL .= '       and indexed_status = 0 and startnumber is not NULL ';
  75         $sSQL .= '       and parent_place_id != 0';
  76         $sSQL .= ' ORDER BY distance ASC limit 1';
  77         Debug::printSQL($sSQL);
  78
  79         return $this->oDB->getRow(
  80             $sSQL,
  81             null,
  82             'Could not determine closest housenumber on an osm interpolation line.'
  83         );
  84     }
  85
  86     protected function lookupLargeArea($sPointSQL, $iMaxRank)
  87     {
  88         if(CONST_Search_WithinCountries
  89             and $this->lookupInCountry($sPointSQL, $iMaxRank) == null){
  90                 return  null;
  91         }
  92
  93         if ($iMaxRank > 4) {
  94             $aPlace = $this->lookupPolygon($sPointSQL, $iMaxRank);
  95             if ($aPlace) {
  96                 return new Result($aPlace['place_id']);
  97             }
  98         }
  99
 100         // If no polygon which contains the searchpoint is found,
 101         // searches in the country_osm_grid table for a polygon.
 102         return  $this->lookupInCountry($sPointSQL, $iMaxRank);
 103     }
 104
 105     protected function lookupInCountry($sPointSQL, $iMaxRank)
 106     {
 107         Debug::newFunction('lookupInCountry');
 108         // searches for polygon in table country_osm_grid which contains the searchpoint
 109         // and searches for the nearest place node to the searchpoint in this polygon
 110         $sSQL = 'SELECT country_code FROM country_osm_grid';
 111         $sSQL .= ' WHERE ST_CONTAINS(geometry, '.$sPointSQL.') LIMIT 1';
 112         Debug::printSQL($sSQL);
 113
 114         $sCountryCode = $this->oDB->getOne(
 115             $sSQL,
 116             null,
 117             'Could not determine country polygon containing the point.'
 118         );
 119         Debug::printVar('Country code', $sCountryCode);
 120
 121         if ($sCountryCode) {
 122             if ($iMaxRank > 4) {
 123                 // look for place nodes with the given country code
 124                 $sSQL = 'SELECT place_id FROM';
 125                 $sSQL .= ' (SELECT place_id, rank_search,';
 126                 $sSQL .= '         ST_distance('.$sPointSQL.', geometry) as distance';
 127                 $sSQL .= ' FROM placex';
 128                 $sSQL .= ' WHERE osm_type = \'N\'';
 129                 $sSQL .= ' AND country_code = \''.$sCountryCode.'\'';
 130                 $sSQL .= ' AND rank_address between 4 and 25'; // needed to select right index
 131                 $sSQL .= ' AND rank_search between 5 and ' .min(25, $iMaxRank);
 132                 $sSQL .= ' AND type != \'postcode\'';
 133                 $sSQL .= ' AND name IS NOT NULL ';
 134                 $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
 135                 $sSQL .= ' AND ST_Buffer(geometry, reverse_place_diameter(rank_search)) && '.$sPointSQL;
 136                 $sSQL .= ') as a ';
 137                 $sSQL .= 'WHERE distance <= reverse_place_diameter(rank_search)';
 138                 $sSQL .= ' ORDER BY rank_search DESC, distance ASC';
 139                 $sSQL .= ' LIMIT 1';
 140                 Debug::printSQL($sSQL);
 141
 142                 $aPlace = $this->oDB->getRow($sSQL, null, 'Could not determine place node.');
 143                 Debug::printVar('Country node', $aPlace);
 144
 145                 if ($aPlace) {
 146                     return new Result($aPlace['place_id']);
 147                 }
 148             }
 149
 150             // still nothing, then return the country object
 151             $sSQL = 'SELECT place_id, ST_distance('.$sPointSQL.', centroid) as distance';
 152             $sSQL .= ' FROM placex';
 153             $sSQL .= ' WHERE country_code = \''.$sCountryCode.'\'';
 154             $sSQL .= ' AND rank_search = 4 AND rank_address = 4';
 155             $sSQL .= ' AND class in (\'boundary\',  \'place\')';
 156             $sSQL .= ' AND linked_place_id is null';
 157             $sSQL .= ' ORDER BY distance ASC';
 158             Debug::printSQL($sSQL);
 159
 160             $aPlace = $this->oDB->getRow($sSQL, null, 'Could not determine place node.');
 161             Debug::printVar('Country place', $aPlace);
 162             if ($aPlace) {
 163                 return new Result($aPlace['place_id']);
 164             }
 165         }
 166
 167         return null;
 168     }
 169
 170     /**
 171      * Search for areas or nodes for areas or nodes between state and suburb level.
 172      *
 173      * @param string $sPointSQL Search point as SQL string.
 174      * @param int    $iMaxRank  Maximum address rank of the feature.
 175      *
 176      * @return Record of the found feature or null.
 177      *
 178      * Searches first for polygon that contains the search point.
 179      * If such a polygon is found, place nodes with a higher rank are
 180      * searched inside the polygon.
 181      */
 182     protected function lookupPolygon($sPointSQL, $iMaxRank)
 183     {
 184         Debug::newFunction('lookupPolygon');
 185         // polygon search begins at suburb-level
 186         if ($iMaxRank > 25) {
 187             $iMaxRank = 25;
 188         }
 189         // no polygon search over country-level
 190         if ($iMaxRank < 5) {
 191             $iMaxRank = 5;
 192         }
 193         // search for polygon
 194         $sSQL = 'SELECT place_id, parent_place_id, rank_address, rank_search FROM';
 195         $sSQL .= '(select place_id, parent_place_id, rank_address, rank_search, country_code, geometry';
 196         $sSQL .= ' FROM placex';
 197         $sSQL .= ' WHERE ST_GeometryType(geometry) in (\'ST_Polygon\', \'ST_MultiPolygon\')';
 198         // Ensure that query planner doesn't use the index on rank_search.
 199         $sSQL .= ' AND coalesce(rank_search, 0) between 5 and ' .$iMaxRank;
 200         $sSQL .= ' AND rank_address between 4 and 25'; // needed for index selection
 201         $sSQL .= ' AND geometry && '.$sPointSQL;
 202         $sSQL .= ' AND type != \'postcode\' ';
 203         $sSQL .= ' AND name is not null';
 204         $sSQL .= ' AND indexed_status = 0 and linked_place_id is null';
 205         $sSQL .= ' ORDER BY rank_search DESC LIMIT 50 ) as a';
 206         $sSQL .= ' WHERE ST_Contains(geometry, '.$sPointSQL.' )';
 207         $sSQL .= ' ORDER BY rank_search DESC LIMIT 1';
 208         Debug::printSQL($sSQL);
 209
 210         $aPoly = $this->oDB->getRow($sSQL, null, 'Could not determine polygon containing the point.');
 211         Debug::printVar('Polygon result', $aPoly);
 212
 213         if ($aPoly) {
 214         // if a polygon is found, search for placenodes begins ...
 215             $iRankAddress = $aPoly['rank_address'];
 216             $iRankSearch = $aPoly['rank_search'];
 217             $iPlaceID = $aPoly['place_id'];
 218
 219             if ($iRankSearch != $iMaxRank) {
 220                 $sSQL = 'SELECT place_id FROM ';
 221                 $sSQL .= '(SELECT place_id, rank_search, country_code, geometry,';
 222                 $sSQL .= ' ST_distance('.$sPointSQL.', geometry) as distance';
 223                 $sSQL .= ' FROM placex';
 224                 $sSQL .= ' WHERE osm_type = \'N\'';
 225                 $sSQL .= ' AND rank_search > '.$iRankSearch;
 226                 $sSQL .= ' AND rank_search <= '.$iMaxRank;
 227                 $sSQL .= ' AND rank_address between 4 and 25';  // needed to select right index
 228                 $sSQL .= ' AND type != \'postcode\'';
 229                 $sSQL .= ' AND name IS NOT NULL ';
 230                 $sSQL .= ' AND indexed_status = 0 AND linked_place_id is null';
 231                 $sSQL .= ' AND ST_Buffer(geometry, reverse_place_diameter(rank_search)) && '.$sPointSQL;
 232                 $sSQL .= ' ORDER BY rank_search DESC, distance ASC';
 233                 $sSQL .= ' limit 100) as a';
 234                 $sSQL .= ' WHERE ST_Contains((SELECT geometry FROM placex WHERE place_id = '.$iPlaceID.'), geometry )';
 235                 $sSQL .= ' AND distance <= reverse_place_diameter(rank_search)';
 236                 $sSQL .= ' ORDER BY rank_search DESC, distance ASC';
 237                 $sSQL .= ' LIMIT 1';
 238                 Debug::printSQL($sSQL);
 239
 240                 $aPlaceNode = $this->oDB->getRow($sSQL, null, 'Could not determine place node.');
 241                 Debug::printVar('Nearest place node', $aPlaceNode);
 242                 if ($aPlaceNode) {
 243                     return $aPlaceNode;
 244                 }
 245             }
 246         }
 247         return $aPoly;
 248     }
 249
 250
 251     public function lookup($fLat, $fLon, $bDoInterpolation = true)
 252     {
 253         return $this->lookupPoint(
 254             'ST_SetSRID(ST_Point('.$fLon.','.$fLat.'),4326)',
 255             $bDoInterpolation
 256         );
 257     }
 258
 259     public function lookupPoint($sPointSQL, $bDoInterpolation = true)
 260     {
 261         Debug::newFunction('lookupPoint');
 262         // Find the nearest point
 263         $fSearchDiam = 0.006;
 264         $oResult = null;
 265         $aPlace = null;
 266
 267         // for POI or street level
 268         if ($this->iMaxRank >= 26) {
 269             // starts if the search is on POI or street level,
 270             // searches for the nearest POI or street,
 271             // if a street is found and a POI is searched for,
 272             // the nearest POI which the found street is a parent of is chosen.
 273             $sSQL = 'select place_id,parent_place_id,rank_address,country_code,';
 274             $sSQL .= ' ST_distance('.$sPointSQL.', geometry) as distance';
 275             $sSQL .= ' FROM ';
 276             $sSQL .= ' placex';
 277             $sSQL .= '   WHERE ST_DWithin('.$sPointSQL.', geometry, '.$fSearchDiam.')';
 278             $sSQL .= '   AND';
 279             $sSQL .= ' rank_address between 26 and '.$this->iMaxRank;
 280             $sSQL .= ' and (name is not null or housenumber is not null';
 281             $sSQL .= ' or rank_address between 26 and 27)';
 282             $sSQL .= ' and (rank_address between 26 and 27';
 283             $sSQL .= '      or ST_GeometryType(geometry) != \'ST_LineString\')';
 284             $sSQL .= ' and class not in (\'boundary\')';
 285             $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
 286             $sSQL .= ' and (ST_GeometryType(geometry) not in (\'ST_Polygon\',\'ST_MultiPolygon\') ';
 287             $sSQL .= ' OR ST_DWithin('.$sPointSQL.', centroid, '.$fSearchDiam.'))';
 288             $sSQL .= ' ORDER BY distance ASC limit 1';
 289             Debug::printSQL($sSQL);
 290
 291             $aPlace = $this->oDB->getRow($sSQL, null, 'Could not determine closest place.');
 292
 293             Debug::printVar('POI/street level result', $aPlace);
 294             if ($aPlace) {
 295                 $iPlaceID = $aPlace['place_id'];
 296                 $oResult = new Result($iPlaceID);
 297                 $iRankAddress = $aPlace['rank_address'];
 298             }
 299
 300             if ($aPlace) {
 301                 // if street and maxrank > streetlevel
 302                 if ($iRankAddress <= 27 && $this->iMaxRank > 27) {
 303                     // find the closest object (up to a certain radius) of which the street is a parent of
 304                     $sSQL = ' select place_id,';
 305                     $sSQL .= ' ST_distance('.$sPointSQL.', geometry) as distance';
 306                     $sSQL .= ' FROM ';
 307                     $sSQL .= ' placex';
 308                     // radius ?
 309                     $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', geometry, 0.001)';
 310                     $sSQL .= ' AND parent_place_id = '.$iPlaceID;
 311                     $sSQL .= ' and rank_address > 28';
 312                     $sSQL .= ' and ST_GeometryType(geometry) != \'ST_LineString\'';
 313                     $sSQL .= ' and (name is not null or housenumber is not null)';
 314                     $sSQL .= ' and class not in (\'boundary\')';
 315                     $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
 316                     $sSQL .= ' ORDER BY distance ASC limit 1';
 317                     Debug::printSQL($sSQL);
 318
 319                     $aStreet = $this->oDB->getRow($sSQL, null, 'Could not determine closest place.');
 320                     Debug::printVar('Closest POI result', $aStreet);
 321
 322                     if ($aStreet) {
 323                         $aPlace = $aStreet;
 324                         $oResult = new Result($aStreet['place_id']);
 325                         $iRankAddress = 30;
 326                     }
 327                 }
 328
 329                   // In the US we can check TIGER data for nearest housenumber
 330                 if (CONST_Use_US_Tiger_Data
 331                     && $iRankAddress <= 27
 332                     && $aPlace['country_code'] == 'us'
 333                     && $this->iMaxRank >= 28
 334                 ) {
 335                     $sSQL = 'SELECT place_id,parent_place_id,30 as rank_search,';
 336                     $sSQL .= '      (endnumber - startnumber) * ST_LineLocatePoint(linegeo,'.$sPointSQL.') as fhnr,';
 337                     $sSQL .= '      startnumber, endnumber, step,';
 338                     $sSQL .= '      ST_Distance('.$sPointSQL.', linegeo) as distance';
 339                     $sSQL .= ' FROM location_property_tiger WHERE parent_place_id = '.$oResult->iId;
 340                     $sSQL .= ' AND ST_DWithin('.$sPointSQL.', linegeo, 0.001)';
 341                     $sSQL .= ' ORDER BY distance ASC limit 1';
 342                     Debug::printSQL($sSQL);
 343
 344                     $aPlaceTiger = $this->oDB->getRow($sSQL, null, 'Could not determine closest Tiger place.');
 345                     Debug::printVar('Tiger house number result', $aPlaceTiger);
 346
 347                     if ($aPlaceTiger) {
 348                         $aPlace = $aPlaceTiger;
 349                         $oResult = new Result($aPlaceTiger['place_id'], Result::TABLE_TIGER);
 350                         $iRndNum = max(0, round($aPlaceTiger['fhnr'] / $aPlaceTiger['step']) * $aPlaceTiger['step']);
 351                         $oResult->iHouseNumber = $aPlaceTiger['startnumber'] + $iRndNum;
 352                         if ($oResult->iHouseNumber > $aPlaceTiger['endnumber']) {
 353                             $oResult->iHouseNumber = $aPlaceTiger['endnumber'];
 354                         }
 355                         $iRankAddress = 30;
 356                     }
 357                 }
 358             }
 359
 360             if ($bDoInterpolation && $this->iMaxRank >= 30) {
 361                 $fDistance = $fSearchDiam;
 362                 if ($aPlace) {
 363                     // We can't reliably go from the closest street to an
 364                     // interpolation line because the closest interpolation
 365                     // may have a different street segments as a parent.
 366                     // Therefore allow an interpolation line to take precedence
 367                     // even when the street is closer.
 368                     $fDistance = $iRankAddress < 28 ? 0.001 : $aPlace['distance'];
 369                 }
 370
 371                 $aHouse = $this->lookupInterpolation($sPointSQL, $fDistance);
 372                 Debug::printVar('Interpolation result', $aPlace);
 373
 374                 if ($aHouse) {
 375                     $oResult = new Result($aHouse['place_id'], Result::TABLE_OSMLINE);
 376                     $iRndNum = max(0, round($aHouse['fhnr'] / $aHouse['step']) * $aHouse['step']);
 377                     $oResult->iHouseNumber = $aHouse['startnumber'] + $iRndNum;
 378                     if ($oResult->iHouseNumber > $aHouse['endnumber']) {
 379                         $oResult->iHouseNumber = $aHouse['endnumber'];
 380                     }
 381                     $aPlace = $aHouse;
 382                 }
 383             }
 384
 385             if (!$aPlace) {
 386                 // if no POI or street is found ...
 387                 $oResult = $this->lookupLargeArea($sPointSQL, 25);
 388             }
 389         } else {
 390             // lower than street level ($iMaxRank < 26 )
 391             $oResult = $this->lookupLargeArea($sPointSQL, $this->iMaxRank);
 392         }
 393
 394         Debug::printVar('Final result', $oResult);
 395         return $oResult;
 396     }
 397 }