Fix rubocop style issues

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

diff --git a/app/models/way.rb b/app/models/way.rb
index f95037ea13466832349bf5f261a1a09e21c0d2ba..2d427051c5a95d3e571f868e5bb35b812b53a6d7 100644 (file)
--- a/app/models/way.rb
+++ b/app/models/way.rb
@@ -1,91 +1,112 @@
 class Way < ActiveRecord::Base
   require 'xml/libxml'
 
 class Way < ActiveRecord::Base
   require 'xml/libxml'
 

-  belongs_to :user
+  include ConsistencyValidations
+  include NotRedactable
+  include ObjectMetadata

 
 

-  has_many :nodes, :through => :way_nodes, :order => 'sequence_id'
-  has_many :way_nodes, :foreign_key => 'id', :order => 'sequence_id'
-  has_many :way_tags, :foreign_key => 'id'
+  self.table_name = "current_ways"

 
 

-  has_many :old_ways, :foreign_key => 'id', :order => 'version'
+  belongs_to :changeset

 
 

-  set_table_name 'current_ways'
+  has_many :old_ways, -> { order(:version) }

 
 

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

 
 

-      way = Way.new
+  has_many :way_tags

 
 

-      doc.find('//osm/way').each do |pt|
-        if !create and pt['id'] != '0'
-          way.id = pt['id'].to_i
-        end
+  has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
+  has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation

 
 

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

 
 

-        pt.find('tag').each do |tag|
-          way.add_tag_keyval(tag['k'], tag['v'])
-        end
+  scope :visible, -> { where(:visible => true) }
+  scope :invisible, -> { where(:visible => false) }

 
 

-        pt.find('nd').each do |nd|
-          way.add_nd_num(nd['ref'])
-        end
-      end
-    rescue
-      way = nil
+  # Read in xml as text and return it's Way object representation
+  def self.from_xml(xml, create = false)
+    p = XML::Parser.string(xml)
+    doc = p.parse
+
+    doc.find('//osm/way').each do |pt|
+      return Way.from_xml_node(pt, create)
+    end
+    fail 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
+
+    fail OSM::APIBadXMLError.new("way", pt, "Version is required when updating") unless create || !pt['version'].nil?
+    way.version = pt['version']
+    fail OSM::APIBadXMLError.new("way", pt, "Changeset id is missing") if pt['changeset'].nil?
+    way.changeset_id = pt['changeset']
+
+    unless create
+      fail 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
+      fail OSM::APIBadUserInput.new("ID of way cannot be zero when updating.") if way.id == 0

     end
 
     end
 

-    return way
+    # 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 = {}
+
+    # Add in any tags from the XML
+    pt.find('tag').each do |tag|
+      fail OSM::APIBadXMLError.new("way", pt, "tag is missing key") if tag['k'].nil?
+      fail 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
 
   # Find a way given it's ID, and in a single SQL call also grab its nodes
   #
   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)
   # 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}])
+    Way.find(id, :include => { :way_nodes => :node })
+    # If waytag had a multipart key that was real, you could do this:
+    # Way.find(id, :include => [:way_tags, {:way_nodes => :node}])

   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
   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
+    doc.root << to_xml_node
+    doc

   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
-
-    user_display_name_cache = {} if user_display_name_cache.nil?
+  def to_xml_node(visible_nodes = nil, changeset_cache = {}, user_display_name_cache = {})
+    el = XML::Node.new 'way'
+    el['id'] = id.to_s

 
 

-    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
-
-    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 = []
 
     # make sure nodes are output in sequence_id order
     ordered_nodes = []

-    self.way_nodes.each do |nd|
+    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]
       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]


@@ -93,172 +114,207 @@ 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 && nd.node.visible?

           ordered_nodes[nd.sequence_id] = nd.node_id.to_s
         end
       end
     end
 
     ordered_nodes.each do |nd_id|
           ordered_nodes[nd.sequence_id] = nd.node_id.to_s
         end
       end
     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
+      next unless nd_id && nd_id != '0'

 
 

-    self.way_tags.each do |tag|
-      e = XML::Node.new 'tag'
-      e['k'] = tag.k
-      e['v'] = tag.v
-      el1 << e
+      node_el = XML::Node.new 'nd'
+      node_el['ref'] = nd_id
+      el << node_el

     end
     end

-    return el1
-  end 
+
+    add_tags_to_xml_node(el, way_tags)
+
+    el
+  end

 
   def nds
 
   def nds

-    unless @nds
-      @nds = Array.new
-      self.way_nodes.each do |nd|
-        @nds += [nd.node_id]
-      end
-    end
-    @nds
+    @nds ||= way_nodes.collect(&:node_id)

   end
 
   def tags
   end
 
   def tags

-    unless @tags
-      @tags = {}
-      self.way_tags.each do |tag|
-        @tags[tag.k] = tag.v
-      end
-    end
-    @tags
+    @tags ||= Hash[way_tags.collect { |t| [t.k, t.v] }]

   end
 
   end
 

-  def nds=(s)
-    @nds = s
-  end
+  attr_writer :nds

 
 

-  def tags=(t)
-    @tags = t
-  end
+  attr_writer :tags

 
   def add_nd_num(n)
 
   def add_nd_num(n)

-    @nds = Array.new unless @nds
+    @nds = [] unless @nds

     @nds << n.to_i
   end
 
   def add_tag_keyval(k, v)
     @nds << n.to_i
   end
 
   def add_tag_keyval(k, v)

-    @tags = Hash.new unless @tags
+    @tags = {} unless @tags
+
+    # duplicate tags are now forbidden, so we can't allow values
+    # in the hash to be overwritten.
+    fail 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
+  ##
+  # 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
     Way.transaction do

-      self.timestamp = t
-      self.save!
-    end
+      self.lock!
+      check_consistency(self, new_way, user)
+      unless new_way.preconditions_ok?(nds)
+        fail OSM::APIPreconditionFailedError.new("Cannot update way #{id}: data is invalid.")
+      end

 
 

-    WayTag.transaction do
-      tags = self.tags
+      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

 
 

-      WayTag.delete_all(['id = ?', self.id])
+  def create_with_history(user)
+    check_create_consistency(self, user)
+    unless self.preconditions_ok?
+      fail OSM::APIPreconditionFailedError.new("Cannot create way: data is invalid.")
+    end
+    self.version = 0
+    self.visible = true
+    save_with_history!
+  end

 
 

-      tags.each do |k,v|
-        tag = WayTag.new
-        tag.k = k
-        tag.v = v
-        tag.id = self.id
-        tag.save!
-      end
+  def preconditions_ok?(old_nodes = [])
+    return false if nds.empty?
+    if nds.length > MAX_NUMBER_OF_WAY_NODES
+      fail OSM::APITooManyWayNodesError.new(id, nds.length, MAX_NUMBER_OF_WAY_NODES)

     end
 
     end
 

-    WayNode.transaction do
-      nds = self.nds
+    # 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

 
 

-      WayNode.delete_all(['id = ?', self.id])
+    unless new_nds.empty?
+      db_nds = Node.where(:id => new_nds, :visible => true)

 
 

-      sequence = 1
-      nds.each do |n|
-        nd = WayNode.new
-        nd.id = [self.id, sequence]
-        nd.node_id = n
-        nd.save!
-        sequence += 1
+      if db_nds.length < new_nds.length
+        missing = new_nds - db_nds.collect(&:id)
+        fail OSM::APIPreconditionFailedError.new("Way #{id} requires the nodes with id in (#{missing.join(',')}), which either do not exist, or are not visible.")

       end
     end
 
       end
     end
 

-    old_way = OldWay.from_way(self)
-    old_way.timestamp = t
-    old_way.save_with_dependencies!
+    true

   end
 
   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
+  def delete_with_history!(new_way, user)
+    fail 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
+      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)
+      fail OSM::APIPreconditionFailedError.new("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

-    return true

   end
 
   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
-      # omg FIXME
-      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
+  # Temporary method to match interface to nodes
+  def tags_as_hash
+    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)
+    nds.map! do |node_id|
+      if node_id < 0
+        new_id = id_map[:node][node_id]
+        fail OSM::APIBadUserInput.new("Placeholder node not found for reference #{node_id} in way #{id.nil? ? placeholder_id : id}") if new_id.nil?
+        new_id

       else
       else

-        self.user_id = user.id
-        self.tags = []
-        self.nds = []
-        self.visible = false
-        self.save_with_history!
+        node_id

       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
-  # WARNING, INCOMPLETE - Read the code
-  def delete_with_relations_and_nodes_and_history(user)
-    return false # until complete, just return false
-    
-    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 not #{self.id}")
-    
-    node_ids_not_to_delete = way_nodes.collect {|way_node| way_node.node_id}
-
-    nodes_to_delete = node_ids - node_ids_not_to_delete
-
-    # update the visibility etc on the current nodes
-    update_time = Time.now()
-    
-    Node.update(node_ids_to_delete, {:user_id => user.id, :timestamp => update_time, :visibility => false})
-
-    # create old nodes
-
-    old_nodes_to_create = []
-    OldNode.find(node_ids_to_delete).each do |old_node|
-      old_nodes_to_create << {:id => old_node.id, :timestamp => update_time, :latitude => old_node.latitude, :longitude => old_node.longitude, :visible => false}
-    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 = changeset
+    cs.update_bbox!(bbox) unless nodes.empty?

 
 

-    OldNode.create(old_nodes_to_create)
+    Way.transaction do
+      self.version += 1
+      self.timestamp = t
+      self.save!
+
+      tags = self.tags
+      WayTag.delete_all(:way_id => id)
+      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.delete_all(:way_id => id)
+      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!

 
 

-    # FIXME - the old nodes need to have their tile updated and I have no idea how that works
-    # they also need their tags copied over, and that depends on normalising the tags out to their own table that nicks working on
+      # reload the way so that the nodes array points to the correct
+      # new set of nodes.
+      reload

 
 

-    # finally, delete the way
-    
-    self.delete_with_relations_and_history
+      # 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
 end