namespace Nominatim;
-/**
- * Operators describing special searches.
- */
-abstract final class Operator
-{
- /// No operator selected.
- const NONE = -1;
- /// Search for POIs near the given place.
- const NEAR = 0;
- /// Search for POIS in the given place.
- const IN = 1;
- /// Search for POIS named as given.
- const NAME = 3;
- /// Search for postcodes.
- const POSTCODE = 4;
-}
+require_once(CONST_BasePath.'/lib/SpecialSearchOperator.php');
+require_once(CONST_BasePath.'/lib/SearchContext.php');
+require_once(CONST_BasePath.'/lib/Result.php');
/**
* Description of a single interpretation of a search query.
private $sCountryCode = '';
/// List of word ids making up the name of the object.
private $aName = array();
+ /// True if the name is rare enough to force index use on name.
+ private $bRareName = false;
/// List of word ids making up the address of the object.
private $aAddress = array();
/// Subset of word ids of full words making up the address.
private $sHouseNumber = '';
/// Postcode for the object.
private $sPostcode = '';
- /// Geographic search area.
- private $oNearPoint = false;
+ /// Global search constraints.
+ private $oContext;
// Temporary values used while creating the search description.
- /// Index of phrase currently processed
+ /// Index of phrase currently processed.
private $iNamePhrase = -1;
-};
+
+ /**
+ * Create an empty search description.
+ *
+ * @param object $oContext Global context to use. Will be inherited by
+ * all derived search objects.
+ */
+ public function __construct($oContext)
+ {
+ $this->oContext = $oContext;
+ }
+
+ /**
+ * Get current search rank.
+ *
+ * The higher the search rank the lower the likelihood that the
+ * search is a correct interpretation of the search query.
+ *
+ * @return integer Search rank.
+ */
+ public function getRank()
+ {
+ return $this->iSearchRank;
+ }
+
+ /**
+ * Make this search a POI search.
+ *
+ * In a POI search, objects are not (only) searched by their name
+ * but also by the primary OSM key/value pair (class and type in Nominatim).
+ *
+ * @param integer $iOperator Type of POI search
+ * @param string $sClass Class (or OSM tag key) of POI.
+ * @param string $sType Type (or OSM tag value) of POI.
+ *
+ * @return void
+ */
+ public function setPoiSearch($iOperator, $sClass, $sType)
+ {
+ $this->iOperator = $iOperator;
+ $this->sClass = $sClass;
+ $this->sType = $sType;
+ }
+
+ /**
+ * Check if this might be a full address search.
+ *
+ * @return bool True if the search contains name, address and housenumber.
+ */
+ public function looksLikeFullAddress()
+ {
+ return (!empty($this->aName))
+ && (!empty($this->aAddress) || $this->sCountryCode)
+ && preg_match('/[0-9]+/', $this->sHouseNumber);
+ }
+
+ /**
+ * Check if any operator is set.
+ *
+ * @return bool True, if this is a special search operation.
+ */
+ public function hasOperator()
+ {
+ return $this->iOperator != Operator::NONE;
+ }
+
+ /**
+ * Extract key/value pairs from a query.
+ *
+ * Key/value pairs are recognised if they are of the form [<key>=<value>].
+ * If multiple terms of this kind are found then all terms are removed
+ * but only the first is used for search.
+ *
+ * @param string $sQuery Original query string.
+ *
+ * @return string The query string with the special search patterns removed.
+ */
+ public function extractKeyValuePairs($sQuery)
+ {
+ // Search for terms of kind [<key>=<value>].
+ preg_match_all(
+ '/\\[([\\w_]*)=([\\w_]*)\\]/',
+ $sQuery,
+ $aSpecialTermsRaw,
+ PREG_SET_ORDER
+ );
+
+ foreach ($aSpecialTermsRaw as $aTerm) {
+ $sQuery = str_replace($aTerm[0], ' ', $sQuery);
+ if (!$this->hasOperator()) {
+ $this->setPoiSearch(Operator::TYPE, $aTerm[1], $aTerm[2]);
+ }
+ }
+
+ return $sQuery;
+ }
+
+ /**
+ * Check if the combination of parameters is sensible.
+ *
+ * @return bool True, if the search looks valid.
+ */
+ public function isValidSearch()
+ {
+ if (empty($this->aName)) {
+ if ($this->sHouseNumber) {
+ return false;
+ }
+ if (!$this->sClass && !$this->sCountryCode) {
+ return false;
+ }
+ }
+
+ return true;
+ }
+
+ /////////// Search building functions
+
+
+ /**
+ * Derive new searches by adding a full term to the existing search.
+ *
+ * @param object $oSearchTerm Description of the token.
+ * @param bool $bHasPartial True if there are also tokens of partial terms
+ * with the same name.
+ * @param string $sPhraseType Type of phrase the token is contained in.
+ * @param bool $bFirstToken True if the token is at the beginning of the
+ * query.
+ * @param bool $bFirstPhrase True if the token is in the first phrase of
+ * the query.
+ * @param bool $bLastToken True if the token is at the end of the query.
+ *
+ * @return SearchDescription[] List of derived search descriptions.
+ */
+ public function extendWithFullTerm($oSearchTerm, $bHasPartial, $sPhraseType, $bFirstToken, $bFirstPhrase, $bLastToken)
+ {
+ $aNewSearches = array();
+
+ if (($sPhraseType == '' || $sPhraseType == 'country')
+ && is_a($oSearchTerm, '\Nominatim\Token\Country')
+ ) {
+ if (!$this->sCountryCode) {
+ $oSearch = clone $this;
+ $oSearch->iSearchRank++;
+ $oSearch->sCountryCode = $oSearchTerm->sCountryCode;
+ // Country is almost always at the end of the string
+ // - increase score for finding it anywhere else (optimisation)
+ if (!$bLastToken) {
+ $oSearch->iSearchRank += 5;
+ }
+ $aNewSearches[] = $oSearch;
+ }
+ } elseif (($sPhraseType == '' || $sPhraseType == 'postalcode')
+ && is_a($oSearchTerm, '\Nominatim\Token\Postcode')
+ ) {
+ // We need to try the case where the postal code is the primary element
+ // (i.e. no way to tell if it is (postalcode, city) OR (city, postalcode)
+ // so try both.
+ if (!$this->sPostcode) {
+ // If we have structured search or this is the first term,
+ // make the postcode the primary search element.
+ if ($this->iOperator == Operator::NONE
+ && ($sPhraseType == 'postalcode' || $bFirstToken)
+ ) {
+ $oSearch = clone $this;
+ $oSearch->iSearchRank++;
+ $oSearch->iOperator = Operator::POSTCODE;
+ $oSearch->aAddress = array_merge($this->aAddress, $this->aName);
+ $oSearch->aName =
+ array($oSearchTerm->iId => $oSearchTerm->sPostcode);
+ $aNewSearches[] = $oSearch;
+ }
+
+ // If we have a structured search or this is not the first term,
+ // add the postcode as an addendum.
+ if ($this->iOperator != Operator::POSTCODE
+ && ($sPhraseType == 'postalcode' || !empty($this->aName))
+ ) {
+ $oSearch = clone $this;
+ $oSearch->iSearchRank++;
+ $oSearch->sPostcode = $oSearchTerm->sPostcode;
+ $aNewSearches[] = $oSearch;
+ }
+ }
+ } elseif (($sPhraseType == '' || $sPhraseType == 'street')
+ && is_a($oSearchTerm, '\Nominatim\Token\HouseNumber')
+ ) {
+ if (!$this->sHouseNumber && $this->iOperator != Operator::POSTCODE) {
+ $oSearch = clone $this;
+ $oSearch->iSearchRank++;
+ $oSearch->sHouseNumber = $oSearchTerm->sToken;
+ // sanity check: if the housenumber is not mainly made
+ // up of numbers, add a penalty
+ if (preg_match('/\\d/', $oSearch->sHouseNumber) === 0
+ || preg_match_all('/[^0-9]/', $oSearch->sHouseNumber, $aMatches) > 2) {
+ $oSearch->iSearchRank++;
+ }
+ if (empty($oSearchTerm->iId)) {
+ $oSearch->iSearchRank++;
+ }
+ // also must not appear in the middle of the address
+ if (!empty($this->aAddress)
+ || (!empty($this->aAddressNonSearch))
+ || $this->sPostcode
+ ) {
+ $oSearch->iSearchRank++;
+ }
+ $aNewSearches[] = $oSearch;
+ }
+ } elseif ($sPhraseType == ''
+ && is_a($oSearchTerm, '\Nominatim\Token\SpecialTerm')
+ ) {
+ if ($this->iOperator == Operator::NONE) {
+ $oSearch = clone $this;
+ $oSearch->iSearchRank++;
+
+ $iOp = $oSearchTerm->iOperator;
+ if ($iOp == Operator::NONE) {
+ if (!empty($this->aName) || $this->oContext->isBoundedSearch()) {
+ $iOp = Operator::NAME;
+ } else {
+ $iOp = Operator::NEAR;
+ }
+ $oSearch->iSearchRank += 2;
+ }
+
+ $oSearch->setPoiSearch(
+ $iOp,
+ $oSearchTerm->sClass,
+ $oSearchTerm->sType
+ );
+ $aNewSearches[] = $oSearch;
+ }
+ } elseif ($sPhraseType != 'country'
+ && is_a($oSearchTerm, '\Nominatim\Token\Word')
+ ) {
+ $iWordID = $oSearchTerm->iId;
+ // Full words can only be a name if they appear at the beginning
+ // of the phrase. In structured search the name must forcably in
+ // the first phrase. In unstructured search it may be in a later
+ // phrase when the first phrase is a house number.
+ if (!empty($this->aName) || !($bFirstPhrase || $sPhraseType == '')) {
+ if (($sPhraseType == '' || !$bFirstPhrase) && !$bHasPartial) {
+ $oSearch = clone $this;
+ $oSearch->iSearchRank += 2;
+ $oSearch->aAddress[$iWordID] = $iWordID;
+ $aNewSearches[] = $oSearch;
+ } else {
+ $this->aFullNameAddress[$iWordID] = $iWordID;
+ }
+ } else {
+ $oSearch = clone $this;
+ $oSearch->iSearchRank++;
+ $oSearch->aName = array($iWordID => $iWordID);
+ if (CONST_Search_NameOnlySearchFrequencyThreshold) {
+ $oSearch->bRareName =
+ $oSearchTerm->iSearchNameCount
+ < CONST_Search_NameOnlySearchFrequencyThreshold;
+ }
+ $aNewSearches[] = $oSearch;
+ }
+ }
+
+ return $aNewSearches;
+ }
+
+ /**
+ * Derive new searches by adding a partial term to the existing search.
+ *
+ * @param string $sToken Term for the token.
+ * @param object $oSearchTerm Description of the token.
+ * @param bool $bStructuredPhrases True if the search is structured.
+ * @param integer $iPhrase Number of the phrase the token is in.
+ * @param array[] $aFullTokens List of full term tokens with the
+ * same name.
+ *
+ * @return SearchDescription[] List of derived search descriptions.
+ */
+ public function extendWithPartialTerm($sToken, $oSearchTerm, $bStructuredPhrases, $iPhrase, $aFullTokens)
+ {
+ // Only allow name terms.
+ if (!(is_a($oSearchTerm, '\Nominatim\Token\Word'))) {
+ return array();
+ }
+
+ $aNewSearches = array();
+ $iWordID = $oSearchTerm->iId;
+
+ if ((!$bStructuredPhrases || $iPhrase > 0)
+ && (!empty($this->aName))
+ && strpos($sToken, ' ') === false
+ ) {
+ if ($oSearchTerm->iSearchNameCount < CONST_Max_Word_Frequency) {
+ $oSearch = clone $this;
+ $oSearch->iSearchRank += 2;
+ $oSearch->aAddress[$iWordID] = $iWordID;
+ $aNewSearches[] = $oSearch;
+ } else {
+ $oSearch = clone $this;
+ $oSearch->iSearchRank++;
+ $oSearch->aAddressNonSearch[$iWordID] = $iWordID;
+ if (preg_match('#^[0-9]+$#', $sToken)) {
+ $oSearch->iSearchRank += 2;
+ }
+ if (!empty($aFullTokens)) {
+ $oSearch->iSearchRank++;
+ }
+ $aNewSearches[] = $oSearch;
+
+ // revert to the token version?
+ foreach ($aFullTokens as $oSearchTermToken) {
+ if (is_a($oSearchTermToken, '\Nominatim\Token\Word')) {
+ $oSearch = clone $this;
+ $oSearch->iSearchRank++;
+ $oSearch->aAddress[$oSearchTermToken->iId]
+ = $oSearchTermToken->iId;
+ $aNewSearches[] = $oSearch;
+ }
+ }
+ }
+ }
+
+ if ((!$this->sPostcode && !$this->aAddress && !$this->aAddressNonSearch)
+ && (empty($this->aName) || $this->iNamePhrase == $iPhrase)
+ ) {
+ $oSearch = clone $this;
+ $oSearch->iSearchRank += 2;
+ if (empty($this->aName)) {
+ $oSearch->iSearchRank += 1;
+ }
+ if (preg_match('#^[0-9]+$#', $sToken)) {
+ $oSearch->iSearchRank += 2;
+ }
+ if ($oSearchTerm->iSearchNameCount < CONST_Max_Word_Frequency) {
+ if (empty($this->aName)
+ && CONST_Search_NameOnlySearchFrequencyThreshold
+ ) {
+ $oSearch->bRareName =
+ $oSearchTerm->iSearchNameCount
+ < CONST_Search_NameOnlySearchFrequencyThreshold;
+ } else {
+ $oSearch->bRareName = false;
+ }
+ $oSearch->aName[$iWordID] = $iWordID;
+ } else {
+ $oSearch->aNameNonSearch[$iWordID] = $iWordID;
+ }
+ $oSearch->iNamePhrase = $iPhrase;
+ $aNewSearches[] = $oSearch;
+ }
+
+ return $aNewSearches;
+ }
+
+ /////////// Query functions
+
+
+ /**
+ * Query database for places that match this search.
+ *
+ * @param object $oDB Nominatim::DB instance to use.
+ * @param integer $iMinRank Minimum address rank to restrict search to.
+ * @param integer $iMaxRank Maximum address rank to restrict search to.
+ * @param integer $iLimit Maximum number of results.
+ *
+ * @return mixed[] An array with two fields: IDs contains the list of
+ * matching place IDs and houseNumber the houseNumber
+ * if appicable or -1 if not.
+ */
+ public function query(&$oDB, $iMinRank, $iMaxRank, $iLimit)
+ {
+ $aResults = array();
+ $iHousenumber = -1;
+
+ if ($this->sCountryCode
+ && empty($this->aName)
+ && !$this->iOperator
+ && !$this->sClass
+ && !$this->oContext->hasNearPoint()
+ ) {
+ // Just looking for a country - look it up
+ if (4 >= $iMinRank && 4 <= $iMaxRank) {
+ $aResults = $this->queryCountry($oDB);
+ }
+ } elseif (empty($this->aName) && empty($this->aAddress)) {
+ // Neither name nor address? Then we must be
+ // looking for a POI in a geographic area.
+ if ($this->oContext->isBoundedSearch()) {
+ $aResults = $this->queryNearbyPoi($oDB, $iLimit);
+ }
+ } elseif ($this->iOperator == Operator::POSTCODE) {
+ // looking for postcode
+ $aResults = $this->queryPostcode($oDB, $iLimit);
+ } else {
+ // Ordinary search:
+ // First search for places according to name and address.
+ $aResults = $this->queryNamedPlace(
+ $oDB,
+ $iMinRank,
+ $iMaxRank,
+ $iLimit
+ );
+
+ // Now search for housenumber, if housenumber provided. Can be zero.
+ if (($this->sHouseNumber || $this->sHouseNumber === '0') && !empty($aResults)) {
+ // Downgrade the rank of the street results, they are missing
+ // the housenumber.
+ foreach ($aResults as $oRes) {
+ $oRes->iResultRank++;
+ }
+
+ $aHnResults = $this->queryHouseNumber($oDB, $aResults);
+
+ if (!empty($aHnResults)) {
+ foreach ($aHnResults as $oRes) {
+ $aResults[$oRes->iId] = $oRes;
+ }
+ }
+ }
+
+ // finally get POIs if requested
+ if ($this->sClass && !empty($aResults)) {
+ $aResults = $this->queryPoiByOperator($oDB, $aResults, $iLimit);
+ }
+ }
+
+ Debug::printDebugTable('Place IDs', $aResults);
+
+ if (!empty($aResults) && $this->sPostcode) {
+ $sPlaceIds = Result::joinIdsByTable($aResults, Result::TABLE_PLACEX);
+ if ($sPlaceIds) {
+ $sSQL = 'SELECT place_id FROM placex';
+ $sSQL .= ' WHERE place_id in ('.$sPlaceIds.')';
+ $sSQL .= " AND postcode != '".$this->sPostcode."'";
+ Debug::printSQL($sSQL);
+ $aFilteredPlaceIDs = $oDB->getCol($sSQL);
+ if ($aFilteredPlaceIDs) {
+ foreach ($aFilteredPlaceIDs as $iPlaceId) {
+ $aResults[$iPlaceId]->iResultRank++;
+ }
+ }
+ }
+ }
+
+ return $aResults;
+ }
+
+
+ private function queryCountry(&$oDB)
+ {
+ $sSQL = 'SELECT place_id FROM placex ';
+ $sSQL .= "WHERE country_code='".$this->sCountryCode."'";
+ $sSQL .= ' AND rank_search = 4';
+ if ($this->oContext->bViewboxBounded) {
+ $sSQL .= ' AND ST_Intersects('.$this->oContext->sqlViewboxSmall.', geometry)';
+ }
+ $sSQL .= ' ORDER BY st_area(geometry) DESC LIMIT 1';
+
+ Debug::printSQL($sSQL);
+
+ $iPlaceId = $oDB->getOne($sSQL);
+
+ $aResults = array();
+ if ($iPlaceId) {
+ $aResults[$iPlaceId] = new Result($iPlaceId);
+ }
+
+ return $aResults;
+ }
+
+ private function queryNearbyPoi(&$oDB, $iLimit)
+ {
+ if (!$this->sClass) {
+ return array();
+ }
+
+ $aDBResults = array();
+ $sPoiTable = $this->poiTable();
+
+ if ($oDB->tableExists($sPoiTable)) {
+ $sSQL = 'SELECT place_id FROM '.$sPoiTable.' ct';
+ if ($this->oContext->sqlCountryList) {
+ $sSQL .= ' JOIN placex USING (place_id)';
+ }
+ if ($this->oContext->hasNearPoint()) {
+ $sSQL .= ' WHERE '.$this->oContext->withinSQL('ct.centroid');
+ } elseif ($this->oContext->bViewboxBounded) {
+ $sSQL .= ' WHERE ST_Contains('.$this->oContext->sqlViewboxSmall.', ct.centroid)';
+ }
+ if ($this->oContext->sqlCountryList) {
+ $sSQL .= ' AND country_code in '.$this->oContext->sqlCountryList;
+ }
+ $sSQL .= $this->oContext->excludeSQL(' AND place_id');
+ if ($this->oContext->sqlViewboxCentre) {
+ $sSQL .= ' ORDER BY ST_Distance(';
+ $sSQL .= $this->oContext->sqlViewboxCentre.', ct.centroid) ASC';
+ } elseif ($this->oContext->hasNearPoint()) {
+ $sSQL .= ' ORDER BY '.$this->oContext->distanceSQL('ct.centroid').' ASC';
+ }
+ $sSQL .= " LIMIT $iLimit";
+ Debug::printSQL($sSQL);
+ $aDBResults = $oDB->getCol($sSQL);
+ }
+
+ if ($this->oContext->hasNearPoint()) {
+ $sSQL = 'SELECT place_id FROM placex WHERE ';
+ $sSQL .= 'class = :class and type = :type';
+ $sSQL .= ' AND '.$this->oContext->withinSQL('geometry');
+ $sSQL .= ' AND linked_place_id is null';
+ if ($this->oContext->sqlCountryList) {
+ $sSQL .= ' AND country_code in '.$this->oContext->sqlCountryList;
+ }
+ $sSQL .= ' ORDER BY '.$this->oContext->distanceSQL('centroid').' ASC';
+ $sSQL .= " LIMIT $iLimit";
+ Debug::printSQL($sSQL);
+ $aDBResults = $oDB->getCol(
+ $sSQL,
+ array(':class' => $this->sClass, ':type' => $this->sType)
+ );
+ }
+
+ $aResults = array();
+ foreach ($aDBResults as $iPlaceId) {
+ $aResults[$iPlaceId] = new Result($iPlaceId);
+ }
+
+ return $aResults;
+ }
+
+ private function queryPostcode(&$oDB, $iLimit)
+ {
+ $sSQL = 'SELECT p.place_id FROM location_postcode p ';
+
+ if (!empty($this->aAddress)) {
+ $sSQL .= ', search_name s ';
+ $sSQL .= 'WHERE s.place_id = p.parent_place_id ';
+ $sSQL .= 'AND array_cat(s.nameaddress_vector, s.name_vector)';
+ $sSQL .= ' @> '.$oDB->getArraySQL($this->aAddress).' AND ';
+ } else {
+ $sSQL .= 'WHERE ';
+ }
+
+ $sSQL .= "p.postcode = '".reset($this->aName)."'";
+ $sSQL .= $this->countryCodeSQL(' AND p.country_code');
+ if ($this->oContext->bViewboxBounded) {
+ $sSQL .= ' AND ST_Intersects('.$this->oContext->sqlViewboxSmall.', geometry)';
+ }
+ $sSQL .= $this->oContext->excludeSQL(' AND p.place_id');
+ $sSQL .= " LIMIT $iLimit";
+
+ Debug::printSQL($sSQL);
+
+ $aResults = array();
+ foreach ($oDB->getCol($sSQL) as $iPlaceId) {
+ $aResults[$iPlaceId] = new Result($iPlaceId, Result::TABLE_POSTCODE);
+ }
+
+ return $aResults;
+ }
+
+ private function queryNamedPlace(&$oDB, $iMinAddressRank, $iMaxAddressRank, $iLimit)
+ {
+ $aTerms = array();
+ $aOrder = array();
+
+ // Sort by existence of the requested house number but only if not
+ // too many results are expected for the street, i.e. if the result
+ // will be narrowed down by an address. Remeber that with ordering
+ // every single result has to be checked.
+ if ($this->sHouseNumber && (!empty($this->aAddress) || $this->sPostcode)) {
+ $sHouseNumberRegex = '\\\\m'.$this->sHouseNumber.'\\\\M';
+ $aOrder[] = ' (';
+ $aOrder[0] .= 'EXISTS(';
+ $aOrder[0] .= ' SELECT place_id';
+ $aOrder[0] .= ' FROM placex';
+ $aOrder[0] .= ' WHERE parent_place_id = search_name.place_id';
+ $aOrder[0] .= " AND transliteration(housenumber) ~* E'".$sHouseNumberRegex."'";
+ $aOrder[0] .= ' LIMIT 1';
+ $aOrder[0] .= ') ';
+ // also housenumbers from interpolation lines table are needed
+ if (preg_match('/[0-9]+/', $this->sHouseNumber)) {
+ $iHouseNumber = intval($this->sHouseNumber);
+ $aOrder[0] .= 'OR EXISTS(';
+ $aOrder[0] .= ' SELECT place_id ';
+ $aOrder[0] .= ' FROM location_property_osmline ';
+ $aOrder[0] .= ' WHERE parent_place_id = search_name.place_id';
+ $aOrder[0] .= ' AND startnumber is not NULL';
+ $aOrder[0] .= ' AND '.$iHouseNumber.'>=startnumber ';
+ $aOrder[0] .= ' AND '.$iHouseNumber.'<=endnumber ';
+ $aOrder[0] .= ' LIMIT 1';
+ $aOrder[0] .= ')';
+ }
+ $aOrder[0] .= ') DESC';
+ }
+
+ if (!empty($this->aName)) {
+ $aTerms[] = 'name_vector @> '.$oDB->getArraySQL($this->aName);
+ }
+ if (!empty($this->aAddress)) {
+ // For infrequent name terms disable index usage for address
+ if ($this->bRareName) {
+ $aTerms[] = 'array_cat(nameaddress_vector,ARRAY[]::integer[]) @> '.$oDB->getArraySQL($this->aAddress);
+ } else {
+ $aTerms[] = 'nameaddress_vector @> '.$oDB->getArraySQL($this->aAddress);
+ }
+ }
+
+ $sCountryTerm = $this->countryCodeSQL('country_code');
+ if ($sCountryTerm) {
+ $aTerms[] = $sCountryTerm;
+ }
+
+ if ($this->sHouseNumber) {
+ $aTerms[] = 'address_rank between 16 and 27';
+ } elseif (!$this->sClass || $this->iOperator == Operator::NAME) {
+ if ($iMinAddressRank > 0) {
+ $aTerms[] = "((address_rank between $iMinAddressRank and $iMaxAddressRank) or (search_rank between $iMinAddressRank and $iMaxAddressRank))";
+ }
+ }
+
+ if ($this->oContext->hasNearPoint()) {
+ $aTerms[] = $this->oContext->withinSQL('centroid');
+ $aOrder[] = $this->oContext->distanceSQL('centroid');
+ } elseif ($this->sPostcode) {
+ if (empty($this->aAddress)) {
+ $aTerms[] = "EXISTS(SELECT place_id FROM location_postcode p WHERE p.postcode = '".$this->sPostcode."' AND ST_DWithin(search_name.centroid, p.geometry, 0.1))";
+ } else {
+ $aOrder[] = "(SELECT min(ST_Distance(search_name.centroid, p.geometry)) FROM location_postcode p WHERE p.postcode = '".$this->sPostcode."')";
+ }
+ }
+
+ $sExcludeSQL = $this->oContext->excludeSQL('place_id');
+ if ($sExcludeSQL) {
+ $aTerms[] = $sExcludeSQL;
+ }
+
+ if ($this->oContext->bViewboxBounded) {
+ $aTerms[] = 'centroid && '.$this->oContext->sqlViewboxSmall;
+ }
+
+ if ($this->oContext->hasNearPoint()) {
+ $aOrder[] = $this->oContext->distanceSQL('centroid');
+ }
+
+ if ($this->sHouseNumber) {
+ $sImportanceSQL = '- abs(26 - address_rank) + 3';
+ } else {
+ $sImportanceSQL = '(CASE WHEN importance = 0 OR importance IS NULL THEN 0.75001-(search_rank::float/40) ELSE importance END)';
+ }
+ $sImportanceSQL .= $this->oContext->viewboxImportanceSQL('centroid');
+ $aOrder[] = "$sImportanceSQL DESC";
+
+ if (!empty($this->aFullNameAddress)) {
+ $sExactMatchSQL = ' ( ';
+ $sExactMatchSQL .= ' SELECT count(*) FROM ( ';
+ $sExactMatchSQL .= ' SELECT unnest('.$oDB->getArraySQL($this->aFullNameAddress).')';
+ $sExactMatchSQL .= ' INTERSECT ';
+ $sExactMatchSQL .= ' SELECT unnest(nameaddress_vector)';
+ $sExactMatchSQL .= ' ) s';
+ $sExactMatchSQL .= ') as exactmatch';
+ $aOrder[] = 'exactmatch DESC';
+ } else {
+ $sExactMatchSQL = '0::int as exactmatch';
+ }
+
+ if ($this->sHouseNumber || $this->sClass) {
+ $iLimit = 40;
+ }
+
+ $aResults = array();
+
+ if (!empty($aTerms)) {
+ $sSQL = 'SELECT place_id,'.$sExactMatchSQL;
+ $sSQL .= ' FROM search_name';
+ $sSQL .= ' WHERE '.join(' and ', $aTerms);
+ $sSQL .= ' ORDER BY '.join(', ', $aOrder);
+ $sSQL .= ' LIMIT '.$iLimit;
+
+ Debug::printSQL($sSQL);
+
+ $aDBResults = $oDB->getAll($sSQL, null, 'Could not get places for search terms.');
+
+ foreach ($aDBResults as $aResult) {
+ $oResult = new Result($aResult['place_id']);
+ $oResult->iExactMatches = $aResult['exactmatch'];
+ $aResults[$aResult['place_id']] = $oResult;
+ }
+ }
+
+ return $aResults;
+ }
+
+ private function queryHouseNumber(&$oDB, $aRoadPlaceIDs)
+ {
+ $aResults = array();
+ $sPlaceIDs = Result::joinIdsByTable($aRoadPlaceIDs, Result::TABLE_PLACEX);
+
+ if (!$sPlaceIDs) {
+ return $aResults;
+ }
+
+ $sHouseNumberRegex = '\\\\m'.$this->sHouseNumber.'\\\\M';
+ $sSQL = 'SELECT place_id FROM placex ';
+ $sSQL .= 'WHERE parent_place_id in ('.$sPlaceIDs.')';
+ $sSQL .= " AND transliteration(housenumber) ~* E'".$sHouseNumberRegex."'";
+ $sSQL .= $this->oContext->excludeSQL(' AND place_id');
+
+ Debug::printSQL($sSQL);
+
+ // XXX should inherit the exactMatches from its parent
+ foreach ($oDB->getCol($sSQL) as $iPlaceId) {
+ $aResults[$iPlaceId] = new Result($iPlaceId);
+ }
+
+ $bIsIntHouseNumber= (bool) preg_match('/[0-9]+/', $this->sHouseNumber);
+ $iHousenumber = intval($this->sHouseNumber);
+ if ($bIsIntHouseNumber && empty($aResults)) {
+ // if nothing found, search in the interpolation line table
+ $sSQL = 'SELECT distinct place_id FROM location_property_osmline';
+ $sSQL .= ' WHERE startnumber is not NULL';
+ $sSQL .= ' AND parent_place_id in ('.$sPlaceIDs.') AND (';
+ if ($iHousenumber % 2 == 0) {
+ // If housenumber is even, look for housenumber in streets
+ // with interpolationtype even or all.
+ $sSQL .= "interpolationtype='even'";
+ } else {
+ // Else look for housenumber with interpolationtype odd or all.
+ $sSQL .= "interpolationtype='odd'";
+ }
+ $sSQL .= " or interpolationtype='all') and ";
+ $sSQL .= $iHousenumber.'>=startnumber and ';
+ $sSQL .= $iHousenumber.'<=endnumber';
+ $sSQL .= $this->oContext->excludeSQL(' AND place_id');
+
+ Debug::printSQL($sSQL);
+
+ foreach ($oDB->getCol($sSQL) as $iPlaceId) {
+ $oResult = new Result($iPlaceId, Result::TABLE_OSMLINE);
+ $oResult->iHouseNumber = $iHousenumber;
+ $aResults[$iPlaceId] = $oResult;
+ }
+ }
+
+ // If nothing found try the aux fallback table
+ if (CONST_Use_Aux_Location_data && empty($aResults)) {
+ $sSQL = 'SELECT place_id FROM location_property_aux';
+ $sSQL .= ' WHERE parent_place_id in ('.$sPlaceIDs.')';
+ $sSQL .= " AND housenumber = '".$this->sHouseNumber."'";
+ $sSQL .= $this->oContext->excludeSQL(' AND place_id');
+
+ Debug::printSQL($sSQL);
+
+ foreach ($oDB->getCol($sSQL) as $iPlaceId) {
+ $aResults[$iPlaceId] = new Result($iPlaceId, Result::TABLE_AUX);
+ }
+ }
+
+ // If nothing found then search in Tiger data (location_property_tiger)
+ if (CONST_Use_US_Tiger_Data && $bIsIntHouseNumber && empty($aResults)) {
+ $sSQL = 'SELECT place_id FROM location_property_tiger';
+ $sSQL .= ' WHERE parent_place_id in ('.$sPlaceIDs.') and (';
+ if ($iHousenumber % 2 == 0) {
+ $sSQL .= "interpolationtype='even'";
+ } else {
+ $sSQL .= "interpolationtype='odd'";
+ }
+ $sSQL .= " or interpolationtype='all') and ";
+ $sSQL .= $iHousenumber.'>=startnumber and ';
+ $sSQL .= $iHousenumber.'<=endnumber';
+ $sSQL .= $this->oContext->excludeSQL(' AND place_id');
+
+ Debug::printSQL($sSQL);
+
+ foreach ($oDB->getCol($sSQL) as $iPlaceId) {
+ $oResult = new Result($iPlaceId, Result::TABLE_TIGER);
+ $oResult->iHouseNumber = $iHousenumber;
+ $aResults[$iPlaceId] = $oResult;
+ }
+ }
+
+ return $aResults;
+ }
+
+
+ private function queryPoiByOperator(&$oDB, $aParentIDs, $iLimit)
+ {
+ $aResults = array();
+ $sPlaceIDs = Result::joinIdsByTable($aParentIDs, Result::TABLE_PLACEX);
+
+ if (!$sPlaceIDs) {
+ return $aResults;
+ }
+
+ if ($this->iOperator == Operator::TYPE || $this->iOperator == Operator::NAME) {
+ // If they were searching for a named class (i.e. 'Kings Head pub')
+ // then we might have an extra match
+ $sSQL = 'SELECT place_id FROM placex ';
+ $sSQL .= " WHERE place_id in ($sPlaceIDs)";
+ $sSQL .= " AND class='".$this->sClass."' ";
+ $sSQL .= " AND type='".$this->sType."'";
+ $sSQL .= ' AND linked_place_id is null';
+ $sSQL .= $this->oContext->excludeSQL(' AND place_id');
+ $sSQL .= ' ORDER BY rank_search ASC ';
+ $sSQL .= " LIMIT $iLimit";
+
+ Debug::printSQL($sSQL);
+
+ foreach ($oDB->getCol($sSQL) as $iPlaceId) {
+ $aResults[$iPlaceId] = new Result($iPlaceId);
+ }
+ }
+
+ // NEAR and IN are handled the same
+ if ($this->iOperator == Operator::TYPE || $this->iOperator == Operator::NEAR) {
+ $sClassTable = $this->poiTable();
+ $bCacheTable = $oDB->tableExists($sClassTable);
+
+ $sSQL = "SELECT min(rank_search) FROM placex WHERE place_id in ($sPlaceIDs)";
+ Debug::printSQL($sSQL);
+ $iMaxRank = (int) $oDB->getOne($sSQL);
+
+ // For state / country level searches the normal radius search doesn't work very well
+ $sPlaceGeom = false;
+ if ($iMaxRank < 9 && $bCacheTable) {
+ // Try and get a polygon to search in instead
+ $sSQL = 'SELECT geometry FROM placex';
+ $sSQL .= " WHERE place_id in ($sPlaceIDs)";
+ $sSQL .= " AND rank_search < $iMaxRank + 5";
+ $sSQL .= " AND ST_GeometryType(geometry) in ('ST_Polygon','ST_MultiPolygon')";
+ $sSQL .= ' ORDER BY rank_search ASC ';
+ $sSQL .= ' LIMIT 1';
+ Debug::printSQL($sSQL);
+ $sPlaceGeom = $oDB->getOne($sSQL);
+ }
+
+ if ($sPlaceGeom) {
+ $sPlaceIDs = false;
+ } else {
+ $iMaxRank += 5;
+ $sSQL = 'SELECT place_id FROM placex';
+ $sSQL .= " WHERE place_id in ($sPlaceIDs) and rank_search < $iMaxRank";
+ Debug::printSQL($sSQL);
+ $aPlaceIDs = $oDB->getCol($sSQL);
+ $sPlaceIDs = join(',', $aPlaceIDs);
+ }
+
+ if ($sPlaceIDs || $sPlaceGeom) {
+ $fRange = 0.01;
+ if ($bCacheTable) {
+ // More efficient - can make the range bigger
+ $fRange = 0.05;
+
+ $sOrderBySQL = '';
+ if ($this->oContext->hasNearPoint()) {
+ $sOrderBySQL = $this->oContext->distanceSQL('l.centroid');
+ } elseif ($sPlaceIDs) {
+ $sOrderBySQL = 'ST_Distance(l.centroid, f.geometry)';
+ } elseif ($sPlaceGeom) {
+ $sOrderBySQL = "ST_Distance(st_centroid('".$sPlaceGeom."'), l.centroid)";
+ }
+
+ $sSQL = 'SELECT distinct i.place_id';
+ if ($sOrderBySQL) {
+ $sSQL .= ', i.order_term';
+ }
+ $sSQL .= ' from (SELECT l.place_id';
+ if ($sOrderBySQL) {
+ $sSQL .= ','.$sOrderBySQL.' as order_term';
+ }
+ $sSQL .= ' from '.$sClassTable.' as l';
+
+ if ($sPlaceIDs) {
+ $sSQL .= ',placex as f WHERE ';
+ $sSQL .= "f.place_id in ($sPlaceIDs) ";
+ $sSQL .= " AND ST_DWithin(l.centroid, f.centroid, $fRange)";
+ } elseif ($sPlaceGeom) {
+ $sSQL .= " WHERE ST_Contains('$sPlaceGeom', l.centroid)";
+ }
+
+ $sSQL .= $this->oContext->excludeSQL(' AND l.place_id');
+ $sSQL .= 'limit 300) i ';
+ if ($sOrderBySQL) {
+ $sSQL .= 'order by order_term asc';
+ }
+ $sSQL .= " limit $iLimit";
+
+ Debug::printSQL($sSQL);
+
+ foreach ($oDB->getCol($sSQL) as $iPlaceId) {
+ $aResults[$iPlaceId] = new Result($iPlaceId);
+ }
+ } else {
+ if ($this->oContext->hasNearPoint()) {
+ $fRange = $this->oContext->nearRadius();
+ }
+
+ $sOrderBySQL = '';
+ if ($this->oContext->hasNearPoint()) {
+ $sOrderBySQL = $this->oContext->distanceSQL('l.geometry');
+ } else {
+ $sOrderBySQL = 'ST_Distance(l.geometry, f.geometry)';
+ }
+
+ $sSQL = 'SELECT distinct l.place_id';
+ if ($sOrderBySQL) {
+ $sSQL .= ','.$sOrderBySQL.' as orderterm';
+ }
+ $sSQL .= ' FROM placex as l, placex as f';
+ $sSQL .= " WHERE f.place_id in ($sPlaceIDs)";
+ $sSQL .= " AND ST_DWithin(l.geometry, f.centroid, $fRange)";
+ $sSQL .= " AND l.class='".$this->sClass."'";
+ $sSQL .= " AND l.type='".$this->sType."'";
+ $sSQL .= $this->oContext->excludeSQL(' AND l.place_id');
+ if ($sOrderBySQL) {
+ $sSQL .= 'ORDER BY orderterm ASC';
+ }
+ $sSQL .= " limit $iLimit";
+
+ Debug::printSQL($sSQL);
+
+ foreach ($oDB->getCol($sSQL) as $iPlaceId) {
+ $aResults[$iPlaceId] = new Result($iPlaceId);
+ }
+ }
+ }
+ }
+
+ return $aResults;
+ }
+
+ private function poiTable()
+ {
+ return 'place_classtype_'.$this->sClass.'_'.$this->sType;
+ }
+
+ private function countryCodeSQL($sVar)
+ {
+ if ($this->sCountryCode) {
+ return $sVar.' = \''.$this->sCountryCode."'";
+ }
+ if ($this->oContext->sqlCountryList) {
+ return $sVar.' in '.$this->oContext->sqlCountryList;
+ }
+
+ return '';
+ }
+
+ /////////// Sort functions
+
+
+ public static function bySearchRank($a, $b)
+ {
+ if ($a->iSearchRank == $b->iSearchRank) {
+ return $a->iOperator + strlen($a->sHouseNumber)
+ - $b->iOperator - strlen($b->sHouseNumber);
+ }
+
+ return $a->iSearchRank < $b->iSearchRank ? -1 : 1;
+ }
+
+ //////////// Debugging functions
+
+
+ public function debugInfo()
+ {
+ return array(
+ 'Search rank' => $this->iSearchRank,
+ 'Country code' => $this->sCountryCode,
+ 'Name terms' => $this->aName,
+ 'Name terms (stop words)' => $this->aNameNonSearch,
+ 'Address terms' => $this->aAddress,
+ 'Address terms (stop words)' => $this->aAddressNonSearch,
+ 'Address terms (full words)' => $this->aFullNameAddress,
+ 'Special search' => $this->iOperator,
+ 'Class' => $this->sClass,
+ 'Type' => $this->sType,
+ 'House number' => $this->sHouseNumber,
+ 'Postcode' => $this->sPostcode
+ );
+ }
+
+ public function dumpAsHtmlTableRow(&$aWordIDs)
+ {
+ $kf = function ($k) use (&$aWordIDs) {
+ return $aWordIDs[$k];
+ };
+
+ echo '<tr>';
+ echo "<td>$this->iSearchRank</td>";
+ echo '<td>'.join(', ', array_map($kf, $this->aName)).'</td>';
+ echo '<td>'.join(', ', array_map($kf, $this->aNameNonSearch)).'</td>';
+ echo '<td>'.join(', ', array_map($kf, $this->aAddress)).'</td>';
+ echo '<td>'.join(', ', array_map($kf, $this->aAddressNonSearch)).'</td>';
+ echo '<td>'.$this->sCountryCode.'</td>';
+ echo '<td>'.Operator::toString($this->iOperator).'</td>';
+ echo '<td>'.$this->sClass.'</td>';
+ echo '<td>'.$this->sType.'</td>';
+ echo '<td>'.$this->sPostcode.'</td>';
+ echo '<td>'.$this->sHouseNumber.'</td>';
+
+ echo '</tr>';
+ }
+}