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