lib/SearchDescription.php

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