test/README.md - more instructions how to import test db

[nominatim.git] / lib / Geocode.php

diff --git a/lib/Geocode.php b/lib/Geocode.php
index 48683e64db5cf3f8b3b60d138baba8648e8fd015..0c93e0a96e429945d4a795fe32179fcc573f0544 100644 (file)
--- a/lib/Geocode.php
+++ b/lib/Geocode.php
@@ -1,26 +1,23 @@
 <?php
 <?php

+
+namespace Nominatim;
+

 require_once(CONST_BasePath.'/lib/PlaceLookup.php');
 require_once(CONST_BasePath.'/lib/PlaceLookup.php');

+require_once(CONST_BasePath.'/lib/Phrase.php');

 require_once(CONST_BasePath.'/lib/ReverseGeocode.php');
 require_once(CONST_BasePath.'/lib/ReverseGeocode.php');

+require_once(CONST_BasePath.'/lib/SearchDescription.php');
+require_once(CONST_BasePath.'/lib/SearchContext.php');
+require_once(CONST_BasePath.'/lib/TokenList.php');

 
 class Geocode
 {
     protected $oDB;
 
 
 class Geocode
 {
     protected $oDB;
 

-    protected $aLangPrefOrder = array();
-
-    protected $bIncludeAddressDetails = false;
-    protected $bIncludeExtraTags = false;
-    protected $bIncludeNameDetails = false;
+    protected $oPlaceLookup;

 
 

-    protected $bIncludePolygonAsPoints = false;
-    protected $bIncludePolygonAsText = false;
-    protected $bIncludePolygonAsGeoJSON = false;
-    protected $bIncludePolygonAsKML = false;
-    protected $bIncludePolygonAsSVG = false;
-    protected $fPolygonSimplificationThreshold = 0.0;
+    protected $aLangPrefOrder = array();

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

-    protected $bDeDupe = true;

     protected $bReverseInPlan = false;
 
     protected $iLimit = 20;
     protected $bReverseInPlan = false;
 
     protected $iLimit = 20;


@@ -29,86 +26,79 @@ class Geocode
     protected $bFallback = false;
 
     protected $aCountryCodes = false;
     protected $bFallback = false;
 
     protected $aCountryCodes = false;

-    protected $aNearPoint = false;

 
     protected $bBoundedSearch = false;
     protected $aViewBox = false;
 
     protected $bBoundedSearch = false;
     protected $aViewBox = false;

-    protected $sViewboxCentreSQL = false;
-    protected $sViewboxSmallSQL = false;
-    protected $sViewboxLargeSQL = false;
+    protected $aRoutePoints = false;
+    protected $aRouteWidth = false;

 
     protected $iMaxRank = 20;
     protected $iMinAddressRank = 0;
     protected $iMaxAddressRank = 30;
     protected $aAddressRankList = array();
 
     protected $iMaxRank = 20;
     protected $iMinAddressRank = 0;
     protected $iMaxAddressRank = 30;
     protected $aAddressRankList = array();

-    protected $exactMatchCache = array();

 
     protected $sAllowedTypesSQLList = false;
 
     protected $sQuery = false;
     protected $aStructuredQuery = false;
 
 
     protected $sAllowedTypesSQLList = false;
 
     protected $sQuery = false;
     protected $aStructuredQuery = false;
 

-    function Geocode(&$oDB)
+    protected $oNormalizer = null;
+
+
+    public function __construct(&$oDB)

     {
         $this->oDB =& $oDB;
     {
         $this->oDB =& $oDB;

+        $this->oPlaceLookup = new PlaceLookup($this->oDB);
+        $this->oNormalizer = \Transliterator::createFromRules(CONST_Term_Normalization_Rules);

     }
 
     }
 

-    function setReverseInPlan($bReverse)
+    private function normTerm($sTerm)

     {
     {

-        $this->bReverseInPlan = $bReverse;
-    }
+        if ($this->oNormalizer === null) {
+            return $sTerm;
+        }

 
 

-    function setLanguagePreference($aLangPref)
-    {
-        $this->aLangPrefOrder = $aLangPref;
+        return $this->oNormalizer->transliterate($sTerm);

     }
 
     }
 

-    function getIncludeAddressDetails()
+    public function setReverseInPlan($bReverse)

     {
     {

-        return $this->bIncludeAddressDetails;
+        $this->bReverseInPlan = $bReverse;

     }
 
     }
 

-    function getIncludeExtraTags()
+    public function setLanguagePreference($aLangPref)

     {
     {

-        return $this->bIncludeExtraTags;
+        $this->aLangPrefOrder = $aLangPref;

     }
 
     }
 

-    function getIncludeNameDetails()
+    public function getMoreUrlParams()

     {
     {

-        return $this->bIncludeNameDetails;
-    }
+        if ($this->aStructuredQuery) {
+            $aParams = $this->aStructuredQuery;
+        } else {
+            $aParams = array('q' => $this->sQuery);
+        }

 
 

-    function setIncludePolygonAsPoints($b = true)
-    {
-        $this->bIncludePolygonAsPoints = $b;
-    }
+        $aParams = array_merge($aParams, $this->oPlaceLookup->getMoreUrlParams());

 
 

-    function setIncludePolygonAsText($b = true)
-    {
-        $this->bIncludePolygonAsText = $b;
-    }
+        if ($this->aExcludePlaceIDs) {
+            $aParams['exclude_place_ids'] = implode(',', $this->aExcludePlaceIDs);
+        }

 
 

-    function setIncludePolygonAsGeoJSON($b = true)
-    {
-        $this->bIncludePolygonAsGeoJSON = $b;
-    }
+        if ($this->bBoundedSearch) $aParams['bounded'] = '1';

 
 

-    function setIncludePolygonAsKML($b = true)
-    {
-        $this->bIncludePolygonAsKML = $b;
-    }
+        if ($this->aCountryCodes) {
+            $aParams['countrycodes'] = implode(',', $this->aCountryCodes);
+        }

 
 

-    function setIncludePolygonAsSVG($b = true)
-    {
-        $this->bIncludePolygonAsSVG = $b;
-    }
+        if ($this->aViewBox) {
+            $aParams['viewbox'] = join(',', $this->aViewBox);
+        }

 
 

-    function setPolygonSimplificationThreshold($f)
-    {
-        $this->fPolygonSimplificationThreshold = $f;
+        return $aParams;

     }
 
     }
 

-    function setLimit($iLimit = 10)
+    public function setLimit($iLimit = 10)

     {
         if ($iLimit > 50) $iLimit = 50;
         if ($iLimit < 1) $iLimit = 1;
     {
         if ($iLimit > 50) $iLimit = 50;
         if ($iLimit < 1) $iLimit = 1;


@@ -117,105 +107,84 @@ class Geocode
         $this->iLimit = $iLimit + min($iLimit, 10);
     }
 
         $this->iLimit = $iLimit + min($iLimit, 10);
     }
 

-    function getExcludedPlaceIDs()
-    {
-        return $this->aExcludePlaceIDs;
-    }
-
-    function getViewBoxString()
-    {
-        if (!$this->aViewBox) return null;
-        return $this->aViewBox[0].','.$this->aViewBox[3].','.$this->aViewBox[2].','.$this->aViewBox[1];
-    }
-
-    function setFeatureType($sFeatureType)
+    public function setFeatureType($sFeatureType)

     {
         switch ($sFeatureType) {
     {
         switch ($sFeatureType) {

-        case 'country':
-            $this->setRankRange(4, 4);
-            break;
-        case 'state':
-            $this->setRankRange(8, 8);
-            break;
-        case 'city':
-            $this->setRankRange(14, 16);
-            break;
-        case 'settlement':
-            $this->setRankRange(8, 20);
-            break;
+            case 'country':
+                $this->setRankRange(4, 4);
+                break;
+            case 'state':
+                $this->setRankRange(8, 8);
+                break;
+            case 'city':
+                $this->setRankRange(14, 16);
+                break;
+            case 'settlement':
+                $this->setRankRange(8, 20);
+                break;

         }
     }
 
         }
     }
 

-    function setRankRange($iMin, $iMax)
+    public function setRankRange($iMin, $iMax)

     {
         $this->iMinAddressRank = $iMin;
         $this->iMaxAddressRank = $iMax;
     }
 
     {
         $this->iMinAddressRank = $iMin;
         $this->iMaxAddressRank = $iMax;
     }
 

-    function setRoute($aRoutePoints, $fRouteWidth)
+    public function setViewbox($aViewbox)

     {
     {

-        $this->aViewBox = false;
-
-        $this->sViewboxCentreSQL = "ST_SetSRID('LINESTRING(";
-        $sSep = '';
-        foreach ($this->aRoutePoints as $aPoint) {
-            $fPoint = (float)$aPoint;
-            $this->sViewboxCentreSQL .= $sSep.$fPoint;
-            $sSep = ($sSep == ' ') ? ',' : ' ';
-        }
-        $this->sViewboxCentreSQL .= ")'::geometry,4326)";
+        $aBox = array_map('floatval', $aViewbox);

 
 

-        $this->sViewboxSmallSQL = 'st_buffer('.$this->sViewboxCentreSQL;
-        $this->sViewboxSmallSQL .= ','.($fRouteWidth/69).')';
+        $this->aViewBox[0] = max(-180.0, min($aBox[0], $aBox[2]));
+        $this->aViewBox[1] = max(-90.0, min($aBox[1], $aBox[3]));
+        $this->aViewBox[2] = min(180.0, max($aBox[0], $aBox[2]));
+        $this->aViewBox[3] = min(90.0, max($aBox[1], $aBox[3]));

 
 

-        $this->sViewboxLargeSQL = 'st_buffer('.$this->sViewboxCentreSQL;
-        $this->sViewboxLargeSQL .= ','.($fRouteWidth/30).')';
+        if ($this->aViewBox[2] - $this->aViewBox[0] < 0.000000001
+            || $this->aViewBox[3] - $this->aViewBox[1] < 0.000000001
+        ) {
+            userError("Bad parameter 'viewbox'. Not a box.");
+        }

     }
 
     }
 

-    function setViewbox($aViewbox)
+    private function viewboxImportanceFactor($fX, $fY)

     {
     {

-        $this->aViewBox = array_map('floatval', $aViewbox);
-
-        $fHeight = $this->aViewBox[0] - $this->aViewBox[2];
-        $fWidth = $this->aViewBox[1] - $this->aViewBox[3];
-        $aBigViewBox[0] = $this->aViewBox[0] + $fHeight;
-        $aBigViewBox[2] = $this->aViewBox[2] - $fHeight;
-        $aBigViewBox[1] = $this->aViewBox[1] + $fWidth;
-        $aBigViewBox[3] = $this->aViewBox[3] - $fWidth;
-
-        $this->sViewboxCentreSQL = false;
-        $this->sViewboxSmallSQL = "ST_SetSRID(ST_MakeBox2D(ST_Point(".$this->aViewBox[0].",".$this->aViewBox[1]."),ST_Point(".$this->aViewBox[2].",".$this->aViewBox[3].")),4326)";
-        $this->sViewboxLargeSQL = "ST_SetSRID(ST_MakeBox2D(ST_Point(".$aBigViewBox[0].",".$aBigViewBox[1]."),ST_Point(".$aBigViewBox[2].",".$aBigViewBox[3].")),4326)";
-    }
+        if (!$this->aViewBox) {
+            return 1;
+        }

 
 

-    function setNearPoint($aNearPoint, $fRadiusDeg = 0.1)
-    {
-        $this->aNearPoint = array((float)$aNearPoint[0], (float)$aNearPoint[1], (float)$fRadiusDeg);
+        $fWidth = ($this->aViewBox[2] - $this->aViewBox[0])/2;
+        $fHeight = ($this->aViewBox[3] - $this->aViewBox[1])/2;
+
+        $fXDist = abs($fX - ($this->aViewBox[0] + $this->aViewBox[2])/2);
+        $fYDist = abs($fY - ($this->aViewBox[1] + $this->aViewBox[3])/2);
+
+        if ($fXDist <= $fWidth && $fYDist <= $fHeight) {
+            return 1;
+        }
+
+        if ($fXDist <= $fWidth * 3 && $fYDist <= 3 * $fHeight) {
+            return 0.5;
+        }
+
+        return 0.25;

     }
 
     }
 

-    function setQuery($sQueryString)
+    public function setQuery($sQueryString)

     {
         $this->sQuery = $sQueryString;
         $this->aStructuredQuery = false;
     }
 
     {
         $this->sQuery = $sQueryString;
         $this->aStructuredQuery = false;
     }
 

-    function getQueryString()
+    public function getQueryString()

     {
         return $this->sQuery;
     }
 
 
     {
         return $this->sQuery;
     }
 
 

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

     {
     {

-        $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);


@@ -248,33 +217,38 @@ class Geocode
                     $aCountries[] = strtolower($sCountryCode);
                 }
             }
                     $aCountries[] = strtolower($sCountryCode);
                 }
             }

-            if (isset($aCountryCodes))
+            if (isset($aCountries))

                 $this->aCountryCodes = $aCountries;
         }
 
         $aViewbox = $oParams->getStringList('viewboxlbrt');
         if ($aViewbox) {
                 $this->aCountryCodes = $aCountries;
         }
 
         $aViewbox = $oParams->getStringList('viewboxlbrt');
         if ($aViewbox) {

+            if (count($aViewbox) != 4) {
+                userError("Bad parameter 'viewboxlbrt'. Expected 4 coordinates.");
+            }

             $this->setViewbox($aViewbox);
         } else {
             $aViewbox = $oParams->getStringList('viewbox');
             if ($aViewbox) {
             $this->setViewbox($aViewbox);
         } else {
             $aViewbox = $oParams->getStringList('viewbox');
             if ($aViewbox) {

-                $this->setViewBox(array(
-                                   $aViewbox[0],
-                                   $aViewbox[3],
-                                   $aViewbox[2],
-                                   $aViewbox[1]
-                                  ));
+                if (count($aViewbox) != 4) {
+                    userError("Bad parameter 'viewbox'. Expected 4 coordinates.");
+                }
+                $this->setViewBox($aViewbox);

             } else {
                 $aRoute = $oParams->getStringList('route');
                 $fRouteWidth = $oParams->getFloat('routewidth');
                 if ($aRoute && $fRouteWidth) {
             } else {
                 $aRoute = $oParams->getStringList('route');
                 $fRouteWidth = $oParams->getFloat('routewidth');
                 if ($aRoute && $fRouteWidth) {

-                    $this->setRoute($aRoute, $fRouteWidth);
+                    $this->aRoutePoints = $aRoute;
+                    $this->aRouteWidth = $fRouteWidth;

                 }
             }
         }
                 }
             }
         }

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

     }
 
     }
 

-    function setQueryFromParams($oParams)
+    public function setQueryFromParams($oParams)

     {
         // Search query
         $sQuery = $oParams->getString('q');
     {
         // Search query
         $sQuery = $oParams->getString('q');


@@ -294,7 +268,7 @@ class Geocode
         }
     }
 
         }
     }
 

-    function loadStructuredAddressElement($sValue, $sKey, $iNewMinAddressRank, $iNewMaxAddressRank, $aItemListValues)
+    public function loadStructuredAddressElement($sValue, $sKey, $iNewMinAddressRank, $iNewMaxAddressRank, $aItemListValues)

     {
         $sValue = trim($sValue);
         if (!$sValue) return false;
     {
         $sValue = trim($sValue);
         if (!$sValue) return false;


@@ -307,7 +281,7 @@ class Geocode
         return true;
     }
 
         return true;
     }
 

-    function setStructuredQuery($sAmentiy = false, $sStreet = false, $sCity = false, $sCounty = false, $sState = false, $sCountry = false, $sPostalCode = false)
+    public function setStructuredQuery($sAmenity = false, $sStreet = false, $sCity = false, $sCounty = false, $sState = false, $sCountry = false, $sPostalCode = false)

     {
         $this->sQuery = false;
 
     {
         $this->sQuery = false;
 


@@ -317,9 +291,9 @@ class Geocode
         $this->aAddressRankList = array();
 
         $this->aStructuredQuery = array();
         $this->aAddressRankList = array();
 
         $this->aStructuredQuery = array();

-        $this->sAllowedTypesSQLList = '';
+        $this->sAllowedTypesSQLList = false;

 
 

-        $this->loadStructuredAddressElement($sAmentiy, 'amenity', 26, 30, false);
+        $this->loadStructuredAddressElement($sAmenity, 'amenity', 26, 30, false);

         $this->loadStructuredAddressElement($sStreet, 'street', 26, 30, false);
         $this->loadStructuredAddressElement($sCity, 'city', 14, 24, false);
         $this->loadStructuredAddressElement($sCounty, 'county', 9, 13, false);
         $this->loadStructuredAddressElement($sStreet, 'street', 26, 30, false);
         $this->loadStructuredAddressElement($sCity, 'city', 14, 24, false);
         $this->loadStructuredAddressElement($sCounty, 'county', 9, 13, false);


@@ -327,21 +301,21 @@ class Geocode
         $this->loadStructuredAddressElement($sPostalCode, 'postalcode', 5, 11, array(5, 11));
         $this->loadStructuredAddressElement($sCountry, 'country', 4, 4, false);
 
         $this->loadStructuredAddressElement($sPostalCode, 'postalcode', 5, 11, array(5, 11));
         $this->loadStructuredAddressElement($sCountry, 'country', 4, 4, false);
 

-        if (sizeof($this->aStructuredQuery) > 0) {
+        if (!empty($this->aStructuredQuery)) {

             $this->sQuery = join(', ', $this->aStructuredQuery);
             if ($this->iMaxAddressRank < 30) {
             $this->sQuery = join(', ', $this->aStructuredQuery);
             if ($this->iMaxAddressRank < 30) {

-                $sAllowedTypesSQLList = '(\'place\',\'boundary\')';
+                $this->sAllowedTypesSQLList = '(\'place\',\'boundary\')';

             }
         }
     }
 
             }
         }
     }
 

-    function fallbackStructuredQuery()
+    public function fallbackStructuredQuery()

     {
         if (!$this->aStructuredQuery) return false;
 
         $aParams = $this->aStructuredQuery;
 
     {
         if (!$this->aStructuredQuery) return false;
 
         $aParams = $this->aStructuredQuery;
 

-        if (sizeof($aParams) == 1) return false;
+        if (count($aParams) == 1) return false;

 
         $aOrderToFallback = array('postalcode', 'street', 'city', 'county', 'state');
 
 
         $aOrderToFallback = array('postalcode', 'street', 'city', 'county', 'state');
 


@@ -356,140 +330,10 @@ class Geocode
         return false;
     }
 
         return false;
     }
 

-    function getDetails($aPlaceIDs)
-    {
-        //$aPlaceIDs is an array with key: placeID and value: tiger-housenumber, if found, else -1
-        if (sizeof($aPlaceIDs) == 0) return array();
-
-        $sLanguagePrefArraySQL = "ARRAY[".join(',', array_map("getDBQuoted", $this->aLangPrefOrder))."]";
-
-        // Get the details for display (is this a redundant extra step?)
-        $sPlaceIDs = join(',', array_keys($aPlaceIDs));
-
-        $sImportanceSQL = '';
-        if ($this->sViewboxSmallSQL) $sImportanceSQL .= " case when ST_Contains($this->sViewboxSmallSQL, ST_Collect(centroid)) THEN 1 ELSE 0.75 END * ";
-        if ($this->sViewboxLargeSQL) $sImportanceSQL .= " case when ST_Contains($this->sViewboxLargeSQL, ST_Collect(centroid)) THEN 1 ELSE 0.75 END * ";
-
-        $sSQL = "select osm_type,osm_id,class,type,admin_level,rank_search,rank_address,min(place_id) as place_id, min(parent_place_id) as parent_place_id, calculated_country_code as country_code,";
-        $sSQL .= "get_address_by_language(place_id, -1, $sLanguagePrefArraySQL) as langaddress,";
-        $sSQL .= "get_name_by_language(name, $sLanguagePrefArraySQL) as placename,";
-        $sSQL .= "get_name_by_language(name, ARRAY['ref']) as ref,";
-        if ($this->bIncludeExtraTags) $sSQL .= "hstore_to_json(extratags)::text as extra,";
-        if ($this->bIncludeNameDetails) $sSQL .= "hstore_to_json(name)::text as names,";
-        $sSQL .= "avg(ST_X(centroid)) as lon,avg(ST_Y(centroid)) as lat, ";
-        $sSQL .= $sImportanceSQL."coalesce(importance,0.75-(rank_search::float/40)) as importance, ";
-        $sSQL .= "(select max(p.importance*(p.rank_address+2)) from place_addressline s, placex p where s.place_id = min(CASE WHEN placex.rank_search < 28 THEN placex.place_id ELSE placex.parent_place_id END) and p.place_id = s.address_place_id and s.isaddress and p.importance is not null) as addressimportance, ";
-        $sSQL .= "(extratags->'place') as extra_place ";
-        $sSQL .= "from placex where place_id in ($sPlaceIDs) ";
-        $sSQL .= "and (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 .= ") ";
-        if ($this->sAllowedTypesSQLList) $sSQL .= "and placex.class in $this->sAllowedTypesSQLList ";
-        $sSQL .= "and linked_place_id is null ";
-        $sSQL .= "group by osm_type,osm_id,class,type,admin_level,rank_search,rank_address,calculated_country_code,importance";
-        if (!$this->bDeDupe) $sSQL .= ",place_id";
-        $sSQL .= ",langaddress ";
-        $sSQL .= ",placename ";
-        $sSQL .= ",ref ";
-        if ($this->bIncludeExtraTags) $sSQL .= ",extratags";
-        if ($this->bIncludeNameDetails) $sSQL .= ",name";
-        $sSQL .= ",extratags->'place' ";
-
-        if (30 >= $this->iMinAddressRank && 30 <= $this->iMaxAddressRank) {
-            //only Tiger housenumbers and interpolation lines need to be interpolated, because they are saved as lines 
-            // with start- and endnumber, the common osm housenumbers are usually saved as points
-            $sHousenumbers = "";
-            $i = 0;
-            $length = count($aPlaceIDs);
-            foreach ($aPlaceIDs as $placeID => $housenumber) {
-                $i++;
-                $sHousenumbers .= "(".$placeID.", ".$housenumber.")";
-                if ($i<$length) $sHousenumbers .= ", ";
-            }
-            if (CONST_Use_US_Tiger_Data) {
-                //Tiger search only if a housenumber was searched and if it was found (i.e. aPlaceIDs[placeID] = housenumber != -1) (realized through a join)
-                $sSQL .= " union";
-                $sSQL .= " select 'T' as osm_type, place_id as osm_id, 'place' as class, 'house' as type, null as admin_level, 30 as rank_search, 30 as rank_address, min(place_id) as place_id, min(parent_place_id) as parent_place_id, 'us' as country_code";
-                $sSQL .= ", get_address_by_language(place_id, housenumber_for_place, $sLanguagePrefArraySQL) as langaddress ";
-                $sSQL .= ", null as placename";
-                $sSQL .= ", null as ref";
-                if ($this->bIncludeExtraTags) $sSQL .= ", null as extra";
-                if ($this->bIncludeNameDetails) $sSQL .= ", null as names";
-                $sSQL .= ", avg(st_x(centroid)) as lon, avg(st_y(centroid)) as lat,";
-                $sSQL .= $sImportanceSQL."-1.15 as importance ";
-                $sSQL .= ", (select max(p.importance*(p.rank_address+2)) from place_addressline s, placex p where s.place_id = min(blub.parent_place_id) and p.place_id = s.address_place_id and s.isaddress and p.importance is not null) as addressimportance ";
-                $sSQL .= ", null as extra_place ";
-                $sSQL .= " from (select place_id";
-                //interpolate the Tiger housenumbers here
-                $sSQL .= ", ST_LineInterpolatePoint(linegeo, (housenumber_for_place-startnumber::float)/(endnumber-startnumber)::float) as centroid, parent_place_id, housenumber_for_place";
-                $sSQL .= " from (location_property_tiger ";
-                $sSQL .= " join (values ".$sHousenumbers.") as housenumbers(place_id, housenumber_for_place) using(place_id)) ";
-                $sSQL .= " where housenumber_for_place>=0 and 30 between $this->iMinAddressRank and $this->iMaxAddressRank) as blub"; //postgres wants an alias here
-                $sSQL .= " group by place_id, housenumber_for_place"; //is this group by really needed?, place_id + housenumber (in combination) are unique
-                if (!$this->bDeDupe) $sSQL .= ", place_id ";
-            }
-            // osmline
-            // interpolation line search only if a housenumber was searched and if it was found (i.e. aPlaceIDs[placeID] = housenumber != -1) (realized through a join)
-            $sSQL .= " union ";
-            $sSQL .= "select 'W' as osm_type, place_id as osm_id, 'place' as class, 'house' as type, null as admin_level, 30 as rank_search, 30 as rank_address, min(place_id) as place_id, min(parent_place_id) as parent_place_id, calculated_country_code as country_code, ";
-            $sSQL .= "get_address_by_language(place_id, housenumber_for_place, $sLanguagePrefArraySQL) as langaddress, ";
-            $sSQL .= "null as placename, ";
-            $sSQL .= "null as ref, ";
-            if ($this->bIncludeExtraTags) $sSQL .= "null as extra, ";
-            if ($this->bIncludeNameDetails) $sSQL .= "null as names, ";
-            $sSQL .= " avg(st_x(centroid)) as lon, avg(st_y(centroid)) as lat,";
-            $sSQL .= $sImportanceSQL."-0.1 as importance, ";  // slightly smaller than the importance for normal houses with rank 30, which is 0
-            $sSQL .= " (select max(p.importance*(p.rank_address+2)) from place_addressline s, placex p";
-            $sSQL .= " where s.place_id = min(blub.parent_place_id) and p.place_id = s.address_place_id and s.isaddress and p.importance is not null) as addressimportance,";
-            $sSQL .= " null as extra_place ";
-            $sSQL .= " from (select place_id, calculated_country_code ";
-            //interpolate the housenumbers here
-            $sSQL .= ", CASE WHEN startnumber != endnumber THEN ST_LineInterpolatePoint(linegeo, (housenumber_for_place-startnumber::float)/(endnumber-startnumber)::float) ";
-            $sSQL .= " ELSE ST_LineInterpolatePoint(linegeo, 0.5) END as centroid";
-            $sSQL .= ", parent_place_id, housenumber_for_place ";
-            $sSQL .= " from (location_property_osmline ";
-            $sSQL .= " join (values ".$sHousenumbers.") as housenumbers(place_id, housenumber_for_place) using(place_id)) ";
-            $sSQL .= " where housenumber_for_place>=0 and 30 between $this->iMinAddressRank and $this->iMaxAddressRank) as blub"; //postgres wants an alias here
-            $sSQL .= " group by place_id, housenumber_for_place, calculated_country_code "; //is this group by really needed?, place_id + housenumber (in combination) are unique
-            if (!$this->bDeDupe) $sSQL .= ", place_id ";
-
-            if (CONST_Use_Aux_Location_data) {
-                $sSQL .= " union ";
-                $sSQL .= "select 'L' as osm_type, place_id as osm_id, 'place' as class, 'house' as type, null as admin_level, 0 as rank_search, 0 as rank_address, min(place_id) as place_id, min(parent_place_id) as parent_place_id, 'us' as country_code, ";
-                $sSQL .= "get_address_by_language(place_id, -1, $sLanguagePrefArraySQL) as langaddress, ";
-                $sSQL .= "null as placename, ";
-                $sSQL .= "null as ref, ";
-                if ($this->bIncludeExtraTags) $sSQL .= "null as extra, ";
-                if ($this->bIncludeNameDetails) $sSQL .= "null as names, ";
-                $sSQL .= "avg(ST_X(centroid)) as lon, avg(ST_Y(centroid)) as lat, ";
-                $sSQL .= $sImportanceSQL."-1.10 as importance, ";
-                $sSQL .= "(select max(p.importance*(p.rank_address+2)) from place_addressline s, placex p where s.place_id = min(location_property_aux.parent_place_id) and p.place_id = s.address_place_id and s.isaddress and p.importance is not null) as addressimportance, ";
-                $sSQL .= "null as extra_place ";
-                $sSQL .= "from location_property_aux where place_id in ($sPlaceIDs) ";
-                $sSQL .= "and 30 between $this->iMinAddressRank and $this->iMaxAddressRank ";
-                $sSQL .= "group by place_id";
-                if (!$this->bDeDupe) $sSQL .= ", place_id";
-                $sSQL .= ", get_address_by_language(place_id, -1, $sLanguagePrefArraySQL) ";
-            }
-        }
-
-        $sSQL .= " order by importance desc";
-        if (CONST_Debug) {
-            echo "<hr>"; var_dump($sSQL);
-        }
-        $aSearchResults = chksql(
-            $this->oDB->getAll($sSQL),
-            "Could not get details for place."
-        );
-
-        return $aSearchResults;
-    }
-
-    function getGroupedSearches($aSearches, $aPhraseTypes, $aPhrases, $aValidTokens, $aWordFrequencyScores, $bStructuredPhrases)
+    public function getGroupedSearches($aSearches, $aPhrases, $oValidTokens, $bIsStructured)

     {
         /*
     {
         /*

-             Calculate all searches using aValidTokens i.e.
+             Calculate all searches using oValidTokens i.e.

              'Wodsworth Road, Sheffield' =>
 
              Phrase Wordset
              'Wodsworth Road, Sheffield' =>
 
              Phrase Wordset


@@ -499,15 +343,11 @@ class Geocode
 
              Score how good the search is so they can be ordered
          */
 
              Score how good the search is so they can be ordered
          */

-        foreach ($aPhrases as $iPhrase => $sPhrase) {
+        foreach ($aPhrases as $iPhrase => $oPhrase) {

             $aNewPhraseSearches = array();
             $aNewPhraseSearches = array();

-            if ($bStructuredPhrases) $sPhraseType = $aPhraseTypes[$iPhrase];
-            else $sPhraseType = '';
-
-            foreach ($aPhrases[$iPhrase]['wordsets'] as $iWordSet => $aWordset) {
-                // Too many permutations - too expensive
-                if ($iWordSet > 120) break;
+            $sPhraseType = $bIsStructured ? $oPhrase->getPhraseType() : '';

 
 

+            foreach ($oPhrase->getWordSets() as $aWordset) {

                 $aWordsetSearches = $aSearches;
 
                 // Add all words from this wordset
                 $aWordsetSearches = $aSearches;
 
                 // Add all words from this wordset


@@ -515,165 +355,60 @@ class Geocode
                     //echo "<br><b>$sToken</b>";
                     $aNewWordsetSearches = array();
 
                     //echo "<br><b>$sToken</b>";
                     $aNewWordsetSearches = array();
 

-                    foreach ($aWordsetSearches as $aCurrentSearch) {
+                    foreach ($aWordsetSearches as $oCurrentSearch) {

                         //echo "<i>";
                         //echo "<i>";

-                        //var_dump($aCurrentSearch);
+                        //var_dump($oCurrentSearch);

                         //echo "</i>";
 
                         //echo "</i>";
 

-                        // If the token is valid
-                        if (isset($aValidTokens[' '.$sToken])) {
-                            foreach ($aValidTokens[' '.$sToken] as $aSearchTerm) {
-                                $aSearch = $aCurrentSearch;
-                                $aSearch['iSearchRank']++;
-                                if (($sPhraseType == '' || $sPhraseType == 'country') && !empty($aSearchTerm['country_code']) && $aSearchTerm['country_code'] != '0') {
-                                    if ($aSearch['sCountryCode'] === false) {
-                                        $aSearch['sCountryCode'] = strtolower($aSearchTerm['country_code']);
-                                        // Country is almost always at the end of the string - increase score for finding it anywhere else (optimisation)
-                                        if (($iToken+1 != sizeof($aWordset) || $iPhrase+1 != sizeof($aPhrases))) {
-                                            $aSearch['iSearchRank'] += 5;
-                                        }
-                                        if ($aSearch['iSearchRank'] < $this->iMaxRank) $aNewWordsetSearches[] = $aSearch;
-                                    }
-                                } elseif (isset($aSearchTerm['lat']) && $aSearchTerm['lat'] !== '' && $aSearchTerm['lat'] !== null) {
-                                    if ($aSearch['fLat'] === '') {
-                                        $aSearch['fLat'] = $aSearchTerm['lat'];
-                                        $aSearch['fLon'] = $aSearchTerm['lon'];
-                                        $aSearch['fRadius'] = $aSearchTerm['radius'];
-                                        if ($aSearch['iSearchRank'] < $this->iMaxRank) $aNewWordsetSearches[] = $aSearch;
-                                    }
-                                } elseif ($sPhraseType == 'postalcode') {
-                                    // 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 (isset($aSearchTerm['word_id']) && $aSearchTerm['word_id']) {
-                                        // If we already have a name try putting the postcode first
-                                        if (sizeof($aSearch['aName'])) {
-                                            $aNewSearch = $aSearch;
-                                            $aNewSearch['aAddress'] = array_merge($aNewSearch['aAddress'], $aNewSearch['aName']);
-                                            $aNewSearch['aName'] = array();
-                                            $aNewSearch['aName'][$aSearchTerm['word_id']] = $aSearchTerm['word_id'];
-                                            if ($aSearch['iSearchRank'] < $this->iMaxRank) $aNewWordsetSearches[] = $aNewSearch;
-                                        }
-
-                                        if (sizeof($aSearch['aName'])) {
-                                            if ((!$bStructuredPhrases || $iPhrase > 0) && $sPhraseType != 'country' && (!isset($aValidTokens[$sToken]) || strpos($sToken, ' ') !== false)) {
-                                                $aSearch['aAddress'][$aSearchTerm['word_id']] = $aSearchTerm['word_id'];
-                                            } else {
-                                                $aCurrentSearch['aFullNameAddress'][$aSearchTerm['word_id']] = $aSearchTerm['word_id'];
-                                                $aSearch['iSearchRank'] += 1000; // skip;
-                                            }
-                                        } else {
-                                            $aSearch['aName'][$aSearchTerm['word_id']] = $aSearchTerm['word_id'];
-                                            //$aSearch['iNamePhrase'] = $iPhrase;
-                                        }
-                                        if ($aSearch['iSearchRank'] < $this->iMaxRank) $aNewWordsetSearches[] = $aSearch;
-                                    }
-                                } elseif (($sPhraseType == '' || $sPhraseType == 'street') && $aSearchTerm['class'] == 'place' && $aSearchTerm['type'] == 'house') {
-                                    if ($aSearch['sHouseNumber'] === '') {
-                                        $aSearch['sHouseNumber'] = $sToken;
-                                        // sanity check: if the housenumber is not mainly made
-                                        // up of numbers, add a penalty
-                                        if (preg_match_all("/[^0-9]/", $sToken, $aMatches) > 2) $aSearch['iSearchRank']++;
-                                        // also housenumbers should appear in the first or second phrase
-                                        if ($iPhrase > 1) $aSearch['iSearchRank'] += 1;
-                                        if ($aSearch['iSearchRank'] < $this->iMaxRank) $aNewWordsetSearches[] = $aSearch;
-                                        /*
-                                        // Fall back to not searching for this item (better than nothing)
-                                        $aSearch = $aCurrentSearch;
-                                        $aSearch['iSearchRank'] += 1;
-                                        if ($aSearch['iSearchRank'] < $this->iMaxRank) $aNewWordsetSearches[] = $aSearch;
-                                         */
-                                    }
-                                } elseif ($sPhraseType == '' && $aSearchTerm['class'] !== '' && $aSearchTerm['class'] !== null) {
-                                    if ($aSearch['sClass'] === '') {
-                                        $aSearch['sOperator'] = $aSearchTerm['operator'];
-                                        $aSearch['sClass'] = $aSearchTerm['class'];
-                                        $aSearch['sType'] = $aSearchTerm['type'];
-                                        if (sizeof($aSearch['aName'])) $aSearch['sOperator'] = 'name';
-                                        else $aSearch['sOperator'] = 'near'; // near = in for the moment
-                                        if (strlen($aSearchTerm['operator']) == 0) $aSearch['iSearchRank'] += 1;
-
-                                        if ($aSearch['iSearchRank'] < $this->iMaxRank) $aNewWordsetSearches[] = $aSearch;
-                                    }
-                                } elseif (isset($aSearchTerm['word_id']) && $aSearchTerm['word_id']) {
-                                    if (sizeof($aSearch['aName'])) {
-                                        if ((!$bStructuredPhrases || $iPhrase > 0) && $sPhraseType != 'country' && (!isset($aValidTokens[$sToken]) || strpos($sToken, ' ') !== false)) {
-                                            $aSearch['aAddress'][$aSearchTerm['word_id']] = $aSearchTerm['word_id'];
-                                        } else {
-                                            $aCurrentSearch['aFullNameAddress'][$aSearchTerm['word_id']] = $aSearchTerm['word_id'];
-                                            $aSearch['iSearchRank'] += 1000; // skip;
-                                        }
-                                    } else {
-                                        $aSearch['aName'][$aSearchTerm['word_id']] = $aSearchTerm['word_id'];
-                                        //$aSearch['iNamePhrase'] = $iPhrase;
-                                    }
-                                    if ($aSearch['iSearchRank'] < $this->iMaxRank) $aNewWordsetSearches[] = $aSearch;
+                        // Tokens with full name matches.
+                        foreach ($oValidTokens->get(' '.$sToken) as $oSearchTerm) {
+                            $aNewSearches = $oCurrentSearch->extendWithFullTerm(
+                                $oSearchTerm,
+                                $oValidTokens->contains($sToken)
+                                  && strpos($sToken, ' ') === false,
+                                $sPhraseType,
+                                $iToken == 0 && $iPhrase == 0,
+                                $iPhrase == 0,
+                                $iToken + 1 == count($aWordset)
+                                  && $iPhrase + 1 == count($aPhrases)
+                            );
+
+                            foreach ($aNewSearches as $oSearch) {
+                                if ($oSearch->getRank() < $this->iMaxRank) {
+                                    $aNewWordsetSearches[] = $oSearch;

                                 }
                             }
                         }
                         // Look for partial matches.
                         // Note that there is no point in adding country terms here
                                 }
                             }
                         }
                         // Look for partial matches.
                         // Note that there is no point in adding country terms here

-                        // because country are omitted in the address.
-                        if (isset($aValidTokens[$sToken]) && $sPhraseType != 'country') {
+                        // because country is omitted in the address.
+                        if ($sPhraseType != 'country') {

                             // Allow searching for a word - but at extra cost
                             // Allow searching for a word - but at extra cost

-                            foreach ($aValidTokens[$sToken] as $aSearchTerm) {
-                                if (isset($aSearchTerm['word_id']) && $aSearchTerm['word_id']) {
-                                    if ((!$bStructuredPhrases || $iPhrase > 0) && sizeof($aCurrentSearch['aName']) && strpos($sToken, ' ') === false) {
-                                        $aSearch = $aCurrentSearch;
-                                        $aSearch['iSearchRank'] += 1;
-                                        if ($aWordFrequencyScores[$aSearchTerm['word_id']] < CONST_Max_Word_Frequency) {
-                                            $aSearch['aAddress'][$aSearchTerm['word_id']] = $aSearchTerm['word_id'];
-                                            if ($aSearch['iSearchRank'] < $this->iMaxRank) $aNewWordsetSearches[] = $aSearch;
-                                        } elseif (isset($aValidTokens[' '.$sToken])) { // revert to the token version?
-                                            $aSearch['aAddressNonSearch'][$aSearchTerm['word_id']] = $aSearchTerm['word_id'];
-                                            $aSearch['iSearchRank'] += 1;
-                                            if ($aSearch['iSearchRank'] < $this->iMaxRank) $aNewWordsetSearches[] = $aSearch;
-                                            foreach ($aValidTokens[' '.$sToken] as $aSearchTermToken) {
-                                                if (empty($aSearchTermToken['country_code'])
-                                                    && empty($aSearchTermToken['lat'])
-                                                    && empty($aSearchTermToken['class'])
-                                                ) {
-                                                    $aSearch = $aCurrentSearch;
-                                                    $aSearch['iSearchRank'] += 1;
-                                                    $aSearch['aAddress'][$aSearchTermToken['word_id']] = $aSearchTermToken['word_id'];
-                                                    if ($aSearch['iSearchRank'] < $this->iMaxRank) $aNewWordsetSearches[] = $aSearch;
-                                                }
-                                            }
-                                        } else {
-                                            $aSearch['aAddressNonSearch'][$aSearchTerm['word_id']] = $aSearchTerm['word_id'];
-                                            if (preg_match('#^[0-9]+$#', $sToken)) $aSearch['iSearchRank'] += 2;
-                                            if ($aSearch['iSearchRank'] < $this->iMaxRank) $aNewWordsetSearches[] = $aSearch;
-                                        }
-                                    }
-
-                                    if (!sizeof($aCurrentSearch['aName']) || $aCurrentSearch['iNamePhrase'] == $iPhrase) {
-                                        $aSearch = $aCurrentSearch;
-                                        $aSearch['iSearchRank'] += 1;
-                                        if (!sizeof($aCurrentSearch['aName'])) $aSearch['iSearchRank'] += 1;
-                                        if (preg_match('#^[0-9]+$#', $sToken)) $aSearch['iSearchRank'] += 2;
-                                        if ($aWordFrequencyScores[$aSearchTerm['word_id']] < CONST_Max_Word_Frequency) {
-                                            $aSearch['aName'][$aSearchTerm['word_id']] = $aSearchTerm['word_id'];
-                                        } else {
-                                            $aSearch['aNameNonSearch'][$aSearchTerm['word_id']] = $aSearchTerm['word_id'];
-                                        }
-                                        $aSearch['iNamePhrase'] = $iPhrase;
-                                        if ($aSearch['iSearchRank'] < $this->iMaxRank) $aNewWordsetSearches[] = $aSearch;
+                            foreach ($oValidTokens->get($sToken) as $oSearchTerm) {
+                                $aNewSearches = $oCurrentSearch->extendWithPartialTerm(
+                                    $sToken,
+                                    $oSearchTerm,
+                                    $bIsStructured,
+                                    $iPhrase,
+                                    $oValidTokens->get(' '.$sToken)
+                                );
+
+                                foreach ($aNewSearches as $oSearch) {
+                                    if ($oSearch->getRank() < $this->iMaxRank) {
+                                        $aNewWordsetSearches[] = $oSearch;

                                     }
                                 }
                             }
                                     }
                                 }
                             }

-                        } else {
-                            // Allow skipping a word - but at EXTREAM cost
-                            //$aSearch = $aCurrentSearch;
-                            //$aSearch['iSearchRank']+=100;
-                            //$aNewWordsetSearches[] = $aSearch;

                         }
                     }
                     // Sort and cut
                         }
                     }
                     // Sort and cut

-                    usort($aNewWordsetSearches, 'bySearchRank');
+                    usort($aNewWordsetSearches, array('Nominatim\SearchDescription', 'bySearchRank'));

                     $aWordsetSearches = array_slice($aNewWordsetSearches, 0, 50);
                 }
                     $aWordsetSearches = array_slice($aNewWordsetSearches, 0, 50);
                 }

-                //var_Dump('<hr>',sizeof($aWordsetSearches)); exit;
+                //var_Dump('<hr>',count($aWordsetSearches)); exit;

 
                 $aNewPhraseSearches = array_merge($aNewPhraseSearches, $aNewWordsetSearches);
 
                 $aNewPhraseSearches = array_merge($aNewPhraseSearches, $aNewWordsetSearches);

-                usort($aNewPhraseSearches, 'bySearchRank');
+                usort($aNewPhraseSearches, array('Nominatim\SearchDescription', 'bySearchRank'));

 
                 $aSearchHash = array();
                 foreach ($aNewPhraseSearches as $iSearch => $aSearch) {
 
                 $aSearchHash = array();
                 foreach ($aNewPhraseSearches as $iSearch => $aSearch) {


@@ -688,9 +423,12 @@ class Geocode
             // Re-group the searches by their score, junk anything over 20 as just not worth trying
             $aGroupedSearches = array();
             foreach ($aNewPhraseSearches as $aSearch) {
             // Re-group the searches by their score, junk anything over 20 as just not worth trying
             $aGroupedSearches = array();
             foreach ($aNewPhraseSearches as $aSearch) {

-                if ($aSearch['iSearchRank'] < $this->iMaxRank) {
-                    if (!isset($aGroupedSearches[$aSearch['iSearchRank']])) $aGroupedSearches[$aSearch['iSearchRank']] = array();
-                    $aGroupedSearches[$aSearch['iSearchRank']][] = $aSearch;
+                $iRank = $aSearch->getRank();
+                if ($iRank < $this->iMaxRank) {
+                    if (!isset($aGroupedSearches[$iRank])) {
+                        $aGroupedSearches[$iRank] = array();
+                    }
+                    $aGroupedSearches[$iRank][] = $aSearch;

                 }
             }
             ksort($aGroupedSearches);
                 }
             }
             ksort($aGroupedSearches);


@@ -698,13 +436,27 @@ class Geocode
             $iSearchCount = 0;
             $aSearches = array();
             foreach ($aGroupedSearches as $iScore => $aNewSearches) {
             $iSearchCount = 0;
             $aSearches = array();
             foreach ($aGroupedSearches as $iScore => $aNewSearches) {

-                $iSearchCount += sizeof($aNewSearches);
+                $iSearchCount += count($aNewSearches);

                 $aSearches = array_merge($aSearches, $aNewSearches);
                 if ($iSearchCount > 50) break;
             }
                 $aSearches = array_merge($aSearches, $aNewSearches);
                 if ($iSearchCount > 50) break;
             }

+        }
+
+        // Revisit searches, drop bad searches and give penalty to unlikely combinations.
+        $aGroupedSearches = array();
+        foreach ($aSearches as $oSearch) {
+            if (!$oSearch->isValidSearch()) {
+                continue;
+            }

 
 

-            //if (CONST_Debug) _debugDumpGroupedSearches($aGroupedSearches, $aValidTokens);
+            $iRank = $oSearch->getRank();
+            if (!isset($aGroupedSearches[$iRank])) {
+                $aGroupedSearches[$iRank] = array();
+            }
+            $aGroupedSearches[$iRank][] = $oSearch;

         }
         }

+        ksort($aGroupedSearches);
+

         return $aGroupedSearches;
     }
 
         return $aGroupedSearches;
     }
 


@@ -719,9 +471,9 @@ class Geocode
             osm_id: id of corresponding OSM object
             class: general object class (corresponds to tag key of primary OSM tag)
             type: subclass of object (corresponds to tag value of primary OSM tag)
             osm_id: id of corresponding OSM object
             class: general object class (corresponds to tag key of primary OSM tag)
             type: subclass of object (corresponds to tag value of primary OSM tag)

-            admin_level: see http://wiki.openstreetmap.org/wiki/Admin_level
+            admin_level: see https://wiki.openstreetmap.org/wiki/Admin_level

             rank_search: rank in search hierarchy
             rank_search: rank in search hierarchy

-                        (see also http://wiki.openstreetmap.org/wiki/Nominatim/Development_overview#Country_to_street_level)
+                        (see also https://wiki.openstreetmap.org/wiki/Nominatim/Development_overview#Country_to_street_level)

             rank_address: rank in address hierarchy (determines orer in address)
             place_id: internal key (may differ between different instances)
             country_code: ISO country code
             rank_address: rank in address hierarchy (determines orer in address)
             place_id: internal key (may differ between different instances)
             country_code: ISO country code


@@ -738,118 +490,114 @@ class Geocode
             name: full name (currently the same as langaddress)
             foundorder: secondary ordering for places with same importance
     */
             name: full name (currently the same as langaddress)
             foundorder: secondary ordering for places with same importance
     */

-    function lookup()
+
+
+    public function lookup()

     {
     {

-        if (!$this->sQuery && !$this->aStructuredQuery) return false;
+        Debug::newFunction('Geocode::lookup');
+        if (!$this->sQuery && !$this->aStructuredQuery) return array();

 
 

-        $sLanguagePrefArraySQL = "ARRAY[".join(',', array_map("getDBQuoted", $this->aLangPrefOrder))."]";
-        $sCountryCodesSQL = false;
+        Debug::printDebugArray('Geocode', $this);
+
+        $oCtx = new SearchContext();
+
+        if ($this->aRoutePoints) {
+            $oCtx->setViewboxFromRoute(
+                $this->oDB,
+                $this->aRoutePoints,
+                $this->aRouteWidth,
+                $this->bBoundedSearch
+            );
+        } elseif ($this->aViewBox) {
+            $oCtx->setViewboxFromBox($this->aViewBox, $this->bBoundedSearch);
+        }
+        if ($this->aExcludePlaceIDs) {
+            $oCtx->setExcludeList($this->aExcludePlaceIDs);
+        }

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

-            $sCountryCodesSQL = join(',', array_map('addQuotes', $this->aCountryCodes));
+            $oCtx->setCountryList($this->aCountryCodes);

         }
 
         }
 

+        Debug::newSection('Query Preprocessing');
+
+        $sNormQuery = $this->normTerm($this->sQuery);
+        Debug::printVar('Normalized query', $sNormQuery);
+
+        $sLanguagePrefArraySQL = $this->oDB->getArraySQL(
+            $this->oDB->getDBQuotedList($this->aLangPrefOrder)
+        );
+

         $sQuery = $this->sQuery;
         $sQuery = $this->sQuery;

+        if (!preg_match('//u', $sQuery)) {
+            userError('Query string is not UTF-8 encoded.');
+        }

 
         // Conflicts between US state abreviations and various words for 'the' in different languages
         if (isset($this->aLangPrefOrder['name:en'])) {
 
         // Conflicts between US state abreviations and various words for 'the' in different languages
         if (isset($this->aLangPrefOrder['name:en'])) {

-            $sQuery = preg_replace('/(^|,)\s*il\s*(,|$)/', '\1illinois\2', $sQuery);
-            $sQuery = preg_replace('/(^|,)\s*al\s*(,|$)/', '\1alabama\2', $sQuery);
-            $sQuery = preg_replace('/(^|,)\s*la\s*(,|$)/', '\1louisiana\2', $sQuery);
-        }
-
-        $bBoundingBoxSearch = $this->bBoundedSearch && $this->sViewboxSmallSQL;
-        if ($this->sViewboxCentreSQL) {
-            // For complex viewboxes (routes) precompute the bounding geometry
-            $sGeom = chksql(
-                $this->oDB->getOne("select ".$this->sViewboxSmallSQL),
-                "Could not get small viewbox"
-            );
-            $this->sViewboxSmallSQL = "'".$sGeom."'::geometry";
-
-            $sGeom = chksql(
-                $this->oDB->getOne("select ".$this->sViewboxLargeSQL),
-                "Could not get large viewbox"
-            );
-            $this->sViewboxLargeSQL = "'".$sGeom."'::geometry";
+            $sQuery = preg_replace('/(^|,)\s*il\s*(,|$)/i', '\1illinois\2', $sQuery);
+            $sQuery = preg_replace('/(^|,)\s*al\s*(,|$)/i', '\1alabama\2', $sQuery);
+            $sQuery = preg_replace('/(^|,)\s*la\s*(,|$)/i', '\1louisiana\2', $sQuery);

         }
 
         // Do we have anything that looks like a lat/lon pair?
         }
 
         // Do we have anything that looks like a lat/lon pair?

-        if ($aLooksLike = looksLikeLatLonPair($sQuery)) {
-            $this->setNearPoint(array($aLooksLike['lat'], $aLooksLike['lon']));
-            $sQuery = $aLooksLike['query'];
-        }
+        $sQuery = $oCtx->setNearPointFromQuery($sQuery);

 
 

-        $aSearchResults = array();

         if ($sQuery || $this->aStructuredQuery) {
         if ($sQuery || $this->aStructuredQuery) {

-            // Start with a blank search
-            $aSearches = array(
-                          array(
-                           'iSearchRank' => 0,
-                           'iNamePhrase' => -1,
-                           'sCountryCode' => false,
-                           'aName' => array(),
-                           'aAddress' => array(),
-                           'aFullNameAddress' => array(),
-                           'aNameNonSearch' => array(),
-                           'aAddressNonSearch' => array(),
-                           'sOperator' => '',
-                           'aFeatureName' => array(),
-                           'sClass' => '',
-                           'sType' => '',
-                           'sHouseNumber' => '',
-                           'fLat' => '',
-                           'fLon' => '',
-                           'fRadius' => ''
-                          )
-                         );
-
-            // Do we have a radius search?
-            $sNearPointSQL = false;
-            if ($this->aNearPoint) {
-                $sNearPointSQL = "ST_SetSRID(ST_Point(".(float)$this->aNearPoint[1].",".(float)$this->aNearPoint[0]."),4326)";
-                $aSearches[0]['fLat'] = (float)$this->aNearPoint[0];
-                $aSearches[0]['fLon'] = (float)$this->aNearPoint[1];
-                $aSearches[0]['fRadius'] = (float)$this->aNearPoint[2];
-            }
+            // Start with a single blank search
+            $aSearches = array(new SearchDescription($oCtx));

 
 

-            // Any 'special' terms in the search?
-            $bSpecialTerms = false;
-            preg_match_all('/\\[(.*)=(.*)\\]/', $sQuery, $aSpecialTermsRaw, PREG_SET_ORDER);
-            $aSpecialTerms = array();
-            foreach ($aSpecialTermsRaw as $aSpecialTerm) {
-                $sQuery = str_replace($aSpecialTerm[0], ' ', $sQuery);
-                $aSpecialTerms[strtolower($aSpecialTerm[1])] = $aSpecialTerm[2];
+            if ($sQuery) {
+                $sQuery = $aSearches[0]->extractKeyValuePairs($sQuery);

             }
 
             }
 

-            preg_match_all('/\\[([\\w ]*)\\]/u', $sQuery, $aSpecialTermsRaw, PREG_SET_ORDER);
-            $aSpecialTerms = array();
-            if (isset($this->aStructuredQuery['amenity']) && $this->aStructuredQuery['amenity']) {
-                $aSpecialTermsRaw[] = array('['.$this->aStructuredQuery['amenity'].']', $this->aStructuredQuery['amenity']);
+            $sSpecialTerm = '';
+            if ($sQuery) {
+                preg_match_all(
+                    '/\\[([\\w ]*)\\]/u',
+                    $sQuery,
+                    $aSpecialTermsRaw,
+                    PREG_SET_ORDER
+                );
+                if (!empty($aSpecialTermsRaw)) {
+                    Debug::printVar('Special terms', $aSpecialTermsRaw);
+                }
+
+                foreach ($aSpecialTermsRaw as $aSpecialTerm) {
+                    $sQuery = str_replace($aSpecialTerm[0], ' ', $sQuery);
+                    if (!$sSpecialTerm) {
+                        $sSpecialTerm = $aSpecialTerm[1];
+                    }
+                }
+            }
+            if (!$sSpecialTerm && $this->aStructuredQuery
+                && isset($this->aStructuredQuery['amenity'])) {
+                $sSpecialTerm = $this->aStructuredQuery['amenity'];

                 unset($this->aStructuredQuery['amenity']);
             }
 
                 unset($this->aStructuredQuery['amenity']);
             }
 

-            foreach ($aSpecialTermsRaw as $aSpecialTerm) {
-                $sQuery = str_replace($aSpecialTerm[0], ' ', $sQuery);
-                $sToken = chksql($this->oDB->getOne("select make_standard_name('".$aSpecialTerm[1]."') as string"));
-                $sSQL = 'select * from (select word_id,word_token, word, class, type, country_code, operator';
-                $sSQL .= ' from word where word_token in (\' '.$sToken.'\')) as x where (class is not null and class not in (\'place\')) or country_code is not null';
-                if (CONST_Debug) var_Dump($sSQL);
-                $aSearchWords = chksql($this->oDB->getAll($sSQL));
+            if ($sSpecialTerm && !$aSearches[0]->hasOperator()) {
+                $sSpecialTerm = pg_escape_string($sSpecialTerm);
+                $sToken = $this->oDB->getOne(
+                    'SELECT make_standard_name(:term)',
+                    array(':term' => $sSpecialTerm),
+                    'Cannot decode query. Wrong encoding?'
+                );
+                $sSQL = 'SELECT class, type FROM word ';
+                $sSQL .= '   WHERE word_token in (\' '.$sToken.'\')';
+                $sSQL .= '   AND class is not null AND class not in (\'place\')';
+
+                Debug::printSQL($sSQL);
+                $aSearchWords = $this->oDB->getAll($sSQL);

                 $aNewSearches = array();
                 $aNewSearches = array();

-                foreach ($aSearches as $aSearch) {
+                foreach ($aSearches as $oSearch) {

                     foreach ($aSearchWords as $aSearchTerm) {
                     foreach ($aSearchWords as $aSearchTerm) {

-                        $aNewSearch = $aSearch;
-                        if ($aSearchTerm['country_code']) {
-                            $aNewSearch['sCountryCode'] = strtolower($aSearchTerm['country_code']);
-                            $aNewSearches[] = $aNewSearch;
-                            $bSpecialTerms = true;
-                        }
-                        if ($aSearchTerm['class']) {
-                            $aNewSearch['sClass'] = $aSearchTerm['class'];
-                            $aNewSearch['sType'] = $aSearchTerm['type'];
-                            $aNewSearches[] = $aNewSearch;
-                            $bSpecialTerms = true;
-                        }
+                        $oNewSearch = clone $oSearch;
+                        $oNewSearch->setPoiSearch(
+                            Operator::TYPE,
+                            $aSearchTerm['class'],
+                            $aSearchTerm['type']
+                        );
+                        $aNewSearches[] = $oNewSearch;

                     }
                 }
                 $aSearches = $aNewSearches;
                     }
                 }
                 $aSearches = $aNewSearches;


@@ -858,136 +606,107 @@ class Geocode
             // Split query into phrases
             // Commas are used to reduce the search space by indicating where phrases split
             if ($this->aStructuredQuery) {
             // Split query into phrases
             // Commas are used to reduce the search space by indicating where phrases split
             if ($this->aStructuredQuery) {

-                $aPhrases = $this->aStructuredQuery;
+                $aInPhrases = $this->aStructuredQuery;

                 $bStructuredPhrases = true;
             } else {
                 $bStructuredPhrases = true;
             } else {

-                $aPhrases = explode(',', $sQuery);
+                $aInPhrases = explode(',', $sQuery);

                 $bStructuredPhrases = false;
             }
 
                 $bStructuredPhrases = false;
             }
 

+            Debug::printDebugArray('Search context', $oCtx);
+            Debug::printDebugArray('Base search', empty($aSearches) ? null : $aSearches[0]);
+            Debug::printVar('Final query phrases', $aInPhrases);
+

             // Convert each phrase to standard form
             // Create a list of standard words
             // Get all 'sets' of words
             // Generate a complete list of all
             // Convert each phrase to standard form
             // Create a list of standard words
             // Get all 'sets' of words
             // Generate a complete list of all

+            Debug::newSection('Tokenization');

             $aTokens = array();
             $aTokens = array();

-            foreach ($aPhrases as $iPhrase => $sPhrase) {
-                $aPhrase = chksql(
-                    $this->oDB->getRow("select make_standard_name('".pg_escape_string($sPhrase)."') as string"),
-                    "Cannot nomralize query string (is it an UTF-8 string?)"
+            $aPhrases = array();
+            foreach ($aInPhrases as $iPhrase => $sPhrase) {
+                $sPhrase = $this->oDB->getOne(
+                    'SELECT make_standard_name(:phrase)',
+                    array(':phrase' => $sPhrase),
+                    'Cannot normalize query string (is it a UTF-8 string?)'

                 );
                 );

-                if (trim($aPhrase['string'])) {
-                    $aPhrases[$iPhrase] = $aPhrase;
-                    $aPhrases[$iPhrase]['words'] = explode(' ', $aPhrases[$iPhrase]['string']);
-                    $aPhrases[$iPhrase]['wordsets'] = getWordSets($aPhrases[$iPhrase]['words'], 0);
-                    $aTokens = array_merge($aTokens, getTokensFromSets($aPhrases[$iPhrase]['wordsets']));
-                } else {
-                    unset($aPhrases[$iPhrase]);
+                if (trim($sPhrase)) {
+                    $oPhrase = new Phrase($sPhrase, is_string($iPhrase) ? $iPhrase : '');
+                    $oPhrase->addTokens($aTokens);
+                    $aPhrases[] = $oPhrase;

                 }
             }
 
                 }
             }
 

-            // Reindex phrases - we make assumptions later on that they are numerically keyed in order
-            $aPhraseTypes = array_keys($aPhrases);
-            $aPhrases = array_values($aPhrases);
+            Debug::printVar('Tokens', $aTokens);

 
 

-            if (sizeof($aTokens)) {
-                // 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 where word_token in ('.join(',', array_map("getDBQuoted", $aTokens)).')';
+            $oValidTokens = new TokenList();

 
 

-                if (CONST_Debug) var_Dump($sSQL);
+            if (!empty($aTokens)) {
+                $sSQL = 'SELECT word_id, word_token, word, class, type, country_code, operator, search_name_count';
+                $sSQL .= ' FROM word ';
+                $sSQL .= ' WHERE word_token in ('.join(',', $this->oDB->getDBQuotedList($aTokens)).')';

 
 

-                $aValidTokens = array();
-                if (sizeof($aTokens)) {
-                    $aDatabaseWords = chksql(
-                        $this->oDB->getAll($sSQL),
-                        "Could not get word tokens."
-                    );
-                } else {
-                    $aDatabaseWords = array();
-                }
-                $aPossibleMainWordIDs = array();
-                $aWordFrequencyScores = array();
-                foreach ($aDatabaseWords as $aToken) {
-                    // Very special case - require 2 letter country param to match the country code found
-                    if ($bStructuredPhrases && $aToken['country_code'] && !empty($this->aStructuredQuery['country'])
-                        && strlen($this->aStructuredQuery['country']) == 2 && strtolower($this->aStructuredQuery['country']) != $aToken['country_code']
-                    ) {
-                        continue;
-                    }
+                Debug::printSQL($sSQL);

 
 

-                    if (isset($aValidTokens[$aToken['word_token']])) {
-                        $aValidTokens[$aToken['word_token']][] = $aToken;
-                    } else {
-                        $aValidTokens[$aToken['word_token']] = array($aToken);
-                    }
-                    if (!$aToken['class'] && !$aToken['country_code']) $aPossibleMainWordIDs[$aToken['word_id']] = 1;
-                    $aWordFrequencyScores[$aToken['word_id']] = $aToken['search_name_count'] + 1;
-                }
-                if (CONST_Debug) var_Dump($aPhrases, $aValidTokens);
+                $oValidTokens->addTokensFromDB(
+                    $this->oDB,
+                    $aTokens,
+                    $this->aCountryCodes,
+                    $sNormQuery,
+                    $this->oNormalizer
+                );

 
 

-                // Try and calculate GB postcodes we might be missing
+                // Try more interpretations for Tokens that could not be matched.

                 foreach ($aTokens as $sToken) {
                 foreach ($aTokens as $sToken) {

-                    // Source of gb postcodes is now definitive - always use
-                    if (preg_match('/^([A-Z][A-Z]?[0-9][0-9A-Z]? ?[0-9])([A-Z][A-Z])$/', strtoupper(trim($sToken)), $aData)) {
-                        if (substr($aData[1], -2, 1) != ' ') {
-                            $aData[0] = substr($aData[0], 0, strlen($aData[1])-1).' '.substr($aData[0], strlen($aData[1])-1);
-                            $aData[1] = substr($aData[1], 0, -1).' '.substr($aData[1], -1, 1);
-                        }
-                        $aGBPostcodeLocation = gbPostcodeCalculate($aData[0], $aData[1], $aData[2], $this->oDB);
-                        if ($aGBPostcodeLocation) {
-                            $aValidTokens[$sToken] = $aGBPostcodeLocation;
-                        }
-                    } elseif (!isset($aValidTokens[$sToken]) && preg_match('/^([0-9]{5}) [0-9]{4}$/', $sToken, $aData)) {
-                        // US ZIP+4 codes - if there is no token,
-                        //  merge in the 5-digit ZIP code
-                        if (isset($aValidTokens[$aData[1]])) {
-                            foreach ($aValidTokens[$aData[1]] as $aToken) {
-                                if (!$aToken['class']) {
-                                    if (isset($aValidTokens[$sToken])) {
-                                        $aValidTokens[$sToken][] = $aToken;
-                                    } else {
-                                        $aValidTokens[$sToken] = array($aToken);
-                                    }
-                                }
-                            }
+                    if ($sToken[0] == ' ' && !$oValidTokens->contains($sToken)) {
+                        if (preg_match('/^ ([0-9]{5}) [0-9]{4}$/', $sToken, $aData)) {
+                            // US ZIP+4 codes - merge in the 5-digit ZIP code
+                            $oValidTokens->addToken(
+                                $sToken,
+                                new Token\Postcode(null, $aData[1], 'us')
+                            );
+                        } elseif (preg_match('/^ [0-9]+$/', $sToken)) {
+                            // Unknown single word token with a number.
+                            // Assume it is a house number.
+                            $oValidTokens->addToken(
+                                $sToken,
+                                new Token\HouseNumber(null, trim($sToken))
+                            );

                         }
                     }
                 }
 
                         }
                     }
                 }
 

-                foreach ($aTokens as $sToken) {
-                    // Unknown single word token with a number - assume it is a house number
-                    if (!isset($aValidTokens[' '.$sToken]) && strpos($sToken, ' ') === false && preg_match('/[0-9]/', $sToken)) {
-                        $aValidTokens[' '.$sToken] = array(array('class' => 'place', 'type' => 'house'));
-                    }
-                }
-

                 // Any words that have failed completely?
                 // TODO: suggestions
 
                 // Any words that have failed completely?
                 // TODO: suggestions
 

-                // Start the search process
-                // array with: placeid => -1 | tiger-housenumber
-                $aResultPlaceIDs = array();
+                Debug::printGroupTable('Valid Tokens', $oValidTokens->debugInfo());
+
+                foreach ($aPhrases as $oPhrase) {
+                    $oPhrase->computeWordSets($oValidTokens);
+                }
+                Debug::printDebugTable('Phrases', $aPhrases);
+
+                Debug::newSection('Search candidates');

 
 

-                $aGroupedSearches = $this->getGroupedSearches($aSearches, $aPhraseTypes, $aPhrases, $aValidTokens, $aWordFrequencyScores, $bStructuredPhrases);
+                $aGroupedSearches = $this->getGroupedSearches($aSearches, $aPhrases, $oValidTokens, $bStructuredPhrases);

 
                 if ($this->bReverseInPlan) {
                     // Reverse phrase array and also reverse the order of the wordsets in
                     // the first and final phrase. Don't bother about phrases in the middle
                     // because order in the address doesn't matter.
                     $aPhrases = array_reverse($aPhrases);
 
                 if ($this->bReverseInPlan) {
                     // Reverse phrase array and also reverse the order of the wordsets in
                     // the first and final phrase. Don't bother about phrases in the middle
                     // because order in the address doesn't matter.
                     $aPhrases = array_reverse($aPhrases);

-                    $aPhrases[0]['wordsets'] = getInverseWordSets($aPhrases[0]['words'], 0);
-                    if (sizeof($aPhrases) > 1) {
-                        $aFinalPhrase = end($aPhrases);
-                        $aPhrases[sizeof($aPhrases)-1]['wordsets'] = getInverseWordSets($aFinalPhrase['words'], 0);
+                    $aPhrases[0]->invertWordSets();
+                    if (count($aPhrases) > 1) {
+                        $aPhrases[count($aPhrases)-1]->invertWordSets();

                     }
                     }

-                    $aReverseGroupedSearches = $this->getGroupedSearches($aSearches, null, $aPhrases, $aValidTokens, $aWordFrequencyScores, false);
+                    $aReverseGroupedSearches = $this->getGroupedSearches($aSearches, $aPhrases, $oValidTokens, false);

 
                     foreach ($aGroupedSearches as $aSearches) {
                         foreach ($aSearches as $aSearch) {
 
                     foreach ($aGroupedSearches as $aSearches) {
                         foreach ($aSearches as $aSearch) {

-                            if ($aSearch['iSearchRank'] < $this->iMaxRank) {
-                                if (!isset($aReverseGroupedSearches[$aSearch['iSearchRank']])) $aReverseGroupedSearches[$aSearch['iSearchRank']] = array();
-                                $aReverseGroupedSearches[$aSearch['iSearchRank']][] = $aSearch;
+                            if (!isset($aReverseGroupedSearches[$aSearch->getRank()])) {
+                                $aReverseGroupedSearches[$aSearch->getRank()] = array();

                             }
                             }

+                            $aReverseGroupedSearches[$aSearch->getRank()][] = $aSearch;

                         }
                     }
 
                         }
                     }
 


@@ -998,39 +717,9 @@ class Geocode
                 // Re-group the searches by their score, junk anything over 20 as just not worth trying
                 $aGroupedSearches = array();
                 foreach ($aSearches as $aSearch) {
                 // Re-group the searches by their score, junk anything over 20 as just not worth trying
                 $aGroupedSearches = array();
                 foreach ($aSearches as $aSearch) {

-                    if ($aSearch['iSearchRank'] < $this->iMaxRank) {
-                        if (!isset($aGroupedSearches[$aSearch['iSearchRank']])) $aGroupedSearches[$aSearch['iSearchRank']] = array();
-                        $aGroupedSearches[$aSearch['iSearchRank']][] = $aSearch;
-                    }
-                }
-                ksort($aGroupedSearches);
-            }
-
-            if (CONST_Debug) var_Dump($aGroupedSearches);
-            if (CONST_Search_TryDroppedAddressTerms && sizeof($this->aStructuredQuery) > 0) {
-                $aCopyGroupedSearches = $aGroupedSearches;
-                foreach ($aCopyGroupedSearches as $iGroup => $aSearches) {
-                    foreach ($aSearches as $iSearch => $aSearch) {
-                        $aReductionsList = array($aSearch['aAddress']);
-                        $iSearchRank = $aSearch['iSearchRank'];
-                        while (sizeof($aReductionsList) > 0) {
-                            $iSearchRank += 5;
-                            if ($iSearchRank > iMaxRank) break 3;
-                            $aNewReductionsList = array();
-                            foreach ($aReductionsList as $aReductionsWordList) {
-                                for ($iReductionWord = 0; $iReductionWord < sizeof($aReductionsWordList); $iReductionWord++) {
-                                    $aReductionsWordListResult = array_merge(array_slice($aReductionsWordList, 0, $iReductionWord), array_slice($aReductionsWordList, $iReductionWord+1));
-                                    $aReverseSearch = $aSearch;
-                                    $aSearch['aAddress'] = $aReductionsWordListResult;
-                                    $aSearch['iSearchRank'] = $iSearchRank;
-                                    $aGroupedSearches[$iSearchRank][] = $aReverseSearch;
-                                    if (sizeof($aReductionsWordListResult) > 0) {
-                                        $aNewReductionsList[] = $aReductionsWordListResult;
-                                    }
-                                }
-                            }
-                            $aReductionsList = $aNewReductionsList;
-                        }
+                    if ($aSearch->getRank() < $this->iMaxRank) {
+                        if (!isset($aGroupedSearches[$aSearch->getRank()])) $aGroupedSearches[$aSearch->getRank()] = array();
+                        $aGroupedSearches[$aSearch->getRank()][] = $aSearch;

                     }
                 }
                 ksort($aGroupedSearches);
                     }
                 }
                 ksort($aGroupedSearches);


@@ -1043,442 +732,141 @@ class Geocode
                     $sHash = serialize($aSearch);
                     if (isset($aSearchHash[$sHash])) {
                         unset($aGroupedSearches[$iGroup][$iSearch]);
                     $sHash = serialize($aSearch);
                     if (isset($aSearchHash[$sHash])) {
                         unset($aGroupedSearches[$iGroup][$iSearch]);

-                        if (sizeof($aGroupedSearches[$iGroup]) == 0) unset($aGroupedSearches[$iGroup]);
+                        if (empty($aGroupedSearches[$iGroup])) unset($aGroupedSearches[$iGroup]);

                     } else {
                         $aSearchHash[$sHash] = 1;
                     }
                 }
             }
 
                     } else {
                         $aSearchHash[$sHash] = 1;
                     }
                 }
             }
 

-            if (CONST_Debug) _debugDumpGroupedSearches($aGroupedSearches, $aValidTokens);
+            Debug::printGroupedSearch(
+                $aGroupedSearches,
+                $oValidTokens->debugTokenByWordIdList()
+            );

 
 

+            // Start the search process

             $iGroupLoop = 0;
             $iQueryLoop = 0;
             $iGroupLoop = 0;
             $iQueryLoop = 0;

+            $aNextResults = array();

             foreach ($aGroupedSearches as $iGroupedRank => $aSearches) {
                 $iGroupLoop++;
             foreach ($aGroupedSearches as $iGroupedRank => $aSearches) {
                 $iGroupLoop++;

-                foreach ($aSearches as $aSearch) {
+                $aResults = $aNextResults;
+                foreach ($aSearches as $oSearch) {

                     $iQueryLoop++;
                     $iQueryLoop++;

-                    $searchedHousenumber = -1;
-
-                    if (CONST_Debug) echo "<hr><b>Search Loop, group $iGroupLoop, loop $iQueryLoop</b>";
-                    if (CONST_Debug) _debugDumpGroupedSearches(array($iGroupedRank => array($aSearch)), $aValidTokens);
-
-                    // No location term?
-                    if (!sizeof($aSearch['aName']) && !sizeof($aSearch['aAddress']) && !$aSearch['fLon']) {
-                        if ($aSearch['sCountryCode'] && !$aSearch['sClass'] && !$aSearch['sHouseNumber']) {
-                            // Just looking for a country by code - look it up
-                            if (4 >= $this->iMinAddressRank && 4 <= $this->iMaxAddressRank) {
-                                $sSQL = "select place_id from placex where calculated_country_code='".$aSearch['sCountryCode']."' and rank_search = 4";
-                                if ($sCountryCodesSQL) $sSQL .= " and calculated_country_code in ($sCountryCodesSQL)";
-                                if ($bBoundingBoxSearch)
-                                    $sSQL .= " and _st_intersects($this->sViewboxSmallSQL, geometry)";
-                                $sSQL .= " order by st_area(geometry) desc limit 1";
-                                if (CONST_Debug) var_dump($sSQL);
-                                $aPlaceIDs = chksql($this->oDB->getCol($sSQL));
-                            } else {
-                                $aPlaceIDs = array();
-                            }
-                        } else {
-                            if (!$bBoundingBoxSearch && !$aSearch['fLon']) continue;
-                            if (!$aSearch['sClass']) continue;
-
-                            $sSQL = "select count(*) from pg_tables where tablename = 'place_classtype_".$aSearch['sClass']."_".$aSearch['sType']."'";
-                            if (chksql($this->oDB->getOne($sSQL))) {
-                                $sSQL = "select place_id from place_classtype_".$aSearch['sClass']."_".$aSearch['sType']." ct";
-                                if ($sCountryCodesSQL) $sSQL .= " join placex using (place_id)";
-                                $sSQL .= " where st_contains($this->sViewboxSmallSQL, ct.centroid)";
-                                if ($sCountryCodesSQL) $sSQL .= " and calculated_country_code in ($sCountryCodesSQL)";
-                                if (sizeof($this->aExcludePlaceIDs)) {
-                                    $sSQL .= " and place_id not in (".join(',', $this->aExcludePlaceIDs).")";
-                                }
-                                if ($this->sViewboxCentreSQL) $sSQL .= " order by st_distance($this->sViewboxCentreSQL, ct.centroid) asc";
-                                $sSQL .= " limit $this->iLimit";
-                                if (CONST_Debug) var_dump($sSQL);
-                                $aPlaceIDs = chksql($this->oDB->getCol($sSQL));
-
-                                // If excluded place IDs are given, it is fair to assume that
-                                // there have been results in the small box, so no further
-                                // expansion in that case.
-                                // Also don't expand if bounded results were requested.
-                                if (!sizeof($aPlaceIDs) && !sizeof($this->aExcludePlaceIDs) && !$this->bBoundedSearch) {
-                                    $sSQL = "select place_id from place_classtype_".$aSearch['sClass']."_".$aSearch['sType']." ct";
-                                    if ($sCountryCodesSQL) $sSQL .= " join placex using (place_id)";
-                                    $sSQL .= " where st_contains($this->sViewboxLargeSQL, ct.centroid)";
-                                    if ($sCountryCodesSQL) $sSQL .= " and calculated_country_code in ($sCountryCodesSQL)";
-                                    if ($this->sViewboxCentreSQL) $sSQL .= " order by st_distance($this->sViewboxCentreSQL, ct.centroid) asc";
-                                    $sSQL .= " limit $this->iLimit";
-                                    if (CONST_Debug) var_dump($sSQL);
-                                    $aPlaceIDs = chksql($this->oDB->getCol($sSQL));
-                                }
-                            } else {
-                                $sSQL = "select place_id from placex where class='".$aSearch['sClass']."' and type='".$aSearch['sType']."'";
-                                $sSQL .= " and st_contains($this->sViewboxSmallSQL, geometry) and linked_place_id is null";
-                                if ($sCountryCodesSQL) $sSQL .= " and calculated_country_code in ($sCountryCodesSQL)";
-                                if ($this->sViewboxCentreSQL)   $sSQL .= " order by st_distance($this->sViewboxCentreSQL, centroid) asc";
-                                $sSQL .= " limit $this->iLimit";
-                                if (CONST_Debug) var_dump($sSQL);
-                                $aPlaceIDs = chksql($this->oDB->getCol($sSQL));
-                            }
-                        }
-                    } elseif ($aSearch['fLon'] && !sizeof($aSearch['aName']) && !sizeof($aSearch['aAddress']) && !$aSearch['sClass']) {
-                        // If a coordinate is given, the search must either
-                        // be for a name or a special search. Ignore everythin else.
-                        $aPlaceIDs = array();
-                    } else {
-                        $aPlaceIDs = array();
-
-                        // First we need a position, either aName or fLat or both
-                        $aTerms = array();
-                        $aOrder = array();
-
-                        if ($aSearch['sHouseNumber'] && sizeof($aSearch['aAddress'])) {
-                            $sHouseNumberRegex = '\\\\m'.$aSearch['sHouseNumber'].'\\\\M';
-                            $aOrder[] = "";
-                            $aOrder[0] = " (exists(select place_id from placex where parent_place_id = search_name.place_id";
-                            $aOrder[0] .= " and transliteration(housenumber) ~* E'".$sHouseNumberRegex."' limit 1) ";
-                            // also housenumbers from interpolation lines table are needed
-                            $aOrder[0] .= " or exists(select place_id from location_property_osmline where parent_place_id = search_name.place_id";
-                            $aOrder[0] .= " and ".intval($aSearch['sHouseNumber']).">=startnumber and ".intval($aSearch['sHouseNumber'])."<=endnumber limit 1))";
-                            $aOrder[0] .= " desc";
-                        }
-
-                        // TODO: filter out the pointless search terms (2 letter name tokens and less)
-                        // they might be right - but they are just too darned expensive to run
-                        if (sizeof($aSearch['aName'])) $aTerms[] = "name_vector @> ARRAY[".join($aSearch['aName'], ",")."]";
-                        if (sizeof($aSearch['aNameNonSearch'])) $aTerms[] = "array_cat(name_vector,ARRAY[]::integer[]) @> ARRAY[".join($aSearch['aNameNonSearch'], ",")."]";
-                        if (sizeof($aSearch['aAddress']) && $aSearch['aName'] != $aSearch['aAddress']) {
-                            // For infrequent name terms disable index usage for address
-                            if (CONST_Search_NameOnlySearchFrequencyThreshold
-                                && sizeof($aSearch['aName']) == 1
-                                && $aWordFrequencyScores[$aSearch['aName'][reset($aSearch['aName'])]] < CONST_Search_NameOnlySearchFrequencyThreshold
-                            ) {
-                                $aTerms[] = "array_cat(nameaddress_vector,ARRAY[]::integer[]) @> ARRAY[".join(array_merge($aSearch['aAddress'], $aSearch['aAddressNonSearch']), ",")."]";
-                            } else {
-                                $aTerms[] = "nameaddress_vector @> ARRAY[".join($aSearch['aAddress'], ",")."]";
-                                if (sizeof($aSearch['aAddressNonSearch'])) {
-                                    $aTerms[] = "array_cat(nameaddress_vector,ARRAY[]::integer[]) @> ARRAY[".join($aSearch['aAddressNonSearch'], ",")."]";
-                                }
-                            }
-                        }
-                        if ($aSearch['sCountryCode']) $aTerms[] = "country_code = '".pg_escape_string($aSearch['sCountryCode'])."'";
-                        if ($aSearch['sHouseNumber']) {
-                            $aTerms[] = "address_rank between 16 and 27";
-                        } else {
-                            if ($this->iMinAddressRank > 0) {
-                                $aTerms[] = "address_rank >= ".$this->iMinAddressRank;
-                            }
-                            if ($this->iMaxAddressRank < 30) {
-                                $aTerms[] = "address_rank <= ".$this->iMaxAddressRank;
-                            }
-                        }
-                        if ($aSearch['fLon'] && $aSearch['fLat']) {
-                            $aTerms[] = "ST_DWithin(centroid, ST_SetSRID(ST_Point(".$aSearch['fLon'].",".$aSearch['fLat']."),4326), ".$aSearch['fRadius'].")";
-                            $aOrder[] = "ST_Distance(centroid, ST_SetSRID(ST_Point(".$aSearch['fLon'].",".$aSearch['fLat']."),4326)) ASC";
-                        }
-                        if (sizeof($this->aExcludePlaceIDs)) {
-                            $aTerms[] = "place_id not in (".join(',', $this->aExcludePlaceIDs).")";
-                        }
-                        if ($sCountryCodesSQL) {
-                            $aTerms[] = "country_code in ($sCountryCodesSQL)";
-                        }
-
-                        if ($bBoundingBoxSearch) $aTerms[] = "centroid && $this->sViewboxSmallSQL";
-                        if ($sNearPointSQL) $aOrder[] = "ST_Distance($sNearPointSQL, centroid) asc";
-
-                        if ($aSearch['sHouseNumber']) {
-                            $sImportanceSQL = '- abs(26 - address_rank) + 3';
-                        } else {
-                            $sImportanceSQL = '(case when importance = 0 OR importance IS NULL then 0.75-(search_rank::float/40) else importance end)';
-                        }
-                        if ($this->sViewboxSmallSQL) $sImportanceSQL .= " * case when ST_Contains($this->sViewboxSmallSQL, centroid) THEN 1 ELSE 0.5 END";
-                        if ($this->sViewboxLargeSQL) $sImportanceSQL .= " * case when ST_Contains($this->sViewboxLargeSQL, centroid) THEN 1 ELSE 0.5 END";
-
-                        $aOrder[] = "$sImportanceSQL DESC";
-                        if (sizeof($aSearch['aFullNameAddress'])) {
-                            $sExactMatchSQL = '(select count(*) from (select unnest(ARRAY['.join($aSearch['aFullNameAddress'], ",").']) INTERSECT select unnest(nameaddress_vector))s) as exactmatch';
-                            $aOrder[] = 'exactmatch DESC';
-                        } else {
-                            $sExactMatchSQL = '0::int as exactmatch';
-                        }
-
-                        if (sizeof($aTerms)) {
-                            $sSQL = "select place_id, ";
-                            $sSQL .= $sExactMatchSQL;
-                            $sSQL .= " from search_name";
-                            $sSQL .= " where ".join(' and ', $aTerms);
-                            $sSQL .= " order by ".join(', ', $aOrder);
-                            if ($aSearch['sHouseNumber'] || $aSearch['sClass']) {
-                                $sSQL .= " limit 20";
-                            } elseif (!sizeof($aSearch['aName']) && !sizeof($aSearch['aAddress']) && $aSearch['sClass']) {
-                                $sSQL .= " limit 1";
-                            } else {
-                                $sSQL .= " limit ".$this->iLimit;
-                            }
-
-                            if (CONST_Debug) var_dump($sSQL);
-                            $aViewBoxPlaceIDs = chksql(
-                                $this->oDB->getAll($sSQL),
-                                "Could not get places for search terms."
-                            );
-                            //var_dump($aViewBoxPlaceIDs);
-                            // Did we have an viewbox matches?
-                            $aPlaceIDs = array();
-                            $bViewBoxMatch = false;
-                            foreach ($aViewBoxPlaceIDs as $aViewBoxRow) {
-                                //if ($bViewBoxMatch == 1 && $aViewBoxRow['in_small'] == 'f') break;
-                                //if ($bViewBoxMatch == 2 && $aViewBoxRow['in_large'] == 'f') break;
-                                //if ($aViewBoxRow['in_small'] == 't') $bViewBoxMatch = 1;
-                                //else if ($aViewBoxRow['in_large'] == 't') $bViewBoxMatch = 2;
-                                $aPlaceIDs[] = $aViewBoxRow['place_id'];
-                                $this->exactMatchCache[$aViewBoxRow['place_id']] = $aViewBoxRow['exactmatch'];
-                            }
-                        }
-                        //var_Dump($aPlaceIDs);
-                        //exit;
-
-                        //now search for housenumber, if housenumber provided
-                        if ($aSearch['sHouseNumber'] && sizeof($aPlaceIDs)) {
-                            $searchedHousenumber = intval($aSearch['sHouseNumber']);
-                            $aRoadPlaceIDs = $aPlaceIDs;
-                            $sPlaceIDs = join(',', $aPlaceIDs);
-
-                            // Now they are indexed, look for a house attached to a street we found
-                            $sHouseNumberRegex = '\\\\m'.$aSearch['sHouseNumber'].'\\\\M';
-                            $sSQL = "select place_id from placex where parent_place_id in (".$sPlaceIDs.") and transliteration(housenumber) ~* E'".$sHouseNumberRegex."'";
-                            if (sizeof($this->aExcludePlaceIDs)) {
-                                $sSQL .= " and place_id not in (".join(',', $this->aExcludePlaceIDs).")";
-                            }
-                            $sSQL .= " limit $this->iLimit";
-                            if (CONST_Debug) var_dump($sSQL);
-                            $aPlaceIDs = chksql($this->oDB->getCol($sSQL));
-                            
-                            // if nothing found, search in the interpolation line table
-                            if (!sizeof($aPlaceIDs)) {
-                                // do we need to use transliteration and the regex for housenumbers???
-                                //new query for lines, not housenumbers anymore
-                                if ($searchedHousenumber%2 == 0) {
-                                    //if housenumber is even, look for housenumber in streets with interpolationtype even or all
-                                    $sSQL = "select distinct place_id from location_property_osmline where parent_place_id in (".$sPlaceIDs.") and (interpolationtype='even' or interpolationtype='all') and ".$searchedHousenumber.">=startnumber and ".$searchedHousenumber."<=endnumber";
-                                } else {
-                                    //look for housenumber in streets with interpolationtype odd or all
-                                    $sSQL = "select distinct place_id from location_property_osmline where parent_place_id in (".$sPlaceIDs.") and (interpolationtype='odd' or interpolationtype='all') and ".$searchedHousenumber.">=startnumber and ".$searchedHousenumber."<=endnumber";
-                                }
-
-                                if (sizeof($this->aExcludePlaceIDs)) {
-                                    $sSQL .= " and place_id not in (".join(',', $this->aExcludePlaceIDs).")";
-                                }
-                                //$sSQL .= " limit $this->iLimit";
-                                if (CONST_Debug) var_dump($sSQL);
-                                //get place IDs
-                                $aPlaceIDs = chksql($this->oDB->getCol($sSQL, 0));
-                            }
-                                
-                            // If nothing found try the aux fallback table
-                            if (CONST_Use_Aux_Location_data && !sizeof($aPlaceIDs)) {
-                                $sSQL = "select place_id from location_property_aux where parent_place_id in (".$sPlaceIDs.") and housenumber = '".pg_escape_string($aSearch['sHouseNumber'])."'";
-                                if (sizeof($this->aExcludePlaceIDs)) {
-                                    $sSQL .= " and parent_place_id not in (".join(',', $this->aExcludePlaceIDs).")";
-                                }
-                                //$sSQL .= " limit $this->iLimit";
-                                if (CONST_Debug) var_dump($sSQL);
-                                $aPlaceIDs = chksql($this->oDB->getCol($sSQL));
-                            }
-
-                            //if nothing was found in placex or location_property_aux, then search in Tiger data for this housenumber(location_property_tiger)
-                            if (CONST_Use_US_Tiger_Data && !sizeof($aPlaceIDs)) {
-                                //new query for lines, not housenumbers anymore
-                                if ($searchedHousenumber%2 == 0) {
-                                    //if housenumber is even, look for housenumber in streets with interpolationtype even or all
-                                    $sSQL = "select distinct place_id from location_property_tiger where parent_place_id in (".$sPlaceIDs.") and (interpolationtype='even' or interpolationtype='all') and ".$searchedHousenumber.">=startnumber and ".$searchedHousenumber."<=endnumber";
-                                } else {
-                                    //look for housenumber in streets with interpolationtype odd or all
-                                    $sSQL = "select distinct place_id from location_property_tiger where parent_place_id in (".$sPlaceIDs.") and (interpolationtype='odd' or interpolationtype='all') and ".$searchedHousenumber.">=startnumber and ".$searchedHousenumber."<=endnumber";
-                                }
-
-                                if (sizeof($this->aExcludePlaceIDs)) {
-                                    $sSQL .= " and place_id not in (".join(',', $this->aExcludePlaceIDs).")";
-                                }
-                                //$sSQL .= " limit $this->iLimit";
-                                if (CONST_Debug) var_dump($sSQL);
-                                //get place IDs
-                                $aPlaceIDs = chksql($this->oDB->getCol($sSQL, 0));
-                            }
-
-                            // Fallback to the road (if no housenumber was found)
-                            if (!sizeof($aPlaceIDs) && preg_match('/[0-9]+/', $aSearch['sHouseNumber'])) {
-                                $aPlaceIDs = $aRoadPlaceIDs;
-                                //set to -1, if no housenumbers were found
-                                $searchedHousenumber = -1;
-                            }
-                            //else: housenumber was found, remains saved in searchedHousenumber
-                        }
-

 
 

-                        if ($aSearch['sClass'] && sizeof($aPlaceIDs)) {
-                            $sPlaceIDs = join(',', $aPlaceIDs);
-                            $aClassPlaceIDs = array();
-
-                            if (!$aSearch['sOperator'] || $aSearch['sOperator'] == 'name') {
-                                // If they were searching for a named class (i.e. 'Kings Head pub') then we might have an extra match
-                                $sSQL = "select place_id from placex where place_id in ($sPlaceIDs) and class='".$aSearch['sClass']."' and type='".$aSearch['sType']."'";
-                                $sSQL .= " and linked_place_id is null";
-                                if ($sCountryCodesSQL) $sSQL .= " and calculated_country_code in ($sCountryCodesSQL)";
-                                $sSQL .= " order by rank_search asc limit $this->iLimit";
-                                if (CONST_Debug) var_dump($sSQL);
-                                $aClassPlaceIDs = chksql($this->oDB->getCol($sSQL));
-                            }
-
-                            if (!$aSearch['sOperator'] || $aSearch['sOperator'] == 'near') { // & in
-                                $sSQL = "select count(*) from pg_tables where tablename = 'place_classtype_".$aSearch['sClass']."_".$aSearch['sType']."'";
-                                $bCacheTable = chksql($this->oDB->getOne($sSQL));
-
-                                $sSQL = "select min(rank_search) from placex where place_id in ($sPlaceIDs)";
-
-                                if (CONST_Debug) var_dump($sSQL);
-                                $this->iMaxRank = ((int)chksql($this->oDB->getOne($sSQL)));
-
-                                // For state / country level searches the normal radius search doesn't work very well
-                                $sPlaceGeom = false;
-                                if ($this->iMaxRank < 9 && $bCacheTable) {
-                                    // Try and get a polygon to search in instead
-                                    $sSQL = "select geometry from placex where place_id in ($sPlaceIDs) and rank_search < $this->iMaxRank + 5 and st_geometrytype(geometry) in ('ST_Polygon','ST_MultiPolygon') order by rank_search asc limit 1";
-                                    if (CONST_Debug) var_dump($sSQL);
-                                    $sPlaceGeom = chksql($this->oDB->getOne($sSQL));
-                                }
+                    Debug::newSection("Search Loop, group $iGroupLoop, loop $iQueryLoop");
+                    Debug::printGroupedSearch(
+                        array($iGroupedRank => array($oSearch)),
+                        $oValidTokens->debugTokenByWordIdList()
+                    );

 
 

-                                if ($sPlaceGeom) {
-                                    $sPlaceIDs = false;
-                                } else {
-                                    $this->iMaxRank += 5;
-                                    $sSQL = "select place_id from placex where place_id in ($sPlaceIDs) and rank_search < $this->iMaxRank";
-                                    if (CONST_Debug) var_dump($sSQL);
-                                    $aPlaceIDs = chksql($this->oDB->getCol($sSQL));
-                                    $sPlaceIDs = join(',', $aPlaceIDs);
-                                }
+                    $aNewResults = $oSearch->query(
+                        $this->oDB,
+                        $this->iMinAddressRank,
+                        $this->iMaxAddressRank,
+                        $this->iLimit
+                    );

 
 

-                                if ($sPlaceIDs || $sPlaceGeom) {
-                                    $fRange = 0.01;
-                                    if ($bCacheTable) {
-                                        // More efficient - can make the range bigger
-                                        $fRange = 0.05;
-
-                                        $sOrderBySQL = '';
-                                        if ($sNearPointSQL) $sOrderBySQL = "ST_Distance($sNearPointSQL, l.centroid)";
-                                        elseif ($sPlaceIDs) $sOrderBySQL = "ST_Distance(l.centroid, f.geometry)";
-                                        elseif ($sPlaceGeom) $sOrderBysSQL = "ST_Distance(st_centroid('".$sPlaceGeom."'), l.centroid)";
-
-                                        $sSQL = "select distinct l.place_id".($sOrderBySQL?','.$sOrderBySQL:'')." from place_classtype_".$aSearch['sClass']."_".$aSearch['sType']." as l";
-                                        if ($sCountryCodesSQL) $sSQL .= " join placex as lp using (place_id)";
-                                        if ($sPlaceIDs) {
-                                            $sSQL .= ",placex as f where ";
-                                            $sSQL .= "f.place_id in ($sPlaceIDs) and ST_DWithin(l.centroid, f.centroid, $fRange) ";
-                                        }
-                                        if ($sPlaceGeom) {
-                                            $sSQL .= " where ";
-                                            $sSQL .= "ST_Contains('".$sPlaceGeom."', l.centroid) ";
-                                        }
-                                        if (sizeof($this->aExcludePlaceIDs)) {
-                                            $sSQL .= " and l.place_id not in (".join(',', $this->aExcludePlaceIDs).")";
-                                        }
-                                        if ($sCountryCodesSQL) $sSQL .= " and lp.calculated_country_code in ($sCountryCodesSQL)";
-                                        if ($sOrderBySQL) $sSQL .= "order by ".$sOrderBySQL." asc";
-                                        if ($this->iOffset) $sSQL .= " offset $this->iOffset";
-                                        $sSQL .= " limit $this->iLimit";
-                                        if (CONST_Debug) var_dump($sSQL);
-                                        $aClassPlaceIDs = array_merge($aClassPlaceIDs, chksql($this->oDB->getCol($sSQL)));
-                                    } else {
-                                        if (isset($aSearch['fRadius']) && $aSearch['fRadius']) $fRange = $aSearch['fRadius'];
-
-                                        $sOrderBySQL = '';
-                                        if ($sNearPointSQL) $sOrderBySQL = "ST_Distance($sNearPointSQL, l.geometry)";
-                                        else $sOrderBySQL = "ST_Distance(l.geometry, f.geometry)";
-
-                                        $sSQL = "select distinct l.place_id".($sOrderBysSQL?','.$sOrderBysSQL:'')." from placex as l,placex as f where ";
-                                        $sSQL .= "f.place_id in ( $sPlaceIDs) and ST_DWithin(l.geometry, f.centroid, $fRange) ";
-                                        $sSQL .= "and l.class='".$aSearch['sClass']."' and l.type='".$aSearch['sType']."' ";
-                                        if (sizeof($this->aExcludePlaceIDs)) {
-                                            $sSQL .= " and l.place_id not in (".join(',', $this->aExcludePlaceIDs).")";
-                                        }
-                                        if ($sCountryCodesSQL) $sSQL .= " and l.calculated_country_code in ($sCountryCodesSQL)";
-                                        if ($sOrderBy) $sSQL .= "order by ".$OrderBysSQL." asc";
-                                        if ($this->iOffset) $sSQL .= " offset $this->iOffset";
-                                        $sSQL .= " limit $this->iLimit";
-                                        if (CONST_Debug) var_dump($sSQL);
-                                        $aClassPlaceIDs = array_merge($aClassPlaceIDs, chksql($this->oDB->getCol($sSQL)));
-                                    }
-                                }
-                            }
-                            $aPlaceIDs = $aClassPlaceIDs;
+                    // The same result may appear in different rounds, only
+                    // use the one with minimal rank.
+                    foreach ($aNewResults as $iPlace => $oRes) {
+                        if (!isset($aResults[$iPlace])
+                            || $aResults[$iPlace]->iResultRank > $oRes->iResultRank) {
+                            $aResults[$iPlace] = $oRes;

                         }
                     }
 
                         }
                     }
 

-                    if (CONST_Debug) {
-                        echo "<br><b>Place IDs:</b> "; var_Dump($aPlaceIDs);
-                    }
+                    if ($iQueryLoop > 20) break;
+                }

 
 

-                    foreach ($aPlaceIDs as $iPlaceID) {
-                        // array for placeID => -1 | Tiger housenumber
-                        $aResultPlaceIDs[$iPlaceID] = $searchedHousenumber;
+                if (!empty($aResults)) {
+                    $aSplitResults = Result::splitResults($aResults);
+                    Debug::printVar('Split results', $aSplitResults);
+                    if ($iGroupLoop <= 4 && empty($aSplitResults['tail'])
+                        && reset($aSplitResults['head'])->iResultRank > 0) {
+                        // Haven't found an exact match for the query yet.
+                        // Therefore add result from the next group level.
+                        $aNextResults = $aSplitResults['head'];
+                        foreach ($aNextResults as $oRes) {
+                            $oRes->iResultRank--;
+                        }
+                        $aResults = array();
+                    } else {
+                        $aResults = $aSplitResults['head'];

                     }
                     }

-                    if ($iQueryLoop > 20) break;

                 }
 
                 }
 

-                if (isset($aResultPlaceIDs) && sizeof($aResultPlaceIDs) && ($this->iMinAddressRank != 0 || $this->iMaxAddressRank != 30)) {
+                if (!empty($aResults) && ($this->iMinAddressRank != 0 || $this->iMaxAddressRank != 30)) {

                     // Need to verify passes rank limits before dropping out of the loop (yuk!)
                     // reduces the number of place ids, like a filter
                     // rank_address is 30 for interpolated housenumbers
                     // Need to verify passes rank limits before dropping out of the loop (yuk!)
                     // reduces the number of place ids, like a filter
                     // rank_address is 30 for interpolated housenumbers

-                    $sSQL = "select place_id from placex where place_id in (".join(',', array_keys($aResultPlaceIDs)).") ";
-                    $sSQL .= "and (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).")";
-                    if (CONST_Use_US_Tiger_Data) {
-                        $sSQL .= ") UNION select place_id from location_property_tiger where place_id in (".join(',', array_keys($aResultPlaceIDs)).") ";
-                        $sSQL .= "and (30 between $this->iMinAddressRank and $this->iMaxAddressRank ";
-                        if ($this->aAddressRankList) $sSQL .= " OR 30 in (".join(',', $this->aAddressRankList).")";
+                    $aFilterSql = array();
+                    $sPlaceIds = Result::joinIdsByTable($aResults, Result::TABLE_PLACEX);
+                    if ($sPlaceIds) {
+                        $sSQL = 'SELECT place_id FROM placex ';
+                        $sSQL .= 'WHERE place_id in ('.$sPlaceIds.') ';
+                        $sSQL .= '  AND (';
+                        $sSQL .= "         placex.rank_address between $this->iMinAddressRank and $this->iMaxAddressRank ";
+                        $sSQL .= "         OR placex.rank_search between $this->iMinAddressRank and $this->iMaxAddressRank ";
+                        if ($this->aAddressRankList) {
+                            $sSQL .= '     OR placex.rank_address in ('.join(',', $this->aAddressRankList).')';
+                        }
+                        $sSQL .= ')';
+                        $aFilterSql[] = $sSQL;
+                    }
+                    $sPlaceIds = Result::joinIdsByTable($aResults, Result::TABLE_POSTCODE);
+                    if ($sPlaceIds) {
+                        $sSQL = ' SELECT place_id FROM location_postcode lp ';
+                        $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 .= ') ';
+                        $aFilterSql[] = $sSQL;
+                    }
+
+                    $aFilteredIDs = array();
+                    if ($aFilterSql) {
+                        $sSQL = join(' UNION ', $aFilterSql);
+                        Debug::printSQL($sSQL);
+                        $aFilteredIDs = $this->oDB->getCol($sSQL);

                     }
                     }

-                    $sSQL .= ") UNION select place_id from location_property_osmline where place_id in (".join(',', array_keys($aResultPlaceIDs)).")";
-                    $sSQL .= " and (30 between $this->iMinAddressRank and $this->iMaxAddressRank)";
-                    if (CONST_Debug) var_dump($sSQL);
-                    $aFilteredPlaceIDs = chksql($this->oDB->getCol($sSQL));
+

                     $tempIDs = array();
                     $tempIDs = array();

-                    foreach ($aFilteredPlaceIDs as $placeID) {
-                        $tempIDs[$placeID] = $aResultPlaceIDs[$placeID];  //assign housenumber to placeID
+                    foreach ($aResults as $oResult) {
+                        if (($this->iMaxAddressRank == 30 &&
+                             ($oResult->iTable == Result::TABLE_OSMLINE
+                              || $oResult->iTable == Result::TABLE_AUX
+                              || $oResult->iTable == Result::TABLE_TIGER))
+                            || in_array($oResult->iId, $aFilteredIDs)
+                        ) {
+                            $tempIDs[$oResult->iId] = $oResult;
+                        }

                     }
                     }

-                    $aResultPlaceIDs = $tempIDs;
+                    $aResults = $tempIDs;

                 }
 
                 }
 

-                //exit;
-                if (isset($aResultPlaceIDs) && sizeof($aResultPlaceIDs)) break;
+                if (!empty($aResults)) break;

                 if ($iGroupLoop > 4) break;
                 if ($iQueryLoop > 30) break;
             }
                 if ($iGroupLoop > 4) break;
                 if ($iQueryLoop > 30) break;
             }

-
-            // Did we find anything?
-            if (isset($aResultPlaceIDs) && sizeof($aResultPlaceIDs)) {
-                $aSearchResults = $this->getDetails($aResultPlaceIDs);
-            }

         } else {
             // Just interpret as a reverse geocode
             $oReverse = new ReverseGeocode($this->oDB);
             $oReverse->setZoom(18);
 
         } else {
             // Just interpret as a reverse geocode
             $oReverse = new ReverseGeocode($this->oDB);
             $oReverse->setZoom(18);
 

-            $aLookup = $oReverse->lookup(
-                (float)$this->aNearPoint[0],
-                (float)$this->aNearPoint[1],
-                false
-            );
+            $oLookup = $oReverse->lookupPoint($oCtx->sqlNear, false);

 
 

-            if (CONST_Debug) var_dump("Reverse search", $aLookup);
+            Debug::printVar('Reverse search', $oLookup);

 
 

-            if ($aLookup['place_id']) {
-                $aSearchResults = $this->getDetails(array($aLookup['place_id'] => -1));
-            } else {
-                $aSearchResults = array();
+            if ($oLookup) {
+                $aResults = array($oLookup->iId => $oLookup);

             }
         }
 
         // No results? Done
             }
         }
 
         // No results? Done

-        if (!sizeof($aSearchResults)) {
+        if (empty($aResults)) {

             if ($this->bFallback) {
                 if ($this->fallbackStructuredQuery()) {
                     return $this->lookup();
             if ($this->bFallback) {
                 if ($this->fallbackStructuredQuery()) {
                     return $this->lookup();


@@ -1488,115 +876,82 @@ class Geocode
             return array();
         }
 
             return array();
         }
 

-        $aClassType = getClassTypesWithImportance();
-        $aRecheckWords = preg_split('/\b[\s,\\-]*/u', $sQuery);
-        foreach ($aRecheckWords as $i => $sWord) {
-            if (!preg_match('/\pL/', $sWord)) unset($aRecheckWords[$i]);
+        if ($this->aAddressRankList) {
+            $this->oPlaceLookup->setAddressRankList($this->aAddressRankList);

         }
         }

+        $this->oPlaceLookup->setAllowedTypesSQLList($this->sAllowedTypesSQLList);
+        $this->oPlaceLookup->setLanguagePreference($this->aLangPrefOrder);
+        if ($oCtx->hasNearPoint()) {
+            $this->oPlaceLookup->setAnchorSql($oCtx->sqlNear);
+        }
+
+        $aSearchResults = $this->oPlaceLookup->lookup($aResults);

 
 

-        if (CONST_Debug) {
-            echo '<i>Recheck words:<\i>'; var_dump($aRecheckWords);
+        $aRecheckWords = preg_split('/\b[\s,\\-]*/u', $sQuery);
+        foreach ($aRecheckWords as $i => $sWord) {
+            if (!preg_match('/[\pL\pN]/', $sWord)) unset($aRecheckWords[$i]);

         }
 
         }
 

-        $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);
+        Debug::printVar('Recheck words', $aRecheckWords);

 
 

-        foreach ($aSearchResults as $iResNum => $aResult) {
-            // Default
-            $fDiameter = getResultDiameter($aResult);
+        foreach ($aSearchResults as $iIdx => $aResult) {
+            $fRadius = ClassTypes\getDefRadius($aResult);

 
 

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

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

-            
-            if ($aResult['extra_place'] == 'city') {
-                $aResult['class'] = 'place';
-                $aResult['type'] = 'city';
-                $aResult['rank_search'] = 16;
-            }

 
             // Is there an icon set for this type of result?
 
             // Is there an icon set for this type of result?

-            if (isset($aClassType[$aResult['class'].':'.$aResult['type']]['icon'])
-                && $aClassType[$aResult['class'].':'.$aResult['type']]['icon']
-            ) {
-                $aResult['icon'] = CONST_Website_BaseURL.'images/mapicons/'.$aClassType[$aResult['class'].':'.$aResult['type']]['icon'].'.p.20.png';
+            $sIcon = ClassTypes\getIconFile($aResult);
+            if (isset($sIcon)) {
+                $aResult['icon'] = $sIcon;

             }
 
             }
 

-            if (isset($aClassType[$aResult['class'].':'.$aResult['type'].':'.$aResult['admin_level']]['label'])
-                && $aClassType[$aResult['class'].':'.$aResult['type'].':'.$aResult['admin_level']]['label']
-            ) {
-                $aResult['label'] = $aClassType[$aResult['class'].':'.$aResult['type'].':'.$aResult['admin_level']]['label'];
-            } elseif (isset($aClassType[$aResult['class'].':'.$aResult['type']]['label'])
-                && $aClassType[$aResult['class'].':'.$aResult['type']]['label']
-            ) {
-                $aResult['label'] = $aClassType[$aResult['class'].':'.$aResult['type']]['label'];
-            }
-            // if tag '&addressdetails=1' is set in query
-            if ($this->bIncludeAddressDetails) {
-                // getAddressDetails() is defined in lib.php and uses the SQL function get_addressdata in functions.sql
-                $aResult['address'] = getAddressDetails($this->oDB, $sLanguagePrefArraySQL, $aResult['place_id'], $aResult['country_code'], $aResultPlaceIDs[$aResult['place_id']]);
-                if ($aResult['extra_place'] == 'city' && !isset($aResult['address']['city'])) {
-                    $aResult['address'] = array_merge(array('city' => array_shift(array_values($aResult['address']))), $aResult['address']);
-                }
+            $sLabel = ClassTypes\getLabel($aResult);
+            if (isset($sLabel)) {
+                $aResult['label'] = $sLabel;

             }
             }

+            $aResult['name'] = $aResult['langaddress'];

 
 

-            if ($this->bIncludeExtraTags) {
-                if ($aResult['extra']) {
-                    $aResult['sExtraTags'] = json_decode($aResult['extra']);
-                } else {
-                    $aResult['sExtraTags'] = (object) array();
+            if ($oCtx->hasNearPoint()) {
+                $aResult['importance'] = 0.001;
+                $aResult['foundorder'] = $aResult['addressimportance'];
+            } else {
+                $aResult['importance'] = max(0.001, $aResult['importance']);
+                $aResult['importance'] *= $this->viewboxImportanceFactor(
+                    $aResult['lon'],
+                    $aResult['lat']
+                );
+                // Adjust importance for the number of exact string matches in the result
+                $iCountWords = 0;
+                $sAddress = $aResult['langaddress'];
+                foreach ($aRecheckWords as $i => $sWord) {
+                    if (stripos($sAddress, $sWord)!==false) {
+                        $iCountWords++;
+                        if (preg_match('/(^|,)\s*'.preg_quote($sWord, '/').'\s*(,|$)/', $sAddress)) $iCountWords += 0.1;
+                    }

                 }
                 }

-            }

 
 

-            if ($this->bIncludeNameDetails) {
-                if ($aResult['names']) {
-                    $aResult['sNameDetails'] = json_decode($aResult['names']);
+                $aResult['importance'] = $aResult['importance'] + ($iCountWords*0.1); // 0.1 is a completely arbitrary number but something in the range 0.1 to 0.5 would seem right
+
+                // secondary ordering (for results with same importance (the smaller the better):
+                // - approximate importance of address parts
+                $aResult['foundorder'] = -$aResult['addressimportance']/10;
+                // - number of exact matches from the query
+                $aResult['foundorder'] -= $aResults[$aResult['place_id']]->iExactMatches;
+                // - importance of the class/type
+                $iClassImportance = ClassTypes\getImportance($aResult);
+                if (isset($iClassImportance)) {
+                    $aResult['foundorder'] += 0.0001 * $iClassImportance;

                 } else {
                 } else {

-                    $aResult['sNameDetails'] = (object) array();
+                    $aResult['foundorder'] += 0.01;

                 }
             }
                 }
             }

-
-            // Adjust importance for the number of exact string matches in the result
-            $aResult['importance'] = max(0.001, $aResult['importance']);
-            $iCountWords = 0;
-            $sAddress = $aResult['langaddress'];
-            foreach ($aRecheckWords as $i => $sWord) {
-                if (stripos($sAddress, $sWord)!==false) {
-                    $iCountWords++;
-                    if (preg_match("/(^|,)\s*".preg_quote($sWord, '/')."\s*(,|$)/", $sAddress)) $iCountWords += 0.1;
-                }
-            }
-
-            $aResult['importance'] = $aResult['importance'] + ($iCountWords*0.1); // 0.1 is a completely arbitrary number but something in the range 0.1 to 0.5 would seem right
-
-            $aResult['name'] = $aResult['langaddress'];
-            // secondary ordering (for results with same importance (the smaller the better):
-            //   - approximate importance of address parts
-            $aResult['foundorder'] = -$aResult['addressimportance']/10;
-            //   - number of exact matches from the query
-            if (isset($this->exactMatchCache[$aResult['place_id']])) {
-                $aResult['foundorder'] -= $this->exactMatchCache[$aResult['place_id']];
-            } elseif (isset($this->exactMatchCache[$aResult['parent_place_id']])) {
-                $aResult['foundorder'] -= $this->exactMatchCache[$aResult['parent_place_id']];
-            }
-            //  - importance of the class/type
-            if (isset($aClassType[$aResult['class'].':'.$aResult['type']]['importance'])
-                && $aClassType[$aResult['class'].':'.$aResult['type']]['importance']
-            ) {
-                $aResult['foundorder'] += 0.0001 * $aClassType[$aResult['class'].':'.$aResult['type']]['importance'];
-            } else {
-                $aResult['foundorder'] += 0.01;
-            }
-            if (CONST_Debug) var_dump($aResult);
-            $aSearchResults[$iResNum] = $aResult;
+            $aSearchResults[$iIdx] = $aResult;

         }
         uasort($aSearchResults, 'byImportance');
         }
         uasort($aSearchResults, 'byImportance');

+        Debug::printVar('Pre-filter results', $aSearchResults);

 
         $aOSMIDDone = array();
         $aClassTypeNameDone = array();
 
         $aOSMIDDone = array();
         $aClassTypeNameDone = array();


@@ -1604,7 +959,7 @@ class Geocode
         $aSearchResults = array();
 
         $bFirst = true;
         $aSearchResults = array();
 
         $bFirst = true;

-        foreach ($aToFilter as $iResNum => $aResult) {
+        foreach ($aToFilter as $aResult) {

             $this->aExcludePlaceIDs[$aResult['place_id']] = $aResult['place_id'];
             if ($bFirst) {
                 $fLat = $aResult['lat'];
             $this->aExcludePlaceIDs[$aResult['place_id']] = $aResult['place_id'];
             if ($bFirst) {
                 $fLat = $aResult['lat'];


@@ -1612,7 +967,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;


@@ -1621,13 +976,32 @@ class Geocode
             }
 
             // Absolute limit on number of results
             }
 
             // Absolute limit on number of results

-            if (sizeof($aSearchResults) >= $this->iFinalLimit) break;
+            if (count($aSearchResults) >= $this->iFinalLimit) break;

         }
 
         }
 

+        Debug::printVar('Post-filter results', $aSearchResults);

         return $aSearchResults;
         return $aSearchResults;

-

     } // end lookup()
 
     } // end lookup()
 

-
+    public function debugInfo()
+    {
+        return array(
+                'Query' => $this->sQuery,
+                'Structured query' => $this->aStructuredQuery,
+                'Name keys' => Debug::fmtArrayVals($this->aLangPrefOrder),
+                'Excluded place IDs' => Debug::fmtArrayVals($this->aExcludePlaceIDs),
+                'Try reversed query'=> $this->bReverseInPlan,
+                'Limit (for searches)' => $this->iLimit,
+                'Limit (for results)'=> $this->iFinalLimit,
+                'Country codes' => Debug::fmtArrayVals($this->aCountryCodes),
+                'Bounded search' => $this->bBoundedSearch,
+                'Viewbox' => Debug::fmtArrayVals($this->aViewBox),
+                'Route points' => Debug::fmtArrayVals($this->aRoutePoints),
+                'Route width' => $this->aRouteWidth,
+                'Max rank' => $this->iMaxRank,
+                'Min address rank' => $this->iMinAddressRank,
+                'Max address rank' => $this->iMaxAddressRank,
+                'Address rank list' => Debug::fmtArrayVals($this->aAddressRankList)
+               );
+    }

 } // end class
 } // end class

-