]> git.openstreetmap.org Git - nominatim.git/blobdiff - lib/PlaceLookup.php
use Result class in reverse geocoding
[nominatim.git] / lib / PlaceLookup.php
index e00163378a3d48a8555864f4a8f1d75f1fec3b22..933ab00ca8890f742a982ebb29c48b15378b69a5 100644 (file)
 <?php
-       class PlaceLookup
-       {
-               protected $oDB;
-
-               protected $iPlaceID;
-
-               protected $aLangPrefOrder = array();
-
-               protected $bAddressDetails = false;
-
-               function PlaceLookup(&$oDB)
-               {
-                       $this->oDB =& $oDB;
-               }
-
-               function setLanguagePreference($aLangPrefOrder)
-               {
-                       $this->aLangPrefOrder = $aLangPrefOrder;
-               }
-
-               function setIncludeAddressDetails($bAddressDetails = true)
-               {
-                       $this->bAddressDetails = $bAddressDetails;
-               }
-
-               function setPlaceID($iPlaceID)
-               {
-                       $this->iPlaceID = $iPlaceID;
-               }
-
-               function setOSMID($sType, $iID)
-               {
-                       $sSQL = "select place_id from placex where osm_type = '".pg_escape_string($sType)."' and osm_id = ".(int)$iID." order by type = 'postcode' asc";
-                       $this->iPlaceID = $this->oDB->getOne($sSQL);
-               }
-
-               function lookup()
-               {
-                       if (!$this->iPlaceID) return null;
-
-                       $sLanguagePrefArraySQL = "ARRAY[".join(',',array_map("getDBQuoted", $this->aLangPrefOrder))."]";
-
-                       $sSQL = "select placex.place_id, partition, osm_type, osm_id, class, type, admin_level, housenumber, street, isin, postcode, country_code, extratags, parent_place_id, linked_place_id, rank_address, rank_search, ";
-                       $sSQL .= " coalesce(importance,0.75-(rank_search::float/40)) as importance, indexed_status, indexed_date, wikipedia, calculated_country_code, ";
-                       $sSQL .= " get_address_by_language(place_id, $sLanguagePrefArraySQL) as langaddress,";
-                       $sSQL .= " get_name_by_language(name, $sLanguagePrefArraySQL) as placename,";
-                       $sSQL .= " get_name_by_language(name, ARRAY['ref']) as ref,";
-                       $sSQL .= " st_y(centroid) as lat, st_x(centroid) as lon";
-                       $sSQL .= " from placex where place_id = ".(int)$this->iPlaceID;
-                       $aPlace = $this->oDB->getRow($sSQL);
-
-                       if (!$aPlace['place_id']) return null;
-
-                       if ($this->bAddressDetails)
-                       {
-                               $aAddress = $this->getAddressNames();
-                               $aPlace['aAddress'] = $aAddress;
-                       }
-
-                       $aClassType = getClassTypes();
-                       $sAddressType = '';
-                       $sClassType = $aPlace['class'].':'.$aPlace['type'].':'.$aPlace['admin_level'];
-                       if (isset($aClassType[$sClassType]) && isset($aClassType[$sClassType]['simplelabel']))
-                       {
-                               $sAddressType = $aClassType[$aClassType]['simplelabel'];
-                       }
-                       else
-                       {
-                               $sClassType = $aPlace['class'].':'.$aPlace['type'];
-                               if (isset($aClassType[$sClassType]) && isset($aClassType[$sClassType]['simplelabel']))
-                                       $sAddressType = $aClassType[$sClassType]['simplelabel'];
-                               else $sAddressType = $aPlace['class'];
-                       }
-
-                       $aPlace['addresstype'] = $sAddressType;
-
-                       return $aPlace;
-               }
-
-               function getAddressDetails($bAll = false)
-               {
-                       if (!$this->iPlaceID) return null;
-
-                       $sLanguagePrefArraySQL = "ARRAY[".join(',',array_map("getDBQuoted", $this->aLangPrefOrder))."]";
-
-                       $sSQL = "select *,get_name_by_language(name,$sLanguagePrefArraySQL) as localname from get_addressdata(".$this->iPlaceID.")";
-                       if (!$bAll) $sSQL .= " WHERE isaddress OR type = 'country_code'";
-                       $sSQL .= " order by rank_address desc,isaddress desc";
-
-                       $aAddressLines = $this->oDB->getAll($sSQL);
-                       if (PEAR::IsError($aAddressLines))
-                       {
-                               var_dump($aAddressLines);
-                               exit;
-                       }
-                       return $aAddressLines;
-               }
-
-               function getAddressNames()
-               {
-                       $aAddressLines = $this->getAddressDetails(false);;
-
-                       $aAddress = array();
-                       $aFallback = array();
-                       $aClassType = getClassTypes();
-                       foreach($aAddressLines as $aLine)
-                       {
-                               $bFallback = false;
-                               $aTypeLabel = false;
-                               if (isset($aClassType[$aLine['class'].':'.$aLine['type'].':'.$aLine['admin_level']])) $aTypeLabel = $aClassType[$aLine['class'].':'.$aLine['type'].':'.$aLine['admin_level']];
-                               elseif (isset($aClassType[$aLine['class'].':'.$aLine['type']])) $aTypeLabel = $aClassType[$aLine['class'].':'.$aLine['type']];
-                               elseif (isset($aClassType['boundary:administrative:'.((int)($aLine['rank_address']/2))]))
-                               {
-                                       $aTypeLabel = $aClassType['boundary:administrative:'.((int)($aLine['rank_address']/2))];
-                                       $bFallback = true;
-                               }
-                               else
-                               {
-                                       $aTypeLabel = array('simplelabel'=>'address'.$aLine['rank_address']);
-                                       $bFallback = true;
-                               }
-                               if ($aTypeLabel && ((isset($aLine['localname']) && $aLine['localname']) || (isset($aLine['housenumber']) && $aLine['housenumber'])))
-                               {
-                                       $sTypeLabel = strtolower(isset($aTypeLabel['simplelabel'])?$aTypeLabel['simplelabel']:$aTypeLabel['label']);
-                                       $sTypeLabel = str_replace(' ','_',$sTypeLabel);
-                                       if (!isset($aAddress[$sTypeLabel]) || (isset($aFallback[$sTypeLabel]) && $aFallback[$sTypeLabel]) || $aLine['class'] == 'place')
-                                       {
-                                               $aAddress[$sTypeLabel] = $aLine['localname']?$aLine['localname']:$aLine['housenumber'];
-                                       }
-                                       $aFallback[$sTypeLabel] = $bFallback;
-                               }
-                       }
-                       return $aAddress;
-               }
-
-       }
-?>
+
+namespace Nominatim;
+
+require_once(CONST_BasePath.'/lib/Result.php');
+
+class PlaceLookup
+{
+    protected $oDB;
+
+    protected $aLangPrefOrder = array();
+
+    protected $bAddressDetails = false;
+    protected $bExtraTags = false;
+    protected $bNameDetails = false;
+
+    protected $bIncludePolygonAsPoints = false;
+    protected $bIncludePolygonAsText = false;
+    protected $bIncludePolygonAsGeoJSON = false;
+    protected $bIncludePolygonAsKML = false;
+    protected $bIncludePolygonAsSVG = false;
+    protected $fPolygonSimplificationThreshold = 0.0;
+
+
+    public function __construct(&$oDB)
+    {
+        $this->oDB =& $oDB;
+    }
+
+    public function setLanguagePreference($aLangPrefOrder)
+    {
+        $this->aLangPrefOrder = $aLangPrefOrder;
+    }
+
+    public function setIncludeAddressDetails($bAddressDetails = true)
+    {
+        $this->bAddressDetails = $bAddressDetails;
+    }
+
+    public function setIncludeExtraTags($bExtraTags = false)
+    {
+        $this->bExtraTags = $bExtraTags;
+    }
+
+    public function setIncludeNameDetails($bNameDetails = false)
+    {
+        $this->bNameDetails = $bNameDetails;
+    }
+
+    public function setIncludePolygonAsPoints($b = true)
+    {
+        $this->bIncludePolygonAsPoints = $b;
+    }
+
+    public function setIncludePolygonAsText($b = true)
+    {
+        $this->bIncludePolygonAsText = $b;
+    }
+
+    public function setIncludePolygonAsGeoJSON($b = true)
+    {
+        $this->bIncludePolygonAsGeoJSON = $b;
+    }
+
+    public function setIncludePolygonAsKML($b = true)
+    {
+        $this->bIncludePolygonAsKML = $b;
+    }
+
+    public function setIncludePolygonAsSVG($b = true)
+    {
+        $this->bIncludePolygonAsSVG = $b;
+    }
+
+    public function setPolygonSimplificationThreshold($f)
+    {
+        $this->fPolygonSimplificationThreshold = $f;
+    }
+
+    private function languagePrefSql()
+    {
+        return 'ARRAY['.join(',', array_map('getDBQuoted', $this->aLangPrefOrder)).']';
+    }
+
+    public function lookupOSMID($sType, $iID)
+    {
+        $sSQL = "select place_id from placex where osm_type = '".$sType."' and osm_id = ".$iID;
+        $iPlaceID = chksql($this->oDB->getOne($sSQL));
+
+        if (!$iPlaceID) {
+            return null;
+        }
+
+        return $this->lookup(new Result($iPlaceID));
+    }
+
+    public function lookup($oResult)
+    {
+        if ($oResult === null) {
+            return null;
+        }
+
+        $sLanguagePrefArraySQL = $this->languagePrefSql();
+        $iPlaceID = $oResult->iId;
+
+        if ($oResult->iTable == Result::TABLE_TIGER) {
+            $sSQL = "select place_id,partition, 'T' as osm_type, place_id as osm_id, 'place' as class, 'house' as type, null as admin_level,";
+            $sSQL .= $oResult->iHouseNumber.' as housenumber, postcode,';
+            $sSQL .= " 'us' as country_code, parent_place_id, null as linked_place_id, 30 as rank_address, 30 as rank_search,";
+            $sSQL .= " coalesce(null,0.75-(30::float/40)) as importance, null as indexed_status, null as indexed_date, null as wikipedia, 'us' as country_code, ";
+            $sSQL .= " get_address_by_language(place_id,".$oResult->iHouseNumber.", $sLanguagePrefArraySQL) as langaddress,";
+            $sSQL .= " null as placename,";
+            $sSQL .= " null as ref,";
+            if ($this->bExtraTags) $sSQL .= " null as extra,";
+            if ($this->bNameDetails) $sSQL .= " null as names,";
+            $sSQL .= " ST_X(point) as lon, ST_Y(point) as lat";
+            $sSQL .= " FROM (select *, ST_LineInterpolatePoint(linegeo, (".$oResult->iHouseNumber."-startnumber::float)/(endnumber-startnumber)::float) as point ";
+            $sSQL .= " FROM location_property_tiger where place_id = ".$iPlaceID.") as blub";
+        } elseif ($oResult->iTable == Result::TABLE_OSMLINE) {
+            $sSQL = "select place_id, partition, 'W' as osm_type, osm_id, 'place' as class, 'house' as type, null admin_level,";
+            $sSQL .= $oResult->iHouseNumber.' as housenumber, postcode,';
+            $sSQL .= " country_code, parent_place_id, null as linked_place_id, 30 as rank_address, 30 as rank_search,";
+            $sSQL .= " (0.75-(30::float/40)) as importance, null as indexed_status, null as indexed_date, null as wikipedia, country_code, ";
+            $sSQL .= " get_address_by_language(place_id,".$oResult->iHouseNumber.", $sLanguagePrefArraySQL) as langaddress,";
+            $sSQL .= " null as placename,";
+            $sSQL .= " null as ref,";
+            if ($this->bExtraTags) $sSQL .= " null as extra,";
+            if ($this->bNameDetails) $sSQL .= " null as names,";
+            $sSQL .= " ST_X(point) as lon, ST_Y(point) as lat ";
+            $sSQL .= " FROM (select *, ST_LineInterpolatePoint(linegeo, (".$oResult->iHouseNumber."-startnumber::float)/(endnumber-startnumber)::float) as point ";
+            $sSQL .= " from location_property_osmline where place_id = ".$iPlaceID.") as blub";
+            // testcase: interpolationtype=odd, startnumber=1000, endnumber=1006, fInterpolFraction=1 => housenumber=1007 => error in st_lineinterpolatepoint
+            // but this will never happen, because if the searched point is that close to the endnumber, the endnumber house will be directly taken from placex (in ReverseGeocode.php line 220)
+            // and not interpolated
+        } else {
+            $sSQL = "select placex.place_id, partition, osm_type, osm_id, class,";
+            $sSQL .= " type, admin_level, housenumber, postcode, country_code,";
+            $sSQL .= " parent_place_id, linked_place_id, rank_address, rank_search, ";
+            $sSQL .= " coalesce(importance,0.75-(rank_search::float/40)) as importance, indexed_status, indexed_date, wikipedia, country_code, ";
+            $sSQL .= " get_address_by_language(place_id, -1, $sLanguagePrefArraySQL) as langaddress,";
+            $sSQL .= " get_name_by_language(name, $sLanguagePrefArraySQL) as placename,";
+            $sSQL .= " get_name_by_language(name, ARRAY['ref']) as ref,";
+            if ($this->bExtraTags) $sSQL .= " hstore_to_json(extratags) as extra,";
+            if ($this->bNameDetails) $sSQL .= " hstore_to_json(name) as names,";
+            $sSQL .= " (case when centroid is null then st_y(st_centroid(geometry)) else st_y(centroid) end) as lat,";
+            $sSQL .= " (case when centroid is null then st_x(st_centroid(geometry)) else st_x(centroid) end) as lon";
+            $sSQL .= " from placex where place_id = ".$iPlaceID;
+        }
+
+        $aPlace = chksql($this->oDB->getRow($sSQL), "Could not lookup place");
+
+        if (!$aPlace['place_id']) return null;
+
+        if ($this->bAddressDetails) {
+            // to get addressdetails for tiger data, the housenumber is needed
+            $aPlace['aAddress'] = $this->getAddressNames($aPlace['place_id'], $oResult->iHouseNumber);
+        }
+
+        if ($this->bExtraTags) {
+            if ($aPlace['extra']) {
+                $aPlace['sExtraTags'] = json_decode($aPlace['extra']);
+            } else {
+                $aPlace['sExtraTags'] = (object) array();
+            }
+        }
+
+        if ($this->bNameDetails) {
+            if ($aPlace['names']) {
+                $aPlace['sNameDetails'] = json_decode($aPlace['names']);
+            } else {
+                $aPlace['sNameDetails'] = (object) array();
+            }
+        }
+
+        $aClassType = getClassTypes();
+        $sAddressType = '';
+        $sClassType = $aPlace['class'].':'.$aPlace['type'].':'.$aPlace['admin_level'];
+        if (isset($aClassType[$sClassType]) && isset($aClassType[$sClassType]['simplelabel'])) {
+            $sAddressType = $aClassType[$aClassType]['simplelabel'];
+        } else {
+            $sClassType = $aPlace['class'].':'.$aPlace['type'];
+            if (isset($aClassType[$sClassType]) && isset($aClassType[$sClassType]['simplelabel']))
+                $sAddressType = $aClassType[$sClassType]['simplelabel'];
+            else $sAddressType = $aPlace['class'];
+        }
+
+        $aPlace['addresstype'] = $sAddressType;
+
+        return $aPlace;
+    }
+
+    public function getAddressDetails($iPlaceID, $bAll = false, $housenumber = -1)
+    {
+        $sLanguagePrefArraySQL = "ARRAY[".join(',', array_map("getDBQuoted", $this->aLangPrefOrder))."]";
+
+        $sSQL = "select *,get_name_by_language(name,$sLanguagePrefArraySQL) as localname from get_addressdata(".$iPlaceID.",".$housenumber.")";
+        if (!$bAll) $sSQL .= " WHERE isaddress OR type = 'country_code'";
+        $sSQL .= " order by rank_address desc,isaddress desc";
+
+        return chksql($this->oDB->getAll($sSQL));
+    }
+
+    public function getAddressNames($iPlaceID, $housenumber = -1)
+    {
+        $aAddressLines = $this->getAddressDetails($iPlaceID, false, $housenumber);
+
+        $aAddress = array();
+        $aFallback = array();
+        $aClassType = getClassTypes();
+        foreach ($aAddressLines as $aLine) {
+            $bFallback = false;
+            $aTypeLabel = false;
+            if (isset($aClassType[$aLine['class'].':'.$aLine['type'].':'.$aLine['admin_level']])) {
+                $aTypeLabel = $aClassType[$aLine['class'].':'.$aLine['type'].':'.$aLine['admin_level']];
+            } elseif (isset($aClassType[$aLine['class'].':'.$aLine['type']])) {
+                $aTypeLabel = $aClassType[$aLine['class'].':'.$aLine['type']];
+            } elseif (isset($aClassType['boundary:administrative:'.((int)($aLine['rank_address']/2))])) {
+                $aTypeLabel = $aClassType['boundary:administrative:'.((int)($aLine['rank_address']/2))];
+                $bFallback = true;
+            } else {
+                $aTypeLabel = array('simplelabel' => 'address'.$aLine['rank_address']);
+                $bFallback = true;
+            }
+            if ($aTypeLabel && ((isset($aLine['localname']) && $aLine['localname']) || (isset($aLine['housenumber']) && $aLine['housenumber']))) {
+                $sTypeLabel = strtolower(isset($aTypeLabel['simplelabel'])?$aTypeLabel['simplelabel']:$aTypeLabel['label']);
+                $sTypeLabel = str_replace(' ', '_', $sTypeLabel);
+                if (!isset($aAddress[$sTypeLabel]) || (isset($aFallback[$sTypeLabel]) && $aFallback[$sTypeLabel]) || $aLine['class'] == 'place') {
+                    $aAddress[$sTypeLabel] = $aLine['localname']?$aLine['localname']:$aLine['housenumber'];
+                }
+                $aFallback[$sTypeLabel] = $bFallback;
+            }
+        }
+        return $aAddress;
+    }
+
+
+
+    /* returns an array which will contain the keys
+     *   aBoundingBox
+     * and may also contain one or more of the keys
+     *   asgeojson
+     *   askml
+     *   assvg
+     *   astext
+     *   lat
+     *   lon
+     */
+
+
+    public function getOutlines($iPlaceID, $fLon = null, $fLat = null, $fRadius = null)
+    {
+
+        $aOutlineResult = array();
+        if (!$iPlaceID) return $aOutlineResult;
+
+        if (CONST_Search_AreaPolygons) {
+            // Get the bounding box and outline polygon
+            $sSQL  = "select place_id,0 as numfeatures,st_area(geometry) as area,";
+            $sSQL .= "ST_Y(centroid) as centrelat,ST_X(centroid) as centrelon,";
+            $sSQL .= "ST_YMin(geometry) as minlat,ST_YMax(geometry) as maxlat,";
+            $sSQL .= "ST_XMin(geometry) as minlon,ST_XMax(geometry) as maxlon";
+            if ($this->bIncludePolygonAsGeoJSON) $sSQL .= ",ST_AsGeoJSON(geometry) as asgeojson";
+            if ($this->bIncludePolygonAsKML) $sSQL .= ",ST_AsKML(geometry) as askml";
+            if ($this->bIncludePolygonAsSVG) $sSQL .= ",ST_AsSVG(geometry) as assvg";
+            if ($this->bIncludePolygonAsText || $this->bIncludePolygonAsPoints) $sSQL .= ",ST_AsText(geometry) as astext";
+            $sFrom = " from placex where place_id = ".$iPlaceID;
+            if ($this->fPolygonSimplificationThreshold > 0) {
+                $sSQL .= " from (select place_id,centroid,ST_SimplifyPreserveTopology(geometry,".$this->fPolygonSimplificationThreshold.") as geometry".$sFrom.") as plx";
+            } else {
+                $sSQL .= $sFrom;
+            }
+
+            $aPointPolygon = chksql($this->oDB->getRow($sSQL), "Could not get outline");
+
+            if ($aPointPolygon['place_id']) {
+                if ($aPointPolygon['centrelon'] !== null && $aPointPolygon['centrelat'] !== null) {
+                    $aOutlineResult['lat'] = $aPointPolygon['centrelat'];
+                    $aOutlineResult['lon'] = $aPointPolygon['centrelon'];
+                }
+
+                if ($this->bIncludePolygonAsGeoJSON) $aOutlineResult['asgeojson'] = $aPointPolygon['asgeojson'];
+                if ($this->bIncludePolygonAsKML) $aOutlineResult['askml'] = $aPointPolygon['askml'];
+                if ($this->bIncludePolygonAsSVG) $aOutlineResult['assvg'] = $aPointPolygon['assvg'];
+                if ($this->bIncludePolygonAsText) $aOutlineResult['astext'] = $aPointPolygon['astext'];
+                if ($this->bIncludePolygonAsPoints) $aOutlineResult['aPolyPoints'] = geometryText2Points($aPointPolygon['astext'], $fRadius);
+
+
+                if (abs($aPointPolygon['minlat'] - $aPointPolygon['maxlat']) < 0.0000001) {
+                    $aPointPolygon['minlat'] = $aPointPolygon['minlat'] - $fRadius;
+                    $aPointPolygon['maxlat'] = $aPointPolygon['maxlat'] + $fRadius;
+                }
+
+                if (abs($aPointPolygon['minlon'] - $aPointPolygon['maxlon']) < 0.0000001) {
+                    $aPointPolygon['minlon'] = $aPointPolygon['minlon'] - $fRadius;
+                    $aPointPolygon['maxlon'] = $aPointPolygon['maxlon'] + $fRadius;
+                }
+
+                $aOutlineResult['aBoundingBox'] = array(
+                                                   (string)$aPointPolygon['minlat'],
+                                                   (string)$aPointPolygon['maxlat'],
+                                                   (string)$aPointPolygon['minlon'],
+                                                   (string)$aPointPolygon['maxlon']
+                                                  );
+            }
+        }
+
+        // as a fallback we generate a bounding box without knowing the size of the geometry
+        if ((!isset($aOutlineResult['aBoundingBox'])) && isset($fLon)) {
+            //
+            if ($this->bIncludePolygonAsPoints) {
+                $sGeometryText = 'POINT('.$fLon.','.$fLat.')';
+                $aOutlineResult['aPolyPoints'] = geometryText2Points($sGeometryText, $fRadius);
+            }
+
+            $aBounds = array();
+            $aBounds['minlat'] = $fLat - $fRadius;
+            $aBounds['maxlat'] = $fLat + $fRadius;
+            $aBounds['minlon'] = $fLon - $fRadius;
+            $aBounds['maxlon'] = $fLon + $fRadius;
+
+            $aOutlineResult['aBoundingBox'] = array(
+                                               (string)$aBounds['minlat'],
+                                               (string)$aBounds['maxlat'],
+                                               (string)$aBounds['minlon'],
+                                               (string)$aBounds['maxlon']
+                                              );
+        }
+        return $aOutlineResult;
+    }
+}