<?php
+/**
+ * SPDX-License-Identifier: GPL-2.0-only
+ *
+ * This file is part of Nominatim. (https://nominatim.org)
+ *
+ * Copyright (C) 2022 by the Nominatim developer community.
+ * For a full list of authors see the git log.
+ */
namespace Nominatim;
private $aName = array();
/// True if the name is rare enough to force index use on name.
private $bRareName = false;
+ /// True if the name requires to be accompanied by address terms.
+ private $bNameNeedsAddress = false;
/// List of word ids making up the address of the object.
private $aAddress = array();
/// List of word ids that appear in the name but should be ignored.
return false;
}
}
+ if ($this->bNameNeedsAddress && empty($this->aAddress)) {
+ return false;
+ }
return true;
}
/////////// Search building functions
+
+ /**
+ * Create a copy of this search description adding to search rank.
+ *
+ * @param integer $iTermCost Cost to add to the current search rank.
+ *
+ * @return object Cloned search description.
+ */
public function clone($iTermCost)
{
$oSearch = clone $this;
return $oSearch;
}
+ /**
+ * Check if the search currently includes a name.
+ *
+ * @param bool bIncludeNonNames If true stop-word tokens are taken into
+ * account, too.
+ *
+ * @return bool True, if search has a name.
+ */
public function hasName($bIncludeNonNames = false)
{
return !empty($this->aName)
|| (!empty($this->aNameNonSearch) && $bIncludeNonNames);
}
+ /**
+ * Check if the search currently includes an address term.
+ *
+ * @return bool True, if any address term is included, including stop-word
+ * terms.
+ */
public function hasAddress()
{
return !empty($this->aAddress) || !empty($this->aAddressNonSearch);
}
+ /**
+ * Check if a country restriction is currently included in the search.
+ *
+ * @return bool True, if a country restriction is set.
+ */
public function hasCountry()
{
return $this->sCountryCode !== '';
}
+ /**
+ * Check if a postcode is currently included in the search.
+ *
+ * @return bool True, if a postcode is set.
+ */
public function hasPostcode()
{
return $this->sPostcode !== '';
}
+ /**
+ * Check if a house number is set for the search.
+ *
+ * @return bool True, if a house number is set.
+ */
public function hasHousenumber()
{
return $this->sHouseNumber !== '';
}
+ /**
+ * Check if a special type of place is requested.
+ *
+ * param integer iOperator When set, check for the particular
+ * operator used for the special type.
+ *
+ * @return bool True, if speial type is requested or, if requested,
+ * a special type with the given operator.
+ */
public function hasOperator($iOperator = null)
{
return $iOperator === null ? $this->iOperator != Operator::NONE : $this->iOperator == $iOperator;
}
+ /**
+ * Add the given token to the list of terms to search for in the address.
+ *
+ * @param integer iID ID of term to add.
+ * @param bool bSearchable Term should be used to search for result
+ * (i.e. term is not a stop word).
+ */
public function addAddressToken($iId, $bSearchable = true)
{
if ($bSearchable) {
}
}
- public function addNameToken($iId)
+ /**
+ * Add the given full-word token to the list of terms to search for in the
+ * name.
+ *
+ * @param interger iId ID of term to add.
+ * @param bool bRareName True if the term is infrequent enough to not
+ * require other constraints for efficient search.
+ */
+ public function addNameToken($iId, $bRareName)
{
$this->aName[$iId] = $iId;
+ $this->bRareName = $bRareName;
+ $this->bNameNeedsAddress = false;
}
- public function addPartialNameToken($iId, $bSearchable, $iPhraseNumber)
+ /**
+ * Add the given partial token to the list of terms to search for in
+ * the name.
+ *
+ * @param integer iID ID of term to add.
+ * @param bool bSearchable Term should be used to search for result
+ * (i.e. term is not a stop word).
+ * @param bool bNeedsAddress True if the term is too unspecific to be used
+ * in a stand-alone search without an address
+ * to narrow down the search.
+ * @param integer iPhraseNumber Index of phrase, where the partial term
+ * appears.
+ */
+ public function addPartialNameToken($iId, $bSearchable, $bNeedsAddress, $iPhraseNumber)
{
+ if (empty($this->aName)) {
+ $this->bNameNeedsAddress = $bNeedsAddress;
+ } else {
+ $this->bNameNeedsAddress &= $bNeedsAddress;
+ }
if ($bSearchable) {
$this->aName[$iId] = $iId;
} else {
$this->iNamePhrase = $iPhraseNumber;
}
- public function markRareName()
- {
- $this->bRareName = true;
- }
-
+ /**
+ * Set country restriction for the search.
+ *
+ * @param string sCountryCode Country code of country to restrict search to.
+ */
public function setCountry($sCountryCode)
{
$this->sCountryCode = $sCountryCode;
$this->iNamePhrase = -1;
}
+ /**
+ * Set postcode search constraint.
+ *
+ * @param string sPostcode Postcode the result should have.
+ */
public function setPostcode($sPostcode)
{
$this->sPostcode = $sPostcode;
$this->iNamePhrase = -1;
}
+ /**
+ * Make this search a search for a postcode object.
+ *
+ * @param integer iId Token Id for the postcode.
+ * @param string sPostcode Postcode to look for.
+ */
public function setPostcodeAsName($iId, $sPostcode)
{
$this->iOperator = Operator::POSTCODE;
$this->iNamePhrase = -1;
}
+ /**
+ * Set house number search cnstraint.
+ *
+ * @param string sNumber House number the result should have.
+ */
public function setHousenumber($sNumber)
{
$this->sHouseNumber = $sNumber;
$this->iNamePhrase = -1;
}
+ /**
+ * Make this search a search for a house number.
+ *
+ * @param integer iId Token Id for the house number.
+ */
public function setHousenumberAsName($iId)
{
$this->aAddress = array_merge($this->aAddress, $this->aName);
$this->bRareName = false;
+ $this->bNameNeedsAddress = true;
$this->aName = array($iId => $iId);
$this->iNamePhrase = -1;
}
return $this->iNamePhrase;
}
+ /**
+ * Get the global search context.
+ *
+ * @return object Objects of global search constraints.
+ */
public function getContext()
{
return $this->oContext;
$iLimit
);
- // Now search for housenumber, if housenumber provided. Can be zero.
- if (($this->sHouseNumber || $this->sHouseNumber === '0') && !empty($aResults)) {
- $aHnResults = $this->queryHouseNumber($oDB, $aResults);
-
- // Downgrade the rank of the street results, they are missing
- // the housenumber. Also drop POI places (rank 30) here, they
- // cannot be a parent place and therefore must not be shown
- // as a result for a search with a missing housenumber.
- foreach ($aResults as $oRes) {
- if ($oRes->iAddressRank < 28) {
- if ($oRes->iAddressRank >= 26) {
- $oRes->iResultRank++;
- } else {
- $oRes->iResultRank += 2;
- }
- $aHnResults[$oRes->iId] = $oRes;
- }
- }
-
- $aResults = $aHnResults;
- }
-
// finally get POIs if requested
if ($this->sClass && !empty($aResults)) {
$aResults = $this->queryPoiByOperator($oDB, $aResults, $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 && ($this->bRareName || !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 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);
}
$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))";
+ $aTerms[] = "EXISTS(SELECT place_id FROM location_postcode p WHERE p.postcode = '".$this->sPostcode."' AND ST_DWithin(search_name.centroid, p.geometry, 0.12))";
} else {
$aOrder[] = "(SELECT min(ST_Distance(search_name.centroid, p.geometry)) FROM location_postcode p WHERE p.postcode = '".$this->sPostcode."')";
}
$aTerms[] = 'centroid && '.$this->oContext->sqlViewboxSmall;
}
- if ($this->oContext->hasNearPoint()) {
- $aOrder[] = $this->oContext->distanceSQL('centroid');
- }
-
if ($this->sHouseNumber) {
$sImportanceSQL = '- abs(26 - address_rank) + 3';
} else {
$sExactMatchSQL = '0::int as exactmatch';
}
- if ($this->sHouseNumber || $this->sClass) {
- $iLimit = 40;
+ if (empty($aTerms)) {
+ return array();
}
- $aResults = array();
-
- if (!empty($aTerms)) {
- $sSQL = 'SELECT place_id, address_rank,'.$sExactMatchSQL;
- $sSQL .= ' FROM search_name';
- $sSQL .= ' WHERE '.join(' and ', $aTerms);
- $sSQL .= ' ORDER BY '.join(', ', $aOrder);
- $sSQL .= ' LIMIT '.$iLimit;
+ if ($this->hasHousenumber()) {
+ $sHouseNumberRegex = $oDB->getDBQuoted('\\\\m'.$this->sHouseNumber.'\\\\M');
- Debug::printSQL($sSQL);
+ // Housenumbers on streets and places.
+ $sPlacexSql = 'SELECT array_agg(place_id) FROM placex';
+ $sPlacexSql .= ' WHERE parent_place_id = sin.place_id AND sin.address_rank < 30';
+ $sPlacexSql .= ' and housenumber ~* E'.$sHouseNumberRegex;
- $aDBResults = $oDB->getAll($sSQL, null, 'Could not get places for search terms.');
+ // Interpolations on streets and places.
+ $sInterpolSql = 'null';
+ $sTigerSql = 'null';
+ if (preg_match('/^[0-9]+$/', $this->sHouseNumber)) {
+ $sIpolHnr = 'WHERE parent_place_id = sin.place_id ';
+ $sIpolHnr .= ' AND startnumber is not NULL AND sin.address_rank < 30';
+ $sIpolHnr .= ' AND '.$this->sHouseNumber.' between startnumber and endnumber';
+ $sIpolHnr .= ' AND ('.$this->sHouseNumber.' - startnumber) % step = 0';
- foreach ($aDBResults as $aResult) {
- $oResult = new Result($aResult['place_id']);
- $oResult->iExactMatches = $aResult['exactmatch'];
- $oResult->iAddressRank = $aResult['address_rank'];
- $aResults[$aResult['place_id']] = $oResult;
+ $sInterpolSql = 'SELECT array_agg(place_id) FROM location_property_osmline '.$sIpolHnr;
+ if (CONST_Use_US_Tiger_Data) {
+ $sTigerSql = 'SELECT array_agg(place_id) FROM location_property_tiger '.$sIpolHnr;
+ $sTigerSql .= " and sin.country_code = 'us'";
+ }
}
- }
-
- return $aResults;
- }
- private function queryHouseNumber(&$oDB, $aRoadPlaceIDs)
- {
- $aResults = array();
- $sRoadPlaceIDs = Result::joinIdsByTableMaxRank(
- $aRoadPlaceIDs,
- Result::TABLE_PLACEX,
- 27
- );
- $sPOIPlaceIDs = Result::joinIdsByTableMinRank(
- $aRoadPlaceIDs,
- Result::TABLE_PLACEX,
- 30
- );
+ if ($this->sClass) {
+ $iLimit = 40;
+ }
- $aIDCondition = array();
- if ($sRoadPlaceIDs) {
- $aIDCondition[] = 'parent_place_id in ('.$sRoadPlaceIDs.')';
- }
- if ($sPOIPlaceIDs) {
- $aIDCondition[] = 'place_id in ('.$sPOIPlaceIDs.')';
- }
+ $sSelfHnr = 'SELECT * FROM placex WHERE place_id = search_name.place_id';
+ $sSelfHnr .= ' AND housenumber ~* E'.$sHouseNumberRegex;
+
+ $aTerms[] = '(address_rank < 30 or exists('.$sSelfHnr.'))';
+
+
+ $sSQL = 'SELECT sin.*, ';
+ $sSQL .= '('.$sPlacexSql.') as placex_hnr, ';
+ $sSQL .= '('.$sInterpolSql.') as interpol_hnr, ';
+ $sSQL .= '('.$sTigerSql.') as tiger_hnr ';
+ $sSQL .= ' FROM (';
+ $sSQL .= ' SELECT place_id, address_rank, country_code,'.$sExactMatchSQL.',';
+ $sSQL .= ' CASE WHEN importance = 0 OR importance IS NULL';
+ $sSQL .= ' THEN 0.75001-(search_rank::float/40) ELSE importance END as importance';
+ $sSQL .= ' FROM search_name';
+ $sSQL .= ' WHERE '.join(' and ', $aTerms);
+ $sSQL .= ' ORDER BY '.join(', ', $aOrder);
+ $sSQL .= ' LIMIT 40000';
+ $sSQL .= ') as sin';
+ $sSQL .= ' ORDER BY address_rank = 30 desc, placex_hnr, interpol_hnr, tiger_hnr,';
+ $sSQL .= ' importance';
+ $sSQL .= ' LIMIT '.$iLimit;
+ } else {
+ if ($this->sClass) {
+ $iLimit = 40;
+ }
- if (empty($aIDCondition)) {
- return $aResults;
+ $sSQL = 'SELECT place_id, address_rank, '.$sExactMatchSQL;
+ $sSQL .= ' FROM search_name';
+ $sSQL .= ' WHERE '.join(' and ', $aTerms);
+ $sSQL .= ' ORDER BY '.join(', ', $aOrder);
+ $sSQL .= ' LIMIT '.$iLimit;
}
- $sHouseNumberRegex = '\\\\m'.$this->sHouseNumber.'\\\\M';
- $sSQL = 'SELECT place_id FROM placex WHERE';
- $sSQL .= " housenumber ~* E'".$sHouseNumberRegex."'";
- $sSQL .= ' AND ('.join(' OR ', $aIDCondition).')';
- $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 && $sRoadPlaceIDs && 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 ('.$sRoadPlaceIDs.') 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');
+ $aDBResults = $oDB->getAll($sSQL, null, 'Could not get places for search terms.');
- Debug::printSQL($sSQL);
+ $aResults = array();
- foreach ($oDB->getCol($sSQL) as $iPlaceId) {
- $oResult = new Result($iPlaceId, Result::TABLE_OSMLINE);
- $oResult->iHouseNumber = $iHousenumber;
- $aResults[$iPlaceId] = $oResult;
- }
- }
+ foreach ($aDBResults as $aResult) {
+ $oResult = new Result($aResult['place_id']);
+ $oResult->iExactMatches = $aResult['exactmatch'];
+ $oResult->iAddressRank = $aResult['address_rank'];
+
+ $bNeedResult = true;
+ if ($this->hasHousenumber() && $aResult['address_rank'] < 30) {
+ if ($aResult['placex_hnr']) {
+ foreach (explode(',', substr($aResult['placex_hnr'], 1, -1)) as $sPlaceID) {
+ $iPlaceID = intval($sPlaceID);
+ $oHnrResult = new Result($iPlaceID);
+ $oHnrResult->iExactMatches = $aResult['exactmatch'];
+ $oHnrResult->iAddressRank = 30;
+ $aResults[$iPlaceID] = $oHnrResult;
+ $bNeedResult = false;
+ }
+ }
+ if ($aResult['interpol_hnr']) {
+ foreach (explode(',', substr($aResult['interpol_hnr'], 1, -1)) as $sPlaceID) {
+ $iPlaceID = intval($sPlaceID);
+ $oHnrResult = new Result($iPlaceID, Result::TABLE_OSMLINE);
+ $oHnrResult->iExactMatches = $aResult['exactmatch'];
+ $oHnrResult->iAddressRank = 30;
+ $oHnrResult->iHouseNumber = intval($this->sHouseNumber);
+ $aResults[$iPlaceID] = $oHnrResult;
+ $bNeedResult = false;
+ }
+ }
+ if ($aResult['tiger_hnr']) {
+ foreach (explode(',', substr($aResult['tiger_hnr'], 1, -1)) as $sPlaceID) {
+ $iPlaceID = intval($sPlaceID);
+ $oHnrResult = new Result($iPlaceID, Result::TABLE_TIGER);
+ $oHnrResult->iExactMatches = $aResult['exactmatch'];
+ $oHnrResult->iAddressRank = 30;
+ $oHnrResult->iHouseNumber = intval($this->sHouseNumber);
+ $aResults[$iPlaceID] = $oHnrResult;
+ $bNeedResult = false;
+ }
+ }
- // If nothing found then search in Tiger data (location_property_tiger)
- if (CONST_Use_US_Tiger_Data && $sRoadPlaceIDs && $bIsIntHouseNumber && empty($aResults)) {
- $sSQL = 'SELECT place_id FROM location_property_tiger';
- $sSQL .= ' WHERE parent_place_id in ('.$sRoadPlaceIDs.') and (';
- if ($iHousenumber % 2 == 0) {
- $sSQL .= "interpolationtype='even'";
- } else {
- $sSQL .= "interpolationtype='odd'";
+ if ($aResult['address_rank'] < 26) {
+ $oResult->iResultRank += 2;
+ } else {
+ $oResult->iResultRank++;
+ }
}
- $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;
+ if ($bNeedResult) {
+ $aResults[$aResult['place_id']] = $oResult;
}
}
projects / nominatim.git / blobdiff