in /details JSON output add check if place (type) has an icon set

[nominatim.git] / lib / ReverseGeocode.php

diff --git a/lib/ReverseGeocode.php b/lib/ReverseGeocode.php
index 6d3cc8293b4a8a11c95b0470fbed7725b7494a73..fc5e04d6fcc5b82ec2f3ba614673a831e39522ba 100644 (file)
--- a/lib/ReverseGeocode.php
+++ b/lib/ReverseGeocode.php
@@ -2,6 +2,8 @@
 
 namespace Nominatim;
 
 
 namespace Nominatim;
 

+require_once(CONST_BasePath.'/lib/Result.php');
+

 class ReverseGeocode
 {
     protected $oDB;
 class ReverseGeocode
 {
     protected $oDB;


@@ -53,169 +55,312 @@ class ReverseGeocode
     protected function lookupInterpolation($sPointSQL, $fSearchDiam)
     {
         $sSQL = 'SELECT place_id, parent_place_id, 30 as rank_search,';
     protected function lookupInterpolation($sPointSQL, $fSearchDiam)
     {
         $sSQL = 'SELECT place_id, parent_place_id, 30 as rank_search,';

-        $sSQL .= ' ST_LineLocatePoint(linegeo,'.$sPointSQL.') as fraction';
-        $sSQL .= ' , ST_Distance(linegeo,'.$sPointSQL.') as distance';
+        $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 .= ' FROM location_property_osmline';
         $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';

-        $sSQL .= ' and indexed_status = 0 ';
-        $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', linegeo) ASC limit 1';
+        $sSQL .= ' and indexed_status = 0 and startnumber is not NULL ';
+        $sSQL .= ' ORDER BY distance ASC limit 1';

 
         return chksql(
             $this->oDB->getRow($sSQL),
 
         return chksql(
             $this->oDB->getRow($sSQL),

-            "Could not determine closest housenumber on an osm interpolation line."
+            'Could not determine closest housenumber on an osm interpolation line.'

         );
     }
 
         );
     }
 

-    /* lookup()
-     * returns { place_id =>, type => '(osm|tiger)' }
-     * fails if no place was found
-     */
+    protected function lookupLargeArea($sPointSQL, $iMaxRank)
+    {
+        $oResult = null;
+
+        if ($iMaxRank > 4) {
+            $aPlace = $this->lookupPolygon($sPointSQL, $iMaxRank);
+            if ($aPlace) {
+                return new Result($aPlace['place_id']);
+            }
+        }

 
 

+        // If no polygon which contains the searchpoint is found,
+        // searches in the country_osm_grid table for a polygon.
+        return  $this->lookupInCountry($sPointSQL, $iMaxRank);
+    }

 
 

-    public function lookup($fLat, $fLon, $bDoInterpolation = true)
+    protected function lookupInCountry($sPointSQL, $iMaxRank)

     {
     {

-        $sPointSQL = 'ST_SetSRID(ST_Point('.$fLon.','.$fLat.'),4326)';
-        $iMaxRank = $this->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';

 
 

-        // Find the nearest point
-        $fSearchDiam = 0.0004;
-        $iPlaceID = null;
-        $fMaxAreaDistance = 1;
-        $bIsInUnitedStates = false;
-        $bPlaceIsTiger = false;
-        $bPlaceIsLine = false;
-        while (!$iPlaceID && $fSearchDiam < $fMaxAreaDistance) {
-            $fSearchDiam = $fSearchDiam * 2;
-
-            // 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) {
-                // try with interpolations before continuing
-                if ($bDoInterpolation) {
-                    // no house found, try with interpolations
-                    $aPlaceLine = $this->lookupInterpolation($sPointSQL, $fSearchDiam/2);
-
-                    if ($aPlaceLine) {
-                        // interpolation is closer to point than placex house
-                        $bPlaceIsLine = true;
-                        $aPlace = $aPlaceLine;
-                        $iPlaceID = $aPlaceLine['place_id'];
-                        $iParentPlaceID = $aPlaceLine['parent_place_id']; // the street
-                        $fFraction = $aPlaceLine['fraction'];
-                        $iMaxRank = 30;
-
-                        break;
-                    }
+        $sCountryCode = chksql(
+            $this->oDB->getOne($sSQL),
+            'Could not determine country polygon containing the point.'
+        );
+        if ($sCountryCode) {
+            if ($iMaxRank > 4) {
+                // 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 .= ' 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 indexed_status = 0 and linked_place_id is null';
+                $sSQL .= ' AND ST_DWithin('.$sPointSQL.', geometry, 1.8)) 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);
+                $aPlace = chksql(
+                    $this->oDB->getRow($sSQL),
+                    'Could not determine place node.'
+                );
+                if ($aPlace) {
+                    return new Result($aPlace['place_id']);

                 }
                 }

-                // no interpolation found, continue search
-                $iMaxRank = 26;

             }
 
             }
 

-            $sSQL = 'select place_id,parent_place_id,rank_search,calculated_country_code';
+            // still nothing, then return the country object
+            $sSQL = 'SELECT place_id, ST_distance('.$sPointSQL.', centroid) as distance';

             $sSQL .= ' FROM placex';
             $sSQL .= ' 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\',\'man_made\')';
-            $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';
+            $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);
             $aPlace = chksql(
                 $this->oDB->getRow($sSQL),
             if (CONST_Debug) var_dump($sSQL);
             $aPlace = chksql(
                 $this->oDB->getRow($sSQL),

-                "Could not determine closest place."
+                'Could not determine place node.'

             );
             );

-            $iPlaceID = $aPlace['place_id'];
-            $iParentPlaceID = $aPlace['parent_place_id'];
-            $bIsInUnitedStates = ($aPlace['calculated_country_code'] == 'us');
+            if ($aPlace) {
+                return new Result($aPlace['place_id']);
+            }

         }
 
         }
 

-        // If a house was found make sure there isn't an interpolation line
-        // that is closer
-        if ($bDoInterpolation && !$bPlaceIsLine && $aPlace && $aPlace['rank_search'] == 30) {
-            // get the distance of the house to the search point
-            $sSQL = 'SELECT ST_distance('.$sPointSQL.', house.geometry)';
-            $sSQL .= ' FROM placex as house WHERE house.place_id='.$iPlaceID;
+        return null;
+    }

 
 

-            $fDistancePlacex = chksql(
-                $this->oDB->getOne($sSQL),
-                "Could not determine distance between searched point and placex house."
-            );
+    /**
+     * Search for areas or nodes for areas or nodes between state and suburb level.
+     *
+     * @param string $sPointSQL Search point as SQL string.
+     * @param int    $iMaxRank  Maximum address rank of the feature.
+     *
+     * @return Record of the found feature or null.
+     *
+     * Searches first for polygon that contains the search point.
+     * If such a polygon is found, place nodes with a higher rank are
+     * searched inside the polygon.
+     */
+    protected function lookupPolygon($sPointSQL, $iMaxRank)
+    {
+        // 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';

 
 

-            // look for an interpolation that is closer
-            $aPlaceLine = $this->lookupInterpolation($sPointSQL, $fDistancePlacex);
+        $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 ($aPlaceLine) {
-                // interpolation is closer to point than placex house
-                $bPlaceIsLine = true;
-                $aPlace = $aPlaceLine;
-                $iPlaceID = $aPlaceLine['place_id'];
-                $iParentPlaceID = $aPlaceLine['parent_place_id']; // the street
-                $fFraction = $aPlaceLine['fraction'];
-            }
-        }
+            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';

 
 

-        // Only street found? If it's in the US we can check TIGER data for nearest housenumber
-        if (CONST_Use_US_Tiger_Data && $bDoInterpolation && $bIsInUnitedStates && $this->iMaxRank >= 28 && $iPlaceID && ($aPlace['rank_search'] == 26 || $aPlace['rank_search'] == 27 )) {
-            $fSearchDiam = 0.001;
-            $sSQL = 'SELECT place_id,parent_place_id,30 as rank_search, ST_LineLocatePoint(linegeo,'.$sPointSQL.') as fraction';
-            //if (CONST_Debug) { $sSQL .= ', housenumber, ST_distance('.$sPointSQL.', centroid) as distance, st_y(centroid) as lat, st_x(centroid) as lon'; }
-            $sSQL .= ' FROM location_property_tiger WHERE parent_place_id = '.$iPlaceID;
-            $sSQL .= ' AND ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';  //no centroid anymore in Tiger data, now we have lines
-            $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', linegeo) ASC limit 1';
-
-            if (CONST_Debug) {
-                $sSQL = preg_replace('/limit 1/', 'limit 100', $sSQL);
-                var_dump($sSQL);
-
-                $aAllHouses = chksql($this->oDB->getAll($sSQL));
-                foreach ($aAllHouses as $i) {
-                    echo $i['housenumber'] . ' | ' . $i['distance'] * 1000 . ' | ' . $i['lat'] . ' | ' . $i['lon']. ' | '. "<br>\n";
+                if (CONST_Debug) var_dump($sSQL);
+                $aPlacNode = chksql(
+                    $this->oDB->getRow($sSQL),
+                    'Could not determine place node.'
+                );
+                if ($aPlacNode) {
+                    return $aPlacNode;

                 }
             }
                 }
             }

+        }
+        return $aPoly;
+    }

 
 

-            $aPlaceTiger = chksql(
+
+    public function lookup($fLat, $fLon, $bDoInterpolation = true)
+    {
+        return $this->lookupPoint(
+            'ST_SetSRID(ST_Point('.$fLon.','.$fLat.'),4326)',
+            $bDoInterpolation
+        );
+    }
+
+    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
+        $fSearchDiam = 0.006;
+        $oResult = null;
+        $aPlace = null;
+
+        // for POI or street level
+        if ($iMaxRank >= 26) {
+            $sSQL = 'select place_id,parent_place_id,rank_address,country_code,';
+            $sSQL .= ' ST_distance('.$sPointSQL.', geometry) 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 between 26 and '.$iMaxRank;
+            }
+            $sSQL .= ' and (name is not null or housenumber is not null';
+            $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 .= ' ORDER BY distance ASC limit 1';
+            if (CONST_Debug) var_dump($sSQL);
+            $aPlace = chksql(

                 $this->oDB->getRow($sSQL),
                 $this->oDB->getRow($sSQL),

-                "Could not determine closest Tiger place."
+                'Could not determine closest place.'

             );
             );

-            if ($aPlaceTiger) {
-                if (CONST_Debug) var_dump('found Tiger housenumber', $aPlaceTiger);
-                $bPlaceIsTiger = true;
-                $aPlace = $aPlaceTiger;
-                $iPlaceID = $aPlaceTiger['place_id'];
-                $iParentPlaceID = $aPlaceTiger['parent_place_id']; // the street
-                $fFraction = $aPlaceTiger['fraction'];
-                $iMaxRank = 30;
+
+            if (CONST_Debug) var_dump($aPlace);
+            if ($aPlace) {
+                $iPlaceID = $aPlace['place_id'];
+                $oResult = new Result($iPlaceID);
+                $iRankAddress = $aPlace['rank_address'];
+                $iParentPlaceID = $aPlace['parent_place_id'];

             }
             }

-        }

 
 

-        // 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 || $bPlaceIsTiger || $bPlaceIsLine) && $iParentPlaceID) {
-                $iPlaceID = $iParentPlaceID;
+            if ($bDoInterpolation && $iMaxRank >= 30) {
+                $fDistance = $fSearchDiam;
+                if ($aPlace) {
+                    // We can't reliably go from the closest street to an
+                    // interpolation line because the closest interpolation
+                    // may have a different street segments as a parent.
+                    // Therefore allow an interpolation line to take precendence
+                    // even when the street is closer.
+                    $fDistance = $iRankAddress < 28 ? 0.001 : $aPlace['distance'];
+                }
+
+                $aHouse = $this->lookupInterpolation($sPointSQL, $fDistance);
+
+                if ($aHouse) {
+                    $oResult = new Result($aHouse['place_id'], Result::TABLE_OSMLINE);
+                    $oResult->iHouseNumber = closestHouseNumber($aHouse);
+                    $aPlace = $aHouse;
+                    $iRankAddress = 30;
+                }

             }
             }

-            $sSQL  = 'select address_place_id';
-            $sSQL .= ' FROM place_addressline';
-            $sSQL .= " WHERE place_id = $iPlaceID";
-            $sSQL .= " ORDER BY abs(cached_rank_address - $iMaxRank) asc,cached_rank_address desc,isaddress desc,distance desc";
-            $sSQL .= ' LIMIT 1';
-            $iPlaceID = chksql($this->oDB->getOne($sSQL), "Could not get parent for place.");
-            if (!$iPlaceID) {
-                $iPlaceID = $aPlace['place_id'];
+
+            if ($aPlace) {
+                // if street and maxrank > streetlevel
+                if ($iRankAddress <= 27 && $iMaxRank > 27) {
+                    // find the closest object (up to a certain radius) of which the street is a parent of
+                    $sSQL = ' select place_id,';
+                    $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) {
+                        if (CONST_Debug) var_dump($aStreet);
+                        $oResult = new Result($aStreet['place_id']);
+                    }
+                }
+
+                  // In the US we can check TIGER data for nearest housenumber
+                if (CONST_Use_US_Tiger_Data
+                    && $iRankAddress <= 27
+                    && $aPlace['country_code'] == 'us'
+                    && $this->iMaxRank >= 28
+                ) {
+                    $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, 0.001)';
+                    $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);
+                        $oResult = new Result($aPlaceTiger['place_id'], Result::TABLE_TIGER);
+                        $oResult->iHouseNumber = closestHouseNumber($aPlaceTiger);
+                    }
+                }
+            } else {
+                // if no POI or street is found ...
+                $oResult = $this->lookupLargeArea($sPointSQL, 25);

             }
             }

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

         }
         }

-        return array(
-                'place_id' => $iPlaceID,
-                'type' => $bPlaceIsTiger ? 'tiger' : ($bPlaceIsLine ? 'interpolation' : 'osm'),
-                'fraction' => ($bPlaceIsTiger || $bPlaceIsLine) ? $fFraction : -1
-               );
+        return $oResult;

     }
 }
     }
 }