X-Git-Url: https://git.openstreetmap.org/rails.git/blobdiff_plain/86b4d1bc2c05a68053c7485217144a7fcf8ef4e8..4f6dc5568301dc878c20ef3a9039d31a95a99815:/lib/osm.rb?ds=sidebyside diff --git a/lib/osm.rb b/lib/osm.rb index a8cb103d2..4c99de2f1 100644 --- a/lib/osm.rb +++ b/lib/osm.rb @@ -10,266 +10,286 @@ module OSM # The base class for API Errors. class APIError < RuntimeError + 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 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 initialize(object = "object", object_id = "") + @object, @object_id = object, object_id + end + + 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 - # 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 + # Raised when the user logged in isn't the same as the changeset + class APIUserChangesetMismatchError < APIError + def status + :conflict end - attr_reader :provided, :latest + 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 + + # Raised when a change is expecting a changeset, but the changeset doesn't exist + class APIChangesetMissingError < APIError + def status + :conflict + end - @tx = xsheet(min_lon) - xpad / 2 - @ty = ysheet(min_lat) - ypad / 2 + def to_s + "You need to supply a changeset to be able to make a change" + end + end - @bx = xsheet(max_lon) + xpad / 2 - @by = ysheet(max_lat) + ypad / 2 + # 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 - #the following two functions will give you the x/y on the entire sheet + def status + :conflict + end - def ysheet(lat) - log(tan(PI / 4 + (lat * PI / 180 / 2))) / (PI / 180) + 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 end - def xsheet(lon) - lon + def status + :bad_request end + + def to_s + "Unknown action #{@provided}, choices are create, modify, delete" + 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 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 - 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 + "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. + class APIVersionMismatchError < APIError + def initialize(id, type, provided, latest) + @id, @type, @provided, @latest = id, type, provided, latest + 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 - - parser.listen( :characters, %w{ ele } ) do |text| - ele = text - gotele = true - end - - parser.listen( :characters, %w{ time } ) do |text| - if text && text != '' - begin - date = DateTime.parse(text) - gotdate = true - rescue - end - end - end + attr_reader :provided, :latest, :id, :type - parser.listen( :end_element, %w{ trkseg } ) do |uri, localname, qname| - @tracksegs += 1 - end + def status + :conflict + end - 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 to_s + "Version mismatch: Provided #{provided}, server had: #{latest} of #{type} #{id}" + end + end - parser.parse + # 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 - 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) + attr_reader :type, :id, :tag_key - linegc = Magick::Draw.new - linegc.stroke_linejoin('miter') - linegc.stroke_width(1) - linegc.stroke('#BBBBBB') - linegc.fill('#BBBBBB') + def status + :bad_request + end - highlightgc = Magick::Draw.new - highlightgc.stroke_linejoin('miter') - highlightgc.stroke_width(3) - highlightgc.stroke('#000000') - highlightgc.fill('#000000') + 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(provided, max) + @provided, @max = provided, max + end + + attr_reader :provided, :max - images = [] + def status + :bad_request + end + + def to_s + "You tried to add #{provided} nodes to the way, however only #{max} are allowed" + end + end - frames.times do - image = Magick::Image.new(width, height) do |image| - image.background_color = 'white' - image.format = 'GIF' - end + ## + # raised when user input couldn't be parsed + class APIBadUserInput < APIError + def initialize(message) + @message = message + end - images << image - end + def status + :bad_request + end - oldpx = 0.0 - oldpy = 0.0 + def to_s + @message + end + end - first = true + ## + # 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 - m = 0 - mm = 0 - points do |p| - px = proj.x(p['longitude']) - py = proj.y(p['latitude']) + def status + :method_not_allowed + end - if m > 0 - frames.times do |n| - if n == mm - gc = highlightgc.dup - else - gc = linegc.dup - end + def to_s + "Only method #{@supported_method} is supported on this URI" + end + end - gc.line(px, py, oldpx, oldpy) + ## + # raised when an API call takes too long + class APITimeoutError < APIError + def status + :request_timeout + end - gc.draw(images[n]) - end - end + def to_s + "Request timed out" + end + end - m += 1 - if m > num_points.to_f / frames.to_f * (mm+1) - mm += 1 - end + # Helper methods for going to/from mercator and lat/lng. + class Mercator + include Math - oldpy = py - oldpx = px - 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 - il = Magick::ImageList.new + xpad = width * scale - xsize + ypad = height * scale - ysize - images.each do |f| - il << f - end + @width = width + @height = height - il.delay = 50 - il.format = 'GIF' + @tx = xsheet(min_lon) - xpad / 2 + @ty = ysheet(min_lat) - ypad / 2 - return il.to_blob + @bx = xsheet(max_lon) + xpad / 2 + @by = ysheet(max_lat) + ypad / 2 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) - - gc = Magick::Draw.new - gc.stroke_linejoin('miter') - gc.stroke_width(1) - gc.stroke('#000000') - gc.fill('#000000') - - image = Magick::Image.new(width, height) do |image| - image.background_color = 'white' - image.format = 'GIF' - end - - oldpx = 0.0 - oldpy = 0.0 - - first = true + #the following two functions will give you the x/y on the entire sheet - points do |p| - px = proj.x(p['longitude']) - py = proj.y(p['latitude']) + def ysheet(lat) + log(tan(PI / 4 + (lat * PI / 180 / 2))) / (PI / 180) + end - gc.dup.line(px, py, oldpx, oldpy).draw(image) unless first + def xsheet(lon) + lon + end - first = false - oldpy = py - oldpx = px - end + #and these two will give you the right points on your image. all the constants can be reduced to speed things up. FIXME - return image.to_blob + 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 @@ -303,7 +323,7 @@ module OSM 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 @@ -389,10 +409,10 @@ module OSM 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['generator'] = GENERATOR doc.root = root return doc end @@ -403,16 +423,8 @@ module OSM 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 - end + country = Country.find_by_code(country) + return { :minlon => country.min_lon, :minlat => country.min_lat, :maxlon => country.max_lon, :maxlat => country.max_lat } end end