Nominatim/lib/PlaceLookup.php

<?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;


    function PlaceLookup(&$oDB)
    {
        $this->oDB =& $oDB;
    }

    function setLanguagePreference($aLangPrefOrder)
    {
        $this->aLangPrefOrder = $aLangPrefOrder;
    }

    function setIncludeAddressDetails($bAddressDetails = true)
    {
        $this->bAddressDetails = $bAddressDetails;
    }

    function setIncludeExtraTags($bExtraTags = false)
    {
        $this->bExtraTags = $bExtraTags;
    }

    function setIncludeNameDetails($bNameDetails = false)
    {
        $this->bNameDetails = $bNameDetails;
    }


    function setIncludePolygonAsPoints($b = true)
    {
        $this->bIncludePolygonAsPoints = $b;
    }

    function getIncludePolygonAsPoints()
    {
        return $this->bIncludePolygonAsPoints;
    }

    function setIncludePolygonAsText($b = true)
    {
        $this->bIncludePolygonAsText = $b;
    }

    function getIncludePolygonAsText()
    {
        return $this->bIncludePolygonAsText;
    }

    function setIncludePolygonAsGeoJSON($b = true)
    {
        $this->bIncludePolygonAsGeoJSON = $b;
    }

    function setIncludePolygonAsKML($b = true)
    {
        $this->bIncludePolygonAsKML = $b;
    }

    function setIncludePolygonAsSVG($b = true)
    {
        $this->bIncludePolygonAsSVG = $b;
    }

    function setPolygonSimplificationThreshold($f)
    {
        $this->fPolygonSimplificationThreshold = $f;
    }

    function lookupOSMID($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";
        $iPlaceID = chksql($this->oDB->getOne($sSQL));

        return $this->lookup((int)$iPlaceID);
    }

    function lookup($iPlaceID, $sType = '', $fInterpolFraction = 0.0)
    {
        if (!$iPlaceID) return null;

        $sLanguagePrefArraySQL = "ARRAY[".join(',',array_map("getDBQuoted", $this->aLangPrefOrder))."]";
        $bIsTiger = CONST_Use_US_Tiger_Data && $sType == 'tiger';
        $bIsInterpolation = $sType == 'interpolation';

        if ($bIsTiger)
        {
            $sSQL = "select place_id,partition, 'T' as osm_type, place_id as osm_id, 'place' as class, 'house' as type, null as admin_level, housenumber, null as street, null as isin, 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 calculated_country_code, ";
            $sSQL .= " get_address_by_language(place_id, housenumber, $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 from (select *, ST_LineInterpolatePoint(linegeo, (housenumber-startnumber::float)/(endnumber-startnumber)::float) as point from ";
            $sSQL .= " (select *, ";
            $sSQL .= " CASE WHEN interpolationtype='odd' THEN floor((".$fInterpolFraction."*(endnumber-startnumber)+startnumber)/2)::int*2+1";
            $sSQL .= " WHEN interpolationtype='even' THEN ((".$fInterpolFraction."*(endnumber-startnumber)+startnumber)/2)::int*2";
            $sSQL .= " WHEN interpolationtype='all' THEN (".$fInterpolFraction."*(endnumber-startnumber)+startnumber)::int";
            $sSQL .= " END as housenumber";
            $sSQL .= " from location_property_tiger where place_id = ".$iPlaceID.") as blub1) as blub2";
        }
        else if ($bIsInterpolation)
        {
            $sSQL = "select place_id, partition, 'W' as osm_type, osm_id, 'place' as class, 'house' as type, null admin_level, housenumber, null as street, null as isin, postcode,";
            $sSQL .= " calculated_country_code as 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, calculated_country_code, ";
            $sSQL .= " get_address_by_language(place_id, housenumber, $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 from (select *, ST_LineInterpolatePoint(linegeo, (housenumber-startnumber::float)/(endnumber-startnumber)::float) as point from ";
            $sSQL .= " (select *, ";
            $sSQL .= " CASE WHEN interpolationtype='odd' THEN floor((".$fInterpolFraction."*(endnumber-startnumber)+startnumber)/2)::int*2+1";
            $sSQL .= " WHEN interpolationtype='even' THEN ((".$fInterpolFraction."*(endnumber-startnumber)+startnumber)/2)::int*2";
            $sSQL .= " WHEN interpolationtype='all' THEN (".$fInterpolFraction."*(endnumber-startnumber)+startnumber)::int";
            $sSQL .= " END as housenumber";
            $sSQL .= " from location_property_osmline where place_id = ".$iPlaceID.") as blub1) as blub2";
            // 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, type, admin_level, housenumber, street, isin, postcode, country_code, 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, -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
            $iHousenumber = ($bIsTiger || $bIsInterpolation) ? $aPlace['housenumber'] : -1;
            $aPlace['aAddress'] = $this->getAddressNames($aPlace['place_id'],
                                                         $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;
    }

    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));
    }

    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
    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']
                                                 );
            }
        } // CONST_Search_AreaPolygons

        // 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;
    }
}