Merge branch 'pull/5030'

[rails.git] / lib / osm.rb

diff --git a/lib/osm.rb b/lib/osm.rb
index 3e4b5dcee4b005d8b4db2bc2b7e81bf8bf9eeedc..46f37036f92d796243960cf1c7c8b63fdd91244e 100644 (file)
--- a/lib/osm.rb
+++ b/lib/osm.rb
@@ -5,59 +5,48 @@ module OSM
   require "rexml/text"
   require "xml/libxml"
 
   require "rexml/text"
   require "xml/libxml"
 

-  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 status
-      :internal_server_error
+    def initialize(message = "Generic API Error")
+      super

     end
 
     end
 

-    def to_s
-      "Generic API Error"
+    def status
+      :internal_server_error

     end
   end
 
   # Raised when access is denied.
     end
   end
 
   # Raised when access is denied.

-  class APIAccessDenied < RuntimeError
-    def status
-      :forbidden
+  class APIAccessDenied < APIError
+    def initialize
+      super("Access denied")

     end
 
     end
 

-    def to_s
-      "Access denied"
+    def status
+      :forbidden

     end
   end
 
   # Raised when an API object is not found.
   class APINotFoundError < APIError
     end
   end
 
   # Raised when an API object is not found.
   class APINotFoundError < APIError

-    def status
-      :not_found
+    def initialize
+      super("Object not found")

     end
 
     end
 

-    def to_s
-      "Object not found"
+    def status
+      :not_found

     end
   end
 
   # Raised when a precondition to an API action fails sanity check.
   class APIPreconditionFailedError < APIError
     def initialize(message = "")
     end
   end
 
   # Raised when a precondition to an API action fails sanity check.
   class APIPreconditionFailedError < APIError
     def initialize(message = "")

-      @message = message
+      super("Precondition failed: #{message}")

     end
 
     def status
       :precondition_failed
     end
     end
 
     def status
       :precondition_failed
     end

-
-    def to_s
-      "Precondition failed: #{@message}"
-    end

   end
 
   # Raised when to delete an already-deleted object.
   end
 
   # Raised when to delete an already-deleted object.


@@ -65,6 +54,8 @@ module OSM
     def initialize(object = "object", object_id = "")
       @object = object
       @object_id = object_id
     def initialize(object = "object", object_id = "")
       @object = object
       @object_id = object_id

+
+      super("The #{object} with the id #{object_id} has already been deleted")

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


@@ -72,20 +63,16 @@ module OSM
     def status
       :gone
     end
     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
 
   # Raised when the user logged in isn't the same as the changeset
   class APIUserChangesetMismatchError < APIError

-    def status
-      :conflict
+    def initialize
+      super("The user doesn't own that changeset")

     end
 
     end
 

-    def to_s
-      "The user doesn't own that changeset"
+    def status
+      :conflict

     end
   end
 
     end
   end
 


@@ -93,6 +80,8 @@ module OSM
   class APIChangesetAlreadyClosedError < APIError
     def initialize(changeset)
       @changeset = changeset
   class APIChangesetAlreadyClosedError < APIError
     def initialize(changeset)
       @changeset = changeset

+
+      super("The changeset #{changeset.id} was closed at #{changeset.closed_at}")

     end
 
     attr_reader :changeset
     end
 
     attr_reader :changeset


@@ -100,16 +89,14 @@ module OSM
     def status
       :conflict
     end
     def status
       :conflict
     end

-
-    def to_s
-      "The changeset #{@changeset.id} was closed at #{@changeset.closed_at}"
-    end

   end
 
   # Raised when the changeset provided is not yet closed
   class APIChangesetNotYetClosedError < APIError
     def initialize(changeset)
       @changeset = changeset
   end
 
   # Raised when the changeset provided is not yet closed
   class APIChangesetNotYetClosedError < APIError
     def initialize(changeset)
       @changeset = changeset

+
+      super("The changeset #{changeset.id} is not yet closed.")

     end
 
     attr_reader :changeset
     end
 
     attr_reader :changeset


@@ -117,16 +104,14 @@ module OSM
     def status
       :conflict
     end
     def status
       :conflict
     end

-
-    def to_s
-      "The changeset #{@changeset.id} is not yet closed."
-    end

   end
 
   # Raised when a user is already subscribed to the changeset
   class APIChangesetAlreadySubscribedError < APIError
     def initialize(changeset)
       @changeset = changeset
   end
 
   # Raised when a user is already subscribed to the changeset
   class APIChangesetAlreadySubscribedError < APIError
     def initialize(changeset)
       @changeset = changeset

+
+      super("You are already subscribed to changeset #{changeset.id}.")

     end
 
     attr_reader :changeset
     end
 
     attr_reader :changeset


@@ -134,16 +119,14 @@ module OSM
     def status
       :conflict
     end
     def status
       :conflict
     end

-
-    def to_s
-      "You are already subscribed to changeset #{@changeset.id}."
-    end

   end
 
   # Raised when a user is not subscribed to the changeset
   class APIChangesetNotSubscribedError < APIError
     def initialize(changeset)
       @changeset = changeset
   end
 
   # Raised when a user is not subscribed to the changeset
   class APIChangesetNotSubscribedError < APIError
     def initialize(changeset)
       @changeset = changeset

+
+      super("You are not subscribed to changeset #{changeset.id}.")

     end
 
     attr_reader :changeset
     end
 
     attr_reader :changeset


@@ -151,20 +134,16 @@ module OSM
     def status
       :not_found
     end
     def status
       :not_found
     end

-
-    def to_s
-      "You are not subscribed to changeset #{@changeset.id}."
-    end

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

-    def status
-      :conflict
+    def initialize
+      super("You need to supply a changeset to be able to make a change")

     end
 
     end
 

-    def to_s
-      "You need to supply a changeset to be able to make a change"
+    def status
+      :conflict

     end
   end
 
     end
   end
 


@@ -172,51 +151,36 @@ module OSM
   # the changeset ID that the diff was uploaded to.
   class APIChangesetMismatchError < APIError
     def initialize(provided, allowed)
   # the changeset ID that the diff was uploaded to.
   class APIChangesetMismatchError < APIError
     def initialize(provided, allowed)

-      @provided = provided
-      @allowed = allowed
+      super("Changeset mismatch: Provided #{provided} but only #{allowed} is allowed")

     end
 
     def status
       :conflict
     end
     end
 
     def status
       :conflict
     end

-
-    def to_s
-      "Changeset mismatch: Provided #{@provided} but only #{@allowed} is allowed"
-    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)
   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
+      super("Unknown action #{provided}, choices are create, modify, delete")

     end
 
     def status
       :bad_request
     end
     end
 
     def status
       :bad_request
     end

-
-    def to_s
-      "Unknown action #{@provided}, choices are create, modify, delete"
-    end

   end
 
   # Raised when bad XML is encountered which stops things parsing as
   # they should.
   class APIBadXMLError < APIError
     def initialize(model, xml, message = "")
   end
 
   # Raised when bad XML is encountered which stops things parsing as
   # they should.
   class APIBadXMLError < APIError
     def initialize(model, xml, message = "")

-      @model = model
-      @xml = xml
-      @message = message
+      super("Cannot parse valid #{model} from xml string #{xml}. #{message}")

     end
 
     def status
       :bad_request
     end
     end
 
     def status
       :bad_request
     end

-
-    def to_s
-      "Cannot parse valid #{@model} from xml string #{@xml}. #{@message}"
-    end

   end
 
   # Raised when the provided version is not equal to the latest in the db.
   end
 
   # Raised when the provided version is not equal to the latest in the db.


@@ -226,6 +190,8 @@ module OSM
       @type = type
       @provided = provided
       @latest = latest
       @type = type
       @provided = provided
       @latest = latest

+
+      super("Version mismatch: Provided #{provided}, server had: #{latest} of #{type} #{id}")

     end
 
     attr_reader :provided, :latest, :id, :type
     end
 
     attr_reader :provided, :latest, :id, :type


@@ -233,10 +199,6 @@ module OSM
     def status
       :conflict
     end
     def status
       :conflict
     end

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

   end
 
   # raised when a two tags have a duplicate key string in an element.
   end
 
   # raised when a two tags have a duplicate key string in an element.


@@ -246,6 +208,8 @@ module OSM
       @type = type
       @id = id
       @tag_key = tag_key
       @type = type
       @id = id
       @tag_key = tag_key

+
+      super("Element #{type}/#{id} has duplicate tags with key #{tag_key}")

     end
 
     attr_reader :type, :id, :tag_key
     end
 
     attr_reader :type, :id, :tag_key


@@ -253,16 +217,14 @@ module OSM
     def status
       :bad_request
     end
     def status
       :bad_request
     end

-
-    def to_s
-      "Element #{@type}/#{@id} has duplicate tags with key #{@tag_key}"
-    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
     def initialize(id, provided, max)
   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
     def initialize(id, provided, max)

+      super("You tried to add #{provided} nodes to way #{id}, however only #{max} are allowed")
+

       @id = id
       @provided = provided
       @max = max
       @id = id
       @provided = provided
       @max = max


@@ -273,69 +235,63 @@ module OSM
     def status
       :bad_request
     end
     def status
       :bad_request
     end

+  end
+
+  # Raised when a relation has more than the configured number of relation members.
+  # This prevents relations from being too complex and difficult to work with
+  class APITooManyRelationMembersError < APIError
+    def initialize(id, provided, max)
+      super("You tried to add #{provided} members to relation #{id}, however only #{max} are allowed")
+
+      @id = id
+      @provided = provided
+      @max = max
+    end
+
+    attr_reader :id, :provided, :max

 
 

-    def to_s
-      "You tried to add #{provided} nodes to way #{id}, however only #{max} are allowed"
+    def status
+      :bad_request

     end
   end
 
   ##
   # raised when user input couldn't be parsed
   class APIBadUserInput < APIError
     end
   end
 
   ##
   # raised when user input couldn't be parsed
   class APIBadUserInput < APIError

-    def initialize(message)
-      @message = message
-    end
-

     def status
       :bad_request
     end
     def status
       :bad_request
     end

-
-    def to_s
-      @message
-    end

   end
 
   ##
   # raised when bounding box is invalid
   class APIBadBoundingBox < APIError
   end
 
   ##
   # raised when bounding box is invalid
   class APIBadBoundingBox < APIError

-    def initialize(message)
-      @message = message
-    end
-

     def status
       :bad_request
     end
     def status
       :bad_request
     end

-
-    def to_s
-      @message
-    end

   end
 
   ##
   # raised when an API call is made using a method not supported on that URI
   class APIBadMethodError < APIError
     def initialize(supported_method)
   end
 
   ##
   # raised when an API call is made using a method not supported on that URI
   class APIBadMethodError < APIError
     def initialize(supported_method)

-      @supported_method = supported_method
+      super("Only method #{supported_method} is supported on this URI")

     end
 
     def status
       :method_not_allowed
     end
     end
 
     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
   end
 
   ##
   # raised when an API call takes too long
   class APITimeoutError < APIError

-    def status
-      :request_timeout
+    def initialize
+      super("Request timed out")

     end
 
     end
 

-    def to_s
-      "Request timed out"
+    def status
+      :request_timeout

     end
   end
 
     end
   end
 


@@ -343,12 +299,12 @@ module OSM
   # raised when someone tries to redact a current version of
   # an element - only historical versions can be redacted.
   class APICannotRedactError < APIError
   # 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
+    def initialize
+      super("Cannot redact current version of element, only historical versions may be redacted.")

     end
 
     end
 

-    def to_s
-      "Cannot redact current version of element, only historical versions may be redacted."
+    def status
+      :bad_request

     end
   end
 
     end
   end
 


@@ -356,6 +312,8 @@ module OSM
   class APINoteAlreadyClosedError < APIError
     def initialize(note)
       @note = note
   class APINoteAlreadyClosedError < APIError
     def initialize(note)
       @note = note

+
+      super("The note #{note.id} was closed at #{note.closed_at}")

     end
 
     attr_reader :note
     end
 
     attr_reader :note


@@ -363,16 +321,14 @@ module OSM
     def status
       :conflict
     end
     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
 
   # Raised when the note provided is already open
   class APINoteAlreadyOpenError < APIError
     def initialize(note)
       @note = note

+
+      super("The note #{note.id} is already open")

     end
 
     attr_reader :note
     end
 
     attr_reader :note


@@ -380,16 +336,14 @@ module OSM
     def status
       :conflict
     end
     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
 
   # raised when a two preferences have a duplicate key string.
   class APIDuplicatePreferenceError < APIError
     def initialize(key)
       @key = key

+
+      super("Duplicate preferences with key #{key}")

     end
 
     attr_reader :key
     end
 
     attr_reader :key


@@ -397,9 +351,27 @@ module OSM
     def status
       :bad_request
     end
     def status
       :bad_request
     end

+  end
+
+  # Raised when a rate limit is exceeded
+  class APIRateLimitExceeded < APIError
+    def initialize
+      super("Rate limit exceeded")
+    end

 
 

-    def to_s
-      "Duplicate preferences with key #{@key}"
+    def status
+      :too_many_requests
+    end
+  end
+
+  # Raised when a size limit is exceeded
+  class APISizeLimitExceeded < APIError
+    def initialize
+      super("Size limit exceeded")
+    end
+
+    def status
+      :payload_too_large

     end
   end
 
     end
   end
 


@@ -415,23 +387,23 @@ module OSM
       yscale = ysize / height
       scale = [xscale, yscale].max
 
       yscale = ysize / height
       scale = [xscale, yscale].max
 

-      xpad = width * scale - xsize
-      ypad = height * scale - ysize
+      xpad = (width * scale) - xsize
+      ypad = (height * scale) - ysize

 
       @width = width
       @height = height
 
 
       @width = width
       @height = height
 

-      @tx = xsheet(min_lon) - xpad / 2
-      @ty = ysheet(min_lat) - ypad / 2
+      @tx = xsheet(min_lon) - (xpad / 2)
+      @ty = ysheet(min_lat) - (ypad / 2)

 
 

-      @bx = xsheet(max_lon) + xpad / 2
-      @by = ysheet(max_lat) + ypad / 2
+      @bx = xsheet(max_lon) + (xpad / 2)
+      @by = ysheet(max_lat) + (ypad / 2)

     end
 
     # the following two functions will give you the x/y on the entire sheet
 
     def ysheet(lat)
     end
 
     # the following two functions will give you the x/y on the entire sheet
 
     def ysheet(lat)

-      log(tan(PI / 4 + (lat * PI / 180 / 2))) / (PI / 180)
+      log(tan((PI / 4) + (lat * PI / 180 / 2))) / (PI / 180)

     end
 
     def xsheet(lon)
     end
 
     def xsheet(lon)


@@ -439,12 +411,17 @@ module OSM
     end
 
     # and these two will give you the right points on your image. all the constants can be reduced to speed things up. FIXME
     end
 
     # and these two will give you the right points on your image. all the constants can be reduced to speed things up. FIXME

+    # If the bbox has no extent, return the centre of the image to avoid dividing by zero.

 
     def y(lat)
 
     def y(lat)

+      return @height / 2 if (@by - @ty).zero?
+

       @height - ((ysheet(lat) - @ty) / (@by - @ty) * @height)
     end
 
     def x(lon)
       @height - ((ysheet(lat) - @ty) / (@by - @ty) * @height)
     end
 
     def x(lon)

+      return @width / 2 if (@bx - @tx).zero?
+

       ((xsheet(lon) - @tx) / (@bx - @tx) * @width)
     end
   end
       ((xsheet(lon) - @tx) / (@bx - @tx) * @width)
     end
   end


@@ -462,7 +439,7 @@ module OSM
     def distance(lat, lon)
       lat = lat * PI / 180
       lon = lon * PI / 180
     def distance(lat, lon)
       lat = lat * PI / 180
       lon = lon * PI / 180

-      6372.795 * 2 * asin(sqrt(sin((lat - @lat) / 2)**2 + cos(@lat) * cos(lat) * sin((lon - @lon) / 2)**2))
+      6372.795 * 2 * asin(sqrt((sin((lat - @lat) / 2)**2) + (cos(@lat) * cos(lat) * (sin((lon - @lon) / 2)**2))))

     end
 
     # get the worst case bounds for a given radius from the base position
     end
 
     # get the worst case bounds for a given radius from the base position


@@ -470,7 +447,7 @@ module OSM
       latradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2)**2))
 
       begin
       latradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2)**2))
 
       begin

-        lonradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2)**2 / cos(@lat)**2))
+        lonradius = 2 * asin(sqrt((sin(radius / 6372.795 / 2)**2) / (cos(@lat)**2)))

       rescue Errno::EDOM, Math::DomainError
         lonradius = PI
       end
       rescue Errno::EDOM, Math::DomainError
         lonradius = PI
       end


@@ -490,7 +467,7 @@ module OSM
   end
 
   class API
   end
 
   class API

-    def get_xml_doc
+    def xml_doc

       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"


@@ -536,15 +513,8 @@ module OSM
   end
 
   # Construct a random token of a given length
   end
 
   # Construct a random token of a given length

-  def self.make_token(length = 30)
-    chars = "abcdefghijklmnopqrtuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
-    token = ""
-
-    length.times do
-      token += chars[(rand * chars.length).to_i].chr
-    end
-
-    token
+  def self.make_token(length = 24)
+    SecureRandom.urlsafe_base64(length)

   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


@@ -558,14 +528,15 @@ module OSM
 
   # Return the terms and conditions text for a given country
   def self.legal_text_for_country(country_code)
 
   # Return the terms and conditions text for a given country
   def self.legal_text_for_country(country_code)

-    file_name = Rails.root.join("config", "legales", country_code.to_s + ".yml")
-    file_name = Rails.root.join("config", "legales", Settings.default_legale + ".yml") unless File.exist? file_name
-    YAML.load_file(file_name)
+    file_name = Rails.root.join("config", "legales", "#{country_code}.yml")
+    file_name = Rails.root.join("config", "legales", "#{Settings.default_legale}.yml") unless File.exist? file_name
+    YAML.load_file(file_name).transform_values!(&:html_safe)

   end
 
   # Return the HTTP client to use
   def self.http_client
   end
 
   # Return the HTTP client to use
   def self.http_client

-    @http_client ||= Faraday.new
+    @http_client ||= Faraday.new(:request => { :timeout => 15 },
+                                 :headers => { :user_agent => Settings.server_url })

   end
 
   # Return the MaxMindDB database handle
   end
 
   # Return the MaxMindDB database handle