]> git.openstreetmap.org Git - rails.git/blobdiff - app/controllers/geocoder_controller.rb
Improve zoom level selection when invoking Potlatch on an object
[rails.git] / app / controllers / geocoder_controller.rb
index 489d89b58b5422059aca844cc68cd1f1d6bef7b3..692ae24ddb2e892d89bbc50e663a9af668e96b67 100644 (file)
@@ -1,58 +1,63 @@
+# coding: utf-8
+
 class GeocoderController < ApplicationController
   require 'uri'
   require 'net/http'
   require 'rexml/document'
 
+  before_filter :authorize_web
+  before_filter :set_locale
+  before_filter :require_oauth, :only => [: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)
-    elsif query.match(/[A-Z]\d[A-Z]\s*\d[A-Z]\d/i)
-      results.push search_ca_postcode(query)
+    normalize_params
+
+    @sources = []
+    if params[:lat] && params[:lon]
+      @sources.push "latlon"
+      @sources.push "osm_nominatim_reverse"
+      @sources.push "geonames_reverse"
+    elsif params[:query].match(/^\d{5}(-\d{4})?$/)
+      @sources.push "us_postcode"
+      @sources.push "osm_nominatim"
+    elsif params[: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 params[:query].match(/^[A-Z]\d[A-Z]\s*\d[A-Z]\d$/i)
+      @sources.push "ca_postcode"
+      @sources.push "osm_nominatim"
     else
-      results.push search_osm_namefinder(query)
-      results.push search_geonames(query)
+      @sources.push "osm_nominatim"
+      @sources.push "geonames" if defined?(GEONAMES_USERNAME)
     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], position[:lon], position[:zoom]
-      else
-        page.call "openSidebar"
-      end
-    end
+    render :layout => map_layout
   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)
+  def search_latlon
+    lat = params[:lat].to_f
+    lon = params[:lon].to_f
+    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 = [{:lat => lat, :lon => lon,
+                   :zoom => params[:zoom],
+                   :name => "#{lat}, #{lon}"}]
 
-    render :update do |page|
-      page.replace_html :sidebar_content, :partial => 'results', :object => results
-      page.call "openSidebar"
+      render :action => "results"
     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)}")
@@ -60,18 +65,24 @@ private
     # 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 => 12,
-                    :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
 
-    return { :source => "Geocoder.us", :url => "http://geocoder.us/", :results => results }
+    render :action => "results"
   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
 
-  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)}")
@@ -80,78 +91,114 @@ private
     unless response.match(/Error/)
       dataline = response.split(/\n/)[1]
       data = dataline.split(/,/) # easting,northing,postcode,lat,long
-      results.push({:lat => data[3], :lon => data[4], :zoom => 12,
-                    :name => data[2].gsub(/'/, "")})
+      postcode = data[2].gsub(/'/, "")
+      zoom = POSTCODE_ZOOM - postcode.count("#")
+      @results.push({:lat => data[3], :lon => data[4], :zoom => zoom,
+                     :name => postcode})
     end
 
-    return { :source => "NPEMap / FreeThePostcode", :url => "http://www.npemap.org.uk/", :results => results }
+    render :action => "results"
   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
 
-  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
-    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 => 12,
-                    :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 => POSTCODE_ZOOM,
+                     :name => query.upcase})
     end
 
-    return { :source => "Geocoder.CA", :url => "http://geocoder.ca/", :results => results }
+    render :action => "results"
   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
 
-  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
+
+    # 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=#{http_accept_language.user_preferred_languages.join(',')}")
+
+    # create result array
+    @results = Array.new
 
-    # ask OSM namefinder
-    response = fetch_xml("http://www.frankieandshadow.com/osm/search.xml?find=#{escape_query(query)}")
+    # 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
-    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
+    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(",")
+      if type.empty?
+        prefix_name = ""
       else
-        prefix = "#{type} "
+        prefix_name = t "geocoder.search_osm_nominatim.prefix.#{klass}.#{type}", :default => type.gsub("_", " ").capitalize
       end
-      if place
-        distance = format_distance(place.attributes["approxdistance"].to_i)
-        direction = format_direction(place.attributes["direction"].to_i)
-        placename = place.attributes["name"].to_s
-        suffix = ", #{distance} #{direction} of #{placename}"
-      else
-        suffix = ""
+      if klass == 'boundary' and type == 'administrative'
+        rank = (place.attributes["place_rank"].to_i + 1) / 2
+        prefix_name = t "geocoder.search_osm_nominatim.admin_levels.level#{rank}", :default => prefix_name
       end
-      results.push({:lat => lat, :lon => lon, :zoom => zoom,
-                    :prefix => prefix, :name => name, :suffix => suffix,
-                    :description => description})
+      prefix = t "geocoder.search_osm_nominatim.prefix_format", :name => prefix_name
+      object_type = place.attributes["osm_type"]
+      object_id = place.attributes["osm_id"]
+
+      @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,
+                     :type => object_type, :id => object_id})
+      @more_params[:exclude].push(place.attributes["place_id"].to_s)
     end
 
-    return { :source => "OpenStreetMap Namefinder", :url => "http://www.frankieandshadow.com/osm/", :results => results }
-  rescue Exception => ex
-    return { :source => "OpenStreetMap Namefinder", :url => "http://www.frankieandshadow.com/osm/", :error => "Error contacting www.frankieandshadow.com: #{ex.to_s}" }
+    render :action => "results"
+#  rescue Exception => ex
+#    @error = "Error contacting nominatim.openstreetmap.org: #{ex.to_s}"
+#    render :action => "error"
   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")
+    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|
@@ -159,46 +206,57 @@ private
       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 => 12,
-                    :name => name,
-                    :suffix => ", #{country}"})
+      @results.push({:lat => lat, :lon => lon,
+                     :zoom => GEONAMES_ZOOM,
+                     :name => name,
+                     :suffix => ", #{country}"})
     end
 
-    return { :source => "GeoNames", :url => "http://www.geonames.org/", :results => results }
+    render :action => "results"
   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
 
-  def description_osm_namefinder(types, lat, lon, max)
-    results = Array.new
+  def search_osm_nominatim_reverse
+    # get query parameters
+    lat = params[:lat]
+    lon = params[:lon]
+    zoom = params[:zoom]
 
-    # ask OSM namefinder
-    response = fetch_xml("http://www.frankieandshadow.com/osm/search.xml?find=#{types}+near+#{lat},#{lon}&max=#{max}")
+    # create result array
+    @results = Array.new
+
+    # ask nominatim
+    response = fetch_xml("#{NOMINATIM_URL}reverse?lat=#{lat}&lon=#{lon}&zoom=#{zoom}&accept-language=#{http_accept_language.user_preferred_languages.join(',')}")
 
     # 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})
-    end
-
-    return { :type => types.capitalize, :source => "OpenStreetMap Namefinder", :url => "http://www.frankieandshadow.com/osm/", :results => results }
+    response.elements.each("reversegeocode/result") do |result|
+      lat = result.attributes["lat"].to_s
+      lon = result.attributes["lon"].to_s
+      object_type = result.attributes["osm_type"]
+      object_id = result.attributes["osm_id"]
+      description = result.get_text.to_s
+
+      @results.push({:lat => lat, :lon => lon,
+                     :zoom => zoom,
+                     :name => description,
+                     :type => object_type, :id => object_id})
+    end
+
+    render :action => "results"
   rescue Exception => ex
-    return { :type => types.capitalize, :source => "OpenStreetMap Namefinder", :url => "http://www.frankieandshadow.com/osm/", :error => "Error contacting www.frankieandshadow.com: #{ex.to_s}" }
+    @error = "Error contacting nominatim.openstreetmap.org: #{ex.to_s}"
+    render :action => "error"
   end
 
-  def description_geonames(lat, lon)
-    results = Array.new
+  def search_geonames_reverse
+    # 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}")
@@ -207,14 +265,20 @@ private
     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({:lat => lat, :lon => lon,
+                     :zoom => GEONAMES_ZOOM,
+                     :name => name,
+                     :suffix => ", #{country}"})
     end
 
-    return { :type => "Location", :source => "GeoNames", :url => "http://www.geonames.org/", :results => results }
+    render :action => "results"
   rescue Exception => ex
-    return { :type => types.capitalize, :source => "OpenStreetMap Namefinder", :url => "http://www.frankieandshadow.com/osm/", :error => "Error contacting www.frankieandshadow.com: #{ex.to_s}" }
+    @error = "Error contacting ws.geonames.org: #{ex.to_s}"
+    render :action => "error"
   end
 
+private
+
   def fetch_text(url)
     return Net::HTTP.get(URI.parse(url))
   end
@@ -224,19 +288,22 @@ private
   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)
-    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)
+    return name.gsub(/( *\[[^\]]*\])*$/, "")
   end
 
   def count_results(results)
@@ -252,4 +319,67 @@ private
   def escape_query(query)
     return URI.escape(query, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]", false, 'N'))
   end
+
+  def normalize_params
+    query = params[:query]
+    return unless query
+
+    query.strip!
+
+    if latlon = query.match(/^([NS])\s*(\d{1,3}(\.\d*)?)\W*([EW])\s*(\d{1,3}(\.\d*)?)$/).try(:captures) # [NSEW] decimal degrees
+      params.merge!(nsew_to_decdeg(latlon)).delete(:query)
+    elsif latlon = query.match(/^(\d{1,3}(\.\d*)?)\s*([NS])\W*(\d{1,3}(\.\d*)?)\s*([EW])$/).try(:captures) # decimal degrees [NSEW]
+      params.merge!(nsew_to_decdeg(latlon)).delete(:query)
+
+    elsif latlon = query.match(/^([NS])\s*(\d{1,3})°?\s*(\d{1,3}(\.\d*)?)?['′]?\W*([EW])\s*(\d{1,3})°?\s*(\d{1,3}(\.\d*)?)?['′]?$/).try(:captures) # [NSEW] degrees, decimal minutes
+      params.merge!(ddm_to_decdeg(latlon)).delete(:query)
+    elsif latlon = query.match(/^(\d{1,3})°?\s*(\d{1,3}(\.\d*)?)?['′]?\s*([NS])\W*(\d{1,3})°?\s*(\d{1,3}(\.\d*)?)?['′]?\s*([EW])$/).try(:captures) # degrees, decimal minutes [NSEW]
+      params.merge!(ddm_to_decdeg(latlon)).delete(:query)
+
+    elsif latlon = query.match(/^([NS])\s*(\d{1,3})°?\s*(\d{1,2})['′]?\s*(\d{1,3}(\.\d*)?)?["″]?\W*([EW])\s*(\d{1,3})°?\s*(\d{1,2})['′]?\s*(\d{1,3}(\.\d*)?)?["″]?$/).try(:captures) # [NSEW] degrees, minutes, decimal seconds
+      params.merge!(dms_to_decdeg(latlon)).delete(:query)
+    elsif latlon = query.match(/^(\d{1,3})°?\s*(\d{1,2})['′]?\s*(\d{1,3}(\.\d*)?)?["″]\s*([NS])\W*(\d{1,3})°?\s*(\d{1,2})['′]?\s*(\d{1,3}(\.\d*)?)?["″]?\s*([EW])$/).try(:captures) # degrees, minutes, decimal seconds [NSEW]
+      params.merge!(dms_to_decdeg(latlon)).delete(:query)
+
+    elsif latlon = query.match(/^\s*([+-]?\d+(\.\d*)?)\s*[\s,]\s*([+-]?\d+(\.\d*)?)\s*$/)
+      params.merge!({:lat => latlon[1].to_f, :lon => latlon[3].to_f}).delete(:query)
+    end
+  end
+
+  def nsew_to_decdeg(captures)
+    begin
+      Float(captures[0])
+      captures[2].downcase != 's' ? lat = captures[0].to_f : lat = -(captures[0].to_f)
+      captures[5].downcase != 'w' ? lon = captures[3].to_f : lon = -(captures[3].to_f)
+    rescue
+      captures[0].downcase != 's' ? lat = captures[1].to_f : lat = -(captures[1].to_f)
+      captures[3].downcase != 'w' ? lon = captures[4].to_f : lon = -(captures[4].to_f)
+    end
+    {:lat => lat, :lon => lon}
+  end
+
+  def ddm_to_decdeg(captures)
+    begin
+      Float(captures[0])
+      captures[3].downcase != 's' ? lat = captures[0].to_f + captures[1].to_f/60 : lat = -(captures[0].to_f + captures[1].to_f/60)
+      captures[7].downcase != 'w' ? lon = captures[4].to_f + captures[5].to_f/60 : lon = -(captures[4].to_f + captures[5].to_f/60)
+    rescue
+      captures[0].downcase != 's' ? lat = captures[1].to_f + captures[2].to_f/60 : lat = -(captures[1].to_f + captures[2].to_f/60)
+      captures[4].downcase != 'w' ? lon = captures[5].to_f + captures[6].to_f/60 : lon = -(captures[5].to_f + captures[6].to_f/60)
+    end
+    {:lat => lat, :lon => lon}
+  end
+
+  def dms_to_decdeg(captures)
+    begin
+      Float(captures[0])
+      captures[4].downcase != 's' ? lat = captures[0].to_f + (captures[1].to_f + captures[2].to_f/60)/60 : lat = -(captures[0].to_f + (captures[1].to_f + captures[2].to_f/60)/60)
+      captures[9].downcase != 'w' ? lon = captures[5].to_f + (captures[6].to_f + captures[7].to_f/60)/60 : lon = -(captures[5].to_f + (captures[6].to_f + captures[7].to_f/60)/60)
+    rescue
+      captures[0].downcase != 's' ? lat = captures[1].to_f + (captures[2].to_f + captures[3].to_f/60)/60 : lat = -(captures[1].to_f + (captures[2].to_f + captures[3].to_f/60)/60)
+      captures[5].downcase != 'w' ? lon = captures[6].to_f + (captures[7].to_f + captures[8].to_f/60)/60 : lon = -(captures[6].to_f + (captures[7].to_f + captures[8].to_f/60)/60)
+    end
+    {:lat => lat, :lon => lon}
+  end
+
 end