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