X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/2f9291ba5764fe104264ae7e3b6a361e11212e8b..d8b9b6dd58cf049acc6cf647f80ceb5e3e200cd6:/lib/osm.rb diff --git a/lib/osm.rb b/lib/osm.rb index 1951e3c31..b6dd64b99 100644 --- a/lib/osm.rb +++ b/lib/osm.rb @@ -5,59 +5,48 @@ module OSM 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 - def status - :internal_server_error + def initialize(message = "Generic API Error") + super message end - def to_s - "Generic API Error" + def status + :internal_server_error end end # Raised when access is denied. - class APIAccessDenied < RuntimeError - def status - :forbidden + class APIAccessDenied < APIError + def initialize + super "Access denied" end - def to_s - "Access denied" + def status + :forbidden end end # Raised when an API object is not found. class APINotFoundError < APIError - def status - :not_found + def initialize + super "Object not found" 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 = "") - @message = message + super "Precondition failed: #{message}" end def status :precondition_failed end - - def to_s - "Precondition failed: #{@message}" - end 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 + + super "The #{object} with the id #{object_id} has already been deleted" end attr_reader :object, :object_id @@ -72,20 +63,16 @@ module OSM 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 - def status - :conflict + def initialize + super "The user doesn't own that changeset" end - def to_s - "The user doesn't own that changeset" + def status + :conflict end end @@ -93,6 +80,8 @@ module OSM class APIChangesetAlreadyClosedError < APIError def initialize(changeset) @changeset = changeset + + super "The changeset #{changeset.id} was closed at #{changeset.closed_at}" end attr_reader :changeset @@ -100,16 +89,14 @@ module OSM 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 + + super "The changeset #{changeset.id} is not yet closed." end attr_reader :changeset @@ -117,16 +104,14 @@ module OSM 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 + + super "You are already subscribed to changeset #{changeset.id}." end attr_reader :changeset @@ -134,16 +119,14 @@ module OSM 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 + + super "You are not subscribed to changeset #{changeset.id}." end attr_reader :changeset @@ -151,20 +134,16 @@ module OSM 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 - def status - :conflict + def initialize + super "You need to supply a changeset to be able to make a change" end - def to_s - "You need to supply a changeset to be able to make a change" + def status + :conflict end end @@ -172,51 +151,36 @@ module OSM # 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 - - 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) - @provided = provided + super "Unknown action #{provided}, choices are create, modify, delete" 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 = "") - @model = model - @xml = xml - @message = message + super "Cannot parse valid #{model} from xml string #{xml}. #{message}" 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. @@ -226,6 +190,8 @@ module OSM @type = type @provided = provided @latest = latest + + super "Version mismatch: Provided #{provided}, server had: #{latest} of #{type} #{id}" end attr_reader :provided, :latest, :id, :type @@ -233,10 +199,6 @@ module OSM 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. @@ -246,6 +208,8 @@ module OSM @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 @@ -253,16 +217,14 @@ module OSM 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) + super "You tried to add #{provided} nodes to way #{id}, however only #{max} are allowed" + @id = id @provided = provided @max = max @@ -273,69 +235,45 @@ module OSM def status :bad_request end - - def to_s - "You tried to add #{provided} nodes to way #{id}, however only #{max} are allowed" - 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 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 ## # 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 - - 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 + def initialize + super "Request timed out" end - def to_s - "Request timed out" + def status + :request_timeout end end @@ -343,12 +281,12 @@ module OSM # 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 - def to_s - "Cannot redact current version of element, only historical versions may be redacted." + def status + :bad_request end end @@ -356,6 +294,8 @@ module OSM class APINoteAlreadyClosedError < APIError def initialize(note) @note = note + + super "The note #{note.id} was closed at #{note.closed_at}" end attr_reader :note @@ -363,16 +303,14 @@ module OSM 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 + + super "The note #{note.id} is already open" end attr_reader :note @@ -380,16 +318,14 @@ module OSM 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 + + super "Duplicate preferences with key #{key}" end attr_reader :key @@ -397,10 +333,6 @@ module OSM def status :bad_request end - - def to_s - "Duplicate preferences with key #{@key}" - end end # Helper methods for going to/from mercator and lat/lng. @@ -439,12 +371,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 + # If the bbox has no extent, return the centre of the image to avoid dividing by zero. def y(lat) + return @height / 2 if (@by - @ty).zero? + @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 @@ -502,26 +439,19 @@ module OSM end def xml_root_attributes - { "version" => API_VERSION.to_s, - "generator" => GENERATOR, - "copyright" => COPYRIGHT_OWNER, - "attribution" => ATTRIBUTION_URL, - "license" => LICENSE_URL } + { "version" => Settings.api_version, + "generator" => Settings.generator, + "copyright" => Settings.copyright_owner, + "attribution" => Settings.attribution_url, + "license" => Settings.license_url } end end def self.ip_to_country(ip_address) - ipinfo = geoip_database.country(ip_address) if defined?(GEOIP_DATABASE) + ipinfo = maxmind_database.lookup(ip_address) if Settings.key?(:maxmind_database) - if ipinfo - country = ipinfo.country_code2 - else - country = http_client.get("https://api.hostip.info/country.php?ip=#{ip_address}").body - country = "GB" if country == "UK" - end + return ipinfo.country.iso_code if ipinfo&.found? - country - rescue StandardError nil end @@ -565,9 +495,9 @@ module OSM # 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", 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 @@ -575,8 +505,8 @@ module OSM @http_client ||= Faraday.new end - # Return the GeoIP database handle - def self.geoip_database - @geoip_database ||= GeoIP.new(GEOIP_DATABASE) if defined?(GEOIP_DATABASE) + # Return the MaxMindDB database handle + def self.maxmind_database + @maxmind_database ||= MaxMindDB.new(Settings.maxmind_database) if Settings.key?(:maxmind_database) end end