]> git.openstreetmap.org Git - nominatim.git/blobdiff - lib/Geocode.php
check if query is valid unicode string
[nominatim.git] / lib / Geocode.php
index 48683e64db5cf3f8b3b60d138baba8648e8fd015..ec3ce13b2bd2a15e4d8d8ef1ea4eb7567932fac1 100644 (file)
@@ -1,4 +1,7 @@
 <?php
+
+namespace Nominatim;
+
 require_once(CONST_BasePath.'/lib/PlaceLookup.php');
 require_once(CONST_BasePath.'/lib/ReverseGeocode.php');
 
@@ -48,67 +51,68 @@ class Geocode
     protected $sQuery = false;
     protected $aStructuredQuery = false;
 
-    function Geocode(&$oDB)
+
+    public function __construct(&$oDB)
     {
         $this->oDB =& $oDB;
     }
 
-    function setReverseInPlan($bReverse)
+    public function setReverseInPlan($bReverse)
     {
         $this->bReverseInPlan = $bReverse;
     }
 
-    function setLanguagePreference($aLangPref)
+    public function setLanguagePreference($aLangPref)
     {
         $this->aLangPrefOrder = $aLangPref;
     }
 
-    function getIncludeAddressDetails()
+    public function getIncludeAddressDetails()
     {
         return $this->bIncludeAddressDetails;
     }
 
-    function getIncludeExtraTags()
+    public function getIncludeExtraTags()
     {
         return $this->bIncludeExtraTags;
     }
 
-    function getIncludeNameDetails()
+    public function getIncludeNameDetails()
     {
         return $this->bIncludeNameDetails;
     }
 
-    function setIncludePolygonAsPoints($b = true)
+    public function setIncludePolygonAsPoints($b = true)
     {
         $this->bIncludePolygonAsPoints = $b;
     }
 
-    function setIncludePolygonAsText($b = true)
+    public function setIncludePolygonAsText($b = true)
     {
         $this->bIncludePolygonAsText = $b;
     }
 
-    function setIncludePolygonAsGeoJSON($b = true)
+    public function setIncludePolygonAsGeoJSON($b = true)
     {
         $this->bIncludePolygonAsGeoJSON = $b;
     }
 
-    function setIncludePolygonAsKML($b = true)
+    public function setIncludePolygonAsKML($b = true)
     {
         $this->bIncludePolygonAsKML = $b;
     }
 
-    function setIncludePolygonAsSVG($b = true)
+    public function setIncludePolygonAsSVG($b = true)
     {
         $this->bIncludePolygonAsSVG = $b;
     }
 
-    function setPolygonSimplificationThreshold($f)
+    public function setPolygonSimplificationThreshold($f)
     {
         $this->fPolygonSimplificationThreshold = $f;
     }
 
-    function setLimit($iLimit = 10)
+    public function setLimit($iLimit = 10)
     {
         if ($iLimit > 50) $iLimit = 50;
         if ($iLimit < 1) $iLimit = 1;
@@ -117,48 +121,48 @@ class Geocode
         $this->iLimit = $iLimit + min($iLimit, 10);
     }
 
-    function getExcludedPlaceIDs()
+    public function getExcludedPlaceIDs()
     {
         return $this->aExcludePlaceIDs;
     }
 
-    function getViewBoxString()
+    public function getViewBoxString()
     {
         if (!$this->aViewBox) return null;
         return $this->aViewBox[0].','.$this->aViewBox[3].','.$this->aViewBox[2].','.$this->aViewBox[1];
     }
 
-    function setFeatureType($sFeatureType)
+    public function setFeatureType($sFeatureType)
     {
         switch ($sFeatureType) {
-        case 'country':
-            $this->setRankRange(4, 4);
-            break;
-        case 'state':
-            $this->setRankRange(8, 8);
-            break;
-        case 'city':
-            $this->setRankRange(14, 16);
-            break;
-        case 'settlement':
-            $this->setRankRange(8, 20);
-            break;
+            case 'country':
+                $this->setRankRange(4, 4);
+                break;
+            case 'state':
+                $this->setRankRange(8, 8);
+                break;
+            case 'city':
+                $this->setRankRange(14, 16);
+                break;
+            case 'settlement':
+                $this->setRankRange(8, 20);
+                break;
         }
     }
 
-    function setRankRange($iMin, $iMax)
+    public function setRankRange($iMin, $iMax)
     {
         $this->iMinAddressRank = $iMin;
         $this->iMaxAddressRank = $iMax;
     }
 
-    function setRoute($aRoutePoints, $fRouteWidth)
+    public function setRoute($aRoutePoints, $fRouteWidth)
     {
         $this->aViewBox = false;
 
         $this->sViewboxCentreSQL = "ST_SetSRID('LINESTRING(";
         $sSep = '';
-        foreach ($this->aRoutePoints as $aPoint) {
+        foreach ($aRoutePoints as $aPoint) {
             $fPoint = (float)$aPoint;
             $this->sViewboxCentreSQL .= $sSep.$fPoint;
             $sSep = ($sSep == ' ') ? ',' : ' ';
@@ -172,10 +176,20 @@ class Geocode
         $this->sViewboxLargeSQL .= ','.($fRouteWidth/30).')';
     }
 
-    function setViewbox($aViewbox)
+    public function setViewbox($aViewbox)
     {
         $this->aViewBox = array_map('floatval', $aViewbox);
 
+        if ($this->aViewBox[0] < -180
+            || $this->aViewBox[2] > 180
+            || $this->aViewBox[0] >= $this->aViewBox[2]
+            || $this->aViewBox[1] < -90
+            || $this->aViewBox[3] > 90
+            || $this->aViewBox[1] >= $this->aViewBox[3]
+        ) {
+            userError("Bad parameter 'viewbox'. Out of range".$this->aViewBox[0]."|".$this->aViewBox[1]."|".$this->aViewBox[2]."|".$this->aViewBox[3]);
+        }
+
         $fHeight = $this->aViewBox[0] - $this->aViewBox[2];
         $fWidth = $this->aViewBox[1] - $this->aViewBox[3];
         $aBigViewBox[0] = $this->aViewBox[0] + $fHeight;
@@ -188,24 +202,24 @@ class Geocode
         $this->sViewboxLargeSQL = "ST_SetSRID(ST_MakeBox2D(ST_Point(".$aBigViewBox[0].",".$aBigViewBox[1]."),ST_Point(".$aBigViewBox[2].",".$aBigViewBox[3].")),4326)";
     }
 
-    function setNearPoint($aNearPoint, $fRadiusDeg = 0.1)
+    public function setNearPoint($aNearPoint, $fRadiusDeg = 0.1)
     {
         $this->aNearPoint = array((float)$aNearPoint[0], (float)$aNearPoint[1], (float)$fRadiusDeg);
     }
 
-    function setQuery($sQueryString)
+    public function setQuery($sQueryString)
     {
         $this->sQuery = $sQueryString;
         $this->aStructuredQuery = false;
     }
 
-    function getQueryString()
+    public function getQueryString()
     {
         return $this->sQuery;
     }
 
 
-    function loadParamArray($oParams)
+    public function loadParamArray($oParams)
     {
         $this->bIncludeAddressDetails
          = $oParams->getBool('addressdetails', $this->bIncludeAddressDetails);
@@ -248,16 +262,22 @@ class Geocode
                     $aCountries[] = strtolower($sCountryCode);
                 }
             }
-            if (isset($aCountryCodes))
+            if (isset($aCountries))
                 $this->aCountryCodes = $aCountries;
         }
 
         $aViewbox = $oParams->getStringList('viewboxlbrt');
         if ($aViewbox) {
+            if (count($aViewbox) != 4) {
+                userError("Bad parmater 'viewbox'. Expected 4 coordinates.");
+            }
             $this->setViewbox($aViewbox);
         } else {
             $aViewbox = $oParams->getStringList('viewbox');
             if ($aViewbox) {
+                if (count($aViewbox) != 4) {
+                    userError("Bad parmater 'viewbox'. Expected 4 coordinates.");
+                }
                 $this->setViewBox(array(
                                    $aViewbox[0],
                                    $aViewbox[3],
@@ -274,7 +294,7 @@ class Geocode
         }
     }
 
-    function setQueryFromParams($oParams)
+    public function setQueryFromParams($oParams)
     {
         // Search query
         $sQuery = $oParams->getString('q');
@@ -294,7 +314,7 @@ class Geocode
         }
     }
 
-    function loadStructuredAddressElement($sValue, $sKey, $iNewMinAddressRank, $iNewMaxAddressRank, $aItemListValues)
+    public function loadStructuredAddressElement($sValue, $sKey, $iNewMinAddressRank, $iNewMaxAddressRank, $aItemListValues)
     {
         $sValue = trim($sValue);
         if (!$sValue) return false;
@@ -307,7 +327,7 @@ class Geocode
         return true;
     }
 
-    function setStructuredQuery($sAmentiy = false, $sStreet = false, $sCity = false, $sCounty = false, $sState = false, $sCountry = false, $sPostalCode = false)
+    public function setStructuredQuery($sAmentiy = false, $sStreet = false, $sCity = false, $sCounty = false, $sState = false, $sCountry = false, $sPostalCode = false)
     {
         $this->sQuery = false;
 
@@ -335,7 +355,7 @@ class Geocode
         }
     }
 
-    function fallbackStructuredQuery()
+    public function fallbackStructuredQuery()
     {
         if (!$this->aStructuredQuery) return false;
 
@@ -356,7 +376,7 @@ class Geocode
         return false;
     }
 
-    function getDetails($aPlaceIDs)
+    public function getDetails($aPlaceIDs)
     {
         //$aPlaceIDs is an array with key: placeID and value: tiger-housenumber, if found, else -1
         if (sizeof($aPlaceIDs) == 0) return array();
@@ -397,7 +417,7 @@ class Geocode
         $sSQL .= ",extratags->'place' ";
 
         if (30 >= $this->iMinAddressRank && 30 <= $this->iMaxAddressRank) {
-            //only Tiger housenumbers and interpolation lines need to be interpolated, because they are saved as lines 
+            // only Tiger housenumbers and interpolation lines need to be interpolated, because they are saved as lines
             // with start- and endnumber, the common osm housenumbers are usually saved as points
             $sHousenumbers = "";
             $i = 0;
@@ -408,7 +428,7 @@ class Geocode
                 if ($i<$length) $sHousenumbers .= ", ";
             }
             if (CONST_Use_US_Tiger_Data) {
-                //Tiger search only if a housenumber was searched and if it was found (i.e. aPlaceIDs[placeID] = housenumber != -1) (realized through a join)
+                // Tiger search only if a housenumber was searched and if it was found (i.e. aPlaceIDs[placeID] = housenumber != -1) (realized through a join)
                 $sSQL .= " union";
                 $sSQL .= " select 'T' as osm_type, place_id as osm_id, 'place' as class, 'house' as type, null as admin_level, 30 as rank_search, 30 as rank_address, min(place_id) as place_id, min(parent_place_id) as parent_place_id, 'us' as country_code";
                 $sSQL .= ", get_address_by_language(place_id, housenumber_for_place, $sLanguagePrefArraySQL) as langaddress ";
@@ -421,7 +441,7 @@ class Geocode
                 $sSQL .= ", (select max(p.importance*(p.rank_address+2)) from place_addressline s, placex p where s.place_id = min(blub.parent_place_id) and p.place_id = s.address_place_id and s.isaddress and p.importance is not null) as addressimportance ";
                 $sSQL .= ", null as extra_place ";
                 $sSQL .= " from (select place_id";
-                //interpolate the Tiger housenumbers here
+                // interpolate the Tiger housenumbers here
                 $sSQL .= ", ST_LineInterpolatePoint(linegeo, (housenumber_for_place-startnumber::float)/(endnumber-startnumber)::float) as centroid, parent_place_id, housenumber_for_place";
                 $sSQL .= " from (location_property_tiger ";
                 $sSQL .= " join (values ".$sHousenumbers.") as housenumbers(place_id, housenumber_for_place) using(place_id)) ";
@@ -444,7 +464,7 @@ class Geocode
             $sSQL .= " where s.place_id = min(blub.parent_place_id) and p.place_id = s.address_place_id and s.isaddress and p.importance is not null) as addressimportance,";
             $sSQL .= " null as extra_place ";
             $sSQL .= " from (select place_id, calculated_country_code ";
-            //interpolate the housenumbers here
+            // interpolate the housenumbers here
             $sSQL .= ", CASE WHEN startnumber != endnumber THEN ST_LineInterpolatePoint(linegeo, (housenumber_for_place-startnumber::float)/(endnumber-startnumber)::float) ";
             $sSQL .= " ELSE ST_LineInterpolatePoint(linegeo, 0.5) END as centroid";
             $sSQL .= ", parent_place_id, housenumber_for_place ";
@@ -476,7 +496,8 @@ class Geocode
 
         $sSQL .= " order by importance desc";
         if (CONST_Debug) {
-            echo "<hr>"; var_dump($sSQL);
+            echo "<hr>";
+            var_dump($sSQL);
         }
         $aSearchResults = chksql(
             $this->oDB->getAll($sSQL),
@@ -486,7 +507,7 @@ class Geocode
         return $aSearchResults;
     }
 
-    function getGroupedSearches($aSearches, $aPhraseTypes, $aPhrases, $aValidTokens, $aWordFrequencyScores, $bStructuredPhrases)
+    public function getGroupedSearches($aSearches, $aPhraseTypes, $aPhrases, $aValidTokens, $aWordFrequencyScores, $bStructuredPhrases)
     {
         /*
              Calculate all searches using aValidTokens i.e.
@@ -738,7 +759,9 @@ class Geocode
             name: full name (currently the same as langaddress)
             foundorder: secondary ordering for places with same importance
     */
-    function lookup()
+
+
+    public function lookup()
     {
         if (!$this->sQuery && !$this->aStructuredQuery) return false;
 
@@ -749,6 +772,9 @@ class Geocode
         }
 
         $sQuery = $this->sQuery;
+        if (!preg_match('//u', $sQuery)) {
+            userError("Query string is not UTF-8 encoded.");
+        }
 
         // Conflicts between US state abreviations and various words for 'the' in different languages
         if (isset($this->aLangPrefOrder['name:en'])) {
@@ -873,7 +899,7 @@ class Geocode
             foreach ($aPhrases as $iPhrase => $sPhrase) {
                 $aPhrase = chksql(
                     $this->oDB->getRow("select make_standard_name('".pg_escape_string($sPhrase)."') as string"),
-                    "Cannot nomralize query string (is it an UTF-8 string?)"
+                    "Cannot normalize query string (is it a UTF-8 string?)"
                 );
                 if (trim($aPhrase['string'])) {
                     $aPhrases[$iPhrase] = $aPhrase;
@@ -939,7 +965,7 @@ class Geocode
                         }
                     } elseif (!isset($aValidTokens[$sToken]) && preg_match('/^([0-9]{5}) [0-9]{4}$/', $sToken, $aData)) {
                         // US ZIP+4 codes - if there is no token,
-                        //  merge in the 5-digit ZIP code
+                        // merge in the 5-digit ZIP code
                         if (isset($aValidTokens[$aData[1]])) {
                             foreach ($aValidTokens[$aData[1]] as $aToken) {
                                 if (!$aToken['class']) {
@@ -1413,7 +1439,8 @@ class Geocode
                     }
 
                     if (CONST_Debug) {
-                        echo "<br><b>Place IDs:</b> "; var_Dump($aPlaceIDs);
+                        echo "<br><b>Place IDs:</b> ";
+                        var_Dump($aPlaceIDs);
                     }
 
                     foreach ($aPlaceIDs as $iPlaceID) {
@@ -1472,6 +1499,7 @@ class Geocode
 
             if ($aLookup['place_id']) {
                 $aSearchResults = $this->getDetails(array($aLookup['place_id'] => -1));
+                $aResultPlaceIDs[$aLookup['place_id']] = -1;
             } else {
                 $aSearchResults = array();
             }
@@ -1495,7 +1523,8 @@ class Geocode
         }
 
         if (CONST_Debug) {
-            echo '<i>Recheck words:<\i>'; var_dump($aRecheckWords);
+            echo '<i>Recheck words:<\i>';
+            var_dump($aRecheckWords);
         }
 
         $oPlaceLookup = new PlaceLookup($this->oDB);
@@ -1542,7 +1571,7 @@ class Geocode
                 // getAddressDetails() is defined in lib.php and uses the SQL function get_addressdata in functions.sql
                 $aResult['address'] = getAddressDetails($this->oDB, $sLanguagePrefArraySQL, $aResult['place_id'], $aResult['country_code'], $aResultPlaceIDs[$aResult['place_id']]);
                 if ($aResult['extra_place'] == 'city' && !isset($aResult['address']['city'])) {
-                    $aResult['address'] = array_merge(array('city' => array_shift(array_values($aResult['address']))), $aResult['address']);
+                    $aResult['address'] = array_merge(array('city' => array_values($aResult['address'])[0]), $aResult['address']);
                 }
             }
 
@@ -1577,15 +1606,15 @@ class Geocode
 
             $aResult['name'] = $aResult['langaddress'];
             // secondary ordering (for results with same importance (the smaller the better):
-            //   - approximate importance of address parts
+            // - approximate importance of address parts
             $aResult['foundorder'] = -$aResult['addressimportance']/10;
-            //   - number of exact matches from the query
+            // - number of exact matches from the query
             if (isset($this->exactMatchCache[$aResult['place_id']])) {
                 $aResult['foundorder'] -= $this->exactMatchCache[$aResult['place_id']];
             } elseif (isset($this->exactMatchCache[$aResult['parent_place_id']])) {
                 $aResult['foundorder'] -= $this->exactMatchCache[$aResult['parent_place_id']];
             }
-            //  - importance of the class/type
+            // - importance of the class/type
             if (isset($aClassType[$aResult['class'].':'.$aResult['type']]['importance'])
                 && $aClassType[$aResult['class'].':'.$aResult['type']]['importance']
             ) {
@@ -1625,9 +1654,5 @@ class Geocode
         }
 
         return $aSearchResults;
-
     } // end lookup()
-
-
 } // end class
-