X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/509b8ec62adac85558c32ed51cbc11ec4b93d8c7..38b9f8f7927f09b32a94df87d1264f568f620480:/app/models/way.rb

diff --git a/app/models/way.rb b/app/models/way.rb
index 958944200..e78d0df0b 100644
--- a/app/models/way.rb
+++ b/app/models/way.rb
@@ -1,52 +1,83 @@
 class Way < ActiveRecord::Base
   require 'xml/libxml'
+  
+  include ConsistencyValidations
+  include NotRedactable
+  include ObjectMetadata
 
-  set_table_name 'current_ways'
-
-  belongs_to :user
+  self.table_name = "current_ways"
+  
+  belongs_to :changeset
 
-  has_many :old_ways, :foreign_key => 'id', :order => 'version'
+  has_many :old_ways, -> { order(:version) }
 
-  has_many :way_nodes, :foreign_key => 'id', :order => 'sequence_id'
-  has_many :nodes, :through => :way_nodes, :order => 'sequence_id'
+  has_many :way_nodes, -> { order(:sequence_id) }
+  has_many :nodes, :through => :way_nodes
 
-  has_many :way_tags, :foreign_key => 'id'
+  has_many :way_tags
 
   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_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation
+
+  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
 
+  scope :visible, -> { where(:visible => true) }
+  scope :invisible, -> { where(:visible => false) }
+
+  # Read in xml as text and return it's Way 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
 
-      way = Way.new
-
       doc.find('//osm/way').each do |pt|
-        if !create and pt['id'] != '0'
-          way.id = pt['id'].to_i
-        end
+        return Way.from_xml_node(pt, create)
+      end
+      raise OSM::APIBadXMLError.new("node", xml, "XML doesn't contain an osm/way element.")
+    rescue LibXML::XML::Error, ArgumentError => ex
+      raise OSM::APIBadXMLError.new("way", xml, ex.message)
+    end
+  end
 
-        if create
-          way.timestamp = Time.now
-          way.visible = true
-        else
-          if pt['timestamp']
-            way.timestamp = Time.parse(pt['timestamp'])
-          end
-        end
+  def self.from_xml_node(pt, create=false)
+    way = Way.new
 
-        pt.find('tag').each do |tag|
-          way.add_tag_keyval(tag['k'], tag['v'])
-        end
+    raise OSM::APIBadXMLError.new("way", pt, "Version is required when updating") unless create or not pt['version'].nil?
+    way.version = pt['version']
+    raise OSM::APIBadXMLError.new("way", pt, "Changeset id is missing") if pt['changeset'].nil?
+    way.changeset_id = pt['changeset']
 
-        pt.find('nd').each do |nd|
-          way.add_nd_num(nd['ref'])
-        end
-      end
-    rescue
-      way = nil
+    unless create
+      raise OSM::APIBadXMLError.new("way", pt, "ID is required when updating") if pt['id'].nil?
+      way.id = pt['id'].to_i
+      # .to_i will return 0 if there is no number that can be parsed. 
+      # We want to make sure that there is no id with zero anyway
+      raise OSM::APIBadUserInput.new("ID of way cannot be zero when updating.") if way.id == 0
+    end
+
+    # We don't care about the timestamp nor the visibility as these are either
+    # set explicitly or implicit in the action. The visibility is set to true, 
+    # and manually set to false before the actual delete.
+    way.visible = true
+
+    # Start with no tags
+    way.tags = Hash.new
+
+    # Add in any tags from the XML
+    pt.find('tag').each do |tag|
+      raise OSM::APIBadXMLError.new("way", pt, "tag is missing key") if tag['k'].nil?
+      raise OSM::APIBadXMLError.new("way", pt, "tag is missing value") if tag['v'].nil?
+      way.add_tag_keyval(tag['k'], tag['v'])
+    end
+
+    pt.find('nd').each do |nd|
+      way.add_nd_num(nd['ref'])
     end
 
     return way
@@ -69,23 +100,11 @@ class Way < ActiveRecord::Base
     return doc
   end
 
-  def to_xml_node(visible_nodes = nil, user_display_name_cache = nil)
-    el1 = XML::Node.new 'way'
-    el1['id'] = self.id.to_s
-    el1['visible'] = self.visible.to_s
-    el1['timestamp'] = self.timestamp.xmlschema
-
-    user_display_name_cache = {} if user_display_name_cache.nil?
-
-    if user_display_name_cache and user_display_name_cache.key?(self.user_id)
-      # use the cache if available
-    elsif self.user.data_public?
-      user_display_name_cache[self.user_id] = self.user.display_name
-    else
-      user_display_name_cache[self.user_id] = nil
-    end
+  def to_xml_node(visible_nodes = nil, changeset_cache = {}, user_display_name_cache = {})
+    el = XML::Node.new 'way'
+    el['id'] = self.id.to_s
 
-    el1['user'] = user_display_name_cache[self.user_id] unless user_display_name_cache[self.user_id].nil?
+    add_metadata_to_xml_node(el, self, changeset_cache, user_display_name_cache)
 
     # make sure nodes are output in sequence_id order
     ordered_nodes = []
@@ -97,7 +116,7 @@ class Way < ActiveRecord::Base
         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
@@ -105,39 +124,23 @@ class Way < ActiveRecord::Base
 
     ordered_nodes.each do |nd_id|
       if nd_id and nd_id != '0'
-        e = XML::Node.new 'nd'
-        e['ref'] = nd_id
-        el1 << e
+        node_el = XML::Node.new 'nd'
+        node_el['ref'] = nd_id
+        el << node_el
       end
     end
 
-    self.way_tags.each do |tag|
-      e = XML::Node.new 'tag'
-      e['k'] = tag.k
-      e['v'] = tag.v
-      el1 << e
-    end
-    return el1
+    add_tags_to_xml_node(el, self.way_tags)
+
+    return el
   end 
 
   def nds
-    unless @nds
-      @nds = Array.new
-      self.way_nodes.each do |nd|
-        @nds += [nd.node_id]
-      end
-    end
-    @nds
+    @nds ||= self.way_nodes.collect { |n| n.node_id }
   end
 
   def tags
-    unless @tags
-      @tags = {}
-      self.way_tags.each do |tag|
-        @tags[tag.k] = tag.v
-      end
-    end
-    @tags
+    @tags ||= Hash[self.way_tags.collect { |t| [t.k, t.v] }]
   end
 
   def nds=(s)
@@ -155,36 +158,146 @@ class Way < ActiveRecord::Base
 
   def add_tag_keyval(k, v)
     @tags = Hash.new unless @tags
+
+    # 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[k] = v
   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 }
+    BoundingBox.new(lons.min, lats.min, lons.max, lats.max)
+  end
+
+  def update_from(new_way, user)
+    Way.transaction do
+      self.lock!
+      check_consistency(self, new_way, user)
+      unless new_way.preconditions_ok?(self.nds)
+        raise OSM::APIPreconditionFailedError.new("Cannot update way #{self.id}: data is invalid.")
+      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 create_with_history(user)
+    check_create_consistency(self, user)
+    unless self.preconditions_ok?
+      raise OSM::APIPreconditionFailedError.new("Cannot create way: data is invalid.")
+    end
+    self.version = 0
+    self.visible = true
+    save_with_history!
+  end
+
+  def preconditions_ok?(old_nodes = [])
+    return false if self.nds.empty?
+    if self.nds.length > MAX_NUMBER_OF_WAY_NODES
+      raise OSM::APITooManyWayNodesError.new(self.id, self.nds.length, MAX_NUMBER_OF_WAY_NODES)
+    end
+
+    # check only the new nodes, for efficiency - old nodes having been checked last time and can't
+    # be deleted when they're in-use.
+    new_nds = (self.nds - old_nodes).sort.uniq
+
+    unless new_nds.empty?
+      db_nds = Node.where(:id => new_nds, :visible => true)
+
+      if db_nds.length < new_nds.length
+        missing = new_nds - db_nds.collect { |n| n.id }
+        raise OSM::APIPreconditionFailedError.new("Way #{self.id} requires the nodes with id in (#{missing.join(',')}), which either do not exist, or are not visible.")
+      end
+    end
+
+    return true
+  end
+
+  def delete_with_history!(new_way, user)
+    unless self.visible
+      raise OSM::APIAlreadyDeletedError.new("way", new_way.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.
+    Way.transaction do
+      self.lock!
+      check_consistency(self, new_way, user)
+      rels = Relation.joins(:relation_members).where(:visible => true, :current_relation_members => { :member_type => "Way", :member_id => id }).order(:id)
+      raise OSM::APIPreconditionFailedError.new("Way #{self.id} is still used by relations #{rels.collect { |r| r.id }.join(",")}.") unless rels.empty?
+
+      self.changeset_id = new_way.changeset_id
+      self.changeset = new_way.changeset
+
+      self.tags = []
+      self.nds = []
+      self.visible = false
+      save_with_history!
+    end
+  end
+
+  # Temporary method to match interface to nodes
+  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, placeholder_id = nil)
+    self.nds.map! do |node_id|
+      if node_id < 0
+        new_id = id_map[:node][node_id]
+        raise OSM::APIBadUserInput.new("Placeholder node not found for reference #{node_id} in way #{self.id.nil? ? placeholder_id : self.id}") if new_id.nil?
+        new_id
+      else
+        node_id
+      end
+    end
+  end
+
+  private
+  
   def save_with_history!
-    t = Time.now
+    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!
-    end
 
-    WayTag.transaction do
       tags = self.tags
-
-      WayTag.delete_all(['id = ?', self.id])
-
+      WayTag.delete_all(:way_id => self.id)
       tags.each do |k,v|
         tag = WayTag.new
+        tag.way_id = self.id
         tag.k = k
         tag.v = v
-        tag.id = self.id
         tag.save!
       end
-    end
 
-    WayNode.transaction do
       nds = self.nds
-
-      WayNode.delete_all(['id = ?', self.id])
-
+      WayNode.delete_all(:way_id => self.id)
       sequence = 1
       nds.each do |n|
         nd = WayNode.new
@@ -193,75 +306,23 @@ class Way < ActiveRecord::Base
         nd.save!
         sequence += 1
       end
-    end
-
-    old_way = OldWay.from_way(self)
-    old_way.timestamp = t
-    old_way.save_with_dependencies!
-  end
-
-  def preconditions_ok?
-    return false if self.nds.empty?
-    self.nds.each do |n|
-      node = Node.find(:first, :conditions => ["id = ?", n])
-      unless node and node.visible
-        return false
-      end
-    end
-    return true
-  end
 
-  # Delete the way and it's relations, but don't really delete it - set its visibility to false and update the history etc to maintain wiki-like functionality.
-  def delete_with_relations_and_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!!
-      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
-      else
-        self.user_id = user.id
-        self.tags = []
-        self.nds = []
-        self.visible = false
-        self.save_with_history!
-      end
-    else
-      raise OSM::APIAlreadyDeletedError
-    end
-  end
+      old_way = OldWay.from_way(self)
+      old_way.timestamp = t
+      old_way.save_with_dependencies!
 
-  # delete a way and it's nodes that aren't part of other ways, with history
-  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
+      # reload the way so that the nodes array points to the correct
+      # new set of nodes.
+      self.reload
 
-    self.delete_with_relations_and_history(user)
-  end
+      # 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?
 
-  # Find nodes that belong to this way only
-  def unshared_node_ids
-    node_ids = self.nodes.collect { |node| node.id }
+      # tell the changeset we updated one element only
+      cs.add_changes! 1
 
-    unless node_ids.empty?
-      way_nodes = WayNode.find(:all, :conditions => "node_id in (#{node_ids.join(',')}) and id != #{self.id}")
-      node_ids = node_ids - way_nodes.collect { |way_node| way_node.node_id }
+      cs.save!
     end
-
-    return node_ids
-  end
-
-  # Temporary method to match interface to nodes
-  def tags_as_hash
-    return self.tags
   end
 end