lib-php/Geocode.php

   1 <?php
   2
   3 namespace Nominatim;
   4
   5 require_once(CONST_LibDir.'/PlaceLookup.php');
   6 require_once(CONST_LibDir.'/Phrase.php');
   7 require_once(CONST_LibDir.'/ReverseGeocode.php');
   8 require_once(CONST_LibDir.'/SearchDescription.php');
   9 require_once(CONST_LibDir.'/SearchContext.php');
  10 require_once(CONST_LibDir.'/TokenList.php');
  11 require_once(CONST_TokenizerDir.'/tokenizer.php');
  12
  13 class Geocode
  14 {
  15     protected $oDB;
  16
  17     protected $oPlaceLookup;
  18     protected $oTokenizer;
  19
  20     protected $aLangPrefOrder = array();
  21
  22     protected $aExcludePlaceIDs = array();
  23
  24     protected $iLimit = 20;
  25     protected $iFinalLimit = 10;
  26     protected $iOffset = 0;
  27     protected $bFallback = false;
  28
  29     protected $aCountryCodes = false;
  30
  31     protected $bBoundedSearch = false;
  32     protected $aViewBox = false;
  33     protected $aRoutePoints = false;
  34     protected $aRouteWidth = false;
  35
  36     protected $iMaxRank = 20;
  37     protected $iMinAddressRank = 0;
  38     protected $iMaxAddressRank = 30;
  39     protected $aAddressRankList = array();
  40
  41     protected $sAllowedTypesSQLList = false;
  42
  43     protected $sQuery = false;
  44     protected $aStructuredQuery = false;
  45
  46
  47     public function __construct(&$oDB)
  48     {
  49         $this->oDB =& $oDB;
  50         $this->oPlaceLookup = new PlaceLookup($this->oDB);
  51         $this->oTokenizer = new \Nominatim\Tokenizer($this->oDB);
  52     }
  53
  54     public function setLanguagePreference($aLangPref)
  55     {
  56         $this->aLangPrefOrder = $aLangPref;
  57     }
  58
  59     public function getMoreUrlParams()
  60     {
  61         if ($this->aStructuredQuery) {
  62             $aParams = $this->aStructuredQuery;
  63         } else {
  64             $aParams = array('q' => $this->sQuery);
  65         }
  66
  67         $aParams = array_merge($aParams, $this->oPlaceLookup->getMoreUrlParams());
  68
  69         if ($this->aExcludePlaceIDs) {
  70             $aParams['exclude_place_ids'] = implode(',', $this->aExcludePlaceIDs);
  71         }
  72
  73         if ($this->bBoundedSearch) {
  74             $aParams['bounded'] = '1';
  75         }
  76
  77         if ($this->aCountryCodes) {
  78             $aParams['countrycodes'] = implode(',', $this->aCountryCodes);
  79         }
  80
  81         if ($this->aViewBox) {
  82             $aParams['viewbox'] = join(',', $this->aViewBox);
  83         }
  84
  85         return $aParams;
  86     }
  87
  88     public function setLimit($iLimit = 10)
  89     {
  90         if ($iLimit > 50) {
  91             $iLimit = 50;
  92         } elseif ($iLimit < 1) {
  93             $iLimit = 1;
  94         }
  95
  96         $this->iFinalLimit = $iLimit;
  97         $this->iLimit = $iLimit + min($iLimit, 10);
  98     }
  99
 100     public function setFeatureType($sFeatureType)
 101     {
 102         switch ($sFeatureType) {
 103             case 'country':
 104                 $this->setRankRange(4, 4);
 105                 break;
 106             case 'state':
 107                 $this->setRankRange(8, 8);
 108                 break;
 109             case 'city':
 110                 $this->setRankRange(14, 16);
 111                 break;
 112             case 'settlement':
 113                 $this->setRankRange(8, 20);
 114                 break;
 115         }
 116     }
 117
 118     public function setRankRange($iMin, $iMax)
 119     {
 120         $this->iMinAddressRank = $iMin;
 121         $this->iMaxAddressRank = $iMax;
 122     }
 123
 124     public function setViewbox($aViewbox)
 125     {
 126         $aBox = array_map('floatval', $aViewbox);
 127
 128         $this->aViewBox[0] = max(-180.0, min($aBox[0], $aBox[2]));
 129         $this->aViewBox[1] = max(-90.0, min($aBox[1], $aBox[3]));
 130         $this->aViewBox[2] = min(180.0, max($aBox[0], $aBox[2]));
 131         $this->aViewBox[3] = min(90.0, max($aBox[1], $aBox[3]));
 132
 133         if ($this->aViewBox[2] - $this->aViewBox[0] < 0.000000001
 134             || $this->aViewBox[3] - $this->aViewBox[1] < 0.000000001
 135         ) {
 136             userError("Bad parameter 'viewbox'. Not a box.");
 137         }
 138     }
 139
 140     private function viewboxImportanceFactor($fX, $fY)
 141     {
 142         if (!$this->aViewBox) {
 143             return 1;
 144         }
 145
 146         $fWidth = ($this->aViewBox[2] - $this->aViewBox[0])/2;
 147         $fHeight = ($this->aViewBox[3] - $this->aViewBox[1])/2;
 148
 149         $fXDist = abs($fX - ($this->aViewBox[0] + $this->aViewBox[2])/2);
 150         $fYDist = abs($fY - ($this->aViewBox[1] + $this->aViewBox[3])/2);
 151
 152         if ($fXDist <= $fWidth && $fYDist <= $fHeight) {
 153             return 1;
 154         }
 155
 156         if ($fXDist <= $fWidth * 3 && $fYDist <= 3 * $fHeight) {
 157             return 0.5;
 158         }
 159
 160         return 0.25;
 161     }
 162
 163     public function setQuery($sQueryString)
 164     {
 165         $this->sQuery = $sQueryString;
 166         $this->aStructuredQuery = false;
 167     }
 168
 169     public function getQueryString()
 170     {
 171         return $this->sQuery;
 172     }
 173
 174
 175     public function loadParamArray($oParams, $sForceGeometryType = null)
 176     {
 177         $this->bBoundedSearch = $oParams->getBool('bounded', $this->bBoundedSearch);
 178
 179         $this->setLimit($oParams->getInt('limit', $this->iFinalLimit));
 180         $this->iOffset = $oParams->getInt('offset', $this->iOffset);
 181
 182         $this->bFallback = $oParams->getBool('fallback', $this->bFallback);
 183
 184         // List of excluded Place IDs - used for more acurate pageing
 185         $sExcluded = $oParams->getStringList('exclude_place_ids');
 186         if ($sExcluded) {
 187             foreach ($sExcluded as $iExcludedPlaceID) {
 188                 $iExcludedPlaceID = (int)$iExcludedPlaceID;
 189                 if ($iExcludedPlaceID) {
 190                     $aExcludePlaceIDs[$iExcludedPlaceID] = $iExcludedPlaceID;
 191                 }
 192             }
 193
 194             if (isset($aExcludePlaceIDs)) {
 195                 $this->aExcludePlaceIDs = $aExcludePlaceIDs;
 196             }
 197         }
 198
 199         // Only certain ranks of feature
 200         $sFeatureType = $oParams->getString('featureType');
 201         if (!$sFeatureType) {
 202             $sFeatureType = $oParams->getString('featuretype');
 203         }
 204         if ($sFeatureType) {
 205             $this->setFeatureType($sFeatureType);
 206         }
 207
 208         // Country code list
 209         $sCountries = $oParams->getStringList('countrycodes');
 210         if ($sCountries) {
 211             foreach ($sCountries as $sCountryCode) {
 212                 if (preg_match('/^[a-zA-Z][a-zA-Z]$/', $sCountryCode)) {
 213                     $aCountries[] = strtolower($sCountryCode);
 214                 }
 215             }
 216             if (isset($aCountries)) {
 217                 $this->aCountryCodes = $aCountries;
 218             }
 219         }
 220
 221         $aViewbox = $oParams->getStringList('viewboxlbrt');
 222         if ($aViewbox) {
 223             if (count($aViewbox) != 4) {
 224                 userError("Bad parameter 'viewboxlbrt'. Expected 4 coordinates.");
 225             }
 226             $this->setViewbox($aViewbox);
 227         } else {
 228             $aViewbox = $oParams->getStringList('viewbox');
 229             if ($aViewbox) {
 230                 if (count($aViewbox) != 4) {
 231                     userError("Bad parameter 'viewbox'. Expected 4 coordinates.");
 232                 }
 233                 $this->setViewBox($aViewbox);
 234             } else {
 235                 $aRoute = $oParams->getStringList('route');
 236                 $fRouteWidth = $oParams->getFloat('routewidth');
 237                 if ($aRoute && $fRouteWidth) {
 238                     $this->aRoutePoints = $aRoute;
 239                     $this->aRouteWidth = $fRouteWidth;
 240                 }
 241             }
 242         }
 243
 244         $this->oPlaceLookup->loadParamArray($oParams, $sForceGeometryType);
 245         $this->oPlaceLookup->setIncludeAddressDetails($oParams->getBool('addressdetails', false));
 246     }
 247
 248     public function setQueryFromParams($oParams)
 249     {
 250         // Search query
 251         $sQuery = $oParams->getString('q');
 252         if (!$sQuery) {
 253             $this->setStructuredQuery(
 254                 $oParams->getString('amenity'),
 255                 $oParams->getString('street'),
 256                 $oParams->getString('city'),
 257                 $oParams->getString('county'),
 258                 $oParams->getString('state'),
 259                 $oParams->getString('country'),
 260                 $oParams->getString('postalcode')
 261             );
 262         } else {
 263             $this->setQuery($sQuery);
 264         }
 265     }
 266
 267     public function loadStructuredAddressElement($sValue, $sKey, $iNewMinAddressRank, $iNewMaxAddressRank, $aItemListValues)
 268     {
 269         $sValue = trim($sValue);
 270         if (!$sValue) {
 271             return false;
 272         }
 273         $this->aStructuredQuery[$sKey] = $sValue;
 274         if ($this->iMinAddressRank == 0 && $this->iMaxAddressRank == 30) {
 275             $this->iMinAddressRank = $iNewMinAddressRank;
 276             $this->iMaxAddressRank = $iNewMaxAddressRank;
 277         }
 278         if ($aItemListValues) {
 279             $this->aAddressRankList = array_merge($this->aAddressRankList, $aItemListValues);
 280         }
 281         return true;
 282     }
 283
 284     public function setStructuredQuery($sAmenity = false, $sStreet = false, $sCity = false, $sCounty = false, $sState = false, $sCountry = false, $sPostalCode = false)
 285     {
 286         $this->sQuery = false;
 287
 288         // Reset
 289         $this->iMinAddressRank = 0;
 290         $this->iMaxAddressRank = 30;
 291         $this->aAddressRankList = array();
 292
 293         $this->aStructuredQuery = array();
 294         $this->sAllowedTypesSQLList = false;
 295
 296         $this->loadStructuredAddressElement($sAmenity, 'amenity', 26, 30, false);
 297         $this->loadStructuredAddressElement($sStreet, 'street', 26, 30, false);
 298         $this->loadStructuredAddressElement($sCity, 'city', 14, 24, false);
 299         $this->loadStructuredAddressElement($sCounty, 'county', 9, 13, false);
 300         $this->loadStructuredAddressElement($sState, 'state', 8, 8, false);
 301         $this->loadStructuredAddressElement($sPostalCode, 'postalcode', 5, 11, array(5, 11));
 302         $this->loadStructuredAddressElement($sCountry, 'country', 4, 4, false);
 303
 304         if (!empty($this->aStructuredQuery)) {
 305             $this->sQuery = join(', ', $this->aStructuredQuery);
 306             if ($this->iMaxAddressRank < 30) {
 307                 $this->sAllowedTypesSQLList = '(\'place\',\'boundary\')';
 308             }
 309         }
 310     }
 311
 312     public function fallbackStructuredQuery()
 313     {
 314         $aParams = $this->aStructuredQuery;
 315
 316         if (!$aParams || count($aParams) == 1) {
 317             return false;
 318         }
 319
 320         $aOrderToFallback = array('postalcode', 'street', 'city', 'county', 'state');
 321
 322         foreach ($aOrderToFallback as $sType) {
 323             if (isset($aParams[$sType])) {
 324                 unset($aParams[$sType]);
 325                 $this->setStructuredQuery(@$aParams['amenity'], @$aParams['street'], @$aParams['city'], @$aParams['county'], @$aParams['state'], @$aParams['country'], @$aParams['postalcode']);
 326                 return true;
 327             }
 328         }
 329
 330         return false;
 331     }
 332
 333     public function getGroupedSearches($aSearches, $aPhrases, $oValidTokens)
 334     {
 335         /*
 336              Calculate all searches using oValidTokens i.e.
 337              'Wodsworth Road, Sheffield' =>
 338
 339              Phrase Wordset
 340              0      0       (wodsworth road)
 341              0      1       (wodsworth)(road)
 342              1      0       (sheffield)
 343
 344              Score how good the search is so they can be ordered
 345          */
 346         foreach ($aPhrases as $iPhrase => $oPhrase) {
 347             $aNewPhraseSearches = array();
 348             $sPhraseType = $oPhrase->getPhraseType();
 349
 350             foreach ($oPhrase->getWordSets() as $aWordset) {
 351                 $aWordsetSearches = $aSearches;
 352
 353                 // Add all words from this wordset
 354                 foreach ($aWordset as $iToken => $sToken) {
 355                     $aNewWordsetSearches = array();
 356
 357                     foreach ($aWordsetSearches as $oCurrentSearch) {
 358                         foreach ($oValidTokens->get($sToken) as $oSearchTerm) {
 359                             $aNewSearches = $oCurrentSearch->extendWithSearchTerm(
 360                                 $sToken,
 361                                 $oSearchTerm,
 362                                 $sPhraseType,
 363                                 $iToken == 0 && $iPhrase == 0,
 364                                 $iToken + 1 == count($aWordset)
 365                                   && $iPhrase + 1 == count($aPhrases),
 366                                 $iPhrase
 367                             );
 368
 369                             foreach ($aNewSearches as $oSearch) {
 370                                 if ($oSearch->getRank() < $this->iMaxRank) {
 371                                     $aNewWordsetSearches[] = $oSearch;
 372                                 }
 373                             }
 374                         }
 375                     }
 376                     // Sort and cut
 377                     usort($aNewWordsetSearches, array('Nominatim\SearchDescription', 'bySearchRank'));
 378                     $aWordsetSearches = array_slice($aNewWordsetSearches, 0, 50);
 379                 }
 380
 381                 $aNewPhraseSearches = array_merge($aNewPhraseSearches, $aNewWordsetSearches);
 382                 usort($aNewPhraseSearches, array('Nominatim\SearchDescription', 'bySearchRank'));
 383
 384                 $aSearchHash = array();
 385                 foreach ($aNewPhraseSearches as $iSearch => $aSearch) {
 386                     $sHash = serialize($aSearch);
 387                     if (isset($aSearchHash[$sHash])) {
 388                         unset($aNewPhraseSearches[$iSearch]);
 389                     } else {
 390                         $aSearchHash[$sHash] = 1;
 391                     }
 392                 }
 393
 394                 $aNewPhraseSearches = array_slice($aNewPhraseSearches, 0, 50);
 395             }
 396
 397             // Re-group the searches by their score, junk anything over 20 as just not worth trying
 398             $aGroupedSearches = array();
 399             foreach ($aNewPhraseSearches as $aSearch) {
 400                 $iRank = $aSearch->getRank();
 401                 if ($iRank < $this->iMaxRank) {
 402                     if (!isset($aGroupedSearches[$iRank])) {
 403                         $aGroupedSearches[$iRank] = array();
 404                     }
 405                     $aGroupedSearches[$iRank][] = $aSearch;
 406                 }
 407             }
 408             ksort($aGroupedSearches);
 409
 410             $iSearchCount = 0;
 411             $aSearches = array();
 412             foreach ($aGroupedSearches as $aNewSearches) {
 413                 $iSearchCount += count($aNewSearches);
 414                 $aSearches = array_merge($aSearches, $aNewSearches);
 415                 if ($iSearchCount > 50) {
 416                     break;
 417                 }
 418             }
 419         }
 420
 421         // Revisit searches, drop bad searches and give penalty to unlikely combinations.
 422         $aGroupedSearches = array();
 423         foreach ($aSearches as $oSearch) {
 424             if (!$oSearch->isValidSearch()) {
 425                 continue;
 426             }
 427
 428             $iRank = $oSearch->getRank();
 429             if (!isset($aGroupedSearches[$iRank])) {
 430                 $aGroupedSearches[$iRank] = array();
 431             }
 432             $aGroupedSearches[$iRank][] = $oSearch;
 433         }
 434         ksort($aGroupedSearches);
 435
 436         return $aGroupedSearches;
 437     }
 438
 439     /* Perform the actual query lookup.
 440
 441         Returns an ordered list of results, each with the following fields:
 442             osm_type: type of corresponding OSM object
 443                         N - node
 444                         W - way
 445                         R - relation
 446                         P - postcode (internally computed)
 447             osm_id: id of corresponding OSM object
 448             class: general object class (corresponds to tag key of primary OSM tag)
 449             type: subclass of object (corresponds to tag value of primary OSM tag)
 450             admin_level: see https://wiki.openstreetmap.org/wiki/Admin_level
 451             rank_search: rank in search hierarchy
 452                         (see also https://wiki.openstreetmap.org/wiki/Nominatim/Development_overview#Country_to_street_level)
 453             rank_address: rank in address hierarchy (determines orer in address)
 454             place_id: internal key (may differ between different instances)
 455             country_code: ISO country code
 456             langaddress: localized full address
 457             placename: localized name of object
 458             ref: content of ref tag (if available)
 459             lon: longitude
 460             lat: latitude
 461             importance: importance of place based on Wikipedia link count
 462             addressimportance: cumulated importance of address elements
 463             extra_place: type of place (for admin boundaries, if there is a place tag)
 464             aBoundingBox: bounding Box
 465             label: short description of the object class/type (English only)
 466             name: full name (currently the same as langaddress)
 467             foundorder: secondary ordering for places with same importance
 468     */
 469
 470
 471     public function lookup()
 472     {
 473         Debug::newFunction('Geocode::lookup');
 474         if (!$this->sQuery && !$this->aStructuredQuery) {
 475             return array();
 476         }
 477
 478         Debug::printDebugArray('Geocode', $this);
 479
 480         $oCtx = new SearchContext();
 481
 482         if ($this->aRoutePoints) {
 483             $oCtx->setViewboxFromRoute(
 484                 $this->oDB,
 485                 $this->aRoutePoints,
 486                 $this->aRouteWidth,
 487                 $this->bBoundedSearch
 488             );
 489         } elseif ($this->aViewBox) {
 490             $oCtx->setViewboxFromBox($this->aViewBox, $this->bBoundedSearch);
 491         }
 492         if ($this->aExcludePlaceIDs) {
 493             $oCtx->setExcludeList($this->aExcludePlaceIDs);
 494         }
 495         if ($this->aCountryCodes) {
 496             $oCtx->setCountryList($this->aCountryCodes);
 497         }
 498         $this->oTokenizer->setCountryRestriction($this->aCountryCodes);
 499
 500         Debug::newSection('Query Preprocessing');
 501
 502         $sQuery = $this->sQuery;
 503         if (!preg_match('//u', $sQuery)) {
 504             userError('Query string is not UTF-8 encoded.');
 505         }
 506
 507         // Conflicts between US state abreviations and various words for 'the' in different languages
 508         if (isset($this->aLangPrefOrder['name:en'])) {
 509             $sQuery = preg_replace('/(^|,)\s*il\s*(,|$)/i', '\1illinois\2', $sQuery);
 510             $sQuery = preg_replace('/(^|,)\s*al\s*(,|$)/i', '\1alabama\2', $sQuery);
 511             $sQuery = preg_replace('/(^|,)\s*la\s*(,|$)/i', '\1louisiana\2', $sQuery);
 512         }
 513
 514         // Do we have anything that looks like a lat/lon pair?
 515         $sQuery = $oCtx->setNearPointFromQuery($sQuery);
 516
 517         if ($sQuery || $this->aStructuredQuery) {
 518             // Start with a single blank search
 519             $aSearches = array(new SearchDescription($oCtx));
 520
 521             if ($sQuery) {
 522                 $sQuery = $aSearches[0]->extractKeyValuePairs($sQuery);
 523             }
 524
 525             $sSpecialTerm = '';
 526             if ($sQuery) {
 527                 preg_match_all(
 528                     '/\\[([\\w ]*)\\]/u',
 529                     $sQuery,
 530                     $aSpecialTermsRaw,
 531                     PREG_SET_ORDER
 532                 );
 533                 if (!empty($aSpecialTermsRaw)) {
 534                     Debug::printVar('Special terms', $aSpecialTermsRaw);
 535                 }
 536
 537                 foreach ($aSpecialTermsRaw as $aSpecialTerm) {
 538                     $sQuery = str_replace($aSpecialTerm[0], ' ', $sQuery);
 539                     if (!$sSpecialTerm) {
 540                         $sSpecialTerm = $aSpecialTerm[1];
 541                     }
 542                 }
 543             }
 544             if (!$sSpecialTerm && $this->aStructuredQuery
 545                 && isset($this->aStructuredQuery['amenity'])) {
 546                 $sSpecialTerm = $this->aStructuredQuery['amenity'];
 547                 unset($this->aStructuredQuery['amenity']);
 548             }
 549
 550             if ($sSpecialTerm && !$aSearches[0]->hasOperator()) {
 551                 $aTokens = $this->oTokenizer->tokensForSpecialTerm($sSpecialTerm);
 552
 553                 if (!empty($aTokens)) {
 554                     $aNewSearches = array();
 555                     foreach ($aSearches as $oSearch) {
 556                         foreach ($aTokens as $oToken) {
 557                             $oNewSearch = clone $oSearch;
 558                             $oNewSearch->setPoiSearch(
 559                                 $oToken->iOperator,
 560                                 $oToken->sClass,
 561                                 $oToken->sType
 562                             );
 563                             $aNewSearches[] = $oNewSearch;
 564                         }
 565                     }
 566                     $aSearches = $aNewSearches;
 567                 }
 568             }
 569
 570             // Split query into phrases
 571             // Commas are used to reduce the search space by indicating where phrases split
 572             $aPhrases = array();
 573             if ($this->aStructuredQuery) {
 574                 foreach ($this->aStructuredQuery as $iPhrase => $sPhrase) {
 575                     $aPhrases[] = new Phrase($sPhrase, $iPhrase);
 576                 }
 577             } else {
 578                 foreach (explode(',', $sQuery) as $sPhrase) {
 579                     $aPhrases[] = new Phrase($sPhrase, '');
 580                 }
 581             }
 582
 583             Debug::printDebugArray('Search context', $oCtx);
 584             Debug::printDebugArray('Base search', empty($aSearches) ? null : $aSearches[0]);
 585
 586             Debug::newSection('Tokenization');
 587             $oValidTokens = $this->oTokenizer->extractTokensFromPhrases($aPhrases);
 588
 589             if ($oValidTokens->count() > 0) {
 590                 $oCtx->setFullNameWords($oValidTokens->getFullWordIDs());
 591
 592                 $aPhrases = array_filter($aPhrases, function ($oPhrase) {
 593                     return $oPhrase->getWordSets() !== null;
 594                 });
 595
 596                 // Any words that have failed completely?
 597                 // TODO: suggestions
 598
 599                 Debug::printGroupTable('Valid Tokens', $oValidTokens->debugInfo());
 600                 Debug::printDebugTable('Phrases', $aPhrases);
 601
 602                 Debug::newSection('Search candidates');
 603
 604                 $aGroupedSearches = $this->getGroupedSearches($aSearches, $aPhrases, $oValidTokens);
 605
 606                 if (!$this->aStructuredQuery) {
 607                     // Reverse phrase array and also reverse the order of the wordsets in
 608                     // the first and final phrase. Don't bother about phrases in the middle
 609                     // because order in the address doesn't matter.
 610                     $aPhrases = array_reverse($aPhrases);
 611                     $aPhrases[0]->invertWordSets();
 612                     if (count($aPhrases) > 1) {
 613                         $aPhrases[count($aPhrases)-1]->invertWordSets();
 614                     }
 615                     $aReverseGroupedSearches = $this->getGroupedSearches($aSearches, $aPhrases, $oValidTokens);
 616
 617                     foreach ($aGroupedSearches as $aSearches) {
 618                         foreach ($aSearches as $aSearch) {
 619                             if (!isset($aReverseGroupedSearches[$aSearch->getRank()])) {
 620                                 $aReverseGroupedSearches[$aSearch->getRank()] = array();
 621                             }
 622                             $aReverseGroupedSearches[$aSearch->getRank()][] = $aSearch;
 623                         }
 624                     }
 625
 626                     $aGroupedSearches = $aReverseGroupedSearches;
 627                     ksort($aGroupedSearches);
 628                 }
 629             } else {
 630                 // Re-group the searches by their score, junk anything over 20 as just not worth trying
 631                 $aGroupedSearches = array();
 632                 foreach ($aSearches as $aSearch) {
 633                     if ($aSearch->getRank() < $this->iMaxRank) {
 634                         if (!isset($aGroupedSearches[$aSearch->getRank()])) {
 635                             $aGroupedSearches[$aSearch->getRank()] = array();
 636                         }
 637                         $aGroupedSearches[$aSearch->getRank()][] = $aSearch;
 638                     }
 639                 }
 640                 ksort($aGroupedSearches);
 641             }
 642
 643             // Filter out duplicate searches
 644             $aSearchHash = array();
 645             foreach ($aGroupedSearches as $iGroup => $aSearches) {
 646                 foreach ($aSearches as $iSearch => $aSearch) {
 647                     $sHash = serialize($aSearch);
 648                     if (isset($aSearchHash[$sHash])) {
 649                         unset($aGroupedSearches[$iGroup][$iSearch]);
 650                         if (empty($aGroupedSearches[$iGroup])) {
 651                             unset($aGroupedSearches[$iGroup]);
 652                         }
 653                     } else {
 654                         $aSearchHash[$sHash] = 1;
 655                     }
 656                 }
 657             }
 658
 659             Debug::printGroupedSearch(
 660                 $aGroupedSearches,
 661                 $oValidTokens->debugTokenByWordIdList()
 662             );
 663
 664             // Start the search process
 665             $iGroupLoop = 0;
 666             $iQueryLoop = 0;
 667             $aNextResults = array();
 668             foreach ($aGroupedSearches as $iGroupedRank => $aSearches) {
 669                 $iGroupLoop++;
 670                 $aResults = $aNextResults;
 671                 foreach ($aSearches as $oSearch) {
 672                     $iQueryLoop++;
 673
 674                     Debug::newSection("Search Loop, group $iGroupLoop, loop $iQueryLoop");
 675                     Debug::printGroupedSearch(
 676                         array($iGroupedRank => array($oSearch)),
 677                         $oValidTokens->debugTokenByWordIdList()
 678                     );
 679
 680                     $aNewResults = $oSearch->query(
 681                         $this->oDB,
 682                         $this->iMinAddressRank,
 683                         $this->iMaxAddressRank,
 684                         $this->iLimit
 685                     );
 686
 687                     // The same result may appear in different rounds, only
 688                     // use the one with minimal rank.
 689                     foreach ($aNewResults as $iPlace => $oRes) {
 690                         if (!isset($aResults[$iPlace])
 691                             || $aResults[$iPlace]->iResultRank > $oRes->iResultRank) {
 692                             $aResults[$iPlace] = $oRes;
 693                         }
 694                     }
 695
 696                     if ($iQueryLoop > 20) {
 697                         break;
 698                     }
 699                 }
 700
 701                 if (!empty($aResults)) {
 702                     $aSplitResults = Result::splitResults($aResults);
 703                     Debug::printVar('Split results', $aSplitResults);
 704                     if ($iGroupLoop <= 4
 705                         && reset($aSplitResults['head'])->iResultRank > 0
 706                         && $iGroupedRank !== array_key_last($aGroupedSearches)) {
 707                         // Haven't found an exact match for the query yet.
 708                         // Therefore add result from the next group level.
 709                         $aNextResults = $aSplitResults['head'];
 710                         foreach ($aNextResults as $oRes) {
 711                             $oRes->iResultRank--;
 712                         }
 713                         foreach ($aSplitResults['tail'] as $oRes) {
 714                             $oRes->iResultRank--;
 715                             $aNextResults[$oRes->iId] = $oRes;
 716                         }
 717                         $aResults = array();
 718                     } else {
 719                         $aResults = $aSplitResults['head'];
 720                     }
 721                 }
 722
 723                 if (!empty($aResults) && ($this->iMinAddressRank != 0 || $this->iMaxAddressRank != 30)) {
 724                     // Need to verify passes rank limits before dropping out of the loop (yuk!)
 725                     // reduces the number of place ids, like a filter
 726                     // rank_address is 30 for interpolated housenumbers
 727                     $aFilterSql = array();
 728                     $sPlaceIds = Result::joinIdsByTable($aResults, Result::TABLE_PLACEX);
 729                     if ($sPlaceIds) {
 730                         $sSQL = 'SELECT place_id FROM placex ';
 731                         $sSQL .= 'WHERE place_id in ('.$sPlaceIds.') ';
 732                         $sSQL .= '  AND (';
 733                         $sSQL .= "         placex.rank_address between $this->iMinAddressRank and $this->iMaxAddressRank ";
 734                         $sSQL .= "         OR placex.rank_search between $this->iMinAddressRank and $this->iMaxAddressRank ";
 735                         if ($this->aAddressRankList) {
 736                             $sSQL .= '     OR placex.rank_address in ('.join(',', $this->aAddressRankList).')';
 737                         }
 738                         $sSQL .= ')';
 739                         $aFilterSql[] = $sSQL;
 740                     }
 741                     $sPlaceIds = Result::joinIdsByTable($aResults, Result::TABLE_POSTCODE);
 742                     if ($sPlaceIds) {
 743                         $sSQL = ' SELECT place_id FROM location_postcode lp ';
 744                         $sSQL .= 'WHERE place_id in ('.$sPlaceIds.') ';
 745                         $sSQL .= "  AND (lp.rank_address between $this->iMinAddressRank and $this->iMaxAddressRank ";
 746                         if ($this->aAddressRankList) {
 747                             $sSQL .= '     OR lp.rank_address in ('.join(',', $this->aAddressRankList).')';
 748                         }
 749                         $sSQL .= ') ';
 750                         $aFilterSql[] = $sSQL;
 751                     }
 752
 753                     $aFilteredIDs = array();
 754                     if ($aFilterSql) {
 755                         $sSQL = join(' UNION ', $aFilterSql);
 756                         Debug::printSQL($sSQL);
 757                         $aFilteredIDs = $this->oDB->getCol($sSQL);
 758                     }
 759
 760                     $tempIDs = array();
 761                     foreach ($aResults as $oResult) {
 762                         if (($this->iMaxAddressRank == 30 &&
 763                              ($oResult->iTable == Result::TABLE_OSMLINE
 764                               || $oResult->iTable == Result::TABLE_TIGER))
 765                             || in_array($oResult->iId, $aFilteredIDs)
 766                         ) {
 767                             $tempIDs[$oResult->iId] = $oResult;
 768                         }
 769                     }
 770                     $aResults = $tempIDs;
 771                 }
 772
 773                 if (!empty($aResults) || $iGroupLoop > 4 || $iQueryLoop > 30) {
 774                     break;
 775                 }
 776             }
 777         } else {
 778             // Just interpret as a reverse geocode
 779             $oReverse = new ReverseGeocode($this->oDB);
 780             $oReverse->setZoom(18);
 781
 782             $oLookup = $oReverse->lookupPoint($oCtx->sqlNear, false);
 783
 784             Debug::printVar('Reverse search', $oLookup);
 785
 786             if ($oLookup) {
 787                 $aResults = array($oLookup->iId => $oLookup);
 788             }
 789         }
 790
 791         // No results? Done
 792         if (empty($aResults)) {
 793             if ($this->bFallback && $this->fallbackStructuredQuery()) {
 794                 return $this->lookup();
 795             }
 796
 797             return array();
 798         }
 799
 800         if ($this->aAddressRankList) {
 801             $this->oPlaceLookup->setAddressRankList($this->aAddressRankList);
 802         }
 803         $this->oPlaceLookup->setAllowedTypesSQLList($this->sAllowedTypesSQLList);
 804         $this->oPlaceLookup->setLanguagePreference($this->aLangPrefOrder);
 805         if ($oCtx->hasNearPoint()) {
 806             $this->oPlaceLookup->setAnchorSql($oCtx->sqlNear);
 807         }
 808
 809         $aSearchResults = $this->oPlaceLookup->lookup($aResults);
 810
 811         $aRecheckWords = preg_split('/\b[\s,\\-]*/u', $sQuery);
 812         foreach ($aRecheckWords as $i => $sWord) {
 813             if (!preg_match('/[\pL\pN]/', $sWord)) {
 814                 unset($aRecheckWords[$i]);
 815             }
 816         }
 817
 818         Debug::printVar('Recheck words', $aRecheckWords);
 819
 820         foreach ($aSearchResults as $iIdx => $aResult) {
 821             $fRadius = ClassTypes\getDefRadius($aResult);
 822
 823             $aOutlineResult = $this->oPlaceLookup->getOutlines($aResult['place_id'], $aResult['lon'], $aResult['lat'], $fRadius);
 824             if ($aOutlineResult) {
 825                 $aResult = array_merge($aResult, $aOutlineResult);
 826             }
 827
 828             // Is there an icon set for this type of result?
 829             $sIcon = ClassTypes\getIconFile($aResult);
 830             if (isset($sIcon)) {
 831                 $aResult['icon'] = $sIcon;
 832             }
 833
 834             $sLabel = ClassTypes\getLabel($aResult);
 835             if (isset($sLabel)) {
 836                 $aResult['label'] = $sLabel;
 837             }
 838             $aResult['name'] = $aResult['langaddress'];
 839
 840             if ($oCtx->hasNearPoint()) {
 841                 $aResult['importance'] = 0.001;
 842                 $aResult['foundorder'] = $aResult['addressimportance'];
 843             } else {
 844                 $aResult['importance'] = max(0.001, $aResult['importance']);
 845                 $aResult['importance'] *= $this->viewboxImportanceFactor(
 846                     $aResult['lon'],
 847                     $aResult['lat']
 848                 );
 849
 850                 // secondary ordering (for results with same importance (the smaller the better):
 851                 // - approximate importance of address parts
 852                 if (isset($aResult['addressimportance']) && $aResult['addressimportance']) {
 853                     $aResult['foundorder'] = -$aResult['addressimportance']/10;
 854                 } else {
 855                     $aResult['foundorder'] = -$aResult['importance'];
 856                 }
 857                 // - number of exact matches from the query
 858                 $aResult['foundorder'] -= $aResults[$aResult['place_id']]->iExactMatches;
 859                 // - importance of the class/type
 860                 $iClassImportance = ClassTypes\getImportance($aResult);
 861                 if (isset($iClassImportance)) {
 862                     $aResult['foundorder'] += 0.0001 * $iClassImportance;
 863                 } else {
 864                     $aResult['foundorder'] += 0.01;
 865                 }
 866                 // - rank
 867                 $aResult['foundorder'] -= 0.00001 * (30 - $aResult['rank_search']);
 868
 869                 // Adjust importance for the number of exact string matches in the result
 870                 $iCountWords = 0;
 871                 $sAddress = $aResult['langaddress'];
 872                 foreach ($aRecheckWords as $i => $sWord) {
 873                     if (stripos($sAddress, $sWord)!==false) {
 874                         $iCountWords++;
 875                         if (preg_match('/(^|,)\s*'.preg_quote($sWord, '/').'\s*(,|$)/', $sAddress)) {
 876                             $iCountWords += 0.1;
 877                         }
 878                     }
 879                 }
 880
 881                 // 0.1 is a completely arbitrary number but something in the range 0.1 to 0.5 would seem right
 882                 $aResult['importance'] = $aResult['importance'] + ($iCountWords*0.1);
 883             }
 884             $aSearchResults[$iIdx] = $aResult;
 885         }
 886         uasort($aSearchResults, 'byImportance');
 887         Debug::printVar('Pre-filter results', $aSearchResults);
 888
 889         $aOSMIDDone = array();
 890         $aClassTypeNameDone = array();
 891         $aToFilter = $aSearchResults;
 892         $aSearchResults = array();
 893
 894         foreach ($aToFilter as $aResult) {
 895             $this->aExcludePlaceIDs[$aResult['place_id']] = $aResult['place_id'];
 896             if (!$this->oPlaceLookup->doDeDupe() || (!isset($aOSMIDDone[$aResult['osm_type'].$aResult['osm_id']])
 897                 && !isset($aClassTypeNameDone[$aResult['osm_type'].$aResult['class'].$aResult['type'].$aResult['name'].$aResult['admin_level']]))
 898             ) {
 899                 $aOSMIDDone[$aResult['osm_type'].$aResult['osm_id']] = true;
 900                 $aClassTypeNameDone[$aResult['osm_type'].$aResult['class'].$aResult['type'].$aResult['name'].$aResult['admin_level']] = true;
 901                 $aSearchResults[] = $aResult;
 902             }
 903
 904             // Absolute limit on number of results
 905             if (count($aSearchResults) >= $this->iFinalLimit) {
 906                 break;
 907             }
 908         }
 909
 910         Debug::printVar('Post-filter results', $aSearchResults);
 911         return $aSearchResults;
 912     } // end lookup()
 913
 914     public function debugInfo()
 915     {
 916         return array(
 917                 'Query' => $this->sQuery,
 918                 'Structured query' => $this->aStructuredQuery,
 919                 'Name keys' => Debug::fmtArrayVals($this->aLangPrefOrder),
 920                 'Excluded place IDs' => Debug::fmtArrayVals($this->aExcludePlaceIDs),
 921                 'Limit (for searches)' => $this->iLimit,
 922                 'Limit (for results)'=> $this->iFinalLimit,
 923                 'Country codes' => Debug::fmtArrayVals($this->aCountryCodes),
 924                 'Bounded search' => $this->bBoundedSearch,
 925                 'Viewbox' => Debug::fmtArrayVals($this->aViewBox),
 926                 'Route points' => Debug::fmtArrayVals($this->aRoutePoints),
 927                 'Route width' => $this->aRouteWidth,
 928                 'Max rank' => $this->iMaxRank,
 929                 'Min address rank' => $this->iMinAddressRank,
 930                 'Max address rank' => $this->iMaxAddressRank,
 931                 'Address rank list' => Debug::fmtArrayVals($this->aAddressRankList)
 932                );
 933     }
 934 } // end class