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