Add annotate gem and associated rake task. Annotate models.

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

diff --git a/app/models/way.rb b/app/models/way.rb
index 09d1dafa0adca5b320aaad2003b63c36b9d85e43..1954f744ca9332d1c45c7bd133e27f9b7b24bed2 100644 (file)
--- a/app/models/way.rb
+++ b/app/models/way.rb
@@ -1,200 +1,331 @@
+# == Schema Information
+#
+# Table name: current_ways
+#
+#  id           :integer          not null, primary key
+#  changeset_id :integer          not null
+#  timestamp    :datetime         not null
+#  visible      :boolean          not null
+#  version      :integer          not null
+#
+# Indexes
+#
+#  current_ways_timestamp_idx  (timestamp)
+#
+# Foreign Keys
+#
+#  current_ways_changeset_id_fkey  (changeset_id => changesets.id)
+#
+

 class Way < ActiveRecord::Base
 class Way < ActiveRecord::Base

-  require 'xml/libxml'
-  
-  belongs_to :user
+  require "xml/libxml"

 
 

-  has_many :way_segments, :foreign_key => 'id', :order => 'sequence_id'
-  has_many :way_tags, :foreign_key => 'id'
+  include ConsistencyValidations
+  include NotRedactable
+  include ObjectMetadata

 
 

-  has_many :old_ways, :foreign_key => 'id', :order => 'version'
+  self.table_name = "current_ways"

 
 

-  set_table_name 'current_ways'
+  belongs_to :changeset

 
 

-  def self.from_xml(xml, create=false)
-    begin
-      p = XML::Parser.new
-      p.string = xml
-      doc = p.parse
+  has_many :old_ways, -> { order(:version) }

 
 

-      way = Way.new
+  has_many :way_nodes, -> { order(:sequence_id) }
+  has_many :nodes, :through => :way_nodes

 
 

-      doc.find('//osm/way').each do |pt|
-        if !create and pt['id'] != '0'
-          way.id = pt['id'].to_i
-        end
+  has_many :way_tags

 
 

-        if create
-          way.timestamp = Time.now
-          way.visible = true
-        else
-          if pt['timestamp']
-            way.timestamp = Time.parse(pt['timestamp'])
-          end
-        end
+  has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
+  has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation

 
 

-        pt.find('tag').each do |tag|
-          way.add_tag_keyval(tag['k'], tag['v'])
-        end
+  validates :id, :uniqueness => true, :presence => { :on => :update },
+                 :numericality => { :on => :update, :integer_only => true }
+  validates :version, :presence => true,
+                      :numericality => { :integer_only => true }
+  validates :changeset_id, :presence => true,
+                           :numericality => { :integer_only => true }
+  validates :timestamp, :presence => true
+  validates :changeset, :associated => true
+  validates :visible, :inclusion => [true, false]

 
 

-        pt.find('seg').each do |seg|
-          way.add_seg_num(seg['id'])
-        end
-      end
-    rescue
-      way = nil
+  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)
+    p = XML::Parser.string(xml, :options => XML::Parser::Options::NOERROR)
+    doc = p.parse
+
+    doc.find("//osm/way").each do |pt|
+      return Way.from_xml_node(pt, create)

     end
     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
+
+  def self.from_xml_node(pt, create = false)
+    way = Way.new
+
+    raise OSM::APIBadXMLError.new("way", pt, "Version is required when updating") unless create || !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"]
+
+    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, "ID of way cannot be zero when updating." if way.id.zero?
+    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 = {}

 
 

-    return way
+    # 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
+
+    way

   end
 
   end
 

+  # Find a way given it's ID, and in a single SQL call also grab its nodes and tags

   def to_xml
     doc = OSM::API.new.get_xml_doc
   def to_xml
     doc = OSM::API.new.get_xml_doc

-    doc.root << to_xml_node()
-    return doc
+    doc.root << to_xml_node
+    doc

   end
 
   end
 

-  def to_xml_node(visible_segments = 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"] = 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 segments are output in sequence_id order
-    ordered_segments = []
-    self.way_segments.each do |seg|
-      if visible_segments
-        # if there is a list of visible segments then use that to weed out deleted segments
-        if visible_segments[seg.segment_id]
-          ordered_segments[seg.sequence_id] = seg.segment_id.to_s
+    # make sure nodes are output in sequence_id order
+    ordered_nodes = []
+    way_nodes.each do |nd|
+      if visible_nodes
+        # if there is a list of visible nodes then use that to weed out deleted nodes
+        if visible_nodes[nd.node_id]
+          ordered_nodes[nd.sequence_id] = nd.node_id.to_s

         end
       else
         # otherwise, manually go to the db to check things
         end
       else
         # otherwise, manually go to the db to check things

-        if seg.segment.visible? and seg.segment.from_node.visible? and seg.segment.to_node.visible?
-          ordered_segments[seg.sequence_id] = seg.segment_id.to_s
+        if nd.node && nd.node.visible?
+          ordered_nodes[nd.sequence_id] = nd.node_id.to_s

         end
       end
     end
 
         end
       end
     end
 

-    ordered_segments.each do |seg_id|
-      if seg_id and seg_id != '0'
-        e = XML::Node.new 'seg'
-        e['id'] = seg_id
-        el1 << e
-      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
-  end 
-
-  def segs
-    unless @segs
-        @segs = Array.new
-        self.way_segments.each do |seg|
-            @segs += [seg.segment_id]
-        end
-    end
-    @segs
-  end
+    ordered_nodes.each do |nd_id|
+      next unless nd_id && nd_id != "0"

 
 

-  def tags
-    unless @tags
-        @tags = Hash.new
-        self.way_tags.each do |tag|
-            @tags[tag.k] = tag.v
-        end
+      node_el = XML::Node.new "nd"
+      node_el["ref"] = nd_id
+      el << node_el

     end
     end

-    @tags
+
+    add_tags_to_xml_node(el, way_tags)
+
+    el

   end
 
   end
 

-  def segs=(s)
-    @segs = s
+  def nds
+    @nds ||= way_nodes.collect(&:node_id)

   end
 
   end
 

-  def tags=(t)
-    @tags = t
+  def tags
+    @tags ||= Hash[way_tags.collect { |t| [t.k, t.v] }]

   end
 
   end
 

-  def add_seg_num(n)
-    @segs = Array.new unless @segs
-    @segs << n.to_i
+  attr_writer :nds
+
+  attr_writer :tags
+
+  def add_nd_num(n)
+    @nds ||= []
+    @nds << n.to_i

   end
 
   def add_tag_keyval(k, v)
   end
 
   def add_tag_keyval(k, v)

-    @tags = Hash.new unless @tags
+    @tags ||= {}
+
+    # duplicate tags are now forbidden, so we can't allow values
+    # in the hash to be overwritten.
+    raise OSM::APIDuplicateTagsError.new("way", id, k) if @tags.include? k
+

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

-  def save_with_history
-    begin
-      Way.transaction do
-        t = Time.now
-        self.timestamp = t
-        self.save!
+  ##
+  # the integer coords (i.e: unscaled) bounding box of the way, assuming
+  # straight line segments.
+  def bbox
+    lons = nodes.collect(&:longitude)
+    lats = nodes.collect(&:latitude)
+    BoundingBox.new(lons.min, lats.min, lons.max, lats.max)
+  end

 
 

-        tags = self.tags
+  def update_from(new_way, user)
+    Way.transaction do
+      lock!
+      check_consistency(self, new_way, user)
+      unless new_way.preconditions_ok?(nds)
+        raise OSM::APIPreconditionFailedError, "Cannot update way #{id}: data is invalid."
+      end

 
 

-        WayTag.delete_all(['id = ?', self.id])
+      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

 
 

-        tags.each do |k,v|
-          tag = WayTag.new
-          tag.k = k
-          tag.v = v
-          tag.id = self.id
-          tag.save!
-        end
+  def create_with_history(user)
+    check_create_consistency(self, user)
+    unless preconditions_ok?
+      raise OSM::APIPreconditionFailedError, "Cannot create way: data is invalid."
+    end
+    self.version = 0
+    self.visible = true
+    save_with_history!
+  end

 
 

-        segs = self.segs
+  def preconditions_ok?(old_nodes = [])
+    return false if nds.empty?
+    if nds.length > MAX_NUMBER_OF_WAY_NODES
+      raise OSM::APITooManyWayNodesError.new(id, nds.length, MAX_NUMBER_OF_WAY_NODES)
+    end

 
 

-        WaySegment.delete_all(['id = ?', self.id])
+    # 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 = (nds - old_nodes).sort.uniq

 
 

-        i = 1
-        segs.each do |n|
-          seg = WaySegment.new
-          seg.id = self.id
-          seg.segment_id = n
-          seg.sequence_id = i
-          seg.save!
-          i += 1
-        end
+    unless new_nds.empty?
+      # NOTE: nodes are locked here to ensure they can't be deleted before
+      # the current transaction commits.
+      db_nds = Node.where(:id => new_nds, :visible => true).lock("for share")

 
 

-        old_way = OldWay.from_way(self)
-        old_way.timestamp = t
-        old_way.save_with_dependencies!
+      if db_nds.length < new_nds.length
+        missing = new_nds - db_nds.collect(&:id)
+        raise OSM::APIPreconditionFailedError, "Way #{id} requires the nodes with id in (#{missing.join(',')}), which either do not exist, or are not visible."

       end
       end

+    end
+
+    true
+  end

 
 

-      return true
-    rescue
-      return nil
+  def delete_with_history!(new_way, user)
+    raise OSM::APIAlreadyDeletedError.new("way", new_way.id) unless visible
+
+    # 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
+      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, "Way #{id} is still used by relations #{rels.collect(&: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
 
     end
   end
 

-  def preconditions_ok?
-    return false if self.segs.empty?
-    self.segs.each do |n|
-      segment = Segment.find(:first, :conditions => ["id = ?", n])
-      unless segment and segment.visible and segment.preconditions_ok?
-        return false
+  ##
+  # 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)
+    nds.map! do |node_id|
+      if node_id < 0
+        new_id = id_map[:node][node_id]
+        raise OSM::APIBadUserInput, "Placeholder node not found for reference #{node_id} in way #{id.nil? ? placeholder_id : id}" if new_id.nil?
+        new_id
+      else
+        node_id

       end
     end
       end
     end

-    return true

   end
 
   end
 

+  private
+
+  def save_with_history!
+    t = Time.now.getutc
+
+    self.version += 1
+    self.timestamp = t
+
+    # 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 = changeset
+    cs.update_bbox!(bbox) unless nodes.empty?
+
+    Way.transaction do
+      # clone the object before saving it so that the original is
+      # still marked as dirty if we retry the transaction
+      clone.save!
+
+      tags = self.tags
+      WayTag.where(:way_id => id).delete_all
+      tags.each do |k, v|
+        tag = WayTag.new
+        tag.way_id = id
+        tag.k = k
+        tag.v = v
+        tag.save!
+      end
+
+      nds = self.nds
+      WayNode.where(:way_id => id).delete_all
+      sequence = 1
+      nds.each do |n|
+        nd = WayNode.new
+        nd.id = [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.
+      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