]> git.openstreetmap.org Git - nominatim.git/blobdiff - lib/PlaceLookup.php
Nominatim::DB support input variables, custom error messages
[nominatim.git] / lib / PlaceLookup.php
index 4fce7e3683a74a32d1b6a95faca75e731d831446..cf3e4f7be812ea8579f815219665404c0edaf039 100644 (file)
@@ -2,6 +2,7 @@
 
 namespace Nominatim;
 
+require_once(CONST_BasePath.'/lib/AddressDetails.php');
 require_once(CONST_BasePath.'/lib/Result.php');
 
 class PlaceLookup
@@ -42,29 +43,37 @@ class PlaceLookup
         $this->bIncludePolygonAsPoints = $b;
     }
 
+    public function setIncludeAddressDetails($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);
 
         $this->bDeDupe = $oParams->getBool('dedupe', $this->bDeDupe);
 
-        if ($sGeomType === null || $sGeomType == 'text') {
-            $this->bIncludePolygonAsText = $oParams->getBool('polygon_text');
-        }
         if ($sGeomType === null || $sGeomType == 'geojson') {
             $this->bIncludePolygonAsGeoJSON = $oParams->getBool('polygon_geojson');
+            $this->bIncludePolygonAsPoints = false;
         }
-        if ($sGeomType === null || $sGeomType == 'kml') {
-            $this->bIncludePolygonAsKML = $oParams->getBool('polygon_kml');
-        }
-        if ($sGeomType === null || $sGeomType == 'svg') {
-            $this->bIncludePolygonAsSVG = $oParams->getBool('polygon_svg');
+
+        if ($oParams->getString('format', '') !== 'geojson') {
+            if ($sGeomType === null || $sGeomType == 'text') {
+                $this->bIncludePolygonAsText = $oParams->getBool('polygon_text');
+            }
+            if ($sGeomType === null || $sGeomType == 'kml') {
+                $this->bIncludePolygonAsKML = $oParams->getBool('polygon_kml');
+            }
+            if ($sGeomType === null || $sGeomType == 'svg') {
+                $this->bIncludePolygonAsSVG = $oParams->getBool('polygon_svg');
+            }
         }
         $this->fPolygonSimplificationThreshold
             = $oParams->getFloat('polygon_threshold', 0.0);
@@ -123,13 +132,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)
@@ -150,13 +155,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;
@@ -164,19 +172,21 @@ class PlaceLookup
 
         $aResults = $this->lookup(array($iPlaceID => new Result($iPlaceID)));
 
-        return sizeof($aResults) ? reset($aResults) : null;
+        return empty($aResults) ? null : reset($aResults);
     }
 
     public function lookup($aResults, $iMinRank = 0, $iMaxRank = 30)
     {
-        if (!sizeof($aResults)) {
+        Debug::newFunction('Place lookup');
+
+        if (empty($aResults)) {
             return array();
         }
         $aSubSelects = array();
 
         $sPlaceIDs = Result::joinIdsByTable($aResults, Result::TABLE_PLACEX);
-        if (CONST_Debug) var_dump('PLACEX', $sPlaceIDs);
         if ($sPlaceIDs) {
+            Debug::printVar('Ids from placex', $sPlaceIDs);
             $sSQL  = 'SELECT ';
             $sSQL .= '    osm_type,';
             $sSQL .= '    osm_id,';
@@ -233,7 +243,7 @@ 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, ';
@@ -246,23 +256,24 @@ class PlaceLookup
         // postcode table
         $sPlaceIDs = Result::joinIdsByTable($aResults, Result::TABLE_POSTCODE);
         if ($sPlaceIDs) {
+            Debug::printVar('Ids from location_postcode', $sPlaceIDs);
             $sSQL = 'SELECT';
             $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";
@@ -276,6 +287,7 @@ class PlaceLookup
             if (CONST_Use_US_Tiger_Data) {
                 $sPlaceIDs = Result::joinIdsByTable($aResults, Result::TABLE_TIGER);
                 if ($sPlaceIDs) {
+                    Debug::printVar('Ids from Tiger table', $sPlaceIDs);
                     $sHousenumbers = Result::sqlHouseNumberTable($aResults, Result::TABLE_TIGER);
                     // Tiger search only if a housenumber was searched and if it was found
                     // (realized through a join)
@@ -284,7 +296,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, ';
@@ -292,15 +304,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, ';
@@ -321,6 +333,7 @@ class PlaceLookup
             // osmline - interpolated housenumbers
             $sPlaceIDs = Result::joinIdsByTable($aResults, Result::TABLE_OSMLINE);
             if ($sPlaceIDs) {
+                Debug::printVar('Ids from interpolation', $sPlaceIDs);
                 $sHousenumbers = Result::sqlHouseNumberTable($aResults, Result::TABLE_OSMLINE);
                 // interpolation line search only if a housenumber was searched
                 // (realized through a join)
@@ -329,7 +342,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, ';
@@ -337,16 +350,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, ';
@@ -378,7 +391,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,';
@@ -386,10 +399,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, ';
@@ -397,7 +410,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) ";
 
@@ -406,25 +419,24 @@ class PlaceLookup
             }
         }
 
-        if (CONST_Debug) var_dump($aSubSelects);
-
-        if (!sizeof($aSubSelects)) {
+        if (empty($aSubSelects)) {
             return array();
         }
 
-        $aPlaces = chksql(
-            $this->oDB->getAll(join(' UNION ', $aSubSelects)),
-            'Could not lookup place'
-        );
+        $sSQL = join(' UNION ', $aSubSelects);
+        Debug::printSQL($sSQL);
+        $aPlaces = $this->oDB->getAll($sSQL, null, 'Could not lookup place');
 
-        $aClassType = getClassTypes();
         foreach ($aPlaces as &$aPlace) {
             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']
+                    $aPlace['housenumber'],
+                    $this->aLangPrefOrderSql
                 );
+                $aPlace['langaddress'] = $aPlace['address']->getLocaleAddress();
             }
 
             if ($this->bExtraTags) {
@@ -443,77 +455,18 @@ 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\getProperty(
+                $aPlace,
+                'simplelabel',
+                $aPlace['class']
+            );
         }
 
-        if (CONST_Debug) var_dump($aPlaces);
+        Debug::printVar('Places', $aPlaces);
 
         return $aPlaces;
     }
 
-    private function getAddressDetails($iPlaceID, $bAll, $sHousenumber)
-    {
-        $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;
-    }
-
-
-
     /* returns an array which will contain the keys
      *   aBoundingBox
      * and may also contain one or more of the keys
@@ -526,7 +479,7 @@ class PlaceLookup
      */
 
 
-    public function getOutlines($iPlaceID, $fLon = null, $fLat = null, $fRadius = null)
+    public function getOutlines($iPlaceID, $fLon = null, $fLat = null, $fRadius = null, $fLonReverse = null, $fLatReverse = null)
     {
 
         $aOutlineResult = array();
@@ -534,24 +487,36 @@ class PlaceLookup
 
         if (CONST_Search_AreaPolygons) {
             // Get the bounding box and outline polygon
-            $sSQL  = 'select place_id,0 as numfeatures,st_area(geometry) as area,';
-            $sSQL .= 'ST_Y(centroid) as centrelat,ST_X(centroid) as centrelon,';
-            $sSQL .= 'ST_YMin(geometry) as minlat,ST_YMax(geometry) as maxlat,';
-            $sSQL .= 'ST_XMin(geometry) as minlon,ST_XMax(geometry) as maxlon';
+            $sSQL = 'select place_id,0 as numfeatures,st_area(geometry) as area,';
+            if ($fLonReverse != null && $fLatReverse != null) {
+                $sSQL .= ' ST_Y(closest_point) as centrelat,';
+                $sSQL .= ' ST_X(closest_point) as centrelon,';
+            } else {
+                $sSQL .= ' ST_Y(centroid) as centrelat, ST_X(centroid) as centrelon,';
+            }
+            $sSQL .= ' ST_YMin(geometry) as minlat,ST_YMax(geometry) as maxlat,';
+            $sSQL .= ' ST_XMin(geometry) as minlon,ST_XMax(geometry) as maxlon';
             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';
-            $sFrom = ' from placex where place_id = '.$iPlaceID;
+            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))';
+                $sFrom .=' ELSE centroid END AS closest_point';
+                $sFrom .= ' from placex where place_id = '.$iPlaceID.') as plx';
+            } else {
+                $sFrom = ' from placex where place_id = '.$iPlaceID;
+            }
             if ($this->fPolygonSimplificationThreshold > 0) {
                 $sSQL .= ' from (select place_id,centroid,ST_SimplifyPreserveTopology(geometry,'.$this->fPolygonSimplificationThreshold.') as geometry'.$sFrom.') as plx';
             } else {
                 $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'];