Merge remote-tracking branch 'upstream/master'

[nominatim.git] / lib / Geocode.php

diff --git a/lib/Geocode.php b/lib/Geocode.php
index bf359caf77a6c94b564573ebdc4e24473b61474b..8276fe98d6c86d4d4d6d9ad6fafd74757bf949ce 100644 (file)
--- a/lib/Geocode.php
+++ b/lib/Geocode.php
@@ -12,22 +12,14 @@ class Geocode
 {
     protected $oDB;
 
 {
     protected $oDB;
 

+    protected $oPlaceLookup;
+

     protected $aLangPrefOrder = array();
 
     protected $bIncludeAddressDetails = false;
     protected $aLangPrefOrder = array();
 
     protected $bIncludeAddressDetails = false;

-    protected $bIncludeExtraTags = false;
-    protected $bIncludeNameDetails = false;
-
-    protected $bIncludePolygonAsPoints = false;
-    protected $bIncludePolygonAsText = false;
-    protected $bIncludePolygonAsGeoJSON = false;
-    protected $bIncludePolygonAsKML = false;
-    protected $bIncludePolygonAsSVG = false;
-    protected $fPolygonSimplificationThreshold = 0.0;

 
     protected $aExcludePlaceIDs = array();
 
     protected $aExcludePlaceIDs = array();

-    protected $bDeDupe = true;
-    protected $bReverseInPlan = false;
+    protected $bReverseInPlan = true;

 
     protected $iLimit = 20;
     protected $iFinalLimit = 10;
 
     protected $iLimit = 20;
     protected $iFinalLimit = 10;


@@ -57,6 +49,7 @@ class Geocode
     public function __construct(&$oDB)
     {
         $this->oDB =& $oDB;
     public function __construct(&$oDB)
     {
         $this->oDB =& $oDB;

+        $this->oPlaceLookup = new PlaceLookup($this->oDB);

         $this->oNormalizer = \Transliterator::createFromRules(CONST_Term_Normalization_Rules);
     }
 
         $this->oNormalizer = \Transliterator::createFromRules(CONST_Term_Normalization_Rules);
     }
 


@@ -87,26 +80,14 @@ class Geocode
             $aParams = array('q' => $this->sQuery);
         }
 
             $aParams = array('q' => $this->sQuery);
         }
 

+        $aParams = array_merge($aParams, $this->oPlaceLookup->getMoreUrlParams());
+

         if ($this->aExcludePlaceIDs) {
             $aParams['exclude_place_ids'] = implode(',', $this->aExcludePlaceIDs);
         }
 
         if ($this->bIncludeAddressDetails) $aParams['addressdetails'] = '1';
         if ($this->aExcludePlaceIDs) {
             $aParams['exclude_place_ids'] = implode(',', $this->aExcludePlaceIDs);
         }
 
         if ($this->bIncludeAddressDetails) $aParams['addressdetails'] = '1';

-        if ($this->bIncludeExtraTags) $aParams['extratags'] = '1';
-        if ($this->bIncludeNameDetails) $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';
-        if ($this->bIncludePolygonAsSVG) $aParams['polygon_svg'] = '1';
-
-        if ($this->fPolygonSimplificationThreshold > 0.0) {
-            $aParams['polygon_threshold'] = $this->fPolygonSimplificationThreshold;
-        }
-

         if ($this->bBoundedSearch) $aParams['bounded'] = '1';
         if ($this->bBoundedSearch) $aParams['bounded'] = '1';

-        if (!$this->bDeDupe) $aParams['dedupe'] = '0';

 
         if ($this->aCountryCodes) {
             $aParams['countrycodes'] = implode(',', $this->aCountryCodes);
 
         if ($this->aCountryCodes) {
             $aParams['countrycodes'] = implode(',', $this->aCountryCodes);


@@ -119,36 +100,6 @@ class Geocode
         return $aParams;
     }
 
         return $aParams;
     }
 

-    public function setIncludePolygonAsPoints($b = true)
-    {
-        $this->bIncludePolygonAsPoints = $b;
-    }
-
-    public function setIncludePolygonAsText($b = true)
-    {
-        $this->bIncludePolygonAsText = $b;
-    }
-
-    public function setIncludePolygonAsGeoJSON($b = true)
-    {
-        $this->bIncludePolygonAsGeoJSON = $b;
-    }
-
-    public function setIncludePolygonAsKML($b = true)
-    {
-        $this->bIncludePolygonAsKML = $b;
-    }
-
-    public function setIncludePolygonAsSVG($b = true)
-    {
-        $this->bIncludePolygonAsSVG = $b;
-    }
-
-    public function setPolygonSimplificationThreshold($f)
-    {
-        $this->fPolygonSimplificationThreshold = $f;
-    }
-

     public function setLimit($iLimit = 10)
     {
         if ($iLimit > 50) $iLimit = 50;
     public function setLimit($iLimit = 10)
     {
         if ($iLimit > 50) $iLimit = 50;


@@ -229,17 +180,12 @@ class Geocode
     }
 
 
     }
 
 

-    public function loadParamArray($oParams)
+    public function loadParamArray($oParams, $sForceGeometryType = null)

     {
         $this->bIncludeAddressDetails
          = $oParams->getBool('addressdetails', $this->bIncludeAddressDetails);
     {
         $this->bIncludeAddressDetails
          = $oParams->getBool('addressdetails', $this->bIncludeAddressDetails);

-        $this->bIncludeExtraTags
-         = $oParams->getBool('extratags', $this->bIncludeExtraTags);
-        $this->bIncludeNameDetails
-         = $oParams->getBool('namedetails', $this->bIncludeNameDetails);

 
         $this->bBoundedSearch = $oParams->getBool('bounded', $this->bBoundedSearch);
 
         $this->bBoundedSearch = $oParams->getBool('bounded', $this->bBoundedSearch);

-        $this->bDeDupe = $oParams->getBool('dedupe', $this->bDeDupe);

 
         $this->setLimit($oParams->getInt('limit', $this->iFinalLimit));
         $this->iOffset = $oParams->getInt('offset', $this->iOffset);
 
         $this->setLimit($oParams->getInt('limit', $this->iFinalLimit));
         $this->iOffset = $oParams->getInt('offset', $this->iOffset);


@@ -298,6 +244,10 @@ class Geocode
                 }
             }
         }
                 }
             }
         }

+
+        $this->oPlaceLookup->loadParamArray($oParams, $sForceGeometryType);
+        $this->oPlaceLookup->setIncludeAddressDetails(false);
+        $this->oPlaceLookup->setIncludePolygonAsPoints($oParams->getBool('polygon'));

     }
 
     public function setQueryFromParams($oParams)
     }
 
     public function setQueryFromParams($oParams)


@@ -395,8 +345,6 @@ class Geocode
 
              Score how good the search is so they can be ordered
          */
 
              Score how good the search is so they can be ordered
          */

-        $iGlobalRank = 0;
-

         foreach ($aPhrases as $iPhrase => $oPhrase) {
             $aNewPhraseSearches = array();
             $sPhraseType = $bIsStructured ? $oPhrase->getPhraseType() : '';
         foreach ($aPhrases as $iPhrase => $oPhrase) {
             $aNewPhraseSearches = array();
             $sPhraseType = $bIsStructured ? $oPhrase->getPhraseType() : '';


@@ -428,8 +376,7 @@ class Geocode
                                     $iToken == 0 && $iPhrase == 0,
                                     $iPhrase == 0,
                                     $iToken + 1 == sizeof($aWordset)
                                     $iToken == 0 && $iPhrase == 0,
                                     $iPhrase == 0,
                                     $iToken + 1 == sizeof($aWordset)

-                                      && $iPhrase + 1 == sizeof($aPhrases),
-                                    $iGlobalRank
+                                      && $iPhrase + 1 == sizeof($aPhrases)

                                 );
 
                                 foreach ($aNewSearches as $oSearch) {
                                 );
 
                                 foreach ($aNewSearches as $oSearch) {


@@ -510,7 +457,7 @@ class Geocode
                 continue;
             }
 
                 continue;
             }
 

-            $iRank = $oSearch->addToRank($iGlobalRank);
+            $iRank = $oSearch->getRank();

             if (!isset($aGroupedSearches[$iRank])) {
                 $aGroupedSearches[$iRank] = array();
             }
             if (!isset($aGroupedSearches[$iRank])) {
                 $aGroupedSearches[$iRank] = array();
             }


@@ -578,12 +525,12 @@ class Geocode
 
         $sNormQuery = $this->normTerm($this->sQuery);
         $sLanguagePrefArraySQL = getArraySQL(
 
         $sNormQuery = $this->normTerm($this->sQuery);
         $sLanguagePrefArraySQL = getArraySQL(

-            array_map("getDBQuoted", $this->aLangPrefOrder)
+            array_map('getDBQuoted', $this->aLangPrefOrder)

         );
 
         $sQuery = $this->sQuery;
         if (!preg_match('//u', $sQuery)) {
         );
 
         $sQuery = $this->sQuery;
         if (!preg_match('//u', $sQuery)) {

-            userError("Query string is not UTF-8 encoded.");
+            userError('Query string is not UTF-8 encoded.');

         }
 
         // Conflicts between US state abreviations and various words for 'the' in different languages
         }
 
         // Conflicts between US state abreviations and various words for 'the' in different languages


@@ -630,7 +577,7 @@ class Geocode
                 $sSpecialTerm = pg_escape_string($sSpecialTerm);
                 $sToken = chksql(
                     $this->oDB->getOne("SELECT make_standard_name('$sSpecialTerm')"),
                 $sSpecialTerm = pg_escape_string($sSpecialTerm);
                 $sToken = chksql(
                     $this->oDB->getOne("SELECT make_standard_name('$sSpecialTerm')"),

-                    "Cannot decode query. Wrong encoding?"
+                    'Cannot decode query. Wrong encoding?'

                 );
                 $sSQL = 'SELECT class, type FROM word ';
                 $sSQL .= '   WHERE word_token in (\' '.$sToken.'\')';
                 );
                 $sSQL = 'SELECT class, type FROM word ';
                 $sSQL .= '   WHERE word_token in (\' '.$sToken.'\')';


@@ -671,7 +618,7 @@ class Geocode
             foreach ($aInPhrases as $iPhrase => $sPhrase) {
                 $sPhrase = chksql(
                     $this->oDB->getOne('SELECT make_standard_name('.getDBQuoted($sPhrase).')'),
             foreach ($aInPhrases as $iPhrase => $sPhrase) {
                 $sPhrase = chksql(
                     $this->oDB->getOne('SELECT make_standard_name('.getDBQuoted($sPhrase).')'),

-                    "Cannot normalize query string (is it a UTF-8 string?)"
+                    'Cannot normalize query string (is it a UTF-8 string?)'

                 );
                 if (trim($sPhrase)) {
                     $oPhrase = new Phrase($sPhrase, is_string($iPhrase) ? $iPhrase : '');
                 );
                 if (trim($sPhrase)) {
                     $oPhrase = new Phrase($sPhrase, is_string($iPhrase) ? $iPhrase : '');


@@ -684,14 +631,14 @@ class Geocode
                 // Check which tokens we have, get the ID numbers
                 $sSQL = 'SELECT word_id, word_token, word, class, type, country_code, operator, search_name_count';
                 $sSQL .= ' FROM word ';
                 // Check which tokens we have, get the ID numbers
                 $sSQL = 'SELECT word_id, word_token, word, class, type, country_code, operator, search_name_count';
                 $sSQL .= ' FROM word ';

-                $sSQL .= ' WHERE word_token in ('.join(',', array_map("getDBQuoted", $aTokens)).')';
+                $sSQL .= ' WHERE word_token in ('.join(',', array_map('getDBQuoted', $aTokens)).')';

 
                 if (CONST_Debug) var_Dump($sSQL);
 
                 $aValidTokens = array();
                 $aDatabaseWords = chksql(
                     $this->oDB->getAll($sSQL),
 
                 if (CONST_Debug) var_Dump($sSQL);
 
                 $aValidTokens = array();
                 $aDatabaseWords = chksql(
                     $this->oDB->getAll($sSQL),

-                    "Could not get word tokens."
+                    'Could not get word tokens.'

                 );
                 $aWordFrequencyScores = array();
                 foreach ($aDatabaseWords as $aToken) {
                 );
                 $aWordFrequencyScores = array();
                 foreach ($aDatabaseWords as $aToken) {


@@ -833,15 +780,15 @@ class Geocode
                     if ($sPlaceIds) {
                         $sSQL = 'SELECT place_id FROM placex ';
                         $sSQL .= 'WHERE place_id in ('.$sPlaceIds.') ';
                     if ($sPlaceIds) {
                         $sSQL = 'SELECT place_id FROM placex ';
                         $sSQL .= 'WHERE place_id in ('.$sPlaceIds.') ';

-                        $sSQL .= "  AND (";
+                        $sSQL .= '  AND (';

                         $sSQL .= "         placex.rank_address between $this->iMinAddressRank and $this->iMaxAddressRank ";
                         if (14 >= $this->iMinAddressRank && 14 <= $this->iMaxAddressRank) {
                             $sSQL .= "     OR (extratags->'place') = 'city'";
                         }
                         if ($this->aAddressRankList) {
                         $sSQL .= "         placex.rank_address between $this->iMinAddressRank and $this->iMaxAddressRank ";
                         if (14 >= $this->iMinAddressRank && 14 <= $this->iMaxAddressRank) {
                             $sSQL .= "     OR (extratags->'place') = 'city'";
                         }
                         if ($this->aAddressRankList) {

-                            $sSQL .= "     OR placex.rank_address in (".join(',', $this->aAddressRankList).")";
+                            $sSQL .= '     OR placex.rank_address in ('.join(',', $this->aAddressRankList).')';

                         }
                         }

-                        $sSQL .= ")";
+                        $sSQL .= ')';

                         $aFilterSql[] = $sSQL;
                     }
                     $sPlaceIds = Result::joinIdsByTable($aResults, Result::TABLE_POSTCODE);
                         $aFilterSql[] = $sSQL;
                     }
                     $sPlaceIds = Result::joinIdsByTable($aResults, Result::TABLE_POSTCODE);


@@ -850,9 +797,9 @@ class Geocode
                         $sSQL .= 'WHERE place_id in ('.$sPlaceIds.') ';
                         $sSQL .= "  AND (lp.rank_address between $this->iMinAddressRank and $this->iMaxAddressRank ";
                         if ($this->aAddressRankList) {
                         $sSQL .= 'WHERE place_id in ('.$sPlaceIds.') ';
                         $sSQL .= "  AND (lp.rank_address between $this->iMinAddressRank and $this->iMaxAddressRank ";
                         if ($this->aAddressRankList) {

-                            $sSQL .= "     OR lp.rank_address in (".join(',', $this->aAddressRankList).")";
+                            $sSQL .= '     OR lp.rank_address in ('.join(',', $this->aAddressRankList).')';

                         }
                         }

-                        $sSQL .= ") ";
+                        $sSQL .= ') ';

                         $aFilterSql[] = $sSQL;
                     }
 
                         $aFilterSql[] = $sSQL;
                     }
 


@@ -888,7 +835,7 @@ class Geocode
 
             $oLookup = $oReverse->lookupPoint($oCtx->sqlNear, false);
 
 
             $oLookup = $oReverse->lookupPoint($oCtx->sqlNear, false);
 

-            if (CONST_Debug) var_dump("Reverse search", $aLookup);
+            if (CONST_Debug) var_dump('Reverse search', $aLookup);

 
             if ($oLookup) {
                 $aResults = array($oLookup->iId => $oLookup);
 
             if ($oLookup) {
                 $aResults = array($oLookup->iId => $oLookup);


@@ -906,26 +853,16 @@ class Geocode
             return array();
         }
 
             return array();
         }
 

-        $oPlaceLookup = new PlaceLookup($this->oDB);
-        $oPlaceLookup->setIncludePolygonAsPoints($this->bIncludePolygonAsPoints);
-        $oPlaceLookup->setIncludePolygonAsText($this->bIncludePolygonAsText);
-        $oPlaceLookup->setIncludePolygonAsGeoJSON($this->bIncludePolygonAsGeoJSON);
-        $oPlaceLookup->setIncludePolygonAsKML($this->bIncludePolygonAsKML);
-        $oPlaceLookup->setIncludePolygonAsSVG($this->bIncludePolygonAsSVG);
-        $oPlaceLookup->setPolygonSimplificationThreshold($this->fPolygonSimplificationThreshold);
-        $oPlaceLookup->setDeDupe($this->bDeDupe);

         if ($this->aAddressRankList) {
         if ($this->aAddressRankList) {

-            $oPlaceLookup->setAddressRankList($this->aAddressRankList);
+            $this->oPlaceLookup->setAddressRankList($this->aAddressRankList);

         }
         }

-        $oPlaceLookup->setAllowedTypesSQLList($this->sAllowedTypesSQLList);
-        $oPlaceLookup->setLanguagePreference($this->aLangPrefOrder);
-        $oPlaceLookup->setIncludeExtraTags($this->bIncludeExtraTags);
-        $oPlaceLookup->setIncludeNameDetails($this->bIncludeNameDetails);
+        $this->oPlaceLookup->setAllowedTypesSQLList($this->sAllowedTypesSQLList);
+        $this->oPlaceLookup->setLanguagePreference($this->aLangPrefOrder);

         if ($oCtx->hasNearPoint()) {
         if ($oCtx->hasNearPoint()) {

-            $oPlaceLookup->setAnchorSql($oCtx->sqlNear);
+            $this->oPlaceLookup->setAnchorSql($oCtx->sqlNear);

         }
 
         }
 

-        $aSearchResults = $oPlaceLookup->lookup($aResults);
+        $aSearchResults = $this->oPlaceLookup->lookup($aResults);

 
         $aClassType = getClassTypesWithImportance();
         $aRecheckWords = preg_split('/\b[\s,\\-]*/u', $sQuery);
 
         $aClassType = getClassTypesWithImportance();
         $aRecheckWords = preg_split('/\b[\s,\\-]*/u', $sQuery);


@@ -942,7 +879,7 @@ class Geocode
             // Default
             $fDiameter = getResultDiameter($aResult);
 
             // Default
             $fDiameter = getResultDiameter($aResult);
 

-            $aOutlineResult = $oPlaceLookup->getOutlines($aResult['place_id'], $aResult['lon'], $aResult['lat'], $fDiameter/2);
+            $aOutlineResult = $this->oPlaceLookup->getOutlines($aResult['place_id'], $aResult['lon'], $aResult['lat'], $fDiameter/2);

             if ($aOutlineResult) {
                 $aResult = array_merge($aResult, $aOutlineResult);
             }
             if ($aOutlineResult) {
                 $aResult = array_merge($aResult, $aOutlineResult);
             }


@@ -995,7 +932,7 @@ class Geocode
                 foreach ($aRecheckWords as $i => $sWord) {
                     if (stripos($sAddress, $sWord)!==false) {
                         $iCountWords++;
                 foreach ($aRecheckWords as $i => $sWord) {
                     if (stripos($sAddress, $sWord)!==false) {
                         $iCountWords++;

-                        if (preg_match("/(^|,)\s*".preg_quote($sWord, '/')."\s*(,|$)/", $sAddress)) $iCountWords += 0.1;
+                        if (preg_match('/(^|,)\s*'.preg_quote($sWord, '/').'\s*(,|$)/', $sAddress)) $iCountWords += 0.1;

                     }
                 }
 
                     }
                 }
 


@@ -1036,7 +973,7 @@ class Geocode
                 if (isset($aResult['zoom'])) $iZoom = $aResult['zoom'];
                 $bFirst = false;
             }
                 if (isset($aResult['zoom'])) $iZoom = $aResult['zoom'];
                 $bFirst = false;
             }

-            if (!$this->bDeDupe || (!isset($aOSMIDDone[$aResult['osm_type'].$aResult['osm_id']])
+            if (!$this->oPlaceLookup->doDeDupe() || (!isset($aOSMIDDone[$aResult['osm_type'].$aResult['osm_id']])

                 && !isset($aClassTypeNameDone[$aResult['osm_type'].$aResult['class'].$aResult['type'].$aResult['name'].$aResult['admin_level']]))
             ) {
                 $aOSMIDDone[$aResult['osm_type'].$aResult['osm_id']] = true;
                 && !isset($aClassTypeNameDone[$aResult['osm_type'].$aResult['class'].$aResult['type'].$aResult['name'].$aResult['admin_level']]))
             ) {
                 $aOSMIDDone[$aResult['osm_type'].$aResult['osm_id']] = true;