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