nominatim fallback mode for structured queries

[nominatim.git] / lib / Geocode.php

diff --git a/lib/Geocode.php b/lib/Geocode.php
index cadad11122d2c831c1fad9ca0fc4651c59ce2399..d56122408172a0027c5df0f22194c123ca53b74f 100644 (file)
--- a/lib/Geocode.php
+++ b/lib/Geocode.php
@@ -20,6 +20,7 @@
                protected $iLimit = 20;
                protected $iFinalLimit = 10;
                protected $iOffset = 0;
+               protected $bFallback = false;
 
                protected $aCountryCodes = false;
                protected $aNearPoint = false;
@@ -117,6 +118,11 @@
                        $this->iOffset = $iOffset;
                }
 
+               function setFallback($bFallback = true)
+               {
+                       $this->bFallback = (bool)$bFallback;
+               }
+
                function setExcludedPlaceIDs($a)
                {
                        // TODO: force to int
@@ -195,17 +201,17 @@
                        return $this->sQuery;
                }
 
-               function loadStructuredAddressElement(&$aStructuredQuery, &$iMinAddressRank, &$iMaxAddressRank, &$aAddressRankList, $sValue, $sKey, $iNewMinAddressRank, $iNewMaxAddressRank, $aItemListValues)
+               function loadStructuredAddressElement($sValue, $sKey, $iNewMinAddressRank, $iNewMaxAddressRank, $aItemListValues)
                {
                        $sValue = trim($sValue);
                        if (!$sValue) return false;
-                       $aStructuredQuery[$sKey] = $sValue;
-                       if ($iMinAddressRank == 0 && $iMaxAddressRank == 30)
+                       $this->aStructuredQuery[$sKey] = $sValue;
+                       if ($this->iMinAddressRank == 0 && $this->iMaxAddressRank == 30)
                        {
-                               $iMinAddressRank = $iNewMinAddressRank;
-                               $iMaxAddressRank = $iNewMaxAddressRank;
+                               $this->iMinAddressRank = $iNewMinAddressRank;
+                               $this->iMaxAddressRank = $iNewMaxAddressRank;
                        }
-                       if ($aItemListValues) $aAddressRankList = array_merge($aAddressRankList, $aItemListValues);
+                       if ($aItemListValues) $this->aAddressRankList = array_merge($this->aAddressRankList, $aItemListValues);
                        return true;
                }
 
@@ -213,16 +219,21 @@
                {
                        $this->sQuery = false;
 
+                       // Reset
+                       $this->iMinAddressRank = 0;
+                       $this->iMaxAddressRank = 30;
+                       $this->aAddressRankList = array();
+
                        $this->aStructuredQuery = array();
                        $this->sAllowedTypesSQLList = '';
 
-                       $this->loadStructuredAddressElement($this->aStructuredQuery, $this->iMinAddressRank, $this->iMaxAddressRank, $this->aAddressRankList, $sAmentiy, 'amenity', 26, 30, false);
-                       $this->loadStructuredAddressElement($this->aStructuredQuery, $this->iMinAddressRank, $this->iMaxAddressRank, $this->aAddressRankList, $sStreet, 'street', 26, 30, false);
-                       $this->loadStructuredAddressElement($this->aStructuredQuery, $this->iMinAddressRank, $this->iMaxAddressRank, $this->aAddressRankList, $sCity, 'city', 14, 24, false);
-                       $this->loadStructuredAddressElement($this->aStructuredQuery, $this->iMinAddressRank, $this->iMaxAddressRank, $this->aAddressRankList, $sCounty, 'county', 9, 13, false);
-                       $this->loadStructuredAddressElement($this->aStructuredQuery, $this->iMinAddressRank, $this->iMaxAddressRank, $this->aAddressRankList, $sState, 'state', 8, 8, false);
-                       $this->loadStructuredAddressElement($this->aStructuredQuery, $this->iMinAddressRank, $this->iMaxAddressRank, $this->aAddressRankList, $sPostalCode, 'postalcode' , 5, 11, array(5, 11));
-                       $this->loadStructuredAddressElement($this->aStructuredQuery, $this->iMinAddressRank, $this->iMaxAddressRank, $this->aAddressRankList, $sCountry, 'country', 4, 4, false);
+                       $this->loadStructuredAddressElement($sAmentiy, '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($sState, 'state', 8, 8, false);
+                       $this->loadStructuredAddressElement($sPostalCode, 'postalcode' , 5, 11, array(5, 11));
+                       $this->loadStructuredAddressElement($sCountry, 'country', 4, 4, false);
 
                        if (sizeof($this->aStructuredQuery) > 0) 
                        {
@@ -232,7 +243,29 @@
                                        $sAllowedTypesSQLList = '(\'place\',\'boundary\')';
                                }
                        }
+               }
+
+               function fallbackStructuredQuery()
+               {
+                       if (!$this->aStructuredQuery) return false;
+
+                       $aParams = $this->aStructuredQuery;
+
+                       if (sizeof($aParams) == 1) return false;
+
+                       $aOrderToFallback = array('postalcode', 'street', 'city', 'county', 'state');
+
+                       foreach($aOrderToFallback as $sType)
+                       {
+                               if (isset($aParams[$sType]))
+                               {
+                                       unset($aParams[$sType]);
+                                       $this->setStructuredQuery(@$aParams['amenity'], @$aParams['street'], @$aParams['city'], @$aParams['county'], @$aParams['state'], @$aParams['country'], @$aParams['postalcode']);
+                                       return true;
+                               }
+                       }
 
+                       return false;
                }
 
                function getDetails($aPlaceIDs)
@@ -1374,6 +1407,14 @@
                        // No results? Done
                        if (!sizeof($aSearchResults))
                        {
+                               if ($this->bFallback)
+                               {
+                                       if ($this->fallbackStructuredQuery())
+                                       {
+                                               return $this->lookup();
+                                       }
+                               }
+
                                return array();
                        }