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