Merge 14059:14394 from trunk.
[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.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'], 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(user_display_name_cache = nil)
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     user_display_name_cache = {} if user_display_name_cache.nil?
99     
100     if user_display_name_cache and user_display_name_cache.key?(self.changeset.user_id)
101       # use the cache if available
102     elsif self.changeset.user.data_public?
103       user_display_name_cache[self.changeset.user_id] = self.changeset.user.display_name
104     else
105       user_display_name_cache[self.changeset.user_id] = nil
106     end
107
108     if not user_display_name_cache[self.changeset.user_id].nil?
109       el1['user'] = user_display_name_cache[self.changeset.user_id]
110       el1['uid'] = self.changeset.user_id.to_s
111     end
112
113     self.relation_members.each do |member|
114       p=0
115       #if visible_members
116       #  # if there is a list of visible members then use that to weed out deleted segments
117       #  if visible_members[member.member_type][member.member_id]
118       #    p=1
119       #  end
120       #else
121         # otherwise, manually go to the db to check things
122         if member.member.visible?
123           p=1
124         end
125       #end
126       if p
127         e = XML::Node.new 'member'
128         e['type'] = member.member_type
129         e['ref'] = member.member_id.to_s 
130         e['role'] = member.member_role
131         el1 << e
132        end
133     end
134
135     self.relation_tags.each do |tag|
136       e = XML::Node.new 'tag'
137       e['k'] = tag.k
138       e['v'] = tag.v
139       el1 << e
140     end
141     return el1
142   end 
143
144   def self.find_for_nodes(ids, options = {})
145     if ids.empty?
146       return []
147     else
148       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
149         return self.find(:all, options)
150       end
151     end
152   end
153
154   def self.find_for_ways(ids, options = {})
155     if ids.empty?
156       return []
157     else
158       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
159         return self.find(:all, options)
160       end
161     end
162   end
163
164   def self.find_for_relations(ids, options = {})
165     if ids.empty?
166       return []
167     else
168       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
169         return self.find(:all, options)
170       end
171     end
172   end
173
174   # FIXME is this really needed?
175   def members
176     unless @members
177       @members = Array.new
178       self.relation_members.each do |member|
179         @members += [[member.member_type,member.member_id,member.member_role]]
180       end
181     end
182     @members
183   end
184
185   def tags
186     unless @tags
187       @tags = Hash.new
188       self.relation_tags.each do |tag|
189         @tags[tag.k] = tag.v
190       end
191     end
192     @tags
193   end
194
195   def members=(m)
196     @members = m
197   end
198
199   def tags=(t)
200     @tags = t
201   end
202
203   def add_member(type,id,role)
204     @members = Array.new unless @members
205     @members += [[type,id,role]]
206   end
207
208   def add_tag_keyval(k, v)
209     @tags = Hash.new unless @tags
210
211     # duplicate tags are now forbidden, so we can't allow values
212     # in the hash to be overwritten.
213     raise OSM::APIDuplicateTagsError.new("relation", self.id, k) if @tags.include? k
214
215     @tags[k] = v
216   end
217
218   ##
219   # updates the changeset bounding box to contain the bounding box of 
220   # the element with given +type+ and +id+. this only works with nodes
221   # and ways at the moment, as they're the only elements to respond to
222   # the :bbox call.
223   def update_changeset_element(type, id)
224     element = Kernel.const_get(type.capitalize).find(id)
225     changeset.update_bbox! element.bbox
226   end    
227
228   def delete_with_history!(new_relation, user)
229     unless self.visible
230       raise OSM::APIAlreadyDeletedError.new
231     end
232
233     # need to start the transaction here, so that the database can 
234     # provide repeatable reads for the used-by checks. this means it
235     # shouldn't be possible to get race conditions.
236     Relation.transaction do
237       check_consistency(self, new_relation, user)
238       # This will check to see if this relation is used by another relation
239       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 ])
240         raise OSM::APIPreconditionFailedError.new("The relation #{new_relation.id} is a used in another relation")
241       end
242       self.changeset_id = new_relation.changeset_id
243       self.tags = {}
244       self.members = []
245       self.visible = false
246       save_with_history!
247     end
248   end
249
250   def update_from(new_relation, user)
251     check_consistency(self, new_relation, user)
252     if !new_relation.preconditions_ok?
253       raise OSM::APIPreconditionFailedError.new
254     end
255     self.changeset_id = new_relation.changeset_id
256     self.changeset = new_relation.changeset
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.getutc
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       # reload, so that all of the members are accessible in their
378       # new state.
379       self.reload
380
381       # same pattern as before, but this time we're collecting the
382       # changed members in an array, as the bounding box updates for
383       # elements are per-element, not blanked on/off like for tags.
384       changed_members = Array.new
385       members = Hash.new
386       self.members.each do |m|
387         # should be: h[[m.id, m.type]] = m.role, but someone prefers arrays
388         members[[m[1], m[0]]] = m[2]
389       end
390       relation_members.each do |old_member|
391         key = [old_member.member_id.to_s, old_member.member_type]
392         if members.has_key? key
393           members.delete key
394         else
395           changed_members << key
396         end
397       end
398       # any remaining members must be new additions
399       changed_members += members.keys
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       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.each do |type, id, role|
438           if type != "relation"
439             update_changeset_element(type, id)
440           end
441         end
442       else
443         # add only changed members to the changeset
444         changed_members.each do |id, type|
445           update_changeset_element(type, id)
446         end
447       end
448
449       # tell the changeset we updated one element only
450       changeset.add_changes! 1
451
452       # save the (maybe updated) changeset bounding box
453       changeset.save!
454     end
455   end
456
457 end