X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/12168e3ca9421ab1d0195507919c26ce029ce155..d1041979ecfc352399fa8828b771eb559cb57351:/lib/Geocode.php
diff --git a/lib/Geocode.php b/lib/Geocode.php
index 184fd0f5..5343873f 100644
--- a/lib/Geocode.php
+++ b/lib/Geocode.php
@@ -7,6 +7,7 @@ require_once(CONST_BasePath.'/lib/Phrase.php');
require_once(CONST_BasePath.'/lib/ReverseGeocode.php');
require_once(CONST_BasePath.'/lib/SearchDescription.php');
require_once(CONST_BasePath.'/lib/SearchContext.php');
+require_once(CONST_BasePath.'/lib/TokenList.php');
class Geocode
{
@@ -16,8 +17,6 @@ class Geocode
protected $aLangPrefOrder = array();
- protected $bIncludeAddressDetails = false;
-
protected $aExcludePlaceIDs = array();
protected $bReverseInPlan = true;
@@ -86,7 +85,6 @@ class Geocode
$aParams['exclude_place_ids'] = implode(',', $this->aExcludePlaceIDs);
}
- if ($this->bIncludeAddressDetails) $aParams['addressdetails'] = '1';
if ($this->bBoundedSearch) $aParams['bounded'] = '1';
if ($this->aCountryCodes) {
@@ -151,6 +149,10 @@ class Geocode
private function viewboxImportanceFactor($fX, $fY)
{
+ if (!$this->aViewBox) {
+ return 1;
+ }
+
$fWidth = ($this->aViewBox[2] - $this->aViewBox[0])/2;
$fHeight = ($this->aViewBox[3] - $this->aViewBox[1])/2;
@@ -182,9 +184,6 @@ class Geocode
public function loadParamArray($oParams, $sForceGeometryType = null)
{
- $this->bIncludeAddressDetails
- = $oParams->getBool('addressdetails', $this->bIncludeAddressDetails);
-
$this->bBoundedSearch = $oParams->getBool('bounded', $this->bBoundedSearch);
$this->setLimit($oParams->getInt('limit', $this->iFinalLimit));
@@ -246,8 +245,8 @@ class Geocode
}
$this->oPlaceLookup->loadParamArray($oParams, $sForceGeometryType);
- $this->oPlaceLookup->setIncludeAddressDetails(false);
$this->oPlaceLookup->setIncludePolygonAsPoints($oParams->getBool('polygon'));
+ $this->oPlaceLookup->setIncludeAddressDetails($oParams->getBool('addressdetails', false));
}
public function setQueryFromParams($oParams)
@@ -303,7 +302,7 @@ class Geocode
$this->loadStructuredAddressElement($sPostalCode, 'postalcode', 5, 11, array(5, 11));
$this->loadStructuredAddressElement($sCountry, 'country', 4, 4, false);
- if (sizeof($this->aStructuredQuery) > 0) {
+ if (!empty($this->aStructuredQuery)) {
$this->sQuery = join(', ', $this->aStructuredQuery);
if ($this->iMaxAddressRank < 30) {
$this->sAllowedTypesSQLList = '(\'place\',\'boundary\')';
@@ -317,7 +316,7 @@ class Geocode
$aParams = $this->aStructuredQuery;
- if (sizeof($aParams) == 1) return false;
+ if (count($aParams) == 1) return false;
$aOrderToFallback = array('postalcode', 'street', 'city', 'county', 'state');
@@ -332,10 +331,10 @@ class Geocode
return false;
}
- public function getGroupedSearches($aSearches, $aPhrases, $aValidTokens, $bIsStructured)
+ public function getGroupedSearches($aSearches, $aPhrases, $oValidTokens, $bIsStructured)
{
/*
- Calculate all searches using aValidTokens i.e.
+ Calculate all searches using oValidTokens i.e.
'Wodsworth Road, Sheffield' =>
Phrase Wordset
@@ -365,38 +364,37 @@ class Geocode
//var_dump($oCurrentSearch);
//echo "";
- // If the token is valid
- if (isset($aValidTokens[' '.$sToken])) {
- foreach ($aValidTokens[' '.$sToken] as $aSearchTerm) {
- $aNewSearches = $oCurrentSearch->extendWithFullTerm(
- $aSearchTerm,
- isset($aValidTokens[$sToken])
- && strpos($sToken, ' ') === false,
- $sPhraseType,
- $iToken == 0 && $iPhrase == 0,
- $iPhrase == 0,
- $iToken + 1 == sizeof($aWordset)
- && $iPhrase + 1 == sizeof($aPhrases)
- );
-
- foreach ($aNewSearches as $oSearch) {
- if ($oSearch->getRank() < $this->iMaxRank) {
- $aNewWordsetSearches[] = $oSearch;
- }
+ // Tokens with full name matches.
+ foreach ($oValidTokens->get(' '.$sToken) as $oSearchTerm) {
+ $aNewSearches = $oCurrentSearch->extendWithFullTerm(
+ $oSearchTerm,
+ $oValidTokens->contains($sToken)
+ && strpos($sToken, ' ') === false,
+ $sPhraseType,
+ $iToken == 0 && $iPhrase == 0,
+ $iPhrase == 0,
+ $iToken + 1 == count($aWordset)
+ && $iPhrase + 1 == count($aPhrases)
+ );
+
+ foreach ($aNewSearches as $oSearch) {
+ if ($oSearch->getRank() < $this->iMaxRank) {
+ $aNewWordsetSearches[] = $oSearch;
}
}
}
// Look for partial matches.
// Note that there is no point in adding country terms here
// because country is omitted in the address.
- if (isset($aValidTokens[$sToken]) && $sPhraseType != 'country') {
+ if ($sPhraseType != 'country') {
// Allow searching for a word - but at extra cost
- foreach ($aValidTokens[$sToken] as $aSearchTerm) {
+ foreach ($oValidTokens->get($sToken) as $oSearchTerm) {
$aNewSearches = $oCurrentSearch->extendWithPartialTerm(
- $aSearchTerm,
+ $sToken,
+ $oSearchTerm,
$bIsStructured,
$iPhrase,
- isset($aValidTokens[' '.$sToken]) ? $aValidTokens[' '.$sToken] : array()
+ $oValidTokens->get(' '.$sToken)
);
foreach ($aNewSearches as $oSearch) {
@@ -411,7 +409,7 @@ class Geocode
usort($aNewWordsetSearches, array('Nominatim\SearchDescription', 'bySearchRank'));
$aWordsetSearches = array_slice($aNewWordsetSearches, 0, 50);
}
- //var_Dump('
',sizeof($aWordsetSearches)); exit;
+ //var_Dump('
',count($aWordsetSearches)); exit;
$aNewPhraseSearches = array_merge($aNewPhraseSearches, $aNewWordsetSearches);
usort($aNewPhraseSearches, array('Nominatim\SearchDescription', 'bySearchRank'));
@@ -442,12 +440,10 @@ class Geocode
$iSearchCount = 0;
$aSearches = array();
foreach ($aGroupedSearches as $iScore => $aNewSearches) {
- $iSearchCount += sizeof($aNewSearches);
+ $iSearchCount += count($aNewSearches);
$aSearches = array_merge($aSearches, $aNewSearches);
if ($iSearchCount > 50) break;
}
-
- //if (CONST_Debug) _debugDumpGroupedSearches($aGroupedSearches, $aValidTokens);
}
// Revisit searches, drop bad searches and give penalty to unlikely combinations.
@@ -502,8 +498,11 @@ class Geocode
public function lookup()
{
+ Debug::newFunction('Geocode::lookup');
if (!$this->sQuery && !$this->aStructuredQuery) return array();
+ Debug::printDebugArray('Geocode', $this);
+
$oCtx = new SearchContext();
if ($this->aRoutePoints) {
@@ -523,7 +522,11 @@ class Geocode
$oCtx->setCountryList($this->aCountryCodes);
}
+ Debug::newSection('Query Preprocessing');
+
$sNormQuery = $this->normTerm($this->sQuery);
+ Debug::printVar('Normalized query', $sNormQuery);
+
$sLanguagePrefArraySQL = getArraySQL(
array_map('getDBQuoted', $this->aLangPrefOrder)
);
@@ -543,7 +546,6 @@ class Geocode
// Do we have anything that looks like a lat/lon pair?
$sQuery = $oCtx->setNearPointFromQuery($sQuery);
- $aResults = array();
if ($sQuery || $this->aStructuredQuery) {
// Start with a single blank search
$aSearches = array(new SearchDescription($oCtx));
@@ -560,6 +562,10 @@ class Geocode
$aSpecialTermsRaw,
PREG_SET_ORDER
);
+ if (!empty($aSpecialTermsRaw)) {
+ Debug::printVar('Special terms', $aSpecialTermsRaw);
+ }
+
foreach ($aSpecialTermsRaw as $aSpecialTerm) {
$sQuery = str_replace($aSpecialTerm[0], ' ', $sQuery);
if (!$sSpecialTerm) {
@@ -582,7 +588,8 @@ class Geocode
$sSQL = 'SELECT class, type FROM word ';
$sSQL .= ' WHERE word_token in (\' '.$sToken.'\')';
$sSQL .= ' AND class is not null AND class not in (\'place\')';
- if (CONST_Debug) var_Dump($sSQL);
+
+ Debug::printSQL($sSQL);
$aSearchWords = chksql($this->oDB->getAll($sSQL));
$aNewSearches = array();
foreach ($aSearches as $oSearch) {
@@ -609,10 +616,15 @@ class Geocode
$bStructuredPhrases = false;
}
+ Debug::printDebugArray('Search context', $oCtx);
+ Debug::printDebugArray('Base search', empty($aSearches) ? null : $aSearches[0]);
+ Debug::printVar('Final query phrases', $aInPhrases);
+
// Convert each phrase to standard form
// Create a list of standard words
// Get all 'sets' of words
// Generate a complete list of all
+ Debug::newSection('Tokenization');
$aTokens = array();
$aPhrases = array();
foreach ($aInPhrases as $iPhrase => $sPhrase) {
@@ -627,74 +639,54 @@ class Geocode
}
}
- if (sizeof($aTokens)) {
- // Check which tokens we have, get the ID numbers
+ Debug::printDebugTable('Phrases', $aPhrases);
+ Debug::printVar('Tokens', $aTokens);
+
+ $oValidTokens = new TokenList();
+
+ if (!empty($aTokens)) {
$sSQL = 'SELECT word_id, word_token, word, class, type, country_code, operator, search_name_count';
$sSQL .= ' FROM word ';
$sSQL .= ' WHERE word_token in ('.join(',', array_map('getDBQuoted', $aTokens)).')';
- if (CONST_Debug) var_Dump($sSQL);
+ Debug::printSQL($sSQL);
- $aValidTokens = array();
- $aDatabaseWords = chksql(
- $this->oDB->getAll($sSQL),
- 'Could not get word tokens.'
+ $oValidTokens->addTokensFromDB(
+ $this->oDB,
+ $aTokens,
+ $this->aCountryCodes,
+ $sNormQuery,
+ $this->oNormalizer
);
- $aWordFrequencyScores = array();
- foreach ($aDatabaseWords as $aToken) {
- // Filter country tokens that do not match restricted countries.
- if ($this->aCountryCodes
- && $aToken['country_code']
- && !in_array($aToken['country_code'], $this->aCountryCodes)
- ) {
- continue;
- }
-
- // Special terms need to appear in their normalized form.
- if ($aToken['word'] && $aToken['class']) {
- $sNormWord = $this->normTerm($aToken['word']);
- if (strpos($sNormQuery, $sNormWord) === false) {
- continue;
- }
- }
-
- if (isset($aValidTokens[$aToken['word_token']])) {
- $aValidTokens[$aToken['word_token']][] = $aToken;
- } else {
- $aValidTokens[$aToken['word_token']] = array($aToken);
- }
- $aWordFrequencyScores[$aToken['word_id']] = $aToken['search_name_count'] + 1;
- }
- if (CONST_Debug) var_Dump($aPhrases, $aValidTokens);
- // US ZIP+4 codes - if there is no token, merge in the 5-digit ZIP code
+ // Try more interpretations for Tokens that could not be matched.
foreach ($aTokens as $sToken) {
- if (!isset($aValidTokens[$sToken]) && preg_match('/^([0-9]{5}) [0-9]{4}$/', $sToken, $aData)) {
- if (isset($aValidTokens[$aData[1]])) {
- foreach ($aValidTokens[$aData[1]] as $aToken) {
- if (!$aToken['class']) {
- if (isset($aValidTokens[$sToken])) {
- $aValidTokens[$sToken][] = $aToken;
- } else {
- $aValidTokens[$sToken] = array($aToken);
- }
- }
- }
+ if ($sToken[0] == ' ' && !$oValidTokens->contains($sToken)) {
+ if (preg_match('/^ ([0-9]{5}) [0-9]{4}$/', $sToken, $aData)) {
+ // US ZIP+4 codes - merge in the 5-digit ZIP code
+ $oValidTokens->addToken(
+ $sToken,
+ new Token\Postcode(null, $aData[1], 'us')
+ );
+ } elseif (preg_match('/^ [0-9]+$/', $sToken)) {
+ // Unknown single word token with a number.
+ // Assume it is a house number.
+ $oValidTokens->addToken(
+ $sToken,
+ new Token\HouseNumber(null, trim($sToken))
+ );
}
}
}
- foreach ($aTokens as $sToken) {
- // Unknown single word token with a number - assume it is a house number
- if (!isset($aValidTokens[' '.$sToken]) && strpos($sToken, ' ') === false && preg_match('/^[0-9]+$/', $sToken)) {
- $aValidTokens[' '.$sToken] = array(array('class' => 'place', 'type' => 'house', 'word_token' => ' '.$sToken));
- }
- }
-
// Any words that have failed completely?
// TODO: suggestions
- $aGroupedSearches = $this->getGroupedSearches($aSearches, $aPhrases, $aValidTokens, $bStructuredPhrases);
+ Debug::printGroupTable('Valid Tokens', $oValidTokens->debugInfo());
+
+ Debug::newSection('Search candidates');
+
+ $aGroupedSearches = $this->getGroupedSearches($aSearches, $aPhrases, $oValidTokens, $bStructuredPhrases);
if ($this->bReverseInPlan) {
// Reverse phrase array and also reverse the order of the wordsets in
@@ -702,10 +694,10 @@ class Geocode
// because order in the address doesn't matter.
$aPhrases = array_reverse($aPhrases);
$aPhrases[0]->invertWordSets();
- if (sizeof($aPhrases) > 1) {
- $aPhrases[sizeof($aPhrases)-1]->invertWordSets();
+ if (count($aPhrases) > 1) {
+ $aPhrases[count($aPhrases)-1]->invertWordSets();
}
- $aReverseGroupedSearches = $this->getGroupedSearches($aSearches, $aPhrases, $aValidTokens, false);
+ $aReverseGroupedSearches = $this->getGroupedSearches($aSearches, $aPhrases, $oValidTokens, false);
foreach ($aGroupedSearches as $aSearches) {
foreach ($aSearches as $aSearch) {
@@ -738,31 +730,36 @@ class Geocode
$sHash = serialize($aSearch);
if (isset($aSearchHash[$sHash])) {
unset($aGroupedSearches[$iGroup][$iSearch]);
- if (sizeof($aGroupedSearches[$iGroup]) == 0) unset($aGroupedSearches[$iGroup]);
+ if (empty($aGroupedSearches[$iGroup])) unset($aGroupedSearches[$iGroup]);
} else {
$aSearchHash[$sHash] = 1;
}
}
}
- if (CONST_Debug) _debugDumpGroupedSearches($aGroupedSearches, $aValidTokens);
+ Debug::printGroupedSearch(
+ $aGroupedSearches,
+ $oValidTokens->debugTokenByWordIdList()
+ );
// Start the search process
$iGroupLoop = 0;
$iQueryLoop = 0;
+ $aNextResults = array();
foreach ($aGroupedSearches as $iGroupedRank => $aSearches) {
$iGroupLoop++;
+ $aResults = $aNextResults;
foreach ($aSearches as $oSearch) {
$iQueryLoop++;
- if (CONST_Debug) {
- echo "
Search Loop, group $iGroupLoop, loop $iQueryLoop";
- _debugDumpGroupedSearches(array($iGroupedRank => array($oSearch)), $aValidTokens);
- }
+ Debug::newSection("Search Loop, group $iGroupLoop, loop $iQueryLoop");
+ Debug::printGroupedSearch(
+ array($iGroupedRank => array($oSearch)),
+ $oValidTokens->debugTokenByWordIdList()
+ );
$aResults += $oSearch->query(
$this->oDB,
- $aWordFrequencyScores,
$this->iMinAddressRank,
$this->iMaxAddressRank,
$this->iLimit
@@ -771,7 +768,24 @@ class Geocode
if ($iQueryLoop > 20) break;
}
- if (sizeof($aResults) && ($this->iMinAddressRank != 0 || $this->iMaxAddressRank != 30)) {
+ if (!empty($aResults)) {
+ $aSplitResults = Result::splitResults($aResults);
+ Debug::printVar('Split results', $aSplitResults);
+ if ($iGroupLoop <= 4 && empty($aSplitResults['tail'])
+ && reset($aSplitResults['head'])->iResultRank > 0) {
+ // Haven't found an exact match for the query yet.
+ // Therefore add result from the next group level.
+ $aNextResults = $aSplitResults['head'];
+ foreach ($aNextResults as $oRes) {
+ $oRes->iResultRank--;
+ }
+ $aResults = array();
+ } else {
+ $aResults = $aSplitResults['head'];
+ }
+ }
+
+ if (!empty($aResults) && ($this->iMinAddressRank != 0 || $this->iMaxAddressRank != 30)) {
// Need to verify passes rank limits before dropping out of the loop (yuk!)
// reduces the number of place ids, like a filter
// rank_address is 30 for interpolated housenumbers
@@ -806,7 +820,7 @@ class Geocode
$aFilteredIDs = array();
if ($aFilterSql) {
$sSQL = join(' UNION ', $aFilterSql);
- if (CONST_Debug) var_dump($sSQL);
+ Debug::printSQL($sSQL);
$aFilteredIDs = chksql($this->oDB->getCol($sSQL));
}
@@ -824,7 +838,7 @@ class Geocode
$aResults = $tempIDs;
}
- if (sizeof($aResults)) break;
+ if (!empty($aResults)) break;
if ($iGroupLoop > 4) break;
if ($iQueryLoop > 30) break;
}
@@ -835,7 +849,7 @@ class Geocode
$oLookup = $oReverse->lookupPoint($oCtx->sqlNear, false);
- if (CONST_Debug) var_dump('Reverse search', $aLookup);
+ Debug::printVar('Reverse search', $oLookup);
if ($oLookup) {
$aResults = array($oLookup->iId => $oLookup);
@@ -843,7 +857,7 @@ class Geocode
}
// No results? Done
- if (!sizeof($aResults)) {
+ if (empty($aResults)) {
if ($this->bFallback) {
if ($this->fallbackStructuredQuery()) {
return $this->lookup();
@@ -864,20 +878,17 @@ class Geocode
$aSearchResults = $this->oPlaceLookup->lookup($aResults);
- $aClassType = getClassTypesWithImportance();
+ $aClassType = ClassTypes\getListWithImportance();
$aRecheckWords = preg_split('/\b[\s,\\-]*/u', $sQuery);
foreach ($aRecheckWords as $i => $sWord) {
if (!preg_match('/[\pL\pN]/', $sWord)) unset($aRecheckWords[$i]);
}
- if (CONST_Debug) {
- echo 'Recheck words:<\i>';
- var_dump($aRecheckWords);
- }
+ Debug::printVar('Recheck words', $aRecheckWords);
foreach ($aSearchResults as $iIdx => $aResult) {
// Default
- $fDiameter = getResultDiameter($aResult);
+ $fDiameter = ClassTypes\getProperty($aResult, 'defdiameter', 0.0001);
$aOutlineResult = $this->oPlaceLookup->getOutlines($aResult['place_id'], $aResult['lon'], $aResult['lat'], $fDiameter/2);
if ($aOutlineResult) {
@@ -891,27 +902,15 @@ class Geocode
}
// Is there an icon set for this type of result?
- if (isset($aClassType[$aResult['class'].':'.$aResult['type']]['icon'])
- && $aClassType[$aResult['class'].':'.$aResult['type']]['icon']
- ) {
- $aResult['icon'] = CONST_Website_BaseURL.'images/mapicons/'.$aClassType[$aResult['class'].':'.$aResult['type']]['icon'].'.p.20.png';
- }
+ $aClassInfo = ClassTypes\getInfo($aResult);
- if (isset($aClassType[$aResult['class'].':'.$aResult['type'].':'.$aResult['admin_level']]['label'])
- && $aClassType[$aResult['class'].':'.$aResult['type'].':'.$aResult['admin_level']]['label']
- ) {
- $aResult['label'] = $aClassType[$aResult['class'].':'.$aResult['type'].':'.$aResult['admin_level']]['label'];
- } elseif (isset($aClassType[$aResult['class'].':'.$aResult['type']]['label'])
- && $aClassType[$aResult['class'].':'.$aResult['type']]['label']
- ) {
- $aResult['label'] = $aClassType[$aResult['class'].':'.$aResult['type']]['label'];
- }
- // if tag '&addressdetails=1' is set in query
- if ($this->bIncludeAddressDetails) {
- // getAddressDetails() is defined in lib.php and uses the SQL function get_addressdata in functions.sql
- $aResult['address'] = getAddressDetails($this->oDB, $sLanguagePrefArraySQL, $aResult['place_id'], $aResult['country_code'], $aResults[$aResult['place_id']]->iHouseNumber);
- if ($aResult['extra_place'] == 'city' && !isset($aResult['address']['city'])) {
- $aResult['address'] = array_merge(array('city' => array_values($aResult['address'])[0]), $aResult['address']);
+ if ($aClassInfo) {
+ if (isset($aClassInfo['icon'])) {
+ $aResult['icon'] = CONST_Website_BaseURL.'images/mapicons/'.$aClassInfo['icon'].'.p.20.png';
+ }
+
+ if (isset($aClassInfo['label'])) {
+ $aResult['label'] = $aClassInfo['label'];
}
}
@@ -952,18 +951,16 @@ class Geocode
$aResult['foundorder'] += 0.01;
}
}
- if (CONST_Debug) var_dump($aResult);
$aSearchResults[$iIdx] = $aResult;
}
uasort($aSearchResults, 'byImportance');
+ Debug::printVar('Pre-filter results', $aSearchResults);
$aOSMIDDone = array();
$aClassTypeNameDone = array();
$aToFilter = $aSearchResults;
$aSearchResults = array();
- if (CONST_Debug) var_dump($aToFilter);
-
$bFirst = true;
foreach ($aToFilter as $aResult) {
$this->aExcludePlaceIDs[$aResult['place_id']] = $aResult['place_id'];
@@ -982,10 +979,32 @@ class Geocode
}
// Absolute limit on number of results
- if (sizeof($aSearchResults) >= $this->iFinalLimit) break;
+ if (count($aSearchResults) >= $this->iFinalLimit) break;
}
- if (CONST_Debug) var_dump($aSearchResults);
+ Debug::printVar('Post-filter results', $aSearchResults);
return $aSearchResults;
} // end lookup()
+
+ public function debugInfo()
+ {
+ return array(
+ 'Query' => $this->sQuery,
+ 'Structured query' => $this->aStructuredQuery,
+ 'Name keys' => Debug::fmtArrayVals($this->aLangPrefOrder),
+ 'Excluded place IDs' => Debug::fmtArrayVals($this->aExcludePlaceIDs),
+ 'Try reversed query'=> $this->bReverseInPlan,
+ 'Limit (for searches)' => $this->iLimit,
+ 'Limit (for results)'=> $this->iFinalLimit,
+ 'Country codes' => Debug::fmtArrayVals($this->aCountryCodes),
+ 'Bounded search' => $this->bBoundedSearch,
+ 'Viewbox' => Debug::fmtArrayVals($this->aViewBox),
+ 'Route points' => Debug::fmtArrayVals($this->aRoutePoints),
+ 'Route width' => $this->aRouteWidth,
+ 'Max rank' => $this->iMaxRank,
+ 'Min address rank' => $this->iMinAddressRank,
+ 'Max address rank' => $this->iMaxAddressRank,
+ 'Address rank list' => Debug::fmtArrayVals($this->aAddressRankList)
+ );
+ }
} // end class