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