Merged 17256:18123 from trunk.

[rails.git] / app / controllers / geocoder_controller.rb

diff --git a/app/controllers/geocoder_controller.rb b/app/controllers/geocoder_controller.rb
index 66962c7f6bf58d035e4125ec8e7053050e38e66c..556cfb36ad4ae53bf04fbadd3097cbdc9bb31dbd 100644 (file)
--- a/app/controllers/geocoder_controller.rb
+++ b/app/controllers/geocoder_controller.rb
@@ -3,60 +3,71 @@ class GeocoderController < ApplicationController
   require 'net/http'
   require 'rexml/document'
 
   require 'net/http'
   require 'rexml/document'
 

-  POSTCODE_ZOOM = 15
-  GEONAMES_ZOOM = 12
+  before_filter :authorize_web
+  before_filter :set_locale

 
   def search
 
   def search

-    query = params[:query]
-    results = Array.new
-
-    if query.match(/^\d{5}(-\d{4})?$/)
-      results.push search_us_postcode(query)
-    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)
-      results.push search_uk_postcode(query)
-      results.push search_osm_namefinder(query)
-    elsif query.match(/[A-Z]\d[A-Z]\s*\d[A-Z]\d/i)
-      results.push search_ca_postcode(query)
+    @query = params[:query]
+    @sources = Array.new
+
+    @query.sub(/^\s+/, "")
+    @query.sub(/\s+$/, "")
+
+    if @query.match(/^[+-]?\d+(\.\d*)?\s*[\s,]\s*[+-]?\d+(\.\d*)?$/)
+      @sources.push "latlon"
+    elsif @query.match(/^\d{5}(-\d{4})?$/)
+      @sources.push "us_postcode"
+    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)
+      @sources.push "uk_postcode"
+      @sources.push "osm_namefinder"
+    elsif @query.match(/^[A-Z]\d[A-Z]\s*\d[A-Z]\d$/i)
+      @sources.push "ca_postcode"

     else
     else

-      results.push search_osm_namefinder(query)
-      results.push search_geonames(query)
+      @sources.push "osm_namefinder"
+      @sources.push "geonames"

     end
 
     end
 

-    results_count = count_results(results)
-

     render :update do |page|
     render :update do |page|

-      page.replace_html :sidebar_content, :partial => 'results', :object => results
-
-      if results_count == 1
-        position = results.collect { |s| s[:results] }.compact.flatten[0]
-        page.call "setPosition", position[:lat], position[:lon], position[:zoom]
-      else
-        page.call "openSidebar"
-      end
+      page.replace_html :sidebar_content, :partial => "search"
+      page.call "openSidebar"

     end
   end
     end
   end

-  
-  def description
-    results = Array.new

 
 

-    lat = params[:lat]
-    lon = params[:lon]
+  def search_latlon
+    # get query parameters
+    query = params[:query]

 
 

-    results.push description_osm_namefinder("cities", lat, lon, 2)
-    results.push description_osm_namefinder("towns", lat, lon, 4)
-    results.push description_osm_namefinder("places", lat, lon, 10)
-    results.push description_geonames(lat, lon)
+    # create result array
+    @results = Array.new

 
 

-    render :update do |page|
-      page.replace_html :sidebar_content, :partial => 'results', :object => results
-      page.call "openSidebar"
+    # decode the location
+    if m = query.match(/^\s*([+-]?\d+(\.\d*)?)\s*[\s,]\s*([+-]?\d+(\.\d*)?)\s*$/)
+      lat = m[1].to_f
+      lon = m[3].to_f
+    end
+
+    # generate results
+    if lat < -90 or lat > 90
+      @error = "Latitude #{lat} out of range"
+      render :action => "error"
+    elsif lon < -180 or lon > 180
+      @error = "Longitude #{lon} out of range"
+      render :action => "error"
+    else
+      @results.push({:lat => lat, :lon => lon,
+                     :zoom => APP_CONFIG['postcode_zoom'],
+                     :name => "#{lat}, #{lon}"})
+
+      render :action => "results"

     end
   end
 
     end
   end
 

-private
+  def search_us_postcode
+    # get query parameters
+    query = params[:query]

 
 

-  def search_us_postcode(query)
-    results = Array.new
+    # create result array
+    @results = Array.new

 
     # ask geocoder.us (they have a non-commercial use api)
     response = fetch_text("http://rpc.geocoder.us/service/csv?zip=#{escape_query(query)}")
 
     # ask geocoder.us (they have a non-commercial use api)
     response = fetch_text("http://rpc.geocoder.us/service/csv?zip=#{escape_query(query)}")


@@ -64,18 +75,24 @@ private
     # parse the response
     unless response.match(/couldn't find this zip/)
       data = response.split(/\s*,\s+/) # lat,long,town,state,zip
     # parse the response
     unless response.match(/couldn't find this zip/)
       data = response.split(/\s*,\s+/) # lat,long,town,state,zip

-      results.push({:lat => data[0], :lon => data[1], :zoom => POSTCODE_ZOOM,
-                    :prefix => "#{data[2]}, #{data[3]}, ",
-                    :name => data[4]})
+      @results.push({:lat => data[0], :lon => data[1],
+                     :zoom => APP_CONFIG['postcode_zoom'],
+                     :prefix => "#{data[2]}, #{data[3]},",
+                     :name => data[4]})

     end
 
     end
 

-    return { :source => "Geocoder.us", :url => "http://geocoder.us/", :results => results }
+    render :action => "results"

   rescue Exception => ex
   rescue Exception => ex

-    return { :source => "Geocoder.us", :url => "http://geocoder.us/", :error => "Error contacting rpc.geocoder.us: #{ex.to_s}" }
+    @error = "Error contacting rpc.geocoder.us: #{ex.to_s}"
+    render :action => "error"

   end
 
   end
 

-  def search_uk_postcode(query)
-    results = Array.new
+  def search_uk_postcode
+    # get query parameters
+    query = params[:query]
+
+    # create result array
+    @results = Array.new

 
     # ask npemap.org.uk to do a combined npemap + freethepostcode search
     response = fetch_text("http://www.npemap.org.uk/cgi/geocoder.fcgi?format=text&postcode=#{escape_query(query)}")
 
     # ask npemap.org.uk to do a combined npemap + freethepostcode search
     response = fetch_text("http://www.npemap.org.uk/cgi/geocoder.fcgi?format=text&postcode=#{escape_query(query)}")


@@ -85,37 +102,45 @@ private
       dataline = response.split(/\n/)[1]
       data = dataline.split(/,/) # easting,northing,postcode,lat,long
       postcode = data[2].gsub(/'/, "")
       dataline = response.split(/\n/)[1]
       data = dataline.split(/,/) # easting,northing,postcode,lat,long
       postcode = data[2].gsub(/'/, "")

-      zoom = POSTCODE_ZOOM - postcode.count("#")
-      results.push({:lat => data[3], :lon => data[4], :zoom => zoom,
-                    :name => postcode})
+      zoom = APP_CONFIG['postcode_zoom'] - postcode.count("#")
+      @results.push({:lat => data[3], :lon => data[4], :zoom => zoom,
+                     :name => postcode})

     end
 
     end
 

-    return { :source => "NPEMap / FreeThePostcode", :url => "http://www.npemap.org.uk/", :results => results }
+    render :action => "results"

   rescue Exception => ex
   rescue Exception => ex

-    return { :source => "NPEMap / FreeThePostcode", :url => "http://www.npemap.org.uk/", :error => "Error contacting www.npemap.org.uk: #{ex.to_s}" }
+    @error = "Error contacting www.npemap.org.uk: #{ex.to_s}"
+    render :action => "error"

   end
 
   end
 

-  def search_ca_postcode(query)
-    results = Array.new
+  def search_ca_postcode
+    # get query parameters
+    query = params[:query]
+    @results = Array.new

 
     # ask geocoder.ca (note - they have a per-day limit)
     response = fetch_xml("http://geocoder.ca/?geoit=XML&postal=#{escape_query(query)}")
 
     # parse the response
 
     # ask geocoder.ca (note - they have a per-day limit)
     response = fetch_xml("http://geocoder.ca/?geoit=XML&postal=#{escape_query(query)}")
 
     # parse the response

-    unless response.get_elements("geodata/error")
-      results.push({:lat => response.get_text("geodata/latt").to_s,
-                    :lon => response.get_text("geodata/longt").to_s,
-                    :zoom => POSTCODE_ZOOM,
-                    :name => query.upcase})
+    if response.get_elements("geodata/error").empty?
+      @results.push({:lat => response.get_text("geodata/latt").to_s,
+                     :lon => response.get_text("geodata/longt").to_s,
+                     :zoom => APP_CONFIG['postcode_zoom'],
+                     :name => query.upcase})

     end
 
     end
 

-    return { :source => "Geocoder.CA", :url => "http://geocoder.ca/", :results => results }
+    render :action => "results"

   rescue Exception => ex
   rescue Exception => ex

-    return { :source => "Geocoder.CA", :url => "http://geocoder.ca/", :error => "Error contacting geocoder.ca: #{ex.to_s}" }
+    @error = "Error contacting geocoder.ca: #{ex.to_s}"
+    render :action => "error"

   end
 
   end
 

-  def search_osm_namefinder(query)
-    results = Array.new
+  def search_osm_namefinder
+    # get query parameters
+    query = params[:query]
+
+    # create result array
+    @results = Array.new

 
     # ask OSM namefinder
     response = fetch_xml("http://gazetteer.openstreetmap.org/namefinder/search.xml?find=#{escape_query(query)}")
 
     # ask OSM namefinder
     response = fetch_xml("http://gazetteer.openstreetmap.org/namefinder/search.xml?find=#{escape_query(query)}")


@@ -134,29 +159,30 @@ private
         prefix = ""
         name = type
       else
         prefix = ""
         name = type
       else

-        prefix = "#{type} "
+        prefix =  t "geocoder.search_osm_namefinder.prefix", :type => type

       end
 
       if place
         distance = format_distance(place.attributes["approxdistance"].to_i)
         direction = format_direction(place.attributes["direction"].to_i)
         placename = format_name(place.attributes["name"].to_s)
       end
 
       if place
         distance = format_distance(place.attributes["approxdistance"].to_i)
         direction = format_direction(place.attributes["direction"].to_i)
         placename = format_name(place.attributes["name"].to_s)

-        suffix = ", #{distance} #{direction} of #{placename}"
+        suffix = t "geocoder.search_osm_namefinder.suffix_place", :distance => distance, :direction => direction, :placename => placename

 
         if place.attributes["rank"].to_i <= 30
           parent = nil
           parentrank = 0
 
         if place.attributes["rank"].to_i <= 30
           parent = nil
           parentrank = 0

-          parentdistance = 0
+          parentscore = 0

 
           place.elements.each("nearestplaces/named") do |nearest|
             nearestrank = nearest.attributes["rank"].to_i
 
           place.elements.each("nearestplaces/named") do |nearest|
             nearestrank = nearest.attributes["rank"].to_i

-            nearestdistance = nearest.attributes["distance"].to_f
+            nearestscore = nearestrank / nearest.attributes["distance"].to_f

 
 

-            if nearestrank > parentrank or
-               ( nearestrank == parentrank and nearestdistance < parentdistance )
+            if nearestrank > 30 and
+               ( nearestscore > parentscore or
+                 ( nearestscore == parentscore and nearestrank > parentrank ) )

               parent = nearest
               parentrank = nearestrank
               parent = nearest
               parentrank = nearestrank

-              parentdistance = nearestdistance
+              parentscore = nearestscore

             end
           end
 
             end
           end
 


@@ -164,9 +190,11 @@ private
             parentname = format_name(parent.attributes["name"].to_s)
 
             if  place.attributes["info"].to_s == "suburb"
             parentname = format_name(parent.attributes["name"].to_s)
 
             if  place.attributes["info"].to_s == "suburb"

-              suffix = "#{suffix}, #{parentname}"
+              suffix = t "geocoder.search_osm_namefinder.suffix_suburb", :suffix => suffix, :parentname => parentname

             else
             else

-              suffix = "#{suffix} (near #{parentname})"
+              parentdistance = format_distance(parent.attributes["approxdistance"].to_i)
+              parentdirection = format_direction(parent.attributes["direction"].to_i)
+              suffix = t "geocoder.search_osm_namefinder.suffix_parent", :suffix => suffix, :parentdistance => parentdistance, :parentdirection => parentdirection, :parentname => parentname

             end
           end
         end
             end
           end
         end


@@ -174,18 +202,23 @@ private
         suffix = ""
       end
 
         suffix = ""
       end
 

-      results.push({:lat => lat, :lon => lon, :zoom => zoom,
-                    :prefix => prefix, :name => name, :suffix => suffix,
-                    :description => description})
+      @results.push({:lat => lat, :lon => lon, :zoom => zoom,
+                     :prefix => prefix, :name => name, :suffix => suffix,
+                     :description => description})

     end
 
     end
 

-    return { :source => "OpenStreetMap Namefinder", :url => "http://gazetteer.openstreetmap.org/namefinder/", :results => results }
+    render :action => "results"

   rescue Exception => ex
   rescue Exception => ex

-    return { :source => "OpenStreetMap Namefinder", :url => "http://gazetteer.openstreetmap.org/namefinder/", :error => "Error contacting gazetteer.openstreetmap.org: #{ex.to_s}" }
+    @error = "Error contacting gazetteer.openstreetmap.org: #{ex.to_s}"
+    render :action => "error"

   end
 
   end
 

-  def search_geonames(query)
-    results = Array.new
+  def search_geonames
+    # get query parameters
+    query = params[:query]
+
+    # create result array
+    @results = Array.new

 
     # ask geonames.org
     response = fetch_xml("http://ws.geonames.org/search?q=#{escape_query(query)}&maxRows=20")
 
     # ask geonames.org
     response = fetch_xml("http://ws.geonames.org/search?q=#{escape_query(query)}&maxRows=20")


@@ -196,18 +229,41 @@ private
       lon = geoname.get_text("lng").to_s
       name = geoname.get_text("name").to_s
       country = geoname.get_text("countryName").to_s
       lon = geoname.get_text("lng").to_s
       name = geoname.get_text("name").to_s
       country = geoname.get_text("countryName").to_s

-      results.push({:lat => lat, :lon => lon, :zoom => GEONAMES_ZOOM,
-                    :name => name,
-                    :suffix => ", #{country}"})
+      @results.push({:lat => lat, :lon => lon,
+                     :zoom => APP_CONFIG['geonames_zoom'],
+                     :name => name,
+                     :suffix => ", #{country}"})

     end
 
     end
 

-    return { :source => "GeoNames", :url => "http://www.geonames.org/", :results => results }
+    render :action => "results"

   rescue Exception => ex
   rescue Exception => ex

-    return { :source => "GeoNames", :url => "http://www.geonames.org/", :error => "Error contacting ws.geonames.org: #{ex.to_s}" }
+    @error = "Error contacting ws.geonames.org: #{ex.to_s}"
+    render :action => "error"

   end
   end

+  
+  def description
+    @sources = Array.new

 
 

-  def description_osm_namefinder(types, lat, lon, max)
-    results = Array.new
+    @sources.push({ :name => "osm_namefinder", :types => "cities", :max => 2 })
+    @sources.push({ :name => "osm_namefinder", :types => "towns", :max => 4 })
+    @sources.push({ :name => "osm_namefinder", :types => "places", :max => 10 })
+    @sources.push({ :name => "geonames" })
+
+    render :update do |page|
+      page.replace_html :sidebar_content, :partial => "description"
+      page.call "openSidebar"
+    end
+  end
+
+  def description_osm_namefinder
+    # get query parameters
+    lat = params[:lat]
+    lon = params[:lon]
+    types = params[:types]
+    max = params[:max]
+
+    # create result array
+    @results = Array.new

 
     # ask OSM namefinder
     response = fetch_xml("http://gazetteer.openstreetmap.org/namefinder/search.xml?find=#{types}+near+#{lat},#{lon}&max=#{max}")
 
     # ask OSM namefinder
     response = fetch_xml("http://gazetteer.openstreetmap.org/namefinder/search.xml?find=#{types}+near+#{lat},#{lon}&max=#{max}")


@@ -223,19 +279,25 @@ private
       description = named.elements["description"].to_s
       distance = format_distance(place.attributes["approxdistance"].to_i)
       direction = format_direction((place.attributes["direction"].to_i - 180) % 360)
       description = named.elements["description"].to_s
       distance = format_distance(place.attributes["approxdistance"].to_i)
       direction = format_direction((place.attributes["direction"].to_i - 180) % 360)

-      prefix = "#{distance} #{direction} of #{type} "
-      results.push({:lat => lat, :lon => lon, :zoom => zoom,
-                    :prefix => prefix.capitalize, :name => name,
-                    :description => description})
+      prefix = t "geocoder.description_osm_namefinder.prefix", :distance => distance, :direction => direction, :type => type
+      @results.push({:lat => lat, :lon => lon, :zoom => zoom,
+                     :prefix => prefix.capitalize, :name => name,
+                     :description => description})

     end
 
     end
 

-    return { :type => types.capitalize, :source => "OpenStreetMap Namefinder", :url => "http://gazetteer.openstreetmap.org/namefinder/", :results => results }
+    render :action => "results"

   rescue Exception => ex
   rescue Exception => ex

-    return { :type => types.capitalize, :source => "OpenStreetMap Namefinder", :url => "http://gazetteer.openstreetmap.org/namefinder/", :error => "Error contacting gazetteer.openstreetmap.org: #{ex.to_s}" }
+    @error = "Error contacting gazetteer.openstreetmap.org: #{ex.to_s}"
+    render :action => "error"

   end
 
   end
 

-  def description_geonames(lat, lon)
-    results = Array.new
+  def description_geonames
+    # get query parameters
+    lat = params[:lat]
+    lon = params[:lon]
+
+    # create result array
+    @results = Array.new

 
     # ask geonames.org
     response = fetch_xml("http://ws.geonames.org/countrySubdivision?lat=#{lat}&lng=#{lon}")
 
     # ask geonames.org
     response = fetch_xml("http://ws.geonames.org/countrySubdivision?lat=#{lat}&lng=#{lon}")


@@ -244,14 +306,17 @@ private
     response.elements.each("geonames/countrySubdivision") do |geoname|
       name = geoname.get_text("adminName1").to_s
       country = geoname.get_text("countryName").to_s
     response.elements.each("geonames/countrySubdivision") do |geoname|
       name = geoname.get_text("adminName1").to_s
       country = geoname.get_text("countryName").to_s

-      results.push({:prefix => "#{name}, #{country}"})
+      @results.push({:prefix => "#{name}, #{country}"})

     end
 
     end
 

-    return { :type => "Location", :source => "GeoNames", :url => "http://www.geonames.org/", :results => results }
+    render :action => "results"

   rescue Exception => ex
   rescue Exception => ex

-    return { :type => "Location", :source => "GeoNames", :url => "http://www.geonames.org/", :error => "Error contacting ws.geonames.org: #{ex.to_s}" }
+    @error = "Error contacting ws.geonames.org: #{ex.to_s}"
+    render :action => "error"

   end
 
   end
 

+private
+

   def fetch_text(url)
     return Net::HTTP.get(URI.parse(url))
   end
   def fetch_text(url)
     return Net::HTTP.get(URI.parse(url))
   end


@@ -261,19 +326,18 @@ private
   end
 
   def format_distance(distance)
   end
 
   def format_distance(distance)

-    return "less than 1km" if distance == 0
-    return "about #{distance}km"
+    return t("geocoder.distance", :count => distance)

   end
 
   def format_direction(bearing)
   end
 
   def format_direction(bearing)

-    return "south-west" if bearing >= 22.5 and bearing < 67.5
-    return "south" if bearing >= 67.5 and bearing < 112.5
-    return "south-east" if bearing >= 112.5 and bearing < 157.5
-    return "east" if bearing >= 157.5 and bearing < 202.5
-    return "north-east" if bearing >= 202.5 and bearing < 247.5
-    return "north" if bearing >= 247.5 and bearing < 292.5
-    return "north-west" if bearing >= 292.5 and bearing < 337.5
-    return "west"
+    return t("geocoder.direction.south_west") if bearing >= 22.5 and bearing < 67.5
+    return t("geocoder.direction.south") if bearing >= 67.5 and bearing < 112.5
+    return t("geocoder.direction.south_east") if bearing >= 112.5 and bearing < 157.5
+    return t("geocoder.direction.east") if bearing >= 157.5 and bearing < 202.5
+    return t("geocoder.direction.north_east") if bearing >= 202.5 and bearing < 247.5
+    return t("geocoder.direction.north") if bearing >= 247.5 and bearing < 292.5
+    return t("geocoder.direction.north_west") if bearing >= 292.5 and bearing < 337.5
+    return t("geocoder.direction.west")

   end
 
   def format_name(name)
   end
 
   def format_name(name)