new query if no polygon is found

[nominatim.git] / lib / ReverseGeocode.php

diff --git a/lib/ReverseGeocode.php b/lib/ReverseGeocode.php
index cb8c0c6bcf84b7febe7b17a053b12ab1cfd9fe8f..422159311557ea5cb77edca281b68cb1ebbbe0d4 100644 (file)
--- a/lib/ReverseGeocode.php
+++ b/lib/ReverseGeocode.php
@@ -1,139 +1,290 @@
 <?php
 <?php

-       class ReverseGeocode
-       {
-               protected $oDB;

 
 

-               protected $fLat;
-               protected $fLon;
-               protected $iMaxRank = 28;
+namespace Nominatim;

 
 

-               protected $aLangPrefOrder = array();
+require_once(CONST_BasePath.'/lib/Result.php');

 
 

-               protected $bShowAddressDetails = true;
+class ReverseGeocode
+{
+    protected $oDB;
+    protected $iMaxRank = 28;

 
 

-               function ReverseGeocode(&$oDB)
-               {
-                       $this->oDB =& $oDB;
-               }

 
 

-               function setLanguagePreference($aLangPref)
-               {
-                       $this->aLangPrefOrder = $aLangPref;
-               }
+    public function __construct(&$oDB)
+    {
+        $this->oDB =& $oDB;
+    }

 
 

-               function setIncludeAddressDetails($bAddressDetails = true)
-               {
-                       $this->bAddressDetails = $bAddressDetails;
-               }

 
 

-               function setLatLon($fLat, $fLon)
-               {
-                       $this->fLat = (float)$fLat;
-                       $this->fLon = (float)$fLon;
-               }
+    public function setZoom($iZoom)
+    {
+        // Zoom to rank, this could probably be calculated but a lookup gives fine control
+        $aZoomRank = array(
+                      0 => 2, // Continent / Sea
+                      1 => 2,
+                      2 => 2,
+                      3 => 4, // Country
+                      4 => 4,
+                      5 => 8, // State
+                      6 => 10, // Region
+                      7 => 10,
+                      8 => 12, // County
+                      9 => 12,
+                      10 => 17, // City
+                      11 => 17,
+                      12 => 18, // Town / Village
+                      13 => 18,
+                      14 => 22, // Suburb
+                      15 => 22,
+                      16 => 26, // Street, TODO: major street?
+                      17 => 26,
+                      18 => 30, // or >, Building
+                      19 => 30, // or >, Building
+                     );
+        $this->iMaxRank = (isset($iZoom) && isset($aZoomRank[$iZoom]))?$aZoomRank[$iZoom]:28;
+    }

 
 

-               function setRank($iRank)
-               {
-                       $this->iMaxRank = $iRank;
-               }
+    /**
+     * Find the closest interpolation with the given search diameter.
+     *
+     * @param string $sPointSQL   Reverse geocoding point as SQL
+     * @param float  $fSearchDiam Search diameter
+     *
+     * @return Record of the interpolation or null.
+     */
+    protected function lookupInterpolation($sPointSQL, $fSearchDiam)
+    {
+        $sSQL = 'SELECT place_id, parent_place_id, 30 as rank_search,';
+        $sSQL .= '  ST_LineLocatePoint(linegeo,'.$sPointSQL.') as fraction,';
+        $sSQL .= '  startnumber, endnumber, interpolationtype,';
+        $sSQL .= '  ST_Distance(linegeo,'.$sPointSQL.') as distance';
+        $sSQL .= ' FROM location_property_osmline';
+        $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';
+        $sSQL .= ' and indexed_status = 0 and startnumber is not NULL ';
+        $sSQL .= ' ORDER BY distance ASC limit 1';

 
 

-               function setZoom($iZoom)
-               {
-                       // Zoom to rank, this could probably be calculated but a lookup gives fine control
-                       $aZoomRank = array(
-                               0 => 2, // Continent / Sea
-                               1 => 2,
-                               2 => 2,
-                               3 => 4, // Country
-                               4 => 4,
-                               5 => 8, // State
-                               6 => 10, // Region
-                               7 => 10,
-                               8 => 12, // County
-                               9 => 12,
-                               10 => 17, // City
-                               11 => 17,
-                               12 => 18, // Town / Village
-                               13 => 18,
-                               14 => 22, // Suburb
-                               15 => 22,
-                               16 => 26, // Street, TODO: major street?
-                               17 => 26,
-                               18 => 30, // or >, Building
-                               19 => 30, // or >, Building
-                               );
-                       $this->iMaxRank = (isset($iZoom) && isset($aZoomRank[$iZoom]))?$aZoomRank[$iZoom]:28;
-               }
+        return chksql(
+            $this->oDB->getRow($sSQL),
+            'Could not determine closest housenumber on an osm interpolation line.'
+        );
+    }
+    
+    protected function noPolygonFound($sPointSQL, $iMaxRank)
+    {
+        $sSQL = 'SELECT * FROM country_osm_grid';
+        $sSQL .= ' WHERE ST_CONTAINS (geometry, '.$sPointSQL.' )';
+        
+        $aPoly = chksql(
+            $this->oDB->getRow($sSQL),
+            'Could not determine polygon containing the point.'
+        );
+        if ($aPoly) {
+            $sCountryCode = $aPoly['country_code'];
+            
+            $sSQL = 'SELECT *, ST_distance('.$sPointSQL.', geometry) as distance';
+            $sSQL .= ' FROM placex';
+            $sSQL .= ' WHERE osm_type = \'N\'';
+            $sSQL .= ' AND country_code = \''.$sCountryCode.'\'';
+            $sSQL .= ' AND rank_address > 0';
+            $sSQL .= ' AND rank_address <= ' .Min(25, $iMaxRank);
+            $sSQL .= ' AND type != \'postcode\'';
+            $sSQL .= ' AND name IS NOT NULL ';
+            $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
+            $sSQL .= ' ORDER BY distance ASC, rank_address DESC';
+            $sSQL .= ' LIMIT 1';
+            
+            if (CONST_Debug) var_dump($sSQL);
+            $aPlacNode = chksql(
+                $this->oDB->getRow($sSQL),
+                'Could not determine place node.'
+            );
+            if ($aPlacNode) {
+                return $aPlacNode;
+            }
+        }
+    }
+    
+    protected function lookupPolygon($sPointSQL, $iMaxRank)
+    {
+    
+        $oResult = null;
+        $aPlace = null;
+        
+        $sSQL = 'SELECT * FROM';
+        $sSQL .= '(select place_id,parent_place_id,rank_address,country_code, geometry';
+        $sSQL .= ' FROM placex';
+        $sSQL .= ' WHERE ST_GeometryType(geometry) in (\'ST_Polygon\', \'ST_MultiPolygon\')';
+        $sSQL .= ' AND rank_address <= ' .Min(25, $iMaxRank);
+        $sSQL .= ' AND geometry && '.$sPointSQL;
+        $sSQL .= ' AND type != \'postcode\' ';
+        $sSQL .= ' AND name is not null';
+        $sSQL .= ' AND indexed_status = 0 and linked_place_id is null';
+        $sSQL .= ' ORDER BY rank_address DESC LIMIT 50 ) as a';
+        $sSQL .= ' WHERE ST_CONTAINS(geometry, '.$sPointSQL.' )';
+        $sSQL .= ' ORDER BY rank_address DESC LIMIT 1';

 
 

-               function lookup()
-               {
-                       $sPointSQL = 'ST_SetSRID(ST_Point('.$this->fLon.','.$this->fLat.'),4326)';
-                       $iMaxRank = $this->iMaxRank;
+        $aPoly = chksql(
+            $this->oDB->getRow($sSQL),
+            'Could not determine polygon containing the point.'
+        );
+        if ($aPoly) {
+            $iParentPlaceID = $aPoly['parent_place_id'];
+            $iRankAddress = $aPoly['rank_address'];
+            $iPlaceID = $aPoly['place_id'];
+            
+            if ($iRankAddress != $iMaxRank) {
+                $sSQL = 'SELECT *';
+                $sSQL .= ' FROM (';
+                $sSQL .= ' SELECT place_id, rank_address,country_code, geometry,';
+                $sSQL .= ' ST_distance('.$sPointSQL.', geometry) as distance';
+                $sSQL .= ' FROM placex';
+                $sSQL .= ' WHERE osm_type = \'N\'';
+                $sSQL .= ' AND rank_address > '.$iRankAddress;
+                $sSQL .= ' AND rank_address <= ' .Min(25, $iMaxRank);
+                $sSQL .= ' AND type != \'postcode\'';
+                $sSQL .= ' AND name IS NOT NULL ';
+                $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
+                // preselection through bbox
+                $sSQL .= ' AND (SELECT geometry FROM placex WHERE place_id = '.$iPlaceID.') && geometry';
+                $sSQL .= ' ORDER BY distance ASC,';
+                $sSQL .= ' rank_address DESC';
+                $sSQL .= ' limit 500) as a';
+                $sSQL .= ' WHERE ST_CONTAINS((SELECT geometry FROM placex WHERE place_id = '.$iPlaceID.'), geometry )';
+                $sSQL .= ' ORDER BY distance ASC, rank_address DESC';
+                $sSQL .= ' LIMIT 1';
+                
+                if (CONST_Debug) var_dump($sSQL);
+                $aPlacNode = chksql(
+                    $this->oDB->getRow($sSQL),
+                    'Could not determine place node.'
+                );
+                if ($aPlacNode) {
+                    return $aPlacNode;
+                }
+            }
+        }
+        return $aPoly;
+    }

 
 

-                       // Find the nearest point
-                       $fSearchDiam = 0.0004;
-                       $iPlaceID = null;
-                       $aArea = false;
-                       $fMaxAreaDistance = 1;
-                       while(!$iPlaceID && $fSearchDiam < $fMaxAreaDistance)
-                       {
-                               $fSearchDiam = $fSearchDiam * 2;
+    public function lookup($fLat, $fLon, $bDoInterpolation = true)
+    {
+        return $this->lookupPoint(
+            'ST_SetSRID(ST_Point('.$fLon.','.$fLat.'),4326)',
+            $bDoInterpolation
+        );
+    }

 
 

-                               // If we have to expand the search area by a large amount then we need a larger feature
-                               // then there is a limit to how small the feature should be
-                               if ($fSearchDiam > 2 && $iMaxRank > 4) $iMaxRank = 4;
-                               if ($fSearchDiam > 1 && $iMaxRank > 9) $iMaxRank = 8;
-                               if ($fSearchDiam > 0.8 && $iMaxRank > 10) $iMaxRank = 10;
-                               if ($fSearchDiam > 0.6 && $iMaxRank > 12) $iMaxRank = 12;
-                               if ($fSearchDiam > 0.2 && $iMaxRank > 17) $iMaxRank = 17;
-                               if ($fSearchDiam > 0.1 && $iMaxRank > 18) $iMaxRank = 18;
-                               if ($fSearchDiam > 0.008 && $iMaxRank > 22) $iMaxRank = 22;
-                               if ($fSearchDiam > 0.001 && $iMaxRank > 26) $iMaxRank = 26;
+    public function lookupPoint($sPointSQL, $bDoInterpolation = true)
+    {
+        
+        $iMaxRank = $this->iMaxRank;

 
 

-                               $sSQL = 'select place_id,parent_place_id,rank_search from placex';
-                               $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', geometry, '.$fSearchDiam.')';
-                               $sSQL .= ' and rank_search != 28 and rank_search >= '.$iMaxRank;
-                               $sSQL .= ' and (name is not null or housenumber is not null)';
-                               $sSQL .= ' and class not in (\'waterway\',\'railway\',\'tunnel\',\'bridge\')';
-                               $sSQL .= ' and indexed_status = 0 ';
-                               $sSQL .= ' and (ST_GeometryType(geometry) not in (\'ST_Polygon\',\'ST_MultiPolygon\') ';
-                               $sSQL .= ' OR ST_DWithin('.$sPointSQL.', centroid, '.$fSearchDiam.'))';
-                               $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', geometry) ASC limit 1';
-                               if (CONST_Debug) var_dump($sSQL);
-                               $aPlace = $this->oDB->getRow($sSQL);
-                               if (PEAR::IsError($aPlace))
-                               {
-                                       failInternalError("Could not determine closest place.", $sSQL, $aPlace);
-                               }
-                               $iPlaceID = $aPlace['place_id'];
-                               $iParentPlaceID = $aPlace['parent_place_id'];
-                       }
+        // Find the nearest point
+        $fSearchDiam = 0.006;
+        $oResult = null;
+        $aPlace = null;
+        $fMaxAreaDistance = 1;
+        $bIsTigerStreet = false;
+        
+        // try with interpolations before continuing
+        if ($bDoInterpolation && $iMaxRank >= 30) {
+            $aHouse = $this->lookupInterpolation($sPointSQL, $fSearchDiam/3);

 
 

-                       // The point we found might be too small - use the address to find what it is a child of
-                       if ($iPlaceID && $iMaxRank < 28)
-                       {
-                               if ($aPlace['rank_search'] > 28 && $iParentPlaceID)
-                               {
-                                       $iPlaceID = $iParentPlaceID;
-                               }
-                               $sSQL = "select address_place_id from place_addressline where place_id = $iPlaceID order by abs(cached_rank_address - $iMaxRank) asc,cached_rank_address desc,isaddress desc,distance desc limit 1";
-                               $iPlaceID = $this->oDB->getOne($sSQL);
-                               if (PEAR::IsError($iPlaceID))
-                               {
-                                       failInternalError("Could not get parent for place.", $sSQL, $iPlaceID);
-                               }
-                               if (!$iPlaceID)
-                               {
-                                       $iPlaceID = $aPlace['place_id'];
-                               }
-                       }
+            if ($aHouse) {
+                $oResult = new Result($aHouse['place_id'], Result::TABLE_OSMLINE);
+                $oResult->iHouseNumber = closestHouseNumber($aHouse);

 
 

-                       $oPlaceLookup = new PlaceLookup($this->oDB);
-                       $oPlaceLookup->setLanguagePreference($this->aLangPrefOrder);
-                       $oPlaceLookup->setIncludeAddressDetails($this->bAddressDetails);
-                       $oPlaceLookup->setPlaceId($iPlaceID);
-
-                       return $oPlaceLookup->lookup();
-               }
-       }
-?>
+                $aPlace = $aHouse;
+                $iParentPlaceID = $aHouse['parent_place_id']; // the street
+                $iMaxRank = 30;
+                
+                return $oResult;
+            }
+        }// no interpolation found, continue search
+        
+        // for POI or street level
+        if ($iMaxRank >= 26) {
+            $sSQL = 'select place_id,parent_place_id,rank_address,country_code,';
+            $sSQL .= 'CASE WHEN ST_GeometryType(geometry) in (\'ST_Polygon\',\'ST_MultiPolygon\') THEN ST_distance('.$sPointSQL.', centroid)';
+            $sSQL .= ' ELSE ST_distance('.$sPointSQL.', geometry) ';
+            $sSQL .= ' END as distance';
+            $sSQL .= ' FROM ';
+            $sSQL .= ' placex';
+            $sSQL .= '   WHERE ST_DWithin('.$sPointSQL.', geometry, '.$fSearchDiam.')';
+            $sSQL .= '   AND';
+            // only streets
+            if ($iMaxRank == 26) {
+                $sSQL .= ' rank_address = 26';
+            } else {
+                $sSQL .= ' rank_address >= 26';
+            }
+            $sSQL .= ' and (name is not null or housenumber is not null';
+            $sSQL .= ' or rank_address between 26 and 27)';
+            $sSQL .= ' and class not in (\'waterway\',\'railway\',\'tunnel\',\'bridge\',\'man_made\')';
+            $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
+            $sSQL .= ' and (ST_GeometryType(geometry) not in (\'ST_Polygon\',\'ST_MultiPolygon\') ';
+            $sSQL .= ' OR ST_DWithin('.$sPointSQL.', centroid, '.$fSearchDiam.'))';
+            $sSQL .= ' ORDER BY distance ASC limit 1';
+            if (CONST_Debug) var_dump($sSQL);
+            $aPlace = chksql(
+                $this->oDB->getRow($sSQL),
+                'Could not determine closest place.'
+            );
+            
+            if ($aPlace) {
+                    $iPlaceID = $aPlace['place_id'];
+                    $oResult = new Result($iPlaceID);
+                    $iParentPlaceID = $aPlace['parent_place_id'];
+                    // if street and maxrank > streetlevel
+                if (($aPlace['rank_address'] == 26 || $aPlace['rank_address'] == 27)&& $iMaxRank > 27) {
+                    // find the closest object (up to a certain radius) of which the street is a parent of
+                    $sSQL = ' select place_id,parent_place_id,rank_address,country_code,';
+                    $sSQL .= ' ST_distance('.$sPointSQL.', geometry) as distance';
+                    $sSQL .= ' FROM ';
+                    $sSQL .= ' placex';
+                    // radius ?
+                    $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', geometry, 0.001)';
+                    $sSQL .= ' AND parent_place_id = '.$iPlaceID;
+                    $sSQL .= ' and rank_address != 28';
+                    $sSQL .= ' and (name is not null or housenumber is not null';
+                    $sSQL .= ' or rank_address between 26 and 27)';
+                    $sSQL .= ' and class not in (\'waterway\',\'railway\',\'tunnel\',\'bridge\',\'man_made\')';
+                    $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
+                    $sSQL .= ' ORDER BY distance ASC limit 1';
+                    if (CONST_Debug) var_dump($sSQL);
+                    $aStreet = chksql(
+                        $this->oDB->getRow($sSQL),
+                        'Could not determine closest place.'
+                    );
+                    if ($aStreet) {
+                        $iPlaceID = $aStreet['place_id'];
+                        $oResult = new Result($iPlaceID);
+                        $iParentPlaceID = $aStreet['parent_place_id'];
+                    }
+                }
+            } else {
+                $aPlace = $this->lookupPolygon($sPointSQL, $iMaxRank);
+                if ($aPlace) {
+                    $oResult = new Result($aPlace['place_id']);
+                } else {
+                    $aPlace = $this->noPolygonFound($sPointSQL, $iMaxRank);
+                    if ($aPlace) {
+                        $oResult = new Result($aPlace['place_id']);
+                    }
+                }
+            }
+            // lower than street level ($iMaxRank < 26 )
+        } else {
+            $aPlace = $this->lookupPolygon($sPointSQL, $iMaxRank);
+            if ($aPlace) {
+                $oResult = new Result($aPlace['place_id']);
+            } else {
+                $aPlace = $this->noPolygonFound($sPointSQL, $iMaxRank);
+                if ($aPlace) {
+                    $oResult = new Result($aPlace['place_id']);
+                }
+            }
+        }
+        return $oResult;
+    }
+}