factor out parameter parsing into its own class

[nominatim.git] / lib / ReverseGeocode.php

diff --git a/lib/ReverseGeocode.php b/lib/ReverseGeocode.php
index 3dff161e4136a443b6362171c719057b8d8f5b39..b523d0aaa9b54a726389691596d28eea5c2a9d31 100644 (file)
--- a/lib/ReverseGeocode.php
+++ b/lib/ReverseGeocode.php
@@ -2,42 +2,13 @@
        class ReverseGeocode
        {
                protected $oDB;
        class ReverseGeocode
        {
                protected $oDB;

-
-               protected $fLat;
-               protected $fLon;

                protected $iMaxRank = 28;
 
                protected $iMaxRank = 28;
 

-               protected $aLangPrefOrder = array();
-
-               protected $bIncludePolygonAsPoints = false;
-               protected $bIncludePolygonAsText = false;
-               protected $bIncludePolygonAsGeoJSON = false;
-               protected $bIncludePolygonAsKML = false;
-               protected $bIncludePolygonAsSVG = false;
-               protected $fPolygonSimplificationThreshold = 0.0;
-
-

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

-               function setLanguagePreference($aLangPref)
-               {
-                       $this->aLangPrefOrder = $aLangPref;
-               }
-
-               function setLatLon($fLat, $fLon)
-               {
-                       $this->fLat = (float)$fLat;
-                       $this->fLon = (float)$fLon;
-               }
-
-               function setRank($iRank)
-               {
-                       $this->iMaxRank = $iRank;
-               }
-

                function setZoom($iZoom)
                {
                        // Zoom to rank, this could probably be calculated but a lookup gives fine control
                function setZoom($iZoom)
                {
                        // Zoom to rank, this could probably be calculated but a lookup gives fine control


@@ -66,53 +37,12 @@
                        $this->iMaxRank = (isset($iZoom) && isset($aZoomRank[$iZoom]))?$aZoomRank[$iZoom]:28;
                }
 
                        $this->iMaxRank = (isset($iZoom) && isset($aZoomRank[$iZoom]))?$aZoomRank[$iZoom]:28;
                }
 

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

                // returns { place_id =>, type => '(osm|tiger)' }
                // fails if no place was found
                // returns { place_id =>, type => '(osm|tiger)' }
                // fails if no place was found

-               function lookup()
+               function lookup($fLat, $fLon, $bDoInterpolation = true)

                {
                {

-                       $sPointSQL = 'ST_SetSRID(ST_Point('.$this->fLon.','.$this->fLat.'),4326)';
+                       $sPointSQL = 'ST_SetSRID(ST_Point('.$fLon.','.$fLat.'),4326)';

                        $iMaxRank = $this->iMaxRank;
                        $iMaxRank = $this->iMaxRank;

-                       $iMaxRank_orig = $this->iMaxRank;

 
                        // Find the nearest point
                        $fSearchDiam = 0.0004;
 
                        // Find the nearest point
                        $fSearchDiam = 0.0004;


@@ -121,6 +51,7 @@
                        $fMaxAreaDistance = 1;
                        $bIsInUnitedStates = false;
                        $bPlaceIsTiger = false;
                        $fMaxAreaDistance = 1;
                        $bIsInUnitedStates = false;
                        $bPlaceIsTiger = false;

+                       $bPlaceIsLine = false;

                        while(!$iPlaceID && $fSearchDiam < $fMaxAreaDistance)
                        {
                                $fSearchDiam = $fSearchDiam * 2;
                        while(!$iPlaceID && $fSearchDiam < $fMaxAreaDistance)
                        {
                                $fSearchDiam = $fSearchDiam * 2;


@@ -147,18 +78,79 @@
                                $sSQL .= ' OR ST_DWithin('.$sPointSQL.', centroid, '.$fSearchDiam.'))';
                                $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', geometry) ASC limit 1';
                                if (CONST_Debug) var_dump($sSQL);
                                $sSQL .= ' OR ST_DWithin('.$sPointSQL.', centroid, '.$fSearchDiam.'))';
                                $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', geometry) ASC limit 1';
                                if (CONST_Debug) var_dump($sSQL);

-                               $aPlace = $this->oDB->getRow($sSQL);
-                               if (PEAR::IsError($aPlace))
-                               {
-                                       failInternalError("Could not determine closest place.", $sSQL, $aPlace);
-                               }
+                               $aPlace = chksql($this->oDB->getRow($sSQL),
+                                                "Could not determine closest place.");

                                $iPlaceID = $aPlace['place_id'];
                                $iParentPlaceID = $aPlace['parent_place_id'];
                                $bIsInUnitedStates = ($aPlace['calculated_country_code'] == 'us');
                        }
                                $iPlaceID = $aPlace['place_id'];
                                $iParentPlaceID = $aPlace['parent_place_id'];
                                $bIsInUnitedStates = ($aPlace['calculated_country_code'] == 'us');
                        }

+                       // if a street or house was found, look in interpolation lines table
+                       if ($bDoInterpolation && $this->iMaxRank >= 28 && $aPlace && $aPlace['rank_search'] >= 26)
+                       {
+                               // if a house was found, search the interpolation line that is at least as close as the house
+                               $sSQL = 'SELECT place_id, parent_place_id, 30 as rank_search, ST_line_locate_point(linegeo,'.$sPointSQL.') as fraction';
+                               $sSQL .= ' FROM location_property_osmline';
+                               $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';
+                               $sSQL .= ' and indexed_status = 0 ';
+                               $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', linegeo) ASC limit 1';
+                               
+                               if (CONST_Debug)
+                               {
+                                       $sSQL = preg_replace('/limit 1/', 'limit 100', $sSQL);
+                                       var_dump($sSQL);

 
 

+                                       $aAllHouses = chksql($this->oDB->getAll($sSQL));
+                                       foreach($aAllHouses as $i)
+                                       {
+                                               echo $i['housenumber'] . ' | ' . $i['distance'] * 1000 . ' | ' . $i['lat'] . ' | ' . $i['lon']. ' | '. "<br>\n";
+                                       }
+                               }
+                               $aPlaceLine = chksql($this->oDB->getRow($sSQL),
+                                                    "Could not determine closest housenumber on an osm interpolation line.");
+                               if ($aPlaceLine)
+                               {
+                                       if (CONST_Debug) var_dump('found housenumber in interpolation lines table', $aPlaceLine);
+                                       if ($aPlace['rank_search'] == 30)
+                                       {
+                                               // if a house was already found in placex, we have to find out, 
+                                               // if the placex house or the interpolated house are closer to the searched point
+                                               // distance between point and placex house
+                                               $sSQL = 'SELECT ST_distance('.$sPointSQL.', house.geometry) as distance FROM placex as house WHERE house.place_id='.$iPlaceID;
+                                               $aDistancePlacex = chksql($this->oDB->getRow($sSQL),
+                                                                         "Could not determine distance between searched point and placex house.");
+                                               $fDistancePlacex = $aDistancePlacex['distance'];
+                                               // distance between point and interpolated house (fraction on interpolation line)
+                                               $sSQL = 'SELECT ST_distance('.$sPointSQL.', ST_LineInterpolatePoint(linegeo, '.$aPlaceLine['fraction'].')) as distance';
+                                               $sSQL .= ' FROM location_property_osmline WHERE place_id = '.$aPlaceLine['place_id'];
+                                               $aDistanceInterpolation = chksql($this->oDB->getRow($sSQL),
+                                                                                "Could not determine distance between searched point and interpolated house.");
+                                               $fDistanceInterpolation = $aDistanceInterpolation['distance'];
+                                               if ($fDistanceInterpolation < $fDistancePlacex)
+                                               {
+                                                       // interpolation is closer to point than placex house
+                                                       $bPlaceIsLine = true;
+                                                       $aPlace = $aPlaceLine;
+                                                       $iPlaceID = $aPlaceLine['place_id'];
+                                                       $iParentPlaceID = $aPlaceLine['parent_place_id']; // the street
+                                                       $fFraction = $aPlaceLine['fraction'];
+                                                       $iMaxRank = 30;
+                                               }
+                                               // else: nothing to do, take placex house from above
+                                       }
+                                       else
+                                       {
+                                               $bPlaceIsLine = true;
+                                               $aPlace = $aPlaceLine;
+                                               $iPlaceID = $aPlaceLine['place_id'];
+                                               $iParentPlaceID = $aPlaceLine['parent_place_id']; // the street
+                                               $fFraction = $aPlaceLine['fraction'];
+                                               $iMaxRank = 30;
+                                       }
+                               }
+                       }
+                       

                        // Only street found? If it's in the US we can check TIGER data for nearest housenumber
                        // Only street found? If it's in the US we can check TIGER data for nearest housenumber

-                       if ($bIsInUnitedStates && $iMaxRank_orig >= 28 && $iPlaceID && ($aPlace['rank_search'] == 26 || $aPlace['rank_search'] == 27 ))
+                       if (CONST_Use_US_Tiger_Data && $bDoInterpolation && $bIsInUnitedStates && $this->iMaxRank >= 28 && $iPlaceID && ($aPlace['rank_search'] == 26 || $aPlace['rank_search'] == 27 ))

                        {
                                $fSearchDiam = 0.001;
                                $sSQL = 'SELECT place_id,parent_place_id,30 as rank_search, ST_line_locate_point(linegeo,'.$sPointSQL.') as fraction';
                        {
                                $fSearchDiam = 0.001;
                                $sSQL = 'SELECT place_id,parent_place_id,30 as rank_search, ST_line_locate_point(linegeo,'.$sPointSQL.') as fraction';


@@ -172,33 +164,31 @@
                                        $sSQL = preg_replace('/limit 1/', 'limit 100', $sSQL);
                                        var_dump($sSQL);
 
                                        $sSQL = preg_replace('/limit 1/', 'limit 100', $sSQL);
                                        var_dump($sSQL);
 

-                                       $aAllHouses = $this->oDB->getAll($sSQL);
+                                       $aAllHouses = chksql($this->oDB->getAll($sSQL));

                                        foreach($aAllHouses as $i)
                                        {
                                                echo $i['housenumber'] . ' | ' . $i['distance'] * 1000 . ' | ' . $i['lat'] . ' | ' . $i['lon']. ' | '. "<br>\n";
                                        }
                                }
 
                                        foreach($aAllHouses as $i)
                                        {
                                                echo $i['housenumber'] . ' | ' . $i['distance'] * 1000 . ' | ' . $i['lat'] . ' | ' . $i['lon']. ' | '. "<br>\n";
                                        }
                                }
 

-                               $aPlaceTiger = $this->oDB->getRow($sSQL);
-                               if (PEAR::IsError($aPlace))
-                               {
-                                       failInternalError("Could not determine closest Tiger place.", $sSQL, $aPlaceTiger);
-                               }
+                               $aPlaceTiger = chksql($this->oDB->getRow($sSQL),
+                                                     "Could not determine closest Tiger place.");

                                if ($aPlaceTiger)
                                {
                                if ($aPlaceTiger)
                                {

-                                       if (CONST_Debug) var_dump('found Tiger place', $aPlaceTiger);
+                                       if (CONST_Debug) var_dump('found Tiger housenumber', $aPlaceTiger);

                                        $bPlaceIsTiger = true;
                                        $aPlace = $aPlaceTiger;
                                        $iPlaceID = $aPlaceTiger['place_id'];
                                        $iParentPlaceID = $aPlaceTiger['parent_place_id']; // the street
                                        $bPlaceIsTiger = true;
                                        $aPlace = $aPlaceTiger;
                                        $iPlaceID = $aPlaceTiger['place_id'];
                                        $iParentPlaceID = $aPlaceTiger['parent_place_id']; // the street

-                                       $iFraction = $aPlaceTiger['fraction'];
+                                       $fFraction = $aPlaceTiger['fraction'];
+                                       $iMaxRank = 30;

                                }
                        }
 
                        // The point we found might be too small - use the address to find what it is a child of
                        if ($iPlaceID && $iMaxRank < 28)
                        {
                                }
                        }
 
                        // The point we found might be too small - use the address to find what it is a child of
                        if ($iPlaceID && $iMaxRank < 28)
                        {

-                               if ($aPlace['rank_search'] > 28 && $iParentPlaceID && !$bPlaceIsTiger)
+                               if (($aPlace['rank_search'] > 28 || $bPlaceIsTiger || $bPlaceIsLine) && $iParentPlaceID)

                                {
                                        $iPlaceID = $iParentPlaceID;
                                }
                                {
                                        $iPlaceID = $iParentPlaceID;
                                }


@@ -207,20 +197,16 @@
                                $sSQL .= " WHERE place_id = $iPlaceID";
                                $sSQL .= " ORDER BY abs(cached_rank_address - $iMaxRank) asc,cached_rank_address desc,isaddress desc,distance desc";
                                $sSQL .= ' LIMIT 1';
                                $sSQL .= " WHERE place_id = $iPlaceID";
                                $sSQL .= " ORDER BY abs(cached_rank_address - $iMaxRank) asc,cached_rank_address desc,isaddress desc,distance desc";
                                $sSQL .= ' LIMIT 1';

-                               $iPlaceID = $this->oDB->getOne($sSQL);
-                               if (PEAR::IsError($iPlaceID))
-                               {
-                                       failInternalError("Could not get parent for place.", $sSQL, $iPlaceID);
-                               }
+                               $iPlaceID = chksql($this->oDB->getOne($sSQL),
+                                                  "Could not get parent for place.");

                                if (!$iPlaceID)
                                {
                                        $iPlaceID = $aPlace['place_id'];
                                }
                        }
                                if (!$iPlaceID)
                                {
                                        $iPlaceID = $aPlace['place_id'];
                                }
                        }

-

                        return array('place_id' => $iPlaceID,
                        return array('place_id' => $iPlaceID,

-                                               'type' => $bPlaceIsTiger ? 'tiger' : 'osm',
-                                               'fraction' => $bPlaceIsTiger ? $iFraction : -1);
+                                               'type' => $bPlaceIsTiger ? 'tiger' : ($bPlaceIsLine ? 'interpolation' : 'osm'),
+                                               'fraction' => ($bPlaceIsTiger || $bPlaceIsLine) ? $fFraction : -1);

                }
                
        }
                }
                
        }