Merge branch 'master' into openstreetbugs

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

diff --git a/app/controllers/geocoder_controller.rb b/app/controllers/geocoder_controller.rb
index f4c7f852ae9fdcdde2c6a77642841900ebca3f48..ced95dce630eaac99a99d0b366846a5706fed850 100644 (file)
--- a/app/controllers/geocoder_controller.rb
+++ b/app/controllers/geocoder_controller.rb
@@ -3,87 +3,68 @@ class GeocoderController < ApplicationController
   require 'net/http'
   require 'rexml/document'
 
   require 'net/http'
   require 'rexml/document'
 

+  before_filter :authorize_web

   before_filter :set_locale
 
   def search
   before_filter :set_locale
 
   def search

-    query = params[:query]
-    results = Array.new
-
-    query.sub(/^\s+/, "")
-    query.sub(/\s+$/, "")
-
-    if query.match(/^[+-]?\d+(\.\d*)?\s*[\s,]\s*[+-]?\d+(\.\d*)?$/)
-      results.push search_latlon(query)
-    elsif 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"
+      @sources.push "osm_nominatim"
+    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_nominatim"
+    elsif @query.match(/^[A-Z]\d[A-Z]\s*\d[A-Z]\d$/i)
+      @sources.push "ca_postcode"
+      @sources.push "osm_nominatim"

     else
     else

-      results.push search_osm_namefinder(query)
-      results.push search_geonames(query)
-    end
-
-    results_count = count_results(results)
-
-    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].to_f, position[:lon].to_f, position[:zoom].to_i
-      else
-        page.call "openSidebar"
-      end
-    end
-  end
-  
-  def description
-    results = Array.new
-
-    lat = params[:lat]
-    lon = params[:lon]
-
-    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)
-
-    render :update do |page|
-      page.replace_html :sidebar_content, :partial => 'results', :object => results
-      page.call "openSidebar"
+      @sources.push "osm_nominatim"
+      @sources.push "geonames" if defined?(GEONAMES_USERNAME)

     end
   end
 
     end
   end
 

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

 
 

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

 
     # decode the location
 
     # decode the location

-    if m = query.match(/^([+-]?\d+(\.\d*)?)\s*[\s,]\s*([+-]?\d+(\.\d*)?)$/)
+    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
       lat = m[1].to_f
       lon = m[3].to_f
     end
 
     # generate results
     if lat < -90 or lat > 90

-      return { :source => "Internal", :url => "http://openstreetmap.org/", :error => "Latitude #{lat} out of range" }
+      @error = "Latitude #{lat} out of range"
+      render :action => "error"

     elsif lon < -180 or lon > 180
     elsif lon < -180 or lon > 180

-      return { :source => "Internal", :url => "http://openstreetmap.org/", :error => "Longitude #{lon} out of range" }
+      @error = "Longitude #{lon} out of range"
+      render :action => "error"

     else
     else

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

 
 

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

     end
   end
 
     end
   end
 

-  def search_us_postcode(query)
-    results = Array.new
+  def search_us_postcode
+    # get query parameters
+    query = params[:query]
+
+    # 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)}")


@@ -91,19 +72,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 => APP_CONFIG['postcode_zoom'],
-                    :prefix => "#{data[2]}, #{data[3]}, ",
-                    :name => data[4]})
+      @results.push({:lat => data[0], :lon => data[1],
+                     :zoom => 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)}")


@@ -113,113 +99,102 @@ 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 = APP_CONFIG['postcode_zoom'] - postcode.count("#")
-      results.push({:lat => data[3], :lon => data[4], :zoom => zoom,
-                    :name => postcode})
+      zoom = 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
     if response.get_elements("geodata/error").empty?
 
     # 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
     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})
+      @results.push({:lat => response.get_text("geodata/latt").to_s,
+                     :lon => response.get_text("geodata/longt").to_s,
+                     :zoom => 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_nominatim
+    # get query parameters
+    query = params[:query]
+    minlon = params[:minlon]
+    minlat = params[:minlat]
+    maxlon = params[:maxlon]
+    maxlat = params[:maxlat]
+
+    # get view box
+    if minlon && minlat && maxlon && maxlat
+      viewbox = "&viewbox=#{minlon},#{maxlat},#{maxlon},#{minlat}"
+    end

 
 

-    # ask OSM namefinder
-    response = fetch_xml("http://gazetteer.openstreetmap.org/namefinder/search.xml?find=#{escape_query(query)}")
+    # get objects to excude
+    if params[:exclude]
+      exclude = "&exclude_place_ids=#{params[:exclude].join(',')}"
+    end
+
+    # ask nominatim
+    response = fetch_xml("#{NOMINATIM_URL}search?format=xml&q=#{escape_query(query)}#{viewbox}#{exclude}&accept-language=#{request.user_preferred_languages.join(',')}")
+
+    # create result array
+    @results = Array.new
+
+    # create parameter hash for "more results" link
+    @more_params = params.reverse_merge({ :exclude => [] })
+
+    # extract the results from the response
+    results =  response.elements["searchresults"]

 
     # parse the response
 
     # parse the response

-    response.elements.each("searchresults/named") do |named|
-      lat = named.attributes["lat"].to_s
-      lon = named.attributes["lon"].to_s
-      zoom = named.attributes["zoom"].to_s
-      place = named.elements["place/named"] || named.elements["nearestplaces/named"]
-      type = named.attributes["info"].to_s.capitalize
-      name = named.attributes["name"].to_s
-      description = named.elements["description"].to_s
-
-      if name.empty?
-        prefix = ""
-        name = type
-      else
-        prefix =  t "geocoder.results.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)
-        suffix = t "geocoder.results.namefinder.suffix_place", :distance => distance, :direction => direction, :placename => placename
-
-        if place.attributes["rank"].to_i <= 30
-          parent = nil
-          parentrank = 0
-          parentscore = 0
-
-          place.elements.each("nearestplaces/named") do |nearest|
-            nearestrank = nearest.attributes["rank"].to_i
-            nearestscore = nearestrank / nearest.attributes["distance"].to_f
-
-            if nearestrank > 30 and
-               ( nearestscore > parentscore or
-                 ( nearestscore == parentscore and nearestrank > parentrank ) )
-              parent = nearest
-              parentrank = nearestrank
-              parentscore = nearestscore
-            end
-          end
-
-          if parent
-            parentname = format_name(parent.attributes["name"].to_s)
-
-            if  place.attributes["info"].to_s == "suburb"
-              suffix = t "geocoder.results.namefinder.suffix_suburb", :suffix => suffix, :parentname => parentname
-            else
-              parentdistance = format_distance(parent.attributes["approxdistance"].to_i)
-              parentdirection = format_direction(parent.attributes["direction"].to_i)
-              suffix = t "geocoder.results.namefinder.suffix_parent", :suffix => suffix, :parentdistance => parentdistance, :parentdirection => parentdirection, :parentname => parentname
-            end
-          end
-        end
-      else
-        suffix = ""
-      end
-
-      results.push({:lat => lat, :lon => lon, :zoom => zoom,
-                    :prefix => prefix, :name => name, :suffix => suffix,
-                    :description => description})
+    results.elements.each("place") do |place|
+      lat = place.attributes["lat"].to_s
+      lon = place.attributes["lon"].to_s
+      klass = place.attributes["class"].to_s
+      type = place.attributes["type"].to_s
+      name = place.attributes["display_name"].to_s
+      min_lat,max_lat,min_lon,max_lon = place.attributes["boundingbox"].to_s.split(",")
+      prefix_name = t "geocoder.search_osm_nominatim.prefix.#{klass}.#{type}", :default => type.gsub("_", " ").capitalize
+      prefix = t "geocoder.search_osm_nominatim.prefix_format", :name => prefix_name
+
+      @results.push({:lat => lat, :lon => lon,
+                     :min_lat => min_lat, :max_lat => max_lat,
+                     :min_lon => min_lon, :max_lon => max_lon,
+                     :prefix => prefix, :name => name})
+      @more_params[:exclude].push(place.attributes["place_id"].to_s)

     end
 
     end
 

-    return { :source => "OpenStreetMap Namefinder", :url => "http://gazetteer.openstreetmap.org/namefinder/", :results => results }
-  rescue Exception => ex
-    return { :source => "OpenStreetMap Namefinder", :url => "http://gazetteer.openstreetmap.org/namefinder/", :error => "Error contacting gazetteer.openstreetmap.org: #{ex.to_s}" }
+    render :action => "results"
+#  rescue Exception => ex
+#    @error = "Error contacting nominatim.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
 
     # ask geonames.org

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

 
     # parse the response
     response.elements.each("geonames/geoname") do |geoname|
 
     # parse the response
     response.elements.each("geonames/geoname") do |geoname|


@@ -227,47 +202,57 @@ 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 => APP_CONFIG['geonames_zoom'],
-                    :name => name,
-                    :suffix => ", #{country}"})
+      @results.push({:lat => lat, :lon => lon,
+                     :zoom => 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_osm_namefinder(types, lat, lon, max)
-    results = Array.new
+  def description
+    @sources = Array.new

 
 

-    # ask OSM namefinder
-    response = fetch_xml("http://gazetteer.openstreetmap.org/namefinder/search.xml?find=#{types}+near+#{lat},#{lon}&max=#{max}")
+    @sources.push({ :name => "osm_nominatim" })
+    @sources.push({ :name => "geonames" })
+  end
+
+  def description_osm_nominatim
+    # get query parameters
+    lat = params[:lat]
+    lon = params[:lon]
+    zoom = params[:zoom]
+
+    # create result array
+    @results = Array.new
+
+    # ask nominatim
+    response = fetch_xml("#{NOMINATIM_URL}reverse?lat=#{lat}&lon=#{lon}&zoom=#{zoom}&accept-language=#{request.user_preferred_languages.join(',')}")

 
     # parse the response
 
     # parse the response

-    response.elements.each("searchresults/named") do |named|
-      lat = named.attributes["lat"].to_s
-      lon = named.attributes["lon"].to_s
-      zoom = named.attributes["zoom"].to_s
-      place = named.elements["place/named"] || named.elements["nearestplaces/named"]
-      type = named.attributes["info"].to_s
-      name = named.attributes["name"].to_s
-      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})
+    response.elements.each("reversegeocode/result") do |result|
+      description = result.get_text.to_s
+
+      @results.push({:prefix => "#{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 nominatim.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}")


@@ -276,14 +261,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


@@ -293,19 +281,18 @@ private
   end
 
   def format_distance(distance)
   end
 
   def format_distance(distance)

-    return t "geocoder.results.distance.less_than_1km" if distance == 0
-    return t "geocoder.results.distance.about_distance_km", :distance => distance
+    return t("geocoder.distance", :count => distance)

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

-    return t "geocoder.results.direction.south_west" if bearing >= 22.5 and bearing < 67.5
-    return t "geocoder.results.direction.south" if bearing >= 67.5 and bearing < 112.5
-    return t "geocoder.results.direction.south_east" if bearing >= 112.5 and bearing < 157.5
-    return t "geocoder.results.direction.east" if bearing >= 157.5 and bearing < 202.5
-    return t "geocoder.results.direction.north_east" if bearing >= 202.5 and bearing < 247.5
-    return t "geocoder.results.direction.north" if bearing >= 247.5 and bearing < 292.5
-    return t "geocoder.results.direction.north_west" if bearing >= 292.5 and bearing < 337.5
-    return t "geocoder.results.direction.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)