Merge remote-tracking branch 'upstream/master'

[nominatim.git] / lib / ReverseGeocode.php

diff --git a/lib/ReverseGeocode.php b/lib/ReverseGeocode.php
index ae7c852766781019a2c149f1ca3ff7e9bf379f0e..60f3544916c09a4ee7b755f4da7244c873bdc175 100644 (file)
--- a/lib/ReverseGeocode.php
+++ b/lib/ReverseGeocode.php
@@ -47,12 +47,13 @@ class ReverseGeocode
     /**
      * Find the closest interpolation with the given search diameter.
      *
     /**
      * Find the closest interpolation with the given search diameter.
      *

-     * @param string $sPointSQL   Reverse geocoding point as SQL
-     * @param float  $fSearchDiam Search diameter
+     * @param string  $sPointSQL      Reverse geocoding point as SQL
+     * @param float   $fSearchDiam    Search diameter
+     * @param integer $iParentPlaceID Id of parent object

      *
      * @return Record of the interpolation or null.
      */
      *
      * @return Record of the interpolation or null.
      */

-    protected function lookupInterpolation($sPointSQL, $fSearchDiam)
+    protected function lookupInterpolation($sPointSQL, $fSearchDiam, $iParentPlaceID = null)

     {
         $sSQL = 'SELECT place_id, parent_place_id, 30 as rank_search,';
         $sSQL .= '  ST_LineLocatePoint(linegeo,'.$sPointSQL.') as fraction,';
     {
         $sSQL = 'SELECT place_id, parent_place_id, 30 as rank_search,';
         $sSQL .= '  ST_LineLocatePoint(linegeo,'.$sPointSQL.') as fraction,';


@@ -61,6 +62,9 @@ class ReverseGeocode
         $sSQL .= ' FROM location_property_osmline';
         $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';
         $sSQL .= ' and indexed_status = 0 and startnumber is not NULL ';
         $sSQL .= ' FROM location_property_osmline';
         $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';
         $sSQL .= ' and indexed_status = 0 and startnumber is not NULL ';

+        if (isset($iParentPlaceID)) {
+            $sSQL .= ' and parent_place_id = '.$iParentPlaceID;
+        }

         $sSQL .= ' ORDER BY distance ASC limit 1';
 
         return chksql(
         $sSQL .= ' ORDER BY distance ASC limit 1';
 
         return chksql(


@@ -68,39 +72,56 @@ class ReverseGeocode
             'Could not determine closest housenumber on an osm interpolation line.'
         );
     }
             'Could not determine closest housenumber on an osm interpolation line.'
         );
     }

-    
-    protected function lookupPolygon($sPointSQL, $iMaxRank)
+
+    protected function polygonFunctions($sPointSQL, $iMaxRank)

     {
     {

-        $sSQL = 'select place_id,parent_place_id,rank_search,country_code, geometry';
-        $sSQL .= ' FROM placex';
-        $sSQL .= ' WHERE ST_GeometryType(geometry) in (\'ST_Polygon\',\'ST_MultiPolygon\')';
-        $sSQL .= ' AND rank_search <= LEAST(25, '.$iMaxRank.')';
-        $sSQL .= ' AND ST_CONTAINS(geometry, '.$sPointSQL.' )';
-        $sSQL .= ' AND type != \'postcode\' ';
-        $sSQL .= ' AND name IS NOT NULL ';
-        $sSQL .= ' ORDER BY rank_search DESC LIMIT 1';
+        // starts the nopolygonFound function if no polygon is found with the lookupPolygon function
+        $oResult = null;
+
+        $aPlace = $this->lookupPolygon($sPointSQL, $iMaxRank);
+        if ($aPlace) {
+            $oResult = new Result($aPlace['place_id']);
+        // if no polygon which contains the searchpoint is found,
+        // the noPolygonFound function searches in the country_osm_grid table for a polygon
+        } elseif (!$aPlace && $iMaxRank > 4) {
+            $aPlace = $this->noPolygonFound($sPointSQL, $iMaxRank);
+            if ($aPlace) {
+                $oResult = new Result($aPlace['place_id']);
+            }
+        }
+        return $oResult;
+    }
+
+    protected function noPolygonFound($sPointSQL, $iMaxRank)
+    {
+        // searches for polygon in table country_osm_grid which contains the searchpoint
+        // and searches for the nearest place node to the searchpoint in this polygon
+        $sSQL = 'SELECT country_code FROM country_osm_grid';
+        $sSQL .= ' WHERE ST_CONTAINS (geometry, '.$sPointSQL.') limit 1';

 
         $aPoly = chksql(
             $this->oDB->getRow($sSQL),
             'Could not determine polygon containing the point.'
         );
         if ($aPoly) {
 
         $aPoly = chksql(
             $this->oDB->getRow($sSQL),
             'Could not determine polygon containing the point.'
         );
         if ($aPoly) {

-            $iParentPlaceID = $aPoly['parent_place_id'];
-            $iRankSearch = $aPoly['rank_search'];
-            $iGeometry = $aPoly['geometry'];
-            
-            $sSQL = 'select place_id,parent_place_id,rank_search,country_code, linked_place_id,';
-            $sSQL .='  ST_distance('.$sPointSQL.', geometry) as distance';
+            $sCountryCode = $aPoly['country_code'];
+
+            // look for place nodes with the given country code
+            $sSQL = 'SELECT place_id FROM';
+            $sSQL .= ' (SELECT place_id, rank_search,';
+            $sSQL .= '         ST_distance('.$sPointSQL.', geometry) as distance';

             $sSQL .= ' FROM placex';
             $sSQL .= ' WHERE osm_type = \'N\'';
             $sSQL .= ' FROM placex';
             $sSQL .= ' WHERE osm_type = \'N\'';

-            $sSQL .= ' AND rank_search >= '.$iRankSearch;
-            $sSQL .= ' AND rank_search <= LEAST(25, '.$iMaxRank.')';
-            $sSQL .= ' AND ST_CONTAINS(\''.$iGeometry.'\'::geometry, geometry )';
-            $sSQL .= ' AND type != \'postcode\'';
+            $sSQL .= ' AND country_code = \''.$sCountryCode.'\'';
+            $sSQL .= ' AND rank_search between 5 and ' .min(25, $iMaxRank);
+            $sSQL .= ' AND class = \'place\' AND type != \'postcode\'';

             $sSQL .= ' AND name IS NOT NULL ';
             $sSQL .= ' AND name IS NOT NULL ';

-            $sSQL .= ' ORDER BY distance ASC,';
-            $sSQL .= ' rank_search DESC';
-            $sSQL .= ' limit 1';
+            $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
+            $sSQL .= ' AND ST_DWithin('.$sPointSQL.', geometry, 5.0)) p ';
+            $sSQL .= 'WHERE distance <= reverse_place_diameter(rank_search)';
+            $sSQL .= ' ORDER BY rank_search DESC, distance ASC';
+            $sSQL .= ' LIMIT 1';
+

             if (CONST_Debug) var_dump($sSQL);
             $aPlacNode = chksql(
                 $this->oDB->getRow($sSQL),
             if (CONST_Debug) var_dump($sSQL);
             $aPlacNode = chksql(
                 $this->oDB->getRow($sSQL),


@@ -109,10 +130,97 @@ class ReverseGeocode
             if ($aPlacNode) {
                 return $aPlacNode;
             }
             if ($aPlacNode) {
                 return $aPlacNode;
             }

+
+            // still nothing, then return the country object
+            $sSQL = 'SELECT place_id, ST_distance('.$sPointSQL.', centroid) as distance';
+            $sSQL .= ' FROM placex';
+            $sSQL .= ' WHERE country_code = \''.$sCountryCode.'\'';
+            $sSQL .= ' AND rank_search = 4 AND rank_address = 4';
+            $sSQL .= ' AND class in (\'boundary\',  \'place\')';
+            $sSQL .= ' ORDER BY distance ASC';
+
+            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)
+    {
+        // searches for polygon where the searchpoint is within
+        // if a polygon is found, placenodes with a higher rank are searched inside the polygon
+
+        // polygon search begins at suburb-level
+        if ($iMaxRank > 25) $iMaxRank = 25;
+        // no polygon search over country-level
+        if ($iMaxRank < 5) $iMaxRank = 5;
+        // search for polygon
+        $sSQL = 'SELECT place_id, parent_place_id, rank_address, rank_search FROM';
+        $sSQL .= '(select place_id, parent_place_id, rank_address, rank_search, country_code, geometry';
+        $sSQL .= ' FROM placex';
+        $sSQL .= ' WHERE ST_GeometryType(geometry) in (\'ST_Polygon\', \'ST_MultiPolygon\')';
+        $sSQL .= ' AND rank_address Between 5 AND ' .$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';
+
+        $aPoly = chksql(
+            $this->oDB->getRow($sSQL),
+            'Could not determine polygon containing the point.'
+        );
+        if ($aPoly) {
+        // if a polygon is found, search for placenodes begins ...
+            $iParentPlaceID = $aPoly['parent_place_id'];
+            $iRankAddress = $aPoly['rank_address'];
+            $iRankSearch = $aPoly['rank_search'];
+            $iPlaceID = $aPoly['place_id'];
+
+            if ($iRankAddress != $iMaxRank) {
+                $sSQL = 'SELECT place_id FROM ';
+                $sSQL .= '(SELECT place_id, rank_search, country_code, geometry,';
+                $sSQL .= ' ST_distance('.$sPointSQL.', geometry) as distance';
+                $sSQL .= ' FROM placex';
+                $sSQL .= ' WHERE osm_type = \'N\'';
+                // using rank_search because of a better differentiation
+                // for place nodes at rank_address 16
+                $sSQL .= ' AND rank_search > '.$iRankSearch;
+                $sSQL .= ' AND rank_search <= '.$iMaxRank;
+                $sSQL .= ' AND class = \'place\'';
+                $sSQL .= ' AND type != \'postcode\'';
+                $sSQL .= ' AND name IS NOT NULL ';
+                $sSQL .= ' AND indexed_status = 0 AND linked_place_id is null';
+                $sSQL .= ' AND ST_DWithin('.$sPointSQL.', geometry, reverse_place_diameter('.$iRankSearch.'::smallint))';
+                $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 .= ' AND distance <= reverse_place_diameter(rank_search)';
+                $sSQL .= ' ORDER BY distance ASC, rank_search 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;
     }
 
         }
         return $aPoly;
     }
 

+

     public function lookup($fLat, $fLon, $bDoInterpolation = true)
     {
         return $this->lookupPoint(
     public function lookup($fLat, $fLon, $bDoInterpolation = true)
     {
         return $this->lookupPoint(


@@ -123,7 +231,10 @@ class ReverseGeocode
 
     public function lookupPoint($sPointSQL, $bDoInterpolation = true)
     {
 
     public function lookupPoint($sPointSQL, $bDoInterpolation = true)
     {

-        
+        // starts if the search is on POI or street level,
+        // searches for the nearest POI or street,
+        // if a street is found and a POI is searched for,
+        // the nearest POI which the found street is a parent of is choosen.

         $iMaxRank = $this->iMaxRank;
 
         // Find the nearest point
         $iMaxRank = $this->iMaxRank;
 
         // Find the nearest point


@@ -132,11 +243,10 @@ class ReverseGeocode
         $aPlace = null;
         $fMaxAreaDistance = 1;
         $bIsTigerStreet = false;
         $aPlace = null;
         $fMaxAreaDistance = 1;
         $bIsTigerStreet = false;

-        
+

         // for POI or street level
         // for POI or street level

-        if ( $iMaxRank >= 26 ) {
-            
-            $sSQL = 'select place_id,parent_place_id,rank_search,country_code,';
+        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 .= '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';


@@ -146,14 +256,13 @@ class ReverseGeocode
             $sSQL .= '   AND';
             // only streets
             if ($iMaxRank == 26) {
             $sSQL .= '   AND';
             // only streets
             if ($iMaxRank == 26) {

-                $sSQL .= ' rank_search != 28 and rank_search = 26';
+                $sSQL .= ' rank_address = 26';

             } else {
             } else {

-                $sSQL .= ' rank_search != 28 and rank_search >= 26';
+                $sSQL .= ' rank_address between 26 and '.$iMaxRank;

             }
             $sSQL .= ' and (name is not null or housenumber is not null';
             }
             $sSQL .= ' and (name is not null or housenumber is not null';

-            $sSQL .= '      or rank_search between 26 and 27)';
-            $sSQL .= ' and type not in (\'proposed\')';
-            $sSQL .= ' and class not in (\'waterway\',\'railway\',\'tunnel\',\'bridge\',\'man_made\')';
+            $sSQL .= ' or rank_address between 26 and 27)';
+            $sSQL .= ' and class not in (\'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 .= ' 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.'))';


@@ -163,58 +272,92 @@ class ReverseGeocode
                 $this->oDB->getRow($sSQL),
                 'Could not determine closest place.'
             );
                 $this->oDB->getRow($sSQL),
                 'Could not determine closest place.'
             );

-            
+

             if ($aPlace) {
             if ($aPlace) {

-                    $iPlaceID = $aPlace['place_id'];
-                    $oResult = new Result($iPlaceID);
-                    $iParentPlaceID = $aPlace['parent_place_id'];
-                    // if street and maxrank > streetlevel
-                    if (($aPlace['rank_search'] == 26 || $aPlace['rank_search'] == 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_search,country_code,';
-                        $sSQL .= ' ST_distance('.$sPointSQL.', geometry) as distance';
-                        $sSQL .= ' FROM ';
-                        $sSQL .= ' placex';
-                        // radius ?
-                        $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', geometry, 0.003)';
-                        $sSQL .= ' AND parent_place_id = '.$iPlaceID;
-                        $sSQL .= ' and (name is not null or housenumber is not 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) {
-                        // if place node is found adress goes over linked_place_id
-                        if (!empty($aPlace['linked_place_id'])) {
-                            $oResult = new Result($aPlace['linked_place_id']);
-                        }else{
-                            $oResult = new Result($aPlace['place_id']);
+                $iDistance = $aPlace['distance'];
+                $iPlaceID = $aPlace['place_id'];
+                $oResult = new Result($iPlaceID);
+                $iParentPlaceID = $aPlace['parent_place_id'];
+
+                if ($bDoInterpolation && $iMaxRank >= 30) {
+                    if ($aPlace['rank_address'] <=27) {
+                        $iDistance = 0.001;
+                    }
+                    $aHouse = $this->lookupInterpolation($sPointSQL, $iDistance);
+
+                    if ($aHouse) {
+                        $oResult = new Result($aHouse['place_id'], Result::TABLE_OSMLINE);
+                        $oResult->iHouseNumber = closestHouseNumber($aHouse);
+                    }
+                }
+
+                // if street and maxrank > streetlevel
+                if (($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 .= ' and class not in (\'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) {
+                        $iDistance = $aStreet['distance'];
+                        $iPlaceID = $aStreet['place_id'];
+                        $oResult = new Result($iPlaceID);
+                        $iParentPlaceID = $aStreet['parent_place_id'];
+
+                        if ($bDoInterpolation && $iMaxRank >= 30) {
+                            $aHouse = $this->lookupInterpolation($sPointSQL, $iDistance, $iParentPlaceID);
+
+                            if ($aHouse) {
+                                $oResult = new Result($aHouse['place_id'], Result::TABLE_OSMLINE);
+                                $oResult->iHouseNumber = closestHouseNumber($aHouse);
+                            }

                         }
                     }
                 }
                         }
                     }
                 }

-            // lower than street level ($iMaxRank < 26 )
-            }else{
-                $aPlace = $this->lookupPolygon($sPointSQL, $iMaxRank);
-                if ($aPlace) {
-                // if place node is found adress goes over linked_place_id
-                    if (!empty($aPlace['linked_place_id'])) {
-                        $oResult = new Result($aPlace['linked_place_id']);
-                    }else{
-                        $oResult = new Result($aPlace['place_id']);
+
+                  // In the US we can check TIGER data for nearest housenumber
+                if (CONST_Use_US_Tiger_Data && $aPlace['country_code'] == 'us' && $this->iMaxRank >= 28) {
+                    $fSearchDiam = $aPlace['rank_address'] > 28 ? $aPlace['distance'] : 0.001;
+                    $sSQL = 'SELECT place_id,parent_place_id,30 as rank_search,';
+                    $sSQL .= 'ST_LineLocatePoint(linegeo,'.$sPointSQL.') as fraction,';
+                    $sSQL .= 'ST_distance('.$sPointSQL.', linegeo) as distance,';
+                    $sSQL .= 'startnumber,endnumber,interpolationtype';
+                    $sSQL .= ' FROM location_property_tiger WHERE parent_place_id = '.$oResult->iId;
+                    $sSQL .= ' AND ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';
+                    $sSQL .= ' ORDER BY distance ASC limit 1';
+                    if (CONST_Debug) var_dump($sSQL);
+                    $aPlaceTiger = chksql(
+                        $this->oDB->getRow($sSQL),
+                        'Could not determine closest Tiger place.'
+                    );
+                    if ($aPlaceTiger) {
+                        if (CONST_Debug) var_dump('found Tiger housenumber', $aPlaceTiger);
+                        $aPlace = $aPlaceTiger;
+                        $oResult = new Result($aPlace['place_id'], Result::TABLE_TIGER);
+                        $oResult->iHouseNumber = closestHouseNumber($aPlaceTiger);

                     }
                 }
                     }
                 }

+            // if no POI or street is found ...
+            } else {
+                $oResult = $this->PolygonFunctions($sPointSQL, $iMaxRank);

             }
             }

+            // lower than street level ($iMaxRank < 26 )
+        } else {
+            $oResult = $this->PolygonFunctions($sPointSQL, $iMaxRank);
+        }

         return $oResult;
     }
         return $oResult;
     }

-
-}
\ No newline at end of file
+}