]> git.openstreetmap.org Git - nominatim.git/blobdiff - lib/PlaceLookup.php
test/README.md - more instructions how to import test db
[nominatim.git] / lib / PlaceLookup.php
index f0db09c9be7f0403c0179f6f3e63ba07c9644162..eebfe98301cc16d2ffc100bbbc0869e358d71167 100644 (file)
@@ -2,6 +2,7 @@
 
 namespace Nominatim;
 
+require_once(CONST_BasePath.'/lib/AddressDetails.php');
 require_once(CONST_BasePath.'/lib/Result.php');
 
 class PlaceLookup
@@ -11,11 +12,9 @@ class PlaceLookup
     protected $aLangPrefOrderSql = "''";
 
     protected $bAddressDetails = false;
-    protected $bAddressAdminLevels = false;
     protected $bExtraTags = false;
     protected $bNameDetails = false;
 
-    protected $bIncludePolygonAsPoints = false;
     protected $bIncludePolygonAsText = false;
     protected $bIncludePolygonAsGeoJSON = false;
     protected $bIncludePolygonAsKML = false;
@@ -38,23 +37,17 @@ class PlaceLookup
         return $this->bDeDupe;
     }
 
-    public function setIncludePolygonAsPoints($b = true)
+    public function setIncludeAddressDetails($b)
     {
-        $this->bIncludePolygonAsPoints = $b;
-    }
-
-    public function setAddressAdminLevels($b = true)
-    {
-        $this->bAddressAdminLevels = $b;
+        $this->bAddressDetails = $b;
     }
 
     public function loadParamArray($oParams, $sGeomType = null)
     {
         $aLangs = $oParams->getPreferredLanguages();
         $this->aLangPrefOrderSql =
-            'ARRAY['.join(',', array_map('getDBQuoted', $aLangs)).']';
+            'ARRAY['.join(',', $this->oDB->getDBQuotedList($aLangs)).']';
 
-        $this->bAddressDetails = $oParams->getBool('addressdetails', true);
         $this->bExtraTags = $oParams->getBool('extratags', false);
         $this->bNameDetails = $oParams->getBool('namedetails', false);
 
@@ -62,7 +55,6 @@ class PlaceLookup
 
         if ($sGeomType === null || $sGeomType == 'geojson') {
             $this->bIncludePolygonAsGeoJSON = $oParams->getBool('polygon_geojson');
-            $this->bIncludePolygonAsPoints = false;
         }
 
         if ($oParams->getString('format', '') !== 'geojson') {
@@ -101,7 +93,6 @@ class PlaceLookup
         if ($this->bExtraTags) $aParams['extratags'] = '1';
         if ($this->bNameDetails) $aParams['namedetails'] = '1';
 
-        if ($this->bIncludePolygonAsPoints) $aParams['polygon'] = '1';
         if ($this->bIncludePolygonAsText) $aParams['polygon_text'] = '1';
         if ($this->bIncludePolygonAsGeoJSON) $aParams['polygon_geojson'] = '1';
         if ($this->bIncludePolygonAsKML) $aParams['polygon_kml'] = '1';
@@ -133,13 +124,9 @@ class PlaceLookup
 
     public function setLanguagePreference($aLangPrefOrder)
     {
-        $this->aLangPrefOrderSql =
-            'ARRAY['.join(',', array_map('getDBQuoted', $aLangPrefOrder)).']';
-    }
-
-    public function setIncludeAddressDetails($bAddressDetails = true)
-    {
-        $this->bAddressDetails = $bAddressDetails;
+        $this->aLangPrefOrderSql = $this->oDB->getArraySQL(
+            $this->oDB->getDBQuotedList($aLangPrefOrder)
+        );
     }
 
     private function addressImportanceSql($sGeometry, $sPlaceId)
@@ -160,13 +147,16 @@ class PlaceLookup
 
     private function langAddressSql($sHousenumber)
     {
+        if ($this->bAddressDetails)
+            return ''; // langaddress will be computed from address details
+
         return 'get_address_by_language(place_id,'.$sHousenumber.','.$this->aLangPrefOrderSql.') AS langaddress,';
     }
 
     public function lookupOSMID($sType, $iID)
     {
-        $sSQL = "select place_id from placex where osm_type = '".$sType."' and osm_id = ".$iID;
-        $iPlaceID = chksql($this->oDB->getOne($sSQL));
+        $sSQL = 'select place_id from placex where osm_type = :type and osm_id = :id';
+        $iPlaceID = $this->oDB->getOne($sSQL, array(':type' => $sType, ':id' => $iID));
 
         if (!$iPlaceID) {
             return null;
@@ -217,7 +207,7 @@ class PlaceLookup
                 'ST_Collect(centroid)',
                 'min(CASE WHEN placex.rank_search < 28 THEN placex.place_id ELSE placex.parent_place_id END)'
             );
-            $sSQL .= "    (extratags->'place') AS extra_place ";
+            $sSQL .= "    COALESCE(extratags->'place', extratags->'linked_place') AS extra_place ";
             $sSQL .= ' FROM placex';
             $sSQL .= " WHERE place_id in ($sPlaceIDs) ";
             $sSQL .= '   AND (';
@@ -245,12 +235,12 @@ class PlaceLookup
             $sSQL .= '     country_code, ';
             $sSQL .= '     importance, ';
             if (!$this->bDeDupe) $sSQL .= 'place_id,';
-            $sSQL .= '     langaddress, ';
+            if (!$this->bAddressDetails) $sSQL .= 'langaddress, ';
             $sSQL .= '     placename, ';
             $sSQL .= '     ref, ';
             if ($this->bExtraTags) $sSQL .= 'extratags, ';
             if ($this->bNameDetails) $sSQL .= 'name, ';
-            $sSQL .= "     extratags->'place' ";
+            $sSQL .= '     extra_place ';
 
             $aSubSelects[] = $sSQL;
         }
@@ -263,19 +253,19 @@ class PlaceLookup
             $sSQL .= "  'P' as osm_type,";
             $sSQL .= '  (SELECT osm_id from placex p WHERE p.place_id = lp.parent_place_id) as osm_id,';
             $sSQL .= "  'place' as class, 'postcode' as type,";
-            $sSQL .= '  null as admin_level, rank_search, rank_address,';
+            $sSQL .= '  null::smallint as admin_level, rank_search, rank_address,';
             $sSQL .= '  place_id, parent_place_id,';
-            $sSQL .= '  null as housenumber,';
+            $sSQL .= '  -1 as housenumber,';
             $sSQL .= '  country_code,';
             $sSQL .= $this->langAddressSql('-1');
             $sSQL .= '  postcode as placename,';
             $sSQL .= '  postcode as ref,';
-            if ($this->bExtraTags) $sSQL .= 'null AS extra,';
-            if ($this->bNameDetails) $sSQL .= 'null AS names,';
+            if ($this->bExtraTags) $sSQL .= 'null::text AS extra,';
+            if ($this->bNameDetails) $sSQL .= 'null::text AS names,';
             $sSQL .= '  ST_x(geometry) AS lon, ST_y(geometry) AS lat,';
             $sSQL .= '  (0.75-(rank_search::float/40)) AS importance, ';
             $sSQL .= $this->addressImportanceSql('geometry', 'lp.parent_place_id');
-            $sSQL .= '  null AS extra_place ';
+            $sSQL .= '  null::text AS extra_place ';
             $sSQL .= 'FROM location_postcode lp';
             $sSQL .= " WHERE place_id in ($sPlaceIDs) ";
             $sSQL .= "   AND lp.rank_address between $iMinRank and $iMaxRank";
@@ -298,7 +288,7 @@ class PlaceLookup
                     $sSQL .= '     (SELECT osm_id from placex p WHERE p.place_id=blub.parent_place_id) as osm_id, ';
                     $sSQL .= "     'place' AS class, ";
                     $sSQL .= "     'house' AS type, ";
-                    $sSQL .= '     null AS admin_level, ';
+                    $sSQL .= '     null::smallint AS admin_level, ';
                     $sSQL .= '     30 AS rank_search, ';
                     $sSQL .= '     30 AS rank_address, ';
                     $sSQL .= '     place_id, ';
@@ -306,15 +296,15 @@ class PlaceLookup
                     $sSQL .= '     housenumber_for_place as housenumber,';
                     $sSQL .= "     'us' AS country_code, ";
                     $sSQL .= $this->langAddressSql('housenumber_for_place');
-                    $sSQL .= '     null AS placename, ';
-                    $sSQL .= '     null AS ref, ';
-                    if ($this->bExtraTags) $sSQL .= 'null AS extra,';
-                    if ($this->bNameDetails) $sSQL .= 'null AS names,';
+                    $sSQL .= '     null::text AS placename, ';
+                    $sSQL .= '     null::text AS ref, ';
+                    if ($this->bExtraTags) $sSQL .= 'null::text AS extra,';
+                    if ($this->bNameDetails) $sSQL .= 'null::text AS names,';
                     $sSQL .= '     st_x(centroid) AS lon, ';
                     $sSQL .= '     st_y(centroid) AS lat,';
                     $sSQL .= '     -1.15 AS importance, ';
                     $sSQL .= $this->addressImportanceSql('centroid', 'blub.parent_place_id');
-                    $sSQL .= '     null AS extra_place ';
+                    $sSQL .= '     null::text AS extra_place ';
                     $sSQL .= ' FROM (';
                     $sSQL .= '     SELECT place_id, ';    // interpolate the Tiger housenumbers here
                     $sSQL .= '         ST_LineInterpolatePoint(linegeo, (housenumber_for_place-startnumber::float)/(endnumber-startnumber)::float) AS centroid, ';
@@ -344,7 +334,7 @@ class PlaceLookup
                 $sSQL .= '  osm_id, ';
                 $sSQL .= "  'place' AS class, ";
                 $sSQL .= "  'house' AS type, ";
-                $sSQL .= '  15 AS admin_level, ';
+                $sSQL .= '  null::smallint AS admin_level, ';
                 $sSQL .= '  30 AS rank_search, ';
                 $sSQL .= '  30 AS rank_address, ';
                 $sSQL .= '  place_id, ';
@@ -352,16 +342,16 @@ class PlaceLookup
                 $sSQL .= '  housenumber_for_place as housenumber,';
                 $sSQL .= '  country_code, ';
                 $sSQL .= $this->langAddressSql('housenumber_for_place');
-                $sSQL .= '  null AS placename, ';
-                $sSQL .= '  null AS ref, ';
-                if ($this->bExtraTags) $sSQL .= 'null AS extra, ';
-                if ($this->bNameDetails) $sSQL .= 'null AS names, ';
+                $sSQL .= '  null::text AS placename, ';
+                $sSQL .= '  null::text AS ref, ';
+                if ($this->bExtraTags) $sSQL .= 'null::text AS extra, ';
+                if ($this->bNameDetails) $sSQL .= 'null::text AS names, ';
                 $sSQL .= '  st_x(centroid) AS lon, ';
                 $sSQL .= '  st_y(centroid) AS lat, ';
                 // slightly smaller than the importance for normal houses
                 $sSQL .= '  -0.1 AS importance, ';
                 $sSQL .= $this->addressImportanceSql('centroid', 'blub.parent_place_id');
-                $sSQL .= '  null AS extra_place ';
+                $sSQL .= '  null::text AS extra_place ';
                 $sSQL .= '  FROM (';
                 $sSQL .= '     SELECT ';
                 $sSQL .= '         osm_id, ';
@@ -393,7 +383,7 @@ class PlaceLookup
                     $sSQL .= '     place_id AS osm_id, ';
                     $sSQL .= "     'place' AS class,";
                     $sSQL .= "     'house' AS type, ";
-                    $sSQL .= '     null AS admin_level, ';
+                    $sSQL .= '     null::smallint AS admin_level, ';
                     $sSQL .= '     30 AS rank_search,';
                     $sSQL .= '     30 AS rank_address, ';
                     $sSQL .= '     place_id,';
@@ -401,10 +391,10 @@ class PlaceLookup
                     $sSQL .= '     housenumber,';
                     $sSQL .= "     'us' AS country_code, ";
                     $sSQL .= $this->langAddressSql('-1');
-                    $sSQL .= '     null AS placename, ';
-                    $sSQL .= '     null AS ref, ';
-                    if ($this->bExtraTags) $sSQL .= 'null AS extra, ';
-                    if ($this->bNameDetails) $sSQL .= 'null AS names, ';
+                    $sSQL .= '     null::text AS placename, ';
+                    $sSQL .= '     null::text AS ref, ';
+                    if ($this->bExtraTags) $sSQL .= 'null::text AS extra, ';
+                    if ($this->bNameDetails) $sSQL .= 'null::text AS names, ';
                     $sSQL .= '     ST_X(centroid) AS lon, ';
                     $sSQL .= '     ST_Y(centroid) AS lat, ';
                     $sSQL .= '     -1.10 AS importance, ';
@@ -412,7 +402,7 @@ class PlaceLookup
                         'centroid',
                         'location_property_aux.parent_place_id'
                     );
-                    $sSQL .= '     null AS extra_place ';
+                    $sSQL .= '     null::text AS extra_place ';
                     $sSQL .= '  FROM location_property_aux ';
                     $sSQL .= "  WHERE place_id in ($sPlaceIDs) ";
 
@@ -427,23 +417,19 @@ class PlaceLookup
 
         $sSQL = join(' UNION ', $aSubSelects);
         Debug::printSQL($sSQL);
-        $aPlaces = chksql($this->oDB->getAll($sSQL), 'Could not lookup place');
+        $aPlaces = $this->oDB->getAll($sSQL, null, 'Could not lookup place');
 
-        $aClassType = getClassTypes();
         foreach ($aPlaces as &$aPlace) {
+            $aPlace['importance'] = (float) $aPlace['importance'];
             if ($this->bAddressDetails) {
                 // to get addressdetails for tiger data, the housenumber is needed
-                $aPlace['aAddress'] = $this->getAddressNames(
+                $aPlace['address'] = new AddressDetails(
+                    $this->oDB,
                     $aPlace['place_id'],
-                    $aPlace['housenumber']
-                );
-            }
-
-            if ($this->bAddressAdminLevels) {
-                $aPlace['aAddressAdminLevels'] = $this->getAddressAdminLevels(
-                    $aPlace['place_id'],
-                    $aPlace['housenumber']
+                    $aPlace['housenumber'],
+                    $this->aLangPrefOrderSql
                 );
+                $aPlace['langaddress'] = $aPlace['address']->getLocaleAddress();
             }
 
             if ($this->bExtraTags) {
@@ -462,18 +448,10 @@ class PlaceLookup
                 }
             }
 
-            $sAddressType = '';
-            $sClassType = $aPlace['class'].':'.$aPlace['type'].':'.$aPlace['admin_level'];
-            if (isset($aClassType[$sClassType]) && isset($aClassType[$sClassType]['simplelabel'])) {
-                $sAddressType = $aClassType[$aClassType]['simplelabel'];
-            } else {
-                $sClassType = $aPlace['class'].':'.$aPlace['type'];
-                if (isset($aClassType[$sClassType]) && isset($aClassType[$sClassType]['simplelabel']))
-                    $sAddressType = $aClassType[$sClassType]['simplelabel'];
-                else $sAddressType = $aPlace['class'];
-            }
-
-            $aPlace['addresstype'] = $sAddressType;
+            $aPlace['addresstype'] = ClassTypes\getLabelTag(
+                $aPlace,
+                $aPlace['country_code']
+            );
         }
 
         Debug::printVar('Places', $aPlaces);
@@ -481,85 +459,6 @@ class PlaceLookup
         return $aPlaces;
     }
 
-    public function getAddressDetails($iPlaceID, $bAll = false, $sHousenumber = -1)
-    {
-        $sSQL = 'SELECT *,';
-        $sSQL .= '  get_name_by_language(name,'.$this->aLangPrefOrderSql.') as localname';
-        $sSQL .= ' FROM get_addressdata('.$iPlaceID.','.$sHousenumber.')';
-        if (!$bAll) {
-            $sSQL .= " WHERE isaddress OR type = 'country_code'";
-        }
-        $sSQL .= ' ORDER BY rank_address desc,isaddress DESC';
-
-        return chksql($this->oDB->getAll($sSQL));
-    }
-
-    public function getAddressNames($iPlaceID, $sHousenumber = null)
-    {
-        $aAddressLines = $this->getAddressDetails(
-            $iPlaceID,
-            false,
-            $sHousenumber === null ? -1 : $sHousenumber
-        );
-
-        $aAddress = array();
-        $aFallback = array();
-        $aClassType = getClassTypes();
-        foreach ($aAddressLines as $aLine) {
-            $bFallback = false;
-            $aTypeLabel = false;
-            if (isset($aClassType[$aLine['class'].':'.$aLine['type'].':'.$aLine['admin_level']])) {
-                $aTypeLabel = $aClassType[$aLine['class'].':'.$aLine['type'].':'.$aLine['admin_level']];
-            } elseif (isset($aClassType[$aLine['class'].':'.$aLine['type']])) {
-                $aTypeLabel = $aClassType[$aLine['class'].':'.$aLine['type']];
-            } elseif (isset($aClassType['boundary:administrative:'.((int)($aLine['rank_address']/2))])) {
-                $aTypeLabel = $aClassType['boundary:administrative:'.((int)($aLine['rank_address']/2))];
-                $bFallback = true;
-            } else {
-                $aTypeLabel = array('simplelabel' => 'address'.$aLine['rank_address']);
-                $bFallback = true;
-            }
-            if ($aTypeLabel && ((isset($aLine['localname']) && $aLine['localname']) || (isset($aLine['housenumber']) && $aLine['housenumber']))) {
-                $sTypeLabel = strtolower(isset($aTypeLabel['simplelabel'])?$aTypeLabel['simplelabel']:$aTypeLabel['label']);
-                $sTypeLabel = str_replace(' ', '_', $sTypeLabel);
-                if (!isset($aAddress[$sTypeLabel]) || (isset($aFallback[$sTypeLabel]) && $aFallback[$sTypeLabel]) || $aLine['class'] == 'place') {
-                    $aAddress[$sTypeLabel] = $aLine['localname']?$aLine['localname']:$aLine['housenumber'];
-                }
-                $aFallback[$sTypeLabel] = $bFallback;
-            }
-        }
-        return $aAddress;
-    }
-
-    /* "Downing Street, London"
-     * [
-     *   "level15" => "Covent Garden",
-     *   "level8" => "Westminster",
-     *   "level6" => "London",
-     *   "level5" => "Greater London",
-     *   "level4" => "England",
-     *   "level2" => "United Kingdom"
-     * ]
-     */
-
-    public function getAddressAdminLevels($iPlaceID, $sHousenumber = null)
-    {
-        $aAddressLines = $this->getAddressDetails(
-            $iPlaceID,
-            false,
-            $sHousenumber === null ? -1 : $sHousenumber
-        );
-
-        $aAddress = array();
-        foreach ($aAddressLines as $aLine) {
-            if (isset($aLine['admin_level'])) {
-                $aAddress['level'.$aLine['admin_level']] = $aLine['localname'];
-            }
-        }
-        return $aAddress;
-    }
-
-
     /* returns an array which will contain the keys
      *   aBoundingBox
      * and may also contain one or more of the keys
@@ -592,7 +491,7 @@ class PlaceLookup
             if ($this->bIncludePolygonAsGeoJSON) $sSQL .= ',ST_AsGeoJSON(geometry) as asgeojson';
             if ($this->bIncludePolygonAsKML) $sSQL .= ',ST_AsKML(geometry) as askml';
             if ($this->bIncludePolygonAsSVG) $sSQL .= ',ST_AsSVG(geometry) as assvg';
-            if ($this->bIncludePolygonAsText || $this->bIncludePolygonAsPoints) $sSQL .= ',ST_AsText(geometry) as astext';
+            if ($this->bIncludePolygonAsText) $sSQL .= ',ST_AsText(geometry) as astext';
             if ($fLonReverse != null && $fLatReverse != null) {
                 $sFrom = ' from (SELECT * , CASE WHEN (class = \'highway\') AND (ST_GeometryType(geometry) = \'ST_LineString\') THEN ';
                 $sFrom .=' ST_ClosestPoint(geometry, ST_SetSRID(ST_Point('.$fLatReverse.','.$fLonReverse.'),4326))';
@@ -607,9 +506,9 @@ class PlaceLookup
                 $sSQL .= $sFrom;
             }
 
-            $aPointPolygon = chksql($this->oDB->getRow($sSQL), 'Could not get outline');
+            $aPointPolygon = $this->oDB->getRow($sSQL, null, 'Could not get outline');
 
-            if ($aPointPolygon['place_id']) {
+            if ($aPointPolygon && $aPointPolygon['place_id']) {
                 if ($aPointPolygon['centrelon'] !== null && $aPointPolygon['centrelat'] !== null) {
                     $aOutlineResult['lat'] = $aPointPolygon['centrelat'];
                     $aOutlineResult['lon'] = $aPointPolygon['centrelon'];
@@ -619,8 +518,6 @@ class PlaceLookup
                 if ($this->bIncludePolygonAsKML) $aOutlineResult['askml'] = $aPointPolygon['askml'];
                 if ($this->bIncludePolygonAsSVG) $aOutlineResult['assvg'] = $aPointPolygon['assvg'];
                 if ($this->bIncludePolygonAsText) $aOutlineResult['astext'] = $aPointPolygon['astext'];
-                if ($this->bIncludePolygonAsPoints) $aOutlineResult['aPolyPoints'] = geometryText2Points($aPointPolygon['astext'], $fRadius);
-
 
                 if (abs($aPointPolygon['minlat'] - $aPointPolygon['maxlat']) < 0.0000001) {
                     $aPointPolygon['minlat'] = $aPointPolygon['minlat'] - $fRadius;
@@ -643,17 +540,12 @@ class PlaceLookup
 
         // as a fallback we generate a bounding box without knowing the size of the geometry
         if ((!isset($aOutlineResult['aBoundingBox'])) && isset($fLon)) {
-            //
-            if ($this->bIncludePolygonAsPoints) {
-                $sGeometryText = 'POINT('.$fLon.','.$fLat.')';
-                $aOutlineResult['aPolyPoints'] = geometryText2Points($sGeometryText, $fRadius);
-            }
-
-            $aBounds = array();
-            $aBounds['minlat'] = $fLat - $fRadius;
-            $aBounds['maxlat'] = $fLat + $fRadius;
-            $aBounds['minlon'] = $fLon - $fRadius;
-            $aBounds['maxlon'] = $fLon + $fRadius;
+            $aBounds = array(
+                        'minlat' => $fLat - $fRadius,
+                        'maxlat' => $fLat + $fRadius,
+                        'minlon' => $fLon - $fRadius,
+                        'maxlon' => $fLon + $fRadius
+                       );
 
             $aOutlineResult['aBoundingBox'] = array(
                                                (string)$aBounds['minlat'],