Merge remote-tracking branch 'upstream/pull/1704'

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

diff --git a/app/controllers/geocoder_controller.rb b/app/controllers/geocoder_controller.rb
index 76b157faabd6058f2c536711dc49942115939416..e9fa7f26af847ca7e61b27710ff4e787f83ea359 100644 (file)
--- a/app/controllers/geocoder_controller.rb
+++ b/app/controllers/geocoder_controller.rb
@@ -1,133 +1,351 @@
 class GeocoderController < ApplicationController
 class GeocoderController < ApplicationController

-  layout 'site'
+  require "cgi"
+  require "uri"
+  require "rexml/document"

 
 

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

 
   def search
 
   def search

-    if params[:postcode] and not params[:postcode].empty?
-      check_postcode(params[:postcode])
-    elsif params[:query][:postcode] and not params[:query][:postcode].empty?
-      check_postcode(params[:query][:postcode])
-    elsif params[:query][:place_name]  
-      redirect_to :controller => 'geocoder', :action => 'results', :params => {:place_name => params[:query][:place_name]}
-    end 
+    @params = 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] =~ /^\d{5}(-\d{4})?$/
+        @sources.push "osm_nominatim"
+      elsif @params[:query] =~ /^(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] =~ /^[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?
+      head :bad_request
+    else
+      render :layout => map_layout
+    end

   end
 
   end
 

-  def check_postcode(p)
+  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}" }]

 
 

-    @postcode_arr = []
-    postcode = p.upcase
-    escaped_postcode = postcode.sub(/\s/,'%20')
+      render :action => "results"
+    end
+  end

 
 

-    begin
-      if postcode.match(/(^\d{5}$)|(^\d{5}-\d{4}$)/)
-        # Its a zip code - ask geocoder.us
-        # (They have a non commerical use api)
-        Net::HTTP.start('rpc.geocoder.us') do |http|
-          resp = http.get("/service/csv?zip=#{postcode}")
-          if resp.body.match(/couldn't find this zip/)
-            redirect_to :controller => params[:next_controller], :action => params[:next_action], :error => "invalid_zip_code"
-            return
-          end
-          data = resp.body.split(/, /) # lat,long,town,state,zip
-          lat = data[0] 
-          lon = data[1]
-          redirect_to :controller => params[:next_controller], :action => params[:next_action], :mlat => lat, :mlon => lon, :zoom => 14
-          return
-        end
-      elsif postcode.match(/^([A-Z]{1,2}\d+[A-Z]?\s*\d[A-Z]{2})/)
-        # It matched our naive UK postcode regexp
-        # Ask npemap to do a combined npemap + freethepostcode search
-        Net::HTTP.start('www.npemap.org.uk') do |http|
-          resp = http.get("/cgi/geocoder.fcgi?format=text&postcode=#{escaped_postcode}")
-          dataline = resp.body.split(/\n/)[1]
-          data = dataline.split(/,/) # easting,northing,postcode,lat,long
-          lat = data[3] 
-          lon = data[4]
-          redirect_to :controller => params[:next_controller], :action => params[:next_action], :mlat => lat, :mlon => lon, :zoom => 14
-          return
-        end
-      elsif postcode.match(/^[A-Z]\d[A-Z]\s*\d[A-Z]\d/)
-        # It's a canadian postcode
-        # Ask geocoder.ca (note - they have a per-day limit)
-        postcode = postcode.sub(/\s/,'')
-        Net::HTTP.start('geocoder.ca') do |http|
-          resp = http.get("?geoit=XML&postal=#{postcode}")
-          data_lat = resp.body.slice(/latt>.*?</)
-          data_lon = resp.body.slice(/longt>.*?</)
-          lat = data_lat.split(/[<>]/)[1]
-          lon = data_lon.split(/[<>]/)[1]
-          redirect_to :controller => params[:next_controller], :action => params[:next_action], :mlat => lat, :mlon => lon, :zoom => 14
-          return
-        end
-      elsif postcode.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})
-        /)
-        #its a UK postcode
-        begin
-          Net::HTTP.start('www.freethepostcode.org') do |http|
-            resp = http.get("/geocode?postcode=#{postcode}")
-            lat = resp.body.scan(/[4-6][0-9]\.?[0-9]+/)
-            lon = resp.body.scan(/[-+][0-9]\.?[0-9]+/)
-            redirect_to :controller => params[:next_controller], :action => params[:next_action], :mlat => lat, :mlon => lon, :zoom => 14
-            return
-          end
-        rescue
-          redirect_to :controller => params[:next_controller], :action => params[:next_action], :error => "invalid_postcode"
-          #redirect to somewhere else
-        end
-      elsif
-        # Some other postcode / zip code
-        # Throw it at geonames, and see if they have any luck with it
-        Net::HTTP.start('ws.geonames.org') do |http|
-          resp = http.get("/postalCodeSearch?postalcode=#{escaped_postcode}&maxRows=1")
-          hits = resp.body.slice(/totalResultsCount>.*?</).split(/[<>]/)[1]
-          if hits == "0"
-            # Geonames doesn't know, it's probably wrong
-            redirect_to :controller => params[:next_controller], :action => params[:next_action], :error => "invalid_postcode_or_zip"
-            return
-          end
-          data_lat = resp.body.slice(/lat>.*?</)
-          data_lon = resp.body.slice(/lng>.*?</)
-          lat = data_lat.split(/[<>]/)[1]
-          lon = data_lon.split(/[<>]/)[1]
-          redirect_to :controller => params[:next_controller], :action => params[:next_action], :mlat => lat, :mlon => lon, :zoom => 14
+  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
+    response = fetch_text("http://www.npemap.org.uk/cgi/geocoder.fcgi?format=text&postcode=#{escape_query(query)}")
+
+    # parse the response
+    unless response =~ /Error/
+      dataline = response.split(/\n/)[1]
+      data = dataline.split(/,/) # easting,northing,postcode,lat,long
+      postcode = data[2].delete("'")
+      zoom = POSTCODE_ZOOM - postcode.count("#")
+      @results.push(:lat => data[3], :lon => data[4], :zoom => zoom,
+                    :name => postcode)
+    end
+
+    render :action => "results"
+  rescue StandardError => ex
+    @error = "Error contacting www.npemap.org.uk: #{ex}"
+    render :action => "error"
+  end
+
+  def search_ca_postcode
+    # get query parameters
+    query = params[:query]
+    @results = []
+
+    # ask geocoder.ca (note - they have a per-day limit)
+    response = fetch_xml("https://geocoder.ca/?geoit=XML&postal=#{escape_query(query)}")
+
+    # parse the response
+    if response.get_elements("geodata/error").empty?
+      @results.push(:lat => response.text("geodata/latt"),
+                    :lon => response.text("geodata/longt"),
+                    :zoom => POSTCODE_ZOOM,
+                    :name => query.upcase)
+    end
+
+    render :action => "results"
+  rescue StandardError => ex
+    @error = "Error contacting geocoder.ca: #{ex}"
+    render :action => "error"
+  end
+
+  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
+    viewbox = "&viewbox=#{minlon},#{maxlat},#{maxlon},#{minlat}" if minlon && minlat && maxlon && maxlat
+
+    # get objects to excude
+    exclude = "&exclude_place_ids=#{params[:exclude]}" if params[:exclude]
+
+    # ask nominatim
+    response = fetch_xml("#{NOMINATIM_URL}search?format=xml&extratags=1&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)
+
+    # create result array
+    @results = []
+
+    # create parameter hash for "more results" link
+    @more_params = params
+                   .permit(:query, :minlon, :minlat, :maxlon, :maxlat, :exclude)
+                   .merge(:exclude => more_url_params["exclude_place_ids"].first)
+
+    # parse the response
+    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["place_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"] == "place"

         end
         end

-      else
-        # Some other postcode / zip file
-        redirect_to :controller => params[:next_controller], :action => params[:next_action], :error => "invalid_postcode_or_zip"
-        return

       end
       end

-    rescue
-      #Its likely that an api is down
-      redirect_to :controller => params[:next_controller], :action => params[:next_action], :error => "api_down"
+      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

+
+    render :action => "results"
+  rescue StandardError => ex
+    @error = "Error contacting nominatim.openstreetmap.org: #{ex}"
+    render :action => "error"

   end
 
   end
 

-  def results
-    @place_name = params[:place_name]
-    res_hash = {}
-    @res_ary = []
-    begin
-      Net::HTTP.start('ws.geonames.org') do |http|
-        res = http.get("/search?q=#{@place_name}&maxRows=10")
-        xml = REXML::Document.new(res.body)
-        xml.elements.each("geonames/geoname") do |ele|
-          res_hash = {}
-          ele.elements.each("name"){ |n| res_hash['name'] = n.text }
-          ele.elements.each("countryCode"){ |n| res_hash['countrycode'] = n.text }
-          ele.elements.each("countryName"){ |n| res_hash['countryname'] = n.text }
-          ele.elements.each("lat"){ |n| res_hash['lat'] = n.text }
-          ele.elements.each("lng"){ |n| res_hash['lon']= n.text }
-          @res_ary << res_hash
-        end 
+  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
+    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|
+      lat = geoname.text("lat")
+      lon = geoname.text("lng")
+      name = geoname.text("name")
+      country = geoname.text("countryName")
+
+      @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("#{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"]
+      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"
+  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.text("adminName1")
+      country = geoname.text("countryName")
+
+      @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
+
+  private
+
+  def fetch_text(url)
+    response = OSM.http_client.get(URI.parse(url))
+
+    if response.success?
+      response.body
+    else
+      raise response.status.to_s
+    end
+  end
+
+  def fetch_xml(url)
+    REXML::Document.new(fetch_text(url))
+  end
+
+  def escape_query(query)
+    CGI.escape(query)
+  end
+
+  def normalize_params
+    if query = params[: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

+    end

 
 

-      flash.delete(:notice)
-    rescue Timeout::Error
-      flash[:notice] = "Timed out waiting for results from ws.geonames.org"
-    rescue Exception => ex
-      flash[:notice] = "Error contacting ws.geonames.org: #{ex.to_s}"
+    params.permit(:query, :lat, :lon, :zoom, :minlat, :minlon, :maxlat, :maxlon)
+  end
+
+  def nsew_to_decdeg(captures)
+    begin
+      Float(captures[0])
+      lat = !captures[2].casecmp("s").zero? ? captures[0].to_f : -captures[0].to_f
+      lon = !captures[5].casecmp("w").zero? ? captures[3].to_f : -captures[3].to_f
+    rescue StandardError
+      lat = !captures[0].casecmp("s").zero? ? captures[1].to_f : -captures[1].to_f
+      lon = !captures[3].casecmp("w").zero? ? captures[4].to_f : -captures[4].to_f
+    end
+    { :lat => lat, :lon => lon }
+  end
+
+  def ddm_to_decdeg(captures)
+    begin
+      Float(captures[0])
+      lat = !captures[3].casecmp("s").zero? ? captures[0].to_f + captures[1].to_f / 60 : -(captures[0].to_f + captures[1].to_f / 60)
+      lon = !captures[7].casecmp("w").zero? ? captures[4].to_f + captures[5].to_f / 60 : -(captures[4].to_f + captures[5].to_f / 60)
+    rescue StandardError
+      lat = !captures[0].casecmp("s").zero? ? captures[1].to_f + captures[2].to_f / 60 : -(captures[1].to_f + captures[2].to_f / 60)
+      lon = !captures[4].casecmp("w").zero? ? captures[5].to_f + captures[6].to_f / 60 : -(captures[5].to_f + captures[6].to_f / 60)
+    end
+    { :lat => lat, :lon => lon }
+  end
+
+  def dms_to_decdeg(captures)
+    begin
+      Float(captures[0])
+      lat = !captures[4].casecmp("s").zero? ? captures[0].to_f + (captures[1].to_f + captures[2].to_f / 60) / 60 : -(captures[0].to_f + (captures[1].to_f + captures[2].to_f / 60) / 60)
+      lon = !captures[9].casecmp("w").zero? ? captures[5].to_f + (captures[6].to_f + captures[7].to_f / 60) / 60 : -(captures[5].to_f + (captures[6].to_f + captures[7].to_f / 60) / 60)
+    rescue StandardError
+      lat = !captures[0].casecmp("s").zero? ? captures[1].to_f + (captures[2].to_f + captures[3].to_f / 60) / 60 : -(captures[1].to_f + (captures[2].to_f + captures[3].to_f / 60) / 60)
+      lon = !captures[5].casecmp("w").zero? ? captures[6].to_f + (captures[7].to_f + captures[8].to_f / 60) / 60 : -(captures[6].to_f + (captures[7].to_f + captures[8].to_f / 60) / 60)

     end
     end

+    { :lat => lat, :lon => lon }

   end
 end
   end
 end