Improve test coverage
[rails.git] / app / models / relation.rb
1 class Relation < ActiveRecord::Base
2   require "xml/libxml"
3
4   include ConsistencyValidations
5   include NotRedactable
6   include ObjectMetadata
7
8   self.table_name = "current_relations"
9
10   belongs_to :changeset
11
12   has_many :old_relations, -> { order(:version) }
13
14   has_many :relation_members, -> { order(:sequence_id) }
15   has_many :relation_tags
16
17   has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
18   has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation
19
20   validates :id, :uniqueness => true, :presence => { :on => :update },
21                  :numericality => { :on => :update, :integer_only => true }
22   validates :version, :presence => true,
23                       :numericality => { :integer_only => true }
24   validates :changeset_id, :presence => true,
25                            :numericality => { :integer_only => true }
26   validates :timestamp, :presence => true
27   validates :changeset, :associated => true
28   validates :visible, :inclusion => [true, false]
29
30   scope :visible, -> { where(:visible => true) }
31   scope :invisible, -> { where(:visible => false) }
32   scope :nodes, ->(*ids) { joins(:relation_members).where(:current_relation_members => { :member_type => "Node", :member_id => ids.flatten }) }
33   scope :ways, ->(*ids) { joins(:relation_members).where(:current_relation_members => { :member_type => "Way", :member_id => ids.flatten }) }
34   scope :relations, ->(*ids) { joins(:relation_members).where(:current_relation_members => { :member_type => "Relation", :member_id => ids.flatten }) }
35
36   TYPES = %w(node way relation)
37
38   def self.from_xml(xml, create = false)
39     p = XML::Parser.string(xml)
40     doc = p.parse
41
42     doc.find("//osm/relation").each do |pt|
43       return Relation.from_xml_node(pt, create)
44     end
45     fail OSM::APIBadXMLError.new("node", xml, "XML doesn't contain an osm/relation element.")
46   rescue LibXML::XML::Error, ArgumentError => ex
47     raise OSM::APIBadXMLError.new("relation", xml, ex.message)
48   end
49
50   def self.from_xml_node(pt, create = false)
51     relation = Relation.new
52
53     fail OSM::APIBadXMLError.new("relation", pt, "Version is required when updating") unless create || !pt["version"].nil?
54     relation.version = pt["version"]
55     fail OSM::APIBadXMLError.new("relation", pt, "Changeset id is missing") if pt["changeset"].nil?
56     relation.changeset_id = pt["changeset"]
57
58     unless create
59       fail OSM::APIBadXMLError.new("relation", pt, "ID is required when updating") if pt["id"].nil?
60       relation.id = pt["id"].to_i
61       # .to_i will return 0 if there is no number that can be parsed.
62       # We want to make sure that there is no id with zero anyway
63       fail OSM::APIBadUserInput.new("ID of relation cannot be zero when updating.") if relation.id == 0
64     end
65
66     # We don't care about the timestamp nor the visibility as these are either
67     # set explicitly or implicit in the action. The visibility is set to true,
68     # and manually set to false before the actual delete.
69     relation.visible = true
70
71     # Start with no tags
72     relation.tags = {}
73
74     # Add in any tags from the XML
75     pt.find("tag").each do |tag|
76       fail OSM::APIBadXMLError.new("relation", pt, "tag is missing key") if tag["k"].nil?
77       fail OSM::APIBadXMLError.new("relation", pt, "tag is missing value") if tag["v"].nil?
78       relation.add_tag_keyval(tag["k"], tag["v"])
79     end
80
81     # need to initialise the relation members array explicitly, as if this
82     # isn't done for a new relation then @members attribute will be nil,
83     # and the members will be loaded from the database instead of being
84     # empty, as intended.
85     relation.members = []
86
87     pt.find("member").each do |member|
88       # member_type =
89       logger.debug "each member"
90       fail OSM::APIBadXMLError.new("relation", pt, "The #{member['type']} is not allowed only, #{TYPES.inspect} allowed") unless TYPES.include? member["type"]
91       logger.debug "after raise"
92       # member_ref = member['ref']
93       # member_role
94       member["role"] ||= "" # Allow  the upload to not include this, in which case we default to an empty string.
95       logger.debug member["role"]
96       relation.add_member(member["type"].classify, member["ref"], member["role"])
97     end
98     fail OSM::APIBadUserInput.new("Some bad xml in relation") if relation.nil?
99
100     relation
101   end
102
103   def to_xml
104     doc = OSM::API.new.get_xml_doc
105     doc.root << to_xml_node
106     doc
107   end
108
109   def to_xml_node(visible_members = nil, changeset_cache = {}, user_display_name_cache = {})
110     el = XML::Node.new "relation"
111     el["id"] = id.to_s
112
113     add_metadata_to_xml_node(el, self, changeset_cache, user_display_name_cache)
114
115     relation_members.each do |member|
116       p = 0
117
118       if visible_members
119         # if there is a list of visible members then use that to weed out deleted segments
120         p = 1 if visible_members[member.member_type][member.member_id]
121       else
122         # otherwise, manually go to the db to check things
123         p = 1 if member.member.visible?
124       end
125
126       next unless p
127
128       member_el = XML::Node.new "member"
129       member_el["type"] = member.member_type.downcase
130       member_el["ref"] = member.member_id.to_s
131       member_el["role"] = member.member_role
132       el << member_el
133     end
134
135     add_tags_to_xml_node(el, relation_tags)
136
137     el
138   end
139
140   # FIXME: is this really needed?
141   def members
142     @members ||= relation_members.map do |member|
143       [member.member_type, member.member_id, member.member_role]
144     end
145   end
146
147   def tags
148     @tags ||= Hash[relation_tags.collect { |t| [t.k, t.v] }]
149   end
150
151   attr_writer :members
152
153   attr_writer :tags
154
155   def add_member(type, id, role)
156     @members ||= []
157     @members << [type, id.to_i, role]
158   end
159
160   def add_tag_keyval(k, v)
161     @tags = {} unless @tags
162
163     # duplicate tags are now forbidden, so we can't allow values
164     # in the hash to be overwritten.
165     fail OSM::APIDuplicateTagsError.new("relation", id, k) if @tags.include? k
166
167     @tags[k] = v
168   end
169
170   ##
171   # updates the changeset bounding box to contain the bounding box of
172   # the element with given +type+ and +id+. this only works with nodes
173   # and ways at the moment, as they're the only elements to respond to
174   # the :bbox call.
175   def update_changeset_element(type, id)
176     element = Kernel.const_get(type.capitalize).find(id)
177     changeset.update_bbox! element.bbox
178   end
179
180   def delete_with_history!(new_relation, user)
181     unless visible
182       fail OSM::APIAlreadyDeletedError.new("relation", new_relation.id)
183     end
184
185     # need to start the transaction here, so that the database can
186     # provide repeatable reads for the used-by checks. this means it
187     # shouldn't be possible to get race conditions.
188     Relation.transaction do
189       self.lock!
190       check_consistency(self, new_relation, user)
191       # This will check to see if this relation is used by another relation
192       rel = RelationMember.joins(:relation).where("visible = ? AND member_type = 'Relation' and member_id = ? ", true, id).first
193       fail OSM::APIPreconditionFailedError.new("The relation #{new_relation.id} is used in relation #{rel.relation.id}.") unless rel.nil?
194
195       self.changeset_id = new_relation.changeset_id
196       self.tags = {}
197       self.members = []
198       self.visible = false
199       save_with_history!
200     end
201   end
202
203   def update_from(new_relation, user)
204     Relation.transaction do
205       self.lock!
206       check_consistency(self, new_relation, user)
207       unless new_relation.preconditions_ok?(members)
208         fail OSM::APIPreconditionFailedError.new("Cannot update relation #{id}: data or member data is invalid.")
209       end
210       self.changeset_id = new_relation.changeset_id
211       self.changeset = new_relation.changeset
212       self.tags = new_relation.tags
213       self.members = new_relation.members
214       self.visible = true
215       save_with_history!
216     end
217   end
218
219   def create_with_history(user)
220     check_create_consistency(self, user)
221     unless self.preconditions_ok?
222       fail OSM::APIPreconditionFailedError.new("Cannot create relation: data or member data is invalid.")
223     end
224     self.version = 0
225     self.visible = true
226     save_with_history!
227   end
228
229   def preconditions_ok?(good_members = [])
230     # These are hastables that store an id in the index of all
231     # the nodes/way/relations that have already been added.
232     # If the member is valid and visible then we add it to the
233     # relevant hash table, with the value true as a cache.
234     # Thus if you have nodes with the ids of 50 and 1 already in the
235     # relation, then the hash table nodes would contain:
236     # => {50=>true, 1=>true}
237     elements = { :node => {}, :way => {}, :relation => {} }
238
239     # pre-set all existing members to good
240     good_members.each { |m| elements[m[0].downcase.to_sym][m[1]] = true }
241
242     members.each do |m|
243       # find the hash for the element type or die
244       hash = elements[m[0].downcase.to_sym]
245       return false unless hash
246
247       # unless its in the cache already
248       next if hash.key? m[1]
249
250       # use reflection to look up the appropriate class
251       model = Kernel.const_get(m[0].capitalize)
252       # get the element with that ID
253       element = model.where(:id => m[1]).first
254
255       # and check that it is OK to use.
256       unless element && element.visible? && element.preconditions_ok?
257         fail OSM::APIPreconditionFailedError.new("Relation with id #{id} cannot be saved due to #{m[0]} with id #{m[1]}")
258       end
259       hash[m[1]] = true
260     end
261
262     true
263   end
264
265   ##
266   # if any members are referenced by placeholder IDs (i.e: negative) then
267   # this calling this method will fix them using the map from placeholders
268   # to IDs +id_map+.
269   def fix_placeholders!(id_map, placeholder_id = nil)
270     members.map! do |type, id, role|
271       old_id = id.to_i
272       if old_id < 0
273         new_id = id_map[type.downcase.to_sym][old_id]
274         fail OSM::APIBadUserInput.new("Placeholder #{type} not found for reference #{old_id} in relation #{self.id.nil? ? placeholder_id : self.id}.") if new_id.nil?
275         [type, new_id, role]
276       else
277         [type, id, role]
278       end
279     end
280   end
281
282   private
283
284   def save_with_history!
285     Relation.transaction do
286       # have to be a little bit clever here - to detect if any tags
287       # changed then we have to monitor their before and after state.
288       tags_changed = false
289
290       t = Time.now.getutc
291       self.version += 1
292       self.timestamp = t
293       self.save!
294
295       tags = self.tags.clone
296       relation_tags.each do |old_tag|
297         key = old_tag.k
298         # if we can match the tags we currently have to the list
299         # of old tags, then we never set the tags_changed flag. but
300         # if any are different then set the flag and do the DB
301         # update.
302         if tags.key? key
303           tags_changed |= (old_tag.v != tags[key])
304
305           # remove from the map, so that we can expect an empty map
306           # at the end if there are no new tags
307           tags.delete key
308
309         else
310           # this means a tag was deleted
311           tags_changed = true
312         end
313       end
314       # if there are left-over tags then they are new and will have to
315       # be added.
316       tags_changed |= (!tags.empty?)
317       RelationTag.delete_all(:relation_id => id)
318       self.tags.each do |k, v|
319         tag = RelationTag.new
320         tag.relation_id = id
321         tag.k = k
322         tag.v = v
323         tag.save!
324       end
325
326       # same pattern as before, but this time we're collecting the
327       # changed members in an array, as the bounding box updates for
328       # elements are per-element, not blanked on/off like for tags.
329       changed_members = []
330       members = self.members.clone
331       relation_members.each do |old_member|
332         key = [old_member.member_type, old_member.member_id, old_member.member_role]
333         i = members.index key
334         if i.nil?
335           changed_members << key
336         else
337           members.delete_at i
338         end
339       end
340       # any remaining members must be new additions
341       changed_members += members
342
343       # update the members. first delete all the old members, as the new
344       # members may be in a different order and i don't feel like implementing
345       # a longest common subsequence algorithm to optimise this.
346       members = self.members
347       RelationMember.delete_all(:relation_id => id)
348       members.each_with_index do |m, i|
349         mem = RelationMember.new
350         mem.relation_id = id
351         mem.sequence_id = i
352         mem.member_type = m[0]
353         mem.member_id = m[1]
354         mem.member_role = m[2]
355         mem.save!
356       end
357
358       old_relation = OldRelation.from_relation(self)
359       old_relation.timestamp = t
360       old_relation.save_with_dependencies!
361
362       # update the bbox of the changeset and save it too.
363       # discussion on the mailing list gave the following definition for
364       # the bounding box update procedure of a relation:
365       #
366       # adding or removing nodes or ways from a relation causes them to be
367       # added to the changeset bounding box. adding a relation member or
368       # changing tag values causes all node and way members to be added to the
369       # bounding box. this is similar to how the map call does things and is
370       # reasonable on the assumption that adding or removing members doesn't
371       # materially change the rest of the relation.
372       any_relations =
373         changed_members.collect { |_id, type| type == "relation" }
374         .inject(false) { |a, e| a || e }
375
376       update_members = if tags_changed || any_relations
377                          # add all non-relation bounding boxes to the changeset
378                          # FIXME: check for tag changes along with element deletions and
379                          # make sure that the deleted element's bounding box is hit.
380                          self.members
381                        else
382                          changed_members
383                        end
384       update_members.each do |type, id, _role|
385         update_changeset_element(type, id) if type != "Relation"
386       end
387
388       # tell the changeset we updated one element only
389       changeset.add_changes! 1
390
391       # save the (maybe updated) changeset bounding box
392       changeset.save!
393     end
394   end
395 end