X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/0ff1214f86ac1347bb257abfda70581cc78903dd..b946779b845b298639c99e92407e8200d66814c1:/app/models/relation.rb

diff --git a/app/models/relation.rb b/app/models/relation.rb
index 2a2ec3dca..e3ba69b56 100644
--- a/app/models/relation.rb
+++ b/app/models/relation.rb
@@ -15,19 +15,26 @@ class Relation < ActiveRecord::Base
   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
+  
   TYPES = ["node", "way", "relation"]
 
   def self.from_xml(xml, create=false)
     begin
-      p = XML::Parser.new
-      p.string = xml
+      p = XML::Parser.string(xml)
       doc = p.parse
 
       doc.find('//osm/relation').each do |pt|
         return Relation.from_xml_node(pt, create)
       end
-    rescue LibXML::XML::Error => ex
-      #return nil
+      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
@@ -35,23 +42,27 @@ class Relation < ActiveRecord::Base
   def self.from_xml_node(pt, create=false)
     relation = Relation.new
 
-    if !create and pt['id'] != '0'
-      relation.id = pt['id'].to_i
-    end
-
+    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']
-
-    if create
-      relation.timestamp = Time.now
-      relation.visible = true
-    else
-      if pt['timestamp']
-        relation.timestamp = Time.parse(pt['timestamp'])
-      end
+    
+    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. 
+      # 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
+    # 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
 
     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
 
@@ -64,7 +75,7 @@ class Relation < ActiveRecord::Base
       #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'], member['ref'], member['role'])
+      relation.add_member(member['type'].classify, member['ref'], member['role'])
     end
     raise OSM::APIBadUserInput.new("Some bad xml in relation") if relation.nil?
 
@@ -77,7 +88,7 @@ class Relation < ActiveRecord::Base
     return doc
   end
 
-  def to_xml_node(user_display_name_cache = nil)
+  def to_xml_node(visible_members = nil, changeset_cache = {}, user_display_name_cache = {})
     el1 = XML::Node.new 'relation'
     el1['id'] = self.id.to_s
     el1['visible'] = self.visible.to_s
@@ -85,37 +96,43 @@ class Relation < ActiveRecord::Base
     el1['version'] = self.version.to_s
     el1['changeset'] = self.changeset_id.to_s
 
-    user_display_name_cache = {} if user_display_name_cache.nil?
-    
-    if user_display_name_cache and user_display_name_cache.key?(self.changeset.user_id)
+    if changeset_cache.key?(self.changeset_id)
+      # use the cache if available
+    else
+      changeset_cache[self.changeset_id] = self.changeset.user_id
+    end
+
+    user_id = changeset_cache[self.changeset_id]
+
+    if user_display_name_cache.key?(user_id)
       # use the cache if available
     elsif self.changeset.user.data_public?
-      user_display_name_cache[self.changeset.user_id] = self.changeset.user.display_name
+      user_display_name_cache[user_id] = self.changeset.user.display_name
     else
-      user_display_name_cache[self.changeset.user_id] = nil
+      user_display_name_cache[user_id] = nil
     end
 
-    if not user_display_name_cache[self.changeset.user_id].nil?
-      el1['user'] = user_display_name_cache[self.changeset.user_id]
-      el1['uid'] = self.changeset.user_id.to_s
+    if not user_display_name_cache[user_id].nil?
+      el1['user'] = user_display_name_cache[user_id]
+      el1['uid'] = user_id.to_s
     end
 
     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[member.member_type][member.member_id]
-      #    p=1
-      #  end
-      #else
+      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
+      else
         # otherwise, manually go to the db to check things
         if member.member.visible?
           p=1
         end
-      #end
+      end
       if p
         e = XML::Node.new 'member'
-        e['type'] = member.member_type
+        e['type'] = member.member_type.downcase
         e['ref'] = member.member_id.to_s 
         e['role'] = member.member_role
         el1 << e
@@ -135,7 +152,7 @@ class Relation < ActiveRecord::Base
     if ids.empty?
       return []
     else
-      self.with_scope(:find => { :joins => "INNER JOIN current_relation_members ON current_relation_members.id = current_relations.id", :conditions => "current_relation_members.member_type = 'node' AND current_relation_members.member_id IN (#{ids.join(',')})" }) do
+      self.with_scope(:find => { :joins => "INNER JOIN current_relation_members AS crm ON crm.id = current_relations.id", :conditions => "crm.member_type = 'Node' AND crm.member_id IN (#{ids.join(',')})" }) do
         return self.find(:all, options)
       end
     end
@@ -145,7 +162,7 @@ class Relation < ActiveRecord::Base
     if ids.empty?
       return []
     else
-      self.with_scope(:find => { :joins => "INNER JOIN current_relation_members ON current_relation_members.id = current_relations.id", :conditions => "current_relation_members.member_type = 'way' AND current_relation_members.member_id IN (#{ids.join(',')})" }) do
+      self.with_scope(:find => { :joins => "INNER JOIN current_relation_members AS crm ON crm.id = current_relations.id", :conditions => "crm.member_type = 'Way' AND crm.member_id IN (#{ids.join(',')})" }) do
         return self.find(:all, options)
       end
     end
@@ -155,7 +172,7 @@ class Relation < ActiveRecord::Base
     if ids.empty?
       return []
     else
-      self.with_scope(:find => { :joins => "INNER JOIN current_relation_members ON current_relation_members.id = current_relations.id", :conditions => "current_relation_members.member_type = 'relation' AND current_relation_members.member_id IN (#{ids.join(',')})" }) do
+      self.with_scope(:find => { :joins => "INNER JOIN current_relation_members AS crm ON crm.id = current_relations.id", :conditions => "crm.member_type = 'Relation' AND crm.member_id IN (#{ids.join(',')})" }) do
         return self.find(:all, options)
       end
     end
@@ -192,7 +209,7 @@ class Relation < ActiveRecord::Base
 
   def add_member(type,id,role)
     @members = Array.new unless @members
-    @members += [[type,id,role]]
+    @members += [[type,id.to_i,role]]
   end
 
   def add_tag_keyval(k, v)
@@ -200,23 +217,141 @@ class Relation < ActiveRecord::Base
 
     # duplicate tags are now forbidden, so we can't allow values
     # in the hash to be overwritten.
-    raise OSM::APIDuplicateTagsError.new if @tags.include? k
+    raise OSM::APIDuplicateTagsError.new("relation", self.id, k) if @tags.include? k
 
     @tags[k] = v
   end
 
+  ##
+  # 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
+  end    
+
+  def delete_with_history!(new_relation, user)
+    unless self.visible
+      raise OSM::APIAlreadyDeletedError.new("relation", new_relation.id)
+    end
+
+    # 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
+      self.lock!
+      check_consistency(self, new_relation, user)
+      # This will check to see if this relation is used by another relation
+      rel = RelationMember.find(:first, :joins => :relation, 
+                                :conditions => [ "visible = ? AND member_type='Relation' and member_id=? ", true, self.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
+      self.tags = {}
+      self.members = []
+      self.visible = false
+      save_with_history!
+    end
+  end
+
+  def update_from(new_relation, user)
+    Relation.transaction do
+      self.lock!
+      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.")
+      end
+      self.changeset_id = new_relation.changeset_id
+      self.changeset = new_relation.changeset
+      self.tags = new_relation.tags
+      self.members = new_relation.members
+      self.visible = true
+      save_with_history!
+    end
+  end
+  
+  def create_with_history(user)
+    check_create_consistency(self, user)
+    unless self.preconditions_ok?
+      raise OSM::APIPreconditionFailedError.new("Cannot create relation: data or member data is invalid.")
+    end
+    self.version = 0
+    self.visible = true
+    save_with_history!
+  end
+
+  def preconditions_ok?(good_members = [])
+    # These are hastables that store an id in the index of all 
+    # the nodes/way/relations that have already been added.
+    # 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}
+    elements = { :node => Hash.new, :way => Hash.new, :relation => Hash.new }
+
+    # 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|
+      # find the hash for the element type or die
+      hash = elements[m[0].downcase.to_sym] or return false
+      # 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.find(:first, :conditions =>["id = ?", m[1]])
+
+        # 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
+      end
+    end
+
+    return true
+  end
+
+  # Temporary method to match interface to nodes
+  def tags_as_hash
+    return self.tags
+  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+. 
+  def fix_placeholders!(id_map, placeholder_id = nil)
+    self.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]
+        raise OSM::APIBadUserInput.new("Placeholder #{type} not found for reference #{old_id} in relation #{self.id.nil? ? placeholder_id : self.id}.") if new_id.nil?
+        [type, new_id, role]
+      else
+        [type, id, role]
+      end
+    end
+  end
+
+  private
+  
   def save_with_history!
     Relation.transaction do
       # have to be a little bit clever here - to detect if any tags
       # changed then we have to monitor their before and after state.
       tags_changed = false
 
-      t = Time.now
+      t = Time.now.getutc
       self.version += 1
       self.timestamp = t
       self.save!
 
-      tags = self.tags
+      tags = self.tags.clone
       self.relation_tags.each do |old_tag|
         key = old_tag.k
         # if we can match the tags we currently have to the list
@@ -224,11 +359,7 @@ class Relation < ActiveRecord::Base
         # if any are different then set the flag and do the DB 
         # update.
         if tags.has_key? key 
-          # rails 2.1 dirty handling should take care of making this
-          # somewhat efficient... hopefully...
-          old_tag.v = tags[key]
-          tags_changed |= old_tag.changed?
-          old_tag.save!
+          tags_changed |= (old_tag.v != tags[key])
 
           # remove from the map, so that we can expect an empty map
           # at the end if there are no new tags
@@ -237,39 +368,36 @@ class Relation < ActiveRecord::Base
         else
           # this means a tag was deleted
           tags_changed = true
-          RelationTag.delete_all ['id = ? and k = ?', self.id, old_tag.k]
         end
       end
       # if there are left-over tags then they are new and will have to
       # be added.
       tags_changed |= (not tags.empty?)
-      tags.each do |k,v|
+      RelationTag.delete_all(:id => self.id)
+      self.tags.each do |k,v|
         tag = RelationTag.new
         tag.k = k
         tag.v = v
         tag.id = self.id
         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.
       changed_members = Array.new
-      members = Hash.new
-      self.members.each do |m|
-        # should be: h[[m.id, m.type]] = m.role, but someone prefers arrays
-        members[[m[1], m[0]]] = m[2]
-      end
-      relation_members.each do |old_member|
-        key = [old_member.member_id.to_s, old_member.member_type]
-        if members.has_key? key
-          members.delete key
-        else
+      members = self.members.clone
+      self.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?
           changed_members << key
+        else
+          members.delete_at i
         end
       end
       # any remaining members must be new additions
-      changed_members += members.keys
+      changed_members += members
 
       # update the members. first delete all the old members, as the new
       # members may be in a different order and i don't feel like implementing
@@ -303,18 +431,16 @@ class Relation < ActiveRecord::Base
         changed_members.collect { |id,type| type == "relation" }.
         inject(false) { |b,s| b or s }
 
-      if tags_changed or 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.each do |type, id, role|
-          if type != "relation"
-            update_changeset_element(type, id)
-          end
-        end
-      else
-        # add only changed members to the changeset
-        changed_members.each do |id, type|
+      update_members = if tags_changed or 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
+                       else 
+                         changed_members
+                       end
+      update_members.each do |type, id, role|
+        if type != "Relation"
           update_changeset_element(type, id)
         end
       end
@@ -327,109 +453,4 @@ class Relation < ActiveRecord::Base
     end
   end
 
-  ##
-  # 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
-  end    
-
-  def delete_with_history!(new_relation, user)
-    if self.visible
-      check_consistency(self, new_relation, user)
-      if RelationMember.find(:first, :joins => "INNER JOIN current_relations ON current_relations.id=current_relation_members.id", :conditions => [ "visible = ? AND member_type='relation' and member_id=? ", true, self.id ])
-        raise OSM::APIPreconditionFailedError.new
-      else
-        self.changeset_id = new_relation.changeset_id
-        self.tags = {}
-        self.members = []
-        self.visible = false
-        save_with_history!
-      end
-    else
-      raise OSM::APIAlreadyDeletedError.new
-    end
-  end
-
-  def update_from(new_relation, user)
-    check_consistency(self, new_relation, user)
-    if !new_relation.preconditions_ok?
-      raise OSM::APIPreconditionFailedError.new
-    end
-    self.changeset_id = new_relation.changeset_id
-    self.tags = new_relation.tags
-    self.members = new_relation.members
-    self.visible = true
-    save_with_history!
-  end
-  
-  def create_with_history(user)
-    check_create_consistency(self, user)
-    if !self.preconditions_ok?
-      raise OSM::APIPreconditionFailedError.new
-    end
-    self.version = 0
-    self.visible = true
-    save_with_history!
-  end
-
-  def preconditions_ok?
-    # These are hastables that store an id in the index of all 
-    # the nodes/way/relations that have already been added.
-    # 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}
-    elements = { :node => Hash.new, :way => Hash.new, :relation => Hash.new }
-    self.members.each do |m|
-      # find the hash for the element type or die
-      hash = elements[m[0].to_sym] or return false
-
-      # 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.find(m[1])
-
-        # and check that it is OK to use.
-        unless element and element.visible? and element.preconditions_ok?
-          return false
-        end
-        hash[m[1]] = true
-      end
-    end
-
-    return true
-  rescue
-    return false
-  end
-
-  # Temporary method to match interface to nodes
-  def tags_as_hash
-    return self.tags
-  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+. 
-  def fix_placeholders!(id_map)
-    self.members.map! do |type, id, role|
-      old_id = id.to_i
-      if old_id < 0
-        new_id = id_map[type.to_sym][old_id]
-        raise "invalid placeholder" if new_id.nil?
-        [type, new_id, role]
-      else
-        [type, id, role]
-      end
-    end
-  end
-
 end