app/controllers/geocoder_controller.rb

   1 # coding: utf-8
   2
   3 class GeocoderController < ApplicationController
   4   require 'cgi'
   5   require 'uri'
   6   require 'net/http'
   7   require 'rexml/document'
   8
   9   before_filter :authorize_web
  10   before_filter :set_locale
  11   before_filter :require_oauth, :only => [:search]
  12
  13   def search
  14     normalize_params
  15
  16     @sources = []
  17     if params[:lat] && params[:lon]
  18       @sources.push "latlon"
  19       @sources.push "osm_nominatim_reverse"
  20       @sources.push "geonames_reverse" if defined?(GEONAMES_USERNAME)
  21     elsif params[:query].match(/^\d{5}(-\d{4})?$/)
  22       @sources.push "us_postcode"
  23       @sources.push "osm_nominatim"
  24     elsif params[:query].match(/^(GIR 0AA|[A-PR-UWYZ]([0-9]{1,2}|([A-HK-Y][0-9]|[A-HK-Y][0-9]([0-9]|[ABEHMNPRV-Y]))|[0-9][A-HJKS-UW])\s*[0-9][ABD-HJLNP-UW-Z]{2})$/i)
  25       @sources.push "uk_postcode"
  26       @sources.push "osm_nominatim"
  27     elsif params[:query].match(/^[A-Z]\d[A-Z]\s*\d[A-Z]\d$/i)
  28       @sources.push "ca_postcode"
  29       @sources.push "osm_nominatim"
  30     else
  31       @sources.push "osm_nominatim"
  32       @sources.push "geonames" if defined?(GEONAMES_USERNAME)
  33     end
  34
  35     render :layout => map_layout
  36   end
  37
  38   def search_latlon
  39     lat = params[:lat].to_f
  40     lon = params[:lon].to_f
  41     if lat < -90 || lat > 90
  42       @error = "Latitude #{lat} out of range"
  43       render :action => "error"
  44     elsif lon < -180 || lon > 180
  45       @error = "Longitude #{lon} out of range"
  46       render :action => "error"
  47     else
  48       @results = [{ :lat => lat, :lon => lon,
  49                     :zoom => params[:zoom],
  50                     :name => "#{lat}, #{lon}" }]
  51
  52       render :action => "results"
  53     end
  54   end
  55
  56   def search_us_postcode
  57     # get query parameters
  58     query = params[:query]
  59
  60     # create result array
  61     @results = []
  62
  63     # ask geocoder.us (they have a non-commercial use api)
  64     response = fetch_text("http://rpc.geocoder.us/service/csv?zip=#{escape_query(query)}")
  65
  66     # parse the response
  67     unless response.match(/couldn't find this zip/)
  68       data = response.split(/\s*,\s+/) # lat,long,town,state,zip
  69       @results.push(:lat => data[0], :lon => data[1],
  70                     :zoom => POSTCODE_ZOOM,
  71                     :prefix => "#{data[2]}, #{data[3]},",
  72                     :name => data[4])
  73     end
  74
  75     render :action => "results"
  76   rescue Exception => ex
  77     @error = "Error contacting rpc.geocoder.us: #{ex}"
  78     render :action => "error"
  79   end
  80
  81   def search_uk_postcode
  82     # get query parameters
  83     query = params[:query]
  84
  85     # create result array
  86     @results = []
  87
  88     # ask npemap.org.uk to do a combined npemap + freethepostcode search
  89     response = fetch_text("http://www.npemap.org.uk/cgi/geocoder.fcgi?format=text&postcode=#{escape_query(query)}")
  90
  91     # parse the response
  92     unless response.match(/Error/)
  93       dataline = response.split(/\n/)[1]
  94       data = dataline.split(/,/) # easting,northing,postcode,lat,long
  95       postcode = data[2].gsub(/'/, "")
  96       zoom = POSTCODE_ZOOM - postcode.count("#")
  97       @results.push(:lat => data[3], :lon => data[4], :zoom => zoom,
  98                     :name => postcode)
  99     end
 100
 101     render :action => "results"
 102   rescue Exception => ex
 103     @error = "Error contacting www.npemap.org.uk: #{ex}"
 104     render :action => "error"
 105   end
 106
 107   def search_ca_postcode
 108     # get query parameters
 109     query = params[:query]
 110     @results = []
 111
 112     # ask geocoder.ca (note - they have a per-day limit)
 113     response = fetch_xml("http://geocoder.ca/?geoit=XML&postal=#{escape_query(query)}")
 114
 115     # parse the response
 116     if response.get_elements("geodata/error").empty?
 117       @results.push(:lat => response.get_text("geodata/latt").to_s,
 118                     :lon => response.get_text("geodata/longt").to_s,
 119                     :zoom => POSTCODE_ZOOM,
 120                     :name => query.upcase)
 121     end
 122
 123     render :action => "results"
 124   rescue Exception => ex
 125     @error = "Error contacting geocoder.ca: #{ex}"
 126     render :action => "error"
 127   end
 128
 129   def search_osm_nominatim
 130     # get query parameters
 131     query = params[:query]
 132     minlon = params[:minlon]
 133     minlat = params[:minlat]
 134     maxlon = params[:maxlon]
 135     maxlat = params[:maxlat]
 136
 137     # get view box
 138     if minlon && minlat && maxlon && maxlat
 139       viewbox = "&viewbox=#{minlon},#{maxlat},#{maxlon},#{minlat}"
 140     end
 141
 142     # get objects to excude
 143     if params[:exclude]
 144       exclude = "&exclude_place_ids=#{params[:exclude]}"
 145     end
 146
 147     # ask nominatim
 148     response = fetch_xml("http:#{NOMINATIM_URL}search?format=xml&q=#{escape_query(query)}#{viewbox}#{exclude}&accept-language=#{http_accept_language.user_preferred_languages.join(',')}")
 149
 150     # extract the results from the response
 151     results =  response.elements["searchresults"]
 152
 153     # extract parameters from more_url
 154     more_url_params = CGI.parse(URI.parse(results.attributes["more_url"]).query)
 155
 156     # create result array
 157     @results = []
 158
 159     # create parameter hash for "more results" link
 160     @more_params = params.merge(:exclude => more_url_params["exclude_place_ids"].first)
 161
 162     # parse the response
 163     results.elements.each("place") do |place|
 164       lat = place.attributes["lat"].to_s
 165       lon = place.attributes["lon"].to_s
 166       klass = place.attributes["class"].to_s
 167       type = place.attributes["type"].to_s
 168       name = place.attributes["display_name"].to_s
 169       min_lat, max_lat, min_lon, max_lon = place.attributes["boundingbox"].to_s.split(",")
 170       if type.empty?
 171         prefix_name = ""
 172       else
 173         prefix_name = t "geocoder.search_osm_nominatim.prefix.#{klass}.#{type}", :default => type.gsub("_", " ").capitalize
 174       end
 175       if klass == 'boundary' && type == 'administrative'
 176         rank = (place.attributes["place_rank"].to_i + 1) / 2
 177         prefix_name = t "geocoder.search_osm_nominatim.admin_levels.level#{rank}", :default => prefix_name
 178       end
 179       prefix = t "geocoder.search_osm_nominatim.prefix_format", :name => prefix_name
 180       object_type = place.attributes["osm_type"]
 181       object_id = place.attributes["osm_id"]
 182
 183       @results.push(:lat => lat, :lon => lon,
 184                     :min_lat => min_lat, :max_lat => max_lat,
 185                     :min_lon => min_lon, :max_lon => max_lon,
 186                     :prefix => prefix, :name => name,
 187                     :type => object_type, :id => object_id)
 188     end
 189
 190     render :action => "results"
 191     #  rescue Exception => ex
 192     #    @error = "Error contacting nominatim.openstreetmap.org: #{ex.to_s}"
 193     #    render :action => "error"
 194   end
 195
 196   def search_geonames
 197     # get query parameters
 198     query = params[:query]
 199
 200     # get preferred language
 201     lang = I18n.locale.to_s.split("-").first
 202
 203     # create result array
 204     @results = []
 205
 206     # ask geonames.org
 207     response = fetch_xml("http://api.geonames.org/search?q=#{escape_query(query)}&lang=#{lang}&maxRows=20&username=#{GEONAMES_USERNAME}")
 208
 209     # parse the response
 210     response.elements.each("geonames/geoname") do |geoname|
 211       lat = geoname.get_text("lat").to_s
 212       lon = geoname.get_text("lng").to_s
 213       name = geoname.get_text("name").to_s
 214       country = geoname.get_text("countryName").to_s
 215       @results.push(:lat => lat, :lon => lon,
 216                     :zoom => GEONAMES_ZOOM,
 217                     :name => name,
 218                     :suffix => ", #{country}")
 219     end
 220
 221     render :action => "results"
 222   rescue Exception => ex
 223     @error = "Error contacting ws.geonames.org: #{ex}"
 224     render :action => "error"
 225   end
 226
 227   def search_osm_nominatim_reverse
 228     # get query parameters
 229     lat = params[:lat]
 230     lon = params[:lon]
 231     zoom = params[:zoom]
 232
 233     # create result array
 234     @results = []
 235
 236     # ask nominatim
 237     response = fetch_xml("http:#{NOMINATIM_URL}reverse?lat=#{lat}&lon=#{lon}&zoom=#{zoom}&accept-language=#{http_accept_language.user_preferred_languages.join(',')}")
 238
 239     # parse the response
 240     response.elements.each("reversegeocode/result") do |result|
 241       lat = result.attributes["lat"].to_s
 242       lon = result.attributes["lon"].to_s
 243       object_type = result.attributes["osm_type"]
 244       object_id = result.attributes["osm_id"]
 245       description = result.get_text.to_s
 246
 247       @results.push(:lat => lat, :lon => lon,
 248                     :zoom => zoom,
 249                     :name => description,
 250                     :type => object_type, :id => object_id)
 251     end
 252
 253     render :action => "results"
 254   rescue Exception => ex
 255     @error = "Error contacting nominatim.openstreetmap.org: #{ex}"
 256     render :action => "error"
 257   end
 258
 259   def search_geonames_reverse
 260     # get query parameters
 261     lat = params[:lat]
 262     lon = params[:lon]
 263
 264     # get preferred language
 265     lang = I18n.locale.to_s.split("-").first
 266
 267     # create result array
 268     @results = []
 269
 270     # ask geonames.org
 271     response = fetch_xml("http://api.geonames.org/countrySubdivision?lat=#{lat}&lng=#{lon}&lang=#{lang}&username=#{GEONAMES_USERNAME}")
 272
 273     # parse the response
 274     response.elements.each("geonames/countrySubdivision") do |geoname|
 275       name = geoname.get_text("adminName1").to_s
 276       country = geoname.get_text("countryName").to_s
 277       @results.push(:lat => lat, :lon => lon,
 278                     :zoom => GEONAMES_ZOOM,
 279                     :name => name,
 280                     :suffix => ", #{country}")
 281     end
 282
 283     render :action => "results"
 284   rescue Exception => ex
 285     @error = "Error contacting ws.geonames.org: #{ex}"
 286     render :action => "error"
 287   end
 288
 289   private
 290
 291   def fetch_text(url)
 292     Net::HTTP.get(URI.parse(url))
 293   end
 294
 295   def fetch_xml(url)
 296     REXML::Document.new(fetch_text(url))
 297   end
 298
 299   def format_distance(distance)
 300     t("geocoder.distance", :count => distance)
 301   end
 302
 303   def format_direction(bearing)
 304     return t("geocoder.direction.south_west") if bearing >= 22.5 && bearing < 67.5
 305     return t("geocoder.direction.south") if bearing >= 67.5 && bearing < 112.5
 306     return t("geocoder.direction.south_east") if bearing >= 112.5 && bearing < 157.5
 307     return t("geocoder.direction.east") if bearing >= 157.5 && bearing < 202.5
 308     return t("geocoder.direction.north_east") if bearing >= 202.5 && bearing < 247.5
 309     return t("geocoder.direction.north") if bearing >= 247.5 && bearing < 292.5
 310     return t("geocoder.direction.north_west") if bearing >= 292.5 && bearing < 337.5
 311     t("geocoder.direction.west")
 312   end
 313
 314   def format_name(name)
 315     name.gsub(/( *\[[^\]]*\])*$/, "")
 316   end
 317
 318   def count_results(results)
 319     count = 0
 320
 321     results.each do |source|
 322       count += source[:results].length if source[:results]
 323     end
 324
 325     count
 326   end
 327
 328   def escape_query(query)
 329     URI.escape(query, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]", false, 'N'))
 330   end
 331
 332   def normalize_params
 333     query = params[:query]
 334     return unless query
 335
 336     query.strip!
 337
 338     if latlon = query.match(/^([NS])\s*(\d{1,3}(\.\d*)?)\W*([EW])\s*(\d{1,3}(\.\d*)?)$/).try(:captures) # [NSEW] decimal degrees
 339       params.merge!(nsew_to_decdeg(latlon)).delete(:query)
 340     elsif latlon = query.match(/^(\d{1,3}(\.\d*)?)\s*([NS])\W*(\d{1,3}(\.\d*)?)\s*([EW])$/).try(:captures) # decimal degrees [NSEW]
 341       params.merge!(nsew_to_decdeg(latlon)).delete(:query)
 342
 343     elsif latlon = query.match(/^([NS])\s*(\d{1,3})°?\s*(\d{1,3}(\.\d*)?)?['′]?\W*([EW])\s*(\d{1,3})°?\s*(\d{1,3}(\.\d*)?)?['′]?$/).try(:captures) # [NSEW] degrees, decimal minutes
 344       params.merge!(ddm_to_decdeg(latlon)).delete(:query)
 345     elsif latlon = query.match(/^(\d{1,3})°?\s*(\d{1,3}(\.\d*)?)?['′]?\s*([NS])\W*(\d{1,3})°?\s*(\d{1,3}(\.\d*)?)?['′]?\s*([EW])$/).try(:captures) # degrees, decimal minutes [NSEW]
 346       params.merge!(ddm_to_decdeg(latlon)).delete(:query)
 347
 348     elsif latlon = query.match(/^([NS])\s*(\d{1,3})°?\s*(\d{1,2})['′]?\s*(\d{1,3}(\.\d*)?)?["″]?\W*([EW])\s*(\d{1,3})°?\s*(\d{1,2})['′]?\s*(\d{1,3}(\.\d*)?)?["″]?$/).try(:captures) # [NSEW] degrees, minutes, decimal seconds
 349       params.merge!(dms_to_decdeg(latlon)).delete(:query)
 350     elsif latlon = query.match(/^(\d{1,3})°?\s*(\d{1,2})['′]?\s*(\d{1,3}(\.\d*)?)?["″]\s*([NS])\W*(\d{1,3})°?\s*(\d{1,2})['′]?\s*(\d{1,3}(\.\d*)?)?["″]?\s*([EW])$/).try(:captures) # degrees, minutes, decimal seconds [NSEW]
 351       params.merge!(dms_to_decdeg(latlon)).delete(:query)
 352
 353     elsif latlon = query.match(/^\s*([+-]?\d+(\.\d*)?)\s*[\s,]\s*([+-]?\d+(\.\d*)?)\s*$/)
 354       params.merge!(:lat => latlon[1].to_f, :lon => latlon[3].to_f).delete(:query)
 355     end
 356   end
 357
 358   def nsew_to_decdeg(captures)
 359     begin
 360       Float(captures[0])
 361       captures[2].downcase != 's' ? lat = captures[0].to_f : lat = -(captures[0].to_f)
 362       captures[5].downcase != 'w' ? lon = captures[3].to_f : lon = -(captures[3].to_f)
 363     rescue
 364       captures[0].downcase != 's' ? lat = captures[1].to_f : lat = -(captures[1].to_f)
 365       captures[3].downcase != 'w' ? lon = captures[4].to_f : lon = -(captures[4].to_f)
 366     end
 367     { :lat => lat, :lon => lon }
 368   end
 369
 370   def ddm_to_decdeg(captures)
 371     begin
 372       Float(captures[0])
 373       captures[3].downcase != 's' ? lat = captures[0].to_f + captures[1].to_f / 60 : lat = -(captures[0].to_f + captures[1].to_f / 60)
 374       captures[7].downcase != 'w' ? lon = captures[4].to_f + captures[5].to_f / 60 : lon = -(captures[4].to_f + captures[5].to_f / 60)
 375     rescue
 376       captures[0].downcase != 's' ? lat = captures[1].to_f + captures[2].to_f / 60 : lat = -(captures[1].to_f + captures[2].to_f / 60)
 377       captures[4].downcase != 'w' ? lon = captures[5].to_f + captures[6].to_f / 60 : lon = -(captures[5].to_f + captures[6].to_f / 60)
 378     end
 379     { :lat => lat, :lon => lon }
 380   end
 381
 382   def dms_to_decdeg(captures)
 383     begin
 384       Float(captures[0])
 385       captures[4].downcase != 's' ? lat = captures[0].to_f + (captures[1].to_f + captures[2].to_f / 60) / 60 : lat = -(captures[0].to_f + (captures[1].to_f + captures[2].to_f / 60) / 60)
 386       captures[9].downcase != 'w' ? lon = captures[5].to_f + (captures[6].to_f + captures[7].to_f / 60) / 60 : lon = -(captures[5].to_f + (captures[6].to_f + captures[7].to_f / 60) / 60)
 387     rescue
 388       captures[0].downcase != 's' ? lat = captures[1].to_f + (captures[2].to_f + captures[3].to_f / 60) / 60 : lat = -(captures[1].to_f + (captures[2].to_f + captures[3].to_f / 60) / 60)
 389       captures[5].downcase != 'w' ? lon = captures[6].to_f + (captures[7].to_f + captures[8].to_f / 60) / 60 : lon = -(captures[6].to_f + (captures[7].to_f + captures[8].to_f / 60) / 60)
 390     end
 391     { :lat => lat, :lon => lon }
 392   end
 393 end