Added better error messages on 412 precondition failed.

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

diff --git a/app/models/way.rb b/app/models/way.rb
index 3bc8bcebec9f7b99b7c318d594a18d2307556260..cbbe6ada41f540eca762b22786e6e6aa45da362f 100644 (file)
--- a/app/models/way.rb
+++ b/app/models/way.rb
@@ -1,9 +1,11 @@
 class Way < ActiveRecord::Base
   require 'xml/libxml'
 class Way < ActiveRecord::Base
   require 'xml/libxml'

+  
+  include ConsistencyValidations

 
   set_table_name 'current_ways'
 
   set_table_name 'current_ways'

-
-  belongs_to :user
+  
+  belongs_to :changeset

 
   has_many :old_ways, :foreign_key => 'id', :order => 'version'
 
 
   has_many :old_ways, :foreign_key => 'id', :order => 'version'
 


@@ -15,17 +17,24 @@ class Way < 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 :changeset_id,:version,  :timestamp
+  validates_uniqueness_of :id
+  validates_inclusion_of :visible, :in => [ true, false ]
+  validates_numericality_of :changeset_id, :version, :integer_only => true
+  validates_numericality_of :id, :on => :update, :integer_only => true
+  validates_associated :changeset
+

   def self.from_xml(xml, create=false)
     begin
   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/way').each do |pt|
       doc = p.parse
 
       doc.find('//osm/way').each do |pt|

-       return Way.from_xml_node(pt, create)
+        return Way.from_xml_node(pt, create)

       end
       end

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

     end
   end
 
     end
   end
 


@@ -37,14 +46,19 @@ class Way < ActiveRecord::Base
     end
     
     way.version = pt['version']
     end
     
     way.version = pt['version']

+    raise OSM::APIBadXMLError.new("node", pt, "Changeset is required") if pt['changeset'].nil?
+    way.changeset_id = pt['changeset']

 
 

+    # This next section isn't required for the create, update, or delete of ways

     if create
     if create

-      way.timestamp = Time.now
+      way.timestamp = Time.now.getutc

       way.visible = true
     else
       if pt['timestamp']
       way.visible = true
     else
       if pt['timestamp']

-       way.timestamp = Time.parse(pt['timestamp'])
+        way.timestamp = Time.parse(pt['timestamp'])

       end
       end

+      # if visible isn't present then it defaults to true
+      way.visible = (pt['visible'] or true)

     end
 
     pt.find('tag').each do |tag|
     end
 
     pt.find('tag').each do |tag|


@@ -81,18 +95,22 @@ class Way < ActiveRecord::Base
     el1['visible'] = self.visible.to_s
     el1['timestamp'] = self.timestamp.xmlschema
     el1['version'] = self.version.to_s
     el1['visible'] = self.visible.to_s
     el1['timestamp'] = self.timestamp.xmlschema
     el1['version'] = self.version.to_s

+    el1['changeset'] = self.changeset_id.to_s

 
     user_display_name_cache = {} if user_display_name_cache.nil?
 
 
     user_display_name_cache = {} if user_display_name_cache.nil?
 

-    if user_display_name_cache and user_display_name_cache.key?(self.user_id)
+    if user_display_name_cache and user_display_name_cache.key?(self.changeset.user_id)

       # use the cache if available
       # use the cache if available

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

     else
     else

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

     end
 
     end
 

-    el1['user'] = user_display_name_cache[self.user_id] unless user_display_name_cache[self.user_id].nil?
+    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
+    end

 
     # make sure nodes are output in sequence_id order
     ordered_nodes = []
 
     # make sure nodes are output in sequence_id order
     ordered_nodes = []


@@ -104,7 +122,7 @@ class Way < ActiveRecord::Base
         end
       else
         # otherwise, manually go to the db to check things
         end
       else
         # otherwise, manually go to the db to check things

-        if nd.node.visible? and nd.node.visible?
+        if nd.node and nd.node.visible?

           ordered_nodes[nd.sequence_id] = nd.node_id.to_s
         end
       end
           ordered_nodes[nd.sequence_id] = nd.node_id.to_s
         end
       end


@@ -162,109 +180,86 @@ class Way < ActiveRecord::Base
 
   def add_tag_keyval(k, v)
     @tags = Hash.new unless @tags
 
   def add_tag_keyval(k, v)
     @tags = Hash.new unless @tags

-    @tags[k] = v
-  end

 
 

-  def save_with_history!
-    t = Time.now
-
-    Way.transaction do
-      self.version += 1
-      self.timestamp = t
-      self.save!
+    # duplicate tags are now forbidden, so we can't allow values
+    # in the hash to be overwritten.
+    raise OSM::APIDuplicateTagsError.new("way", self.id, k) if @tags.include? k

 
 

-      tags = self.tags
-      WayTag.delete_all(['id = ?', self.id])
-      tags.each do |k,v|
-        tag = WayTag.new
-        tag.k = k
-        tag.v = v
-        tag.id = self.id
-        tag.save!
-      end
+    @tags[k] = v
+  end

 
 

-      nds = self.nds
-      WayNode.delete_all(['id = ?', self.id])
-      sequence = 1
-      nds.each do |n|
-        nd = WayNode.new
-        nd.id = [self.id, sequence]
-        nd.node_id = n
-        nd.save!
-        sequence += 1
-      end
+  ##
+  # the integer coords (i.e: unscaled) bounding box of the way, assuming
+  # straight line segments.
+  def bbox
+    lons = nodes.collect { |n| n.longitude }
+    lats = nodes.collect { |n| n.latitude }
+    [ lons.min, lats.min, lons.max, lats.max ]
+  end

 
 

-      old_way = OldWay.from_way(self)
-      old_way.timestamp = t
-      old_way.save_with_dependencies!
+  def update_from(new_way, user)
+    check_consistency(self, new_way, user)
+    unless new_way.preconditions_ok?
+      raise OSM::APIPreconditionFailedError("Cannot update way #{self.id}: data is invalid.")

     end
     end

+
+    self.changeset_id = new_way.changeset_id
+    self.changeset = new_way.changeset
+    self.tags = new_way.tags
+    self.nds = new_way.nds
+    self.visible = true
+    save_with_history!

   end
 
   end
 

-  def update_from(new_way, user)
-    if !new_way.preconditions_ok?
-      raise OSM::APIPreconditionFailedError.new
-    elsif new_way.version != version
-      raise OSM::APIVersionMismatchError.new(new_way.version, version)
-    else
-      self.user_id = user.id
-      self.tags = new_way.tags
-      self.nds = new_way.nds
-      self.visible = true
-      save_with_history!
+  def create_with_history(user)
+    check_create_consistency(self, user)
+    unless self.preconditions_ok?
+      raise OSM::APIPreconditionFailedError("Cannot create way: data is invalid.")

     end
     end

+    self.version = 0
+    self.visible = true
+    save_with_history!

   end
 
   def preconditions_ok?
     return false if self.nds.empty?
   end
 
   def preconditions_ok?
     return false if self.nds.empty?

+    if self.nds.length > APP_CONFIG['max_number_of_way_nodes']
+      raise OSM::APITooManyWayNodesError.new(self.nds.count, APP_CONFIG['max_number_of_way_nodes'])
+    end

     self.nds.each do |n|
       node = Node.find(:first, :conditions => ["id = ?", n])
       unless node and node.visible
     self.nds.each do |n|
       node = Node.find(:first, :conditions => ["id = ?", n])
       unless node and node.visible

-        return false
+        raise OSM::APIPreconditionFailedError.new("The node with id #{n} either does not exist, or is not visible")

       end
     end
     return true
   end
 
       end
     end
     return true
   end
 

-  def delete_with_history(user)
-    if self.visible
-         # FIXME
-         # this should actually delete the relations,
-         # not just throw a PreconditionFailed if it's a member of a relation!!
-
-      # FIXME: this should probably renamed to delete_with_history
+  def delete_with_history!(new_way, user)
+    unless self.visible
+      raise OSM::APIAlreadyDeletedError
+    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.
+    Way.transaction do
+      check_consistency(self, new_way, user)

       if RelationMember.find(:first, :joins => "INNER JOIN current_relations ON current_relations.id=current_relation_members.id",
       if RelationMember.find(:first, :joins => "INNER JOIN current_relations ON current_relations.id=current_relation_members.id",

-                             :conditions => [ "visible = 1 AND member_type='way' and member_id=?", self.id])
-        raise OSM::APIPreconditionFailedError
-      # end FIXME
+                             :conditions => [ "visible = ? AND member_type='Way' and member_id=? ", true, self.id])
+        raise OSM::APIPreconditionFailedError.new("You need to make sure that this way is not a member of a relation.")

       else
       else

-        self.user_id = user.id
+        self.changeset_id = new_way.changeset_id
+        self.changeset = new_way.changeset
+

         self.tags = []
         self.nds = []
         self.visible = false
         self.tags = []
         self.nds = []
         self.visible = false

-        self.save_with_history!
+        save_with_history!

       end
       end

-    else
-      raise OSM::APIAlreadyDeletedError

     end
   end
 
     end
   end
 

-  # delete a way and it's nodes that aren't part of other ways, with history
-
-  # FIXME: merge the potlatch code to delete the relations
-  def delete_with_relations_and_nodes_and_history(user)
-    # delete the nodes not used by other ways
-    self.unshared_node_ids.each do |node_id|
-      n = Node.find(node_id)
-      n.user_id = user.id
-      n.visible = false
-      n.save_with_history!
-    end
-    
-    self.user_id = user.id
-
-    self.delete_with_history(user)
-  end
-

   # Find nodes that belong to this way only
   def unshared_node_ids
     node_ids = self.nodes.collect { |node| node.id }
   # Find nodes that belong to this way only
   def unshared_node_ids
     node_ids = self.nodes.collect { |node| node.id }


@@ -281,4 +276,78 @@ class Way < ActiveRecord::Base
   def tags_as_hash
     return self.tags
   end
   def tags_as_hash
     return self.tags
   end

+
+  ##
+  # if any referenced nodes are placeholder IDs (i.e: are negative) then
+  # this calling this method will fix them using the map from placeholders 
+  # to IDs +id_map+. 
+  def fix_placeholders!(id_map)
+    self.nds.map! do |node_id|
+      if node_id < 0
+        new_id = id_map[:node][node_id]
+        raise "invalid placeholder for #{node_id.inspect}: #{new_id.inspect}" if new_id.nil?
+        new_id
+      else
+        node_id
+      end
+    end
+  end
+
+  private
+  
+  def save_with_history!
+    t = Time.now.getutc
+
+    # update the bounding box, note that this has to be done both before 
+    # and after the save, so that nodes from both versions are included in the 
+    # bbox. we use a copy of the changeset so that it isn't reloaded
+    # later in the save.
+    cs = self.changeset
+    cs.update_bbox!(bbox) unless nodes.empty?
+
+    Way.transaction do
+      self.version += 1
+      self.timestamp = t
+      self.save!
+
+      tags = self.tags
+      WayTag.delete_all(['id = ?', self.id])
+      tags.each do |k,v|
+        tag = WayTag.new
+        tag.k = k
+        tag.v = v
+        tag.id = self.id
+        tag.save!
+      end
+
+      nds = self.nds
+      WayNode.delete_all(['id = ?', self.id])
+      sequence = 1
+      nds.each do |n|
+        nd = WayNode.new
+        nd.id = [self.id, sequence]
+        nd.node_id = n
+        nd.save!
+        sequence += 1
+      end
+
+      old_way = OldWay.from_way(self)
+      old_way.timestamp = t
+      old_way.save_with_dependencies!
+
+      # reload the way so that the nodes array points to the correct
+      # new set of nodes.
+      self.reload
+
+      # update and commit the bounding box, now that way nodes 
+      # have been updated and we're in a transaction.
+      cs.update_bbox!(bbox) unless nodes.empty?
+
+      # tell the changeset we updated one element only
+      cs.add_changes! 1
+
+      cs.save!
+    end
+  end
+

 end
 end