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
- def render_opts { :text => "", :status => :internal_server_error } end
+ def status
+ :internal_server_error
+ end
+
+ def to_s
+ "Generic API Error"
+ end
end
# Raised when an API object is not found.
class APINotFoundError < APIError
+ def status
+ :not_found
+ end
+
+ def to_s
+ "Object not found"
+ end
end
# Raised when a precondition to an API action fails sanity check.
class APIPreconditionFailedError < APIError
- def render_opts { :text => "", :status => :precondition_failed } end
+ def initialize(message = "")
+ @message = message
+ end
+
+ def status
+ :precondition_failed
+ end
+
+ def to_s
+ "Precondition failed: #{@message}"
+ end
end
# Raised when to delete an already-deleted object.
class APIAlreadyDeletedError < APIError
- def render_opts { :text => "", :status => :gone } end
- end
+ def initialize(object = "object", object_id = "")
+ @object, @object_id = object, object_id
+ end
- # Raised when the provided version is not equal to the latest in the db.
- class APIVersionMismatchError < APIError
- def initialize(provided, latest)
- @provided, @latest = provided, latest
+ attr_reader :object, :object_id
+
+ def status
+ :gone
+ end
+
+ def to_s
+ "The #{object} with the id #{object_id} has already been deleted"
end
+ end
- attr_reader :provided, :latest
+ # Raised when the user logged in isn't the same as the changeset
+ class APIUserChangesetMismatchError < APIError
+ def status
+ :conflict
+ end
- def render_opts
- { :text => "Version mismatch: Provided " + ex.provided.to_s +
- ", server had: " + ex.latest.to_s, :status => :bad_request }
+ def to_s
+ "The user doesn't own that changeset"
end
end
- # Helper methods for going to/from mercator and lat/lng.
- class Mercator
- include Math
+ # Raised when the changeset provided is already closed
+ class APIChangesetAlreadyClosedError < APIError
+ def initialize(changeset)
+ @changeset = changeset
+ end
- #init me with your bounding box and the size of your image
- def initialize(min_lat, min_lon, max_lat, max_lon, width, height)
- xsize = xsheet(max_lon) - xsheet(min_lon)
- ysize = ysheet(max_lat) - ysheet(min_lat)
- xscale = xsize / width
- yscale = ysize / height
- scale = [xscale, yscale].max
+ attr_reader :changeset
- xpad = width * scale - xsize
- ypad = height * scale - ysize
+ def status
+ :conflict
+ end
- @width = width
- @height = height
+ def to_s
+ "The changeset #{@changeset.id} was closed at #{@changeset.closed_at}"
+ end
+ end
- @tx = xsheet(min_lon) - xpad / 2
- @ty = ysheet(min_lat) - ypad / 2
+ # Raised when a change is expecting a changeset, but the changeset doesn't exist
+ class APIChangesetMissingError < APIError
+ def status
+ :conflict
+ end
- @bx = xsheet(max_lon) + xpad / 2
- @by = ysheet(max_lat) + ypad / 2
+ def to_s
+ "You need to supply a changeset to be able to make a change"
end
+ end
- #the following two functions will give you the x/y on the entire sheet
+ # Raised when a diff is uploaded containing many changeset IDs which don't match
+ # the changeset ID that the diff was uploaded to.
+ class APIChangesetMismatchError < APIError
+ def initialize(provided, allowed)
+ @provided, @allowed = provided, allowed
+ end
- def ysheet(lat)
- log(tan(PI / 4 + (lat * PI / 180 / 2))) / (PI / 180)
+ def status
+ :conflict
end
- def xsheet(lon)
- lon
+ def to_s
+ "Changeset mismatch: Provided #{@provided} but only #{@allowed} is allowed"
end
+ end
- #and these two will give you the right points on your image. all the constants can be reduced to speed things up. FIXME
+ # 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 y(lat)
- return @height - ((ysheet(lat) - @ty) / (@by - @ty) * @height)
+ def status
+ :bad_request
end
- def x(lon)
- return ((xsheet(lon) - @tx) / (@bx - @tx) * @width)
+ 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, @xml, @message = model, xml, message
+ end
- # This piece of magic reads a GPX with SAX and spits out
- # lat/lng and stuff
- #
- # This would print every latitude value:
- #
- # gpx = OSM::GPXImporter.new('somefile.gpx')
- # gpx.points {|p| puts p['latitude']}
- class GPXImporter
- # FIXME swap REXML for libXML
- attr_reader :possible_points
- attr_reader :actual_points
- attr_reader :tracksegs
-
- def initialize(file)
- @file = file
- end
-
- def points
- @possible_points = 0
- @actual_points = 0
- @tracksegs = 0
-
- lat = -1
- lon = -1
- ele = -1
- date = DateTime.now();
- gotlatlon = false
- gotele = false
- gotdate = false
-
- @file.rewind
-
- parser = REXML::Parsers::SAX2Parser.new(@file)
-
- parser.listen( :start_element, %w{ trkpt }) do |uri,localname,qname,attributes|
- lat = attributes['lat'].to_f
- lon = attributes['lon'].to_f
- gotlatlon = true
- gotele = false
- gotdate = false
- @possible_points += 1
- end
+ def status
+ :bad_request
+ end
- parser.listen( :characters, %w{ ele } ) do |text|
- ele = text
- gotele = true
- end
+ def to_s
+ "Cannot parse valid #{@model} from xml string #{@xml}. #{@message}"
+ end
+ end
- parser.listen( :characters, %w{ time } ) do |text|
- if text && text != ''
- begin
- date = DateTime.parse(text)
- gotdate = true
- rescue
- end
- end
- end
+ # Raised when the provided version is not equal to the latest in the db.
+ class APIVersionMismatchError < APIError
+ def initialize(id, type, provided, latest)
+ @id, @type, @provided, @latest = id, type, provided, latest
+ end
- parser.listen( :end_element, %w{ trkseg } ) do |uri, localname, qname|
- @tracksegs += 1
- end
+ attr_reader :provided, :latest, :id, :type
- parser.listen( :end_element, %w{ trkpt } ) do |uri,localname,qname|
- if gotlatlon && gotdate
- ele = '0' unless gotele
- if lat < 90 && lat > -90 && lon > -180 && lon < 180
- @actual_points += 1
- yield Hash['latitude' => lat, 'longitude' => lon, 'timestamp' => date, 'altitude' => ele, 'segment' => @tracksegs]
- end
- end
- gotlatlon = false
- gotele = false
- gotdate = false
- end
+ def status
+ :conflict
+ end
- parser.parse
+ def to_s
+ "Version mismatch: Provided #{provided}, server had: #{latest} of #{type} #{id}"
end
+ end
- def get_picture(min_lat, min_lon, max_lat, max_lon, num_points)
- #puts "getting picfor bbox #{min_lat},#{min_lon} - #{max_lat},#{max_lon}"
- frames = 10
- width = 250
- height = 250
- proj = OSM::Mercator.new(min_lat, min_lon, max_lat, max_lon, width, height)
+ # raised when a two tags have a duplicate key string in an element.
+ # this is now forbidden by the API.
+ class APIDuplicateTagsError < APIError
+ def initialize(type, id, tag_key)
+ @type, @id, @tag_key = type, id, tag_key
+ end
- linegc = Magick::Draw.new
- linegc.stroke_linejoin('miter')
- linegc.stroke_width(1)
- linegc.stroke('#BBBBBB')
- linegc.fill('#BBBBBB')
+ attr_reader :type, :id, :tag_key
- highlightgc = Magick::Draw.new
- highlightgc.stroke_linejoin('miter')
- highlightgc.stroke_width(3)
- highlightgc.stroke('#000000')
- highlightgc.fill('#000000')
+ def status
+ :bad_request
+ end
- images = []
+ def to_s
+ "Element #{@type}/#{@id} has duplicate tags with key #{@tag_key}"
+ end
+ end
- frames.times do
- image = Magick::Image.new(width, height) do |image|
- image.background_color = 'white'
- image.format = 'GIF'
- 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)
+ @id, @provided, @max = id, provided, max
+ end
- images << image
- end
+ attr_reader :id, :provided, :max
- oldpx = 0.0
- oldpy = 0.0
+ def status
+ :bad_request
+ end
- first = true
+ def to_s
+ "You tried to add #{provided} nodes to way #{id}, however only #{max} are allowed"
+ end
+ end
- m = 0
- mm = 0
- points do |p|
- px = proj.x(p['longitude'])
- py = proj.y(p['latitude'])
+ ##
+ # raised when user input couldn't be parsed
+ class APIBadUserInput < APIError
+ def initialize(message)
+ @message = message
+ end
- if m > 0
- frames.times do |n|
- if n == mm
- gc = highlightgc.dup
- else
- gc = linegc.dup
- end
+ def status
+ :bad_request
+ end
- gc.line(px, py, oldpx, oldpy)
+ def to_s
+ @message
+ end
+ end
- gc.draw(images[n])
- end
- end
+ ##
+ # raised when bounding box is invalid
+ class APIBadBoundingBox < APIError
+ def initialize(message)
+ @message = message
+ end
- m += 1
- if m > num_points.to_f / frames.to_f * (mm+1)
- mm += 1
- end
+ def status
+ :bad_request
+ end
- oldpy = py
- oldpx = px
- end
+ def to_s
+ @message
+ end
+ end
- il = Magick::ImageList.new
+ ##
+ # 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
+ end
- images.each do |f|
- il << f
- end
+ def status
+ :method_not_allowed
+ end
- il.delay = 50
- il.format = 'GIF'
+ def to_s
+ "Only method #{@supported_method} is supported on this URI"
+ end
+ end
- return il.to_blob
+ ##
+ # raised when an API call takes too long
+ class APITimeoutError < APIError
+ def status
+ :request_timeout
end
- def get_icon(min_lat, min_lon, max_lat, max_lon)
- #puts "getting icon for bbox #{min_lat},#{min_lon} - #{max_lat},#{max_lon}"
- width = 50
- height = 50
- proj = OSM::Mercator.new(min_lat, min_lon, max_lat, max_lon, width, height)
+ def to_s
+ "Request timed out"
+ end
+ end
- gc = Magick::Draw.new
- gc.stroke_linejoin('miter')
- gc.stroke_width(1)
- gc.stroke('#000000')
- gc.fill('#000000')
+ ##
+ # 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
- image = Magick::Image.new(width, height) do |image|
- image.background_color = 'white'
- image.format = 'GIF'
- end
+ def to_s
+ "Cannot redact current version of element, only historical versions may be redacted."
+ end
+ end
+
+ # Helper methods for going to/from mercator and lat/lng.
+ class Mercator
+ include Math
+
+ #init me with your bounding box and the size of your image
+ def initialize(min_lat, min_lon, max_lat, max_lon, width, height)
+ xsize = xsheet(max_lon) - xsheet(min_lon)
+ ysize = ysheet(max_lat) - ysheet(min_lat)
+ xscale = xsize / width
+ yscale = ysize / height
+ scale = [xscale, yscale].max
- oldpx = 0.0
- oldpy = 0.0
+ xpad = width * scale - xsize
+ ypad = height * scale - ysize
- first = true
+ @width = width
+ @height = height
- points do |p|
- px = proj.x(p['longitude'])
- py = proj.y(p['latitude'])
+ @tx = xsheet(min_lon) - xpad / 2
+ @ty = ysheet(min_lat) - ypad / 2
- gc.dup.line(px, py, oldpx, oldpy).draw(image) unless first
+ @bx = xsheet(max_lon) + xpad / 2
+ @by = ysheet(max_lat) + ypad / 2
+ end
- first = false
- oldpy = py
- oldpx = px
- end
+ #the following two functions will give you the x/y on the entire sheet
- return image.to_blob
+ def ysheet(lat)
+ log(tan(PI / 4 + (lat * PI / 180 / 2))) / (PI / 180)
+ end
+
+ def xsheet(lon)
+ lon
end
+ #and these two will give you the right points on your image. all the constants can be reduced to speed things up. FIXME
+
+ def y(lat)
+ return @height - ((ysheet(lat) - @ty) / (@by - @ty) * @height)
+ end
+
+ def x(lon)
+ return ((xsheet(lon) - @tx) / (@bx - @tx) * @width)
+ end
end
class GreatCircle
# 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
+
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
def initialize(feed_title='OpenStreetMap GPS Traces', feed_description='OpenStreetMap GPS Traces', feed_url='http://www.openstreetmap.org/traces/')
@doc = XML::Document.new
- @doc.encoding = 'UTF-8'
+ @doc.encoding = XML::Encoding::UTF_8
rss = XML::Node.new 'rss'
@doc.root = rss
class API
def get_xml_doc
doc = XML::Document.new
- doc.encoding = 'UTF-8'
+ doc.encoding = XML::Encoding::UTF_8
root = XML::Node.new 'osm'
- root['version'] = API_VERSION
- root['generator'] = 'OpenStreetMap server'
+ root['version'] = API_VERSION.to_s
+ root['generator'] = GENERATOR
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"
- Net::HTTP.start('ws.geonames.org') do |http|
- xml = REXML::Document.new(http.get("/countryInfo?country=#{country}").body)
- xml.elements.each("geonames/country") do |ele|
- minlon = ele.get_text("bBoxWest").to_s
- minlat = ele.get_text("bBoxSouth").to_s
- maxlon = ele.get_text("bBoxEast").to_s
- maxlat = ele.get_text("bBoxNorth").to_s
- return { :minlon => minlon, :minlat => minlat, :maxlon => maxlon, :maxlat => maxlat }
- end
+ 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
+
+ return country.upcase
end
return nil
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
+
# Construct a random token of a given length
def self.make_token(length = 30)
chars = 'abcdefghijklmnopqrtuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'
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
-
- return "#{tilesql} AND #{prefix}latitude BETWEEN #{minlat} AND #{maxlat} AND #{prefix}longitude BETWEEN #{minlon} AND #{maxlon}"
- end
+ 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 #{bbox.min_lat} AND #{bbox.max_lat} " +
+ "AND #{prefix}longitude BETWEEN #{bbox.min_lon} AND #{bbox.max_lon}"
+ 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