app/controllers/geocoder_controller.rb

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