Use the exclusion list returned by nominatim
[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 Rails.logger.info @more_params
165
166     # parse the response
167     results.elements.each("place") do |place|
168       lat = place.attributes["lat"].to_s
169       lon = place.attributes["lon"].to_s
170       klass = place.attributes["class"].to_s
171       type = place.attributes["type"].to_s
172       name = place.attributes["display_name"].to_s
173       min_lat,max_lat,min_lon,max_lon = place.attributes["boundingbox"].to_s.split(",")
174       if type.empty?
175         prefix_name = ""
176       else
177         prefix_name = t "geocoder.search_osm_nominatim.prefix.#{klass}.#{type}", :default => type.gsub("_", " ").capitalize
178       end
179       if klass == 'boundary' and type == 'administrative'
180         rank = (place.attributes["place_rank"].to_i + 1) / 2
181         prefix_name = t "geocoder.search_osm_nominatim.admin_levels.level#{rank}", :default => prefix_name
182       end
183       prefix = t "geocoder.search_osm_nominatim.prefix_format", :name => prefix_name
184       object_type = place.attributes["osm_type"]
185       object_id = place.attributes["osm_id"]
186
187       @results.push({:lat => lat, :lon => lon,
188                      :min_lat => min_lat, :max_lat => max_lat,
189                      :min_lon => min_lon, :max_lon => max_lon,
190                      :prefix => prefix, :name => name,
191                      :type => object_type, :id => object_id})
192     end
193
194     render :action => "results"
195 #  rescue Exception => ex
196 #    @error = "Error contacting nominatim.openstreetmap.org: #{ex.to_s}"
197 #    render :action => "error"
198   end
199
200   def search_geonames
201     # get query parameters
202     query = params[:query]
203
204     # get preferred language
205     lang = I18n.locale.to_s.split("-").first
206
207     # create result array
208     @results = Array.new
209
210     # ask geonames.org
211     response = fetch_xml("http://api.geonames.org/search?q=#{escape_query(query)}&lang=#{lang}&maxRows=20&username=#{GEONAMES_USERNAME}")
212
213     # parse the response
214     response.elements.each("geonames/geoname") do |geoname|
215       lat = geoname.get_text("lat").to_s
216       lon = geoname.get_text("lng").to_s
217       name = geoname.get_text("name").to_s
218       country = geoname.get_text("countryName").to_s
219       @results.push({:lat => lat, :lon => lon,
220                      :zoom => GEONAMES_ZOOM,
221                      :name => name,
222                      :suffix => ", #{country}"})
223     end
224
225     render :action => "results"
226   rescue Exception => ex
227     @error = "Error contacting ws.geonames.org: #{ex.to_s}"
228     render :action => "error"
229   end
230
231   def search_osm_nominatim_reverse
232     # get query parameters
233     lat = params[:lat]
234     lon = params[:lon]
235     zoom = params[:zoom]
236
237     # create result array
238     @results = Array.new
239
240     # ask nominatim
241     response = fetch_xml("#{NOMINATIM_URL}reverse?lat=#{lat}&lon=#{lon}&zoom=#{zoom}&accept-language=#{http_accept_language.user_preferred_languages.join(',')}")
242
243     # parse the response
244     response.elements.each("reversegeocode/result") do |result|
245       lat = result.attributes["lat"].to_s
246       lon = result.attributes["lon"].to_s
247       object_type = result.attributes["osm_type"]
248       object_id = result.attributes["osm_id"]
249       description = result.get_text.to_s
250
251       @results.push({:lat => lat, :lon => lon,
252                      :zoom => zoom,
253                      :name => description,
254                      :type => object_type, :id => object_id})
255     end
256
257     render :action => "results"
258   rescue Exception => ex
259     @error = "Error contacting nominatim.openstreetmap.org: #{ex.to_s}"
260     render :action => "error"
261   end
262
263   def search_geonames_reverse
264     # get query parameters
265     lat = params[:lat]
266     lon = params[:lon]
267
268     # get preferred language
269     lang = I18n.locale.to_s.split("-").first
270
271     # create result array
272     @results = Array.new
273
274     # ask geonames.org
275     response = fetch_xml("http://api.geonames.org/countrySubdivision?lat=#{lat}&lng=#{lon}&lang=#{lang}&username=#{GEONAMES_USERNAME}")
276
277     # parse the response
278     response.elements.each("geonames/countrySubdivision") do |geoname|
279       name = geoname.get_text("adminName1").to_s
280       country = geoname.get_text("countryName").to_s
281       @results.push({:lat => lat, :lon => lon,
282                      :zoom => GEONAMES_ZOOM,
283                      :name => name,
284                      :suffix => ", #{country}"})
285     end
286
287     render :action => "results"
288   rescue Exception => ex
289     @error = "Error contacting ws.geonames.org: #{ex.to_s}"
290     render :action => "error"
291   end
292
293 private
294
295   def fetch_text(url)
296     return Net::HTTP.get(URI.parse(url))
297   end
298
299   def fetch_xml(url)
300     return REXML::Document.new(fetch_text(url))
301   end
302
303   def format_distance(distance)
304     return t("geocoder.distance", :count => distance)
305   end
306
307   def format_direction(bearing)
308     return t("geocoder.direction.south_west") if bearing >= 22.5 and bearing < 67.5
309     return t("geocoder.direction.south") if bearing >= 67.5 and bearing < 112.5
310     return t("geocoder.direction.south_east") if bearing >= 112.5 and bearing < 157.5
311     return t("geocoder.direction.east") if bearing >= 157.5 and bearing < 202.5
312     return t("geocoder.direction.north_east") if bearing >= 202.5 and bearing < 247.5
313     return t("geocoder.direction.north") if bearing >= 247.5 and bearing < 292.5
314     return t("geocoder.direction.north_west") if bearing >= 292.5 and bearing < 337.5
315     return t("geocoder.direction.west")
316   end
317
318   def format_name(name)
319     return name.gsub(/( *\[[^\]]*\])*$/, "")
320   end
321
322   def count_results(results)
323     count = 0
324
325     results.each do |source|
326       count += source[:results].length if source[:results]
327     end
328
329     return count
330   end
331
332   def escape_query(query)
333     return URI.escape(query, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]", false, 'N'))
334   end
335
336   def normalize_params
337     query = params[:query]
338     return unless query
339
340     query.strip!
341
342     if latlon = query.match(/^([NS])\s*(\d{1,3}(\.\d*)?)\W*([EW])\s*(\d{1,3}(\.\d*)?)$/).try(:captures) # [NSEW] decimal degrees
343       params.merge!(nsew_to_decdeg(latlon)).delete(:query)
344     elsif latlon = query.match(/^(\d{1,3}(\.\d*)?)\s*([NS])\W*(\d{1,3}(\.\d*)?)\s*([EW])$/).try(:captures) # decimal degrees [NSEW]
345       params.merge!(nsew_to_decdeg(latlon)).delete(:query)
346
347     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
348       params.merge!(ddm_to_decdeg(latlon)).delete(:query)
349     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]
350       params.merge!(ddm_to_decdeg(latlon)).delete(:query)
351
352     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
353       params.merge!(dms_to_decdeg(latlon)).delete(:query)
354     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]
355       params.merge!(dms_to_decdeg(latlon)).delete(:query)
356
357     elsif latlon = query.match(/^\s*([+-]?\d+(\.\d*)?)\s*[\s,]\s*([+-]?\d+(\.\d*)?)\s*$/)
358       params.merge!({:lat => latlon[1].to_f, :lon => latlon[3].to_f}).delete(:query)
359     end
360   end
361
362   def nsew_to_decdeg(captures)
363     begin
364       Float(captures[0])
365       captures[2].downcase != 's' ? lat = captures[0].to_f : lat = -(captures[0].to_f)
366       captures[5].downcase != 'w' ? lon = captures[3].to_f : lon = -(captures[3].to_f)
367     rescue
368       captures[0].downcase != 's' ? lat = captures[1].to_f : lat = -(captures[1].to_f)
369       captures[3].downcase != 'w' ? lon = captures[4].to_f : lon = -(captures[4].to_f)
370     end
371     {:lat => lat, :lon => lon}
372   end
373
374   def ddm_to_decdeg(captures)
375     begin
376       Float(captures[0])
377       captures[3].downcase != 's' ? lat = captures[0].to_f + captures[1].to_f/60 : lat = -(captures[0].to_f + captures[1].to_f/60)
378       captures[7].downcase != 'w' ? lon = captures[4].to_f + captures[5].to_f/60 : lon = -(captures[4].to_f + captures[5].to_f/60)
379     rescue
380       captures[0].downcase != 's' ? lat = captures[1].to_f + captures[2].to_f/60 : lat = -(captures[1].to_f + captures[2].to_f/60)
381       captures[4].downcase != 'w' ? lon = captures[5].to_f + captures[6].to_f/60 : lon = -(captures[5].to_f + captures[6].to_f/60)
382     end
383     {:lat => lat, :lon => lon}
384   end
385
386   def dms_to_decdeg(captures)
387     begin
388       Float(captures[0])
389       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)
390       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)
391     rescue
392       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)
393       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)
394     end
395     {:lat => lat, :lon => lon}
396   end
397
398 end