lib/ReverseGeocode.php

   1 <?php
   2         class ReverseGeocode
   3         {
   4                 protected $oDB;
   5
   6                 protected $fLat;
   7                 protected $fLon;
   8                 protected $iMaxRank = 28;
   9
  10                 protected $aLangPrefOrder = array();
  11
  12                 protected $bIncludePolygonAsPoints = false;
  13                 protected $bIncludePolygonAsText = false;
  14                 protected $bIncludePolygonAsGeoJSON = false;
  15                 protected $bIncludePolygonAsKML = false;
  16                 protected $bIncludePolygonAsSVG = false;
  17                 protected $fPolygonSimplificationThreshold = 0.0;
  18
  19
  20                 function ReverseGeocode(&$oDB)
  21                 {
  22                         $this->oDB =& $oDB;
  23                 }
  24
  25                 function setLanguagePreference($aLangPref)
  26                 {
  27                         $this->aLangPrefOrder = $aLangPref;
  28                 }
  29
  30                 function setLatLon($fLat, $fLon)
  31                 {
  32                         $this->fLat = (float)$fLat;
  33                         $this->fLon = (float)$fLon;
  34                 }
  35
  36                 function setRank($iRank)
  37                 {
  38                         $this->iMaxRank = $iRank;
  39                 }
  40
  41                 function setZoom($iZoom)
  42                 {
  43                         // Zoom to rank, this could probably be calculated but a lookup gives fine control
  44                         $aZoomRank = array(
  45                                 0 => 2, // Continent / Sea
  46                                 1 => 2,
  47                                 2 => 2,
  48                                 3 => 4, // Country
  49                                 4 => 4,
  50                                 5 => 8, // State
  51                                 6 => 10, // Region
  52                                 7 => 10,
  53                                 8 => 12, // County
  54                                 9 => 12,
  55                                 10 => 17, // City
  56                                 11 => 17,
  57                                 12 => 18, // Town / Village
  58                                 13 => 18,
  59                                 14 => 22, // Suburb
  60                                 15 => 22,
  61                                 16 => 26, // Street, TODO: major street?
  62                                 17 => 26,
  63                                 18 => 30, // or >, Building
  64                                 19 => 30, // or >, Building
  65                                 );
  66                         $this->iMaxRank = (isset($iZoom) && isset($aZoomRank[$iZoom]))?$aZoomRank[$iZoom]:28;
  67                 }
  68
  69                                 function setIncludePolygonAsPoints($b = true)
  70                 {
  71                         $this->bIncludePolygonAsPoints = $b;
  72                 }
  73
  74                 function getIncludePolygonAsPoints()
  75                 {
  76                         return $this->bIncludePolygonAsPoints;
  77                 }
  78
  79                 function setIncludePolygonAsText($b = true)
  80                 {
  81                         $this->bIncludePolygonAsText = $b;
  82                 }
  83
  84                 function getIncludePolygonAsText()
  85                 {
  86                         return $this->bIncludePolygonAsText;
  87                 }
  88
  89                 function setIncludePolygonAsGeoJSON($b = true)
  90                 {
  91                         $this->bIncludePolygonAsGeoJSON = $b;
  92                 }
  93
  94                 function setIncludePolygonAsKML($b = true)
  95                 {
  96                         $this->bIncludePolygonAsKML = $b;
  97                 }
  98
  99                 function setIncludePolygonAsSVG($b = true)
 100                 {
 101                         $this->bIncludePolygonAsSVG = $b;
 102                 }
 103
 104                 function setPolygonSimplificationThreshold($f)
 105                 {
 106                         $this->fPolygonSimplificationThreshold = $f;
 107                 }
 108
 109                 // returns { place_id =>, type => '(osm|tiger)' }
 110                 // fails if no place was found
 111                 function lookup()
 112                 {
 113                         $sPointSQL = 'ST_SetSRID(ST_Point('.$this->fLon.','.$this->fLat.'),4326)';
 114                         $iMaxRank = $this->iMaxRank;
 115                         $iMaxRank_orig = $this->iMaxRank;
 116
 117                         // Find the nearest point
 118                         $fSearchDiam = 0.0004;
 119                         $iPlaceID = null;
 120                         $aArea = false;
 121                         $fMaxAreaDistance = 1;
 122                         $bIsInUnitedStates = false;
 123                         $bPlaceIsTiger = false;
 124                         $bPlaceIsLine = false;
 125                         while(!$iPlaceID && $fSearchDiam < $fMaxAreaDistance)
 126                         {
 127                                 $fSearchDiam = $fSearchDiam * 2;
 128
 129                                 // If we have to expand the search area by a large amount then we need a larger feature
 130                                 // then there is a limit to how small the feature should be
 131                                 if ($fSearchDiam > 2 && $iMaxRank > 4) $iMaxRank = 4;
 132                                 if ($fSearchDiam > 1 && $iMaxRank > 9) $iMaxRank = 8;
 133                                 if ($fSearchDiam > 0.8 && $iMaxRank > 10) $iMaxRank = 10;
 134                                 if ($fSearchDiam > 0.6 && $iMaxRank > 12) $iMaxRank = 12;
 135                                 if ($fSearchDiam > 0.2 && $iMaxRank > 17) $iMaxRank = 17;
 136                                 if ($fSearchDiam > 0.1 && $iMaxRank > 18) $iMaxRank = 18;
 137                                 if ($fSearchDiam > 0.008 && $iMaxRank > 22) $iMaxRank = 22;
 138                                 if ($fSearchDiam > 0.001 && $iMaxRank > 26) $iMaxRank = 26;
 139
 140                                 $sSQL = 'select place_id,parent_place_id,rank_search,calculated_country_code';
 141                                 $sSQL .= ' FROM placex';
 142                                 $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', geometry, '.$fSearchDiam.')';
 143                                 $sSQL .= ' and rank_search != 28 and rank_search >= '.$iMaxRank;
 144                                 $sSQL .= ' and (name is not null or housenumber is not null)';
 145                                 $sSQL .= ' and class not in (\'waterway\',\'railway\',\'tunnel\',\'bridge\',\'man_made\')';
 146                                 $sSQL .= ' and indexed_status = 0 ';
 147                                 $sSQL .= ' and (ST_GeometryType(geometry) not in (\'ST_Polygon\',\'ST_MultiPolygon\') ';
 148                                 $sSQL .= ' OR ST_DWithin('.$sPointSQL.', centroid, '.$fSearchDiam.'))';
 149                                 $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', geometry) ASC limit 1';
 150                                 if (CONST_Debug) var_dump($sSQL);
 151                                 $aPlace = $this->oDB->getRow($sSQL);
 152                                 if (PEAR::IsError($aPlace))
 153                                 {
 154                                         failInternalError("Could not determine closest place.", $sSQL, $aPlace);
 155                                 }
 156                                 $iPlaceID = $aPlace['place_id'];
 157                                 $iParentPlaceID = $aPlace['parent_place_id'];
 158                                 $bIsInUnitedStates = ($aPlace['calculated_country_code'] == 'us');
 159                         }
 160                         // if a street or house was found, look in interpolation lines table
 161                         if ($iMaxRank_orig >= 28 && $iPlaceID && ($aPlace['rank_search'] == 26 || $aPlace['rank_search'] == 27 || $aPlace['rank_search'] == 30))
 162                         {
 163                                 $fSearchDiam = 0.001;
 164                                 if ($aPlace['rank_search'] == 30)
 165                                 {
 166                                         // if a house was found, the closest road needs to be searched, to use its place id as parent_place_id of the interpolation line
 167                                         // because a road can be closer to the point than the house from above
 168                                         $iRoadID = null;
 169                                         while(!$iRoadID && $fSearchDiam < $fMaxAreaDistance)
 170                                         {
 171                                                 $fSearchDiam = $fSearchDiam * 2;
 172                                                 $sSQL = 'select place_id ';
 173                                                 $sSQL .= ' FROM placex';
 174                                                 $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', geometry, '.$fSearchDiam.')';
 175                                                 $sSQL .= ' and (rank_search = 26 or rank_search = 27)';
 176                                                 $sSQL .= ' and class not in (\'waterway\',\'railway\',\'tunnel\',\'bridge\',\'man_made\')';
 177                                                 $sSQL .= ' and indexed_status = 0 ';
 178                                                 $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', geometry) ASC limit 1';
 179                                                 $aPlaceRoad = $this->oDB->getRow($sSQL);
 180                                                 if (PEAR::IsError($aPlace))
 181                                                 {
 182                                                         failInternalError("Could not determine closest place.", $sSQL, $aPlace);
 183                                                 }
 184                                                 $iRoadID = $aPlaceRoad['place_id'];
 185                                                 $iTempPlaceID = $iRoadID;
 186                                         }
 187                                 }
 188                                 else
 189                                 {
 190                                         // if a street was found, we can take its place_id as parent_place_id
 191                                         $iTempPlaceID = $iPlaceID;
 192                                 }
 193                                 $sSQL = 'SELECT place_id, parent_place_id, 30 as rank_search, ST_line_locate_point(linegeo,'.$sPointSQL.') as fraction';
 194                                 //if (CONST_Debug) { $sSQL .= ', housenumber, ST_distance('.$sPointSQL.', centroid) as distance, st_y(centroid) as lat, st_x(centroid) as lon'; }
 195                                 $sSQL .= ' FROM location_property_osmline WHERE parent_place_id = '.$iTempPlaceID;
 196                                 $sSQL .= ' AND ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.') AND indexed_status = 0';
 197                                 $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', linegeo) ASC limit 1';
 198                                 if (CONST_Debug)
 199                                 {
 200                                         $sSQL = preg_replace('/limit 1/', 'limit 100', $sSQL);
 201                                         var_dump($sSQL);
 202
 203                                         $aAllHouses = $this->oDB->getAll($sSQL);
 204                                         foreach($aAllHouses as $i)
 205                                         {
 206                                                 echo $i['housenumber'] . ' | ' . $i['distance'] * 1000 . ' | ' . $i['lat'] . ' | ' . $i['lon']. ' | '. "<br>\n";
 207                                         }
 208                                 }
 209                                 $aPlaceLine = $this->oDB->getRow($sSQL);
 210                                 if (PEAR::IsError($aPlaceLine))
 211                                 {
 212                                         failInternalError("Could not determine closest housenumber on an osm interpolation line.", $sSQL, $aPlaceLine);
 213                                 }
 214                                 $iInterpolationLinePlaceID = $aPlaceLine['place_id'];
 215                                 if ($aPlaceLine)
 216                                 {
 217                                         if (CONST_Debug) var_dump('found housenumber in interpolation lines table', $aPlaceLine);
 218                                         if ($aPlace['rank_search'] == 30)
 219                                         {
 220                                                 // if a house was already found in placex, we have to find out,
 221                                                 // if the placex house or the interpolated house are closer to the searched point
 222                                                 // distance between point and placex house
 223                                                 $sSQL = 'SELECT ST_distance('.$sPointSQL.', house.geometry) as distance FROM placex as house WHERE house.place_id='.$iPlaceID;
 224                                                 $aDistancePlacex = $this->oDB->getRow($sSQL);
 225                                                 if (PEAR::IsError($aDistancePlacex))
 226                                                 {
 227                                                         failInternalError("Could not determine distance between searched point and placex house.", $sSQL, $aDistancePlacex);
 228                                                 }
 229                                                 $fDistancePlacex = $aDistancePlacex['distance'];
 230                                                 // distance between point and interpolated house (fraction on interpolation line)
 231                                                 $sSQL = 'SELECT ST_distance('.$sPointSQL.', ST_LineInterpolatePoint(linegeo, '.$aPlaceLine['fraction'].')) as distance';
 232                                                 $sSQL .= ' FROM location_property_osmline WHERE place_id = '.$iInterpolationLinePlaceID;
 233                                                 $aDistanceInterpolation = $this->oDB->getRow($sSQL);
 234                                                 if (PEAR::IsError($aDistanceInterpolation))
 235                                                 {
 236                                                         failInternalError("Could not determine distance between searched point and interpolated house.", $sSQL, $aDistanceInterpolation);
 237                                                 }
 238                                                 $fDistanceInterpolation = $aDistanceInterpolation['distance'];
 239                                                 if ($fDistanceInterpolation < $fDistancePlacex)
 240                                                 {
 241                                                         // interpolation is closer to point than placex house
 242                                                         $bPlaceIsLine = true;
 243                                                         $aPlace = $aPlaceLine;
 244                                                         $iPlaceID = $iInterpolationLinePlaceID;
 245                                                         $iParentPlaceID = $aPlaceLine['parent_place_id']; // the street
 246                                                         $fFraction = $aPlaceLine['fraction'];
 247                                                 }
 248                                                 // else: nothing to do, take placex house from above
 249                                         }
 250                                         else
 251                                         {
 252                                                 $bPlaceIsLine = true;
 253                                                 $aPlace = $aPlaceLine;
 254                                                 $iPlaceID = $aPlaceLine['place_id'];
 255                                                 $iParentPlaceID = $aPlaceLine['parent_place_id']; // the street
 256                                                 $fFraction = $aPlaceLine['fraction'];
 257                                         }
 258                                 }
 259                         }
 260
 261                         // Only street found? If it's in the US we can check TIGER data for nearest housenumber
 262                         if ($bIsInUnitedStates && $iMaxRank_orig >= 28 && $iPlaceID && ($aPlace['rank_search'] == 26 || $aPlace['rank_search'] == 27 ))
 263                         {
 264                                 $fSearchDiam = 0.001;
 265                                 $sSQL = 'SELECT place_id,parent_place_id,30 as rank_search, ST_line_locate_point(linegeo,'.$sPointSQL.') as fraction';
 266                                 //if (CONST_Debug) { $sSQL .= ', housenumber, ST_distance('.$sPointSQL.', centroid) as distance, st_y(centroid) as lat, st_x(centroid) as lon'; }
 267                                 $sSQL .= ' FROM location_property_tiger WHERE parent_place_id = '.$iPlaceID;
 268                                 $sSQL .= ' AND ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';  //no centroid anymore in Tiger data, now we have lines
 269                                 $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', linegeo) ASC limit 1';
 270
 271                                 if (CONST_Debug)
 272                                 {
 273                                         $sSQL = preg_replace('/limit 1/', 'limit 100', $sSQL);
 274                                         var_dump($sSQL);
 275
 276                                         $aAllHouses = $this->oDB->getAll($sSQL);
 277                                         foreach($aAllHouses as $i)
 278                                         {
 279                                                 echo $i['housenumber'] . ' | ' . $i['distance'] * 1000 . ' | ' . $i['lat'] . ' | ' . $i['lon']. ' | '. "<br>\n";
 280                                         }
 281                                 }
 282
 283                                 $aPlaceTiger = $this->oDB->getRow($sSQL);
 284                                 if (PEAR::IsError($aPlaceTiger))
 285                                 {
 286                                         failInternalError("Could not determine closest Tiger place.", $sSQL, $aPlaceTiger);
 287                                 }
 288                                 if ($aPlaceTiger)
 289                                 {
 290                                         if (CONST_Debug) var_dump('found Tiger housenumber', $aPlaceTiger);
 291                                         $bPlaceIsTiger = true;
 292                                         $aPlace = $aPlaceTiger;
 293                                         $iPlaceID = $aPlaceTiger['place_id'];
 294                                         $iParentPlaceID = $aPlaceTiger['parent_place_id']; // the street
 295                                         $fFraction = $aPlaceTiger['fraction'];
 296                                 }
 297                         }
 298
 299                         // The point we found might be too small - use the address to find what it is a child of
 300                         if ($iPlaceID && $iMaxRank < 28)
 301                         {
 302                                 if (($aPlace['rank_search'] > 28 || $bPlaceIsTiger || $bPlaceIsLine) && $iParentPlaceID)
 303                                 {
 304                                         $iPlaceID = $iParentPlaceID;
 305                                 }
 306                                 $sSQL  = 'select address_place_id';
 307                                 $sSQL .= ' FROM place_addressline';
 308                                 $sSQL .= " WHERE place_id = $iPlaceID";
 309                                 $sSQL .= " ORDER BY abs(cached_rank_address - $iMaxRank) asc,cached_rank_address desc,isaddress desc,distance desc";
 310                                 $sSQL .= ' LIMIT 1';
 311                                 $iPlaceID = $this->oDB->getOne($sSQL);
 312                                 if (PEAR::IsError($iPlaceID))
 313                                 {
 314                                         failInternalError("Could not get parent for place.", $sSQL, $iPlaceID);
 315                                 }
 316                                 if (!$iPlaceID)
 317                                 {
 318                                         $iPlaceID = $aPlace['place_id'];
 319                                 }
 320                         }
 321                         return array('place_id' => $iPlaceID,
 322                                                 'type' => $bPlaceIsTiger ? 'tiger' : $bPlaceIsLine ? 'interpolation' : 'osm',
 323                                                 'fraction' => ($bPlaceIsTiger || $bPlaceIsLine) ? $fFraction : -1);
 324                 }
 325
 326         }
 327 ?>