]> git.openstreetmap.org Git - nominatim.git/blobdiff - lib/SearchDescription.php
move country list to SearchContext
[nominatim.git] / lib / SearchDescription.php
index a82852990e6f589f3bc57d9f2bd6c3f630c90ae9..39f7ffca90910c9b2b416d952156982ef90fd9ec 100644 (file)
@@ -2,45 +2,8 @@
 
 namespace Nominatim;
 
-/**
- * Operators describing special searches.
- */
-abstract class Operator
-{
-    /// No operator selected.
-    const NONE = 0;
-    /// Search for POI of the given type.
-    const TYPE = 1;
-    /// Search for POIs near the given place.
-    const NEAR = 2;
-    /// Search for POIS in the given place.
-    const IN = 3;
-    /// Search for POIS named as given.
-    const NAME = 4;
-    /// Search for postcodes.
-    const POSTCODE = 5;
-
-    private $aConstantNames = null;
-
-    public static function toString($iOperator)
-    {
-        if ($iOperator == Operator::NONE) {
-            return '';
-        }
-
-        if ($aConstantNames === null) {
-            $oReflector = new \ReflectionClass ('Nominatim\Operator');
-            $aConstants = $oReflector->getConstants();
-
-            $aConstantNames = array();
-            foreach ($aConstants as $sName => $iValue) {
-                $aConstantNames[$iValue] = $sName;
-            }
-        }
-
-        return $aConstantNames[$iOperator];
-    }
-}
+require_once(CONST_BasePath.'/lib/SpecialSearchOperator.php');
+require_once(CONST_BasePath.'/lib/SearchContext.php');
 
 /**
  * Description of a single interpretation of a search query.
@@ -71,14 +34,20 @@ class SearchDescription
     private $sHouseNumber = '';
     /// Postcode for the object.
     private $sPostcode = '';
-    /// Geographic search area.
-    private $oNearPoint = false;
+    /// Global search constraints.
+    private $oContext;
 
     // Temporary values used while creating the search description.
 
-    /// Index of phrase currently processed
+    /// Index of phrase currently processed.
     private $iNamePhrase = -1;
 
+
+    public function __construct($oContext)
+    {
+        $this->oContext = $oContext;
+    }
+
     public function getRank()
     {
         return $this->iSearchRank;
@@ -95,14 +64,6 @@ class SearchDescription
         return $this->sPostcode;
     }
 
-    /**
-     * Set the geographic search radius.
-     */
-    public function setNear(&$oNearPoint)
-    {
-        $this->oNearPoint = $oNearPoint;
-    }
-
     public function setPoiSearch($iOperator, $sClass, $sType)
     {
         $this->iOperator = $iOperator;
@@ -110,29 +71,15 @@ class SearchDescription
         $this->sType = $sType;
     }
 
-    /**
-     * Check if name or address for the search are specified.
-     */
     public function isNamedSearch()
     {
         return sizeof($this->aName) > 0 || sizeof($this->aAddress) > 0;
     }
 
-    /**
-     * Check if only a country is requested.
-     */
     public function isCountrySearch()
     {
         return $this->sCountryCode && sizeof($this->aName) == 0
-               && !$this->iOperator && !$this->oNearPoint;
-    }
-
-    /**
-     * Check if a search near a geographic location is requested.
-     */
-    public function isNearSearch()
-    {
-        return (bool) $this->oNearPoint;
+               && !$this->iOperator && !$this->oContext->hasNearPoint();
     }
 
     public function isPoiSearch()
@@ -162,13 +109,13 @@ class SearchDescription
         return 'place_classtype_'.$this->sClass.'_'.$this->sType;
     }
 
-    public function countryCodeSQL($sVar, $sCountryList)
+    public function countryCodeSQL($sVar)
     {
         if ($this->sCountryCode) {
             return $sVar.' = \''.$this->sCountryCode."'";
         }
-        if ($sCountryList) {
-            return $sVar.' in ('.$sCountryList.')';
+        if ($this->oContext->sqlCountryList) {
+            return $sVar.' in '.$this->oContext->sqlCountryList;
         }
 
         return '';
@@ -179,13 +126,6 @@ class SearchDescription
         return $this->iOperator != Operator::NONE;
     }
 
-    /**
-     * Extract special terms from the query, amend the search
-     * and return the shortended query.
-     *
-     * Only the first special term found will be used but all will
-     * be removed from the query.
-     */
     public function extractKeyValuePairs($sQuery)
     {
         // Search for terms of kind [<key>=<value>].
@@ -225,6 +165,7 @@ class SearchDescription
 
     /////////// Search building functions
 
+
     public function extendWithFullTerm($aSearchTerm, $bWordInQuery, $bHasPartial, $sPhraseType, $bFirstToken, $bFirstPhrase, $bLastToken, &$iGlobalRank)
     {
         $aNewSearches = array();
@@ -256,7 +197,9 @@ class SearchDescription
             // We need to try the case where the postal code is the primary element
             // (i.e. no way to tell if it is (postalcode, city) OR (city, postalcode)
             // so try both.
-            if (!$this->sPostcode && $bWordInQuery) {
+            if (!$this->sPostcode && $bWordInQuery
+                && pg_escape_string($aSearchTerm['word']) == $aSearchTerm['word']
+            ) {
                 // If we have structured search or this is the first term,
                 // make the postcode the primary search element.
                 if ($this->iOperator == Operator::NONE
@@ -294,6 +237,9 @@ class SearchDescription
                 if (preg_match_all("/[^0-9]/", $oSearch->sHouseNumber, $aMatches) > 2) {
                     $oSearch->iSearchRank++;
                 }
+                if (!isset($aSearchTerm['word_id'])) {
+                    $oSearch->iSearchRank++;
+                }
                 // also must not appear in the middle of the address
                 if (sizeof($this->aAddress) || sizeof($this->aAddressNonSearch)) {
                     $oSearch->iSearchRank++;
@@ -322,7 +268,7 @@ class SearchDescription
                 }
 
                 $oSearch->setPoiSearch($iOp, $aSearchTerm['class'], $aSearchTerm['type']);
-                $aNewWordsetSearches[] = $oSearch;
+                $aNewSearches[] = $oSearch;
             }
         } elseif (isset($aSearchTerm['word_id']) && $aSearchTerm['word_id']) {
             $iWordID = $aSearchTerm['word_id'];
@@ -335,8 +281,7 @@ class SearchDescription
                     $oSearch->iSearchRank++;
                     $oSearch->aAddress[$iWordID] = $iWordID;
                     $aNewSearches[] = $oSearch;
-                }
-                else {
+                } else {
                     $this->aFullNameAddress[$iWordID] = $iWordID;
                 }
             } else {
@@ -393,7 +338,7 @@ class SearchDescription
                         $aNewSearches[] = $oSearch;
                     }
                 }
-            } 
+            }
         }
 
         if ((!$this->sPostcode && !$this->aAddress && !$this->aAddressNonSearch)
@@ -421,13 +366,14 @@ class SearchDescription
 
     /////////// Query functions
 
-    public function queryCountry(&$oDB, $sViewboxSQL)
+
+    public function queryCountry(&$oDB)
     {
         $sSQL = 'SELECT place_id FROM placex ';
         $sSQL .= "WHERE country_code='".$this->sCountryCode."'";
         $sSQL .= ' AND rank_search = 4';
-        if ($sViewboxSQL) {
-            $sSQL .= " AND ST_Intersects($sViewboxSQL, geometry)";
+        if ($this->oContext->bViewboxBounded) {
+            $sSQL .= ' AND ST_Intersects('.$this->oContext->sqlViewboxSmall.', geometry)';
         }
         $sSQL .= " ORDER BY st_area(geometry) DESC LIMIT 1";
 
@@ -436,7 +382,7 @@ class SearchDescription
         return chksql($oDB->getCol($sSQL));
     }
 
-    public function queryNearbyPoi(&$oDB, $sCountryList, $sViewboxSQL, $sViewboxCentreSQL, $sExcludeSQL, $iLimit)
+    public function queryNearbyPoi(&$oDB, $iLimit)
     {
         if (!$this->sClass) {
             return array();
@@ -447,39 +393,38 @@ class SearchDescription
         $sSQL = 'SELECT count(*) FROM pg_tables WHERE tablename = \''.$sPoiTable."'";
         if (chksql($oDB->getOne($sSQL))) {
             $sSQL = 'SELECT place_id FROM '.$sPoiTable.' ct';
-            if ($sCountryList) {
+            if ($this->oContext->sqlCountryList) {
                 $sSQL .= ' JOIN placex USING (place_id)';
             }
-            if ($this->oNearPoint) {
-                $sSQL .= ' WHERE '.$this->oNearPoint->withinSQL('ct.centroid');
-            } else {
-                $sSQL .= " WHERE ST_Contains($sViewboxSQL, ct.centroid)";
-            }
-            if ($sCountryList) {
-                $sSQL .= " AND country_code in ($sCountryList)";
+            if ($this->oContext->hasNearPoint()) {
+                $sSQL .= ' WHERE '.$this->oContext->withinSQL('ct.centroid');
+            } else if ($this->oContext->bViewboxBounded) {
+                $sSQL .= ' WHERE ST_Contains('.$this->oContext->sqlViewboxSmall.', ct.centroid)';
             }
-            if ($sExcludeSQL) {
-                $sSQL .= ' AND place_id not in ('.$sExcludeSQL.')';
+            if ($this->oContext->sqlCountryList) {
+                $sSQL .= ' AND country_code in '.$this->oContext->sqlCountryList;
             }
-            if ($sViewboxCentreSQL) {
-                $sSQL .= " ORDER BY ST_Distance($sViewboxCentreSQL, ct.centroid) ASC";
-            } elseif ($this->oNearPoint) {
-                $sSQL .= ' ORDER BY '.$this->oNearPoint->distanceSQL('ct.centroid').' ASC';
+            $sSQL .= $this->oContext->excludeSQL(' AND place_id');
+            if ($this->oContext->sqlViewboxCentre) {
+                $sSQL .= ' ORDER BY ST_Distance(';
+                $sSQL .= $this->oContext->sqlViewboxCentre.', ct.centroid) ASC';
+            } elseif ($this->oContext->hasNearPoint()) {
+                $sSQL .= ' ORDER BY '.$this->oContext->distanceSQL('ct.centroid').' ASC';
             }
             $sSQL .= " limit $iLimit";
             if (CONST_Debug) var_dump($sSQL);
             return chksql($oDB->getCol($sSQL));
         }
 
-        if ($this->oNearPoint) {
+        if ($this->oContext->hasNearPoint()) {
             $sSQL = 'SELECT place_id FROM placex WHERE ';
             $sSQL .= 'class=\''.$this->sClass."' and type='".$this->sType."'";
-            $sSQL .= ' AND '.$this->oNearPoint->withinSQL('geometry');
+            $sSQL .= ' AND '.$this->oContext->withinSQL('geometry');
             $sSQL .= ' AND linked_place_id is null';
-            if ($sCountryList) {
-                $sSQL .= " AND country_code in ($sCountryList)";
+            if ($this->oContext->sqlCountryList) {
+                $sSQL .= ' AND country_code in '.$this->oContext->sqlCountryList;
             }
-            $sSQL .= ' ORDER BY '.$this->oNearPoint->distanceSQL('centroid')." ASC";
+            $sSQL .= ' ORDER BY '.$this->oContext->distanceSQL('centroid')." ASC";
             $sSQL .= " LIMIT $iLimit";
             if (CONST_Debug) var_dump($sSQL);
             return chksql($oDB->getCol($sSQL));
@@ -488,9 +433,9 @@ class SearchDescription
         return array();
     }
 
-    public function queryPostcode(&$oDB, $sCountryList, $iLimit)
+    public function queryPostcode(&$oDB, $iLimit)
     {
-        $sSQL  = 'SELECT p.place_id FROM location_postcode p ';
+        $sSQL = 'SELECT p.place_id FROM location_postcode p ';
 
         if (sizeof($this->aAddress)) {
             $sSQL .= ', search_name s ';
@@ -501,11 +446,9 @@ class SearchDescription
             $sSQL .= 'WHERE ';
         }
 
-        $sSQL .= "p.postcode = '".pg_escape_string(reset($this->$aName))."'";
-        $sCountryTerm = $this->countryCodeSQL('p.country_code', $sCountryList);
-        if ($sCountryTerm) {
-            $sSQL .= ' AND '.$sCountyTerm;
-        }
+        $sSQL .= "p.postcode = '".reset($this->aName)."'";
+        $sSQL .= $this->countryCodeSQL(' AND p.country_code');
+        $sSQL .= $this->oContext->excludeSQL(' AND p.place_id');
         $sSQL .= " LIMIT $iLimit";
 
         if (CONST_Debug) var_dump($sSQL);
@@ -513,7 +456,7 @@ class SearchDescription
         return chksql($oDB->getCol($sSQL));
     }
 
-    public function queryNamedPlace(&$oDB, $aWordFrequencyScores, $sCountryList, $iMinAddressRank, $iMaxAddressRank, $sExcludeSQL, $sViewboxSmall, $sViewboxLarge, $iLimit)
+    public function queryNamedPlace(&$oDB, $aWordFrequencyScores, $iMinAddressRank, $iMaxAddressRank, $iLimit)
     {
         $aTerms = array();
         $aOrder = array();
@@ -560,7 +503,7 @@ class SearchDescription
             }
         }
 
-        $sCountryTerm = $this->countryCodeSQL('country_code', $sCountryList);
+        $sCountryTerm = $this->countryCodeSQL('country_code');
         if ($sCountryTerm) {
             $aTerms[] = $sCountryTerm;
         }
@@ -576,9 +519,9 @@ class SearchDescription
             }
         }
 
-        if ($this->oNearPoint) {
-            $aTerms[] = $this->oNearPoint->withinSQL('centroid');
-            $aOrder[] = $this->oNearPoint->distanceSQL('centroid');
+        if ($this->oContext->hasNearPoint()) {
+            $aTerms[] = $this->oContext->withinSQL('centroid');
+            $aOrder[] = $this->oContext->distanceSQL('centroid');
         } elseif ($this->sPostcode) {
             if (!sizeof($this->aAddress)) {
                 $aTerms[] = "EXISTS(SELECT place_id FROM location_postcode p WHERE p.postcode = '".$this->sPostcode."' AND ST_DWithin(search_name.centroid, p.geometry, 0.1))";
@@ -587,16 +530,17 @@ class SearchDescription
             }
         }
 
+        $sExcludeSQL = $this->oContext->excludeSQL('place_id');
         if ($sExcludeSQL) {
-            $aTerms[] = 'place_id not in ('.$sExcludeSQL.')';
+            $aTerms[] = $sExcludeSQL;
         }
 
-        if ($sViewboxSmall) {
-           $aTerms[] = 'centroid && '.$sViewboxSmall;
+        if ($this->oContext->bViewboxBounded) {
+            $aTerms[] = 'centroid && '.$this->oContext->sqlViewboxSmall;
         }
 
-        if ($this->oNearPoint) {
-            $aOrder[] = $this->oNearPoint->distanceSQL('centroid');
+        if ($this->oContext->hasNearPoint()) {
+            $aOrder[] = $this->oContext->distanceSQL('centroid');
         }
 
         if ($this->sHouseNumber) {
@@ -604,12 +548,7 @@ class SearchDescription
         } else {
             $sImportanceSQL = '(CASE WHEN importance = 0 OR importance IS NULL THEN 0.75-(search_rank::float/40) ELSE importance END)';
         }
-        if ($sViewboxSmall) {
-            $sImportanceSQL .= " * CASE WHEN ST_Contains($sViewboxSmall, centroid) THEN 1 ELSE 0.5 END";
-        }
-        if ($sViewboxLarge) {
-            $sImportanceSQL .= " * CASE WHEN ST_Contains($sViewboxLarge, centroid) THEN 1 ELSE 0.5 END";
-        }
+        $sImportanceSQL .= $this->oContext->viewboxImportanceSQL('centroid');
         $aOrder[] = "$sImportanceSQL DESC";
 
         if (sizeof($this->aFullNameAddress)) {
@@ -647,8 +586,7 @@ class SearchDescription
         return array();
     }
 
-
-    public function queryHouseNumber(&$oDB, $aRoadPlaceIDs, $sExcludeSQL, $iLimit)
+    public function queryHouseNumber(&$oDB, $aRoadPlaceIDs, $iLimit)
     {
         $sPlaceIDs = join(',', $aRoadPlaceIDs);
 
@@ -656,9 +594,7 @@ class SearchDescription
         $sSQL = 'SELECT place_id FROM placex ';
         $sSQL .= 'WHERE parent_place_id in ('.$sPlaceIDs.')';
         $sSQL .= "  AND transliteration(housenumber) ~* E'".$sHouseNumberRegex."'";
-        if ($sExcludeSQL) {
-            $sSQL .= ' AND place_id not in ('.$sExcludeSQL.')';
-        }
+        $sSQL .= $this->oContext->excludeSQL(' AND place_id');
         $sSQL .= " LIMIT $iLimit";
 
         if (CONST_Debug) var_dump($sSQL);
@@ -687,10 +623,7 @@ class SearchDescription
             $sSQL .= " or interpolationtype='all') and ";
             $sSQL .= $iHousenumber.">=startnumber and ";
             $sSQL .= $iHousenumber."<=endnumber";
-
-            if ($sExcludeSQL) {
-                $sSQL .= ' AND place_id not in ('.$sExcludeSQL.')';
-            }
+            $sSQL .= $this->oContext->excludeSQL(' AND place_id');
             $sSQL .= " limit $iLimit";
 
             if (CONST_Debug) var_dump($sSQL);
@@ -707,9 +640,7 @@ class SearchDescription
             $sSQL = 'SELECT place_id FROM location_property_aux';
             $sSQL .= ' WHERE parent_place_id in ('.$sPlaceIDs.')';
             $sSQL .= " AND housenumber = '".$this->sHouseNumber."'";
-            if ($sExcludeSQL) {
-                $sSQL .= " AND place_id not in ($sExcludeSQL)";
-            }
+            $sSQL .= $this->oContext->excludeSQL(' AND place_id');
             $sSQL .= " limit $iLimit";
 
             if (CONST_Debug) var_dump($sSQL);
@@ -733,10 +664,7 @@ class SearchDescription
             $sSQL .= " or interpolationtype='all') and ";
             $sSQL .= $iHousenumber.">=startnumber and ";
             $sSQL .= $iHousenumber."<=endnumber";
-
-            if ($sExcludeSQL) {
-                $sSQL .= ' AND place_id not in ('.$sExcludeSQL.')';
-            }
+            $sSQL .= $this->oContext->excludeSQL(' AND place_id');
             $sSQL .= " limit $iLimit";
 
             if (CONST_Debug) var_dump($sSQL);
@@ -752,7 +680,7 @@ class SearchDescription
     }
 
 
-    public function queryPoiByOperator(&$oDB, $aParentIDs, $sExcludeSQL, $iLimit)
+    public function queryPoiByOperator(&$oDB, $aParentIDs, $iLimit)
     {
         $sPlaceIDs = join(',', $aParentIDs);
         $aClassPlaceIDs = array();
@@ -765,6 +693,7 @@ class SearchDescription
             $sSQL .= "   AND class='".$this->sClass."' ";
             $sSQL .= "   AND type='".$this->sType."'";
             $sSQL .= "   AND linked_place_id is null";
+            $sSQL .= $this->oContext->excludeSQL(' AND place_id');
             $sSQL .= " ORDER BY rank_search ASC ";
             $sSQL .= " LIMIT $iLimit";
 
@@ -815,8 +744,8 @@ class SearchDescription
                     $fRange = 0.05;
 
                     $sOrderBySQL = '';
-                    if ($this->oNearPoint) {
-                        $sOrderBySQL = $this->oNearPoint->distanceSQL('l.centroid');
+                    if ($this->oContext->hasNearPoint()) {
+                        $sOrderBySQL = $this->oContext->distanceSQL('l.centroid');
                     } elseif ($sPlaceIDs) {
                         $sOrderBySQL = "ST_Distance(l.centroid, f.geometry)";
                     } elseif ($sPlaceGeom) {
@@ -841,9 +770,7 @@ class SearchDescription
                         $sSQL .= " WHERE ST_Contains('$sPlaceGeom', l.centroid)";
                     }
 
-                    if ($sExcludeSQL) {
-                        $sSQL .= ' AND l.place_id not in ('.$sExcludeSQL.')';
-                    }
+                    $sSQL .= $this->oContext->excludeSQL(' AND l.place_id');
                     $sSQL .= 'limit 300) i ';
                     if ($sOrderBySQL) {
                         $sSQL .= 'order by order_term asc';
@@ -854,13 +781,13 @@ class SearchDescription
 
                     $aClassPlaceIDs = array_merge($aClassPlaceIDs, chksql($oDB->getCol($sSQL)));
                 } else {
-                    if ($this->oNearPoint) {
-                        $fRange = $this->oNearPoint->radius();
+                    if ($this->oContext->hasNearPoint()) {
+                        $fRange = $this->oContext->nearRadius();
                     }
 
                     $sOrderBySQL = '';
-                    if ($this->oNearPoint) {
-                        $sOrderBySQL = $this->oNearPoint->distanceSQL('l.geometry');
+                    if ($this->oContext->hasNearPoint()) {
+                        $sOrderBySQL = $this->oContext->distanceSQL('l.geometry');
                     } else {
                         $sOrderBySQL = "ST_Distance(l.geometry, f.geometry)";
                     }
@@ -874,9 +801,7 @@ class SearchDescription
                     $sSQL .= "  AND ST_DWithin(l.geometry, f.centroid, $fRange)";
                     $sSQL .= "  AND l.class='".$this->sClass."'";
                     $sSQL .= "  AND l.type='".$this->sType."'";
-                    if ($sExcludeSQL) {
-                        $sSQL .= " AND l.place_id not in (".$sExcludeSQL.")";
-                    }
+                    $sSQL .= $this->oContext->excludeSQL(' AND l.place_id');
                     if ($sOrderBySQL) {
                         $sSQL .= "ORDER BY orderterm ASC";
                     }
@@ -895,7 +820,8 @@ class SearchDescription
 
     /////////// Sort functions
 
-    static function bySearchRank($a, $b)
+
+    public static function bySearchRank($a, $b)
     {
         if ($a->iSearchRank == $b->iSearchRank) {
             return $a->iOperator + strlen($a->sHouseNumber)
@@ -907,9 +833,12 @@ class SearchDescription
 
     //////////// Debugging functions
 
-    function dumpAsHtmlTableRow(&$aWordIDs)
+
+    public function dumpAsHtmlTableRow(&$aWordIDs)
     {
-        $kf = function($k) use (&$aWordIDs) { return $aWordIDs[$k]; };
+        $kf = function ($k) use (&$aWordIDs) {
+            return $aWordIDs[$k];
+        };
 
         echo "<tr>";
         echo "<td>$this->iSearchRank</td>";
@@ -924,14 +853,6 @@ class SearchDescription
         echo "<td>".$this->sPostcode."</td>";
         echo "<td>".$this->sHouseNumber."</td>";
 
-        if ($this->oNearPoint) {
-            echo "<td>".$this->oNearPoint->lat()."</td>";
-            echo "<td>".$this->oNearPoint->lon()."</td>";
-            echo "<td>".$this->oNearPoint->radius()."</td>";
-        } else {
-            echo "<td></td><td></td><td></td>";
-        }
-
         echo "</tr>";
     }
-};
+}