lib-php/SearchDescription.php

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