Merge remote-tracking branch 'openstreetmap/pull/954'

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

diff --git a/app/models/relation.rb b/app/models/relation.rb
index b76213c7a547db17c7057efcaa7f39a43d2c02c9..062f0ed04ec073a869ecabfd3f5414e95e940c6d 100644 (file)
--- a/app/models/relation.rb
+++ b/app/models/relation.rb
@@ -1,6 +1,6 @@
 class Relation < ActiveRecord::Base
 class Relation < ActiveRecord::Base

-  require 'xml/libxml'
-  
+  require "xml/libxml"
+

   include ConsistencyValidations
   include NotRedactable
   include ObjectMetadata
   include ConsistencyValidations
   include NotRedactable
   include ObjectMetadata


@@ -15,157 +15,139 @@ class Relation < ActiveRecord::Base
   has_many :relation_tags
 
   has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
   has_many :relation_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
-
-  validates_presence_of :id, :on => :update
-  validates_presence_of :timestamp,:version,  :changeset_id 
-  validates_uniqueness_of :id
-  validates_inclusion_of :visible, :in => [ true, false ]
-  validates_numericality_of :id, :on => :update, :integer_only => true
-  validates_numericality_of :changeset_id, :version, :integer_only => true
-  validates_associated :changeset
-  
+  has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation
+
+  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]
+

   scope :visible, -> { where(:visible => true) }
   scope :invisible, -> { where(:visible => false) }
   scope :nodes, ->(*ids) { joins(:relation_members).where(:current_relation_members => { :member_type => "Node", :member_id => ids.flatten }) }
   scope :ways, ->(*ids) { joins(:relation_members).where(:current_relation_members => { :member_type => "Way", :member_id => ids.flatten }) }
   scope :relations, ->(*ids) { joins(:relation_members).where(:current_relation_members => { :member_type => "Relation", :member_id => ids.flatten }) }
 
   scope :visible, -> { where(:visible => true) }
   scope :invisible, -> { where(:visible => false) }
   scope :nodes, ->(*ids) { joins(:relation_members).where(:current_relation_members => { :member_type => "Node", :member_id => ids.flatten }) }
   scope :ways, ->(*ids) { joins(:relation_members).where(:current_relation_members => { :member_type => "Way", :member_id => ids.flatten }) }
   scope :relations, ->(*ids) { joins(:relation_members).where(:current_relation_members => { :member_type => "Relation", :member_id => ids.flatten }) }
 

-  TYPES = ["node", "way", "relation"]
+  TYPES = %w(node way relation).freeze

 
 

-  def self.from_xml(xml, create=false)
-    begin
-      p = XML::Parser.string(xml)
-      doc = p.parse
+  def self.from_xml(xml, create = false)
+    p = XML::Parser.string(xml)
+    doc = p.parse

 
 

-      doc.find('//osm/relation').each do |pt|
-        return Relation.from_xml_node(pt, create)
-      end
-      raise OSM::APIBadXMLError.new("node", xml, "XML doesn't contain an osm/relation element.")
-    rescue LibXML::XML::Error, ArgumentError => ex
-      raise OSM::APIBadXMLError.new("relation", xml, ex.message)
+    doc.find("//osm/relation").each do |pt|
+      return Relation.from_xml_node(pt, create)

     end
     end

+    raise OSM::APIBadXMLError.new("node", xml, "XML doesn't contain an osm/relation element.")
+  rescue LibXML::XML::Error, ArgumentError => ex
+    raise OSM::APIBadXMLError.new("relation", xml, ex.message)

   end
 
   end
 

-  def self.from_xml_node(pt, create=false)
+  def self.from_xml_node(pt, create = false)

     relation = Relation.new
 
     relation = Relation.new
 

-    raise OSM::APIBadXMLError.new("relation", pt, "Version is required when updating") unless create or not pt['version'].nil?
-    relation.version = pt['version']
-    raise OSM::APIBadXMLError.new("relation", pt, "Changeset id is missing") if pt['changeset'].nil?
-    relation.changeset_id = pt['changeset']
-    
+    raise OSM::APIBadXMLError.new("relation", pt, "Version is required when updating") unless create || !pt["version"].nil?
+    relation.version = pt["version"]
+    raise OSM::APIBadXMLError.new("relation", pt, "Changeset id is missing") if pt["changeset"].nil?
+    relation.changeset_id = pt["changeset"]
+

     unless create
     unless create

-      raise OSM::APIBadXMLError.new("relation", pt, "ID is required when updating") if pt['id'].nil?
-      relation.id = pt['id'].to_i
-      # .to_i will return 0 if there is no number that can be parsed. 
+      raise OSM::APIBadXMLError.new("relation", pt, "ID is required when updating") if pt["id"].nil?
+      relation.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 relation cannot be zero when updating.") if relation.id == 0
     end
       # We want to make sure that there is no id with zero anyway
       raise OSM::APIBadUserInput.new("ID of relation cannot be zero when updating.") if relation.id == 0
     end

-    
+

     # We don't care about the timestamp nor the visibility as these are either
     # 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, 
+    # set explicitly or implicit in the action. The visibility is set to true,

     # and manually set to false before the actual delete.
     relation.visible = true
 
     # Start with no tags
     # and manually set to false before the actual delete.
     relation.visible = true
 
     # Start with no tags

-    relation.tags = Hash.new
+    relation.tags = {}

 
     # Add in any tags from the XML
 
     # Add in any tags from the XML

-    pt.find('tag').each do |tag|
-      raise OSM::APIBadXMLError.new("relation", pt, "tag is missing key") if tag['k'].nil?
-      raise OSM::APIBadXMLError.new("relation", pt, "tag is missing value") if tag['v'].nil?
-      relation.add_tag_keyval(tag['k'], tag['v'])
+    pt.find("tag").each do |tag|
+      raise OSM::APIBadXMLError.new("relation", pt, "tag is missing key") if tag["k"].nil?
+      raise OSM::APIBadXMLError.new("relation", pt, "tag is missing value") if tag["v"].nil?
+      relation.add_tag_keyval(tag["k"], tag["v"])

     end
 
     # need to initialise the relation members array explicitly, as if this
     end
 
     # need to initialise the relation members array explicitly, as if this

-    # isn't done for a new relation then @members attribute will be nil, 
-    # and the members will be loaded from the database instead of being 
+    # isn't done for a new relation then @members attribute will be nil,
+    # and the members will be loaded from the database instead of being

     # empty, as intended.
     # empty, as intended.

-    relation.members = Array.new
-
-    pt.find('member').each do |member|
-      #member_type = 
-      logger.debug "each member"
-      raise OSM::APIBadXMLError.new("relation", pt, "The #{member['type']} is not allowed only, #{TYPES.inspect} allowed") unless TYPES.include? member['type']
-      logger.debug "after raise"
-      #member_ref = member['ref']
-      #member_role
-      member['role'] ||= "" # Allow  the upload to not include this, in which case we default to an empty string.
-      logger.debug member['role']
-      relation.add_member(member['type'].classify, member['ref'], member['role'])
+    relation.members = []
+
+    pt.find("member").each do |member|
+      # member_type =
+      raise OSM::APIBadXMLError.new("relation", pt, "The #{member['type']} is not allowed only, #{TYPES.inspect} allowed") unless TYPES.include? member["type"]
+      # member_ref = member['ref']
+      # member_role
+      member["role"] ||= "" # Allow  the upload to not include this, in which case we default to an empty string.
+      relation.add_member(member["type"].classify, member["ref"], member["role"])

     end
     raise OSM::APIBadUserInput.new("Some bad xml in relation") if relation.nil?
 
     end
     raise OSM::APIBadUserInput.new("Some bad xml in relation") if relation.nil?
 

-    return relation
+    relation

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

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

   end
 
   def to_xml_node(visible_members = nil, changeset_cache = {}, user_display_name_cache = {})
   end
 
   def to_xml_node(visible_members = nil, changeset_cache = {}, user_display_name_cache = {})

-    el1 = XML::Node.new 'relation'
-    el1['id'] = self.id.to_s
-    add_metadata_to_xml_node(el1, self, changeset_cache, user_display_name_cache)
+    el = XML::Node.new "relation"
+    el["id"] = id.to_s
+
+    add_metadata_to_xml_node(el, self, changeset_cache, user_display_name_cache)
+
+    relation_members.each do |member|
+      p = 0

 
 

-    self.relation_members.each do |member|
-      p=0

       if visible_members
         # if there is a list of visible members then use that to weed out deleted segments
       if visible_members
         # if there is a list of visible members then use that to weed out deleted segments

-        if visible_members[member.member_type][member.member_id]
-          p=1
-        end
+        p = 1 if visible_members[member.member_type][member.member_id]

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

-        if member.member.visible?
-          p=1
-        end
+        p = 1 if member.member.visible?

       end
       end

-      if p
-        e = XML::Node.new 'member'
-        e['type'] = member.member_type.downcase
-        e['ref'] = member.member_id.to_s 
-        e['role'] = member.member_role
-        el1 << e
-       end
-    end

 
 

-    self.relation_tags.each do |tag|
-      e = XML::Node.new 'tag'
-      e['k'] = tag.k
-      e['v'] = tag.v
-      el1 << e
+      next unless p
+
+      member_el = XML::Node.new "member"
+      member_el["type"] = member.member_type.downcase
+      member_el["ref"] = member.member_id.to_s
+      member_el["role"] = member.member_role
+      el << member_el

     end
     end

-    return el1
-  end 

 
 

-  # FIXME is this really needed?
+    add_tags_to_xml_node(el, relation_tags)
+
+    el
+  end
+
+  # FIXME: is this really needed?

   def members
   def members

-    @members ||= self.relation_members.map do |member|
+    @members ||= relation_members.map do |member|

       [member.member_type, member.member_id, member.member_role]
     end
   end
 
   def tags
       [member.member_type, member.member_id, member.member_role]
     end
   end
 
   def tags

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

   end
 
   end
 

-  def members=(m)
-    @members = m
-  end
+  attr_writer :members

 
 

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

 
   def add_member(type, id, role)
     @members ||= []
 
   def add_member(type, id, role)
     @members ||= []


@@ -173,38 +155,38 @@ class Relation < ActiveRecord::Base
   end
 
   def add_tag_keyval(k, v)
   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.
 
     # duplicate tags are now forbidden, so we can't allow values
     # in the hash to be overwritten.

-    raise OSM::APIDuplicateTagsError.new("relation", self.id, k) if @tags.include? k
+    raise OSM::APIDuplicateTagsError.new("relation", id, k) if @tags.include? k

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

-  # updates the changeset bounding box to contain the bounding box of 
+  # updates the changeset bounding box to contain the bounding box of

   # the element with given +type+ and +id+. this only works with nodes
   # and ways at the moment, as they're the only elements to respond to
   # the :bbox call.
   def update_changeset_element(type, id)
     element = Kernel.const_get(type.capitalize).find(id)
     changeset.update_bbox! element.bbox
   # the element with given +type+ and +id+. this only works with nodes
   # and ways at the moment, as they're the only elements to respond to
   # the :bbox call.
   def update_changeset_element(type, id)
     element = Kernel.const_get(type.capitalize).find(id)
     changeset.update_bbox! element.bbox

-  end    
+  end

 
   def delete_with_history!(new_relation, user)
 
   def delete_with_history!(new_relation, user)

-    unless self.visible
+    unless visible

       raise OSM::APIAlreadyDeletedError.new("relation", new_relation.id)
     end
 
       raise OSM::APIAlreadyDeletedError.new("relation", new_relation.id)
     end
 

-    # need to start the transaction here, so that the database can 
+    # 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.
     Relation.transaction do
     # provide repeatable reads for the used-by checks. this means it
     # shouldn't be possible to get race conditions.
     Relation.transaction do

-      self.lock!
+      lock!

       check_consistency(self, new_relation, user)
       # This will check to see if this relation is used by another relation
       check_consistency(self, new_relation, user)
       # This will check to see if this relation is used by another relation

-      rel = RelationMember.joins(:relation).where("visible = ? AND member_type = 'Relation' and member_id = ? ", true, self.id).first
+      rel = RelationMember.joins(:relation).find_by("visible = ? AND member_type = 'Relation' and member_id = ? ", true, id)

       raise OSM::APIPreconditionFailedError.new("The relation #{new_relation.id} is used in relation #{rel.relation.id}.") unless rel.nil?
 
       self.changeset_id = new_relation.changeset_id
       raise OSM::APIPreconditionFailedError.new("The relation #{new_relation.id} is used in relation #{rel.relation.id}.") unless rel.nil?
 
       self.changeset_id = new_relation.changeset_id


@@ -217,10 +199,10 @@ class Relation < ActiveRecord::Base
 
   def update_from(new_relation, user)
     Relation.transaction do
 
   def update_from(new_relation, user)
     Relation.transaction do

-      self.lock!
+      lock!

       check_consistency(self, new_relation, user)
       check_consistency(self, new_relation, user)

-      unless new_relation.preconditions_ok?(self.members)
-        raise OSM::APIPreconditionFailedError.new("Cannot update relation #{self.id}: data or member data is invalid.")
+      unless new_relation.preconditions_ok?(members)
+        raise OSM::APIPreconditionFailedError.new("Cannot update relation #{id}: data or member data is invalid.")

       end
       self.changeset_id = new_relation.changeset_id
       self.changeset = new_relation.changeset
       end
       self.changeset_id = new_relation.changeset_id
       self.changeset = new_relation.changeset


@@ -230,10 +212,10 @@ class Relation < ActiveRecord::Base
       save_with_history!
     end
   end
       save_with_history!
     end
   end

-  
+

   def create_with_history(user)
     check_create_consistency(self, user)
   def create_with_history(user)
     check_create_consistency(self, user)

-    unless self.preconditions_ok?
+    unless preconditions_ok?

       raise OSM::APIPreconditionFailedError.new("Cannot create relation: data or member data is invalid.")
     end
     self.version = 0
       raise OSM::APIPreconditionFailedError.new("Cannot create relation: data or member data is invalid.")
     end
     self.version = 0


@@ -242,50 +224,49 @@ class Relation < ActiveRecord::Base
   end
 
   def preconditions_ok?(good_members = [])
   end
 
   def preconditions_ok?(good_members = [])

-    # These are hastables that store an id in the index of all 
+    # These are hastables that store an id in the index of all

     # the nodes/way/relations that have already been added.
     # the nodes/way/relations that have already been added.

-    # If the member is valid and visible then we add it to the 
+    # If the member is valid and visible then we add it to the

     # relevant hash table, with the value true as a cache.
     # Thus if you have nodes with the ids of 50 and 1 already in the
     # relation, then the hash table nodes would contain:
     # => {50=>true, 1=>true}
     # relevant hash table, with the value true as a cache.
     # Thus if you have nodes with the ids of 50 and 1 already in the
     # relation, then the hash table nodes would contain:
     # => {50=>true, 1=>true}

-    elements = { :node => Hash.new, :way => Hash.new, :relation => Hash.new }
+    elements = { :node => {}, :way => {}, :relation => {} }

 
     # pre-set all existing members to good
     good_members.each { |m| elements[m[0].downcase.to_sym][m[1]] = true }
 
 
     # pre-set all existing members to good
     good_members.each { |m| elements[m[0].downcase.to_sym][m[1]] = true }
 

-    self.members.each do |m|
+    members.each do |m|

       # find the hash for the element type or die
       # find the hash for the element type or die

-      hash = elements[m[0].downcase.to_sym] or return false
+      hash = elements[m[0].downcase.to_sym]
+      return false unless hash
+

       # unless its in the cache already
       # unless its in the cache already

-      unless hash.key? m[1]
-        # use reflection to look up the appropriate class
-        model = Kernel.const_get(m[0].capitalize)
-        # get the element with that ID
-        element = model.where(:id => m[1]).first
-
-        # and check that it is OK to use.
-        unless element and element.visible? and element.preconditions_ok?
-          raise OSM::APIPreconditionFailedError.new("Relation with id #{self.id} cannot be saved due to #{m[0]} with id #{m[1]}")
-        end
-        hash[m[1]] = true
+      next if hash.key? m[1]
+
+      # use reflection to look up the appropriate class
+      model = Kernel.const_get(m[0].capitalize)
+      # get the element with that ID. and, if found, lock the element to
+      # ensure it can't be deleted until after the current transaction
+      # commits.
+      element = model.lock("for share").find_by(:id => m[1])
+
+      # and check that it is OK to use.
+      unless element && element.visible? && element.preconditions_ok?
+        raise OSM::APIPreconditionFailedError.new("Relation with id #{id} cannot be saved due to #{m[0]} with id #{m[1]}")

       end
       end

+      hash[m[1]] = true

     end
 
     end
 

-    return true
-  end
-
-  # Temporary method to match interface to nodes
-  def tags_as_hash
-    return self.tags
+    true

   end
 
   ##
   # if any members are referenced by placeholder IDs (i.e: negative) then
   end
 
   ##
   # if any members are referenced by placeholder IDs (i.e: negative) then

-  # this calling this method will fix them using the map from placeholders 
-  # to IDs +id_map+. 
+  # this calling this method will fix them using the map from placeholders
+  # to IDs +id_map+.

   def fix_placeholders!(id_map, placeholder_id = nil)
   def fix_placeholders!(id_map, placeholder_id = nil)

-    self.members.map! do |type, id, role|
+    members.map! do |type, id, role|

       old_id = id.to_i
       if old_id < 0
         new_id = id_map[type.downcase.to_sym][old_id]
       old_id = id.to_i
       if old_id < 0
         new_id = id_map[type.downcase.to_sym][old_id]


@@ -298,7 +279,7 @@ class Relation < ActiveRecord::Base
   end
 
   private
   end
 
   private

-  
+

   def save_with_history!
     Relation.transaction do
       # have to be a little bit clever here - to detect if any tags
   def save_with_history!
     Relation.transaction do
       # have to be a little bit clever here - to detect if any tags


@@ -308,16 +289,16 @@ class Relation < ActiveRecord::Base
       t = Time.now.getutc
       self.version += 1
       self.timestamp = t
       t = Time.now.getutc
       self.version += 1
       self.timestamp = t

-      self.save!
+      save!

 
       tags = self.tags.clone
 
       tags = self.tags.clone

-      self.relation_tags.each do |old_tag|
+      relation_tags.each do |old_tag|

         key = old_tag.k
         # if we can match the tags we currently have to the list
         # of old tags, then we never set the tags_changed flag. but
         key = old_tag.k
         # if we can match the tags we currently have to the list
         # of old tags, then we never set the tags_changed flag. but

-        # if any are different then set the flag and do the DB 
+        # if any are different then set the flag and do the DB

         # update.
         # update.

-        if tags.has_key? key 
+        if tags.key? key

           tags_changed |= (old_tag.v != tags[key])
 
           # remove from the map, so that we can expect an empty map
           tags_changed |= (old_tag.v != tags[key])
 
           # remove from the map, so that we can expect an empty map


@@ -331,22 +312,22 @@ class Relation < ActiveRecord::Base
       end
       # if there are left-over tags then they are new and will have to
       # be added.
       end
       # if there are left-over tags then they are new and will have to
       # be added.

-      tags_changed |= (not tags.empty?)
-      RelationTag.delete_all(:relation_id => self.id)
-      self.tags.each do |k,v|
+      tags_changed |= !tags.empty?
+      RelationTag.delete_all(:relation_id => id)
+      self.tags.each do |k, v|

         tag = RelationTag.new
         tag = RelationTag.new

-        tag.relation_id = self.id
+        tag.relation_id = id

         tag.k = k
         tag.v = v
         tag.save!
       end
         tag.k = k
         tag.v = v
         tag.save!
       end

-      
+

       # same pattern as before, but this time we're collecting the
       # changed members in an array, as the bounding box updates for
       # elements are per-element, not blanked on/off like for tags.
       # same pattern as before, but this time we're collecting the
       # changed members in an array, as the bounding box updates for
       # elements are per-element, not blanked on/off like for tags.

-      changed_members = Array.new
+      changed_members = []

       members = self.members.clone
       members = self.members.clone

-      self.relation_members.each do |old_member|
+      relation_members.each do |old_member|

         key = [old_member.member_type, old_member.member_id, old_member.member_role]
         i = members.index key
         if i.nil?
         key = [old_member.member_type, old_member.member_id, old_member.member_role]
         i = members.index key
         if i.nil?


@@ -362,10 +343,10 @@ class Relation < ActiveRecord::Base
       # members may be in a different order and i don't feel like implementing
       # a longest common subsequence algorithm to optimise this.
       members = self.members
       # members may be in a different order and i don't feel like implementing
       # a longest common subsequence algorithm to optimise this.
       members = self.members

-      RelationMember.delete_all(:relation_id => self.id)
-      members.each_with_index do |m,i|
+      RelationMember.delete_all(:relation_id => id)
+      members.each_with_index do |m, i|

         mem = RelationMember.new
         mem = RelationMember.new

-        mem.relation_id = self.id
+        mem.relation_id = id

         mem.sequence_id = i
         mem.member_type = m[0]
         mem.member_id = m[1]
         mem.sequence_id = i
         mem.member_type = m[0]
         mem.member_id = m[1]


@@ -387,22 +368,20 @@ class Relation < ActiveRecord::Base
       # bounding box. this is similar to how the map call does things and is
       # reasonable on the assumption that adding or removing members doesn't
       # materially change the rest of the relation.
       # bounding box. this is similar to how the map call does things and is
       # reasonable on the assumption that adding or removing members doesn't
       # materially change the rest of the relation.

-      any_relations = 
-        changed_members.collect { |id,type| type == "relation" }.
-        inject(false) { |b,s| b or s }
+      any_relations =
+        changed_members.collect { |_id, type| type == "relation" }
+                       .inject(false) { |a, e| a || e }

 
 

-      update_members = if tags_changed or any_relations
+      update_members = if tags_changed || any_relations

                          # add all non-relation bounding boxes to the changeset
                          # FIXME: check for tag changes along with element deletions and
                          # make sure that the deleted element's bounding box is hit.
                          self.members
                          # add all non-relation bounding boxes to the changeset
                          # FIXME: check for tag changes along with element deletions and
                          # make sure that the deleted element's bounding box is hit.
                          self.members

-                       else 
+                       else

                          changed_members
                        end
                          changed_members
                        end

-      update_members.each do |type, id, role|
-        if type != "Relation"
-          update_changeset_element(type, id)
-        end
+      update_members.each do |type, id, _role|
+        update_changeset_element(type, id) if type != "Relation"

       end
 
       # tell the changeset we updated one element only
       end
 
       # tell the changeset we updated one element only


@@ -412,5 +391,4 @@ class Relation < ActiveRecord::Base
       changeset.save!
     end
   end
       changeset.save!
     end
   end

-

 end
 end