Merge branch 'pull/5338'

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

diff --git a/app/controllers/geocoder_controller.rb b/app/controllers/geocoder_controller.rb
index 8195b0d473c511bb7a9d6de108d2283bcff99a18..43f276efa020a35cfdbb1719155c4a3f5e61c1fe 100644 (file)
--- a/app/controllers/geocoder_controller.rb
+++ b/app/controllers/geocoder_controller.rb
@@ -1,360 +1,247 @@
 class GeocoderController < ApplicationController
 class GeocoderController < ApplicationController

-  require 'uri'
-  require 'net/http'
-  require 'rexml/document'
+  require "cgi"
+  require "uri"
+  require "rexml/document"

 
 

-  before_filter :authorize_web
-  before_filter :set_locale
+  before_action :authorize_web
+  before_action :set_locale
+  before_action :require_oauth, :only => [:search]
+  authorize_resource :class => false

 
   def search
 
   def search

-    @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
-      @sources.push "osm_namefinder"
-      @sources.push "geonames"
+    @params = normalize_params
+    @sources = []
+
+    if @params[:lat] && @params[:lon]
+      @sources.push(:name => "latlon", :url => root_path)
+      @sources.push(:name => "osm_nominatim_reverse", :url => nominatim_reverse_url(:format => "html"))
+    elsif @params[:query]
+      @sources.push(:name => "osm_nominatim", :url => nominatim_url(:format => "html"))

     end
 
     end
 

-    render :update do |page|
-      page.replace_html :sidebar_content, :partial => "search"
-      page.call "openSidebar"
+    if @sources.empty?
+      head :bad_request
+    else
+      render :layout => map_layout

     end
   end
 
   def search_latlon
     end
   end
 
   def search_latlon

-    # get query parameters
-    query = params[:query]
+    lat = params[:lat].to_f
+    lon = params[:lon].to_f

 
 

-    # create result array
-    @results = Array.new
+    if params[:latlon_digits]
+      # We've got two nondescript numbers for a query, which can mean both "lat, lon" or "lon, lat".
+      @results = []

 
 

-    # 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
+      if lat >= -90 && lat <= 90 && lon >= -180 && lon <= 180
+        @results.push(:lat => params[:lat], :lon => params[:lon],
+                      :zoom => params[:zoom],
+                      :name => "#{params[:lat]}, #{params[:lon]}")
+      end
+
+      if lon >= -90 && lon <= 90 && lat >= -180 && lat <= 180
+        @results.push(:lat => params[:lon], :lon => params[:lat],
+                      :zoom => params[:zoom],
+                      :name => "#{params[:lon]}, #{params[:lat]}")
+      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"
+      if @results.empty?
+        @error = "Latitude or longitude are out of range"
+        render :action => "error"
+      else
+        render :action => "results"
+      end

     else
     else

-      @results.push({:lat => lat, :lon => lon,
-                     :zoom => APP_CONFIG['postcode_zoom'],
-                     :name => "#{lat}, #{lon}"})
+      # Coordinates in a query have come with markers for latitude and longitude.
+      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 => params[:lat], :lon => params[:lon],
+                      :zoom => params[:zoom],
+                      :name => "#{params[:lat]}, #{params[:lon]}" }]

 
 

-      render :action => "results"
+        render :action => "results"
+      end

     end
   end
 
     end
   end
 

-  def search_us_postcode
-    # get query parameters
-    query = params[:query]
-
-    # create result array
-    @results = Array.new
+  def search_osm_nominatim
+    # ask nominatim
+    response = fetch_xml(nominatim_url(:format => "xml"))

 
 

-    # ask geocoder.us (they have a non-commercial use api)
-    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
-      @results.push({:lat => data[0], :lon => data[1],
-                     :zoom => APP_CONFIG['postcode_zoom'],
-                     :prefix => "#{data[2]}, #{data[3]}, ",
-                     :name => data[4]})
-    end
-
-    render :action => "results"
-  rescue Exception => ex
-    @error = "Error contacting rpc.geocoder.us: #{ex.to_s}"
-    render :action => "error"
-  end
-
-  def search_uk_postcode
-    # get query parameters
-    query = params[:query]
+    # extract the results from the response
+    results = response.elements["searchresults"]

 
     # create result array
 
     # 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)}")
-
-    # parse the response
-    unless response.match(/Error/)
-      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})
-    end
-
-    render :action => "results"
-  rescue Exception => ex
-    @error = "Error contacting www.npemap.org.uk: #{ex.to_s}"
-    render :action => "error"
-  end
-
-  def search_ca_postcode
-    # get query parameters
-    query = params[:query]
-    @results = Array.new
+    @results = []

 
 

-    # ask geocoder.ca (note - they have a per-day limit)
-    response = fetch_xml("http://geocoder.ca/?geoit=XML&postal=#{escape_query(query)}")
+    # create parameter hash for "more results" link
+    @more_params = params
+                   .permit(:query, :minlon, :minlat, :maxlon, :maxlat, :exclude)
+                   .merge(:exclude => results.attributes["exclude_place_ids"])

 
     # parse the response
 
     # 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.elements.each("place") do |place|
+      lat = place.attributes["lat"]
+      lon = place.attributes["lon"]
+      klass = place.attributes["class"]
+      type = place.attributes["type"]
+      name = place.attributes["display_name"]
+      min_lat, max_lat, min_lon, max_lon = place.attributes["boundingbox"].split(",")
+      prefix_name = if type.empty?
+                      ""
+                    else
+                      t "geocoder.search_osm_nominatim.prefix.#{klass}.#{type}", :default => type.tr("_", " ").capitalize
+                    end
+      if klass == "boundary" && type == "administrative"
+        rank = (place.attributes["address_rank"].to_i + 1) / 2
+        prefix_name = t "geocoder.search_osm_nominatim.admin_levels.level#{rank}", :default => prefix_name
+        place.elements["extratags"].elements.each("tag") do |extratag|
+          prefix_name = t "geocoder.search_osm_nominatim.prefix.place.#{extratag.attributes['value']}", :default => prefix_name if extratag.attributes["key"] == "linked_place" || extratag.attributes["key"] == "place"
+        end
+      end
+      prefix = t ".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
 
     render :action => "results"
     end
 
     render :action => "results"

-  rescue Exception => ex
-    @error = "Error contacting geocoder.ca: #{ex.to_s}"
+  rescue StandardError => e
+    host = URI(Settings.nominatim_url).host
+    @error = "Error contacting #{host}: #{e}"

     render :action => "error"
   end
 
     render :action => "error"
   end
 

-  def search_osm_namefinder
+  def search_osm_nominatim_reverse

     # get query parameters
     # get query parameters

-    query = params[:query]
+    zoom = params[:zoom]

 
     # create result array
 
     # create result array

-    @results = Array.new
+    @results = []

 
 

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

 
     # 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.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)
-        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
-          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.search_osm_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.search_osm_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})
+    response.elements.each("reversegeocode/result") do |result|
+      lat = result.attributes["lat"]
+      lon = result.attributes["lon"]
+      object_type = result.attributes["osm_type"]
+      object_id = result.attributes["osm_id"]
+      description = result.text
+
+      @results.push(:lat => lat, :lon => lon,
+                    :zoom => zoom,
+                    :name => description,
+                    :type => object_type, :id => object_id)

     end
 
     render :action => "results"
     end
 
     render :action => "results"

-  rescue Exception => ex
-    @error = "Error contacting gazetteer.openstreetmap.org: #{ex.to_s}"
+  rescue StandardError => e
+    host = URI(Settings.nominatim_url).host
+    @error = "Error contacting #{host}: #{e}"

     render :action => "error"
   end
 
     render :action => "error"
   end
 

-  def search_geonames
+  private
+
+  def nominatim_url(format: nil)

     # get query parameters
     query = params[:query]
     # get query parameters
     query = params[:query]

+    minlon = params[:minlon]
+    minlat = params[:minlat]
+    maxlon = params[:maxlon]
+    maxlat = params[:maxlat]

 
 

-    # create result array
-    @results = Array.new
+    # get view box
+    viewbox = "&viewbox=#{minlon},#{maxlat},#{maxlon},#{minlat}" if minlon && minlat && maxlon && maxlat

 
 

-    # ask geonames.org
-    response = fetch_xml("http://ws.geonames.org/search?q=#{escape_query(query)}&maxRows=20")
+    # get objects to excude
+    exclude = "&exclude_place_ids=#{params[:exclude]}" if params[:exclude]

 
 

-    # parse the response
-    response.elements.each("geonames/geoname") do |geoname|
-      lat = geoname.get_text("lat").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}"})
-    end
-
-    render :action => "results"
-  rescue Exception => ex
-    @error = "Error contacting ws.geonames.org: #{ex.to_s}"
-    render :action => "error"
-  end
-  
-  def description
-    @sources = 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
+    # build url
+    "#{Settings.nominatim_url}search?format=#{format}&extratags=1&q=#{escape_query(query)}#{viewbox}#{exclude}&accept-language=#{http_accept_language.user_preferred_languages.join(',')}"

   end
 
   end
 

-  def description_osm_namefinder
+  def nominatim_reverse_url(format: nil)

     # get query parameters
     lat = params[:lat]
     lon = params[:lon]
     # get query parameters
     lat = params[:lat]
     lon = params[:lon]

-    types = params[:types]
-    max = params[:max]
+    zoom = params[:zoom]

 
 

-    # create result array
-    @results = Array.new
+    # build url
+    "#{Settings.nominatim_url}reverse?format=#{format}&lat=#{lat}&lon=#{lon}&zoom=#{zoom}&accept-language=#{http_accept_language.user_preferred_languages.join(',')}"
+  end

 
 

-    # ask OSM namefinder
-    response = fetch_xml("http://gazetteer.openstreetmap.org/namefinder/search.xml?find=#{types}+near+#{lat},#{lon}&max=#{max}")
+  def fetch_text(url)
+    response = OSM.http_client.get(URI.parse(url))

 
 

-    # 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 = 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})
+    if response.success?
+      response.body
+    else
+      raise response.status.to_s

     end
     end

-
-    render :action => "results"
-  rescue Exception => ex
-    @error = "Error contacting gazetteer.openstreetmap.org: #{ex.to_s}"
-    render :action => "error"

   end
 
   end
 

-  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}")
-
-    # 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({:prefix => "#{name}, #{country}"})
-    end
+  def fetch_xml(url)
+    REXML::Document.new(fetch_text(url))
+  end

 
 

-    render :action => "results"
-  rescue Exception => ex
-    @error = "Error contacting ws.geonames.org: #{ex.to_s}"
-    render :action => "error"
+  def escape_query(query)
+    CGI.escape(query)

   end
 
   end
 

-private
+  def normalize_params
+    if query = params[:query]
+      query.strip!

 
 

-  def fetch_text(url)
-    return Net::HTTP.get(URI.parse(url))
-  end
+      if latlon = query.match(/^(?<ns>[NS])\s*#{dms_regexp('ns')}\W*(?<ew>[EW])\s*#{dms_regexp('ew')}$/) ||
+                  query.match(/^#{dms_regexp('ns')}\s*(?<ns>[NS])\W*#{dms_regexp('ew')}\s*(?<ew>[EW])$/)
+        params.merge!(to_decdeg(latlon.named_captures.compact)).delete(:query)

 
 

-  def fetch_xml(url)
-    return REXML::Document.new(fetch_text(url))
-  end
+      elsif latlon = query.match(%r{^(?<lat>[+-]?\d+(?:\.\d+)?)(?:\s+|\s*[,/]\s*)(?<lon>[+-]?\d+(?:\.\d+)?)$})
+        params.merge!(:lat => latlon["lat"], :lon => latlon["lon"]).delete(:query)

 
 

-  def format_distance(distance)
-    return t("geocoder.distance", :count => distance)
-  end
+        params[:latlon_digits] = true
+      end
+    end

 
 

-  def format_direction(bearing)
-    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")
+    params.permit(:query, :lat, :lon, :latlon_digits, :zoom, :minlat, :minlon, :maxlat, :maxlon)

   end
 
   end
 

-  def format_name(name)
-    return name.gsub(/( *\[[^\]]*\])*$/, "")
+  def dms_regexp(name_prefix)
+    /
+      (?: (?<#{name_prefix}d>\d{1,3}(?:\.\d+)?)°? ) |
+      (?: (?<#{name_prefix}d>\d{1,3})°?\s*(?<#{name_prefix}m>\d{1,2}(?:\.\d+)?)['′]? ) |
+      (?: (?<#{name_prefix}d>\d{1,3})°?\s*(?<#{name_prefix}m>\d{1,2})['′]?\s*(?<#{name_prefix}s>\d{1,2}(?:\.\d+)?)["″]? )
+    /x

   end
 
   end
 

-  def count_results(results)
-    count = 0
+  def to_decdeg(captures)
+    ns = captures.fetch("ns").casecmp?("s") ? -1 : 1
+    nsd = BigDecimal(captures.fetch("nsd", "0"))
+    nsm = BigDecimal(captures.fetch("nsm", "0"))
+    nss = BigDecimal(captures.fetch("nss", "0"))

 
 

-    results.each do |source|
-      count += source[:results].length if source[:results]
-    end
+    ew = captures.fetch("ew").casecmp?("w") ? -1 : 1
+    ewd = BigDecimal(captures.fetch("ewd", "0"))
+    ewm = BigDecimal(captures.fetch("ewm", "0"))
+    ews = BigDecimal(captures.fetch("ews", "0"))

 
 

-    return count
-  end
+    lat = ns * (nsd + (nsm / 60) + (nss / 3600))
+    lon = ew * (ewd + (ewm / 60) + (ews / 3600))

 
 

-  def escape_query(query)
-    return URI.escape(query, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]", false, 'N'))
+    { :lat => lat.round(6).to_s("F"), :lon => lon.round(6).to_s("F") }

   end
 end
   end
 end