X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/96b6a1a41892224b79fb99917981843aef6a4465..64ace51e02790bf88e162a15236c5ac2af865c5e:/lib/SearchDescription.php diff --git a/lib/SearchDescription.php b/lib/SearchDescription.php index 99860ce0..bb478b29 100644 --- a/lib/SearchDescription.php +++ b/lib/SearchDescription.php @@ -2,24 +2,9 @@ namespace Nominatim; -/** - * Operators describing special searches. - */ -abstract final class Operator -{ - /// No operator selected. - const NONE = 0; - /// Search for POI of the given type. - const TYPE = 1; - /// Search for POIs near the given place. - const NEAR = 2; - /// Search for POIS in the given place. - const IN = 3; - /// Search for POIS named as given. - const NAME = 4; - /// Search for postcodes. - const POSTCODE = 5; -} +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. @@ -32,6 +17,8 @@ class SearchDescription 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. @@ -50,32 +37,50 @@ class SearchDescription 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; - public function getRank() - { - return $this->iSearchRank; - } - - public function getPostCode() + /** + * Create an empty search description. + * + * @param object $oContext Global context to use. Will be inherited by + * all derived search objects. + */ + public function __construct($oContext) { - return $this->sPostcode; + $this->oContext = $oContext; } /** - * Set the geographic search radius. + * 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 setNear(&$oNearPoint) + public function getRank() { - $this->oNearPoint = $oNearPoint; + 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; @@ -84,208 +89,531 @@ class SearchDescription } /** - * Check if name or address for the search are specified. + * Check if this might be a full address search. + * + * @return bool True if the search contains name, address and housenumber. */ - public function isNamedSearch() + public function looksLikeFullAddress() { - return sizeof($this->aName) > 0 || sizeof($this->aAddress) > 0; + return (!empty($this->aName)) + && (!empty($this->aAddress) || $this->sCountryCode) + && preg_match('/[0-9]+/', $this->sHouseNumber); } /** - * Check if only a country is requested. + * Check if any operator is set. + * + * @return bool True, if this is a special search operation. */ - public function isCountrySearch() + public function hasOperator() { - return $this->sCountryCode && sizeof($this->aName) == 0 - && !$this->iOperator && !$this->oNear; + return $this->iOperator != Operator::NONE; } /** - * Check if a search near a geographic location is requested. + * Extract key/value pairs from a query. + * + * Key/value pairs are recognised if they are of the form [=]. + * 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 isNearSearch() + public function extractKeyValuePairs($sQuery) { - return (bool) $this->oNear; - } + // Search for terms of kind [=]. + preg_match_all( + '/\\[([\\w_]*)=([\\w_]*)\\]/', + $sQuery, + $aSpecialTermsRaw, + PREG_SET_ORDER + ); - public function isPoiSearch() - { - return (bool) $this->sClass; - } + foreach ($aSpecialTermsRaw as $aTerm) { + $sQuery = str_replace($aTerm[0], ' ', $sQuery); + if (!$this->hasOperator()) { + $this->setPoiSearch(Operator::TYPE, $aTerm[1], $aTerm[2]); + } + } - public function looksLikeFullAddress() - { - return sizeof($this->aName) - && (sizeof($this->aAddress || $this->sCountryCode)) - && preg_match('/[0-9]+/', $this->sHouseNumber); + return $sQuery; } - public function isOperator($iType) + /** + * Check if the combination of parameters is sensible. + * + * @return bool True, if the search looks valid. + */ + public function isValidSearch() { - return $this->iOperator == $iType; - } + if (empty($this->aName)) { + if ($this->sHouseNumber) { + return false; + } + if (!$this->sClass && !$this->sCountryCode) { + return false; + } + } - public function hasHouseNumber() - { - return (bool) $this->sHouseNumber; + return true; } - public function poiTable() - { - return 'place_classtype_'.$this->sClass.'_'.$this->sType; - } + /////////// Search building functions - public function addressArraySQL() - { - return 'ARRAY['.join(',', $this->aAddress).']'; - } - public function nameArraySQL() + + /** + * 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) { - return 'ARRAY['.join(',', $this->aName).']'; + $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; } - public function countryCodeSQL($sVar, $sCountryList) + /** + * 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) { - if ($this->sCountryCode) { - return $sVar.' = \''.$this->sCountryCode."'"; + // Only allow name terms. + if (!(is_a($oSearchTerm, '\Nominatim\Token\Word'))) { + return array(); } - if ($sCountryList) { - return $sVar.' in ('.$this->sCountryCode.')'; + + $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; + } + } + } } - return ''; - } + 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; + } - public function hasOperator() - { - return $this->iOperator != Operator::NONE; + return $aNewSearches; } + /////////// Query functions + + /** - * Extract special terms from the query, amend the search - * and return the shortended query. + * 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. * - * Only the first special term found will be used but all will - * be removed from the query. + * @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 extractKeyValuePairs($sQuery) + public function query(&$oDB, $iMinRank, $iMaxRank, $iLimit) { - // Search for terms of kind [=]. - preg_match_all( - '/\\[([\\w_]*)=([\\w_]*)\\]/', - $sQuery, - $aSpecialTermsRaw, - PREG_SET_ORDER - ); + $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 + ); - foreach ($aSpecialTermsRaw as $aTerm) { - $sQuery = str_replace($aTerm[0], ' ', $sQuery); - if (!$this->hasOperator()) { - $this->setPoiSearch(Operator::TYPE, $aTerm[1], $aTerm[2]); + // 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); } } - return $sQuery; + 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; } - public function queryCountry(&$oDB, $sViewboxSQL) + + private function queryCountry(&$oDB) { $sSQL = 'SELECT place_id FROM placex '; $sSQL .= "WHERE country_code='".$this->sCountryCode."'"; $sSQL .= ' AND rank_search = 4'; - if ($ViewboxSQL) { - $sSQL .= " AND ST_Intersects($sViewboxSQL, geometry)"; + if ($this->oContext->bViewboxBounded) { + $sSQL .= ' AND ST_Intersects('.$this->oContext->sqlViewboxSmall.', geometry)'; } - $sSQL .= " ORDER BY st_area(geometry) DESC LIMIT 1"; + $sSQL .= ' ORDER BY st_area(geometry) DESC LIMIT 1'; + + Debug::printSQL($sSQL); - if (CONST_Debug) var_dump($sSQL); + $iPlaceId = $oDB->getOne($sSQL); - return chksql($oDB->getCol($sSQL)); + $aResults = array(); + if ($iPlaceId) { + $aResults[$iPlaceId] = new Result($iPlaceId); + } + + return $aResults; } - public function queryNearbyPoi(&$oDB, $sCountryList, $sViewboxSQL, $sViewboxCentreSQL, $sExcludeSQL, $iLimit) + private function queryNearbyPoi(&$oDB, $iLimit) { if (!$this->sClass) { return array(); } + $aDBResults = array(); $sPoiTable = $this->poiTable(); - $sSQL = 'SELECT count(*) FROM pg_tables WHERE tablename = \''.$sPoiTable."'"; - if (chksql($oDB->getOne($sSQL))) { + if ($oDB->tableExists($sPoiTable)) { $sSQL = 'SELECT place_id FROM '.$sPoiTable.' ct'; - if ($sCountryList) { + if ($this->oContext->sqlCountryList) { $sSQL .= ' JOIN placex USING (place_id)'; } - if ($this->oNearPoint) { - $sSQL .= ' WHERE '.$this->oNearPoint->withinSQL('ct.centroid'); - } else { - $sSQL .= " WHERE ST_Contains($sViewboxSQL, ct.centroid)"; - } - if ($sCountryList) { - $sSQL .= " AND country_code in ($sCountryList)"; + 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 ($sExcludeSQL) { - $sSQL .= ' AND place_id not in ('.$sExcludeSQL.')'; + if ($this->oContext->sqlCountryList) { + $sSQL .= ' AND country_code in '.$this->oContext->sqlCountryList; } - if ($sViewboxCentreSQL) { - $sSQL .= " ORDER BY ST_Distance($sViewboxCentreSQL, ct.centroid) ASC"; - } elseif ($this->oNearPoint) { - $sSQL .= ' ORDER BY '.$this->oNearPoint->distanceSQL('ct.centroid').' ASC'; + $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"; - if (CONST_Debug) var_dump($sSQL); - return chksql($this->oDB->getCol($sSQL)); + $sSQL .= " LIMIT $iLimit"; + Debug::printSQL($sSQL); + $aDBResults = $oDB->getCol($sSQL); } - if ($this->oNearPoint) { + if ($this->oContext->hasNearPoint()) { $sSQL = 'SELECT place_id FROM placex WHERE '; - $sSQL .= 'class=\''.$this->sClass."' and type='".$this->sType."'"; - $sSQL .= ' AND '.$this->oNearPoint->withinSQL('geometry'); + $sSQL .= 'class = :class and type = :type'; + $sSQL .= ' AND '.$this->oContext->withinSQL('geometry'); $sSQL .= ' AND linked_place_id is null'; - if ($sCountryList) { - $sSQL .= " AND country_code in ($sCountryList)"; + if ($this->oContext->sqlCountryList) { + $sSQL .= ' AND country_code in '.$this->oContext->sqlCountryList; } - $sSQL .= ' ORDER BY '.$this->oNearPoint->distanceSQL('centroid')." ASC"; + $sSQL .= ' ORDER BY '.$this->oContext->distanceSQL('centroid').' ASC'; $sSQL .= " LIMIT $iLimit"; - if (CONST_Debug) var_dump($sSQL); - return chksql($this->oDB->getCol($sSQL)); + 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 array(); + return $aResults; } - public function queryPostcode(&$oDB, $sCountryList, $iLimit) + private function queryPostcode(&$oDB, $iLimit) { - $sSQL = 'SELECT p.place_id FROM location_postcode p '; + $sSQL = 'SELECT p.place_id FROM location_postcode p '; - if (sizeof($this->aAddress)) { + 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 .= ' @> '.$this->addressArraySQL().' AND '; + $sSQL .= ' @> '.$oDB->getArraySQL($this->aAddress).' AND '; } else { $sSQL .= 'WHERE '; } - $sSQL .= "p.postcode = '".pg_escape_string(reset($this->$aName))."'"; - $sCountryTerm = $this->countryCodeSQL('p.country_code', $sCountryList); - if ($sCountryTerm) { - $sSQL .= ' AND '.$sCountyTerm; + $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"; - if (CONST_Debug) var_dump($sSQL); + Debug::printSQL($sSQL); + + $aResults = array(); + foreach ($oDB->getCol($sSQL) as $iPlaceId) { + $aResults[$iPlaceId] = new Result($iPlaceId, Result::TABLE_POSTCODE); + } - return chksql($this->oDB->getCol($sSQL)); + return $aResults; } - public function queryNamedPlace(&$oDB, $aWordFrequencyScores, $sCountryList, $iMinAddressRank, $iMaxAddressRank, $sExcludeSQL, $sViewboxSmall, $sViewboxLarge, $iLimit) + private function queryNamedPlace(&$oDB, $iMinAddressRank, $iMaxAddressRank, $iLimit) { $aTerms = array(); $aOrder = array(); - if ($this->sHouseNumber && sizeof($this->aAddress)) { + // 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('; @@ -311,81 +639,70 @@ class SearchDescription $aOrder[0] .= ') DESC'; } - if (sizeof($this->aName)) { - $aTerms[] = 'name_vector @> '.$this->nameArraySQL(); + if (!empty($this->aName)) { + $aTerms[] = 'name_vector @> '.$oDB->getArraySQL($this->aName); } - if (sizeof($this->aAddress)) { + if (!empty($this->aAddress)) { // For infrequent name terms disable index usage for address - if (CONST_Search_NameOnlySearchFrequencyThreshold - && sizeof($this->aName) == 1 - && $aWordFrequencyScores[$this->aName[reset($this->aName)]] - < CONST_Search_NameOnlySearchFrequencyThreshold - ) { - $aTerms[] = 'array_cat(nameaddress_vector,ARRAY[]::integer[]) @> '.$this->addressArraySQL(); + if ($this->bRareName) { + $aTerms[] = 'array_cat(nameaddress_vector,ARRAY[]::integer[]) @> '.$oDB->getArraySQL($this->aAddress); } else { - $aTerms[] = 'nameaddress_vector @> '.$this->addressArraySQL(); + $aTerms[] = 'nameaddress_vector @> '.$oDB->getArraySQL($this->aAddress); } } - $sCountryTerm = $this->countryCodeSQL('p.country_code', $sCountryList); + $sCountryTerm = $this->countryCodeSQL('country_code'); if ($sCountryTerm) { $aTerms[] = $sCountryTerm; } if ($this->sHouseNumber) { - $aTerms[] = "address_rank between 16 and 27"; + $aTerms[] = 'address_rank between 16 and 27'; } elseif (!$this->sClass || $this->iOperator == Operator::NAME) { if ($iMinAddressRank > 0) { - $aTerms[] = "address_rank >= ".$iMinAddressRank; - } - if ($iMaxAddressRank < 30) { - $aTerms[] = "address_rank <= ".$iMaxAddressRank; + $aTerms[] = "((address_rank between $iMinAddressRank and $iMaxAddressRank) or (search_rank between $iMinAddressRank and $iMaxAddressRank))"; } } - if ($this->oNearPoint) { - $aTerms[] = $this->oNearPoint->withinSQL('centroid'); - $aOrder[] = $this->oNearPoint->distanceSQL('centroid'); + if ($this->oContext->hasNearPoint()) { + $aTerms[] = $this->oContext->withinSQL('centroid'); + $aOrder[] = $this->oContext->distanceSQL('centroid'); } elseif ($this->sPostcode) { - if (!sizeof($this->aAddress)) { + 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 = 'place_id not in ('.$sExcludeSQL.')'; + $aTerms[] = $sExcludeSQL; } - if ($sViewboxSmall) { - $aTerms[] = 'centroid && '.$sViewboxSmall; + if ($this->oContext->bViewboxBounded) { + $aTerms[] = 'centroid && '.$this->oContext->sqlViewboxSmall; } - if ($this->oNearPoint) { - $aOrder[] = $this->oNearPoint->distanceSQL('centroid'); + 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.75-(search_rank::float/40) ELSE importance END)'; - } - if ($sViewboxSmall) { - $sImportanceSQL .= " * CASE WHEN ST_Contains($sViewboxSmall, centroid) THEN 1 ELSE 0.5 END"; - } - if ($sViewboxLarge) { - $sImportanceSQL .= " * CASE WHEN ST_Contains($sViewboxLarge, centroid) THEN 1 ELSE 0.5 END"; + $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 (sizeof($this->aFullNameAddress)) { + if (!empty($this->aFullNameAddress)) { $sExactMatchSQL = ' ( '; - $sExactMatchSQL .= ' SELECT count(*) FROM ( '; - $sExactMatchSQL .= ' SELECT unnest(ARRAY['.join($this->aFullNameAddress, ",").']) '; - $sExactMatchSQL .= ' INTERSECT '; - $sExactMatchSQL .= ' SELECT unnest(nameaddress_vector)'; - $sExactMatchSQL .= ' ) s'; + $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 { @@ -393,52 +710,57 @@ class SearchDescription } if ($this->sHouseNumber || $this->sClass) { - $iLimit = 20; + $iLimit = 40; } - if (sizeof($aTerms)) { + $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; - if (CONST_Debug) var_dump($sSQL); + Debug::printSQL($sSQL); - return chksql( - $this->oDB->getAll($sSQL), - "Could not get places for search terms." - ); + $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 array(); + return $aResults; } - - public function queryHouseNumber(&$oDB, $aRoadPlaceIDs, $sExcludeSQL, $iLimit) + private function queryHouseNumber(&$oDB, $aRoadPlaceIDs) { - $sPlaceIDs = join(',', $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."'"; - if ($sExcludeSQL) { - $sSQL .= ' AND place_id not in ('.$sExcludeSQL.')'; - } - $sSQL .= " LIMIT $iLimit"; - - if (CONST_Debug) var_dump($sSQL); + $sSQL .= $this->oContext->excludeSQL(' AND place_id'); - $aPlaceIDs = chksql($this->oDB->getCol($sSQL)); + Debug::printSQL($sSQL); - if (sizeof($aPlaceIDs)) { - return array('aPlaceIDs' => $aPlaceIDs, 'iHouseNumber' => -1); + // 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) { + 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'; @@ -452,45 +774,36 @@ class SearchDescription $sSQL .= "interpolationtype='odd'"; } $sSQL .= " or interpolationtype='all') and "; - $sSQL .= $iHousenumber.">=startnumber and "; - $sSQL .= $iHousenumber."<=endnumber"; - - if ($sExcludeSQL)) { - $sSQL .= ' AND place_id not in ('.$sExcludeSQL.')'; - } - $sSQL .= " limit $iLimit"; - - if (CONST_Debug) var_dump($sSQL); + $sSQL .= $iHousenumber.'>=startnumber and '; + $sSQL .= $iHousenumber.'<=endnumber'; + $sSQL .= $this->oContext->excludeSQL(' AND place_id'); - $aPlaceIDs = chksql($this->oDB->getCol($sSQL, 0)); + Debug::printSQL($sSQL); - if (sizeof($aPlaceIDs)) { - return array('aPlaceIDs' => $aPlaceIDs, 'iHouseNumber' => $iHousenumber); + 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) { + 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."'"; - if ($sExcludeSQL) { - $sSQL .= " AND place_id not in ($sExcludeSQL)"; - } - $sSQL .= " limit $iLimit"; - - if (CONST_Debug) var_dump($sSQL); + $sSQL .= $this->oContext->excludeSQL(' AND place_id'); - $aPlaceIDs = chksql($this->oDB->getCol($sSQL)); + Debug::printSQL($sSQL); - if (sizeof($aPlaceIDs)) { - return array('aPlaceIDs' => $aPlaceIDs, 'iHouseNumber' => -1); + 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) { - $sSQL = 'SELECT distinct place_id FROM 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'"; @@ -498,31 +811,31 @@ class SearchDescription $sSQL .= "interpolationtype='odd'"; } $sSQL .= " or interpolationtype='all') and "; - $sSQL .= $iHousenumber.">=startnumber and "; - $sSQL .= $iHousenumber."<=endnumber"; - - if ($sExcludeSQL) { - $sSQL .= ' AND place_id not in ('.$sExcludeSQL.')'; - } - $sSQL .= " limit $iLimit"; + $sSQL .= $iHousenumber.'>=startnumber and '; + $sSQL .= $iHousenumber.'<=endnumber'; + $sSQL .= $this->oContext->excludeSQL(' AND place_id'); - if (CONST_Debug) var_dump($sSQL); + Debug::printSQL($sSQL); - $aPlaceIDs = chksql($this->oDB->getCol($sSQL, 0)); - - if (sizeof($aPlaceIDs)) { - return array('aPlaceIDs' => $aPlaceIDs, 'iHouseNumber' => $iHousenumber); + foreach ($oDB->getCol($sSQL) as $iPlaceId) { + $oResult = new Result($iPlaceId, Result::TABLE_TIGER); + $oResult->iHouseNumber = $iHousenumber; + $aResults[$iPlaceId] = $oResult; } } - return array(); + return $aResults; } - public function queryPoiByOperator(&$oDB, $aParentIDs, $sExcludeSQL, $iLimit) + private function queryPoiByOperator(&$oDB, $aParentIDs, $iLimit) { - $sPlaceIDs = join(',', $aParentIDs); - $aClassPlaceIDs = array(); + $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') @@ -531,24 +844,26 @@ class SearchDescription $sSQL .= " WHERE place_id in ($sPlaceIDs)"; $sSQL .= " AND class='".$this->sClass."' "; $sSQL .= " AND type='".$this->sType."'"; - $sSQL .= " AND linked_place_id is null"; - $sSQL .= " ORDER BY rank_search ASC "; + $sSQL .= ' AND linked_place_id is null'; + $sSQL .= $this->oContext->excludeSQL(' AND place_id'); + $sSQL .= ' ORDER BY rank_search ASC '; $sSQL .= " LIMIT $iLimit"; - if (CONST_Debug) var_dump($sSQL); + Debug::printSQL($sSQL); - $aClassPlaceIDs = chksql($this->oDB->getCol($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(); - $sSQL = "SELECT count(*) FROM pg_tables WHERE tablename = '$sClassTable'"; - $bCacheTable = (bool) chksql($this->oDB->getOne($sSQL)); + $bCacheTable = $oDB->tableExists($sClassTable); $sSQL = "SELECT min(rank_search) FROM placex WHERE place_id in ($sPlaceIDs)"; - if (CONST_Debug) var_dump($sSQL); - $iMaxRank = (int)chksql($this->oDB->getOne($sSQL)); + Debug::printSQL($sSQL); + $iMaxRank = (int) $oDB->getOne($sSQL); // For state / country level searches the normal radius search doesn't work very well $sPlaceGeom = false; @@ -558,10 +873,10 @@ class SearchDescription $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"; - if (CONST_Debug) var_dump($sSQL); - $sPlaceGeom = chksql($this->oDB->getOne($sSQL)); + $sSQL .= ' ORDER BY rank_search ASC '; + $sSQL .= ' LIMIT 1'; + Debug::printSQL($sSQL); + $sPlaceGeom = $oDB->getOne($sSQL); } if ($sPlaceGeom) { @@ -570,8 +885,8 @@ class SearchDescription $iMaxRank += 5; $sSQL = 'SELECT place_id FROM placex'; $sSQL .= " WHERE place_id in ($sPlaceIDs) and rank_search < $iMaxRank"; - if (CONST_Debug) var_dump($sSQL); - $aPlaceIDs = chksql($this->oDB->getCol($sSQL)); + Debug::printSQL($sSQL); + $aPlaceIDs = $oDB->getCol($sSQL); $sPlaceIDs = join(',', $aPlaceIDs); } @@ -582,10 +897,10 @@ class SearchDescription $fRange = 0.05; $sOrderBySQL = ''; - if ($this->oNearPoint) { - $sOrderBySQL = $this->oNearPoint->distanceSQL('l.centroid'); + if ($this->oContext->hasNearPoint()) { + $sOrderBySQL = $this->oContext->distanceSQL('l.centroid'); } elseif ($sPlaceIDs) { - $sOrderBySQL = "ST_Distance(l.centroid, f.geometry)"; + $sOrderBySQL = 'ST_Distance(l.centroid, f.geometry)'; } elseif ($sPlaceGeom) { $sOrderBySQL = "ST_Distance(st_centroid('".$sPlaceGeom."'), l.centroid)"; } @@ -601,35 +916,35 @@ class SearchDescription $sSQL .= ' from '.$sClassTable.' as l'; if ($sPlaceIDs) { - $sSQL .= ",placex as f WHERE "; + $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)"; } - if ($sExcludeSQL) { - $sSQL .= ' AND l.place_id not in ('.$sExcludeSQL.')'; - } + $sSQL .= $this->oContext->excludeSQL(' AND l.place_id'); $sSQL .= 'limit 300) i '; if ($sOrderBySQL) { $sSQL .= 'order by order_term asc'; } $sSQL .= " limit $iLimit"; - if (CONST_Debug) var_dump($sSQL); + Debug::printSQL($sSQL); - $aClassPlaceIDs = array_merge($aClassPlaceIDs, chksql($this->oDB->getCol($sSQL))); + foreach ($oDB->getCol($sSQL) as $iPlaceId) { + $aResults[$iPlaceId] = new Result($iPlaceId); + } } else { - if ($this->oNearPoint) { - $fRange = $this->oNearPoint->radius(); + if ($this->oContext->hasNearPoint()) { + $fRange = $this->oContext->nearRadius(); } $sOrderBySQL = ''; - if ($this->oNearPoint) { - $sOrderBySQL = $this->oNearPoint->distanceSQL('l.geometry'); + if ($this->oContext->hasNearPoint()) { + $sOrderBySQL = $this->oContext->distanceSQL('l.geometry'); } else { - $sOrderBySQL = "ST_Distance(l.geometry, f.geometry)"; + $sOrderBySQL = 'ST_Distance(l.geometry, f.geometry)'; } $sSQL = 'SELECT distinct l.place_id'; @@ -641,21 +956,94 @@ class SearchDescription $sSQL .= " AND ST_DWithin(l.geometry, f.centroid, $fRange)"; $sSQL .= " AND l.class='".$this->sClass."'"; $sSQL .= " AND l.type='".$this->sType."'"; - if ($sExcludeSQL) { - $sSQL .= " AND l.place_id not in (".$sExcludeSQL.")"; - } + $sSQL .= $this->oContext->excludeSQL(' AND l.place_id'); if ($sOrderBySQL) { - $sSQL .= "ORDER BY orderterm ASC"; + $sSQL .= 'ORDER BY orderterm ASC'; } $sSQL .= " limit $iLimit"; - if (CONST_Debug) var_dump($sSQL); + Debug::printSQL($sSQL); - $aClassPlaceIDs = array_merge($aClassPlaceIDs, chksql($this->oDB->getCol($sSQL))); + foreach ($oDB->getCol($sSQL) as $iPlaceId) { + $aResults[$iPlaceId] = new Result($iPlaceId); + } } } } - return $aClassPlaceIDs; + 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 ''; + echo "$this->iSearchRank"; + echo ''.join(', ', array_map($kf, $this->aName)).''; + echo ''.join(', ', array_map($kf, $this->aNameNonSearch)).''; + echo ''.join(', ', array_map($kf, $this->aAddress)).''; + echo ''.join(', ', array_map($kf, $this->aAddressNonSearch)).''; + echo ''.$this->sCountryCode.''; + echo ''.Operator::toString($this->iOperator).''; + echo ''.$this->sClass.''; + echo ''.$this->sType.''; + echo ''.$this->sPostcode.''; + echo ''.$this->sHouseNumber.''; + + echo ''; + } +}