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