X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/d42aa0870592b36ba9c64eae05a0ceafd2467f4c..5a17bfc9c9565a3215f2969182534fedaa6eba07:/lib/Geocode.php diff --git a/lib/Geocode.php b/lib/Geocode.php index ae518d51..6cc2e4cb 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 { @@ -225,14 +226,14 @@ class Geocode $aViewbox = $oParams->getStringList('viewboxlbrt'); if ($aViewbox) { if (count($aViewbox) != 4) { - userError("Bad parmater 'viewboxlbrt'. Expected 4 coordinates."); + userError("Bad parameter 'viewboxlbrt'. Expected 4 coordinates."); } $this->setViewbox($aViewbox); } else { $aViewbox = $oParams->getStringList('viewbox'); if ($aViewbox) { if (count($aViewbox) != 4) { - userError("Bad parmater 'viewbox'. Expected 4 coordinates."); + userError("Bad parameter 'viewbox'. Expected 4 coordinates."); } $this->setViewBox($aViewbox); } else { @@ -303,7 +304,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 +318,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 +333,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 @@ -345,8 +346,6 @@ class Geocode Score how good the search is so they can be ordered */ - $iGlobalRank = 0; - foreach ($aPhrases as $iPhrase => $oPhrase) { $aNewPhraseSearches = array(); $sPhraseType = $bIsStructured ? $oPhrase->getPhraseType() : ''; @@ -367,39 +366,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), - $iGlobalRank - ); - - 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) { @@ -414,7 +411,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')); @@ -445,12 +442,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. @@ -460,7 +455,7 @@ class Geocode continue; } - $iRank = $oSearch->addToRank($iGlobalRank); + $iRank = $oSearch->getRank(); if (!isset($aGroupedSearches[$iRank])) { $aGroupedSearches[$iRank] = array(); } @@ -482,9 +477,9 @@ class Geocode osm_id: id of corresponding OSM object class: general object class (corresponds to tag key of primary OSM tag) type: subclass of object (corresponds to tag value of primary OSM tag) - admin_level: see http://wiki.openstreetmap.org/wiki/Admin_level + admin_level: see https://wiki.openstreetmap.org/wiki/Admin_level rank_search: rank in search hierarchy - (see also http://wiki.openstreetmap.org/wiki/Nominatim/Development_overview#Country_to_street_level) + (see also https://wiki.openstreetmap.org/wiki/Nominatim/Development_overview#Country_to_street_level) rank_address: rank in address hierarchy (determines orer in address) place_id: internal key (may differ between different instances) country_code: ISO country code @@ -505,8 +500,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) { @@ -526,21 +524,25 @@ 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) + array_map('getDBQuoted', $this->aLangPrefOrder) ); $sQuery = $this->sQuery; if (!preg_match('//u', $sQuery)) { - userError("Query string is not UTF-8 encoded."); + userError('Query string is not UTF-8 encoded.'); } // Conflicts between US state abreviations and various words for 'the' in different languages if (isset($this->aLangPrefOrder['name:en'])) { - $sQuery = preg_replace('/(^|,)\s*il\s*(,|$)/', '\1illinois\2', $sQuery); - $sQuery = preg_replace('/(^|,)\s*al\s*(,|$)/', '\1alabama\2', $sQuery); - $sQuery = preg_replace('/(^|,)\s*la\s*(,|$)/', '\1louisiana\2', $sQuery); + $sQuery = preg_replace('/(^|,)\s*il\s*(,|$)/i', '\1illinois\2', $sQuery); + $sQuery = preg_replace('/(^|,)\s*al\s*(,|$)/i', '\1alabama\2', $sQuery); + $sQuery = preg_replace('/(^|,)\s*la\s*(,|$)/i', '\1louisiana\2', $sQuery); } // Do we have anything that looks like a lat/lon pair? @@ -563,6 +565,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) { @@ -580,12 +586,13 @@ class Geocode $sSpecialTerm = pg_escape_string($sSpecialTerm); $sToken = chksql( $this->oDB->getOne("SELECT make_standard_name('$sSpecialTerm')"), - "Cannot decode query. Wrong encoding?" + 'Cannot decode query. Wrong encoding?' ); $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) { @@ -612,16 +619,21 @@ 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) { $sPhrase = chksql( $this->oDB->getOne('SELECT make_standard_name('.getDBQuoted($sPhrase).')'), - "Cannot normalize query string (is it a UTF-8 string?)" + 'Cannot normalize query string (is it a UTF-8 string?)' ); if (trim($sPhrase)) { $oPhrase = new Phrase($sPhrase, is_string($iPhrase) ? $iPhrase : ''); @@ -630,74 +642,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)).')'; + $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 @@ -705,10 +697,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) { @@ -741,14 +733,17 @@ 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; @@ -758,14 +753,14 @@ class Geocode 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 @@ -774,7 +769,7 @@ class Geocode if ($iQueryLoop > 20) break; } - if (sizeof($aResults) && ($this->iMinAddressRank != 0 || $this->iMaxAddressRank != 30)) { + 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 @@ -783,15 +778,15 @@ class Geocode if ($sPlaceIds) { $sSQL = 'SELECT place_id FROM placex '; $sSQL .= 'WHERE place_id in ('.$sPlaceIds.') '; - $sSQL .= " AND ("; + $sSQL .= ' AND ('; $sSQL .= " placex.rank_address between $this->iMinAddressRank and $this->iMaxAddressRank "; if (14 >= $this->iMinAddressRank && 14 <= $this->iMaxAddressRank) { $sSQL .= " OR (extratags->'place') = 'city'"; } if ($this->aAddressRankList) { - $sSQL .= " OR placex.rank_address in (".join(',', $this->aAddressRankList).")"; + $sSQL .= ' OR placex.rank_address in ('.join(',', $this->aAddressRankList).')'; } - $sSQL .= ")"; + $sSQL .= ')'; $aFilterSql[] = $sSQL; } $sPlaceIds = Result::joinIdsByTable($aResults, Result::TABLE_POSTCODE); @@ -800,16 +795,16 @@ class Geocode $sSQL .= 'WHERE place_id in ('.$sPlaceIds.') '; $sSQL .= " AND (lp.rank_address between $this->iMinAddressRank and $this->iMaxAddressRank "; if ($this->aAddressRankList) { - $sSQL .= " OR lp.rank_address in (".join(',', $this->aAddressRankList).")"; + $sSQL .= ' OR lp.rank_address in ('.join(',', $this->aAddressRankList).')'; } - $sSQL .= ") "; + $sSQL .= ') '; $aFilterSql[] = $sSQL; } $aFilteredIDs = array(); if ($aFilterSql) { $sSQL = join(' UNION ', $aFilterSql); - if (CONST_Debug) var_dump($sSQL); + Debug::printSQL($sSQL); $aFilteredIDs = chksql($this->oDB->getCol($sSQL)); } @@ -827,7 +822,7 @@ class Geocode $aResults = $tempIDs; } - if (sizeof($aResults)) break; + if (!empty($aResults)) break; if ($iGroupLoop > 4) break; if ($iQueryLoop > 30) break; } @@ -838,7 +833,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); @@ -846,7 +841,7 @@ class Geocode } // No results? Done - if (!sizeof($aResults)) { + if (empty($aResults)) { if ($this->bFallback) { if ($this->fallbackStructuredQuery()) { return $this->lookup(); @@ -873,10 +868,7 @@ class Geocode 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 @@ -924,18 +916,18 @@ class Geocode $aResult['importance'] = 0.001; $aResult['foundorder'] = $aResult['addressimportance']; } else { - // Adjust importance for the number of exact string matches in the result + $aResult['importance'] = max(0.001, $aResult['importance']); $aResult['importance'] *= $this->viewboxImportanceFactor( $aResult['lon'], $aResult['lat'] ); - $aResult['importance'] = max(0.001, $aResult['importance']); + // Adjust importance for the number of exact string matches in the result $iCountWords = 0; $sAddress = $aResult['langaddress']; foreach ($aRecheckWords as $i => $sWord) { if (stripos($sAddress, $sWord)!==false) { $iCountWords++; - if (preg_match("/(^|,)\s*".preg_quote($sWord, '/')."\s*(,|$)/", $sAddress)) $iCountWords += 0.1; + if (preg_match('/(^|,)\s*'.preg_quote($sWord, '/').'\s*(,|$)/', $sAddress)) $iCountWords += 0.1; } } @@ -955,18 +947,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']; @@ -985,10 +975,33 @@ 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), + 'Include address' => $this->bIncludeAddressDetails, + '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