]> git.openstreetmap.org Git - nominatim.git/blobdiff - lib/SearchDescription.php
replace NearPoint with a more generic context object
[nominatim.git] / lib / SearchDescription.php
index d18e7eab35790b3208a6c1cde94508875afbc011..7073186b09a778f9c528fde56b90199d9f7084d0 100644 (file)
@@ -2,24 +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;
-}
+require_once(CONST_BasePath.'/lib/SpecialSearchOperator.php');
+require_once(CONST_BasePath.'/lib/SearchContext.php');
 
 /**
  * Description of a single interpretation of a search query.
@@ -50,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;
@@ -74,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;
@@ -89,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()
@@ -158,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>].
@@ -204,6 +165,7 @@ class SearchDescription
 
     /////////// Search building functions
 
+
     public function extendWithFullTerm($aSearchTerm, $bWordInQuery, $bHasPartial, $sPhraseType, $bFirstToken, $bFirstPhrase, $bLastToken, &$iGlobalRank)
     {
         $aNewSearches = array();
@@ -235,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
@@ -273,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++;
@@ -301,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'];
@@ -314,8 +281,7 @@ class SearchDescription
                     $oSearch->iSearchRank++;
                     $oSearch->aAddress[$iWordID] = $iWordID;
                     $aNewSearches[] = $oSearch;
-                }
-                else {
+                } else {
                     $this->aFullNameAddress[$iWordID] = $iWordID;
                 }
             } else {
@@ -372,7 +338,7 @@ class SearchDescription
                         $aNewSearches[] = $oSearch;
                     }
                 }
-            } 
+            }
         }
 
         if ((!$this->sPostcode && !$this->aAddress && !$this->aAddressNonSearch)
@@ -400,6 +366,7 @@ class SearchDescription
 
     /////////// Query functions
 
+
     public function queryCountry(&$oDB, $sViewboxSQL)
     {
         $sSQL = 'SELECT place_id FROM placex ';
@@ -429,8 +396,8 @@ class SearchDescription
             if ($sCountryList) {
                 $sSQL .= ' JOIN placex USING (place_id)';
             }
-            if ($this->oNearPoint) {
-                $sSQL .= ' WHERE '.$this->oNearPoint->withinSQL('ct.centroid');
+            if ($this->oContext->hasNearPoint()) {
+                $sSQL .= ' WHERE '.$this->oContext->withinSQL('ct.centroid');
             } else {
                 $sSQL .= " WHERE ST_Contains($sViewboxSQL, ct.centroid)";
             }
@@ -442,23 +409,23 @@ class SearchDescription
             }
             if ($sViewboxCentreSQL) {
                 $sSQL .= " ORDER BY ST_Distance($sViewboxCentreSQL, ct.centroid) ASC";
-            } elseif ($this->oNearPoint) {
-                $sSQL .= ' ORDER BY '.$this->oNearPoint->distanceSQL('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)";
             }
-            $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));
@@ -469,7 +436,7 @@ class SearchDescription
 
     public function queryPostcode(&$oDB, $sCountryList, $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 ';
@@ -480,10 +447,10 @@ class SearchDescription
             $sSQL .= 'WHERE ';
         }
 
-        $sSQL .= "p.postcode = '".pg_escape_string(reset($this->$aName))."'";
+        $sSQL .= "p.postcode = '".reset($this->aName)."'";
         $sCountryTerm = $this->countryCodeSQL('p.country_code', $sCountryList);
         if ($sCountryTerm) {
-            $sSQL .= ' AND '.$sCountyTerm;
+            $sSQL .= ' AND '.$sCountryTerm;
         }
         $sSQL .= " LIMIT $iLimit";
 
@@ -555,9 +522,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))";
@@ -571,11 +538,11 @@ class SearchDescription
         }
 
         if ($sViewboxSmall) {
-           $aTerms[] = 'centroid && '.$sViewboxSmall;
+            $aTerms[] = 'centroid && '.$sViewboxSmall;
         }
 
-        if ($this->oNearPoint) {
-            $aOrder[] = $this->oNearPoint->distanceSQL('centroid');
+        if ($this->oContext->hasNearPoint()) {
+            $aOrder[] = $this->oContext->distanceSQL('centroid');
         }
 
         if ($this->sHouseNumber) {
@@ -794,8 +761,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) {
@@ -833,13 +800,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,7 +841,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)
@@ -884,4 +852,28 @@ class SearchDescription
         return $a->iSearchRank < $b->iSearchRank ? -1 : 1;
     }
 
-};
+    //////////// Debugging functions
+
+
+    public function dumpAsHtmlTableRow(&$aWordIDs)
+    {
+        $kf = function ($k) use (&$aWordIDs) {
+            return $aWordIDs[$k];
+        };
+
+        echo "<tr>";
+        echo "<td>$this->iSearchRank</td>";
+        echo "<td>".join(', ', array_map($kf, $this->aName))."</td>";
+        echo "<td>".join(', ', array_map($kf, $this->aNameNonSearch))."</td>";
+        echo "<td>".join(', ', array_map($kf, $this->aAddress))."</td>";
+        echo "<td>".join(', ', array_map($kf, $this->aAddressNonSearch))."</td>";
+        echo "<td>".$this->sCountryCode."</td>";
+        echo "<td>".Operator::toString($this->iOperator)."</td>";
+        echo "<td>".$this->sClass."</td>";
+        echo "<td>".$this->sType."</td>";
+        echo "<td>".$this->sPostcode."</td>";
+        echo "<td>".$this->sHouseNumber."</td>";
+
+        echo "</tr>";
+    }
+}