Start refactoring notes layer

[rails.git] / lib / osm.rb

diff --git a/lib/osm.rb b/lib/osm.rb
index 2745762064c5f342d67d8a13d6146df3a65786c1..4a6237b12b3dd8cd8c71fc8bf3f9ba5697dd97e7 100644 (file)
--- a/lib/osm.rb
+++ b/lib/osm.rb
@@ -6,12 +6,18 @@ module OSM
   require 'rexml/text'
   require 'xml/libxml'
   require 'digest/md5'
   require 'rexml/text'
   require 'xml/libxml'
   require 'digest/md5'

-  require 'RMagick'
+
+  if defined?(SystemTimer)
+    Timer = SystemTimer
+  else
+    require 'timeout'
+    Timer = Timeout
+  end

 
   # The base class for API Errors.
   class APIError < RuntimeError
 
   # The base class for API Errors.
   class APIError < RuntimeError

-    def render_opts
-      { :text => "Generic API Error", :status => :internal_server_error, :content_type => "text/plain" }
+    def status
+      :internal_server_error

     end
 
     def to_s
     end
 
     def to_s


@@ -21,8 +27,12 @@ module OSM
 
   # Raised when an API object is not found.
   class APINotFoundError < APIError
 
   # Raised when an API object is not found.
   class APINotFoundError < APIError

-    def render_opts
-      { :text => "The API wasn't found", :status => :not_found, :content_type => "text/plain" }
+    def status
+      :not_found
+    end
+
+    def to_s
+      "Object not found"

     end
   end
 
     end
   end
 


@@ -31,9 +41,9 @@ module OSM
     def initialize(message = "")
       @message = message
     end
     def initialize(message = "")
       @message = message
     end

-    
-    def render_opts
-      { :text => "Precondition failed: #{@message}", :status => :precondition_failed, :content_type => "text/plain" }
+
+    def status
+      :precondition_failed

     end
 
     def to_s
     end
 
     def to_s


@@ -46,18 +56,26 @@ module OSM
     def initialize(object = "object", object_id = "")
       @object, @object_id = object, object_id
     end
     def initialize(object = "object", object_id = "")
       @object, @object_id = object, object_id
     end

-    
+

     attr_reader :object, :object_id
     attr_reader :object, :object_id

-    
-    def render_opts
-      { :text => "The #{object} with the id #{object_id} has already been deleted", :status => :gone, :content_type => "text/plain" }
+
+    def status
+      :gone
+    end
+
+    def to_s
+      "The #{object} with the id #{object_id} has already been deleted"

     end
   end
 
   # Raised when the user logged in isn't the same as the changeset
   class APIUserChangesetMismatchError < APIError
     end
   end
 
   # Raised when the user logged in isn't the same as the changeset
   class APIUserChangesetMismatchError < APIError

-    def render_opts
-      { :text => "The user doesn't own that changeset", :status => :conflict, :content_type => "text/plain" }
+    def status
+      :conflict
+    end
+
+    def to_s
+      "The user doesn't own that changeset"

     end
   end
 
     end
   end
 


@@ -68,20 +86,24 @@ module OSM
     end
 
     attr_reader :changeset
     end
 
     attr_reader :changeset

-    
-    def render_opts
-      { :text => "The changeset #{@changeset.id} was closed at #{@changeset.closed_at}.", :status => :conflict, :content_type => "text/plain" }
+
+    def status
+      :conflict
+    end
+
+    def to_s
+      "The changeset #{@changeset.id} was closed at #{@changeset.closed_at}"

     end
   end
     end
   end

-  
+

   # Raised when a change is expecting a changeset, but the changeset doesn't exist
   class APIChangesetMissingError < APIError
   # Raised when a change is expecting a changeset, but the changeset doesn't exist
   class APIChangesetMissingError < APIError

-    def render_opts
-      { :text => "You need to supply a changeset to be able to make a change", :status => :conflict, :content_type => "text/plain" }
+    def status
+      :conflict

     end
     end

-    
+

     def to_s
     def to_s

-       "You need to supply a changeset to be able to make a change"
+      "You need to supply a changeset to be able to make a change"

     end
   end
 
     end
   end
 


@@ -91,23 +113,29 @@ module OSM
     def initialize(provided, allowed)
       @provided, @allowed = provided, allowed
     end
     def initialize(provided, allowed)
       @provided, @allowed = provided, allowed
     end

-    
-    def render_opts
-      { :text => "Changeset mismatch: Provided #{@provided} but only " +
-      "#{@allowed} is allowed.", :status => :conflict, :content_type => "text/plain" }
+
+    def status
+      :conflict
+    end
+
+    def to_s
+      "Changeset mismatch: Provided #{@provided} but only #{@allowed} is allowed"

     end
   end
     end
   end

-  
+

   # Raised when a diff upload has an unknown action. You can only have create,
   # modify, or delete
   class APIChangesetActionInvalid < APIError
     def initialize(provided)
       @provided = provided
     end
   # Raised when a diff upload has an unknown action. You can only have create,
   # modify, or delete
   class APIChangesetActionInvalid < APIError
     def initialize(provided)
       @provided = provided
     end

-    
-    def render_opts
-      { :text => "Unknown action #{@provided}, choices are create, modify, delete.",
-      :status => :bad_request, :content_type => "text/plain" }
+
+    def status
+      :bad_request
+    end
+
+    def to_s
+      "Unknown action #{@provided}, choices are create, modify, delete"

     end
   end
 
     end
   end
 


@@ -118,9 +146,12 @@ module OSM
       @model, @xml, @message = model, xml, message
     end
 
       @model, @xml, @message = model, xml, message
     end
 

-    def render_opts
-      { :text => "Cannot parse valid #{@model} from xml string #{@xml}. #{@message}",
-      :status => :bad_request, :content_type => "text/plain" }
+    def status
+      :bad_request
+    end
+
+    def to_s
+      "Cannot parse valid #{@model} from xml string #{@xml}. #{@message}"

     end
   end
 
     end
   end
 


@@ -132,14 +163,12 @@ module OSM
 
     attr_reader :provided, :latest, :id, :type
 
 
     attr_reader :provided, :latest, :id, :type
 

-    def render_opts
-      { :text => "Version mismatch: Provided " + provided.to_s +
-        ", server had: " + latest.to_s + " of " + type + " " + id.to_s, 
-        :status => :conflict, :content_type => "text/plain" }
+    def status
+      :conflict

     end
     end

-    
+

     def to_s
     def to_s

-       "Version mismatch: Provided " + provided.to_s + ", server had: " + latest.to_s + " of " + type + " " + id.to_s
+      "Version mismatch: Provided #{provided}, server had: #{latest} of #{type} #{id}"

     end
   end
 
     end
   end
 


@@ -152,24 +181,30 @@ module OSM
 
     attr_reader :type, :id, :tag_key
 
 
     attr_reader :type, :id, :tag_key
 

-    def render_opts
-      { :text => "Element #{@type}/#{@id} has duplicate tags with key #{@tag_key}.",
-        :status => :bad_request, :content_type => "text/plain" }
+    def status
+      :bad_request
+    end
+
+    def to_s
+      "Element #{@type}/#{@id} has duplicate tags with key #{@tag_key}"

     end
   end
     end
   end

-  
+

   # Raised when a way has more than the configured number of way nodes.
   # This prevents ways from being to long and difficult to work with
   class APITooManyWayNodesError < APIError
   # Raised when a way has more than the configured number of way nodes.
   # This prevents ways from being to long and difficult to work with
   class APITooManyWayNodesError < APIError

-    def initialize(provided, max)
-      @provided, @max = provided, max
+    def initialize(id, provided, max)
+      @id, @provided, @max = id, provided, max

     end
     end

-    
-    attr_reader :provided, :max
-    
-    def render_opts
-      { :text => "You tried to add #{provided} nodes to the way, however only #{max} are allowed",
-        :status => :bad_request, :content_type => "text/plain" }
+
+    attr_reader :id, :provided, :max
+
+    def status
+      :bad_request
+    end
+
+    def to_s
+      "You tried to add #{provided} nodes to way #{id}, however only #{max} are allowed"

     end
   end
 
     end
   end
 


@@ -180,8 +215,28 @@ module OSM
       @message = message
     end
 
       @message = message
     end
 

-    def render_opts
-      { :text => @message, :content_type => "text/plain", :status => :bad_request }
+    def status
+      :bad_request
+    end
+
+    def to_s
+      @message
+    end
+  end
+
+  ##
+  # raised when bounding box is invalid
+  class APIBadBoundingBox < APIError
+    def initialize(message)
+      @message = message
+    end
+
+    def status
+      :bad_request
+    end
+
+    def to_s
+      @message

     end
   end
 
     end
   end
 


@@ -192,8 +247,88 @@ module OSM
       @supported_method = supported_method
     end
 
       @supported_method = supported_method
     end
 

-    def render_opts
-      { :text => "Only method #{@supported_method} is supported on this URI.", :status => :method_not_allowed }
+    def status
+      :method_not_allowed
+    end
+
+    def to_s
+      "Only method #{@supported_method} is supported on this URI"
+    end
+  end
+
+  ##
+  # raised when an API call takes too long
+  class APITimeoutError < APIError
+    def status
+      :request_timeout
+    end
+
+    def to_s
+      "Request timed out"
+    end
+  end
+
+  ##
+  # raised when someone tries to redact a current version of
+  # an element - only historical versions can be redacted.
+  class APICannotRedactError < APIError
+    def status
+      :bad_request
+    end
+
+    def to_s
+      "Cannot redact current version of element, only historical versions may be redacted."
+    end
+  end
+
+  # Raised when the note provided is already closed
+  class APINoteAlreadyClosedError < APIError
+    def initialize(note)
+      @note = note
+    end
+
+    attr_reader :note
+
+    def status
+      :conflict
+    end
+
+    def to_s
+      "The note #{@note.id} was closed at #{@note.closed_at}"
+    end
+  end
+
+  # Raised when the note provided is already open
+  class APINoteAlreadyOpenError < APIError
+    def initialize(note)
+      @note = note
+    end
+
+    attr_reader :note
+
+    def status
+      :conflict
+    end
+
+    def to_s
+      "The note #{@note.id} is already open"
+    end
+  end
+
+  # raised when a two preferences have a duplicate key string.
+  class APIDuplicatePreferenceError < APIError
+    def initialize(key)
+      @key = key
+    end
+
+    attr_reader :key
+
+    def status
+      :bad_request
+    end
+
+    def to_s
+      "Duplicate preferences with key #{@key}"

     end
   end
 
     end
   end
 


@@ -262,13 +397,25 @@ module OSM
     # get the worst case bounds for a given radius from the base position
     def bounds(radius)
       latradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2) ** 2))
     # get the worst case bounds for a given radius from the base position
     def bounds(radius)
       latradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2) ** 2))

-      lonradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2) ** 2 / cos(@lat) ** 2))
+
+      begin
+        lonradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2) ** 2 / cos(@lat) ** 2))
+      rescue Errno::EDOM
+        lonradius = PI
+      end
+

       minlat = (@lat - latradius) * 180 / PI
       maxlat = (@lat + latradius) * 180 / PI
       minlon = (@lon - lonradius) * 180 / PI
       maxlon = (@lon + lonradius) * 180 / PI
       minlat = (@lat - latradius) * 180 / PI
       maxlat = (@lat + latradius) * 180 / PI
       minlon = (@lon - lonradius) * 180 / PI
       maxlon = (@lon + lonradius) * 180 / PI

+

       return { :minlat => minlat, :maxlat => maxlat, :minlon => minlon, :maxlon => maxlon }
     end
       return { :minlat => minlat, :maxlat => maxlat, :minlon => minlon, :maxlon => maxlon }
     end

+
+    # get the SQL to use to calculate distance
+    def sql_for_distance(lat_field, lon_field)
+      "6372.795 * 2 * asin(sqrt(power(sin((radians(#{lat_field}) - #{@lat}) / 2), 2) + cos(#{@lat}) * cos(radians(#{lat_field})) * power(sin((radians(#{lon_field}) - #{@lon})/2), 2)))"
+    end

   end
 
   class GeoRSS
   end
 
   class GeoRSS


@@ -362,21 +509,30 @@ module OSM
       doc = XML::Document.new
       doc.encoding = XML::Encoding::UTF_8
       root = XML::Node.new 'osm'
       doc = XML::Document.new
       doc.encoding = XML::Encoding::UTF_8
       root = XML::Node.new 'osm'

-      root['version'] = API_VERSION
+      root['version'] = API_VERSION.to_s

       root['generator'] = GENERATOR
       root['generator'] = GENERATOR

+      root['copyright'] = COPYRIGHT_OWNER
+      root['attribution'] = ATTRIBUTION_URL
+      root['license'] =  LICENSE_URL

       doc.root = root
       return doc
     end
   end
 
       doc.root = root
       return doc
     end
   end
 

-  def self.IPLocation(ip_address)
-    Timeout::timeout(4) do
-      Net::HTTP.start('api.hostip.info') do |http|
-        country = http.get("/country.php?ip=#{ip_address}").body
-        country = "GB" if country == "UK"
-        country = Country.find_by_code(country)
-        return { :minlon => country.min_lon, :minlat => country.min_lat, :maxlon => country.max_lon, :maxlat => country.max_lat }
+  def self.IPToCountry(ip_address)
+    Timer.timeout(4) do
+      ipinfo = Quova::IpInfo.new(ip_address)
+
+      if ipinfo.status == Quova::Success then
+        country = ipinfo.country_code
+      else
+        Net::HTTP.start('api.hostip.info') do |http|
+          country = http.get("/country.php?ip=#{ip_address}").body
+          country = "GB" if country == "UK"
+        end

       end
       end

+
+      return country.upcase

     end
 
     return nil
     end
 
     return nil


@@ -384,6 +540,23 @@ module OSM
     return nil
   end
 
     return nil
   end
 

+  def self.IPLocation(ip_address)
+    code = OSM.IPToCountry(ip_address)
+
+    if code and country = Country.find_by_code(code)
+      return { :minlon => country.min_lon, :minlat => country.min_lat, :maxlon => country.max_lon, :maxlat => country.max_lat }
+    end
+
+    return nil
+  end
+
+  # Parse a float, raising a specified exception on failure
+  def self.parse_float(str, klass, *args)
+    Float(str)
+  rescue
+    raise klass.new(*args)
+  end
+

   # Construct a random token of a given length
   def self.make_token(length = 30)
     chars = 'abcdefghijklmnopqrtuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'
   # Construct a random token of a given length
   def self.make_token(length = 30)
     chars = 'abcdefghijklmnopqrtuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'


@@ -403,15 +576,17 @@ module OSM
   end
 
   # Return an SQL fragment to select a given area of the globe
   end
 
   # Return an SQL fragment to select a given area of the globe

-  def self.sql_for_area(minlat, minlon, maxlat, maxlon, prefix = nil)
-    tilesql = QuadTile.sql_for_area(minlat, minlon, maxlat, maxlon, prefix)
-    minlat = (minlat * 10000000).round
-    minlon = (minlon * 10000000).round
-    maxlat = (maxlat * 10000000).round
-    maxlon = (maxlon * 10000000).round
+  def self.sql_for_area(bbox, prefix = nil)
+    tilesql = QuadTile.sql_for_area(bbox, prefix)
+    bbox = bbox.to_scaled

 
 

-    return "#{tilesql} AND #{prefix}latitude BETWEEN #{minlat} AND #{maxlat} AND #{prefix}longitude BETWEEN #{minlon} AND #{maxlon}"
+    return "#{tilesql} AND #{prefix}latitude BETWEEN #{bbox.min_lat} AND #{bbox.max_lat} " +
+                      "AND #{prefix}longitude BETWEEN #{bbox.min_lon} AND #{bbox.max_lon}"

   end
 
   end
 

-
+  def self.legal_text_for_country(country_code)
+    file_name = File.join(Rails.root, "config", "legales", country_code.to_s + ".yml")
+    file_name = File.join(Rails.root, "config", "legales", DEFAULT_LEGALE + ".yml") unless File.exist? file_name
+    YAML::load_file(file_name)
+  end

 end
 end