]> git.openstreetmap.org Git - rails.git/blob - app/controllers/geocoder_controller.rb
Add about page
[rails.git] / app / controllers / geocoder_controller.rb
1 # coding: utf-8
2
3 class GeocoderController < ApplicationController
4   require 'uri'
5   require 'net/http'
6   require 'rexml/document'
7
8   before_filter :authorize_web
9   before_filter :set_locale
10
11   def search
12     normalize_params
13
14     @sources = []
15     if params[:lat] && params[:lon]
16       @sources.push "osm_nominatim_reverse"
17       @sources.push "geonames_reverse"
18     elsif params[:query].match(/^\d{5}(-\d{4})?$/)
19       @sources.push "us_postcode"
20       @sources.push "osm_nominatim"
21     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)
22       @sources.push "uk_postcode"
23       @sources.push "osm_nominatim"
24     elsif params[:query].match(/^[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   def search_us_postcode
34     # get query parameters
35     query = params[:query]
36
37     # create result array
38     @results = Array.new
39
40     # ask geocoder.us (they have a non-commercial use api)
41     response = fetch_text("http://rpc.geocoder.us/service/csv?zip=#{escape_query(query)}")
42
43     # parse the response
44     unless response.match(/couldn't find this zip/)
45       data = response.split(/\s*,\s+/) # lat,long,town,state,zip
46       @results.push({:lat => data[0], :lon => data[1],
47                      :zoom => POSTCODE_ZOOM,
48                      :prefix => "#{data[2]}, #{data[3]},",
49                      :name => data[4]})
50     end
51
52     render :action => "results"
53   rescue Exception => ex
54     @error = "Error contacting rpc.geocoder.us: #{ex.to_s}"
55     render :action => "error"
56   end
57
58   def search_uk_postcode
59     # get query parameters
60     query = params[:query]
61
62     # create result array
63     @results = Array.new
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.match(/Error/)
70       dataline = response.split(/\n/)[1]
71       data = dataline.split(/,/) # easting,northing,postcode,lat,long
72       postcode = data[2].gsub(/'/, "")
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 Exception => ex
80     @error = "Error contacting www.npemap.org.uk: #{ex.to_s}"
81     render :action => "error"
82   end
83
84   def search_ca_postcode
85     # get query parameters
86     query = params[:query]
87     @results = Array.new
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 Exception => ex
102     @error = "Error contacting geocoder.ca: #{ex.to_s}"
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     if params[:exclude]
121       exclude = "&exclude_place_ids=#{params[:exclude].join(',')}"
122     end
123
124     # ask nominatim
125     response = fetch_xml("#{NOMINATIM_URL}search?format=xml&q=#{escape_query(query)}#{viewbox}#{exclude}&accept-language=#{http_accept_language.user_preferred_languages.join(',')}")
126
127     # create result array
128     @results = Array.new
129
130     # create parameter hash for "more results" link
131     @more_params = params.reverse_merge({ :exclude => [] })
132
133     # extract the results from the response
134     results =  response.elements["searchresults"]
135
136     # parse the response
137     results.elements.each("place") do |place|
138       lat = place.attributes["lat"].to_s
139       lon = place.attributes["lon"].to_s
140       klass = place.attributes["class"].to_s
141       type = place.attributes["type"].to_s
142       name = place.attributes["display_name"].to_s
143       min_lat,max_lat,min_lon,max_lon = place.attributes["boundingbox"].to_s.split(",")
144       prefix_name = t "geocoder.search_osm_nominatim.prefix.#{klass}.#{type}", :default => type.gsub("_", " ").capitalize
145       if klass == 'boundary' and type == 'administrative'
146         rank = (place.attributes["place_rank"].to_i + 1) / 2
147         prefix_name = t "geocoder.search_osm_nominatim.admin_levels.level#{rank}", :default => prefix_name
148       end
149       prefix = t "geocoder.search_osm_nominatim.prefix_format", :name => prefix_name
150       object_type = place.attributes["osm_type"]
151       object_id = place.attributes["osm_id"]
152
153       @results.push({:lat => lat, :lon => lon,
154                      :min_lat => min_lat, :max_lat => max_lat,
155                      :min_lon => min_lon, :max_lon => max_lon,
156                      :prefix => prefix, :name => name,
157                      :type => object_type, :id => object_id})
158       @more_params[:exclude].push(place.attributes["place_id"].to_s)
159     end
160
161     render :action => "results"
162 #  rescue Exception => ex
163 #    @error = "Error contacting nominatim.openstreetmap.org: #{ex.to_s}"
164 #    render :action => "error"
165   end
166
167   def search_geonames
168     # get query parameters
169     query = params[:query]
170
171     # create result array
172     @results = Array.new
173
174     # ask geonames.org
175     response = fetch_xml("http://api.geonames.org/search?q=#{escape_query(query)}&maxRows=20&username=#{GEONAMES_USERNAME}")
176
177     # parse the response
178     response.elements.each("geonames/geoname") do |geoname|
179       lat = geoname.get_text("lat").to_s
180       lon = geoname.get_text("lng").to_s
181       name = geoname.get_text("name").to_s
182       country = geoname.get_text("countryName").to_s
183       @results.push({:lat => lat, :lon => lon,
184                      :zoom => GEONAMES_ZOOM,
185                      :name => name,
186                      :suffix => ", #{country}"})
187     end
188
189     render :action => "results"
190   rescue Exception => ex
191     @error = "Error contacting ws.geonames.org: #{ex.to_s}"
192     render :action => "error"
193   end
194
195   def search_osm_nominatim_reverse
196     # get query parameters
197     lat = params[:lat]
198     lon = params[:lon]
199     zoom = params[:zoom]
200
201     # create result array
202     @results = Array.new
203
204     # ask nominatim
205     response = fetch_xml("#{NOMINATIM_URL}reverse?lat=#{lat}&lon=#{lon}&zoom=#{zoom}&accept-language=#{http_accept_language.user_preferred_languages.join(',')}")
206
207     # parse the response
208     response.elements.each("reversegeocode/result") do |result|
209       lat = result.attributes["lat"].to_s
210       lon = result.attributes["lon"].to_s
211       object_type = result.attributes["osm_type"]
212       object_id = result.attributes["osm_id"]
213       description = result.get_text.to_s
214
215       @results.push({:lat => lat, :lon => lon,
216                      :zoom => zoom,
217                      :name => description,
218                      :type => object_type, :id => object_id})
219     end
220
221     render :action => "results"
222   rescue Exception => ex
223     @error = "Error contacting nominatim.openstreetmap.org: #{ex.to_s}"
224     render :action => "error"
225   end
226
227   def search_geonames_reverse
228     # get query parameters
229     lat = params[:lat]
230     lon = params[:lon]
231
232     # create result array
233     @results = Array.new
234
235     # ask geonames.org
236     response = fetch_xml("http://ws.geonames.org/countrySubdivision?lat=#{lat}&lng=#{lon}")
237
238     # parse the response
239     response.elements.each("geonames/countrySubdivision") do |geoname|
240       name = geoname.get_text("adminName1").to_s
241       country = geoname.get_text("countryName").to_s
242       @results.push({:lat => lat, :lon => lon,
243                      :zoom => GEONAMES_ZOOM,
244                      :name => name,
245                      :suffix => ", #{country}"})
246     end
247
248     render :action => "results"
249   rescue Exception => ex
250     @error = "Error contacting ws.geonames.org: #{ex.to_s}"
251     render :action => "error"
252   end
253
254 private
255
256   def fetch_text(url)
257     return Net::HTTP.get(URI.parse(url))
258   end
259
260   def fetch_xml(url)
261     return REXML::Document.new(fetch_text(url))
262   end
263
264   def format_distance(distance)
265     return t("geocoder.distance", :count => distance)
266   end
267
268   def format_direction(bearing)
269     return t("geocoder.direction.south_west") if bearing >= 22.5 and bearing < 67.5
270     return t("geocoder.direction.south") if bearing >= 67.5 and bearing < 112.5
271     return t("geocoder.direction.south_east") if bearing >= 112.5 and bearing < 157.5
272     return t("geocoder.direction.east") if bearing >= 157.5 and bearing < 202.5
273     return t("geocoder.direction.north_east") if bearing >= 202.5 and bearing < 247.5
274     return t("geocoder.direction.north") if bearing >= 247.5 and bearing < 292.5
275     return t("geocoder.direction.north_west") if bearing >= 292.5 and bearing < 337.5
276     return t("geocoder.direction.west")
277   end
278
279   def format_name(name)
280     return name.gsub(/( *\[[^\]]*\])*$/, "")
281   end
282
283   def count_results(results)
284     count = 0
285
286     results.each do |source|
287       count += source[:results].length if source[:results]
288     end
289
290     return count
291   end
292
293   def escape_query(query)
294     return URI.escape(query, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]", false, 'N'))
295   end
296
297   def normalize_params
298     query = params[:query]
299     return unless query
300
301     query.strip!
302
303     if latlon = query.match(/^([NS])\s*(\d{1,3}(\.\d*)?)\W*([EW])\s*(\d{1,3}(\.\d*)?)$/).try(:captures) # [NSEW] decimal degrees
304       params.merge!(nsew_to_decdeg(latlon)).delete(:query)
305     elsif latlon = query.match(/^(\d{1,3}(\.\d*)?)\s*([NS])\W*(\d{1,3}(\.\d*)?)\s*([EW])$/).try(:captures) # decimal degrees [NSEW]
306       params.merge!(nsew_to_decdeg(latlon)).delete(:query)
307
308     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
309       params.merge!(ddm_to_decdeg(latlon)).delete(:query)
310     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]
311       params.merge!(ddm_to_decdeg(latlon)).delete(:query)
312
313     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
314       params.merge!(dms_to_decdeg(latlon)).delete(:query)
315     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]
316       params.merge!(dms_to_decdeg(latlon)).delete(:query)
317
318     elsif latlon = query.match(/^\s*([+-]?\d+(\.\d*)?)\s*[\s,]\s*([+-]?\d+(\.\d*)?)\s*$/)
319       params.merge!({:lat => latlon[1].to_f, :lon => latlon[3].to_f}).delete(:query)
320     end
321   end
322
323   def nsew_to_decdeg(captures)
324     begin
325       Float(captures[0])
326       captures[2].downcase != 's' ? lat = captures[0].to_f : lat = -(captures[0].to_f)
327       captures[5].downcase != 'w' ? lon = captures[3].to_f : lon = -(captures[3].to_f)
328     rescue
329       captures[0].downcase != 's' ? lat = captures[1].to_f : lat = -(captures[1].to_f)
330       captures[3].downcase != 'w' ? lon = captures[4].to_f : lon = -(captures[4].to_f)
331     end
332     {:lat => lat, :lon => lon}
333   end
334
335   def ddm_to_decdeg(captures)
336     begin
337       Float(captures[0])
338       captures[3].downcase != 's' ? lat = captures[0].to_f + captures[1].to_f/60 : lat = -(captures[0].to_f + captures[1].to_f/60)
339       captures[7].downcase != 'w' ? lon = captures[4].to_f + captures[5].to_f/60 : lon = -(captures[4].to_f + captures[5].to_f/60)
340     rescue
341       captures[0].downcase != 's' ? lat = captures[1].to_f + captures[2].to_f/60 : lat = -(captures[1].to_f + captures[2].to_f/60)
342       captures[4].downcase != 'w' ? lon = captures[5].to_f + captures[6].to_f/60 : lon = -(captures[5].to_f + captures[6].to_f/60)
343     end
344     {:lat => lat, :lon => lon}
345   end
346
347   def dms_to_decdeg(captures)
348     begin
349       Float(captures[0])
350       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)
351       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)
352     rescue
353       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)
354       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)
355     end
356     {:lat => lat, :lon => lon}
357   end
358
359 end