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