]> git.openstreetmap.org Git - nominatim.git/blobdiff - lib/SearchDescription.php
add documentation for Phrase
[nominatim.git] / lib / SearchDescription.php
index 1a994acd38207a08d1fab8e3a904f1ca081442b2..143d28647dc1c21db91089fb7a804d74cfee32c0 100644 (file)
@@ -2,24 +2,8 @@
 
 namespace Nominatim;
 
-/**
- * Operators describing special searches.
- */
-abstract final 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,32 +34,64 @@ 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 getRank()
+
+    /**
+     * Create an empty search description.
+     *
+     * @param object $oContext Global context to use. Will be inherited by
+     *                         all derived search objects.
+     */
+    public function __construct($oContext)
     {
-        return $this->iSearchRank;
+        $this->oContext = $oContext;
     }
 
-    public function getPostCode()
+    /**
+     * Get current search rank.
+     *
+     * The higher the search rank the lower the likelyhood that the
+     * search is a correct interpretation of the search query.
+     *
+     * @return integer Search rank.
+     */
+    public function getRank()
     {
-        return $this->sPostcode;
+        return $this->iSearchRank;
     }
 
     /**
-     * Set the geographic search radius.
+     * Increase the search rank.
+     *
+     * @param integer $iAddRank Number of ranks to increase.
+     *
+     * @return void
      */
-    public function setNear(&$oNearPoint)
+    public function addToRank($iAddRank)
     {
-        $this->oNearPoint = $oNearPoint;
+        $this->iSearchRank += $iAddRank;
+        return $this->iSearchRank;
     }
 
+    /**
+     * Make this search a POI search.
+     *
+     * In a POI search, objects are not (only) searched by their name
+     * but also by the primary OSM key/value pair (class and type in Nominatim).
+     *
+     * @param integer $iOperator Type of POI search
+     * @param string  $sClass    Class (or OSM tag key) of POI.
+     * @param string  $sType     Type (or OSM tag value) of POI.
+     *
+     * @return void
+     */
     public function setPoiSearch($iOperator, $sClass, $sType)
     {
         $this->iOperator = $iOperator;
@@ -84,108 +100,424 @@ class SearchDescription
     }
 
     /**
-     * Check if name or address for the search are specified.
+     * Check if this might be a full address search.
+     *
+     * @return bool True if the search contains name, address and housenumber.
      */
-    public function isNamedSearch()
+    public function looksLikeFullAddress()
     {
-        return sizeof($this->aName) > 0 || sizeof($this->aAddress) > 0;
+        return sizeof($this->aName)
+               && (sizeof($this->aAddress || $this->sCountryCode))
+               && preg_match('/[0-9]+/', $this->sHouseNumber);
     }
 
     /**
-     * Check if only a country is requested.
+     * Check if any operator is set.
+     *
+     * @return bool True, if this is a special search operation.
      */
-    public function isCountrySearch()
+    public function hasOperator()
     {
-        return $this->sCountryCode && sizeof($this->aName) == 0
-               && !$this->iOperator && !$this->oNear;
+        return $this->iOperator != Operator::NONE;
     }
 
     /**
-     * Check if a search near a geographic location is requested.
+     * Extract key/value pairs from a query.
+     *
+     * Key/value pairs are recognised if they are of the form [<key>=<value>].
+     * If multiple terms of this kind are found then all terms are removed
+     * but only the first is used for search.
+     *
+     * @param string $sQuery Original query string.
+     *
+     * @return string The query string with the special search patterns removed.
      */
-    public function isNearSearch()
+    public function extractKeyValuePairs($sQuery)
     {
-        return (bool) $this->oNear;
-    }
+        // Search for terms of kind [<key>=<value>].
+        preg_match_all(
+            '/\\[([\\w_]*)=([\\w_]*)\\]/',
+            $sQuery,
+            $aSpecialTermsRaw,
+            PREG_SET_ORDER
+        );
 
-    public function isPoiSearch()
-    {
-        return (bool) $this->sClass;
-    }
+        foreach ($aSpecialTermsRaw as $aTerm) {
+            $sQuery = str_replace($aTerm[0], ' ', $sQuery);
+            if (!$this->hasOperator()) {
+                $this->setPoiSearch(Operator::TYPE, $aTerm[1], $aTerm[2]);
+            }
+        }
 
-    public function looksLikeFullAddress()
-    {
-        return sizeof($this->aName)
-               && (sizeof($this->aAddress || $this->sCountryCode))
-               && preg_match('/[0-9]+/', $this->sHouseNumber);
+        return $sQuery;
     }
 
-    public function isOperator($iType)
+    /**
+     * Check if the combination of parameters is sensible.
+     *
+     * @param string[] $aCountryCodes List of country codes.
+     *
+     * @return bool True, if the search looks valid.
+     */
+    public function isValidSearch(&$aCountryCodes)
     {
-        return $this->iOperator == $iType;
-    }
+        if (!sizeof($this->aName)) {
+            if ($this->sHouseNumber) {
+                return false;
+            }
+        }
+        if ($aCountryCodes
+            && $this->sCountryCode
+            && !in_array($this->sCountryCode, $aCountryCodes)
+        ) {
+            return false;
+        }
 
-    public function hasHouseNumber()
-    {
-        return (bool) $this->sHouseNumber;
+        return true;
     }
 
-    private function poiTable()
+    /////////// Search building functions
+
+
+    /**
+     * Derive new searches by adding a full term to the existing search.
+     *
+     * @param mixed[] $aSearchTerm  Description of the token.
+     * @param bool    $bWordInQuery True, if the normalised version of the word
+     *                              is contained in the query.
+     * @param bool    $bHasPartial  True if there are also tokens of partial terms
+     *                              with the same name.
+     * @param string  $sPhraseType  Type of phrase the token is contained in.
+     * @param bool    $bFirstToken  True if the token is at the beginning of the
+     *                              query.
+     * @param bool    $bFirstPhrase True if the token is in the first phrase of
+     *                              the query.
+     * @param bool    $bLastToken   True if the token is at the end of the query.
+     * @param integer $iGlobalRank  Changable ranking of all searches in the
+     *                              batch.
+     *
+     * @return SearchDescription[] List of derived search descriptions.
+     */
+    public function extendWithFullTerm($aSearchTerm, $bWordInQuery, $bHasPartial, $sPhraseType, $bFirstToken, $bFirstPhrase, $bLastToken, &$iGlobalRank)
     {
-        return 'place_classtype_'.$this->sClass.'_'.$this->sType;
+        $aNewSearches = array();
+
+        if (($sPhraseType == '' || $sPhraseType == 'country')
+            && !empty($aSearchTerm['country_code'])
+            && $aSearchTerm['country_code'] != '0'
+        ) {
+            if (!$this->sCountryCode) {
+                $oSearch = clone $this;
+                $oSearch->iSearchRank++;
+                $oSearch->sCountryCode = $aSearchTerm['country_code'];
+                // Country is almost always at the end of the string
+                // - increase score for finding it anywhere else (optimisation)
+                if (!$bLastToken) {
+                    $oSearch->iSearchRank += 5;
+                }
+                $aNewSearches[] = $oSearch;
+
+                // If it is at the beginning, we can be almost sure that
+                // the terms are in the wrong order. Increase score for all searches.
+                if ($bFirstToken) {
+                    $iGlobalRank++;
+                }
+            }
+        } elseif (($sPhraseType == '' || $sPhraseType == 'postalcode')
+                  && $aSearchTerm['class'] == 'place' && $aSearchTerm['type'] == 'postcode'
+        ) {
+            // 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
+                && 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
+                    && ($sPhraseType == 'postalcode' || $bFirstToken)
+                ) {
+                    $oSearch = clone $this;
+                    $oSearch->iSearchRank++;
+                    $oSearch->iOperator = Operator::POSTCODE;
+                    $oSearch->aAddress = array_merge($this->aAddress, $this->aName);
+                    $oSearch->aName =
+                        array($aSearchTerm['word_id'] => $aSearchTerm['word']);
+                    $aNewSearches[] = $oSearch;
+                }
+
+                // If we have a structured search or this is not the first term,
+                // add the postcode as an addendum.
+                if ($this->iOperator != Operator::POSTCODE
+                    && ($sPhraseType == 'postalcode' || sizeof($this->aName))
+                ) {
+                    $oSearch = clone $this;
+                    $oSearch->iSearchRank++;
+                    $oSearch->sPostcode = $aSearchTerm['word'];
+                    $aNewSearches[] = $oSearch;
+                }
+            }
+        } elseif (($sPhraseType == '' || $sPhraseType == 'street')
+                 && $aSearchTerm['class'] == 'place' && $aSearchTerm['type'] == 'house'
+        ) {
+            if (!$this->sHouseNumber && $this->iOperator != Operator::POSTCODE) {
+                $oSearch = clone $this;
+                $oSearch->iSearchRank++;
+                $oSearch->sHouseNumber = trim($aSearchTerm['word_token']);
+                // sanity check: if the housenumber is not mainly made
+                // up of numbers, add a penalty
+                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++;
+                }
+                $aNewSearches[] = $oSearch;
+            }
+        } elseif ($sPhraseType == ''
+                  && $aSearchTerm['class'] !== '' && $aSearchTerm['class'] !== null
+        ) {
+            // require a normalized exact match of the term
+            // if we have the normalizer version of the query
+            // available
+            if ($this->iOperator == Operator::NONE
+                && (isset($aSearchTerm['word']) && $aSearchTerm['word'])
+                && $bWordInQuery
+            ) {
+                $oSearch = clone $this;
+                $oSearch->iSearchRank++;
+
+                $iOp = Operator::NEAR; // near == in for the moment
+                if ($aSearchTerm['operator'] == '') {
+                    if (sizeof($this->aName)) {
+                        $iOp = Operator::NAME;
+                    }
+                    $oSearch->iSearchRank += 2;
+                }
+
+                $oSearch->setPoiSearch($iOp, $aSearchTerm['class'], $aSearchTerm['type']);
+                $aNewSearches[] = $oSearch;
+            }
+        } elseif (isset($aSearchTerm['word_id']) && $aSearchTerm['word_id']) {
+            $iWordID = $aSearchTerm['word_id'];
+            if (sizeof($this->aName)) {
+                if (($sPhraseType == '' || !$bFirstPhrase)
+                    && $sPhraseType != 'country'
+                    && !$bHasPartial
+                ) {
+                    $oSearch = clone $this;
+                    $oSearch->iSearchRank++;
+                    $oSearch->aAddress[$iWordID] = $iWordID;
+                    $aNewSearches[] = $oSearch;
+                } else {
+                    $this->aFullNameAddress[$iWordID] = $iWordID;
+                }
+            } else {
+                $oSearch = clone $this;
+                $oSearch->iSearchRank++;
+                $oSearch->aName = array($iWordID => $iWordID);
+                $aNewSearches[] = $oSearch;
+            }
+        }
+
+        return $aNewSearches;
     }
 
-    public function countryCodeSQL($sVar, $sCountryList)
+    /**
+     * Derive new searches by adding a partial term to the existing search.
+     *
+     * @param mixed[] $aSearchTerm          Description of the token.
+     * @param bool    $bStructuredPhrases   True if the search is structured.
+     * @param integer $iPhrase              Number of the phrase the token is in.
+     * @param array[] $aFullTokens          List of full term tokens with the
+     *                                      same name.
+     *
+     * @return SearchDescription[] List of derived search descriptions.
+     */
+    public function extendWithPartialTerm($aSearchTerm, $bStructuredPhrases, $iPhrase, $aFullTokens)
     {
-        if ($this->sCountryCode) {
-            return $sVar.' = \''.$this->sCountryCode."'";
+        // Only allow name terms.
+        if (!(isset($aSearchTerm['word_id']) && $aSearchTerm['word_id'])) {
+            return array();
         }
-        if ($sCountryList) {
-            return $sVar.' in ('.$this->sCountryCode.')';
+
+        $aNewSearches = array();
+        $iWordID = $aSearchTerm['word_id'];
+
+        if ((!$bStructuredPhrases || $iPhrase > 0)
+            && sizeof($this->aName)
+            && strpos($aSearchTerm['word_token'], ' ') === false
+        ) {
+            if ($aSearchTerm['search_name_count'] + 1 < CONST_Max_Word_Frequency) {
+                $oSearch = clone $this;
+                $oSearch->iSearchRank++;
+                $oSearch->aAddress[$iWordID] = $iWordID;
+                $aNewSearches[] = $oSearch;
+            } else {
+                $oSearch = clone $this;
+                $oSearch->iSearchRank++;
+                $oSearch->aAddressNonSearch[$iWordID] = $iWordID;
+                if (preg_match('#^[0-9]+$#', $aSearchTerm['word_token'])) {
+                    $oSearch->iSearchRank += 2;
+                }
+                if (sizeof($aFullTokens)) {
+                    $oSearch->iSearchRank++;
+                }
+                $aNewSearches[] = $oSearch;
+
+                // revert to the token version?
+                foreach ($aFullTokens as $aSearchTermToken) {
+                    if (empty($aSearchTermToken['country_code'])
+                        && empty($aSearchTermToken['lat'])
+                        && empty($aSearchTermToken['class'])
+                    ) {
+                        $oSearch = clone $this;
+                        $oSearch->iSearchRank++;
+                        $oSearch->aAddress[$aSearchTermToken['word_id']] = $aSearchTermToken['word_id'];
+                        $aNewSearches[] = $oSearch;
+                    }
+                }
+            }
         }
 
-        return '';
-    }
+        if ((!$this->sPostcode && !$this->aAddress && !$this->aAddressNonSearch)
+            && (!sizeof($this->aName) || $this->iNamePhrase == $iPhrase)
+        ) {
+            $oSearch = clone $this;
+            $oSearch->iSearchRank++;
+            if (!sizeof($this->aName)) {
+                $oSearch->iSearchRank += 1;
+            }
+            if (preg_match('#^[0-9]+$#', $aSearchTerm['word_token'])) {
+                $oSearch->iSearchRank += 2;
+            }
+            if ($aSearchTerm['search_name_count'] + 1 < CONST_Max_Word_Frequency) {
+                $oSearch->aName[$iWordID] = $iWordID;
+            } else {
+                $oSearch->aNameNonSearch[$iWordID] = $iWordID;
+            }
+            $oSearch->iNamePhrase = $iPhrase;
+            $aNewSearches[] = $oSearch;
+        }
 
-    public function hasOperator()
-    {
-        return $this->iOperator != Operator::NONE;
+        return $aNewSearches;
     }
 
+    /////////// Query functions
+
+
     /**
-     * Extract special terms from the query, amend the search
-     * and return the shortended query.
+     * Query database for places that match this search.
+     *
+     * @param object  $oDB                  Database connection to use.
+     * @param mixed[] $aWordFrequencyScores Number of times tokens appears
+     *                                      overall in a planet database.
+     * @param mixed[] $aExactMatchCache     Saves number of exact matches.
+     * @param integer $iMinRank             Minimum address rank to restrict
+     *                                      search to.
+     * @param integer $iMaxRank             Maximum address rank to restrict
+     *                                      search to.
+     * @param integer $iLimit               Maximum number of results.
      *
-     * Only the first special term found will be used but all will
-     * be removed from the query.
+     * @return mixed[] An array with two fields: IDs contains the list of
+     *                 matching place IDs and houseNumber the houseNumber
+     *                 if appicable or -1 if not.
      */
-    public function extractKeyValuePairs($sQuery)
+    public function query(&$oDB, &$aWordFrequencyScores, &$aExactMatchCache, $iMinRank, $iMaxRank, $iLimit)
     {
-        // Search for terms of kind [<key>=<value>].
-        preg_match_all(
-            '/\\[([\\w_]*)=([\\w_]*)\\]/',
-            $sQuery,
-            $aSpecialTermsRaw,
-            PREG_SET_ORDER
-        );
+        $aPlaceIDs = array();
+        $iHousenumber = -1;
+
+        if ($this->sCountryCode
+            && !sizeof($this->aName)
+            && !$this->iOperator
+            && !$this->sClass
+            && !$this->oContext->hasNearPoint()
+        ) {
+            // Just looking for a country - look it up
+            if (4 >= $iMinRank && 4 <= $iMaxRank) {
+                $aPlaceIDs = $this->queryCountry($oDB);
+            }
+        } elseif (!sizeof($this->aName) && !sizeof($this->aAddress)) {
+            // Neither name nor address? Then we must be
+            // looking for a POI in a geographic area.
+            if ($this->oContext->isBoundedSearch()) {
+                $aPlaceIDs = $this->queryNearbyPoi($oDB, $iLimit);
+            }
+        } elseif ($this->iOperator == Operator::POSTCODE) {
+            // looking for postcode
+            $aPlaceIDs = $this->queryPostcode($oDB, $iLimit);
+        } else {
+            // Ordinary search:
+            // First search for places according to name and address.
+            $aNamedPlaceIDs = $this->queryNamedPlace(
+                $oDB,
+                $aWordFrequencyScores,
+                $iMinRank,
+                $iMaxRank,
+                $iLimit
+            );
 
-        foreach ($aSpecialTermsRaw as $aTerm) {
-            $sQuery = str_replace($aTerm[0], ' ', $sQuery);
-            if (!$this->hasOperator()) {
-                $this->setPoiSearch(Operator::TYPE, $aTerm[1], $aTerm[2]);
+            if (sizeof($aNamedPlaceIDs)) {
+                foreach ($aNamedPlaceIDs as $aRow) {
+                    $aPlaceIDs[] = $aRow['place_id'];
+                    $aExactMatchCache[$aRow['place_id']] = $aRow['exactmatch'];
+                }
+            }
+
+            //now search for housenumber, if housenumber provided
+            if ($this->sHouseNumber && sizeof($aPlaceIDs)) {
+                $aResult = $this->queryHouseNumber($oDB, $aPlaceIDs, $iLimit);
+
+                if (sizeof($aResult)) {
+                    $iHousenumber = $aResult['iHouseNumber'];
+                    $aPlaceIDs = $aResult['aPlaceIDs'];
+                } elseif (!$this->looksLikeFullAddress()) {
+                    $aPlaceIDs = array();
+                }
+            }
+
+            // finally get POIs if requested
+            if ($this->sClass && sizeof($aPlaceIDs)) {
+                $aPlaceIDs = $this->queryPoiByOperator($oDB, $aPlaceIDs, $iLimit);
             }
         }
 
-        return $sQuery;
+        if (CONST_Debug) {
+            echo "<br><b>Place IDs:</b> ";
+            var_Dump($aPlaceIDs);
+        }
+
+        if (sizeof($aPlaceIDs) && $this->sPostcode) {
+            $sSQL = 'SELECT place_id FROM placex';
+            $sSQL .= ' WHERE place_id in ('.join(',', $aPlaceIDs).')';
+            $sSQL .= " AND postcode = '".$this->sPostcode."'";
+            if (CONST_Debug) var_dump($sSQL);
+            $aFilteredPlaceIDs = chksql($oDB->getCol($sSQL));
+            if ($aFilteredPlaceIDs) {
+                $aPlaceIDs = $aFilteredPlaceIDs;
+                if (CONST_Debug) {
+                    echo "<br><b>Place IDs after postcode filtering:</b> ";
+                    var_Dump($aPlaceIDs);
+                }
+            }
+        }
+
+        return array('IDs' => $aPlaceIDs, 'houseNumber' => $iHousenumber);
     }
 
-    public function queryCountry(&$oDB, $sViewboxSQL)
+
+    private function queryCountry(&$oDB)
     {
         $sSQL = 'SELECT place_id FROM placex ';
         $sSQL .= "WHERE country_code='".$this->sCountryCode."'";
         $sSQL .= ' AND rank_search = 4';
-        if ($ViewboxSQL) {
-            $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";
 
@@ -194,7 +526,7 @@ class SearchDescription
         return chksql($oDB->getCol($sSQL));
     }
 
-    public function queryNearbyPoi(&$oDB, $sCountryList, $sViewboxSQL, $sViewboxCentreSQL, $sExcludeSQL, $iLimit)
+    private function queryNearbyPoi(&$oDB, $iLimit)
     {
         if (!$this->sClass) {
             return array();
@@ -205,50 +537,49 @@ 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 ($this->oContext->hasNearPoint()) {
+                $sSQL .= ' WHERE '.$this->oContext->withinSQL('ct.centroid');
+            } elseif ($this->oContext->bViewboxBounded) {
+                $sSQL .= ' WHERE ST_Contains('.$this->oContext->sqlViewboxSmall.', ct.centroid)';
             }
-            if ($sCountryList) {
-                $sSQL .= " AND country_code in ($sCountryList)";
+            if ($this->oContext->sqlCountryList) {
+                $sSQL .= ' AND country_code in '.$this->oContext->sqlCountryList;
             }
-            if ($sExcludeSQL) {
-                $sSQL .= ' AND place_id not in ('.$sExcludeSQL.')';
-            }
-            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($this->oDB->getCol($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($this->oDB->getCol($sSQL));
+            return chksql($oDB->getCol($sSQL));
         }
 
         return array();
     }
 
-    public function queryPostcode(&$oDB, $sCountryList, $iLimit)
+    private 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 ';
@@ -259,19 +590,17 @@ 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);
 
-        return chksql($this->oDB->getCol($sSQL));
+        return chksql($oDB->getCol($sSQL));
     }
 
-    public function queryNamedPlace(&$oDB, $aWordFrequencyScores, $sCountryList, $iMinAddressRank, $iMaxAddressRank, $sExcludeSQL, $sViewboxSmall, $sViewboxLarge, $iLimit)
+    private function queryNamedPlace(&$oDB, $aWordFrequencyScores, $iMinAddressRank, $iMaxAddressRank, $iLimit)
     {
         $aTerms = array();
         $aOrder = array();
@@ -318,7 +647,7 @@ class SearchDescription
             }
         }
 
-        $sCountryTerm = $this->countryCodeSQL('p.country_code', $sCountryList);
+        $sCountryTerm = $this->countryCodeSQL('country_code');
         if ($sCountryTerm) {
             $aTerms[] = $sCountryTerm;
         }
@@ -334,9 +663,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))";
@@ -345,16 +674,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) {
@@ -362,12 +692,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)) {
@@ -397,7 +722,7 @@ class SearchDescription
             if (CONST_Debug) var_dump($sSQL);
 
             return chksql(
-                $this->oDB->getAll($sSQL),
+                $oDB->getAll($sSQL),
                 "Could not get places for search terms."
             );
         }
@@ -405,8 +730,7 @@ class SearchDescription
         return array();
     }
 
-
-    public function queryHouseNumber(&$oDB, $aRoadPlaceIDs, $sExcludeSQL, $iLimit)
+    private function queryHouseNumber(&$oDB, $aRoadPlaceIDs, $iLimit)
     {
         $sPlaceIDs = join(',', $aRoadPlaceIDs);
 
@@ -414,14 +738,12 @@ 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);
 
-        $aPlaceIDs = chksql($this->oDB->getCol($sSQL));
+        $aPlaceIDs = chksql($oDB->getCol($sSQL));
 
         if (sizeof($aPlaceIDs)) {
             return array('aPlaceIDs' => $aPlaceIDs, 'iHouseNumber' => -1);
@@ -445,15 +767,12 @@ 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);
 
-            $aPlaceIDs = chksql($this->oDB->getCol($sSQL, 0));
+            $aPlaceIDs = chksql($oDB->getCol($sSQL, 0));
 
             if (sizeof($aPlaceIDs)) {
                 return array('aPlaceIDs' => $aPlaceIDs, 'iHouseNumber' => $iHousenumber);
@@ -465,14 +784,12 @@ 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);
 
-            $aPlaceIDs = chksql($this->oDB->getCol($sSQL));
+            $aPlaceIDs = chksql($oDB->getCol($sSQL));
 
             if (sizeof($aPlaceIDs)) {
                 return array('aPlaceIDs' => $aPlaceIDs, 'iHouseNumber' => -1);
@@ -491,15 +808,12 @@ 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);
 
-            $aPlaceIDs = chksql($this->oDB->getCol($sSQL, 0));
+            $aPlaceIDs = chksql($oDB->getCol($sSQL, 0));
 
             if (sizeof($aPlaceIDs)) {
                 return array('aPlaceIDs' => $aPlaceIDs, 'iHouseNumber' => $iHousenumber);
@@ -510,7 +824,7 @@ class SearchDescription
     }
 
 
-    public function queryPoiByOperator(&$oDB, $aParentIDs, $sExcludeSQL, $iLimit)
+    private function queryPoiByOperator(&$oDB, $aParentIDs, $iLimit)
     {
         $sPlaceIDs = join(',', $aParentIDs);
         $aClassPlaceIDs = array();
@@ -523,23 +837,24 @@ 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";
 
             if (CONST_Debug) var_dump($sSQL);
 
-            $aClassPlaceIDs = chksql($this->oDB->getCol($sSQL));
+            $aClassPlaceIDs = chksql($oDB->getCol($sSQL));
         }
 
         // NEAR and IN are handled the same
         if ($this->iOperator == Operator::TYPE || $this->iOperator == Operator::NEAR) {
             $sClassTable = $this->poiTable();
             $sSQL = "SELECT count(*) FROM pg_tables WHERE tablename = '$sClassTable'";
-            $bCacheTable = (bool) chksql($this->oDB->getOne($sSQL));
+            $bCacheTable = (bool) chksql($oDB->getOne($sSQL));
 
             $sSQL = "SELECT min(rank_search) FROM placex WHERE place_id in ($sPlaceIDs)";
             if (CONST_Debug) var_dump($sSQL);
-            $iMaxRank = (int)chksql($this->oDB->getOne($sSQL));
+            $iMaxRank = (int)chksql($oDB->getOne($sSQL));
 
             // For state / country level searches the normal radius search doesn't work very well
             $sPlaceGeom = false;
@@ -552,7 +867,7 @@ class SearchDescription
                 $sSQL .= " ORDER BY rank_search ASC ";
                 $sSQL .= " LIMIT 1";
                 if (CONST_Debug) var_dump($sSQL);
-                $sPlaceGeom = chksql($this->oDB->getOne($sSQL));
+                $sPlaceGeom = chksql($oDB->getOne($sSQL));
             }
 
             if ($sPlaceGeom) {
@@ -562,7 +877,7 @@ class SearchDescription
                 $sSQL = 'SELECT place_id FROM placex';
                 $sSQL .= " WHERE place_id in ($sPlaceIDs) and rank_search < $iMaxRank";
                 if (CONST_Debug) var_dump($sSQL);
-                $aPlaceIDs = chksql($this->oDB->getCol($sSQL));
+                $aPlaceIDs = chksql($oDB->getCol($sSQL));
                 $sPlaceIDs = join(',', $aPlaceIDs);
             }
 
@@ -573,8 +888,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) {
@@ -599,9 +914,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';
@@ -610,15 +923,15 @@ class SearchDescription
 
                     if (CONST_Debug) var_dump($sSQL);
 
-                    $aClassPlaceIDs = array_merge($aClassPlaceIDs, chksql($this->oDB->getCol($sSQL)));
+                    $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)";
                     }
@@ -632,9 +945,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";
                     }
@@ -642,11 +953,66 @@ class SearchDescription
 
                     if (CONST_Debug) var_dump($sSQL);
 
-                    $aClassPlaceIDs = array_merge($aClassPlaceIDs, chksql($this->oDB->getCol($sSQL)));
+                    $aClassPlaceIDs = array_merge($aClassPlaceIDs, chksql($oDB->getCol($sSQL)));
                 }
             }
         }
 
         return $aClassPlaceIDs;
     }
-};
+
+    private function poiTable()
+    {
+        return 'place_classtype_'.$this->sClass.'_'.$this->sType;
+    }
+
+    private function countryCodeSQL($sVar)
+    {
+        if ($this->sCountryCode) {
+            return $sVar.' = \''.$this->sCountryCode."'";
+        }
+        if ($this->oContext->sqlCountryList) {
+            return $sVar.' in '.$this->oContext->sqlCountryList;
+        }
+
+        return '';
+    }
+
+    /////////// Sort functions
+
+
+    public static function bySearchRank($a, $b)
+    {
+        if ($a->iSearchRank == $b->iSearchRank) {
+            return $a->iOperator + strlen($a->sHouseNumber)
+                     - $b->iOperator - strlen($b->sHouseNumber);
+        }
+
+        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>";
+    }
+}