Modernise migrations

[rails.git] / lib / osm.rb

diff --git a/lib/osm.rb b/lib/osm.rb
index 5be2da56a13c050be1d395b18ecae458ed9a0d4d..502bc307a3fbb9ced0ade6cd6a5b94ec8300f840 100644 (file)
--- a/lib/osm.rb
+++ b/lib/osm.rb
@@ -1,12 +1,16 @@
 # The OSM module provides support functions for OSM.
 module OSM
 # The OSM module provides support functions for OSM.
 module OSM

-
-  require 'time'
-  require 'rexml/parsers/sax2parser'
-  require 'rexml/text'
-  require 'xml/libxml'
-  require 'digest/md5'
-  require 'RMagick'
+  require "time"
+  require "rexml/parsers/sax2parser"
+  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


@@ -19,6 +23,17 @@ module OSM
     end
   end
 
     end
   end
 

+  # Raised when access is denied.
+  class APIAccessDenied < RuntimeError
+    def status
+      :forbidden
+    end
+
+    def to_s
+      "Access denied"
+    end
+  end
+

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


@@ -37,7 +52,7 @@ module OSM
     end
 
     def status
     end
 
     def status

-      :precondition_failed    
+      :precondition_failed

     end
 
     def to_s
     end
 
     def to_s


@@ -48,15 +63,16 @@ module OSM
   # Raised when to delete an already-deleted object.
   class APIAlreadyDeletedError < APIError
     def initialize(object = "object", object_id = "")
   # Raised when to delete an already-deleted object.
   class APIAlreadyDeletedError < APIError
     def initialize(object = "object", object_id = "")

-      @object, @object_id = object, object_id
+      @object = object
+      @object_id = object_id

     end
     end

-    
+

     attr_reader :object, :object_id
 
     def status
       :gone
     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
     def to_s
       "The #{object} with the id #{object_id} has already been deleted"
     end


@@ -89,7 +105,58 @@ module OSM
       "The changeset #{@changeset.id} was closed at #{@changeset.closed_at}"
     end
   end
       "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
+
+    attr_reader :changeset
+
+    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
+
+    attr_reader :changeset
+
+    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
+
+    attr_reader :changeset
+
+    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
   # Raised when a change is expecting a changeset, but the changeset doesn't exist
   class APIChangesetMissingError < APIError
     def status


@@ -105,7 +172,8 @@ 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, @allowed = provided, allowed
+      @provided = provided
+      @allowed = allowed

     end
 
     def status
     end
 
     def status


@@ -116,7 +184,7 @@ module OSM
       "Changeset mismatch: Provided #{@provided} but only #{@allowed} is allowed"
     end
   end
       "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
   # Raised when a diff upload has an unknown action. You can only have create,
   # modify, or delete
   class APIChangesetActionInvalid < APIError


@@ -127,7 +195,7 @@ module OSM
     def status
       :bad_request
     end
     def status
       :bad_request
     end

-    
+

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


@@ -136,8 +204,10 @@ module OSM
   # Raised when bad XML is encountered which stops things parsing as
   # they should.
   class APIBadXMLError < APIError
   # 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
+    def initialize(model, xml, message = "")
+      @model = model
+      @xml = xml
+      @message = message

     end
 
     def status
     end
 
     def status


@@ -152,7 +222,10 @@ module OSM
   # Raised when the provided version is not equal to the latest in the db.
   class APIVersionMismatchError < APIError
     def initialize(id, type, provided, latest)
   # 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
+      @id = id
+      @type = type
+      @provided = provided
+      @latest = latest

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


@@ -170,7 +243,9 @@ module OSM
   # this is now forbidden by the API.
   class APIDuplicateTagsError < APIError
     def initialize(type, id, tag_key)
   # this is now forbidden by the API.
   class APIDuplicateTagsError < APIError
     def initialize(type, id, tag_key)

-      @type, @id, @tag_key = type, id, tag_key
+      @type = type
+      @id = id
+      @tag_key = tag_key

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


@@ -183,22 +258,24 @@ module OSM
       "Element #{@type}/#{@id} has duplicate tags with key #{@tag_key}"
     end
   end
       "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
   # 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
+    def initialize(id, provided, max)
+      @id = id
+      @provided = provided
+      @max = max

     end
     end

-    
-    attr_reader :provided, :max
+
+    attr_reader :id, :provided, :max

 
     def status
       :bad_request
     end
 
     def status
       :bad_request
     end

-    
+

     def to_s
     def to_s

-      "You tried to add #{provided} nodes to the way, however only #{max} are allowed"
+      "You tried to add #{provided} nodes to way #{id}, however only #{max} are allowed"

     end
   end
 
     end
   end
 


@@ -262,11 +339,75 @@ module OSM
     end
   end
 
     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
 
   # 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
+    # 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)
     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)


@@ -287,7 +428,7 @@ module OSM
       @by = ysheet(max_lat) + ypad / 2
     end
 
       @by = ysheet(max_lat) + ypad / 2
     end
 

-    #the following two functions will give you the x/y on the entire sheet
+    # 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)
 
     def ysheet(lat)
       log(tan(PI / 4 + (lat * PI / 180 / 2))) / (PI / 180)


@@ -297,14 +438,14 @@ module OSM
       lon
     end
 
       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
+    # 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)
 
     def y(lat)

-      return @height - ((ysheet(lat) - @ty) / (@by - @ty) * @height)
+      @height - ((ysheet(lat) - @ty) / (@by - @ty) * @height)

     end
 
     def x(lon)
     end
 
     def x(lon)

-      return  ((xsheet(lon) - @tx) / (@bx - @tx) * @width)
+      ((xsheet(lon) - @tx) / (@bx - @tx) * @width)

     end
   end
 
     end
   end
 


@@ -321,104 +462,30 @@ 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

-      return 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
     def bounds(radius)
     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))
-      lonradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2) ** 2 / cos(@lat) ** 2))
+      latradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2)**2))
+
+      begin
+        lonradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2)**2 / cos(@lat)**2))
+      rescue Errno::EDOM, Math::DomainError
+        lonradius = PI
+      end
+

       minlat = (@lat - latradius) * 180 / PI
       maxlat = (@lat + latradius) * 180 / PI
       minlon = (@lon - lonradius) * 180 / PI
       maxlon = (@lon + lonradius) * 180 / PI
       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
-  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 = XML::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/images/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', author_text='anonymous', url='http://www.example.com/', description_text='dummy description', timestamp=DateTime.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
-
-      guid = XML::Node.new 'guid'
-      guid << url
-      item << guid
-
-      description = XML::Node.new 'description'
-      description << description_text
-      item << description
-
-      author = XML::Node.new 'author'
-      author << author_text
-      item << author
-
-      pubDate = XML::Node.new 'pubDate'
-      pubDate << timestamp.to_s(:rfc822)
-      item << pubDate
-
-      if latitude
-        lat_el = XML::Node.new 'geo:lat'
-        lat_el << latitude.to_s
-        item << lat_el
-      end
-
-      if longitude
-        lon_el = XML::Node.new 'geo:long'
-        lon_el << longitude.to_s
-        item << lon_el
-      end

 
 

-      @channel << item
+      { :minlat => minlat, :maxlat => maxlat, :minlon => minlon, :maxlon => maxlon }

     end
 
     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
 
     end
   end
 


@@ -426,57 +493,88 @@ module OSM
     def get_xml_doc
       doc = XML::Document.new
       doc.encoding = XML::Encoding::UTF_8
     def get_xml_doc
       doc = XML::Document.new
       doc.encoding = XML::Encoding::UTF_8

-      root = XML::Node.new 'osm'
-      root['version'] = API_VERSION
-      root['generator'] = GENERATOR
+      root = XML::Node.new "osm"
+      root["version"] = API_VERSION.to_s
+      root["generator"] = GENERATOR
+      root["copyright"] = COPYRIGHT_OWNER
+      root["attribution"] = ATTRIBUTION_URL
+      root["license"] = LICENSE_URL

       doc.root = root
       doc.root = root

-      return doc
+      doc

     end
   end
 
     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
+  def self.ip_to_country(ip_address)
+    Timer.timeout(4) do
+      ipinfo = Quova::IpInfo.new(ip_address) if defined?(QUOVA_USERNAME)
+
+      if ipinfo && ipinfo.status == Quova::SUCCESS
+        country = ipinfo.country_code
+      else
+        country = http_client.get("http://api.hostip.info/country.php?ip=#{ip_address}").body

         country = "GB" if country == "UK"
         country = "GB" if country == "UK"

-        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

+
+      return country.upcase

     end
 
     return nil
     end
 
     return nil

-  rescue Exception
+  rescue StandardError

     return nil
   end
 
     return nil
   end
 

+  def self.ip_location(ip_address)
+    code = OSM.ip_to_country(ip_address)
+
+    if code && country = Country.find_by_code(code)
+      return { :minlon => country.min_lon, :minlat => country.min_lat, :maxlon => country.max_lon, :maxlat => country.max_lat }
+    end
+
+    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)
   # Construct a random token of a given length
   def self.make_token(length = 30)

-    chars = 'abcdefghijklmnopqrtuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'
-    token = ''
+    chars = "abcdefghijklmnopqrtuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
+    token = ""

 
     length.times do
       token += chars[(rand * chars.length).to_i].chr
     end
 
 
     length.times do
       token += chars[(rand * chars.length).to_i].chr
     end
 

-    return token
-  end
-
-  # Return an encrypted version of a password
-  def self.encrypt_password(password, salt)
-    return Digest::MD5.hexdigest(password) if salt.nil?
-    return Digest::MD5.hexdigest(salt + password)
+    token

   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

-  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
+  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 #{minlat} AND #{maxlat} AND #{prefix}longitude BETWEEN #{minlon} AND #{maxlon}"
+    "#{tilesql} AND #{prefix}latitude BETWEEN #{bbox.min_lat} AND #{bbox.max_lat} " +
+      "AND #{prefix}longitude BETWEEN #{bbox.min_lon} AND #{bbox.max_lon}"

   end
 
   end
 

+  # Return the terms and conditions text for a given country
+  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

 
 

+  # Return the HTTP client to use
+  def self.http_client
+    @http_client ||= Faraday.new
+  end
+
+  # Set the HTTP client to use
+  def self.http_client=(client)
+    @http_client = client
+  end

 end
 end