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