new version with small Haiti-related improvements

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

diff --git a/app/models/relation.rb b/app/models/relation.rb
index 4b5d9e32b89ac90832e674e5434e328e1e0f92bc..e3ba69b56386dae78e9df50a0f3225eb63ae2dda 100644 (file)
--- a/app/models/relation.rb
+++ b/app/models/relation.rb
@@ -33,6 +33,7 @@ class Relation < ActiveRecord::Base
       doc.find('//osm/relation').each do |pt|
         return Relation.from_xml_node(pt, create)
       end
       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)
     end
     rescue LibXML::XML::Error, ArgumentError => ex
       raise OSM::APIBadXMLError.new("relation", xml, ex.message)
     end


@@ -41,27 +42,27 @@ class Relation < ActiveRecord::Base
   def self.from_xml_node(pt, create=false)
     relation = Relation.new
 
   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, "You are missing the required changeset in the relation") if pt['changeset'].nil?
+    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']
     relation.changeset_id = pt['changeset']

-
-    # The follow block does not need to be executed because they are dealt with 
-    # in create_with_history, update_from and delete_with_history
-    if create
-      relation.timestamp = Time.now
-      relation.visible = true
-      relation.version = 0
-    else
-      if pt['timestamp']
-        relation.timestamp = Time.parse(pt['timestamp'])
-      end
-      relation.version = pt['version']
+    
+    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
     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|
 
     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
 
       relation.add_tag_keyval(tag['k'], tag['v'])
     end
 


@@ -74,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']
       #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?
 
     end
     raise OSM::APIBadUserInput.new("Some bad xml in relation") if relation.nil?
 


@@ -87,7 +88,7 @@ class Relation < ActiveRecord::Base
     return doc
   end
 
     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
     el1 = XML::Node.new 'relation'
     el1['id'] = self.id.to_s
     el1['visible'] = self.visible.to_s


@@ -95,37 +96,43 @@ class Relation < ActiveRecord::Base
     el1['version'] = self.version.to_s
     el1['changeset'] = self.changeset_id.to_s
 
     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?
       # 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
     else

-      user_display_name_cache[self.changeset.user_id] = nil
+      user_display_name_cache[user_id] = nil

     end
 
     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
     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
         # 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'
       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
         e['ref'] = member.member_id.to_s 
         e['role'] = member.member_role
         el1 << e


@@ -145,7 +152,7 @@ class Relation < ActiveRecord::Base
     if ids.empty?
       return []
     else
     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
         return self.find(:all, options)
       end
     end


@@ -155,7 +162,7 @@ class Relation < ActiveRecord::Base
     if ids.empty?
       return []
     else
     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
         return self.find(:all, options)
       end
     end


@@ -165,7 +172,7 @@ class Relation < ActiveRecord::Base
     if ids.empty?
       return []
     else
     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
         return self.find(:all, options)
       end
     end


@@ -202,7 +209,7 @@ class Relation < ActiveRecord::Base
 
   def add_member(type,id,role)
     @members = Array.new unless @members
 
   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)
   end
 
   def add_tag_keyval(k, v)


@@ -227,18 +234,20 @@ class Relation < ActiveRecord::Base
 
   def delete_with_history!(new_relation, user)
     unless self.visible
 
   def delete_with_history!(new_relation, user)
     unless self.visible

-      raise OSM::APIAlreadyDeletedError.new
+      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
     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
       check_consistency(self, new_relation, user)
       # This will check to see if this relation is used by another relation

-      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("The relation #{new_relation.id} is a used in another relation")
-      end
+      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.changeset_id = new_relation.changeset_id
       self.tags = {}
       self.members = []


@@ -248,29 +257,32 @@ class Relation < ActiveRecord::Base
   end
 
   def update_from(new_relation, user)
   end
 
   def update_from(new_relation, user)

-    check_consistency(self, new_relation, user)
-    if !new_relation.preconditions_ok?
-      raise OSM::APIPreconditionFailedError.new
+    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

-    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
   
   def create_with_history(user)
     check_create_consistency(self, user)
   end
   
   def create_with_history(user)
     check_create_consistency(self, user)

-    if !self.preconditions_ok?
-      raise OSM::APIPreconditionFailedError.new
+    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
 
     end
     self.version = 0
     self.visible = true
     save_with_history!
   end
 

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


@@ -279,29 +291,29 @@ class Relation < ActiveRecord::Base
     # relation, then the hash table nodes would contain:
     # => {50=>true, 1=>true}
     elements = { :node => Hash.new, :way => Hash.new, :relation => Hash.new }
     # 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
     self.members.each do |m|
       # find the hash for the element type or die

-      hash = elements[m[0].to_sym] or return false
-
+      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)
       # 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
         # get the element with that ID

-        element = model.find(m[1])
+        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?
 
         # and check that it is OK to use.
         unless element and element.visible? and element.preconditions_ok?

-          return false
+          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
         hash[m[1]] = true
       end
     end
 
     return true

-  rescue
-    return false

   end
 
   # Temporary method to match interface to nodes
   end
 
   # Temporary method to match interface to nodes


@@ -313,12 +325,12 @@ class Relation < ActiveRecord::Base
   # 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+. 
   # 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)
+  def fix_placeholders!(id_map, placeholder_id = nil)

     self.members.map! do |type, id, role|
       old_id = id.to_i
       if old_id < 0
     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?
+        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]
         [type, new_id, role]
       else
         [type, id, role]


@@ -334,12 +346,12 @@ class Relation < ActiveRecord::Base
       # changed then we have to monitor their before and after state.
       tags_changed = false
 
       # 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!
 
       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
       self.relation_tags.each do |old_tag|
         key = old_tag.k
         # if we can match the tags we currently have to the list


@@ -347,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 
         # 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
 
           # remove from the map, so that we can expect an empty map
           # at the end if there are no new tags


@@ -360,13 +368,13 @@ class Relation < ActiveRecord::Base
         else
           # this means a tag was deleted
           tags_changed = true
         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?)
         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 = RelationTag.new
         tag.k = k
         tag.v = v


@@ -374,29 +382,22 @@ class Relation < ActiveRecord::Base
         tag.save!
       end
       
         tag.save!
       end
       

-      # reload, so that all of the members are accessible in their
-      # new state.
-      self.reload
-

       # 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
       # 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
           changed_members << key

+        else
+          members.delete_at i

         end
       end
       # any remaining members must be new additions
         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
 
       # 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


@@ -430,18 +431,16 @@ class Relation < ActiveRecord::Base
         changed_members.collect { |id,type| type == "relation" }.
         inject(false) { |b,s| b or s }
 
         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
           update_changeset_element(type, id)
         end
       end