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