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       @sources.push "osm_nominatim"
  21     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)
  22       @sources.push "uk_postcode"
  23       @sources.push "osm_nominatim"
  24     elsif @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"
  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 => 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 => 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 = 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 => 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_nominatim
 219     # get query parameters
 220     query = params[:query]
 221     minlon = params[:minlon]
 222     minlat = params[:minlat]
 223     maxlon = params[:maxlon]
 224     maxlat = params[:maxlat]
 225
 226     # get view box
 227     if minlon && minlat && maxlon && maxlat
 228       viewbox = "&viewbox=#{minlon},#{maxlat},#{maxlon},#{minlat}"
 229     end
 230
 231     # get objects to excude
 232     if params[:exclude]
 233       exclude = "&exclude_place_ids=#{params[:exclude].join(',')}"
 234     end
 235
 236     # ask nominatim
 237     response = fetch_xml("#{NOMINATIM_URL}search?format=xml&q=#{escape_query(query)}#{viewbox}#{exclude}&accept-language=#{request.user_preferred_languages.join(',')}")
 238
 239     # create result array
 240     @results = Array.new
 241
 242     # create parameter hash for "more results" link
 243     @more_params = params.reverse_merge({ :exclude => [] })
 244
 245     # extract the results from the response
 246     results =  response.elements["searchresults"]
 247
 248     # parse the response
 249     results.elements.each("place") do |place|
 250       lat = place.attributes["lat"].to_s
 251       lon = place.attributes["lon"].to_s
 252       klass = place.attributes["class"].to_s
 253       type = place.attributes["type"].to_s
 254       name = place.attributes["display_name"].to_s
 255       min_lat,max_lat,min_lon,max_lon = place.attributes["boundingbox"].to_s.split(",")
 256       prefix_name = t "geocoder.search_osm_nominatim.prefix.#{klass}.#{type}", :default => type.gsub("_", " ").capitalize
 257       prefix = t "geocoder.search_osm_nominatim.prefix_format", :name => prefix_name
 258
 259       @results.push({:lat => lat, :lon => lon,
 260                      :min_lat => min_lat, :max_lat => max_lat,
 261                      :min_lon => min_lon, :max_lon => max_lon,
 262                      :prefix => prefix, :name => name})
 263       @more_params[:exclude].push(place.attributes["place_id"].to_s)
 264     end
 265
 266     render :action => "results"
 267   rescue Exception => ex
 268     @error = "Error contacting nominatim.openstreetmap.org: #{ex.to_s}"
 269     render :action => "error"
 270   end
 271
 272   def search_geonames
 273     # get query parameters
 274     query = params[:query]
 275
 276     # create result array
 277     @results = Array.new
 278
 279     # ask geonames.org
 280     response = fetch_xml("http://ws.geonames.org/search?q=#{escape_query(query)}&maxRows=20")
 281
 282     # parse the response
 283     response.elements.each("geonames/geoname") do |geoname|
 284       lat = geoname.get_text("lat").to_s
 285       lon = geoname.get_text("lng").to_s
 286       name = geoname.get_text("name").to_s
 287       country = geoname.get_text("countryName").to_s
 288       @results.push({:lat => lat, :lon => lon,
 289                      :zoom => GEONAMES_ZOOM,
 290                      :name => name,
 291                      :suffix => ", #{country}"})
 292     end
 293
 294     render :action => "results"
 295   rescue Exception => ex
 296     @error = "Error contacting ws.geonames.org: #{ex.to_s}"
 297     render :action => "error"
 298   end
 299
 300   def description
 301     @sources = Array.new
 302
 303     @sources.push({ :name => "osm_nominatim" })
 304     @sources.push({ :name => "geonames" })
 305
 306     render :update do |page|
 307       page.replace_html :sidebar_content, :partial => "description"
 308       page.call "openSidebar"
 309     end
 310   end
 311
 312   def description_osm_namefinder
 313     # get query parameters
 314     lat = params[:lat]
 315     lon = params[:lon]
 316     types = params[:types]
 317     max = params[:max]
 318
 319     # create result array
 320     @results = Array.new
 321
 322     # ask OSM namefinder
 323     response = fetch_xml("http://gazetteer.openstreetmap.org/namefinder/search.xml?find=#{types}+near+#{lat},#{lon}&max=#{max}")
 324
 325     # parse the response
 326     response.elements.each("searchresults/named") do |named|
 327       lat = named.attributes["lat"].to_s
 328       lon = named.attributes["lon"].to_s
 329       zoom = named.attributes["zoom"].to_s
 330       place = named.elements["place/named"] || named.elements["nearestplaces/named"]
 331       type = named.attributes["info"].to_s
 332       name = named.attributes["name"].to_s
 333       description = named.elements["description"].to_s
 334       distance = format_distance(place.attributes["approxdistance"].to_i)
 335       direction = format_direction((place.attributes["direction"].to_i - 180) % 360)
 336       prefix = t "geocoder.description_osm_namefinder.prefix", :distance => distance, :direction => direction, :type => type
 337       @results.push({:lat => lat, :lon => lon, :zoom => zoom,
 338                      :prefix => prefix.capitalize, :name => name,
 339                      :description => description})
 340     end
 341
 342     render :action => "results"
 343   rescue Exception => ex
 344     @error = "Error contacting gazetteer.openstreetmap.org: #{ex.to_s}"
 345     render :action => "error"
 346   end
 347
 348   def description_osm_nominatim
 349     # get query parameters
 350     lat = params[:lat]
 351     lon = params[:lon]
 352     zoom = params[:zoom]
 353
 354     # create result array
 355     @results = Array.new
 356
 357     # ask OSM namefinder
 358     response = fetch_xml("#{NOMINATIM_URL}reverse?lat=#{lat}&lon=#{lon}&zoom=#{zoom}&accept-language=#{request.user_preferred_languages.join(',')}")
 359
 360     # parse the response
 361     response.elements.each("reversegeocode/result") do |result|
 362       description = result.get_text.to_s
 363
 364       @results.push({:prefix => "#{description}"})
 365     end
 366
 367     render :action => "results"
 368   rescue Exception => ex
 369     @error = "Error contacting nominatim.openstreetmap.org: #{ex.to_s}"
 370     render :action => "error"
 371   end
 372
 373   def description_geonames
 374     # get query parameters
 375     lat = params[:lat]
 376     lon = params[:lon]
 377
 378     # create result array
 379     @results = Array.new
 380
 381     # ask geonames.org
 382     response = fetch_xml("http://ws.geonames.org/countrySubdivision?lat=#{lat}&lng=#{lon}")
 383
 384     # parse the response
 385     response.elements.each("geonames/countrySubdivision") do |geoname|
 386       name = geoname.get_text("adminName1").to_s
 387       country = geoname.get_text("countryName").to_s
 388       @results.push({:prefix => "#{name}, #{country}"})
 389     end
 390
 391     render :action => "results"
 392   rescue Exception => ex
 393     @error = "Error contacting ws.geonames.org: #{ex.to_s}"
 394     render :action => "error"
 395   end
 396
 397 private
 398
 399   def fetch_text(url)
 400     return Net::HTTP.get(URI.parse(url))
 401   end
 402
 403   def fetch_xml(url)
 404     return REXML::Document.new(fetch_text(url))
 405   end
 406
 407   def format_distance(distance)
 408     return t("geocoder.distance", :count => distance)
 409   end
 410
 411   def format_direction(bearing)
 412     return t("geocoder.direction.south_west") if bearing >= 22.5 and bearing < 67.5
 413     return t("geocoder.direction.south") if bearing >= 67.5 and bearing < 112.5
 414     return t("geocoder.direction.south_east") if bearing >= 112.5 and bearing < 157.5
 415     return t("geocoder.direction.east") if bearing >= 157.5 and bearing < 202.5
 416     return t("geocoder.direction.north_east") if bearing >= 202.5 and bearing < 247.5
 417     return t("geocoder.direction.north") if bearing >= 247.5 and bearing < 292.5
 418     return t("geocoder.direction.north_west") if bearing >= 292.5 and bearing < 337.5
 419     return t("geocoder.direction.west")
 420   end
 421
 422   def format_name(name)
 423     return name.gsub(/( *\[[^\]]*\])*$/, "")
 424   end
 425
 426   def count_results(results)
 427     count = 0
 428
 429     results.each do |source|
 430       count += source[:results].length if source[:results]
 431     end
 432
 433     return count
 434   end
 435
 436   def escape_query(query)
 437     return URI.escape(query, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]", false, 'N'))
 438   end
 439 end