Notes: show first comment as marker tooltip

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

diff --git a/app/controllers/geocoder_controller.rb b/app/controllers/geocoder_controller.rb
index 480dc5419b2b5cf9c4e17c0f5eb6c55408eb74df..b6fb455eee3b6631e39f0be605ee3fe7fc2c6ccf 100644 (file)
--- a/app/controllers/geocoder_controller.rb
+++ b/app/controllers/geocoder_controller.rb
@@ -1,118 +1,214 @@
+# coding: utf-8
+

 class GeocoderController < ApplicationController
 class GeocoderController < ApplicationController

-  require 'uri'
-  require 'net/http'
-  require 'rexml/document'
+  require "cgi"
+  require "uri"
+  require "rexml/document"
+
+  before_action :authorize_web
+  before_action :set_locale
+  before_action :require_oauth, :only => [:search]

 
   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]) [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" if defined?(GEONAMES_USERNAME)
+    elsif params[:query]
+      if 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
+        @sources.push "osm_nominatim"
+        @sources.push "geonames" if defined?(GEONAMES_USERNAME)
+      end
+    end
+
+    if @sources.empty?
+      render :text => "", :status => :bad_request

     else
     else

-      @results.push search_osm_namefinder(@query)
-      @results.push search_geonames(@query)
+      render :layout => map_layout

     end
   end
 
     end
   end
 

-private
+  def search_latlon
+    lat = params[:lat].to_f
+    lon = params[:lon].to_f
+    if lat < -90 || lat > 90
+      @error = "Latitude #{lat} out of range"
+      render :action => "error"
+    elsif lon < -180 || lon > 180
+      @error = "Longitude #{lon} out of range"
+      render :action => "error"
+    else
+      @results = [{ :lat => lat, :lon => lon,
+                    :zoom => params[:zoom],
+                    :name => "#{lat}, #{lon}" }]
+
+      render :action => "results"
+    end
+  end

 
 

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

 
     # ask geocoder.us (they have a non-commercial use api)
 
     # ask geocoder.us (they have a non-commercial use api)

-    response = fetch_text("http://rpc.geocoder.us/service/csv?zip=#{URI.escape(query)}")
+    response = fetch_text("http://rpc.geocoder.us/service/csv?zip=#{escape_query(query)}")

 
     # 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 => 12,
-                    :description => "#{data[2]}, #{data[3]}, #{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 }
-  rescue Exception => ex
-    return { :source => "Geocoder.us", :url => "http://geocoder.us/", :error => "Error contacting rpc.geocoder.us: #{ex.to_s}" }
+    render :action => "results"
+  rescue StandardError => ex
+    @error = "Error contacting rpc.geocoder.us: #{ex}"
+    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 = []

 
     # ask npemap.org.uk to do a combined npemap + freethepostcode search
 
     # 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=#{URI.escape(query)}")
+    response = fetch_text("http://www.npemap.org.uk/cgi/geocoder.fcgi?format=text&postcode=#{escape_query(query)}")

 
     # parse the response
     unless response.match(/Error/)
       dataline = response.split(/\n/)[1]
       data = dataline.split(/,/) # easting,northing,postcode,lat,long
 
     # parse the response
     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,
-                    :description => data[2].gsub(/'/, "")})
+      postcode = data[2].delete("'")
+      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 }
-  rescue Exception => ex
-    return { :source => "NPEMap / FreeThePostcode", :url => "http://www.npemap.org.uk/", :error => "Error contacting www.npemap.org.uk: #{ex.to_s}" }
+    render :action => "results"
+  rescue StandardError => ex
+    @error = "Error contacting www.npemap.org.uk: #{ex}"
+    render :action => "error"

   end
 
   end
 

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

 
     # ask geocoder.ca (note - they have a per-day limit)
 
     # ask geocoder.ca (note - they have a per-day limit)

-    response = fetch_xml("http://geocoder.ca/?geoit=XML&postal=#{URI.escape(query)}")
+    response = fetch_xml("http://geocoder.ca/?geoit=XML&postal=#{escape_query(query)}")

 
     # parse the response
 
     # parse the response

-    unless response.get_elements("geodata/error")
-      results.push({:lat => response.get_text("geodata/latt").to_s,
+    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,
                     :lon => response.get_text("geodata/longt").to_s,

-                    :zoom => 12,
-                    :description => query.upcase})
+                    :zoom => POSTCODE_ZOOM,
+                    :name => query.upcase)

     end
 
     end
 

-    return { :source => "Geocoder.CA", :url => "http://geocoder.ca/", :results => results }
-  rescue Exception => ex
-    return { :source => "Geocoder.CA", :url => "http://geocoder.ca/", :error => "Error contacting geocoder.ca: #{ex.to_s}" }
+    render :action => "results"
+  rescue StandardError => ex
+    @error = "Error contacting geocoder.ca: #{ex}"
+    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
+
+    # get objects to excude
+    exclude = "&exclude_place_ids=#{params[:exclude]}" if params[:exclude]
+
+    # ask nominatim
+    response = fetch_xml("http:#{NOMINATIM_URL}search?format=xml&q=#{escape_query(query)}#{viewbox}#{exclude}&accept-language=#{http_accept_language.user_preferred_languages.join(',')}")
+
+    # extract the results from the response
+    results =  response.elements["searchresults"]
+
+    # extract parameters from more_url
+    more_url_params = CGI.parse(URI.parse(results.attributes["more_url"]).query)

 
 

-    # ask OSM namefinder
-    response = fetch_xml("http://www.frankieandshadow.com/osm/search.xml?find=#{URI.escape(query)}")
+    # create result array
+    @results = []
+
+    # create parameter hash for "more results" link
+    @more_params = params.merge(:exclude => more_url_params["exclude_place_ids"].first)

 
     # 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
-      if place
-        distance = format_distance(place.attributes["approxdistance"].to_i)
-        direction = format_direction(place.attributes["direction"].to_i)
-        placename = place.attributes["name"].to_s
-        results.push({:lat => lat, :lon => lon, :zoom => zoom,
-                      :description => "#{type} #{name}, #{distance} #{direction} of #{placename}"})
+    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
       else

-        results.push({:lat => lat, :lon => lon, :zoom => zoom,
-                      :description => "#{type} #{name}"})
+        prefix_name = t "geocoder.search_osm_nominatim.prefix.#{klass}.#{type}", :default => type.tr("_", " ").capitalize
+      end
+      if klass == "boundary" && 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
       end

+      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)

     end
 
     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 StandardError => ex
+    @error = "Error contacting nominatim.openstreetmap.org: #{ex}"
+    render :action => "error"

   end
 
   end
 

-  def search_geonames(query)
-    results = Array.new
+  def search_geonames
+    # get query parameters
+    query = params[:query]
+
+    # get preferred language
+    lang = I18n.locale.to_s.split("-").first
+
+    # create result array
+    @results = []

 
     # ask geonames.org
 
     # ask geonames.org

-    response = fetch_xml("http://ws.geonames.org/search?q=#{URI.escape(query)}&maxRows=20")
+    response = fetch_xml("http://api.geonames.org/search?q=#{escape_query(query)}&lang=#{lang}&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|


@@ -120,36 +216,159 @@ 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 => 12,
-                    :description => "#{name}, #{country}"})
+      @results.push(:lat => lat, :lon => lon,
+                    :zoom => GEONAMES_ZOOM,
+                    :name => name,
+                    :suffix => ", #{country}")
+    end
+
+    render :action => "results"
+  rescue StandardError => ex
+    @error = "Error contacting api.geonames.org: #{ex}"
+    render :action => "error"
+  end
+
+  def search_osm_nominatim_reverse
+    # get query parameters
+    lat = params[:lat]
+    lon = params[:lon]
+    zoom = params[:zoom]
+
+    # create result array
+    @results = []
+
+    # ask nominatim
+    response = fetch_xml("http:#{NOMINATIM_URL}reverse?lat=#{lat}&lon=#{lon}&zoom=#{zoom}&accept-language=#{http_accept_language.user_preferred_languages.join(',')}")
+
+    # parse the response
+    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 StandardError => ex
+    @error = "Error contacting nominatim.openstreetmap.org: #{ex}"
+    render :action => "error"
+  end
+
+  def search_geonames_reverse
+    # get query parameters
+    lat = params[:lat]
+    lon = params[:lon]
+
+    # get preferred language
+    lang = I18n.locale.to_s.split("-").first
+
+    # create result array
+    @results = []
+
+    # ask geonames.org
+    response = fetch_xml("http://api.geonames.org/countrySubdivision?lat=#{lat}&lng=#{lon}&lang=#{lang}&username=#{GEONAMES_USERNAME}")
+
+    # parse the response
+    response.elements.each("geonames/countrySubdivision") do |geoname|
+      name = geoname.get_text("adminName1").to_s
+      country = geoname.get_text("countryName").to_s
+      @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 }
-  rescue Exception => ex
-    return { :source => "GeoNames", :url => "http://www.geonames.org/", :error => "Error contacting ws.geonames.org: #{ex.to_s}" }
+    render :action => "results"
+  rescue StandardError => ex
+    @error = "Error contacting api.geonames.org: #{ex}"
+    render :action => "error"

   end
 
   end
 

+  private
+

   def fetch_text(url)
   def fetch_text(url)

-    return Net::HTTP.get(URI.parse(url))
+    response = OSM.http_client.get(URI.parse(url))
+
+    if response.success?
+      response.body
+    else
+      fail response.status.to_s
+    end

   end
 
   def fetch_xml(url)
   end
 
   def fetch_xml(url)

-    return REXML::Document.new(fetch_text(url))
+    REXML::Document.new(fetch_text(url))
+  end
+
+  def escape_query(query)
+    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
 
   end
 

-  def format_distance(distance)
-    return "less than 1km" if distance == 0
-    return "about #{distance}km"
+  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
 
   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"
+  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
   end
 end