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