app/controllers/geocoder_controller.rb

   1 class GeocoderController < ApplicationController
   2   require "cgi"
   3   require "uri"
   4   require "rexml/document"
   5
   6   before_action :authorize_web
   7   before_action :set_locale
   8   before_action :require_oauth, :only => [:search]
   9   authorize_resource :class => false
  10
  11   def search
  12     @params = normalize_params
  13     @sources = []
  14
  15     if @params[:lat] && @params[:lon]
  16       @sources.push "latlon"
  17       @sources.push "osm_nominatim_reverse"
  18     elsif @params[:query]
  19       @sources.push "osm_nominatim"
  20     end
  21
  22     if @sources.empty?
  23       head :bad_request
  24     else
  25       render :layout => map_layout
  26     end
  27   end
  28
  29   def search_latlon
  30     lat = params[:lat].to_f
  31     lon = params[:lon].to_f
  32
  33     if params[:latlon_digits]
  34       # We've got two nondescript numbers for a query, which can mean both "lat, lon" or "lon, lat".
  35       @results = []
  36
  37       if lat >= -90 && lat <= 90 && lon >= -180 && lon <= 180
  38         @results.push(:lat => lat, :lon => lon,
  39                       :zoom => params[:zoom],
  40                       :name => "#{lat}, #{lon}")
  41       end
  42
  43       if lon >= -90 && lon <= 90 && lat >= -180 && lat <= 180
  44         @results.push(:lat => lon, :lon => lat,
  45                       :zoom => params[:zoom],
  46                       :name => "#{lon}, #{lat}")
  47       end
  48
  49       if @results.empty?
  50         @error = "Latitude or longitude are out of range"
  51         render :action => "error"
  52       else
  53         render :action => "results"
  54       end
  55     else
  56       # Coordinates in a query have come with markers for latitude and longitude.
  57       if lat < -90 || lat > 90
  58         @error = "Latitude #{lat} out of range"
  59         render :action => "error"
  60       elsif lon < -180 || lon > 180
  61         @error = "Longitude #{lon} out of range"
  62         render :action => "error"
  63       else
  64         @results = [{ :lat => lat, :lon => lon,
  65                       :zoom => params[:zoom],
  66                       :name => "#{lat}, #{lon}" }]
  67
  68         render :action => "results"
  69       end
  70     end
  71   end
  72
  73   def search_osm_nominatim
  74     # get query parameters
  75     query = params[:query]
  76     minlon = params[:minlon]
  77     minlat = params[:minlat]
  78     maxlon = params[:maxlon]
  79     maxlat = params[:maxlat]
  80
  81     # get view box
  82     viewbox = "&viewbox=#{minlon},#{maxlat},#{maxlon},#{minlat}" if minlon && minlat && maxlon && maxlat
  83
  84     # get objects to excude
  85     exclude = "&exclude_place_ids=#{params[:exclude]}" if params[:exclude]
  86
  87     # ask nominatim
  88     response = fetch_xml("#{Settings.nominatim_url}search?format=xml&extratags=1&q=#{escape_query(query)}#{viewbox}#{exclude}&accept-language=#{http_accept_language.user_preferred_languages.join(',')}")
  89
  90     # extract the results from the response
  91     results =  response.elements["searchresults"]
  92
  93     # extract parameters from more_url
  94     more_url_params = CGI.parse(URI.parse(results.attributes["more_url"]).query)
  95
  96     # create result array
  97     @results = []
  98
  99     # create parameter hash for "more results" link
 100     @more_params = params
 101                    .permit(:query, :minlon, :minlat, :maxlon, :maxlat, :exclude)
 102                    .merge(:exclude => more_url_params["exclude_place_ids"].first)
 103
 104     # parse the response
 105     results.elements.each("place") do |place|
 106       lat = place.attributes["lat"]
 107       lon = place.attributes["lon"]
 108       klass = place.attributes["class"]
 109       type = place.attributes["type"]
 110       name = place.attributes["display_name"]
 111       min_lat, max_lat, min_lon, max_lon = place.attributes["boundingbox"].split(",")
 112       prefix_name = if type.empty?
 113                       ""
 114                     else
 115                       t "geocoder.search_osm_nominatim.prefix.#{klass}.#{type}", :default => type.tr("_", " ").capitalize
 116                     end
 117       if klass == "boundary" && type == "administrative"
 118         rank = (place.attributes["address_rank"].to_i + 1) / 2
 119         prefix_name = t "geocoder.search_osm_nominatim.admin_levels.level#{rank}", :default => prefix_name
 120         place.elements["extratags"].elements.each("tag") do |extratag|
 121           prefix_name = t "geocoder.search_osm_nominatim.prefix.place.#{extratag.attributes['value']}", :default => prefix_name if extratag.attributes["key"] == "linked_place" || extratag.attributes["key"] == "place"
 122         end
 123       end
 124       prefix = t ".prefix_format", :name => prefix_name
 125       object_type = place.attributes["osm_type"]
 126       object_id = place.attributes["osm_id"]
 127
 128       @results.push(:lat => lat, :lon => lon,
 129                     :min_lat => min_lat, :max_lat => max_lat,
 130                     :min_lon => min_lon, :max_lon => max_lon,
 131                     :prefix => prefix, :name => name,
 132                     :type => object_type, :id => object_id)
 133     end
 134
 135     render :action => "results"
 136   rescue StandardError => e
 137     host = URI(Settings.nominatim_url).host
 138     @error = "Error contacting #{host}: #{e}"
 139     render :action => "error"
 140   end
 141
 142   def search_osm_nominatim_reverse
 143     # get query parameters
 144     lat = params[:lat]
 145     lon = params[:lon]
 146     zoom = params[:zoom]
 147
 148     # create result array
 149     @results = []
 150
 151     # ask nominatim
 152     response = fetch_xml("#{Settings.nominatim_url}reverse?lat=#{lat}&lon=#{lon}&zoom=#{zoom}&accept-language=#{http_accept_language.user_preferred_languages.join(',')}")
 153
 154     # parse the response
 155     response.elements.each("reversegeocode/result") do |result|
 156       lat = result.attributes["lat"]
 157       lon = result.attributes["lon"]
 158       object_type = result.attributes["osm_type"]
 159       object_id = result.attributes["osm_id"]
 160       description = result.text
 161
 162       @results.push(:lat => lat, :lon => lon,
 163                     :zoom => zoom,
 164                     :name => description,
 165                     :type => object_type, :id => object_id)
 166     end
 167
 168     render :action => "results"
 169   rescue StandardError => e
 170     host = URI(Settings.nominatim_url).host
 171     @error = "Error contacting #{host}: #{e}"
 172     render :action => "error"
 173   end
 174
 175   private
 176
 177   def fetch_text(url)
 178     response = OSM.http_client.get(URI.parse(url))
 179
 180     if response.success?
 181       response.body
 182     else
 183       raise response.status.to_s
 184     end
 185   end
 186
 187   def fetch_xml(url)
 188     REXML::Document.new(fetch_text(url))
 189   end
 190
 191   def escape_query(query)
 192     CGI.escape(query)
 193   end
 194
 195   def normalize_params
 196     if query = params[:query]
 197       query.strip!
 198
 199       if latlon = query.match(/^([NS])\s*(\d{1,3}(\.\d*)?)\W*([EW])\s*(\d{1,3}(\.\d*)?)$/).try(:captures) || # [NSEW] decimal degrees
 200                   query.match(/^(\d{1,3}(\.\d*)?)\s*([NS])\W*(\d{1,3}(\.\d*)?)\s*([EW])$/).try(:captures)    # decimal degrees [NSEW]
 201         params.merge!(nsew_to_decdeg(latlon)).delete(:query)
 202
 203       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
 204                      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]
 205         params.merge!(ddm_to_decdeg(latlon)).delete(:query)
 206
 207       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
 208                      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]
 209         params.merge!(dms_to_decdeg(latlon)).delete(:query)
 210
 211       elsif latlon = query.match(/^([+-]?\d+(\.\d*)?)(?:\s+|\s*,\s*)([+-]?\d+(\.\d*)?)$/)
 212         params.merge!(:lat => latlon[1].to_f, :lon => latlon[3].to_f).delete(:query)
 213
 214         params[:latlon_digits] = true unless params[:whereami]
 215       end
 216     end
 217
 218     params.permit(:query, :lat, :lon, :latlon_digits, :zoom, :minlat, :minlon, :maxlat, :maxlon)
 219   end
 220
 221   def nsew_to_decdeg(captures)
 222     begin
 223       Float(captures[0])
 224       lat = captures[2].casecmp("s").zero? ? -captures[0].to_f : captures[0].to_f
 225       lon = captures[5].casecmp("w").zero? ? -captures[3].to_f : captures[3].to_f
 226     rescue StandardError
 227       lat = captures[0].casecmp("s").zero? ? -captures[1].to_f : captures[1].to_f
 228       lon = captures[3].casecmp("w").zero? ? -captures[4].to_f : captures[4].to_f
 229     end
 230     { :lat => lat, :lon => lon }
 231   end
 232
 233   def ddm_to_decdeg(captures)
 234     begin
 235       Float(captures[0])
 236       lat = captures[3].casecmp("s").zero? ? -(captures[0].to_f + (captures[1].to_f / 60)) : captures[0].to_f + (captures[1].to_f / 60)
 237       lon = captures[7].casecmp("w").zero? ? -(captures[4].to_f + (captures[5].to_f / 60)) : captures[4].to_f + (captures[5].to_f / 60)
 238     rescue StandardError
 239       lat = captures[0].casecmp("s").zero? ? -(captures[1].to_f + (captures[2].to_f / 60)) : captures[1].to_f + (captures[2].to_f / 60)
 240       lon = captures[4].casecmp("w").zero? ? -(captures[5].to_f + (captures[6].to_f / 60)) : captures[5].to_f + (captures[6].to_f / 60)
 241     end
 242     { :lat => lat, :lon => lon }
 243   end
 244
 245   def dms_to_decdeg(captures)
 246     begin
 247       Float(captures[0])
 248       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)
 249       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)
 250     rescue StandardError
 251       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)
 252       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)
 253     end
 254     { :lat => lat, :lon => lon }
 255   end
 256 end