X-Git-Url: https://git.openstreetmap.org/rails.git/blobdiff_plain/373a3b05776bfbfaed1087089289583bc9543798..fbcd2bc10a5f97a1ecd5d6d76a039ebd85365d2e:/app/controllers/geocoder_controller.rb diff --git a/app/controllers/geocoder_controller.rb b/app/controllers/geocoder_controller.rb index 66962c7f6..d1af43a72 100644 --- a/app/controllers/geocoder_controller.rb +++ b/app/controllers/geocoder_controller.rb @@ -1,296 +1,353 @@ class GeocoderController < ApplicationController - require 'uri' - require 'net/http' - require 'rexml/document' + require "cgi" + require "uri" + require "rexml/document" - POSTCODE_ZOOM = 15 - GEONAMES_ZOOM = 12 + before_action :authorize_web + before_action :set_locale + before_action :require_oauth, :only => [:search] + authorize_resource :class => false 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) - 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) + @params = normalize_params + @sources = [] + + if @params[:lat] && @params[:lon] + @sources.push "latlon" + @sources.push "osm_nominatim_reverse" + @sources.push "geonames_reverse" if Settings.key?(:geonames_username) + elsif @params[:query] + if @params[:query].match?(/^\d{5}(-\d{4})?$/) + @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 "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 Settings.key?(:geonames_username) + end + end + + if @sources.empty? + head :bad_request else - results.push search_osm_namefinder(query) - results.push search_geonames(query) + render :layout => map_layout end + end - results_count = count_results(results) + def search_latlon + lat = params[:lat].to_f + lon = params[:lon].to_f - render :update do |page| - page.replace_html :sidebar_content, :partial => 'results', :object => results + if params[:latlon_digits] + # We've got two nondescript numbers for a query, which can mean both "lat, lon" or "lon, lat". + @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" + if lat >= -90 && lat <= 90 && lon >= -180 && lon <= 180 + @results.push(:lat => lat, :lon => lon, + :zoom => params[:zoom], + :name => "#{lat}, #{lon}") end - end - end - - def description - results = Array.new - lat = params[:lat] - lon = params[:lon] + if lon >= -90 && lon <= 90 && lat >= -180 && lat <= 180 + @results.push(:lat => lon, :lon => lat, + :zoom => params[:zoom], + :name => "#{lon}, #{lat}") + end - 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) + if @results.empty? + @error = "Latitude or longitude are out of range" + render :action => "error" + else + render :action => "results" + end + else + # 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 => 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 end -private - - def search_us_postcode(query) - results = Array.new + def search_ca_postcode + # get query parameters + query = params[:query] + @results = [] - # 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.ca (note - they have a per-day limit) + response = fetch_xml("https://geocoder.ca/?geoit=XML&postal=#{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 => POSTCODE_ZOOM, - :prefix => "#{data[2]}, #{data[3]}, ", - :name => data[4]}) + if response.get_elements("geodata/error").empty? + @results.push(:lat => response.text("geodata/latt"), + :lon => response.text("geodata/longt"), + :zoom => Settings.postcode_zoom, + :name => query.upcase) 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 => e + @error = "Error contacting geocoder.ca: #{e}" + render :action => "error" end - def search_uk_postcode(query) - 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 = POSTCODE_ZOOM - postcode.count("#") - results.push({:lat => data[3], :lon => data[4], :zoom => zoom, - :name => postcode}) - end + def search_osm_nominatim + # get query parameters + query = params[:query] + minlon = params[:minlon] + minlat = params[:minlat] + maxlon = params[:maxlon] + maxlat = params[:maxlat] - 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}" } - end + # get view box + viewbox = "&viewbox=#{minlon},#{maxlat},#{maxlon},#{minlat}" if minlon && minlat && maxlon && maxlat - def search_ca_postcode(query) - results = Array.new + # get objects to excude + exclude = "&exclude_place_ids=#{params[:exclude]}" if params[:exclude] - # ask geocoder.ca (note - they have a per-day limit) - response = fetch_xml("http://geocoder.ca/?geoit=XML&postal=#{escape_query(query)}") + # ask nominatim + response = fetch_xml("#{Settings.nominatim_url}search?format=xml&extratags=1&q=#{escape_query(query)}#{viewbox}#{exclude}&accept-language=#{http_accept_language.user_preferred_languages.join(',')}") - # 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 => POSTCODE_ZOOM, - :name => query.upcase}) - end + # extract the results from the response + results = response.elements["searchresults"] - 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}" } - end + # extract parameters from more_url + more_url_params = CGI.parse(URI.parse(results.attributes["more_url"]).query) - def search_osm_namefinder(query) - results = Array.new + # create result array + @results = [] - # ask OSM namefinder - response = fetch_xml("http://gazetteer.openstreetmap.org/namefinder/search.xml?find=#{escape_query(query)}") + # 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 - 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 = "#{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 = ", #{distance} #{direction} of #{placename}" - - if place.attributes["rank"].to_i <= 30 - parent = nil - parentrank = 0 - parentdistance = 0 - - place.elements.each("nearestplaces/named") do |nearest| - nearestrank = nearest.attributes["rank"].to_i - nearestdistance = nearest.attributes["distance"].to_f - - if nearestrank > parentrank or - ( nearestrank == parentrank and nearestdistance < parentdistance ) - parent = nearest - parentrank = nearestrank - parentdistance = nearestdistance - end - end - - if parent - parentname = format_name(parent.attributes["name"].to_s) - - if place.attributes["info"].to_s == "suburb" - suffix = "#{suffix}, #{parentname}" - else - suffix = "#{suffix} (near #{parentname})" - end - end + 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 - else - suffix = "" 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) 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 StandardError => e + @error = "Error contacting nominatim.openstreetmap.org: #{e}" + render :action => "error" 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 - 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)}&lang=#{lang}&maxRows=20&username=#{Settings.geonames_username}") # 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 => GEONAMES_ZOOM, + lat = geoname.text("lat") + lon = geoname.text("lng") + name = geoname.text("name") + country = geoname.text("countryName") + + @results.push(:lat => lat, :lon => lon, + :zoom => Settings.geonames_zoom, :name => name, - :suffix => ", #{country}"}) + :suffix => ", #{country}") 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 => e + @error = "Error contacting api.geonames.org: #{e}" + 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] + + # create result array + @results = [] - # ask OSM namefinder - response = fetch_xml("http://gazetteer.openstreetmap.org/namefinder/search.xml?find=#{types}+near+#{lat},#{lon}&max=#{max}") + # ask nominatim + response = fetch_xml("#{Settings.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}) + 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 - return { :type => types.capitalize, :source => "OpenStreetMap Namefinder", :url => "http://gazetteer.openstreetmap.org/namefinder/", :results => results } - 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}" } + render :action => "results" + rescue StandardError => e + @error = "Error contacting nominatim.openstreetmap.org: #{e}" + 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] + + # get preferred language + lang = I18n.locale.to_s.split("-").first + + # create result array + @results = [] # ask geonames.org - response = fetch_xml("http://ws.geonames.org/countrySubdivision?lat=#{lat}&lng=#{lon}") + response = fetch_xml("http://api.geonames.org/countrySubdivision?lat=#{lat}&lng=#{lon}&lang=#{lang}&username=#{Settings.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({:prefix => "#{name}, #{country}"}) + name = geoname.text("adminName1") + country = geoname.text("countryName") + + @results.push(:lat => lat, :lon => lon, + :zoom => Settings.geonames_zoom, + :name => name, + :suffix => ", #{country}") end - return { :type => "Location", :source => "GeoNames", :url => "http://www.geonames.org/", :results => results } - rescue Exception => ex - return { :type => "Location", :source => "GeoNames", :url => "http://www.geonames.org/", :error => "Error contacting ws.geonames.org: #{ex.to_s}" } + render :action => "results" + rescue StandardError => e + @error = "Error contacting api.geonames.org: #{e}" + render :action => "error" end + private + 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 + raise response.status.to_s + end end def fetch_xml(url) - return REXML::Document.new(fetch_text(url)) + REXML::Document.new(fetch_text(url)) end - def format_distance(distance) - return "less than 1km" if distance == 0 - return "about #{distance}km" + def escape_query(query) + CGI.escape(query) 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" - end + def normalize_params + if query = params[:query] + query.strip! - def format_name(name) - return name.gsub(/( *\[[^\]]*\])*$/, "") - end + 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) - def count_results(results) - count = 0 + params[:latlon_digits] = true unless params[:whereami] + end + end + + params.permit(:query, :lat, :lon, :latlon_digits, :zoom, :minlat, :minlon, :maxlat, :maxlon) + end - results.each do |source| - count += source[:results].length if source[:results] + 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 - return count + 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 escape_query(query) - return URI.escape(query, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]", false, 'N')) + 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 + { :lat => lat, :lon => lon } end end