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