app/models/relation.rb

   1 class Relation < ActiveRecord::Base
   2   require 'xml/libxml'
   3
   4   include ConsistencyValidations
   5
   6   set_table_name 'current_relations'
   7
   8   belongs_to :changeset
   9
  10   has_many :old_relations, :foreign_key => 'id', :order => 'version'
  11
  12   has_many :relation_members, :foreign_key => 'id', :order => 'sequence_id'
  13   has_many :relation_tags, :foreign_key => 'id'
  14
  15   has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
  16   has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation, :extend => ObjectFinder
  17
  18   validates_presence_of :id, :on => :update
  19   validates_presence_of :timestamp,:version,  :changeset_id
  20   validates_uniqueness_of :id
  21   validates_inclusion_of :visible, :in => [ true, false ]
  22   validates_numericality_of :id, :on => :update, :integer_only => true
  23   validates_numericality_of :changeset_id, :version, :integer_only => true
  24   validates_associated :changeset
  25
  26   TYPES = ["node", "way", "relation"]
  27
  28   def self.from_xml(xml, create=false)
  29     begin
  30       p = XML::Parser.string(xml)
  31       doc = p.parse
  32
  33       doc.find('//osm/relation').each do |pt|
  34         return Relation.from_xml_node(pt, create)
  35       end
  36     rescue LibXML::XML::Error, ArgumentError => ex
  37       raise OSM::APIBadXMLError.new("relation", xml, ex.message)
  38     end
  39   end
  40
  41   def self.from_xml_node(pt, create=false)
  42     relation = Relation.new
  43
  44     if !create and pt['id'] != '0'
  45       relation.id = pt['id'].to_i
  46     end
  47
  48     raise OSM::APIBadXMLError.new("relation", pt, "You are missing the required changeset in the relation") if pt['changeset'].nil?
  49     relation.changeset_id = pt['changeset']
  50
  51     # The follow block does not need to be executed because they are dealt with
  52     # in create_with_history, update_from and delete_with_history
  53     if create
  54       relation.timestamp = Time.now.getutc
  55       relation.visible = true
  56       relation.version = 0
  57     else
  58       if pt['timestamp']
  59         relation.timestamp = Time.parse(pt['timestamp'])
  60       end
  61       relation.version = pt['version']
  62     end
  63
  64     pt.find('tag').each do |tag|
  65       relation.add_tag_keyval(tag['k'], tag['v'])
  66     end
  67
  68     pt.find('member').each do |member|
  69       #member_type =
  70       logger.debug "each member"
  71       raise OSM::APIBadXMLError.new("relation", pt, "The #{member['type']} is not allowed only, #{TYPES.inspect} allowed") unless TYPES.include? member['type']
  72       logger.debug "after raise"
  73       #member_ref = member['ref']
  74       #member_role
  75       member['role'] ||= "" # Allow  the upload to not include this, in which case we default to an empty string.
  76       logger.debug member['role']
  77       relation.add_member(member['type'].classify, member['ref'], member['role'])
  78     end
  79     raise OSM::APIBadUserInput.new("Some bad xml in relation") if relation.nil?
  80
  81     return relation
  82   end
  83
  84   def to_xml
  85     doc = OSM::API.new.get_xml_doc
  86     doc.root << to_xml_node()
  87     return doc
  88   end
  89
  90   def to_xml_node(visible_members = nil, changeset_cache = {}, user_display_name_cache = {})
  91     el1 = XML::Node.new 'relation'
  92     el1['id'] = self.id.to_s
  93     el1['visible'] = self.visible.to_s
  94     el1['timestamp'] = self.timestamp.xmlschema
  95     el1['version'] = self.version.to_s
  96     el1['changeset'] = self.changeset_id.to_s
  97
  98     if changeset_cache.key?(self.changeset_id)
  99       # use the cache if available
 100     else
 101       changeset_cache[self.changeset_id] = self.changeset.user_id
 102     end
 103
 104     user_id = changeset_cache[self.changeset_id]
 105
 106     if user_display_name_cache.key?(user_id)
 107       # use the cache if available
 108     elsif self.changeset.user.data_public?
 109       user_display_name_cache[user_id] = self.changeset.user.display_name
 110     else
 111       user_display_name_cache[user_id] = nil
 112     end
 113
 114     if not user_display_name_cache[user_id].nil?
 115       el1['user'] = user_display_name_cache[user_id]
 116       el1['uid'] = user_id.to_s
 117     end
 118
 119     self.relation_members.each do |member|
 120       p=0
 121       if visible_members
 122         # if there is a list of visible members then use that to weed out deleted segments
 123         if visible_members[member.member_type][member.member_id]
 124           p=1
 125         end
 126       else
 127         # otherwise, manually go to the db to check things
 128         if member.member.visible?
 129           p=1
 130         end
 131       end
 132       if p
 133         e = XML::Node.new 'member'
 134         e['type'] = member.member_type.downcase
 135         e['ref'] = member.member_id.to_s
 136         e['role'] = member.member_role
 137         el1 << e
 138        end
 139     end
 140
 141     self.relation_tags.each do |tag|
 142       e = XML::Node.new 'tag'
 143       e['k'] = tag.k
 144       e['v'] = tag.v
 145       el1 << e
 146     end
 147     return el1
 148   end
 149
 150   def self.find_for_nodes(ids, options = {})
 151     if ids.empty?
 152       return []
 153     else
 154       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
 155         return self.find(:all, options)
 156       end
 157     end
 158   end
 159
 160   def self.find_for_ways(ids, options = {})
 161     if ids.empty?
 162       return []
 163     else
 164       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
 165         return self.find(:all, options)
 166       end
 167     end
 168   end
 169
 170   def self.find_for_relations(ids, options = {})
 171     if ids.empty?
 172       return []
 173     else
 174       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
 175         return self.find(:all, options)
 176       end
 177     end
 178   end
 179
 180   # FIXME is this really needed?
 181   def members
 182     unless @members
 183       @members = Array.new
 184       self.relation_members.each do |member|
 185         @members += [[member.member_type,member.member_id,member.member_role]]
 186       end
 187     end
 188     @members
 189   end
 190
 191   def tags
 192     unless @tags
 193       @tags = Hash.new
 194       self.relation_tags.each do |tag|
 195         @tags[tag.k] = tag.v
 196       end
 197     end
 198     @tags
 199   end
 200
 201   def members=(m)
 202     @members = m
 203   end
 204
 205   def tags=(t)
 206     @tags = t
 207   end
 208
 209   def add_member(type,id,role)
 210     @members = Array.new unless @members
 211     @members += [[type,id.to_i,role]]
 212   end
 213
 214   def add_tag_keyval(k, v)
 215     @tags = Hash.new unless @tags
 216
 217     # duplicate tags are now forbidden, so we can't allow values
 218     # in the hash to be overwritten.
 219     raise OSM::APIDuplicateTagsError.new("relation", self.id, k) if @tags.include? k
 220
 221     @tags[k] = v
 222   end
 223
 224   ##
 225   # updates the changeset bounding box to contain the bounding box of
 226   # the element with given +type+ and +id+. this only works with nodes
 227   # and ways at the moment, as they're the only elements to respond to
 228   # the :bbox call.
 229   def update_changeset_element(type, id)
 230     element = Kernel.const_get(type.capitalize).find(id)
 231     changeset.update_bbox! element.bbox
 232   end
 233
 234   def delete_with_history!(new_relation, user)
 235     unless self.visible
 236       raise OSM::APIAlreadyDeletedError.new("relation", new_relation.id)
 237     end
 238
 239     # need to start the transaction here, so that the database can
 240     # provide repeatable reads for the used-by checks. this means it
 241     # shouldn't be possible to get race conditions.
 242     Relation.transaction do
 243       self.lock!
 244       check_consistency(self, new_relation, user)
 245       # This will check to see if this relation is used by another relation
 246       rel = RelationMember.find(:first, :joins => :relation,
 247                                 :conditions => [ "visible = ? AND member_type='Relation' and member_id=? ", true, self.id ])
 248       raise OSM::APIPreconditionFailedError.new("The relation #{new_relation.id} is used in relation #{rel.relation.id}.") unless rel.nil?
 249
 250       self.changeset_id = new_relation.changeset_id
 251       self.tags = {}
 252       self.members = []
 253       self.visible = false
 254       save_with_history!
 255     end
 256   end
 257
 258   def update_from(new_relation, user)
 259     Relation.transaction do
 260       self.lock!
 261       check_consistency(self, new_relation, user)
 262       unless new_relation.preconditions_ok?(self.members)
 263         raise OSM::APIPreconditionFailedError.new("Cannot update relation #{self.id}: data or member data is invalid.")
 264       end
 265       self.changeset_id = new_relation.changeset_id
 266       self.changeset = new_relation.changeset
 267       self.tags = new_relation.tags
 268       self.members = new_relation.members
 269       self.visible = true
 270       save_with_history!
 271     end
 272   end
 273
 274   def create_with_history(user)
 275     check_create_consistency(self, user)
 276     unless self.preconditions_ok?
 277       raise OSM::APIPreconditionFailedError.new("Cannot create relation: data or member data is invalid.")
 278     end
 279     self.version = 0
 280     self.visible = true
 281     save_with_history!
 282   end
 283
 284   def preconditions_ok?(good_members = [])
 285     # These are hastables that store an id in the index of all
 286     # the nodes/way/relations that have already been added.
 287     # If the member is valid and visible then we add it to the
 288     # relevant hash table, with the value true as a cache.
 289     # Thus if you have nodes with the ids of 50 and 1 already in the
 290     # relation, then the hash table nodes would contain:
 291     # => {50=>true, 1=>true}
 292     elements = { :node => Hash.new, :way => Hash.new, :relation => Hash.new }
 293
 294     # pre-set all existing members to good
 295     good_members.each { |m| elements[m[0].downcase.to_sym][m[1]] = true }
 296
 297     self.members.each do |m|
 298       # find the hash for the element type or die
 299       hash = elements[m[0].downcase.to_sym] or return false
 300       # unless its in the cache already
 301       unless hash.key? m[1]
 302         # use reflection to look up the appropriate class
 303         model = Kernel.const_get(m[0].capitalize)
 304         # get the element with that ID
 305         element = model.find(:first, :conditions =>["id = ?", m[1]])
 306
 307         # and check that it is OK to use.
 308         unless element and element.visible? and element.preconditions_ok?
 309           raise OSM::APIPreconditionFailedError.new("Relation with id #{self.id} cannot be saved due to #{m[0]} with id #{m[1]}")
 310         end
 311         hash[m[1]] = true
 312       end
 313     end
 314
 315     return true
 316   end
 317
 318   # Temporary method to match interface to nodes
 319   def tags_as_hash
 320     return self.tags
 321   end
 322
 323   ##
 324   # if any members are referenced by placeholder IDs (i.e: negative) then
 325   # this calling this method will fix them using the map from placeholders
 326   # to IDs +id_map+.
 327   def fix_placeholders!(id_map, placeholder_id = nil)
 328     self.members.map! do |type, id, role|
 329       old_id = id.to_i
 330       if old_id < 0
 331         new_id = id_map[type.downcase.to_sym][old_id]
 332         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?
 333         [type, new_id, role]
 334       else
 335         [type, id, role]
 336       end
 337     end
 338   end
 339
 340   private
 341
 342   def save_with_history!
 343     Relation.transaction do
 344       # have to be a little bit clever here - to detect if any tags
 345       # changed then we have to monitor their before and after state.
 346       tags_changed = false
 347
 348       t = Time.now.getutc
 349       self.version += 1
 350       self.timestamp = t
 351       self.save!
 352
 353       tags = self.tags.clone
 354       self.relation_tags.each do |old_tag|
 355         key = old_tag.k
 356         # if we can match the tags we currently have to the list
 357         # of old tags, then we never set the tags_changed flag. but
 358         # if any are different then set the flag and do the DB
 359         # update.
 360         if tags.has_key? key
 361           tags_changed |= (old_tag.v != tags[key])
 362
 363           # remove from the map, so that we can expect an empty map
 364           # at the end if there are no new tags
 365           tags.delete key
 366
 367         else
 368           # this means a tag was deleted
 369           tags_changed = true
 370         end
 371       end
 372       # if there are left-over tags then they are new and will have to
 373       # be added.
 374       tags_changed |= (not tags.empty?)
 375       RelationTag.delete_all(:id => self.id)
 376       self.tags.each do |k,v|
 377         tag = RelationTag.new
 378         tag.k = k
 379         tag.v = v
 380         tag.id = self.id
 381         tag.save!
 382       end
 383
 384       # same pattern as before, but this time we're collecting the
 385       # changed members in an array, as the bounding box updates for
 386       # elements are per-element, not blanked on/off like for tags.
 387       changed_members = Array.new
 388       members = self.members.clone
 389       self.relation_members.each do |old_member|
 390         key = [old_member.member_type, old_member.member_id, old_member.member_role]
 391         i = members.index key
 392         if i.nil?
 393           changed_members << key
 394         else
 395           members.delete_at i
 396         end
 397       end
 398       # any remaining members must be new additions
 399       changed_members += members
 400
 401       # update the members. first delete all the old members, as the new
 402       # members may be in a different order and i don't feel like implementing
 403       # a longest common subsequence algorithm to optimise this.
 404       members = self.members
 405       RelationMember.delete_all(:id => self.id)
 406       members.each_with_index do |m,i|
 407         mem = RelationMember.new
 408         mem.id = [self.id, i]
 409         mem.member_type = m[0]
 410         mem.member_id = m[1]
 411         mem.member_role = m[2]
 412         mem.save!
 413       end
 414
 415       old_relation = OldRelation.from_relation(self)
 416       old_relation.timestamp = t
 417       old_relation.save_with_dependencies!
 418
 419       # update the bbox of the changeset and save it too.
 420       # discussion on the mailing list gave the following definition for
 421       # the bounding box update procedure of a relation:
 422       #
 423       # adding or removing nodes or ways from a relation causes them to be
 424       # added to the changeset bounding box. adding a relation member or
 425       # changing tag values causes all node and way members to be added to the
 426       # bounding box. this is similar to how the map call does things and is
 427       # reasonable on the assumption that adding or removing members doesn't
 428       # materially change the rest of the relation.
 429       any_relations =
 430         changed_members.collect { |id,type| type == "relation" }.
 431         inject(false) { |b,s| b or s }
 432
 433       update_members = if tags_changed or any_relations
 434                          # add all non-relation bounding boxes to the changeset
 435                          # FIXME: check for tag changes along with element deletions and
 436                          # make sure that the deleted element's bounding box is hit.
 437                          self.members
 438                        else
 439                          changed_members
 440                        end
 441       update_members.each do |type, id, role|
 442         if type != "Relation"
 443           update_changeset_element(type, id)
 444         end
 445       end
 446
 447       # tell the changeset we updated one element only
 448       changeset.add_changes! 1
 449
 450       # save the (maybe updated) changeset bounding box
 451       changeset.save!
 452     end
 453   end
 454
 455 end