Experimental support for reverse geocoding using the new geocoder.
[rails.git] / app / controllers / geocoder_controller.rb
1 class GeocoderController < ApplicationController
2   require 'uri'
3   require 'net/http'
4   require 'rexml/document'
5
6   before_filter :authorize_web
7   before_filter :set_locale
8
9   def search
10     @query = params[:query]
11     @sources = Array.new
12
13     @query.sub(/^\s+/, "")
14     @query.sub(/\s+$/, "")
15
16     if @query.match(/^[+-]?\d+(\.\d*)?\s*[\s,]\s*[+-]?\d+(\.\d*)?$/)
17       @sources.push "latlon"
18     elsif @query.match(/^\d{5}(-\d{4})?$/)
19       @sources.push "us_postcode"
20     elsif @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)
21       @sources.push "uk_postcode"
22       @sources.push "osm_namefinder"
23       @sources.push "osm_twain" if APP_CONFIG['twain_enabled']
24     elsif @query.match(/^[A-Z]\d[A-Z]\s*\d[A-Z]\d$/i)
25       @sources.push "ca_postcode"
26     else
27       @sources.push "osm_namefinder"
28       @sources.push "osm_twain" if APP_CONFIG['twain_enabled']
29       @sources.push "geonames"
30     end
31
32     render :update do |page|
33       page.replace_html :sidebar_content, :partial => "search"
34       page.call "openSidebar"
35     end
36   end
37
38   def search_latlon
39     # get query parameters
40     query = params[:query]
41
42     # create result array
43     @results = Array.new
44
45     # decode the location
46     if m = query.match(/^\s*([+-]?\d+(\.\d*)?)\s*[\s,]\s*([+-]?\d+(\.\d*)?)\s*$/)
47       lat = m[1].to_f
48       lon = m[3].to_f
49     end
50
51     # generate results
52     if lat < -90 or lat > 90
53       @error = "Latitude #{lat} out of range"
54       render :action => "error"
55     elsif lon < -180 or lon > 180
56       @error = "Longitude #{lon} out of range"
57       render :action => "error"
58     else
59       @results.push({:lat => lat, :lon => lon,
60                      :zoom => APP_CONFIG['postcode_zoom'],
61                      :name => "#{lat}, #{lon}"})
62
63       render :action => "results"
64     end
65   end
66
67   def search_us_postcode
68     # get query parameters
69     query = params[:query]
70
71     # create result array
72     @results = Array.new
73
74     # ask geocoder.us (they have a non-commercial use api)
75     response = fetch_text("http://rpc.geocoder.us/service/csv?zip=#{escape_query(query)}")
76
77     # parse the response
78     unless response.match(/couldn't find this zip/)
79       data = response.split(/\s*,\s+/) # lat,long,town,state,zip
80       @results.push({:lat => data[0], :lon => data[1],
81                      :zoom => APP_CONFIG['postcode_zoom'],
82                      :prefix => "#{data[2]}, #{data[3]},",
83                      :name => data[4]})
84     end
85
86     render :action => "results"
87   rescue Exception => ex
88     @error = "Error contacting rpc.geocoder.us: #{ex.to_s}"
89     render :action => "error"
90   end
91
92   def search_uk_postcode
93     # get query parameters
94     query = params[:query]
95
96     # create result array
97     @results = Array.new
98
99     # ask npemap.org.uk to do a combined npemap + freethepostcode search
100     response = fetch_text("http://www.npemap.org.uk/cgi/geocoder.fcgi?format=text&postcode=#{escape_query(query)}")
101
102     # parse the response
103     unless response.match(/Error/)
104       dataline = response.split(/\n/)[1]
105       data = dataline.split(/,/) # easting,northing,postcode,lat,long
106       postcode = data[2].gsub(/'/, "")
107       zoom = APP_CONFIG['postcode_zoom'] - postcode.count("#")
108       @results.push({:lat => data[3], :lon => data[4], :zoom => zoom,
109                      :name => postcode})
110     end
111
112     render :action => "results"
113   rescue Exception => ex
114     @error = "Error contacting www.npemap.org.uk: #{ex.to_s}"
115     render :action => "error"
116   end
117
118   def search_ca_postcode
119     # get query parameters
120     query = params[:query]
121     @results = Array.new
122
123     # ask geocoder.ca (note - they have a per-day limit)
124     response = fetch_xml("http://geocoder.ca/?geoit=XML&postal=#{escape_query(query)}")
125
126     # parse the response
127     if response.get_elements("geodata/error").empty?
128       @results.push({:lat => response.get_text("geodata/latt").to_s,
129                      :lon => response.get_text("geodata/longt").to_s,
130                      :zoom => APP_CONFIG['postcode_zoom'],
131                      :name => query.upcase})
132     end
133
134     render :action => "results"
135   rescue Exception => ex
136     @error = "Error contacting geocoder.ca: #{ex.to_s}"
137     render :action => "error"
138   end
139
140   def search_osm_namefinder
141     # get query parameters
142     query = params[:query]
143
144     # create result array
145     @results = Array.new
146
147     # ask OSM namefinder
148     response = fetch_xml("http://gazetteer.openstreetmap.org/namefinder/search.xml?find=#{escape_query(query)}")
149
150     # parse the response
151     response.elements.each("searchresults/named") do |named|
152       lat = named.attributes["lat"].to_s
153       lon = named.attributes["lon"].to_s
154       zoom = named.attributes["zoom"].to_s
155       place = named.elements["place/named"] || named.elements["nearestplaces/named"]
156       type = named.attributes["info"].to_s.capitalize
157       name = named.attributes["name"].to_s
158       description = named.elements["description"].to_s
159
160       if name.empty?
161         prefix = ""
162         name = type
163       else
164         prefix =  t "geocoder.search_osm_namefinder.prefix", :type => type
165       end
166
167       if place
168         distance = format_distance(place.attributes["approxdistance"].to_i)
169         direction = format_direction(place.attributes["direction"].to_i)
170         placename = format_name(place.attributes["name"].to_s)
171         suffix = t "geocoder.search_osm_namefinder.suffix_place", :distance => distance, :direction => direction, :placename => placename
172
173         if place.attributes["rank"].to_i <= 30
174           parent = nil
175           parentrank = 0
176           parentscore = 0
177
178           place.elements.each("nearestplaces/named") do |nearest|
179             nearestrank = nearest.attributes["rank"].to_i
180             nearestscore = nearestrank / nearest.attributes["distance"].to_f
181
182             if nearestrank > 30 and
183                ( nearestscore > parentscore or
184                  ( nearestscore == parentscore and nearestrank > parentrank ) )
185               parent = nearest
186               parentrank = nearestrank
187               parentscore = nearestscore
188             end
189           end
190
191           if parent
192             parentname = format_name(parent.attributes["name"].to_s)
193
194             if  place.attributes["info"].to_s == "suburb"
195               suffix = t "geocoder.search_osm_namefinder.suffix_suburb", :suffix => suffix, :parentname => parentname
196             else
197               parentdistance = format_distance(parent.attributes["approxdistance"].to_i)
198               parentdirection = format_direction(parent.attributes["direction"].to_i)
199               suffix = t "geocoder.search_osm_namefinder.suffix_parent", :suffix => suffix, :parentdistance => parentdistance, :parentdirection => parentdirection, :parentname => parentname
200             end
201           end
202         end
203       else
204         suffix = ""
205       end
206
207       @results.push({:lat => lat, :lon => lon, :zoom => zoom,
208                      :prefix => prefix, :name => name, :suffix => suffix,
209                      :description => description})
210     end
211
212     render :action => "results"
213   rescue Exception => ex
214     @error = "Error contacting gazetteer.openstreetmap.org: #{ex.to_s}"
215     render :action => "error"
216   end
217
218   def search_osm_twain
219     # get query parameters
220     query = params[:query]
221
222     # create result array
223     @results = Array.new
224
225     # ask OSM namefinder
226     response = fetch_xml("http://katie.openstreetmap.org/~twain/?format=xml&polygon=true&q=#{escape_query(query)}")
227
228     # parse the response
229     response.elements.each("searchresults/place") do |place|
230       lat = place.attributes["lat"].to_s
231       lon = place.attributes["lon"].to_s
232       zoom = place.attributes["zoom"].to_s
233       klass = place.attributes["class"].to_s
234       type = place.attributes["type"].to_s
235       name = place.attributes["display_name"].to_s
236       min_lat,max_lat,min_lon,max_lon = place.attributes["boundingbox"].to_s.split(",")
237
238       if klass == "highway"
239         prefix = t 'geocoder.search_osm_twain.prefix_highway', :type => type.capitalize
240       else
241         prefix = t 'geocoder.search_osm_twain.prefix_other', :type => type.capitalize
242       end
243
244       @results.push({:lat => lat, :lon => lon, :zoom => zoom,
245                      :min_lat => min_lat, :max_lat => max_lat,
246                      :min_lon => min_lon, :max_lon => max_lon,
247                      :prefix => prefix, :name => name})
248     end
249
250     render :action => "results"
251   rescue Exception => ex
252     @error = "Error contacting katie.openstreetmap.org: #{ex.to_s}"
253     render :action => "error"
254   end
255
256   def search_geonames
257     # get query parameters
258     query = params[:query]
259
260     # create result array
261     @results = Array.new
262
263     # ask geonames.org
264     response = fetch_xml("http://ws.geonames.org/search?q=#{escape_query(query)}&maxRows=20")
265
266     # parse the response
267     response.elements.each("geonames/geoname") do |geoname|
268       lat = geoname.get_text("lat").to_s
269       lon = geoname.get_text("lng").to_s
270       name = geoname.get_text("name").to_s
271       country = geoname.get_text("countryName").to_s
272       @results.push({:lat => lat, :lon => lon,
273                      :zoom => APP_CONFIG['geonames_zoom'],
274                      :name => name,
275                      :suffix => ", #{country}"})
276     end
277
278     render :action => "results"
279   rescue Exception => ex
280     @error = "Error contacting ws.geonames.org: #{ex.to_s}"
281     render :action => "error"
282   end
283
284   def description
285     @sources = Array.new
286
287     @sources.push({ :name => "osm_namefinder", :types => "cities", :max => 2 })
288     @sources.push({ :name => "osm_namefinder", :types => "towns", :max => 4 })
289     @sources.push({ :name => "osm_namefinder", :types => "places", :max => 10 })
290     @sources.push({ :name => "osm_twain" }) if APP_CONFIG['twain_enabled']
291     @sources.push({ :name => "geonames" })
292
293     render :update do |page|
294       page.replace_html :sidebar_content, :partial => "description"
295       page.call "openSidebar"
296     end
297   end
298
299   def description_osm_namefinder
300     # get query parameters
301     lat = params[:lat]
302     lon = params[:lon]
303     types = params[:types]
304     max = params[:max]
305
306     # create result array
307     @results = Array.new
308
309     # ask OSM namefinder
310     response = fetch_xml("http://gazetteer.openstreetmap.org/namefinder/search.xml?find=#{types}+near+#{lat},#{lon}&max=#{max}")
311
312     # parse the response
313     response.elements.each("searchresults/named") do |named|
314       lat = named.attributes["lat"].to_s
315       lon = named.attributes["lon"].to_s
316       zoom = named.attributes["zoom"].to_s
317       place = named.elements["place/named"] || named.elements["nearestplaces/named"]
318       type = named.attributes["info"].to_s
319       name = named.attributes["name"].to_s
320       description = named.elements["description"].to_s
321       distance = format_distance(place.attributes["approxdistance"].to_i)
322       direction = format_direction((place.attributes["direction"].to_i - 180) % 360)
323       prefix = t "geocoder.description_osm_namefinder.prefix", :distance => distance, :direction => direction, :type => type
324       @results.push({:lat => lat, :lon => lon, :zoom => zoom,
325                      :prefix => prefix.capitalize, :name => name,
326                      :description => description})
327     end
328
329     render :action => "results"
330   rescue Exception => ex
331     @error = "Error contacting gazetteer.openstreetmap.org: #{ex.to_s}"
332     render :action => "error"
333   end
334
335   def description_osm_twain
336     # get query parameters
337     lat = params[:lat]
338     lon = params[:lon]
339     zoom = params[:zoom]
340
341     # create result array
342     @results = Array.new
343
344     # ask OSM namefinder
345     response = fetch_xml("http://katie.openstreetmap.org/~twain/reverse.php?lat=#{lat}&lon=#{lon}&zoom=#{zoom}")
346
347     # parse the response
348     response.elements.each("reversegeocode") do |result|
349       description = result.get_text("result").to_s
350
351       @results.push({:prefix => "#{description}"})
352     end
353
354     render :action => "results"
355   rescue Exception => ex
356     @error = "Error contacting katie.openstreetmap.org: #{ex.to_s}"
357     render :action => "error"
358   end
359
360   def description_geonames
361     # get query parameters
362     lat = params[:lat]
363     lon = params[:lon]
364
365     # create result array
366     @results = Array.new
367
368     # ask geonames.org
369     response = fetch_xml("http://ws.geonames.org/countrySubdivision?lat=#{lat}&lng=#{lon}")
370
371     # parse the response
372     response.elements.each("geonames/countrySubdivision") do |geoname|
373       name = geoname.get_text("adminName1").to_s
374       country = geoname.get_text("countryName").to_s
375       @results.push({:prefix => "#{name}, #{country}"})
376     end
377
378     render :action => "results"
379   rescue Exception => ex
380     @error = "Error contacting ws.geonames.org: #{ex.to_s}"
381     render :action => "error"
382   end
383
384 private
385
386   def fetch_text(url)
387     return Net::HTTP.get(URI.parse(url))
388   end
389
390   def fetch_xml(url)
391     return REXML::Document.new(fetch_text(url))
392   end
393
394   def format_distance(distance)
395     return t("geocoder.distance", :count => distance)
396   end
397
398   def format_direction(bearing)
399     return t("geocoder.direction.south_west") if bearing >= 22.5 and bearing < 67.5
400     return t("geocoder.direction.south") if bearing >= 67.5 and bearing < 112.5
401     return t("geocoder.direction.south_east") if bearing >= 112.5 and bearing < 157.5
402     return t("geocoder.direction.east") if bearing >= 157.5 and bearing < 202.5
403     return t("geocoder.direction.north_east") if bearing >= 202.5 and bearing < 247.5
404     return t("geocoder.direction.north") if bearing >= 247.5 and bearing < 292.5
405     return t("geocoder.direction.north_west") if bearing >= 292.5 and bearing < 337.5
406     return t("geocoder.direction.west")
407   end
408
409   def format_name(name)
410     return name.gsub(/( *\[[^\]]*\])*$/, "")
411   end
412
413   def count_results(results)
414     count = 0
415
416     results.each do |source|
417       count += source[:results].length if source[:results]
418     end
419
420     return count
421   end
422
423   def escape_query(query)
424     return URI.escape(query, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]", false, 'N'))
425   end
426 end