From 06b2d278ea6c273c7e4e01c6f28bb46505efd6d1 Mon Sep 17 00:00:00 2001 From: Tom Hughes Date: Thu, 2 Jul 2009 16:12:38 +0000 Subject: [PATCH] Make the search box load each set of results separately so that one service being slow doesn't delay the response from others. --- app/controllers/geocoder_controller.rb | 262 +++++++++++++---------- app/views/geocoder/_description.html.erb | 13 ++ app/views/geocoder/_results.html.erb | 15 -- app/views/geocoder/_search.html.erb | 9 + app/views/geocoder/error.html.erb | 1 + app/views/geocoder/results.html.erb | 7 + app/views/site/_search.html.erb | 13 +- config/locales/be.yml | 11 +- config/locales/de.yml | 11 +- config/locales/en.yml | 55 +++-- config/locales/es.yml | 11 +- config/locales/fr.yml | 1 - config/locales/he.yml | 3 - config/locales/hi.yml | 3 - config/locales/is.yml | 11 +- config/locales/it.yml | 11 +- config/locales/ja.yml | 11 +- config/locales/ko.yml | 3 - config/locales/nl.yml | 11 +- config/locales/pl.yml | 11 +- config/locales/pt-BR.yml | 11 +- config/locales/ru.yml | 11 +- config/locales/sl.yml | 47 ++-- config/locales/yo.yml | 3 - config/locales/zh-CN.yml | 11 +- config/locales/zh-TW.yml | 11 +- config/routes.rb | 8 + public/images/searching.gif | Bin 0 -> 1849 bytes public/stylesheets/site.css | 10 +- 29 files changed, 347 insertions(+), 238 deletions(-) create mode 100644 app/views/geocoder/_description.html.erb delete mode 100644 app/views/geocoder/_results.html.erb create mode 100644 app/views/geocoder/_search.html.erb create mode 100644 app/views/geocoder/error.html.erb create mode 100644 app/views/geocoder/results.html.erb create mode 100644 public/images/searching.gif diff --git a/app/controllers/geocoder_controller.rb b/app/controllers/geocoder_controller.rb index 622e700af..904e6bf74 100644 --- a/app/controllers/geocoder_controller.rb +++ b/app/controllers/geocoder_controller.rb @@ -6,84 +6,67 @@ class GeocoderController < ApplicationController before_filter :set_locale def search - query = params[:query] - results = Array.new - - query.sub(/^\s+/, "") - query.sub(/\s+$/, "") - - if query.match(/^[+-]?\d+(\.\d*)?\s*[\s,]\s*[+-]?\d+(\.\d*)?$/) - results.push search_latlon(query) - elsif 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) + @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 - results.push search_osm_namefinder(query) - results.push search_geonames(query) + @sources.push "osm_namefinder" + @sources.push "geonames" 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].to_f, position[:lon].to_f, position[:zoom].to_i - else - page.call "openSidebar" - end - end - 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) - - render :update do |page| - page.replace_html :sidebar_content, :partial => 'results', :object => results + page.replace_html :sidebar_content, :partial => "search" page.call "openSidebar" end end -private + def search_latlon + # get query parameters + query = params[:query] - def search_latlon(query) - results = Array.new + # create result array + @results = Array.new # decode the location - if m = query.match(/^([+-]?\d+(\.\d*)?)\s*[\s,]\s*([+-]?\d+(\.\d*)?)$/) + if m = query.match(/^\s*([+-]?\d+(\.\d*)?)\s*[\s,]\s*([+-]?\d+(\.\d*)?)\s*$/) lat = m[1].to_f lon = m[3].to_f end # generate results if lat < -90 or lat > 90 - return { :source => "Internal", :url => "http://openstreetmap.org/", :error => "Latitude #{lat} out of range" } + @error = "Latitude #{lat} out of range" + render :action => "error" elsif lon < -180 or lon > 180 - return { :source => "Internal", :url => "http://openstreetmap.org/", :error => "Longitude #{lon} out of range" } + @error = "Longitude #{lon} out of range" + render :action => "error" else - results.push({:lat => lat, :lon => lon, - :zoom => APP_CONFIG['postcode_zoom'], - :name => "#{lat}, #{lon}"}) + @results.push({:lat => lat, :lon => lon, + :zoom => APP_CONFIG['postcode_zoom'], + :name => "#{lat}, #{lon}"}) - return { :source => "Internal", :url => "http://openstreetmap.org/", :results => results } + 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 = 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)}") @@ -91,19 +74,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 => APP_CONFIG['postcode_zoom'], - :prefix => "#{data[2]}, #{data[3]}, ", - :name => data[4]}) + @results.push({:lat => data[0], :lon => data[1], + :zoom => APP_CONFIG['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)}") @@ -114,36 +102,44 @@ private 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}) + @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 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.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}) 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_namefinder + # get query parameters + query = params[:query] + + # create result array + @results = Array.new # ask OSM namefinder response = fetch_xml("http://gazetteer.openstreetmap.org/namefinder/search.xml?find=#{escape_query(query)}") @@ -162,14 +158,14 @@ private prefix = "" name = type else - prefix = t "geocoder.results.namefinder.prefix", :type => type + 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.results.namefinder.suffix_place", :distance => distance, :direction => direction, :placename => placename + suffix = t "geocoder.search_osm_namefinder.suffix_place", :distance => distance, :direction => direction, :placename => placename if place.attributes["rank"].to_i <= 30 parent = nil @@ -193,11 +189,11 @@ private parentname = format_name(parent.attributes["name"].to_s) if place.attributes["info"].to_s == "suburb" - suffix = t "geocoder.results.namefinder.suffix_suburb", :suffix => suffix, :parentname => parentname + 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.results.namefinder.suffix_parent", :suffix => suffix, :parentdistance => parentdistance, :parentdirection => parentdirection, :parentname => parentname + suffix = t "geocoder.search_osm_namefinder.suffix_parent", :suffix => suffix, :parentdistance => parentdistance, :parentdirection => parentdirection, :parentname => parentname end end end @@ -205,18 +201,23 @@ private suffix = "" end - results.push({:lat => lat, :lon => lon, :zoom => zoom, - :prefix => prefix, :name => name, :suffix => suffix, - :description => description}) + @results.push({:lat => lat, :lon => lon, :zoom => zoom, + :prefix => prefix, :name => name, :suffix => suffix, + :description => description}) end - return { :source => "OpenStreetMap Namefinder", :url => "http://gazetteer.openstreetmap.org/namefinder/", :results => results } + render :action => "results" rescue Exception => ex - return { :source => "OpenStreetMap Namefinder", :url => "http://gazetteer.openstreetmap.org/namefinder/", :error => "Error contacting gazetteer.openstreetmap.org: #{ex.to_s}" } + @error = "Error contacting gazetteer.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") @@ -227,19 +228,41 @@ 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 => APP_CONFIG['geonames_zoom'], - :name => name, - :suffix => ", #{country}"}) + @results.push({:lat => lat, :lon => lon, + :zoom => APP_CONFIG['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 + @sources = Array.new - def description_osm_namefinder(types, lat, lon, max) - results = 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 + end + + def description_osm_namefinder + # get query parameters + lat = params[:lat] + lon = params[:lon] + types = params[:types] + max = params[:max] + + # create result array + @results = Array.new # ask OSM namefinder response = fetch_xml("http://gazetteer.openstreetmap.org/namefinder/search.xml?find=#{types}+near+#{lat},#{lon}&max=#{max}") @@ -256,18 +279,24 @@ private 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}) + @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://gazetteer.openstreetmap.org/namefinder/", :results => results } + render :action => "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}" } + @error = "Error contacting gazetteer.openstreetmap.org: #{ex.to_s}" + render :action => "error" end - def description_geonames(lat, lon) - results = Array.new + 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}") @@ -276,14 +305,17 @@ 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({:prefix => "#{name}, #{country}"}) end - return { :type => "Location", :source => "GeoNames", :url => "http://www.geonames.org/", :results => results } + render :action => "results" rescue Exception => ex - return { :type => "Location", :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 +private + def fetch_text(url) return Net::HTTP.get(URI.parse(url)) end @@ -293,18 +325,18 @@ private end def format_distance(distance) - return t("geocoder.results.distance", :count => distance) + return t("geocoder.distance", :count => distance) end def format_direction(bearing) - return t("geocoder.results.direction.south_west") if bearing >= 22.5 and bearing < 67.5 - return t("geocoder.results.direction.south") if bearing >= 67.5 and bearing < 112.5 - return t("geocoder.results.direction.south_east") if bearing >= 112.5 and bearing < 157.5 - return t("geocoder.results.direction.east") if bearing >= 157.5 and bearing < 202.5 - return t("geocoder.results.direction.north_east") if bearing >= 202.5 and bearing < 247.5 - return t("geocoder.results.direction.north") if bearing >= 247.5 and bearing < 292.5 - return t("geocoder.results.direction.north_west") if bearing >= 292.5 and bearing < 337.5 - return t("geocoder.results.direction.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) diff --git a/app/views/geocoder/_description.html.erb b/app/views/geocoder/_description.html.erb new file mode 100644 index 000000000..7d93179d1 --- /dev/null +++ b/app/views/geocoder/_description.html.erb @@ -0,0 +1,13 @@ +<% @sources.each do |source| %> + <% if source[:types] %> +

<%= t("geocoder.description.title.#{source[:name]}", :types => t("geocoder.description.types.#{source[:types]}")) %>

+ <% else %> +

<%= t("geocoder.description.title.#{source[:name]}") %>

+ <% end %> +
+ <%= image_tag "searching.gif", :class => "search_searching" %> +
+ +<% end %> diff --git a/app/views/geocoder/_results.html.erb b/app/views/geocoder/_results.html.erb deleted file mode 100644 index bf42244f9..000000000 --- a/app/views/geocoder/_results.html.erb +++ /dev/null @@ -1,15 +0,0 @@ -<% results.each do |source| %> -<% type = source[:type] || t('geocoder.results.results') %> -

<%= t'geocoder.results.type_from_source', :type => type, :source_link => link_to(source[:source], source[:url]) %>

-<% if source[:results] %> -<% if source[:results].empty? %> -

<%= t'geocoder.results.no_results' %>

-<% else %> -<% source[:results].each do |result| %> -

<%= result_to_html(result) %>

-<% end %> -<% end %> -<% else %> -

<%= source[:error] %>

-<% end %> -<% end %> diff --git a/app/views/geocoder/_search.html.erb b/app/views/geocoder/_search.html.erb new file mode 100644 index 000000000..0d0ed2466 --- /dev/null +++ b/app/views/geocoder/_search.html.erb @@ -0,0 +1,9 @@ +<% @sources.each do |source| %> +

<%= t "geocoder.search.title.#{source}" %>

+
+ <%= image_tag "searching.gif", :class => "search_searching" %> +
+ +<% end %> diff --git a/app/views/geocoder/error.html.erb b/app/views/geocoder/error.html.erb new file mode 100644 index 000000000..e2ce07b6e --- /dev/null +++ b/app/views/geocoder/error.html.erb @@ -0,0 +1 @@ +

<%= @error %>

diff --git a/app/views/geocoder/results.html.erb b/app/views/geocoder/results.html.erb new file mode 100644 index 000000000..70051c91c --- /dev/null +++ b/app/views/geocoder/results.html.erb @@ -0,0 +1,7 @@ +<% if @results.empty? %> +

<%= t 'geocoder.results.no_results' %>

+<% else %> + <% @results.each do |result| %> +

<%= result_to_html(result) %>

+ <% end %> +<% end %> diff --git a/app/views/site/_search.html.erb b/app/views/site/_search.html.erb index d6c1e38fa..12b8bccc5 100644 --- a/app/views/site/_search.html.erb +++ b/app/views/site/_search.html.erb @@ -1,29 +1,19 @@