Merge remote-tracking branch 'upstream/pull/2915' into master

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

diff --git a/app/models/way.rb b/app/models/way.rb
index 9ae45d40fe07dc5ab123ce645b2d3e30223f4829..ca6829df434cc699974896944d5586c1566ebc3a 100644 (file)
--- a/app/models/way.rb
+++ b/app/models/way.rb
@@ -1,127 +1,289 @@
-class Way < ActiveRecord::Base
-  require 'xml/libxml'
-  
-  belongs_to :user
+# == Schema Information
+#
+# Table name: current_ways
+#
+#  id           :bigint(8)        not null, primary key
+#  changeset_id :bigint(8)        not null
+#  timestamp    :datetime         not null
+#  visible      :boolean          not null
+#  version      :bigint(8)        not null
+#
+# Indexes
+#
+#  current_ways_timestamp_idx  (timestamp)
+#
+# Foreign Keys
+#
+#  current_ways_changeset_id_fkey  (changeset_id => changesets.id)
+#

 
 

-  has_many :way_segments, :foreign_key => 'id'
-  has_many :way_tags, :foreign_key => 'id'
+class Way < ApplicationRecord
+  require "xml/libxml"

 
 

-  set_table_name 'current_ways'
+  include ConsistencyValidations
+  include NotRedactable
+  include ObjectMetadata

 
 

-  def self.from_xml(xml, create=false)
-    p = XML::Parser.new
-    p.string = xml
+  self.table_name = "current_ways"
+
+  belongs_to :changeset
+
+  has_many :old_ways, -> { order(:version) }
+
+  has_many :way_nodes, -> { order(:sequence_id) }
+  has_many :nodes, :through => :way_nodes
+
+  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
+
+  validates :id, :uniqueness => true, :presence => { :on => :update },
+                 :numericality => { :on => :update, :only_integer => true }
+  validates :version, :presence => true,
+                      :numericality => { :only_integer => true }
+  validates :changeset_id, :presence => true,
+                           :numericality => { :only_integer => true }
+  validates :timestamp, :presence => true
+  validates :changeset, :associated => true
+  validates :visible, :inclusion => [true, false]
+
+  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 = p.parse

+    pt = doc.find_first("//osm/way")

 
 

+    if pt
+      Way.from_xml_node(pt, create)
+    else
+      raise OSM::APIBadXMLError.new("node", xml, "XML doesn't contain an osm/way element.")
+    end
+  rescue LibXML::XML::Error, ArgumentError => e
+    raise OSM::APIBadXMLError.new("way", xml, e.message)
+  end
+
+  def self.from_xml_node(pt, create = false)

     way = Way.new
 
     way = Way.new
 

-    doc.find('//osm/way').each do |pt|
-      if !create and pt['id'] != '0'
-        way.id = pt['id'].to_i
-      end
+    raise OSM::APIBadXMLError.new("way", pt, "Version is required when updating") unless create || !pt["version"].nil?

 
 

-      if create
-        way.timestamp = Time.now
-        way.visible = true
-      else
-        if pt['timestamp']
-          way.timestamp = Time.parse(pt['timestamp'])
-        end
-      end
+    way.version = pt["version"]
+    raise OSM::APIBadXMLError.new("way", pt, "Changeset id is missing") if pt["changeset"].nil?

 
 

-      pt.find('tag').each do |tag|
-        way.add_tag_keyval(tag['k'], tag['v'])
-      end
+    way.changeset_id = pt["changeset"]

 
 

-      pt.find('seg').each do |seg|
-        way.add_seg_num(seg['id'])
-      end
+    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
 
     end
 

-    return way
-  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 = {}

 
 

-  def to_xml
-    doc = XML::Document.new
-    doc.encoding = 'UTF-8' 
-    root = XML::Node.new 'osm'
-    root['version'] = '0.4'
-    root['generator'] = 'OpenStreetMap server'
-
-    doc.root = root
-    
-    el1 = XML::Node.new 'way'
-    el1['id'] = self.id.to_s
-    el1['visible'] = self.visible.to_s
-    el1['timestamp'] = self.timestamp.xmlschema
-    
-    self.way_segments.each do |seg| # FIXME need to make sure they come back in the right order
-      e = XML::Node.new 'seg'
-      e['id'] = seg.segment_id.to_s
-      el1 << e
+    # 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
     end

- 
-    self.way_tags.each do |tag|
-      e = XML::Node.new 'tag'
-      e['k'] = tag.k
-      e['v'] = tag.v
-      el1 << e
+
+    pt.find("nd").each do |nd|
+      way.add_nd_num(nd["ref"])

     end
     end

-  
-    root << el1
-    return doc
+
+    way

   end
 
   end
 

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

   end
 
   def tags
   end
 
   def tags

-    @tags = Hash.new unless @tags
-    @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, :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
-    t = Time.now
-    self.timestamp = t
-    self.save
-    
-    WayTag.delete_all(['id = ?', self.id])
-
-    self.tags.each do |k,v|
-      tag = WayTag.new
-      tag.k = k
-      tag.v = v
-      tag.id = self.id
-      tag.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
+
+  def update_from(new_way, user)
+    Way.transaction do
+      lock!
+      check_consistency(self, new_way, user)
+      raise OSM::APIPreconditionFailedError, "Cannot update way #{id}: data is invalid." unless new_way.preconditions_ok?(nds)
+
+      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)
+    raise OSM::APIPreconditionFailedError, "Cannot create way: data is invalid." unless preconditions_ok?
+
+    self.version = 0
+    self.visible = true
+    save_with_history!
+  end
+
+  def preconditions_ok?(old_nodes = [])
+    return false if nds.empty?
+    raise OSM::APITooManyWayNodesError.new(id, nds.length, Settings.max_number_of_way_nodes) if nds.length > Settings.max_number_of_way_nodes
+
+    # 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
+
+    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")
+
+      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
 

-    WaySegment.delete_all(['id = ?', self.id])
-    
-    i = 0
-    self.segs.each do |n|
-      seg = WaySegment.new
-      seg.id = self.id
-      seg.segment_id = n
-      seg.sequence_id = i
-      seg.save
-      i += 1
+    true
+  end
+
+  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

 
 

-    old_way = OldWay.from_way(self)
-    old_way.save
+  ##
+  # 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.negative?
+        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
 

+  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