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     # create result array
  94     @results = []
  95
  96     # create parameter hash for "more results" link
  97     @more_params = params
  98                    .permit(:query, :minlon, :minlat, :maxlon, :maxlat, :exclude)
  99                    .merge(:exclude => results.attributes["exclude_place_ids"])
 100
 101     # parse the response
 102     results.elements.each("place") do |place|
 103       lat = place.attributes["lat"]
 104       lon = place.attributes["lon"]
 105       klass = place.attributes["class"]
 106       type = place.attributes["type"]
 107       name = place.attributes["display_name"]
 108       min_lat, max_lat, min_lon, max_lon = place.attributes["boundingbox"].split(",")
 109       prefix_name = if type.empty?
 110                       ""
 111                     else
 112                       t "geocoder.search_osm_nominatim.prefix.#{klass}.#{type}", :default => type.tr("_", " ").capitalize
 113                     end
 114       if klass == "boundary" && type == "administrative"
 115         rank = (place.attributes["address_rank"].to_i + 1) / 2
 116         prefix_name = t "geocoder.search_osm_nominatim.admin_levels.level#{rank}", :default => prefix_name
 117         place.elements["extratags"].elements.each("tag") do |extratag|
 118           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"
 119         end
 120       end
 121       prefix = t ".prefix_format", :name => prefix_name
 122       object_type = place.attributes["osm_type"]
 123       object_id = place.attributes["osm_id"]
 124
 125       @results.push(:lat => lat, :lon => lon,
 126                     :min_lat => min_lat, :max_lat => max_lat,
 127                     :min_lon => min_lon, :max_lon => max_lon,
 128                     :prefix => prefix, :name => name,
 129                     :type => object_type, :id => object_id)
 130     end
 131
 132     render :action => "results"
 133   rescue StandardError => e
 134     host = URI(Settings.nominatim_url).host
 135     @error = "Error contacting #{host}: #{e}"
 136     render :action => "error"
 137   end
 138
 139   def search_osm_nominatim_reverse
 140     # get query parameters
 141     lat = params[:lat]
 142     lon = params[:lon]
 143     zoom = params[:zoom]
 144
 145     # create result array
 146     @results = []
 147
 148     # ask nominatim
 149     response = fetch_xml("#{Settings.nominatim_url}reverse?lat=#{lat}&lon=#{lon}&zoom=#{zoom}&accept-language=#{http_accept_language.user_preferred_languages.join(',')}")
 150
 151     # parse the response
 152     response.elements.each("reversegeocode/result") do |result|
 153       lat = result.attributes["lat"]
 154       lon = result.attributes["lon"]
 155       object_type = result.attributes["osm_type"]
 156       object_id = result.attributes["osm_id"]
 157       description = result.text
 158
 159       @results.push(:lat => lat, :lon => lon,
 160                     :zoom => zoom,
 161                     :name => description,
 162                     :type => object_type, :id => object_id)
 163     end
 164
 165     render :action => "results"
 166   rescue StandardError => e
 167     host = URI(Settings.nominatim_url).host
 168     @error = "Error contacting #{host}: #{e}"
 169     render :action => "error"
 170   end
 171
 172   private
 173
 174   def fetch_text(url)
 175     response = OSM.http_client.get(URI.parse(url))
 176
 177     if response.success?
 178       response.body
 179     else
 180       raise response.status.to_s
 181     end
 182   end
 183
 184   def fetch_xml(url)
 185     REXML::Document.new(fetch_text(url))
 186   end
 187
 188   def escape_query(query)
 189     CGI.escape(query)
 190   end
 191
 192   def normalize_params
 193     if query = params[:query]
 194       query.strip!
 195
 196       if latlon = query.match(/^([NS])\s*(\d{1,3}(\.\d*)?)\W*([EW])\s*(\d{1,3}(\.\d*)?)$/).try(:captures) || # [NSEW] decimal degrees
 197                   query.match(/^(\d{1,3}(\.\d*)?)\s*([NS])\W*(\d{1,3}(\.\d*)?)\s*([EW])$/).try(:captures)    # decimal degrees [NSEW]
 198         params.merge!(nsew_to_decdeg(latlon)).delete(:query)
 199
 200       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
 201                      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]
 202         params.merge!(ddm_to_decdeg(latlon)).delete(:query)
 203
 204       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
 205                      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]
 206         params.merge!(dms_to_decdeg(latlon)).delete(:query)
 207
 208       elsif latlon = query.match(/^([+-]?\d+(\.\d*)?)(?:\s+|\s*,\s*)([+-]?\d+(\.\d*)?)$/)
 209         params.merge!(:lat => latlon[1].to_f, :lon => latlon[3].to_f).delete(:query)
 210
 211         params[:latlon_digits] = true unless params[:whereami]
 212       end
 213     end
 214
 215     params.permit(:query, :lat, :lon, :latlon_digits, :zoom, :minlat, :minlon, :maxlat, :maxlon)
 216   end
 217
 218   def nsew_to_decdeg(captures)
 219     begin
 220       Float(captures[0])
 221       lat = captures[2].casecmp("s").zero? ? -captures[0].to_f : captures[0].to_f
 222       lon = captures[5].casecmp("w").zero? ? -captures[3].to_f : captures[3].to_f
 223     rescue StandardError
 224       lat = captures[0].casecmp("s").zero? ? -captures[1].to_f : captures[1].to_f
 225       lon = captures[3].casecmp("w").zero? ? -captures[4].to_f : captures[4].to_f
 226     end
 227     { :lat => lat, :lon => lon }
 228   end
 229
 230   def ddm_to_decdeg(captures)
 231     begin
 232       Float(captures[0])
 233       lat = captures[3].casecmp("s").zero? ? -(captures[0].to_f + (captures[1].to_f / 60)) : captures[0].to_f + (captures[1].to_f / 60)
 234       lon = captures[7].casecmp("w").zero? ? -(captures[4].to_f + (captures[5].to_f / 60)) : captures[4].to_f + (captures[5].to_f / 60)
 235     rescue StandardError
 236       lat = captures[0].casecmp("s").zero? ? -(captures[1].to_f + (captures[2].to_f / 60)) : captures[1].to_f + (captures[2].to_f / 60)
 237       lon = captures[4].casecmp("w").zero? ? -(captures[5].to_f + (captures[6].to_f / 60)) : captures[5].to_f + (captures[6].to_f / 60)
 238     end
 239     { :lat => lat, :lon => lon }
 240   end
 241
 242   def dms_to_decdeg(captures)
 243     begin
 244       Float(captures[0])
 245       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)
 246       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)
 247     rescue StandardError
 248       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)
 249       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)
 250     end
 251     { :lat => lat, :lon => lon }
 252   end
 253 end