lib/SearchDescription.php

   1 <?php
   2
   3 namespace Nominatim;
   4
   5 require_once(CONST_BasePath.'/lib/SpecialSearchOperator.php');
   6 require_once(CONST_BasePath.'/lib/SearchContext.php');
   7 require_once(CONST_BasePath.'/lib/Result.php');
   8
   9 /**
  10  * Description of a single interpretation of a search query.
  11  */
  12 class SearchDescription
  13 {
  14     /// Ranking how well the description fits the query.
  15     private $iSearchRank = 0;
  16     /// Country code of country the result must belong to.
  17     private $sCountryCode = '';
  18     /// List of word ids making up the name of the object.
  19     private $aName = array();
  20     /// List of word ids making up the address of the object.
  21     private $aAddress = array();
  22     /// Subset of word ids of full words making up the address.
  23     private $aFullNameAddress = array();
  24     /// List of word ids that appear in the name but should be ignored.
  25     private $aNameNonSearch = array();
  26     /// List of word ids that appear in the address but should be ignored.
  27     private $aAddressNonSearch = array();
  28     /// Kind of search for special searches, see Nominatim::Operator.
  29     private $iOperator = Operator::NONE;
  30     /// Class of special feature to search for.
  31     private $sClass = '';
  32     /// Type of special feature to search for.
  33     private $sType = '';
  34     /// Housenumber of the object.
  35     private $sHouseNumber = '';
  36     /// Postcode for the object.
  37     private $sPostcode = '';
  38     /// Global search constraints.
  39     private $oContext;
  40
  41     // Temporary values used while creating the search description.
  42
  43     /// Index of phrase currently processed.
  44     private $iNamePhrase = -1;
  45
  46
  47     /**
  48      * Create an empty search description.
  49      *
  50      * @param object $oContext Global context to use. Will be inherited by
  51      *                         all derived search objects.
  52      */
  53     public function __construct($oContext)
  54     {
  55         $this->oContext = $oContext;
  56     }
  57
  58     /**
  59      * Get current search rank.
  60      *
  61      * The higher the search rank the lower the likelihood that the
  62      * search is a correct interpretation of the search query.
  63      *
  64      * @return integer Search rank.
  65      */
  66     public function getRank()
  67     {
  68         return $this->iSearchRank;
  69     }
  70
  71     /**
  72      * Make this search a POI search.
  73      *
  74      * In a POI search, objects are not (only) searched by their name
  75      * but also by the primary OSM key/value pair (class and type in Nominatim).
  76      *
  77      * @param integer $iOperator Type of POI search
  78      * @param string  $sClass    Class (or OSM tag key) of POI.
  79      * @param string  $sType     Type (or OSM tag value) of POI.
  80      *
  81      * @return void
  82      */
  83     public function setPoiSearch($iOperator, $sClass, $sType)
  84     {
  85         $this->iOperator = $iOperator;
  86         $this->sClass = $sClass;
  87         $this->sType = $sType;
  88     }
  89
  90     /**
  91      * Check if this might be a full address search.
  92      *
  93      * @return bool True if the search contains name, address and housenumber.
  94      */
  95     public function looksLikeFullAddress()
  96     {
  97         return (!empty($this->aName))
  98                && (!empty($this->aAddress) || $this->sCountryCode)
  99                && preg_match('/[0-9]+/', $this->sHouseNumber);
 100     }
 101
 102     /**
 103      * Check if any operator is set.
 104      *
 105      * @return bool True, if this is a special search operation.
 106      */
 107     public function hasOperator()
 108     {
 109         return $this->iOperator != Operator::NONE;
 110     }
 111
 112     /**
 113      * Extract key/value pairs from a query.
 114      *
 115      * Key/value pairs are recognised if they are of the form [<key>=<value>].
 116      * If multiple terms of this kind are found then all terms are removed
 117      * but only the first is used for search.
 118      *
 119      * @param string $sQuery Original query string.
 120      *
 121      * @return string The query string with the special search patterns removed.
 122      */
 123     public function extractKeyValuePairs($sQuery)
 124     {
 125         // Search for terms of kind [<key>=<value>].
 126         preg_match_all(
 127             '/\\[([\\w_]*)=([\\w_]*)\\]/',
 128             $sQuery,
 129             $aSpecialTermsRaw,
 130             PREG_SET_ORDER
 131         );
 132
 133         foreach ($aSpecialTermsRaw as $aTerm) {
 134             $sQuery = str_replace($aTerm[0], ' ', $sQuery);
 135             if (!$this->hasOperator()) {
 136                 $this->setPoiSearch(Operator::TYPE, $aTerm[1], $aTerm[2]);
 137             }
 138         }
 139
 140         return $sQuery;
 141     }
 142
 143     /**
 144      * Check if the combination of parameters is sensible.
 145      *
 146      * @return bool True, if the search looks valid.
 147      */
 148     public function isValidSearch()
 149     {
 150         if (empty($this->aName)) {
 151             if ($this->sHouseNumber) {
 152                 return false;
 153             }
 154             if (!$this->sClass && !$this->sCountryCode) {
 155                 return false;
 156             }
 157         }
 158
 159         return true;
 160     }
 161
 162     /////////// Search building functions
 163
 164
 165     /**
 166      * Derive new searches by adding a full term to the existing search.
 167      *
 168      * @param mixed[] $aSearchTerm  Description of the token.
 169      * @param bool    $bHasPartial  True if there are also tokens of partial terms
 170      *                              with the same name.
 171      * @param string  $sPhraseType  Type of phrase the token is contained in.
 172      * @param bool    $bFirstToken  True if the token is at the beginning of the
 173      *                              query.
 174      * @param bool    $bFirstPhrase True if the token is in the first phrase of
 175      *                              the query.
 176      * @param bool    $bLastToken   True if the token is at the end of the query.
 177      *
 178      * @return SearchDescription[] List of derived search descriptions.
 179      */
 180     public function extendWithFullTerm($aSearchTerm, $bHasPartial, $sPhraseType, $bFirstToken, $bFirstPhrase, $bLastToken)
 181     {
 182         $aNewSearches = array();
 183
 184         if (($sPhraseType == '' || $sPhraseType == 'country')
 185             && !empty($aSearchTerm['country_code'])
 186             && $aSearchTerm['country_code'] != '0'
 187         ) {
 188             if (!$this->sCountryCode) {
 189                 $oSearch = clone $this;
 190                 $oSearch->iSearchRank++;
 191                 $oSearch->sCountryCode = $aSearchTerm['country_code'];
 192                 // Country is almost always at the end of the string
 193                 // - increase score for finding it anywhere else (optimisation)
 194                 if (!$bLastToken) {
 195                     $oSearch->iSearchRank += 5;
 196                 }
 197                 $aNewSearches[] = $oSearch;
 198             }
 199         } elseif (($sPhraseType == '' || $sPhraseType == 'postalcode')
 200                   && $aSearchTerm['class'] == 'place' && $aSearchTerm['type'] == 'postcode'
 201         ) {
 202             // We need to try the case where the postal code is the primary element
 203             // (i.e. no way to tell if it is (postalcode, city) OR (city, postalcode)
 204             // so try both.
 205             if (!$this->sPostcode
 206                 && $aSearchTerm['word']
 207                 && pg_escape_string($aSearchTerm['word']) == $aSearchTerm['word']
 208             ) {
 209                 // If we have structured search or this is the first term,
 210                 // make the postcode the primary search element.
 211                 if ($this->iOperator == Operator::NONE
 212                     && ($sPhraseType == 'postalcode' || $bFirstToken)
 213                 ) {
 214                     $oSearch = clone $this;
 215                     $oSearch->iSearchRank++;
 216                     $oSearch->iOperator = Operator::POSTCODE;
 217                     $oSearch->aAddress = array_merge($this->aAddress, $this->aName);
 218                     $oSearch->aName =
 219                         array($aSearchTerm['word_id'] => $aSearchTerm['word']);
 220                     $aNewSearches[] = $oSearch;
 221                 }
 222
 223                 // If we have a structured search or this is not the first term,
 224                 // add the postcode as an addendum.
 225                 if ($this->iOperator != Operator::POSTCODE
 226                     && ($sPhraseType == 'postalcode' || !empty($this->aName))
 227                 ) {
 228                     $oSearch = clone $this;
 229                     $oSearch->iSearchRank++;
 230                     $oSearch->sPostcode = $aSearchTerm['word'];
 231                     $aNewSearches[] = $oSearch;
 232                 }
 233             }
 234         } elseif (($sPhraseType == '' || $sPhraseType == 'street')
 235                  && $aSearchTerm['class'] == 'place' && $aSearchTerm['type'] == 'house'
 236         ) {
 237             if (!$this->sHouseNumber && $this->iOperator != Operator::POSTCODE) {
 238                 $oSearch = clone $this;
 239                 $oSearch->iSearchRank++;
 240                 $oSearch->sHouseNumber = trim($aSearchTerm['word_token']);
 241                 // sanity check: if the housenumber is not mainly made
 242                 // up of numbers, add a penalty
 243                 if (preg_match_all('/[^0-9]/', $oSearch->sHouseNumber, $aMatches) > 2) {
 244                     $oSearch->iSearchRank++;
 245                 }
 246                 if (!isset($aSearchTerm['word_id'])) {
 247                     $oSearch->iSearchRank++;
 248                 }
 249                 // also must not appear in the middle of the address
 250                 if (!empty($this->aAddress)
 251                     || (!empty($this->aAddressNonSearch))
 252                     || $this->sPostcode
 253                 ) {
 254                     $oSearch->iSearchRank++;
 255                 }
 256                 $aNewSearches[] = $oSearch;
 257             }
 258         } elseif ($sPhraseType == '' && $aSearchTerm['class']) {
 259             if ($this->iOperator == Operator::NONE) {
 260                 $oSearch = clone $this;
 261                 $oSearch->iSearchRank++;
 262
 263                 $iOp = Operator::NEAR; // near == in for the moment
 264                 if ($aSearchTerm['operator'] == '') {
 265                     if (!empty($this->aName) || $this->oContext->isBoundedSearch()) {
 266                         $iOp = Operator::NAME;
 267                     }
 268                     $oSearch->iSearchRank += 2;
 269                 }
 270
 271                 $oSearch->setPoiSearch($iOp, $aSearchTerm['class'], $aSearchTerm['type']);
 272                 $aNewSearches[] = $oSearch;
 273             }
 274         } elseif (isset($aSearchTerm['word_id'])
 275                   && $aSearchTerm['word_id']
 276                   && $sPhraseType != 'country'
 277         ) {
 278             $iWordID = $aSearchTerm['word_id'];
 279             // Full words can only be a name if they appear at the beginning
 280             // of the phrase. In structured search the name must forcably in
 281             // the first phrase. In unstructured search it may be in a later
 282             // phrase when the first phrase is a house number.
 283             if (!empty($this->aName) || !($bFirstPhrase || $sPhraseType == '')) {
 284                 if (($sPhraseType == '' || !$bFirstPhrase) && !$bHasPartial) {
 285                     $oSearch = clone $this;
 286                     $oSearch->iSearchRank++;
 287                     $oSearch->aAddress[$iWordID] = $iWordID;
 288                     $aNewSearches[] = $oSearch;
 289                 } else {
 290                     $this->aFullNameAddress[$iWordID] = $iWordID;
 291                 }
 292             } else {
 293                 $oSearch = clone $this;
 294                 $oSearch->iSearchRank++;
 295                 $oSearch->aName = array($iWordID => $iWordID);
 296                 $aNewSearches[] = $oSearch;
 297             }
 298         }
 299
 300         return $aNewSearches;
 301     }
 302
 303     /**
 304      * Derive new searches by adding a partial term to the existing search.
 305      *
 306      * @param mixed[] $aSearchTerm        Description of the token.
 307      * @param bool    $bStructuredPhrases True if the search is structured.
 308      * @param integer $iPhrase            Number of the phrase the token is in.
 309      * @param array[] $aFullTokens        List of full term tokens with the
 310      *                                    same name.
 311      *
 312      * @return SearchDescription[] List of derived search descriptions.
 313      */
 314     public function extendWithPartialTerm($aSearchTerm, $bStructuredPhrases, $iPhrase, $aFullTokens)
 315     {
 316         // Only allow name terms.
 317         if (!(isset($aSearchTerm['word_id']) && $aSearchTerm['word_id'])) {
 318             return array();
 319         }
 320
 321         $aNewSearches = array();
 322         $iWordID = $aSearchTerm['word_id'];
 323
 324         if ((!$bStructuredPhrases || $iPhrase > 0)
 325             && (!empty($this->aName))
 326             && strpos($aSearchTerm['word_token'], ' ') === false
 327         ) {
 328             if ($aSearchTerm['search_name_count'] + 1 < CONST_Max_Word_Frequency) {
 329                 $oSearch = clone $this;
 330                 $oSearch->iSearchRank += 2;
 331                 $oSearch->aAddress[$iWordID] = $iWordID;
 332                 $aNewSearches[] = $oSearch;
 333             } else {
 334                 $oSearch = clone $this;
 335                 $oSearch->iSearchRank++;
 336                 $oSearch->aAddressNonSearch[$iWordID] = $iWordID;
 337                 if (preg_match('#^[0-9]+$#', $aSearchTerm['word_token'])) {
 338                     $oSearch->iSearchRank += 2;
 339                 }
 340                 if (!empty($aFullTokens)) {
 341                     $oSearch->iSearchRank++;
 342                 }
 343                 $aNewSearches[] = $oSearch;
 344
 345                 // revert to the token version?
 346                 foreach ($aFullTokens as $aSearchTermToken) {
 347                     if (empty($aSearchTermToken['country_code'])
 348                         && empty($aSearchTermToken['lat'])
 349                         && empty($aSearchTermToken['class'])
 350                     ) {
 351                         $oSearch = clone $this;
 352                         $oSearch->iSearchRank++;
 353                         $oSearch->aAddress[$aSearchTermToken['word_id']] = $aSearchTermToken['word_id'];
 354                         $aNewSearches[] = $oSearch;
 355                     }
 356                 }
 357             }
 358         }
 359
 360         if ((!$this->sPostcode && !$this->aAddress && !$this->aAddressNonSearch)
 361             && (empty($this->aName) || $this->iNamePhrase == $iPhrase)
 362         ) {
 363             $oSearch = clone $this;
 364             $oSearch->iSearchRank += 2;
 365             if (empty($this->aName)) {
 366                 $oSearch->iSearchRank += 1;
 367             }
 368             if (preg_match('#^[0-9]+$#', $aSearchTerm['word_token'])) {
 369                 $oSearch->iSearchRank += 2;
 370             }
 371             if ($aSearchTerm['search_name_count'] + 1 < CONST_Max_Word_Frequency) {
 372                 $oSearch->aName[$iWordID] = $iWordID;
 373             } else {
 374                 $oSearch->aNameNonSearch[$iWordID] = $iWordID;
 375             }
 376             $oSearch->iNamePhrase = $iPhrase;
 377             $aNewSearches[] = $oSearch;
 378         }
 379
 380         return $aNewSearches;
 381     }
 382
 383     /////////// Query functions
 384
 385
 386     /**
 387      * Query database for places that match this search.
 388      *
 389      * @param object  $oDB                  Database connection to use.
 390      * @param mixed[] $aWordFrequencyScores Number of times tokens appears
 391      *                                      overall in a planet database.
 392      * @param integer $iMinRank             Minimum address rank to restrict
 393      *                                      search to.
 394      * @param integer $iMaxRank             Maximum address rank to restrict
 395      *                                      search to.
 396      * @param integer $iLimit               Maximum number of results.
 397      *
 398      * @return mixed[] An array with two fields: IDs contains the list of
 399      *                 matching place IDs and houseNumber the houseNumber
 400      *                 if appicable or -1 if not.
 401      */
 402     public function query(&$oDB, &$aWordFrequencyScores, $iMinRank, $iMaxRank, $iLimit)
 403     {
 404         $aResults = array();
 405         $iHousenumber = -1;
 406
 407         if ($this->sCountryCode
 408             && empty($this->aName)
 409             && !$this->iOperator
 410             && !$this->sClass
 411             && !$this->oContext->hasNearPoint()
 412         ) {
 413             // Just looking for a country - look it up
 414             if (4 >= $iMinRank && 4 <= $iMaxRank) {
 415                 $aResults = $this->queryCountry($oDB);
 416             }
 417         } elseif (empty($this->aName) && empty($this->aAddress)) {
 418             // Neither name nor address? Then we must be
 419             // looking for a POI in a geographic area.
 420             if ($this->oContext->isBoundedSearch()) {
 421                 $aResults = $this->queryNearbyPoi($oDB, $iLimit);
 422             }
 423         } elseif ($this->iOperator == Operator::POSTCODE) {
 424             // looking for postcode
 425             $aResults = $this->queryPostcode($oDB, $iLimit);
 426         } else {
 427             // Ordinary search:
 428             // First search for places according to name and address.
 429             $aResults = $this->queryNamedPlace(
 430                 $oDB,
 431                 $aWordFrequencyScores,
 432                 $iMinRank,
 433                 $iMaxRank,
 434                 $iLimit
 435             );
 436
 437             //now search for housenumber, if housenumber provided
 438             if ($this->sHouseNumber && !empty($aResults)) {
 439                 $aNamedPlaceIDs = $aResults;
 440                 $aResults = $this->queryHouseNumber($oDB, $aNamedPlaceIDs, $iLimit);
 441
 442                 if (empty($aResults) && $this->looksLikeFullAddress()) {
 443                     $aResults = $aNamedPlaceIDs;
 444                 }
 445             }
 446
 447             // finally get POIs if requested
 448             if ($this->sClass && !empty($aResults)) {
 449                 $aResults = $this->queryPoiByOperator($oDB, $aResults, $iLimit);
 450             }
 451         }
 452
 453         if (CONST_Debug) {
 454             echo '<br><b>Place IDs:</b> ';
 455             var_dump(array_keys($aResults));
 456         }
 457
 458         if (!empty($aResults) && $this->sPostcode) {
 459             $sPlaceIds = Result::joinIdsByTable($aResults, Result::TABLE_PLACEX);
 460             if ($sPlaceIds) {
 461                 $sSQL = 'SELECT place_id FROM placex';
 462                 $sSQL .= ' WHERE place_id in ('.$sPlaceIds.')';
 463                 $sSQL .= " AND postcode = '".$this->sPostcode."'";
 464                 if (CONST_Debug) var_dump($sSQL);
 465                 $aFilteredPlaceIDs = chksql($oDB->getCol($sSQL));
 466                 if ($aFilteredPlaceIDs) {
 467                     $aNewResults = array();
 468                     foreach ($aFilteredPlaceIDs as $iPlaceId) {
 469                         $aNewResults[$iPlaceId] = $aResults[$iPlaceId];
 470                     }
 471                     $aResults = $aNewResults;
 472                     if (CONST_Debug) {
 473                         echo '<br><b>Place IDs after postcode filtering:</b> ';
 474                         var_dump(array_keys($aResults));
 475                     }
 476                 }
 477             }
 478         }
 479
 480         return $aResults;
 481     }
 482
 483
 484     private function queryCountry(&$oDB)
 485     {
 486         $sSQL = 'SELECT place_id FROM placex ';
 487         $sSQL .= "WHERE country_code='".$this->sCountryCode."'";
 488         $sSQL .= ' AND rank_search = 4';
 489         if ($this->oContext->bViewboxBounded) {
 490             $sSQL .= ' AND ST_Intersects('.$this->oContext->sqlViewboxSmall.', geometry)';
 491         }
 492         $sSQL .= ' ORDER BY st_area(geometry) DESC LIMIT 1';
 493
 494         if (CONST_Debug) var_dump($sSQL);
 495
 496         $aResults = array();
 497         foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
 498             $aResults[$iPlaceId] = new Result($iPlaceId);
 499         }
 500
 501         return $aResults;
 502     }
 503
 504     private function queryNearbyPoi(&$oDB, $iLimit)
 505     {
 506         if (!$this->sClass) {
 507             return array();
 508         }
 509
 510         $aDBResults = array();
 511         $sPoiTable = $this->poiTable();
 512
 513         $sSQL = 'SELECT count(*) FROM pg_tables WHERE tablename = \''.$sPoiTable."'";
 514         if (chksql($oDB->getOne($sSQL))) {
 515             $sSQL = 'SELECT place_id FROM '.$sPoiTable.' ct';
 516             if ($this->oContext->sqlCountryList) {
 517                 $sSQL .= ' JOIN placex USING (place_id)';
 518             }
 519             if ($this->oContext->hasNearPoint()) {
 520                 $sSQL .= ' WHERE '.$this->oContext->withinSQL('ct.centroid');
 521             } elseif ($this->oContext->bViewboxBounded) {
 522                 $sSQL .= ' WHERE ST_Contains('.$this->oContext->sqlViewboxSmall.', ct.centroid)';
 523             }
 524             if ($this->oContext->sqlCountryList) {
 525                 $sSQL .= ' AND country_code in '.$this->oContext->sqlCountryList;
 526             }
 527             $sSQL .= $this->oContext->excludeSQL(' AND place_id');
 528             if ($this->oContext->sqlViewboxCentre) {
 529                 $sSQL .= ' ORDER BY ST_Distance(';
 530                 $sSQL .= $this->oContext->sqlViewboxCentre.', ct.centroid) ASC';
 531             } elseif ($this->oContext->hasNearPoint()) {
 532                 $sSQL .= ' ORDER BY '.$this->oContext->distanceSQL('ct.centroid').' ASC';
 533             }
 534             $sSQL .= " limit $iLimit";
 535             if (CONST_Debug) var_dump($sSQL);
 536             $aDBResults = chksql($oDB->getCol($sSQL));
 537         }
 538
 539         if ($this->oContext->hasNearPoint()) {
 540             $sSQL = 'SELECT place_id FROM placex WHERE ';
 541             $sSQL .= 'class=\''.$this->sClass."' and type='".$this->sType."'";
 542             $sSQL .= ' AND '.$this->oContext->withinSQL('geometry');
 543             $sSQL .= ' AND linked_place_id is null';
 544             if ($this->oContext->sqlCountryList) {
 545                 $sSQL .= ' AND country_code in '.$this->oContext->sqlCountryList;
 546             }
 547             $sSQL .= ' ORDER BY '.$this->oContext->distanceSQL('centroid').' ASC';
 548             $sSQL .= " LIMIT $iLimit";
 549             if (CONST_Debug) var_dump($sSQL);
 550             $aDBResults = chksql($oDB->getCol($sSQL));
 551         }
 552
 553         $aResults = array();
 554         foreach ($aDBResults as $iPlaceId) {
 555             $aResults[$iPlaceId] = new Result($iPlaceId);
 556         }
 557
 558         return $aResults;
 559     }
 560
 561     private function queryPostcode(&$oDB, $iLimit)
 562     {
 563         $sSQL = 'SELECT p.place_id FROM location_postcode p ';
 564
 565         if (!empty($this->aAddress)) {
 566             $sSQL .= ', search_name s ';
 567             $sSQL .= 'WHERE s.place_id = p.parent_place_id ';
 568             $sSQL .= 'AND array_cat(s.nameaddress_vector, s.name_vector)';
 569             $sSQL .= '      @> '.getArraySQL($this->aAddress).' AND ';
 570         } else {
 571             $sSQL .= 'WHERE ';
 572         }
 573
 574         $sSQL .= "p.postcode = '".reset($this->aName)."'";
 575         $sSQL .= $this->countryCodeSQL(' AND p.country_code');
 576         $sSQL .= $this->oContext->excludeSQL(' AND p.place_id');
 577         $sSQL .= " LIMIT $iLimit";
 578
 579         if (CONST_Debug) var_dump($sSQL);
 580
 581         $aResults = array();
 582         foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
 583             $aResults[$iPlaceId] = new Result($iPlaceId, Result::TABLE_POSTCODE);
 584         }
 585
 586         return $aResults;
 587     }
 588
 589     private function queryNamedPlace(&$oDB, $aWordFrequencyScores, $iMinAddressRank, $iMaxAddressRank, $iLimit)
 590     {
 591         $aTerms = array();
 592         $aOrder = array();
 593
 594         if ($this->sHouseNumber && !empty($this->aAddress)) {
 595             $sHouseNumberRegex = '\\\\m'.$this->sHouseNumber.'\\\\M';
 596             $aOrder[] = ' (';
 597             $aOrder[0] .= 'EXISTS(';
 598             $aOrder[0] .= '  SELECT place_id';
 599             $aOrder[0] .= '  FROM placex';
 600             $aOrder[0] .= '  WHERE parent_place_id = search_name.place_id';
 601             $aOrder[0] .= "    AND transliteration(housenumber) ~* E'".$sHouseNumberRegex."'";
 602             $aOrder[0] .= '  LIMIT 1';
 603             $aOrder[0] .= ') ';
 604             // also housenumbers from interpolation lines table are needed
 605             if (preg_match('/[0-9]+/', $this->sHouseNumber)) {
 606                 $iHouseNumber = intval($this->sHouseNumber);
 607                 $aOrder[0] .= 'OR EXISTS(';
 608                 $aOrder[0] .= '  SELECT place_id ';
 609                 $aOrder[0] .= '  FROM location_property_osmline ';
 610                 $aOrder[0] .= '  WHERE parent_place_id = search_name.place_id';
 611                 $aOrder[0] .= '    AND startnumber is not NULL';
 612                 $aOrder[0] .= '    AND '.$iHouseNumber.'>=startnumber ';
 613                 $aOrder[0] .= '    AND '.$iHouseNumber.'<=endnumber ';
 614                 $aOrder[0] .= '  LIMIT 1';
 615                 $aOrder[0] .= ')';
 616             }
 617             $aOrder[0] .= ') DESC';
 618         }
 619
 620         if (!empty($this->aName)) {
 621             $aTerms[] = 'name_vector @> '.getArraySQL($this->aName);
 622         }
 623         if (!empty($this->aAddress)) {
 624             // For infrequent name terms disable index usage for address
 625             if (CONST_Search_NameOnlySearchFrequencyThreshold
 626                 && count($this->aName) == 1
 627                 && $aWordFrequencyScores[$this->aName[reset($this->aName)]]
 628                      < CONST_Search_NameOnlySearchFrequencyThreshold
 629             ) {
 630                 $aTerms[] = 'array_cat(nameaddress_vector,ARRAY[]::integer[]) @> '.getArraySQL($this->aAddress);
 631             } else {
 632                 $aTerms[] = 'nameaddress_vector @> '.getArraySQL($this->aAddress);
 633             }
 634         }
 635
 636         $sCountryTerm = $this->countryCodeSQL('country_code');
 637         if ($sCountryTerm) {
 638             $aTerms[] = $sCountryTerm;
 639         }
 640
 641         if ($this->sHouseNumber) {
 642             $aTerms[] = 'address_rank between 16 and 27';
 643         } elseif (!$this->sClass || $this->iOperator == Operator::NAME) {
 644             if ($iMinAddressRank > 0) {
 645                 $aTerms[] = 'address_rank >= '.$iMinAddressRank;
 646             }
 647             if ($iMaxAddressRank < 30) {
 648                 $aTerms[] = 'address_rank <= '.$iMaxAddressRank;
 649             }
 650         }
 651
 652         if ($this->oContext->hasNearPoint()) {
 653             $aTerms[] = $this->oContext->withinSQL('centroid');
 654             $aOrder[] = $this->oContext->distanceSQL('centroid');
 655         } elseif ($this->sPostcode) {
 656             if (empty($this->aAddress)) {
 657                 $aTerms[] = "EXISTS(SELECT place_id FROM location_postcode p WHERE p.postcode = '".$this->sPostcode."' AND ST_DWithin(search_name.centroid, p.geometry, 0.1))";
 658             } else {
 659                 $aOrder[] = "(SELECT min(ST_Distance(search_name.centroid, p.geometry)) FROM location_postcode p WHERE p.postcode = '".$this->sPostcode."')";
 660             }
 661         }
 662
 663         $sExcludeSQL = $this->oContext->excludeSQL('place_id');
 664         if ($sExcludeSQL) {
 665             $aTerms[] = $sExcludeSQL;
 666         }
 667
 668         if ($this->oContext->bViewboxBounded) {
 669             $aTerms[] = 'centroid && '.$this->oContext->sqlViewboxSmall;
 670         }
 671
 672         if ($this->oContext->hasNearPoint()) {
 673             $aOrder[] = $this->oContext->distanceSQL('centroid');
 674         }
 675
 676         if ($this->sHouseNumber) {
 677             $sImportanceSQL = '- abs(26 - address_rank) + 3';
 678         } else {
 679             $sImportanceSQL = '(CASE WHEN importance = 0 OR importance IS NULL THEN 0.75001-(search_rank::float/40) ELSE importance END)';
 680         }
 681         $sImportanceSQL .= $this->oContext->viewboxImportanceSQL('centroid');
 682         $aOrder[] = "$sImportanceSQL DESC";
 683
 684         if (!empty($this->aFullNameAddress)) {
 685             $sExactMatchSQL = ' ( ';
 686             $sExactMatchSQL .= ' SELECT count(*) FROM ( ';
 687             $sExactMatchSQL .= '  SELECT unnest('.getArraySQL($this->aFullNameAddress).')';
 688             $sExactMatchSQL .= '    INTERSECT ';
 689             $sExactMatchSQL .= '  SELECT unnest(nameaddress_vector)';
 690             $sExactMatchSQL .= ' ) s';
 691             $sExactMatchSQL .= ') as exactmatch';
 692             $aOrder[] = 'exactmatch DESC';
 693         } else {
 694             $sExactMatchSQL = '0::int as exactmatch';
 695         }
 696
 697         if ($this->sHouseNumber || $this->sClass) {
 698             $iLimit = 20;
 699         }
 700
 701         $aResults = array();
 702
 703         if (!empty($aTerms)) {
 704             $sSQL = 'SELECT place_id,'.$sExactMatchSQL;
 705             $sSQL .= ' FROM search_name';
 706             $sSQL .= ' WHERE '.join(' and ', $aTerms);
 707             $sSQL .= ' ORDER BY '.join(', ', $aOrder);
 708             $sSQL .= ' LIMIT '.$iLimit;
 709
 710             if (CONST_Debug) var_dump($sSQL);
 711
 712             $aDBResults = chksql(
 713                 $oDB->getAll($sSQL),
 714                 'Could not get places for search terms.'
 715             );
 716
 717             foreach ($aDBResults as $aResult) {
 718                 $oResult = new Result($aResult['place_id']);
 719                 $oResult->iExactMatches = $aResult['exactmatch'];
 720                 $aResults[$aResult['place_id']] = $oResult;
 721             }
 722         }
 723
 724         return $aResults;
 725     }
 726
 727     private function queryHouseNumber(&$oDB, $aRoadPlaceIDs, $iLimit)
 728     {
 729         $aResults = array();
 730         $sPlaceIDs = Result::joinIdsByTable($aRoadPlaceIDs, Result::TABLE_PLACEX);
 731
 732         if (!$sPlaceIDs) {
 733             return $aResults;
 734         }
 735
 736         $sHouseNumberRegex = '\\\\m'.$this->sHouseNumber.'\\\\M';
 737         $sSQL = 'SELECT place_id FROM placex ';
 738         $sSQL .= 'WHERE parent_place_id in ('.$sPlaceIDs.')';
 739         $sSQL .= "  AND transliteration(housenumber) ~* E'".$sHouseNumberRegex."'";
 740         $sSQL .= $this->oContext->excludeSQL(' AND place_id');
 741         $sSQL .= " LIMIT $iLimit";
 742
 743         if (CONST_Debug) var_dump($sSQL);
 744
 745         // XXX should inherit the exactMatches from its parent
 746         foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
 747             $aResults[$iPlaceId] = new Result($iPlaceId);
 748         }
 749
 750         $bIsIntHouseNumber= (bool) preg_match('/[0-9]+/', $this->sHouseNumber);
 751         $iHousenumber = intval($this->sHouseNumber);
 752         if ($bIsIntHouseNumber && empty($aResults)) {
 753             // if nothing found, search in the interpolation line table
 754             $sSQL = 'SELECT distinct place_id FROM location_property_osmline';
 755             $sSQL .= ' WHERE startnumber is not NULL';
 756             $sSQL .= '  AND parent_place_id in ('.$sPlaceIDs.') AND (';
 757             if ($iHousenumber % 2 == 0) {
 758                 // If housenumber is even, look for housenumber in streets
 759                 // with interpolationtype even or all.
 760                 $sSQL .= "interpolationtype='even'";
 761             } else {
 762                 // Else look for housenumber with interpolationtype odd or all.
 763                 $sSQL .= "interpolationtype='odd'";
 764             }
 765             $sSQL .= " or interpolationtype='all') and ";
 766             $sSQL .= $iHousenumber.'>=startnumber and ';
 767             $sSQL .= $iHousenumber.'<=endnumber';
 768             $sSQL .= $this->oContext->excludeSQL(' AND place_id');
 769             $sSQL .= " limit $iLimit";
 770
 771             if (CONST_Debug) var_dump($sSQL);
 772
 773             foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
 774                 $oResult = new Result($iPlaceId, Result::TABLE_OSMLINE);
 775                 $oResult->iHouseNumber = $iHousenumber;
 776                 $aResults[$iPlaceId] = $oResult;
 777             }
 778         }
 779
 780         // If nothing found try the aux fallback table
 781         if (CONST_Use_Aux_Location_data && empty($aResults)) {
 782             $sSQL = 'SELECT place_id FROM location_property_aux';
 783             $sSQL .= ' WHERE parent_place_id in ('.$sPlaceIDs.')';
 784             $sSQL .= " AND housenumber = '".$this->sHouseNumber."'";
 785             $sSQL .= $this->oContext->excludeSQL(' AND place_id');
 786             $sSQL .= " limit $iLimit";
 787
 788             if (CONST_Debug) var_dump($sSQL);
 789
 790             foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
 791                 $aResults[$iPlaceId] = new Result($iPlaceId, Result::TABLE_AUX);
 792             }
 793         }
 794
 795         // If nothing found then search in Tiger data (location_property_tiger)
 796         if (CONST_Use_US_Tiger_Data && $bIsIntHouseNumber && empty($aResults)) {
 797             $sSQL = 'SELECT place_id FROM location_property_tiger';
 798             $sSQL .= ' WHERE parent_place_id in ('.$sPlaceIDs.') and (';
 799             if ($iHousenumber % 2 == 0) {
 800                 $sSQL .= "interpolationtype='even'";
 801             } else {
 802                 $sSQL .= "interpolationtype='odd'";
 803             }
 804             $sSQL .= " or interpolationtype='all') and ";
 805             $sSQL .= $iHousenumber.'>=startnumber and ';
 806             $sSQL .= $iHousenumber.'<=endnumber';
 807             $sSQL .= $this->oContext->excludeSQL(' AND place_id');
 808             $sSQL .= " limit $iLimit";
 809
 810             if (CONST_Debug) var_dump($sSQL);
 811
 812             foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
 813                 $oResult = new Result($iPlaceId, Result::TABLE_TIGER);
 814                 $oResult->iHouseNumber = $iHousenumber;
 815                 $aResults[$iPlaceId] = $oResult;
 816             }
 817         }
 818
 819         return $aResults;
 820     }
 821
 822
 823     private function queryPoiByOperator(&$oDB, $aParentIDs, $iLimit)
 824     {
 825         $aResults = array();
 826         $sPlaceIDs = Result::joinIdsByTable($aParentIDs, Result::TABLE_PLACEX);
 827
 828         if (!$sPlaceIDs) {
 829             return $aResults;
 830         }
 831
 832         if ($this->iOperator == Operator::TYPE || $this->iOperator == Operator::NAME) {
 833             // If they were searching for a named class (i.e. 'Kings Head pub')
 834             // then we might have an extra match
 835             $sSQL = 'SELECT place_id FROM placex ';
 836             $sSQL .= " WHERE place_id in ($sPlaceIDs)";
 837             $sSQL .= "   AND class='".$this->sClass."' ";
 838             $sSQL .= "   AND type='".$this->sType."'";
 839             $sSQL .= '   AND linked_place_id is null';
 840             $sSQL .= $this->oContext->excludeSQL(' AND place_id');
 841             $sSQL .= ' ORDER BY rank_search ASC ';
 842             $sSQL .= " LIMIT $iLimit";
 843
 844             if (CONST_Debug) var_dump($sSQL);
 845
 846             foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
 847                 $aResults[$iPlaceId] = new Result($iPlaceId);
 848             }
 849         }
 850
 851         // NEAR and IN are handled the same
 852         if ($this->iOperator == Operator::TYPE || $this->iOperator == Operator::NEAR) {
 853             $sClassTable = $this->poiTable();
 854             $sSQL = "SELECT count(*) FROM pg_tables WHERE tablename = '$sClassTable'";
 855             $bCacheTable = (bool) chksql($oDB->getOne($sSQL));
 856
 857             $sSQL = "SELECT min(rank_search) FROM placex WHERE place_id in ($sPlaceIDs)";
 858             if (CONST_Debug) var_dump($sSQL);
 859             $iMaxRank = (int)chksql($oDB->getOne($sSQL));
 860
 861             // For state / country level searches the normal radius search doesn't work very well
 862             $sPlaceGeom = false;
 863             if ($iMaxRank < 9 && $bCacheTable) {
 864                 // Try and get a polygon to search in instead
 865                 $sSQL = 'SELECT geometry FROM placex';
 866                 $sSQL .= " WHERE place_id in ($sPlaceIDs)";
 867                 $sSQL .= "   AND rank_search < $iMaxRank + 5";
 868                 $sSQL .= "   AND ST_GeometryType(geometry) in ('ST_Polygon','ST_MultiPolygon')";
 869                 $sSQL .= ' ORDER BY rank_search ASC ';
 870                 $sSQL .= ' LIMIT 1';
 871                 if (CONST_Debug) var_dump($sSQL);
 872                 $sPlaceGeom = chksql($oDB->getOne($sSQL));
 873             }
 874
 875             if ($sPlaceGeom) {
 876                 $sPlaceIDs = false;
 877             } else {
 878                 $iMaxRank += 5;
 879                 $sSQL = 'SELECT place_id FROM placex';
 880                 $sSQL .= " WHERE place_id in ($sPlaceIDs) and rank_search < $iMaxRank";
 881                 if (CONST_Debug) var_dump($sSQL);
 882                 $aPlaceIDs = chksql($oDB->getCol($sSQL));
 883                 $sPlaceIDs = join(',', $aPlaceIDs);
 884             }
 885
 886             if ($sPlaceIDs || $sPlaceGeom) {
 887                 $fRange = 0.01;
 888                 if ($bCacheTable) {
 889                     // More efficient - can make the range bigger
 890                     $fRange = 0.05;
 891
 892                     $sOrderBySQL = '';
 893                     if ($this->oContext->hasNearPoint()) {
 894                         $sOrderBySQL = $this->oContext->distanceSQL('l.centroid');
 895                     } elseif ($sPlaceIDs) {
 896                         $sOrderBySQL = 'ST_Distance(l.centroid, f.geometry)';
 897                     } elseif ($sPlaceGeom) {
 898                         $sOrderBySQL = "ST_Distance(st_centroid('".$sPlaceGeom."'), l.centroid)";
 899                     }
 900
 901                     $sSQL = 'SELECT distinct i.place_id';
 902                     if ($sOrderBySQL) {
 903                         $sSQL .= ', i.order_term';
 904                     }
 905                     $sSQL .= ' from (SELECT l.place_id';
 906                     if ($sOrderBySQL) {
 907                         $sSQL .= ','.$sOrderBySQL.' as order_term';
 908                     }
 909                     $sSQL .= ' from '.$sClassTable.' as l';
 910
 911                     if ($sPlaceIDs) {
 912                         $sSQL .= ',placex as f WHERE ';
 913                         $sSQL .= "f.place_id in ($sPlaceIDs) ";
 914                         $sSQL .= " AND ST_DWithin(l.centroid, f.centroid, $fRange)";
 915                     } elseif ($sPlaceGeom) {
 916                         $sSQL .= " WHERE ST_Contains('$sPlaceGeom', l.centroid)";
 917                     }
 918
 919                     $sSQL .= $this->oContext->excludeSQL(' AND l.place_id');
 920                     $sSQL .= 'limit 300) i ';
 921                     if ($sOrderBySQL) {
 922                         $sSQL .= 'order by order_term asc';
 923                     }
 924                     $sSQL .= " limit $iLimit";
 925
 926                     if (CONST_Debug) var_dump($sSQL);
 927
 928                     foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
 929                         $aResults[$iPlaceId] = new Result($iPlaceId);
 930                     }
 931                 } else {
 932                     if ($this->oContext->hasNearPoint()) {
 933                         $fRange = $this->oContext->nearRadius();
 934                     }
 935
 936                     $sOrderBySQL = '';
 937                     if ($this->oContext->hasNearPoint()) {
 938                         $sOrderBySQL = $this->oContext->distanceSQL('l.geometry');
 939                     } else {
 940                         $sOrderBySQL = 'ST_Distance(l.geometry, f.geometry)';
 941                     }
 942
 943                     $sSQL = 'SELECT distinct l.place_id';
 944                     if ($sOrderBySQL) {
 945                         $sSQL .= ','.$sOrderBySQL.' as orderterm';
 946                     }
 947                     $sSQL .= ' FROM placex as l, placex as f';
 948                     $sSQL .= " WHERE f.place_id in ($sPlaceIDs)";
 949                     $sSQL .= "  AND ST_DWithin(l.geometry, f.centroid, $fRange)";
 950                     $sSQL .= "  AND l.class='".$this->sClass."'";
 951                     $sSQL .= "  AND l.type='".$this->sType."'";
 952                     $sSQL .= $this->oContext->excludeSQL(' AND l.place_id');
 953                     if ($sOrderBySQL) {
 954                         $sSQL .= 'ORDER BY orderterm ASC';
 955                     }
 956                     $sSQL .= " limit $iLimit";
 957
 958                     if (CONST_Debug) var_dump($sSQL);
 959
 960                     foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
 961                         $aResults[$iPlaceId] = new Result($iPlaceId);
 962                     }
 963                 }
 964             }
 965         }
 966
 967         return $aResults;
 968     }
 969
 970     private function poiTable()
 971     {
 972         return 'place_classtype_'.$this->sClass.'_'.$this->sType;
 973     }
 974
 975     private function countryCodeSQL($sVar)
 976     {
 977         if ($this->sCountryCode) {
 978             return $sVar.' = \''.$this->sCountryCode."'";
 979         }
 980         if ($this->oContext->sqlCountryList) {
 981             return $sVar.' in '.$this->oContext->sqlCountryList;
 982         }
 983
 984         return '';
 985     }
 986
 987     /////////// Sort functions
 988
 989
 990     public static function bySearchRank($a, $b)
 991     {
 992         if ($a->iSearchRank == $b->iSearchRank) {
 993             return $a->iOperator + strlen($a->sHouseNumber)
 994                      - $b->iOperator - strlen($b->sHouseNumber);
 995         }
 996
 997         return $a->iSearchRank < $b->iSearchRank ? -1 : 1;
 998     }
 999
1000     //////////// Debugging functions
1001
1002
1003     public function dumpAsHtmlTableRow(&$aWordIDs)
1004     {
1005         $kf = function ($k) use (&$aWordIDs) {
1006             return $aWordIDs[$k];
1007         };
1008
1009         echo '<tr>';
1010         echo "<td>$this->iSearchRank</td>";
1011         echo '<td>'.join(', ', array_map($kf, $this->aName)).'</td>';
1012         echo '<td>'.join(', ', array_map($kf, $this->aNameNonSearch)).'</td>';
1013         echo '<td>'.join(', ', array_map($kf, $this->aAddress)).'</td>';
1014         echo '<td>'.join(', ', array_map($kf, $this->aAddressNonSearch)).'</td>';
1015         echo '<td>'.$this->sCountryCode.'</td>';
1016         echo '<td>'.Operator::toString($this->iOperator).'</td>';
1017         echo '<td>'.$this->sClass.'</td>';
1018         echo '<td>'.$this->sType.'</td>';
1019         echo '<td>'.$this->sPostcode.'</td>';
1020         echo '<td>'.$this->sHouseNumber.'</td>';
1021
1022         echo '</tr>';
1023     }
1024 }