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(:name => "latlon", :url => root_path)
  17       @sources.push(:name => "osm_nominatim_reverse", :url => nominatim_reverse_url(:format => "html"))
  18     elsif @params[:query]
  19       @sources.push(:name => "osm_nominatim", :url => nominatim_url(:format => "html"))
  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 => params[:lat], :lon => params[:lon],
  39                       :zoom => params[:zoom],
  40                       :name => "#{params[:lat]}, #{params[:lon]}")
  41       end
  42
  43       if lon >= -90 && lon <= 90 && lat >= -180 && lat <= 180
  44         @results.push(:lat => params[:lon], :lon => params[:lat],
  45                       :zoom => params[:zoom],
  46                       :name => "#{params[:lon]}, #{params[: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 => params[:lat], :lon => params[:lon],
  65                       :zoom => params[:zoom],
  66                       :name => "#{params[:lat]}, #{params[:lon]}" }]
  67
  68         render :action => "results"
  69       end
  70     end
  71   end
  72
  73   def search_osm_nominatim
  74     # ask nominatim
  75     response = fetch_xml(nominatim_url(:format => "xml"))
  76
  77     # extract the results from the response
  78     results = response.elements["searchresults"]
  79
  80     # create result array
  81     @results = []
  82
  83     # create parameter hash for "more results" link
  84     @more_params = params
  85                    .permit(:query, :minlon, :minlat, :maxlon, :maxlat, :exclude)
  86                    .merge(:exclude => results.attributes["exclude_place_ids"])
  87
  88     # parse the response
  89     results.elements.each("place") do |place|
  90       lat = place.attributes["lat"]
  91       lon = place.attributes["lon"]
  92       klass = place.attributes["class"]
  93       type = place.attributes["type"]
  94       name = place.attributes["display_name"]
  95       min_lat, max_lat, min_lon, max_lon = place.attributes["boundingbox"].split(",")
  96       prefix_name = if type.empty?
  97                       ""
  98                     else
  99                       t "geocoder.search_osm_nominatim.prefix.#{klass}.#{type}", :default => type.tr("_", " ").capitalize
 100                     end
 101       if klass == "boundary" && type == "administrative"
 102         rank = (place.attributes["address_rank"].to_i + 1) / 2
 103         prefix_name = t "geocoder.search_osm_nominatim.admin_levels.level#{rank}", :default => prefix_name
 104         place.elements["extratags"].elements.each("tag") do |extratag|
 105           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"
 106         end
 107       end
 108       prefix = t ".prefix_format", :name => prefix_name
 109       object_type = place.attributes["osm_type"]
 110       object_id = place.attributes["osm_id"]
 111
 112       @results.push(:lat => lat, :lon => lon,
 113                     :min_lat => min_lat, :max_lat => max_lat,
 114                     :min_lon => min_lon, :max_lon => max_lon,
 115                     :prefix => prefix, :name => name,
 116                     :type => object_type, :id => object_id)
 117     end
 118
 119     render :action => "results"
 120   rescue StandardError => e
 121     host = URI(Settings.nominatim_url).host
 122     @error = "Error contacting #{host}: #{e}"
 123     render :action => "error"
 124   end
 125
 126   def search_osm_nominatim_reverse
 127     # get query parameters
 128     zoom = params[:zoom]
 129
 130     # create result array
 131     @results = []
 132
 133     # ask nominatim
 134     response = fetch_xml(nominatim_reverse_url(:format => "xml"))
 135
 136     # parse the response
 137     response.elements.each("reversegeocode/result") do |result|
 138       lat = result.attributes["lat"]
 139       lon = result.attributes["lon"]
 140       object_type = result.attributes["osm_type"]
 141       object_id = result.attributes["osm_id"]
 142       description = result.text
 143
 144       @results.push(:lat => lat, :lon => lon,
 145                     :zoom => zoom,
 146                     :name => description,
 147                     :type => object_type, :id => object_id)
 148     end
 149
 150     render :action => "results"
 151   rescue StandardError => e
 152     host = URI(Settings.nominatim_url).host
 153     @error = "Error contacting #{host}: #{e}"
 154     render :action => "error"
 155   end
 156
 157   private
 158
 159   def nominatim_url(format: nil)
 160     # get query parameters
 161     query = params[:query]
 162     minlon = params[:minlon]
 163     minlat = params[:minlat]
 164     maxlon = params[:maxlon]
 165     maxlat = params[:maxlat]
 166
 167     # get view box
 168     viewbox = "&viewbox=#{minlon},#{maxlat},#{maxlon},#{minlat}" if minlon && minlat && maxlon && maxlat
 169
 170     # get objects to excude
 171     exclude = "&exclude_place_ids=#{params[:exclude]}" if params[:exclude]
 172
 173     # build url
 174     "#{Settings.nominatim_url}search?format=#{format}&extratags=1&q=#{escape_query(query)}#{viewbox}#{exclude}&accept-language=#{http_accept_language.user_preferred_languages.join(',')}"
 175   end
 176
 177   def nominatim_reverse_url(format: nil)
 178     # get query parameters
 179     lat = params[:lat]
 180     lon = params[:lon]
 181     zoom = params[:zoom]
 182
 183     # build url
 184     "#{Settings.nominatim_url}reverse?format=#{format}&lat=#{lat}&lon=#{lon}&zoom=#{zoom}&accept-language=#{http_accept_language.user_preferred_languages.join(',')}"
 185   end
 186
 187   def fetch_text(url)
 188     response = OSM.http_client.get(URI.parse(url))
 189
 190     if response.success?
 191       response.body
 192     else
 193       raise response.status.to_s
 194     end
 195   end
 196
 197   def fetch_xml(url)
 198     REXML::Document.new(fetch_text(url))
 199   end
 200
 201   def escape_query(query)
 202     CGI.escape(query)
 203   end
 204
 205   def normalize_params
 206     if query = params[:query]
 207       query.strip!
 208
 209       if latlon = query.match(/^(?<ns>[NS])\s*(?<nsd>\d{1,3}(?:\.\d+)?)°?\W*(?<ew>[EW])\s*(?<ewd>\d{1,3}(?:\.\d+)?)°?$/) ||                                                                                                     # [NSEW] decimal degrees
 210                   query.match(/^(?<nsd>\d{1,3}(?:\.\d+)?)°?\s*(?<ns>[NS])\W*(?<ewd>\d{1,3}(?:\.\d+)?)°?\s*(?<ew>[EW])$/) ||                                                                                                     # decimal degrees [NSEW]
 211                   query.match(/^(?<ns>[NS])\s*(?<nsd>\d{1,3})°?(?:\s*(?<nsm>\d{1,3}(?:\.\d+)?)['′]?)\W*(?<ew>[EW])\s*(?<ewd>\d{1,3})°?(?:\s*(?<ewm>\d{1,3}(?:\.\d+)?)['′]?)$/) ||                                               # [NSEW] degrees, decimal minutes
 212                   query.match(/^(?<nsd>\d{1,3})°?(?:\s*(?<nsm>\d{1,3}(?:\.\d+)?)['′]?)\s*(?<ns>[NS])\W*(?<ewd>\d{1,3})°?(?:\s*(?<ewm>\d{1,3}(?:\.\d+)?)['′]?)\s*(?<ew>[EW])$/) ||                                               # degrees, decimal minutes [NSEW]
 213                   query.match(/^(?<ns>[NS])\s*(?<nsd>\d{1,3})°?\s*(?<nsm>\d{1,2})['′]?(?:\s*(?<nss>\d{1,3}(?:\.\d+)?)["″]?)\W*(?<ew>[EW])\s*(?<ewd>\d{1,3})°?\s*(?<ewm>\d{1,2})['′]?(?:\s*(?<ews>\d{1,3}(?:\.\d+)?)["″]?)$/) || # [NSEW] degrees, minutes, decimal seconds
 214                   query.match(/^(?<nsd>\d{1,3})°?\s*(?<nsm>\d{1,2})['′]?(?:\s*(?<nss>\d{1,3}(?:\.\d+)?)["″]?)\s*(?<ns>[NS])\W*(?<ewd>\d{1,3})°?\s*(?<ewm>\d{1,2})['′]?(?:\s*(?<ews>\d{1,3}(?:\.\d+)?)["″]?)\s*(?<ew>[EW])$/)    # degrees, minutes, decimal seconds [NSEW]
 215         params.merge!(to_decdeg(latlon.named_captures)).delete(:query)
 216
 217       elsif latlon = query.match(%r{^(?<lat>[+-]?\d+(?:\.\d+)?)(?:\s+|\s*[,/]\s*)(?<lon>[+-]?\d+(?:\.\d+)?)$})
 218         params.merge!(:lat => latlon["lat"], :lon => latlon["lon"]).delete(:query)
 219
 220         params[:latlon_digits] = true
 221       end
 222     end
 223
 224     params.permit(:query, :lat, :lon, :latlon_digits, :zoom, :minlat, :minlon, :maxlat, :maxlon)
 225   end
 226
 227   def to_decdeg(captures)
 228     ns = captures.fetch("ns").casecmp("s").zero? ? -1 : 1
 229     nsd = captures.fetch("nsd", "0").to_f
 230     nsm = captures.fetch("nsm", "0").to_f
 231     nss = captures.fetch("nss", "0").to_f
 232
 233     ew = captures.fetch("ew").casecmp("w").zero? ? -1 : 1
 234     ewd = captures.fetch("ewd", "0").to_f
 235     ewm = captures.fetch("ewm", "0").to_f
 236     ews = captures.fetch("ews", "0").to_f
 237
 238     lat = ns * (nsd + (nsm / 60) + (nss / 3600))
 239     lon = ew * (ewd + (ewm / 60) + (ews / 3600))
 240
 241     { :lat => lat, :lon => lon }
 242   end
 243 end