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_action :authorize_web
  10   before_action :set_locale
  11   before_action :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 StandardError => 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 StandardError => 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 StandardError => 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     exclude = "&exclude_place_ids=#{params[:exclude]}" if params[:exclude]
 144
 145     # ask nominatim
 146     response = fetch_xml("http:#{NOMINATIM_URL}search?format=xml&q=#{escape_query(query)}#{viewbox}#{exclude}&accept-language=#{http_accept_language.user_preferred_languages.join(',')}")
 147
 148     # extract the results from the response
 149     results =  response.elements["searchresults"]
 150
 151     # extract parameters from more_url
 152     more_url_params = CGI.parse(URI.parse(results.attributes["more_url"]).query)
 153
 154     # create result array
 155     @results = []
 156
 157     # create parameter hash for "more results" link
 158     @more_params = params.merge(:exclude => more_url_params["exclude_place_ids"].first)
 159
 160     # parse the response
 161     results.elements.each("place") do |place|
 162       lat = place.attributes["lat"].to_s
 163       lon = place.attributes["lon"].to_s
 164       klass = place.attributes["class"].to_s
 165       type = place.attributes["type"].to_s
 166       name = place.attributes["display_name"].to_s
 167       min_lat, max_lat, min_lon, max_lon = place.attributes["boundingbox"].to_s.split(",")
 168       if type.empty?
 169         prefix_name = ""
 170       else
 171         prefix_name = t "geocoder.search_osm_nominatim.prefix.#{klass}.#{type}", :default => type.gsub("_", " ").capitalize
 172       end
 173       if klass == "boundary" && type == "administrative"
 174         rank = (place.attributes["place_rank"].to_i + 1) / 2
 175         prefix_name = t "geocoder.search_osm_nominatim.admin_levels.level#{rank}", :default => prefix_name
 176       end
 177       prefix = t "geocoder.search_osm_nominatim.prefix_format", :name => prefix_name
 178       object_type = place.attributes["osm_type"]
 179       object_id = place.attributes["osm_id"]
 180
 181       @results.push(:lat => lat, :lon => lon,
 182                     :min_lat => min_lat, :max_lat => max_lat,
 183                     :min_lon => min_lon, :max_lon => max_lon,
 184                     :prefix => prefix, :name => name,
 185                     :type => object_type, :id => object_id)
 186     end
 187
 188     render :action => "results"
 189     #  rescue StandardError => ex
 190     #    @error = "Error contacting nominatim.openstreetmap.org: #{ex.to_s}"
 191     #    render :action => "error"
 192   end
 193
 194   def search_geonames
 195     # get query parameters
 196     query = params[:query]
 197
 198     # get preferred language
 199     lang = I18n.locale.to_s.split("-").first
 200
 201     # create result array
 202     @results = []
 203
 204     # ask geonames.org
 205     response = fetch_xml("http://api.geonames.org/search?q=#{escape_query(query)}&lang=#{lang}&maxRows=20&username=#{GEONAMES_USERNAME}")
 206
 207     # parse the response
 208     response.elements.each("geonames/geoname") do |geoname|
 209       lat = geoname.get_text("lat").to_s
 210       lon = geoname.get_text("lng").to_s
 211       name = geoname.get_text("name").to_s
 212       country = geoname.get_text("countryName").to_s
 213       @results.push(:lat => lat, :lon => lon,
 214                     :zoom => GEONAMES_ZOOM,
 215                     :name => name,
 216                     :suffix => ", #{country}")
 217     end
 218
 219     render :action => "results"
 220   rescue StandardError => ex
 221     @error = "Error contacting ws.geonames.org: #{ex}"
 222     render :action => "error"
 223   end
 224
 225   def search_osm_nominatim_reverse
 226     # get query parameters
 227     lat = params[:lat]
 228     lon = params[:lon]
 229     zoom = params[:zoom]
 230
 231     # create result array
 232     @results = []
 233
 234     # ask nominatim
 235     response = fetch_xml("http:#{NOMINATIM_URL}reverse?lat=#{lat}&lon=#{lon}&zoom=#{zoom}&accept-language=#{http_accept_language.user_preferred_languages.join(',')}")
 236
 237     # parse the response
 238     response.elements.each("reversegeocode/result") do |result|
 239       lat = result.attributes["lat"].to_s
 240       lon = result.attributes["lon"].to_s
 241       object_type = result.attributes["osm_type"]
 242       object_id = result.attributes["osm_id"]
 243       description = result.get_text.to_s
 244
 245       @results.push(:lat => lat, :lon => lon,
 246                     :zoom => zoom,
 247                     :name => description,
 248                     :type => object_type, :id => object_id)
 249     end
 250
 251     render :action => "results"
 252   rescue StandardError => ex
 253     @error = "Error contacting nominatim.openstreetmap.org: #{ex}"
 254     render :action => "error"
 255   end
 256
 257   def search_geonames_reverse
 258     # get query parameters
 259     lat = params[:lat]
 260     lon = params[:lon]
 261
 262     # get preferred language
 263     lang = I18n.locale.to_s.split("-").first
 264
 265     # create result array
 266     @results = []
 267
 268     # ask geonames.org
 269     response = fetch_xml("http://api.geonames.org/countrySubdivision?lat=#{lat}&lng=#{lon}&lang=#{lang}&username=#{GEONAMES_USERNAME}")
 270
 271     # parse the response
 272     response.elements.each("geonames/countrySubdivision") do |geoname|
 273       name = geoname.get_text("adminName1").to_s
 274       country = geoname.get_text("countryName").to_s
 275       @results.push(:lat => lat, :lon => lon,
 276                     :zoom => GEONAMES_ZOOM,
 277                     :name => name,
 278                     :suffix => ", #{country}")
 279     end
 280
 281     render :action => "results"
 282   rescue StandardError => ex
 283     @error = "Error contacting ws.geonames.org: #{ex}"
 284     render :action => "error"
 285   end
 286
 287   private
 288
 289   def fetch_text(url)
 290     Net::HTTP.get(URI.parse(url))
 291   end
 292
 293   def fetch_xml(url)
 294     REXML::Document.new(fetch_text(url))
 295   end
 296
 297   def format_distance(distance)
 298     t("geocoder.distance", :count => distance)
 299   end
 300
 301   def format_direction(bearing)
 302     return t("geocoder.direction.south_west") if bearing >= 22.5 && bearing < 67.5
 303     return t("geocoder.direction.south") if bearing >= 67.5 && bearing < 112.5
 304     return t("geocoder.direction.south_east") if bearing >= 112.5 && bearing < 157.5
 305     return t("geocoder.direction.east") if bearing >= 157.5 && bearing < 202.5
 306     return t("geocoder.direction.north_east") if bearing >= 202.5 && bearing < 247.5
 307     return t("geocoder.direction.north") if bearing >= 247.5 && bearing < 292.5
 308     return t("geocoder.direction.north_west") if bearing >= 292.5 && bearing < 337.5
 309     t("geocoder.direction.west")
 310   end
 311
 312   def format_name(name)
 313     name.gsub(/( *\[[^\]]*\])*$/, "")
 314   end
 315
 316   def count_results(results)
 317     count = 0
 318
 319     results.each do |source|
 320       count += source[:results].length if source[:results]
 321     end
 322
 323     count
 324   end
 325
 326   def escape_query(query)
 327     URI.escape(query, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]", false, "N"))
 328   end
 329
 330   def normalize_params
 331     query = params[:query]
 332     return unless query
 333
 334     query.strip!
 335
 336     if latlon = query.match(/^([NS])\s*(\d{1,3}(\.\d*)?)\W*([EW])\s*(\d{1,3}(\.\d*)?)$/).try(:captures) # [NSEW] decimal degrees
 337       params.merge!(nsew_to_decdeg(latlon)).delete(:query)
 338     elsif latlon = query.match(/^(\d{1,3}(\.\d*)?)\s*([NS])\W*(\d{1,3}(\.\d*)?)\s*([EW])$/).try(:captures) # decimal degrees [NSEW]
 339       params.merge!(nsew_to_decdeg(latlon)).delete(:query)
 340
 341     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
 342       params.merge!(ddm_to_decdeg(latlon)).delete(:query)
 343     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]
 344       params.merge!(ddm_to_decdeg(latlon)).delete(:query)
 345
 346     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
 347       params.merge!(dms_to_decdeg(latlon)).delete(:query)
 348     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]
 349       params.merge!(dms_to_decdeg(latlon)).delete(:query)
 350
 351     elsif latlon = query.match(/^\s*([+-]?\d+(\.\d*)?)\s*[\s,]\s*([+-]?\d+(\.\d*)?)\s*$/)
 352       params.merge!(:lat => latlon[1].to_f, :lon => latlon[3].to_f).delete(:query)
 353     end
 354   end
 355
 356   def nsew_to_decdeg(captures)
 357     begin
 358       Float(captures[0])
 359       captures[2].downcase != "s" ? lat = captures[0].to_f : lat = -(captures[0].to_f)
 360       captures[5].downcase != "w" ? lon = captures[3].to_f : lon = -(captures[3].to_f)
 361     rescue
 362       captures[0].downcase != "s" ? lat = captures[1].to_f : lat = -(captures[1].to_f)
 363       captures[3].downcase != "w" ? lon = captures[4].to_f : lon = -(captures[4].to_f)
 364     end
 365     { :lat => lat, :lon => lon }
 366   end
 367
 368   def ddm_to_decdeg(captures)
 369     begin
 370       Float(captures[0])
 371       captures[3].downcase != "s" ? lat = captures[0].to_f + captures[1].to_f / 60 : lat = -(captures[0].to_f + captures[1].to_f / 60)
 372       captures[7].downcase != "w" ? lon = captures[4].to_f + captures[5].to_f / 60 : lon = -(captures[4].to_f + captures[5].to_f / 60)
 373     rescue
 374       captures[0].downcase != "s" ? lat = captures[1].to_f + captures[2].to_f / 60 : lat = -(captures[1].to_f + captures[2].to_f / 60)
 375       captures[4].downcase != "w" ? lon = captures[5].to_f + captures[6].to_f / 60 : lon = -(captures[5].to_f + captures[6].to_f / 60)
 376     end
 377     { :lat => lat, :lon => lon }
 378   end
 379
 380   def dms_to_decdeg(captures)
 381     begin
 382       Float(captures[0])
 383       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)
 384       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)
 385     rescue
 386       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)
 387       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)
 388     end
 389     { :lat => lat, :lon => lon }
 390   end
 391 end