lib-php/SearchDescription.php

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