X-Git-Url: https://git.openstreetmap.org/rails.git/blobdiff_plain/ec264a935e728d47e8167a3f7e43ea4c4e66875a..c6eb4d58569d84d5181eb3dbe58f4da95b9e176a:/app/models/relation.rb diff --git a/app/models/relation.rb b/app/models/relation.rb index 61344bdfb..e3ba69b56 100644 --- a/app/models/relation.rb +++ b/app/models/relation.rb @@ -1,48 +1,83 @@ class Relation < ActiveRecord::Base require 'xml/libxml' - belongs_to :user + include ConsistencyValidations + + set_table_name 'current_relations' - has_many :relation_members, :foreign_key => 'id' - has_many :relation_tags, :foreign_key => 'id' + belongs_to :changeset has_many :old_relations, :foreign_key => 'id', :order => 'version' - set_table_name 'current_relations' + has_many :relation_members, :foreign_key => 'id', :order => 'sequence_id' + has_many :relation_tags, :foreign_key => 'id' + + 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 - relation = Relation.new - doc.find('//osm/relation').each do |pt| - if !create and pt['id'] != '0' - relation.id = pt['id'].to_i - end + 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 + end - if create - relation.timestamp = Time.now - relation.visible = true - else - if pt['timestamp'] - relation.timestamp = Time.parse(pt['timestamp']) - end - end + def self.from_xml_node(pt, create=false) + relation = Relation.new - pt.find('tag').each do |tag| - relation.add_tag_keyval(tag['k'], tag['v']) - 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'] + + 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 - pt.find('member').each do |member| - relation.add_member(member['type'], member['ref'], member['role']) - end - end - rescue - relation = nil + 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']) end + raise OSM::APIBadUserInput.new("Some bad xml in relation") if relation.nil? return relation end @@ -53,40 +88,51 @@ 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 el1['timestamp'] = self.timestamp.xmlschema + 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.user_id) + if changeset_cache.key?(self.changeset_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 + changeset_cache[self.changeset_id] = self.changeset.user_id end - el1['user'] = user_display_name_cache[self.user_id] unless user_display_name_cache[self.user_id].nil? + 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[user_id] = self.changeset.user.display_name + else + user_display_name_cache[user_id] = nil + end + + 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 @@ -102,28 +148,35 @@ class Relation < ActiveRecord::Base return el1 end - - # collect relationships. currently done in one big block at the end; - # may need to move this upwards if people want automatic completion of - # relationships, i.e. deliver referenced objects like we do with ways... - # FIXME: rip out the fucking SQL - def self.find_for_nodes_and_ways(node_ids, way_ids) - relations = [] - - if node_ids.length > 0 - relations += Relation.find_by_sql("select e.* from current_relations e,current_relation_members em where " + - "e.visible=1 and " + - "em.id = e.id and em.member_type='node' and em.member_id in (#{node_ids.join(',')})") - end - if way_ids.length > 0 - relations += Relation.find_by_sql("select e.* from current_relations e,current_relation_members em where " + - "e.visible=1 and " + - "em.id = e.id and em.member_type='way' and em.member_id in (#{way_ids.join(',')})") + def self.find_for_nodes(ids, options = {}) + if ids.empty? + return [] + else + 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 + end - relations # if you don't do this then it returns nil and not [] + def self.find_for_ways(ids, options = {}) + if ids.empty? + return [] + else + 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 end + def self.find_for_relations(ids, options = {}) + if ids.empty? + return [] + else + 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 + end # FIXME is this really needed? def members @@ -156,75 +209,248 @@ 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) @tags = Hash.new unless @tags + + # 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 + @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 - t = Time.now + # 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.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 + # of old tags, then we never set the tags_changed flag. but + # if any are different then set the flag and do the DB + # update. + if tags.has_key? key + tags_changed |= (old_tag.v != tags[key]) - RelationTag.delete_all(['id = ?', self.id]) + # remove from the map, so that we can expect an empty map + # at the end if there are no new tags + tags.delete key - tags.each do |k,v| + else + # this means a tag was deleted + tags_changed = true + end + 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(: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 = 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 + # 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 + # a longest common subsequence algorithm to optimise this. members = self.members - - RelationMember.delete_all(['id = ?', self.id]) - - members.each do |n| + RelationMember.delete_all(:id => self.id) + members.each_with_index do |m,i| mem = RelationMember.new - mem.id = self.id - mem.member_type = n[0]; - mem.member_id = n[1]; - mem.member_role = n[2]; + mem.id = [self.id, i] + mem.member_type = m[0] + mem.member_id = m[1] + mem.member_role = m[2] mem.save! end old_relation = OldRelation.from_relation(self) old_relation.timestamp = t old_relation.save_with_dependencies! - end - end - def preconditions_ok? - self.members.each do |m| - if (m[0] == "node") - n = Node.find(:first, :conditions => ["id = ?", m[1]]) - unless n and n.visible - return false + # update the bbox of the changeset and save it too. + # discussion on the mailing list gave the following definition for + # the bounding box update procedure of a relation: + # + # adding or removing nodes or ways from a relation causes them to be + # added to the changeset bounding box. adding a relation member or + # changing tag values causes all node and way members to be added to the + # 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 } + + 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 - elsif (m[0] == "way") - w = Way.find(:first, :conditions => ["id = ?", m[1]]) - unless w and w.visible and w.preconditions_ok? - return false - end - elsif (m[0] == "relation") - e = Relation.find(:first, :conditions => ["id = ?", m[1]]) - unless e and e.visible and e.preconditions_ok? - return false - end - else - return false end + + # tell the changeset we updated one element only + changeset.add_changes! 1 + + # save the (maybe updated) changeset bounding box + changeset.save! end - return true - rescue - return false end end