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