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