More search improvements - a "Where am I?" link that does a reverse
[rails.git] / app / controllers / geocoder_controller.rb
1 class GeocoderController < ApplicationController
2   require 'uri'
3   require 'net/http'
4   require 'rexml/document'
5
6   def search
7     query = params[:query]
8     results = Array.new
9
10     if query.match(/^\d{5}(-\d{4})?$/)
11       results.push search_us_postcode(query)
12     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)
13       results.push search_uk_postcode(query)
14     elsif query.match(/[A-Z]\d[A-Z]\s*\d[A-Z]\d/i)
15       results.push search_ca_postcode(query)
16     else
17       results.push search_osm_namefinder(query)
18       results.push search_geonames(query)
19     end
20
21     results_count = count_results(results)
22
23     render :update do |page|
24       page.replace_html :search_results_content, :partial => 'results', :object => results
25
26       if results_count == 1
27         position = results.collect { |s| s[:results] }.compact.flatten[0]
28         page.call "setPosition", position[:lat], position[:lon], position[:zoom]
29       else
30         page.call "openSearchResults"
31       end
32     end
33   end
34   
35   def description
36     results = Array.new
37
38     lat = params[:lat]
39     lon = params[:lon]
40
41     results.push description_osm_namefinder("cities", lat, lon, 2)
42     results.push description_osm_namefinder("towns", lat, lon, 4)
43     results.push description_osm_namefinder("places", lat, lon, 10)
44
45     render :update do |page|
46       page.replace_html :search_results_content, :partial => 'results', :object => results
47       page.call "openSearchResults"
48     end
49   end
50
51 private
52
53   def search_us_postcode(query)
54     results = Array.new
55
56     # ask geocoder.us (they have a non-commercial use api)
57     response = fetch_text("http://rpc.geocoder.us/service/csv?zip=#{URI.escape(query)}")
58
59     # parse the response
60     unless response.match(/couldn't find this zip/)
61       data = response.split(/\s*,\s+/) # lat,long,town,state,zip
62       results.push({:lat => data[0], :lon => data[1], :zoom => 12,
63                     :prefix => "#{data[2]}, #{data[3]}, ",
64                     :name => data[4]})
65     end
66
67     return { :source => "Geocoder.us", :url => "http://geocoder.us/", :results => results }
68   rescue Exception => ex
69     return { :source => "Geocoder.us", :url => "http://geocoder.us/", :error => "Error contacting rpc.geocoder.us: #{ex.to_s}" }
70   end
71
72   def search_uk_postcode(query)
73     results = Array.new
74
75     # ask npemap.org.uk to do a combined npemap + freethepostcode search
76     response = fetch_text("http://www.npemap.org.uk/cgi/geocoder.fcgi?format=text&postcode=#{URI.escape(query)}")
77
78     # parse the response
79     unless response.match(/Error/)
80       dataline = response.split(/\n/)[1]
81       data = dataline.split(/,/) # easting,northing,postcode,lat,long
82       results.push({:lat => data[3], :lon => data[4], :zoom => 12,
83                     :name => data[2].gsub(/'/, "")})
84     end
85
86     return { :source => "NPEMap / FreeThePostcode", :url => "http://www.npemap.org.uk/", :results => results }
87   rescue Exception => ex
88     return { :source => "NPEMap / FreeThePostcode", :url => "http://www.npemap.org.uk/", :error => "Error contacting www.npemap.org.uk: #{ex.to_s}" }
89   end
90
91   def search_ca_postcode(query)
92     results = Array.new
93
94     # ask geocoder.ca (note - they have a per-day limit)
95     response = fetch_xml("http://geocoder.ca/?geoit=XML&postal=#{URI.escape(query)}")
96
97     # parse the response
98     unless response.get_elements("geodata/error")
99       results.push({:lat => response.get_text("geodata/latt").to_s,
100                     :lon => response.get_text("geodata/longt").to_s,
101                     :zoom => 12,
102                     :name => query.upcase})
103     end
104
105     return { :source => "Geocoder.CA", :url => "http://geocoder.ca/", :results => results }
106   rescue Exception => ex
107     return { :source => "Geocoder.CA", :url => "http://geocoder.ca/", :error => "Error contacting geocoder.ca: #{ex.to_s}" }
108   end
109
110   def search_osm_namefinder(query)
111     results = Array.new
112
113     # ask OSM namefinder
114     response = fetch_xml("http://www.frankieandshadow.com/osm/search.xml?find=#{URI.escape(query)}")
115
116     # parse the response
117     response.elements.each("searchresults/named") do |named|
118       lat = named.attributes["lat"].to_s
119       lon = named.attributes["lon"].to_s
120       zoom = named.attributes["zoom"].to_s
121       place = named.elements["place/named"] || named.elements["nearestplaces/named"]
122       type = named.attributes["info"].to_s.capitalize
123       name = named.attributes["name"].to_s
124       description = named.elements["description"].to_s
125       if name.empty?
126         prefix = ""
127         name = type
128       else
129         prefix = "#{type} "
130       end
131       if place
132         distance = format_distance(place.attributes["approxdistance"].to_i)
133         direction = format_direction(place.attributes["direction"].to_i)
134         placename = place.attributes["name"].to_s
135         suffix = ", #{distance} #{direction} of #{placename}"
136       else
137         suffix = ""
138       end
139       results.push({:lat => lat, :lon => lon, :zoom => zoom,
140                     :prefix => prefix, :name => name, :suffix => suffix,
141                     :description => description})
142     end
143
144     return { :source => "OpenStreetMap Namefinder", :url => "http://www.frankieandshadow.com/osm/", :results => results }
145   rescue Exception => ex
146     return { :source => "OpenStreetMap Namefinder", :url => "http://www.frankieandshadow.com/osm/", :error => "Error contacting www.frankieandshadow.com: #{ex.to_s}" }
147   end
148
149   def search_geonames(query)
150     results = Array.new
151
152     # ask geonames.org
153     response = fetch_xml("http://ws.geonames.org/search?q=#{URI.escape(query)}&maxRows=20")
154
155     # parse the response
156     response.elements.each("geonames/geoname") do |geoname|
157       lat = geoname.get_text("lat").to_s
158       lon = geoname.get_text("lng").to_s
159       name = geoname.get_text("name").to_s
160       country = geoname.get_text("countryName").to_s
161       results.push({:lat => lat, :lon => lon, :zoom => 12,
162                     :name => name,
163                     :suffix => ", #{country}"})
164     end
165
166     return { :source => "GeoNames", :url => "http://www.geonames.org/", :results => results }
167   rescue Exception => ex
168     return { :source => "GeoNames", :url => "http://www.geonames.org/", :error => "Error contacting ws.geonames.org: #{ex.to_s}" }
169   end
170
171   def description_osm_namefinder(types, lat, lon, max)
172     results = Array.new
173
174     # ask OSM namefinder
175     response = fetch_xml("http://www.frankieandshadow.com/osm/search.xml?find=#{types}+near+#{lat},#{lon}&max=#{max}")
176
177     # parse the response
178     response.elements.each("searchresults/named") do |named|
179       lat = named.attributes["lat"].to_s
180       lon = named.attributes["lon"].to_s
181       zoom = named.attributes["zoom"].to_s
182       place = named.elements["place/named"] || named.elements["nearestplaces/named"]
183       type = named.attributes["info"].to_s
184       name = named.attributes["name"].to_s
185       description = named.elements["description"].to_s
186       distance = format_distance(place.attributes["approxdistance"].to_i)
187       direction = format_direction(360 - place.attributes["direction"].to_i)
188       prefix = "#{distance} #{direction} of #{type} "
189       results.push({:lat => lat, :lon => lon, :zoom => zoom,
190                     :prefix => prefix.capitalize, :name => name,
191                     :description => description})
192     end
193
194     return { :type => types.capitalize, :source => "OpenStreetMap Namefinder", :url => "http://www.frankieandshadow.com/osm/", :results => results }
195   rescue Exception => ex
196     return { :type => types.capitalize, :source => "OpenStreetMap Namefinder", :url => "http://www.frankieandshadow.com/osm/", :error => "Error contacting www.frankieandshadow.com: #{ex.to_s}" }
197   end
198
199   def fetch_text(url)
200     return Net::HTTP.get(URI.parse(url))
201   end
202
203   def fetch_xml(url)
204     return REXML::Document.new(fetch_text(url))
205   end
206
207   def format_distance(distance)
208     return "less than 1km" if distance == 0
209     return "about #{distance}km"
210   end
211
212   def format_direction(bearing)
213     return "south-west" if bearing >= 22.5 and bearing < 67.5
214     return "south" if bearing >= 67.5 and bearing < 112.5
215     return "south-east" if bearing >= 112.5 and bearing < 157.5
216     return "east" if bearing >= 157.5 and bearing < 202.5
217     return "north-east" if bearing >= 202.5 and bearing < 247.5
218     return "north" if bearing >= 247.5 and bearing < 292.5
219     return "north-west" if bearing >= 292.5 and bearing < 337.5
220     return "west"
221   end
222
223   def count_results(results)
224     count = 0
225
226     results.each do |source|
227       count += source[:results].length if source[:results]
228     end
229
230     return count
231   end
232 end