Remove unused to_xml and to_xml_node methods from models

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

diff --git a/app/models/way.rb b/app/models/way.rb
index 34afc6585041e7fa3c723dc08bde40a8b24af83c..724965ddfe4bc1a24b4de482bf6529ca131eeb90 100644 (file)
--- a/app/models/way.rb
+++ b/app/models/way.rb
@@ -1,194 +1,267 @@
-class Way < ActiveRecord::Base
-  require 'xml/libxml'
+# == 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)
+#
+
+class Way < ApplicationRecord
+  require "xml/libxml"
+
+  include ConsistencyValidations
+  include NotRedactable
+
+  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

 
 

-  set_table_name 'current_ways'
+  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
+    pt = doc.find_first("//osm/way")
+
+    if pt
+      Way.from_xml_node(pt, :create => 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

 
 

-  belongs_to :user
+  def self.from_xml_node(pt, create: false)
+    way = Way.new

 
 

-  has_many :old_ways, :foreign_key => 'id', :order => 'version'
+    raise OSM::APIBadXMLError.new("way", pt, "Version is required when updating") unless create || !pt["version"].nil?

 
 

-  has_many :way_nodes, :foreign_key => 'id', :order => 'sequence_id'
-  has_many :nodes, :through => :way_nodes, :order => 'sequence_id'
+    way.version = pt["version"]
+    raise OSM::APIBadXMLError.new("way", pt, "Changeset id is missing") if pt["changeset"].nil?

 
 

-  has_many :way_tags, :foreign_key => 'id'
+    way.changeset_id = pt["changeset"]

 
 

-  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
+    unless create
+      raise OSM::APIBadXMLError.new("way", pt, "ID is required when updating") if pt["id"].nil?

 
 

-  def self.from_xml(xml, create=false)
-    begin
-      p = XML::Parser.new
-      p.string = xml
-      doc = p.parse
-
-      doc.find('//osm/way').each do |pt|
-       return Way.from_xml_node(pt, create)
-      end
-    rescue
-      return 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

-  end

 
 

-  def self.from_xml_node(pt, create=false)
-    way = Way.new
+    # 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

 
 

-    if !create and pt['id'] != '0'
-      way.id = pt['id'].to_i
-    end
-    
-    way.version = pt['version']
+    # Start with no tags
+    way.tags = {}

 
 

-    if create
-      way.timestamp = Time.now
-      way.visible = true
-    else
-      if pt['timestamp']
-       way.timestamp = Time.parse(pt['timestamp'])
-      end
-    end
+    # 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?

 
 

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

     end
 
     end
 

-    pt.find('nd').each do |nd|
-      way.add_nd_num(nd['ref'])
+    pt.find("nd").each do |nd|
+      way.add_nd_num(nd["ref"])

     end
 
     end
 

-    return way
+    way

   end
 
   end
 

-  # Find a way given it's ID, and in a single SQL call also grab its nodes
-  #
-  
-  # You can't pull in all the tags too unless we put a sequence_id on the way_tags table and have a multipart key
-  def self.find_eager(id)
-    way = Way.find(id, :include => {:way_nodes => :node})
-    #If waytag had a multipart key that was real, you could do this:
-    #way = Way.find(id, :include => [:way_tags, {:way_nodes => :node}])
+  def nds
+    @nds ||= way_nodes.collect(&:node_id)

   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
-    doc.root << to_xml_node()
-    return doc
+  def tags
+    @tags ||= way_tags.collect { |t| [t.k, t.v] }.to_h

   end
 
   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
-    el1['version'] = self.version.to_s
+  attr_writer :nds, :tags

 
 

-    user_display_name_cache = {} if user_display_name_cache.nil?
+  def add_nd_num(n)
+    @nds ||= []
+    @nds << n.to_i
+  end

 
 

-    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 add_tag_keyval(k, v)
+    @tags ||= {}

 
 

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

 
 

-    # make sure nodes are output in sequence_id order
-    ordered_nodes = []
-    self.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
-        if nd.node.visible? and nd.node.visible?
-          ordered_nodes[nd.sequence_id] = nd.node_id.to_s
-        end
-      end
-    end
+    @tags[k] = v
+  end

 
 

-    ordered_nodes.each do |nd_id|
-      if nd_id and nd_id != '0'
-        e = XML::Node.new 'nd'
-        e['ref'] = nd_id
-        el1 << e
-      end
-    end
+  ##
+  # 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

 
 

-    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 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)

 
 

-  def nds
-    unless @nds
-      @nds = Array.new
-      self.way_nodes.each do |nd|
-        @nds += [nd.node_id]
-      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

-    @nds

   end
 
   end
 

-  def tags
-    unless @tags
-      @tags = {}
-      self.way_tags.each do |tag|
-        @tags[tag.k] = tag.v
+  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
     end

-    @tags
-  end

 
 

-  def nds=(s)
-    @nds = s
+    true

   end
 
   end
 

-  def tags=(t)
-    @tags = t
-  end
+  def delete_with_history!(new_way, user)
+    raise OSM::APIAlreadyDeletedError.new("way", new_way.id) unless visible

 
 

-  def add_nd_num(n)
-    @nds = Array.new unless @nds
-    @nds << n.to_i
+    # 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
 

-  def add_tag_keyval(k, v)
-    @tags = Hash.new unless @tags
-    @tags[k] = v
+  ##
+  # 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!
   def save_with_history!

-    t = Time.now
+    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
 
     Way.transaction do

-      self.version += 1
-      self.timestamp = t
-      self.save!
+      # 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
 
       tags = self.tags

-      WayTag.delete_all(['id = ?', self.id])
-      tags.each do |k,v|
+      WayTag.where(:way_id => id).delete_all
+      tags.each do |k, v|

         tag = WayTag.new
         tag = WayTag.new

+        tag.way_id = id

         tag.k = k
         tag.v = v
         tag.k = k
         tag.v = v

-        tag.id = self.id

         tag.save!
       end
 
       nds = self.nds
         tag.save!
       end
 
       nds = self.nds

-      WayNode.delete_all(['id = ?', self.id])
+      WayNode.where(:way_id => id).delete_all

       sequence = 1
       nds.each do |n|
         nd = WayNode.new
       sequence = 1
       nds.each do |n|
         nd = WayNode.new

-        nd.id = [self.id, sequence]
+        nd.id = [id, sequence]

         nd.node_id = n
         nd.save!
         sequence += 1
         nd.node_id = n
         nd.save!
         sequence += 1


@@ -197,86 +270,19 @@ class Way < ActiveRecord::Base
       old_way = OldWay.from_way(self)
       old_way.timestamp = t
       old_way.save_with_dependencies!
       old_way = OldWay.from_way(self)
       old_way.timestamp = t
       old_way.save_with_dependencies!

-    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!
-    end
-  end
+      # reload the way so that the nodes array points to the correct
+      # new set of nodes.
+      reload

 
 

-  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
+      # 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?

 
 

-  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
-      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
+      # tell the changeset we updated one element only
+      cs.add_changes! 1

 
 

-  # 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)
-    
-    node_ids = self.nodes.collect {|node| node.id }
-    node_ids_not_to_delete = []
-    way_nodes = WayNode.find(:all, :conditions => "node_id in (#{node_ids.join(',')}) and id != #{self.id}")
-    
-    node_ids_not_to_delete = way_nodes.collect {|way_node| way_node.node_id}
-
-    node_ids_to_delete = node_ids - node_ids_not_to_delete
-
-    # delete the nodes not used by other ways
-    node_ids_to_delete.each do |node_id|
-      n = Node.find(node_id)
-      n.user_id = user.id
-      n.visible = false
-      n.save_with_history!
+      cs.save!

     end
     end

-    
-    self.user_id = user.id
-
-    self.delete_with_history(user)
-
-  end
-
-  # Temporary method to match interface to nodes
-  def tags_as_hash
-    return self.tags

   end
 end
   end
 end