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