X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/eada120ffac9f6b6ecb3db1fe1c4397cb6c0bd44..56d39b06f2173c753a06fa64db8be1abdc43d01e:/lib/osm.rb?ds=inline diff --git a/lib/osm.rb b/lib/osm.rb index 57714c68e..daef8d3f0 100644 --- a/lib/osm.rb +++ b/lib/osm.rb @@ -1,332 +1,510 @@ +# The OSM module provides support functions for OSM. module OSM - # 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']} - require 'time' require 'rexml/parsers/sax2parser' require 'rexml/text' require 'xml/libxml' - require 'RMagick' - class Mercator - include Math + if defined?(SystemTimer) + Timer = SystemTimer + else + require 'timeout' + Timer = Timeout + end - def initialize(lat, lon, degrees_per_pixel, width, height) - #init me with your centre lat/lon, the number of degrees per pixel and the size of your image - @clat = lat - @clon = lon - @degrees_per_pixel = degrees_per_pixel - @width = width - @height = height - @dlon = width / 2 * degrees_per_pixel - @dlat = height / 2 * degrees_per_pixel * cos(@clat * PI / 180) + # The base class for API Errors. + class APIError < RuntimeError + def status + :internal_server_error + end - @tx = xsheet(@clon - @dlon) - @ty = ysheet(@clat - @dlat) + def to_s + "Generic API Error" + end + end - @bx = xsheet(@clon + @dlon) - @by = ysheet(@clat + @dlat) + # Raised when access is denied. + class APIAccessDenied < RuntimeError + def status + :forbidden + end + def to_s + "Access denied" end + end - #the following two functions will give you the x/y on the entire sheet + # Raised when an API object is not found. + class APINotFoundError < APIError + def status + :not_found + end - def kilometerinpixels - return 40008.0 / 360.0 * @degrees_per_pixel + def to_s + "Object not found" end + end - def ysheet(lat) - log(tan(PI / 4 + (lat * PI / 180 / 2))) + # Raised when a precondition to an API action fails sanity check. + class APIPreconditionFailedError < APIError + def initialize(message = "") + @message = message end - def xsheet(lon) - lon + def status + :precondition_failed 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 to_s + "Precondition failed: #{@message}" + end + end - def y(lat) - return @height - ((ysheet(lat) - @ty) / (@by - @ty) * @height) + # Raised when to delete an already-deleted object. + class APIAlreadyDeletedError < APIError + def initialize(object = "object", object_id = "") + @object, @object_id = object, object_id end - def x(lon) - return ((xsheet(lon) - @tx) / (@bx - @tx) * @width) + 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 user logged in isn't the same as the changeset + class APIUserChangesetMismatchError < APIError + def status + :conflict + end - class GPXImporter - # FIXME swap REXML for libXML - attr_reader :possible_points - attr_reader :actual_points - attr_reader :tracksegs + def to_s + "The user doesn't own that changeset" + end + end - def initialize(filename) - @possible_points = 0 - @actual_points = 0 - @tracksegs = 0 - @points = [] + # Raised when the changeset provided is already closed + class APIChangesetAlreadyClosedError < APIError + def initialize(changeset) + @changeset = changeset + end - file = File.new(filename) - parser = REXML::Parsers::SAX2Parser.new( file ) + attr_reader :changeset - lat = -1 - lon = -1 - ele = -1 - date = Time.now(); - gotlatlon = false - gotele = false - gotdate = false + def status + :conflict + end - parser.listen( :start_element, %w{ trkpt }) do |uri,localname,qname,attributes| - lat = attributes['lat'].to_f - lon = attributes['lon'].to_f - gotlatlon = true - @possible_points += 1 - end + def to_s + "The changeset #{@changeset.id} was closed at #{@changeset.closed_at}" + end + end - parser.listen( :characters, %w{ ele } ) do |text| - ele = text - gotele = true - end + # Raised when a change is expecting a changeset, but the changeset doesn't exist + class APIChangesetMissingError < APIError + def status + :conflict + end - parser.listen( :characters, %w{ time } ) do |text| - if text && text != '' - date = Time.parse(text) - gotdate = true - end - end + def to_s + "You need to supply a changeset to be able to make a change" + end + end - parser.listen( :end_element, %w{ trkseg } ) do |uri, localname, qname| - @tracksegs += 1 - end + # 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 - 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 - @points.push(Hash['latitude' => lat,'longitude' => lon,'timestamp' => date,'altitude' => ele,'segment' => @tracksegs]) - end - end - gotlatlon = false - gotele = false - gotdate = false - end - parser.parse + def status + :conflict + end + + def to_s + "Changeset mismatch: Provided #{@provided} but only #{@allowed} is allowed" end + end - def points - @points.each { |p| yield p } + # 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 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 - rat= Math.cos( ((max_lat + min_lat)/2.0) / 180.0 * 3.141592) - proj = OSM::Mercator.new((min_lat + max_lat) / 2, (max_lon + min_lon) / 2, (max_lat - min_lat) / width / rat, width, height) + def status + :bad_request + end - images = [] + def to_s + "Unknown action #{@provided}, choices are create, modify, delete" + end + end - frames.times do - gc = Magick::Draw.new - gc.stroke_linejoin('miter') - gc.stroke('#FFFFFF') - gc.fill('#FFFFFF') - gc.rectangle(0,0,width,height) - gc.stroke_width(1) - images << gc - 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 - oldpx = 0.0 - oldpy = 0.0 - - first = true - - m = 0 - mm = 0 - points do |p| - px = proj.x(p['longitude']) - py = proj.y(p['latitude']) - frames.times do |n| - images[n].stroke_width(1) - images[n].stroke('#BBBBBB') - images[n].fill('#BBBBBB') - # puts "A #{px},#{py} - #{oldpx},#{oldpy}" - images[n].line(px, py, oldpx, oldpy ) unless first - end - images[mm].stroke_width(3) - images[mm].stroke('#000000') - images[mm].fill('#000000') - images[mm].line(px, py, oldpx, oldpy ) unless first - # puts "B #{px},#{py} - #{oldpx},#{oldpy}" - m +=1 - if m > num_points.to_f / frames.to_f * (mm+1) - mm += 1 - end - first = false - oldpy = py - oldpx = px - end + def status + :bad_request + end + + def to_s + "Cannot parse valid #{@model} from xml string #{@xml}. #{@message}" + end + end - il = Magick::ImageList.new + # 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 - frames.times do |n| - canvas = Magick::Image.new(width, height) { - self.background_color = 'white' - } - begin - images[n].draw(canvas) - rescue ArgumentError - end - canvas.format = 'GIF' - il << canvas - end + attr_reader :provided, :latest, :id, :type - il.delay = 50 - il.format = 'GIF' - return il.to_blob + def status + :conflict 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 - rat= Math.cos( ((max_lat + min_lat)/2.0) / 180.0 * 3.141592) - proj = OSM::Mercator.new((min_lat + max_lat) / 2, (max_lon + min_lon) / 2, (max_lat - min_lat) / width / rat, width, height) + def to_s + "Version mismatch: Provided #{provided}, server had: #{latest} of #{type} #{id}" + end + end - images = [] + # 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 - gc = Magick::Draw.new - gc.stroke_linejoin('miter') + attr_reader :type, :id, :tag_key - oldpx = 0.0 - oldpy = 0.0 + def status + :bad_request + end - first = true + def to_s + "Element #{@type}/#{@id} has duplicate tags with key #{@tag_key}" + end + end - gc.stroke_width(1) - gc.stroke('#000000') - gc.fill('#000000') + # 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 - points do |p| - px = proj.x(p['longitude']) - py = proj.y(p['latitude']) - gc.line(px, py, oldpx, oldpy ) unless first - # puts "C #{px},#{py} - #{oldpx},#{oldpy}" - first = false - oldpy = py - oldpx = px - end + 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 + + ## + # 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 + 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 + 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 + + # 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 + + xpad = width * scale - xsize + ypad = height * scale - ysize + + @width = width + @height = height + + @tx = xsheet(min_lon) - xpad / 2 + @ty = ysheet(min_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) + 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 + include Math + + # initialise with a base position + def initialize(lat, lon) + @lat = lat * PI / 180 + @lon = lon * PI / 180 + end + + # get the distance from the base position to a given position + def distance(lat, lon) + lat = lat * PI / 180 + lon = lon * PI / 180 + return 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 + def bounds(radius) + latradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2) ** 2)) - canvas = Magick::Image.new(width, height) { - self.background_color = 'white' - } begin - gc.draw(canvas) - rescue ArgumentError - end - canvas.format = 'GIF' - return canvas.to_blob - 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' - - rss = XML::Node.new 'rss' - @doc.root = rss - rss['version'] = "2.0" - rss['xmlns:geo'] = "http://www.w3.org/2003/01/geo/wgs84_pos#" - @channel = XML::Node.new 'channel' - rss << @channel - title = XML::Node.new 'title' - title << feed_title - @channel << title - description_el = XML::Node.new 'description' - @channel << description_el - - description_el << feed_description - link = XML::Node.new 'link' - link << feed_url - @channel << link - image = XML::Node.new 'image' - @channel << image - url = XML::Node.new 'url' - url << 'http://www.openstreetmap.org/feeds/mag_map-rss2.0.png' - image << url - title = XML::Node.new 'title' - title << "OpenStreetMap" - image << title - width = XML::Node.new 'width' - width << '100' - image << width - height = XML::Node.new 'height' - height << '100' - image << height - link = XML::Node.new 'link' - link << feed_url - image << link - end - - def add(latitude=0, longitude=0, title_text='dummy title', url='http://www.example.com/', description_text='dummy description', timestamp=Time.now) - item = XML::Node.new 'item' - - title = XML::Node.new 'title' - item << title - title << title_text - link = XML::Node.new 'link' - link << url - item << link - - description = XML::Node.new 'description' - description << description_text - item << description - - pubDate = XML::Node.new 'pubDate' - pubDate << timestamp.xmlschema - item << pubDate - - if latitude - lat_el = XML::Node.new 'geo:lat' - lat_el << latitude.to_s - item << lat_el if lat_el + lonradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2) ** 2 / cos(@lat) ** 2)) + rescue Errno::EDOM, Math::DomainError + lonradius = PI end - if longitude - lon_el = XML::Node.new 'geo:long' - lon_el << longitude.to_s - item << lon_el - end + minlat = (@lat - latradius) * 180 / PI + maxlat = (@lat + latradius) * 180 / PI + minlon = (@lon - lonradius) * 180 / PI + maxlon = (@lon + lonradius) * 180 / PI - @channel << item + return { :minlat => minlat, :maxlat => maxlat, :minlon => minlon, :maxlon => maxlon } end - def to_s - return @doc.to_s + # 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 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 + root['copyright'] = COPYRIGHT_OWNER + root['attribution'] = ATTRIBUTION_URL + root['license'] = LICENSE_URL doc.root = root return doc end 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 + rescue Exception + 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' + token = '' + + length.times do + token += chars[(rand * chars.length).to_i].chr + end + + return token + end + + # Return an SQL fragment to select a given area of the globe + 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