Patching better 412 error messages from mis-commit on old api06 branch.
[rails.git] / app / controllers / geocoder_controller.rb
index 4ed94b6498be7aa70e9ffa47b1d6218b9f83dae1..18812689b4c2c8318d792993e6366987bdde479a 100644 (file)
@@ -3,6 +3,9 @@ class GeocoderController < ApplicationController
   require 'net/http'
   require 'rexml/document'
 
+  POSTCODE_ZOOM = 15
+  GEONAMES_ZOOM = 12
+
   def search
     query = params[:query]
     results = Array.new
@@ -11,6 +14,7 @@ class GeocoderController < ApplicationController
       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)
     else
@@ -21,13 +25,13 @@ class GeocoderController < ApplicationController
     results_count = count_results(results)
 
     render :update do |page|
-      page.replace_html :search_results_content, :partial => 'results', :object => results
+      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], position[:lon], position[:zoom]
+        page.call "setPosition", position[:lat].to_f, position[:lon].to_f, position[:zoom].to_i
       else
-        page.call "openSearchResults"
+        page.call "openSidebar"
       end
     end
   end
@@ -44,8 +48,8 @@ class GeocoderController < ApplicationController
     results.push description_geonames(lat, lon)
 
     render :update do |page|
-      page.replace_html :search_results_content, :partial => 'results', :object => results
-      page.call "openSearchResults"
+      page.replace_html :sidebar_content, :partial => 'results', :object => results
+      page.call "openSidebar"
     end
   end
 
@@ -55,12 +59,12 @@ private
     results = Array.new
 
     # 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
-      results.push({:lat => data[0], :lon => data[1], :zoom => 12,
+      results.push({:lat => data[0], :lon => data[1], :zoom => POSTCODE_ZOOM,
                     :prefix => "#{data[2]}, #{data[3]}, ",
                     :name => data[4]})
     end
@@ -74,14 +78,16 @@ private
     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=#{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
-      results.push({:lat => data[3], :lon => data[4], :zoom => 12,
-                    :name => data[2].gsub(/'/, "")})
+      postcode = data[2].gsub(/'/, "")
+      zoom = POSTCODE_ZOOM - postcode.count("#")
+      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 }
@@ -93,13 +99,13 @@ private
     results = Array.new
 
     # 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
-    unless response.get_elements("geodata/error")
+    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 => 12,
+                    :zoom => POSTCODE_ZOOM,
                     :name => query.upcase})
     end
 
@@ -112,7 +118,7 @@ private
     results = Array.new
 
     # ask OSM namefinder
-    response = fetch_xml("http://www.frankieandshadow.com/osm/search.xml?find=#{URI.escape(query)}")
+    response = fetch_xml("http://gazetteer.openstreetmap.org/namefinder/search.xml?find=#{escape_query(query)}")
 
     # parse the response
     response.elements.each("searchresults/named") do |named|
@@ -123,35 +129,69 @@ private
       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 = place.attributes["name"].to_s
+        placename = format_name(place.attributes["name"].to_s)
         suffix = ", #{distance} #{direction} of #{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 = "#{suffix}, #{parentname}"
+            else
+              parentdistance = format_distance(parent.attributes["approxdistance"].to_i)
+              parentdirection = format_direction(parent.attributes["direction"].to_i)
+              suffix = "#{suffix} (#{parentdistance} #{parentdirection} of #{parentname})"
+            end
+          end
+        end
       else
         suffix = ""
       end
+
       results.push({:lat => lat, :lon => lon, :zoom => zoom,
                     :prefix => prefix, :name => name, :suffix => suffix,
                     :description => description})
     end
 
-    return { :source => "OpenStreetMap Namefinder", :url => "http://www.frankieandshadow.com/osm/", :results => results }
+    return { :source => "OpenStreetMap Namefinder", :url => "http://gazetteer.openstreetmap.org/namefinder/", :results => results }
   rescue Exception => ex
-    return { :source => "OpenStreetMap Namefinder", :url => "http://www.frankieandshadow.com/osm/", :error => "Error contacting www.frankieandshadow.com: #{ex.to_s}" }
+    return { :source => "OpenStreetMap Namefinder", :url => "http://gazetteer.openstreetmap.org/namefinder/", :error => "Error contacting gazetteer.openstreetmap.org: #{ex.to_s}" }
   end
 
   def search_geonames(query)
     results = Array.new
 
     # ask geonames.org
-    response = fetch_xml("http://ws.geonames.org/search?q=#{URI.escape(query)}&maxRows=20")
+    response = fetch_xml("http://ws.geonames.org/search?q=#{escape_query(query)}&maxRows=20")
 
     # parse the response
     response.elements.each("geonames/geoname") do |geoname|
@@ -159,7 +199,7 @@ 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 => 12,
+      results.push({:lat => lat, :lon => lon, :zoom => GEONAMES_ZOOM,
                     :name => name,
                     :suffix => ", #{country}"})
     end
@@ -173,7 +213,7 @@ private
     results = Array.new
 
     # ask OSM namefinder
-    response = fetch_xml("http://www.frankieandshadow.com/osm/search.xml?find=#{types}+near+#{lat},#{lon}&max=#{max}")
+    response = fetch_xml("http://gazetteer.openstreetmap.org/namefinder/search.xml?find=#{types}+near+#{lat},#{lon}&max=#{max}")
 
     # parse the response
     response.elements.each("searchresults/named") do |named|
@@ -185,16 +225,16 @@ private
       name = named.attributes["name"].to_s
       description = named.elements["description"].to_s
       distance = format_distance(place.attributes["approxdistance"].to_i)
-      direction = format_direction(360 - place.attributes["direction"].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})
     end
 
-    return { :type => types.capitalize, :source => "OpenStreetMap Namefinder", :url => "http://www.frankieandshadow.com/osm/", :results => results }
+    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://www.frankieandshadow.com/osm/", :error => "Error contacting www.frankieandshadow.com: #{ex.to_s}" }
+    return { :type => types.capitalize, :source => "OpenStreetMap Namefinder", :url => "http://gazetteer.openstreetmap.org/namefinder/", :error => "Error contacting gazetteer.openstreetmap.org: #{ex.to_s}" }
   end
 
   def description_geonames(lat, lon)
@@ -212,7 +252,7 @@ private
 
     return { :type => "Location", :source => "GeoNames", :url => "http://www.geonames.org/", :results => results }
   rescue Exception => ex
-    return { :type => types.capitalize, :source => "OpenStreetMap Namefinder", :url => "http://www.frankieandshadow.com/osm/", :error => "Error contacting www.frankieandshadow.com: #{ex.to_s}" }
+    return { :type => "Location", :source => "GeoNames", :url => "http://www.geonames.org/", :error => "Error contacting ws.geonames.org: #{ex.to_s}" }
   end
 
   def fetch_text(url)
@@ -239,6 +279,10 @@ private
     return "west"
   end
 
+  def format_name(name)
+    return name.gsub(/( *\[[^\]]*\])*$/, "")
+  end
+
   def count_results(results)
     count = 0
 
@@ -248,4 +292,8 @@ private
 
     return count
   end
+
+  def escape_query(query)
+    return URI.escape(query, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]", false, 'N'))
+  end
 end