Using an around_handler for catching and rendering errors in most of the API controll...

[rails.git] / app / models / node.rb

diff --git a/app/models/node.rb b/app/models/node.rb
index 391b50dcda335b4cb7ddb1e54cce2ccad1775b51..e37a10250d06e07ea4310bfa7c95d5a28997ccbc 100644 (file)
--- a/app/models/node.rb
+++ b/app/models/node.rb
@@ -6,11 +6,6 @@ class Node < ActiveRecord::Base
 
   set_table_name 'current_nodes'
 
 
   set_table_name 'current_nodes'
 

-  validates_presence_of :changeset_id, :timestamp
-  validates_inclusion_of :visible, :in => [ true, false ]
-  validates_numericality_of :latitude, :longitude
-  validate :validate_position
-

   belongs_to :changeset
 
   has_many :old_nodes, :foreign_key => :id
   belongs_to :changeset
 
   has_many :old_nodes, :foreign_key => :id


@@ -26,6 +21,15 @@ class Node < ActiveRecord::Base
   has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
   has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation, :extend => ObjectFinder
 
   has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
   has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation, :extend => ObjectFinder
 

+  validates_presence_of :id, :on => :update
+  validates_presence_of :timestamp,:version,  :changeset_id
+  validates_uniqueness_of :id
+  validates_inclusion_of :visible, :in => [ true, false ]
+  validates_numericality_of :latitude, :longitude, :changeset_id, :version, :integer_only => true
+  validates_numericality_of :id, :on => :update, :integer_only => true
+  validate :validate_position
+  validates_associated :changeset
+

   # Sanity check the latitude and longitude and add an error if it's broken
   def validate_position
     errors.add_to_base("Node is not in the world") unless in_world?
   # Sanity check the latitude and longitude and add an error if it's broken
   def validate_position
     errors.add_to_base("Node is not in the world") unless in_world?


@@ -60,29 +64,31 @@ class Node < ActiveRecord::Base
   # Read in xml as text and return it's Node object representation
   def self.from_xml(xml, create=false)
     begin
   # Read in xml as text and return it's Node object representation
   def self.from_xml(xml, create=false)
     begin

-      p = XML::Parser.new
-      p.string = xml
+      p = XML::Parser.string(xml)

       doc = p.parse
 
       doc.find('//osm/node').each do |pt|
         return Node.from_xml_node(pt, create)
       end
       doc = p.parse
 
       doc.find('//osm/node').each do |pt|
         return Node.from_xml_node(pt, create)
       end

-    rescue
-      return nil
+    rescue LibXML::XML::Error, ArgumentError => ex
+      raise OSM::APIBadXMLError.new("node", xml, ex.message)

     end
   end
 
   def self.from_xml_node(pt, create=false)
     node = Node.new
     
     end
   end
 
   def self.from_xml_node(pt, create=false)
     node = Node.new
     

+    raise OSM::APIBadXMLError.new("node", pt, "lat missing") if pt['lat'].nil?
+    raise OSM::APIBadXMLError.new("node", pt, "lon missing") if pt['lon'].nil?

     node.lat = pt['lat'].to_f
     node.lon = pt['lon'].to_f
     node.lat = pt['lat'].to_f
     node.lon = pt['lon'].to_f

+    raise OSM::APIBadXMLError.new("node", pt, "changeset id missing") if pt['changeset'].nil?

     node.changeset_id = pt['changeset'].to_i
 
     node.changeset_id = pt['changeset'].to_i
 

-    return nil unless node.in_world?
+    raise OSM::APIBadUserInput.new("The node is outside this world") unless node.in_world?

 
     # version must be present unless creating
 
     # version must be present unless creating

-    return nil unless create or not pt['version'].nil?
+    raise OSM::APIBadXMLError.new("node", pt, "Version is required when updating") unless create or not pt['version'].nil?

     node.version = create ? 0 : pt['version'].to_i
 
     unless create
     node.version = create ? 0 : pt['version'].to_i
 
     unless create


@@ -93,15 +99,10 @@ class Node < ActiveRecord::Base
 
     # visible if it says it is, or as the default if the attribute
     # is missing.
 
     # visible if it says it is, or as the default if the attribute
     # is missing.

-    node.visible = pt['visible'].nil? or pt['visible'] == 'true'
+    # Don't need to set the visibility, when it is set explicitly in the create/update/delete
+    #node.visible = pt['visible'].nil? or pt['visible'] == 'true'

 
 

-    if create
-      node.timestamp = Time.now
-    else
-      if pt['timestamp']
-        node.timestamp = Time.parse(pt['timestamp'])
-      end
-    end
+    # We don't care about the time, as it is explicitly set on create/update/delete

 
     tags = []
 
 
     tags = []
 


@@ -113,75 +114,58 @@ class Node < ActiveRecord::Base
   end
 
   ##
   end
 
   ##

-  # the bounding box around a node
+  # the bounding box around a node, which is used for determining the changeset's
+  # bounding box

   def bbox
     [ longitude, latitude, longitude, latitude ]
   end
 
   def bbox
     [ longitude, latitude, longitude, latitude ]
   end
 

-  def save_with_history!
-    t = Time.now
-    Node.transaction do
-      self.version += 1
-      self.timestamp = t
-      self.save!
-
-      # Create a NodeTag
-      tags = self.tags
-      NodeTag.delete_all(['id = ?', self.id])
-      tags.each do |k,v|
-        tag = NodeTag.new
-        tag.k = k 
-        tag.v = v 
-        tag.id = self.id
-        tag.save!
-      end 
-
-      # Create an OldNode
-      old_node = OldNode.from_node(self)
-      old_node.timestamp = t
-      old_node.save_with_dependencies!
-
-      # save the changeset in case of bounding box updates
-      changeset.save!
-    end
-  end
-

   # Should probably be renamed delete_from to come in line with update
   def delete_with_history!(new_node, user)
   # Should probably be renamed delete_from to come in line with update
   def delete_with_history!(new_node, user)

-    if self.visible
+    unless self.visible
+      raise OSM::APIAlreadyDeletedError.new("node", new_node.id)
+    end
+
+    # need to start the transaction here, so that the database can 
+    # provide repeatable reads for the used-by checks. this means it
+    # shouldn't be possible to get race conditions.
+    Node.transaction do

       check_consistency(self, new_node, user)
       check_consistency(self, new_node, user)

-      if WayNode.find(:first, :joins => "INNER JOIN current_ways ON current_ways.id = current_way_nodes.id", :conditions => [ "current_ways.visible = ? AND current_way_nodes.node_id = ?", true, self.id ])
-        raise OSM::APIPreconditionFailedError.new
-      elsif RelationMember.find(:first, :joins => "INNER JOIN current_relations ON current_relations.id=current_relation_members.id", :conditions => [ "visible = ? AND member_type='node' and member_id=? ", true, self.id])
-        raise OSM::APIPreconditionFailedError.new
-      else
-        self.changeset_id = new_node.changeset_id
-        self.visible = false
-
-        # update the changeset with the deleted position
-        changeset.update_bbox!(bbox)
-
-        save_with_history!
-      end
-    else
-      raise OSM::APIAlreadyDeletedError.new
+      way = WayNode.find(:first, :joins => :way, 
+                         :conditions => [ "current_ways.visible = ? AND current_way_nodes.node_id = ?", true, self.id ])
+      raise OSM::APIPreconditionFailedError.new("Node #{self.id} is still used by way #{way.way.id}.") unless way.nil?
+      
+      rel = RelationMember.find(:first, :joins => :relation, 
+                                :conditions => [ "visible = ? AND member_type='Node' and member_id=? ", true, self.id])
+      raise OSM::APIPreconditionFailedError.new("Node #{self.id} is still used by relation #{rel.relation.id}.") unless rel.nil?
+
+      self.changeset_id = new_node.changeset_id
+      self.visible = false
+      
+      # update the changeset with the deleted position
+      changeset.update_bbox!(bbox)
+      
+      save_with_history!

     end
   end
 
   def update_from(new_node, user)
     check_consistency(self, new_node, user)
 
     end
   end
 
   def update_from(new_node, user)
     check_consistency(self, new_node, user)
 

-    # update changeset with *old* position first
+    # update changeset first
+    self.changeset_id = new_node.changeset_id
+    self.changeset = new_node.changeset
+
+    # update changeset bbox with *old* position first

     changeset.update_bbox!(bbox);
 
     # FIXME logic needs to be double checked
     changeset.update_bbox!(bbox);
 
     # FIXME logic needs to be double checked

-    self.changeset_id = new_node.changeset_id

     self.latitude = new_node.latitude 
     self.longitude = new_node.longitude
     self.tags = new_node.tags
     self.visible = true
 
     self.latitude = new_node.latitude 
     self.longitude = new_node.longitude
     self.tags = new_node.tags
     self.visible = true
 

-    # update changeset with *new* position
+    # update changeset bbox with *new* position

     changeset.update_bbox!(bbox);
 
     save_with_history!
     changeset.update_bbox!(bbox);
 
     save_with_history!


@@ -204,27 +188,33 @@ class Node < ActiveRecord::Base
     return doc
   end
 
     return doc
   end
 

-  def to_xml_node(user_display_name_cache = nil)
+  def to_xml_node(changeset_cache = {}, user_display_name_cache = {})

     el1 = XML::Node.new 'node'
     el1['id'] = self.id.to_s
     el1['lat'] = self.lat.to_s
     el1['lon'] = self.lon.to_s
     el1['version'] = self.version.to_s
     el1['changeset'] = self.changeset_id.to_s
     el1 = XML::Node.new 'node'
     el1['id'] = self.id.to_s
     el1['lat'] = self.lat.to_s
     el1['lon'] = self.lon.to_s
     el1['version'] = self.version.to_s
     el1['changeset'] = self.changeset_id.to_s

-    
-    user_display_name_cache = {} if user_display_name_cache.nil?

 
 

-    if user_display_name_cache and user_display_name_cache.key?(self.changeset.user_id)
+    if changeset_cache.key?(self.changeset_id)
+      # use the cache if available
+    else
+      changeset_cache[self.changeset_id] = self.changeset.user_id
+    end
+
+    user_id = changeset_cache[self.changeset_id]
+
+    if user_display_name_cache.key?(user_id)

       # use the cache if available
     elsif self.changeset.user.data_public?
       # use the cache if available
     elsif self.changeset.user.data_public?

-      user_display_name_cache[self.changeset.user_id] = self.changeset.user.display_name
+      user_display_name_cache[user_id] = self.changeset.user.display_name

     else
     else

-      user_display_name_cache[self.changeset.user_id] = nil
+      user_display_name_cache[user_id] = nil

     end
 
     end
 

-    if not user_display_name_cache[self.changeset.user_id].nil?
-      el1['user'] = user_display_name_cache[self.changeset.user_id]
-      el1['uid'] = self.changeset.user_id.to_s
+    if not user_display_name_cache[user_id].nil?
+      el1['user'] = user_display_name_cache[user_id]
+      el1['uid'] = user_id.to_s

     end
 
     self.tags.each do |k,v|
     end
 
     self.tags.each do |k,v|


@@ -262,16 +252,56 @@ class Node < ActiveRecord::Base
 
     # duplicate tags are now forbidden, so we can't allow values
     # in the hash to be overwritten.
 
     # duplicate tags are now forbidden, so we can't allow values
     # in the hash to be overwritten.

-    raise OSM::APIDuplicateTagsError.new if @tags.include? k
+    raise OSM::APIDuplicateTagsError.new("node", self.id, k) if @tags.include? k

 
     @tags[k] = v
   end
 
 
     @tags[k] = v
   end
 

+  ##
+  # are the preconditions OK? this is mainly here to keep the duck
+  # typing interface the same between nodes, ways and relations.
+  def preconditions_ok?
+    in_world?
+  end
+

   ##
   # dummy method to make the interfaces of node, way and relation
   # more consistent.
   ##
   # dummy method to make the interfaces of node, way and relation
   # more consistent.

-  def fix_placeholders!(id_map)
+  def fix_placeholders!(id_map, placeholder_id = nil)

     # nodes don't refer to anything, so there is nothing to do here
   end
     # nodes don't refer to anything, so there is nothing to do here
   end

+  
+  private
+
+  def save_with_history!
+    t = Time.now.getutc
+    Node.transaction do
+      self.version += 1
+      self.timestamp = t
+      self.save!

 
 

+      # Create a NodeTag
+      tags = self.tags
+      NodeTag.delete_all(['id = ?', self.id])
+      tags.each do |k,v|
+        tag = NodeTag.new
+        tag.k = k 
+        tag.v = v 
+        tag.id = self.id
+        tag.save!
+      end 
+
+      # Create an OldNode
+      old_node = OldNode.from_node(self)
+      old_node.timestamp = t
+      old_node.save_with_dependencies!
+
+      # tell the changeset we updated one element only
+      changeset.add_changes! 1
+
+      # save the changeset in case of bounding box updates
+      changeset.save!
+    end
+  end
+  

 end
 end