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