Remove unused parameter
[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(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       e = XML::Node.new 'member'
139       e['type'] = member.member_type.downcase
140       e['ref'] = member.member_id.to_s
141       e['role'] = member.member_role
142       el1 << e
143     end
144
145     self.relation_tags.each do |tag|
146       e = XML::Node.new 'tag'
147       e['k'] = tag.k
148       e['v'] = tag.v
149       el1 << e
150     end
151     return el1
152   end 
153
154   # FIXME is this really needed?
155   def members
156     @members ||= self.relation_members.map do |member|
157       [member.member_type, member.member_id, member.member_role]
158     end
159   end
160
161   def tags
162     unless @tags
163       @tags = Hash.new
164       self.relation_tags.each do |tag|
165         @tags[tag.k] = tag.v
166       end
167     end
168     @tags
169   end
170
171   def members=(m)
172     @members = m
173   end
174
175   def tags=(t)
176     @tags = t
177   end
178
179   def add_member(type, id, role)
180     @members ||= []
181     @members << [type, id.to_i, role]
182   end
183
184   def add_tag_keyval(k, v)
185     @tags = Hash.new unless @tags
186
187     # duplicate tags are now forbidden, so we can't allow values
188     # in the hash to be overwritten.
189     raise OSM::APIDuplicateTagsError.new("relation", self.id, k) if @tags.include? k
190
191     @tags[k] = v
192   end
193
194   ##
195   # updates the changeset bounding box to contain the bounding box of 
196   # the element with given +type+ and +id+. this only works with nodes
197   # and ways at the moment, as they're the only elements to respond to
198   # the :bbox call.
199   def update_changeset_element(type, id)
200     element = Kernel.const_get(type.capitalize).find(id)
201     changeset.update_bbox! element.bbox
202   end    
203
204   def delete_with_history!(new_relation, user)
205     unless self.visible
206       raise OSM::APIAlreadyDeletedError.new("relation", new_relation.id)
207     end
208
209     # need to start the transaction here, so that the database can 
210     # provide repeatable reads for the used-by checks. this means it
211     # shouldn't be possible to get race conditions.
212     Relation.transaction do
213       self.lock!
214       check_consistency(self, new_relation, user)
215       # This will check to see if this relation is used by another relation
216       rel = RelationMember.joins(:relation).where("visible = ? AND member_type = 'Relation' and member_id = ? ", true, self.id).first
217       raise OSM::APIPreconditionFailedError.new("The relation #{new_relation.id} is used in relation #{rel.relation.id}.") unless rel.nil?
218
219       self.changeset_id = new_relation.changeset_id
220       self.tags = {}
221       self.members = []
222       self.visible = false
223       save_with_history!
224     end
225   end
226
227   def update_from(new_relation, user)
228     Relation.transaction do
229       self.lock!
230       check_consistency(self, new_relation, user)
231       unless new_relation.preconditions_ok?(self.members)
232         raise OSM::APIPreconditionFailedError.new("Cannot update relation #{self.id}: data or member data is invalid.")
233       end
234       self.changeset_id = new_relation.changeset_id
235       self.changeset = new_relation.changeset
236       self.tags = new_relation.tags
237       self.members = new_relation.members
238       self.visible = true
239       save_with_history!
240     end
241   end
242   
243   def create_with_history(user)
244     check_create_consistency(self, user)
245     unless self.preconditions_ok?
246       raise OSM::APIPreconditionFailedError.new("Cannot create relation: data or member data is invalid.")
247     end
248     self.version = 0
249     self.visible = true
250     save_with_history!
251   end
252
253   def preconditions_ok?(good_members = [])
254     # These are hastables that store an id in the index of all 
255     # the nodes/way/relations that have already been added.
256     # If the member is valid and visible then we add it to the 
257     # relevant hash table, with the value true as a cache.
258     # Thus if you have nodes with the ids of 50 and 1 already in the
259     # relation, then the hash table nodes would contain:
260     # => {50=>true, 1=>true}
261     elements = { :node => Hash.new, :way => Hash.new, :relation => Hash.new }
262
263     # pre-set all existing members to good
264     good_members.each { |m| elements[m[0].downcase.to_sym][m[1]] = true }
265
266     self.members.each do |m|
267       # find the hash for the element type or die
268       hash = elements[m[0].downcase.to_sym] or return false
269       # unless its in the cache already
270       unless hash.key? m[1]
271         # use reflection to look up the appropriate class
272         model = Kernel.const_get(m[0].capitalize)
273         # get the element with that ID
274         element = model.where(:id => m[1]).first
275
276         # and check that it is OK to use.
277         unless element and element.visible? and element.preconditions_ok?
278           raise OSM::APIPreconditionFailedError.new("Relation with id #{self.id} cannot be saved due to #{m[0]} with id #{m[1]}")
279         end
280         hash[m[1]] = true
281       end
282     end
283
284     return true
285   end
286
287   # Temporary method to match interface to nodes
288   def tags_as_hash
289     return self.tags
290   end
291
292   ##
293   # if any members are referenced by placeholder IDs (i.e: negative) then
294   # this calling this method will fix them using the map from placeholders 
295   # to IDs +id_map+. 
296   def fix_placeholders!(id_map, placeholder_id = nil)
297     self.members.map! do |type, id, role|
298       old_id = id.to_i
299       if old_id < 0
300         new_id = id_map[type.downcase.to_sym][old_id]
301         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?
302         [type, new_id, role]
303       else
304         [type, id, role]
305       end
306     end
307   end
308
309   private
310   
311   def save_with_history!
312     Relation.transaction do
313       # have to be a little bit clever here - to detect if any tags
314       # changed then we have to monitor their before and after state.
315       tags_changed = false
316
317       t = Time.now.getutc
318       self.version += 1
319       self.timestamp = t
320       self.save!
321
322       tags = self.tags.clone
323       self.relation_tags.each do |old_tag|
324         key = old_tag.k
325         # if we can match the tags we currently have to the list
326         # of old tags, then we never set the tags_changed flag. but
327         # if any are different then set the flag and do the DB 
328         # update.
329         if tags.has_key? key 
330           tags_changed |= (old_tag.v != tags[key])
331
332           # remove from the map, so that we can expect an empty map
333           # at the end if there are no new tags
334           tags.delete key
335
336         else
337           # this means a tag was deleted
338           tags_changed = true
339         end
340       end
341       # if there are left-over tags then they are new and will have to
342       # be added.
343       tags_changed |= (not tags.empty?)
344       RelationTag.delete_all(:relation_id => self.id)
345       self.tags.each do |k,v|
346         tag = RelationTag.new
347         tag.relation_id = self.id
348         tag.k = k
349         tag.v = v
350         tag.save!
351       end
352       
353       # same pattern as before, but this time we're collecting the
354       # changed members in an array, as the bounding box updates for
355       # elements are per-element, not blanked on/off like for tags.
356       changed_members = Array.new
357       members = self.members.clone
358       self.relation_members.each do |old_member|
359         key = [old_member.member_type, old_member.member_id, old_member.member_role]
360         i = members.index key
361         if i.nil?
362           changed_members << key
363         else
364           members.delete_at i
365         end
366       end
367       # any remaining members must be new additions
368       changed_members += members
369
370       # update the members. first delete all the old members, as the new
371       # members may be in a different order and i don't feel like implementing
372       # a longest common subsequence algorithm to optimise this.
373       members = self.members
374       RelationMember.delete_all(:relation_id => self.id)
375       members.each_with_index do |m,i|
376         mem = RelationMember.new
377         mem.relation_id = self.id
378         mem.sequence_id = i
379         mem.member_type = m[0]
380         mem.member_id = m[1]
381         mem.member_role = m[2]
382         mem.save!
383       end
384
385       old_relation = OldRelation.from_relation(self)
386       old_relation.timestamp = t
387       old_relation.save_with_dependencies!
388
389       # update the bbox of the changeset and save it too.
390       # discussion on the mailing list gave the following definition for
391       # the bounding box update procedure of a relation:
392       #
393       # adding or removing nodes or ways from a relation causes them to be
394       # added to the changeset bounding box. adding a relation member or
395       # changing tag values causes all node and way members to be added to the
396       # bounding box. this is similar to how the map call does things and is
397       # reasonable on the assumption that adding or removing members doesn't
398       # materially change the rest of the relation.
399       any_relations = 
400         changed_members.collect { |id,type| type == "relation" }.
401         inject(false) { |b,s| b or s }
402
403       update_members = if tags_changed or any_relations
404                          # add all non-relation bounding boxes to the changeset
405                          # FIXME: check for tag changes along with element deletions and
406                          # make sure that the deleted element's bounding box is hit.
407                          self.members
408                        else 
409                          changed_members
410                        end
411       update_members.each do |type, id, role|
412         if type != "Relation"
413           update_changeset_element(type, id)
414         end
415       end
416
417       # tell the changeset we updated one element only
418       changeset.add_changes! 1
419
420       # save the (maybe updated) changeset bounding box
421       changeset.save!
422     end
423   end
424
425 end