]> git.openstreetmap.org Git - rails.git/blob - lib/diff_reader.rb
be6fee7bb16700f9cadd81909dd9c74186e303fc
[rails.git] / lib / diff_reader.rb
1 ##
2 # DiffReader reads OSM diffs and applies them to the database.
3 #
4 # Uses the streaming LibXML "Reader" interface to cut down on memory
5 # usage, so hopefully we can process fairly large diffs.
6 class DiffReader
7   include ConsistencyValidations
8
9   # maps each element type to the model class which handles it
10   MODELS = {
11     "node"     => Node,
12     "way"      => Way,
13     "relation" => Relation
14   }
15
16   ##
17   # Construct a diff reader by giving it a bunch of XML +data+ to parse
18   # in OsmChange format. All diffs must be limited to a single changeset
19   # given in +changeset+.
20   def initialize(data, changeset)
21     @reader = XML::Reader.string(data)
22     @changeset = changeset
23     # document that's (re-)used to handle elements expanded out of the
24     # diff processing stream.
25     @doc = XML::Document.new
26     @doc.root = XML::Node.new("osm")
27   end
28
29   ##
30   # Reads the next element from the XML document. Checks the return value
31   # and throws an exception if an error occurred.
32   def read_or_die
33     # NOTE: XML::Reader#read returns false for EOF and raises an
34     # exception if an error occurs.
35     @reader.read
36   rescue LibXML::XML::Error => ex
37     raise OSM::APIBadXMLError.new("changeset", xml, ex.message)
38   end
39
40   ##
41   # An element-block mapping for using the LibXML reader interface.
42   #
43   # Since a lot of LibXML reader usage is boilerplate iteration through
44   # elements, it would be better to DRY and do this in a block. This
45   # could also help with error handling...?
46   def with_element
47     # if the start element is empty then don't do any processing, as
48     # there won't be any child elements to process!
49     unless @reader.empty_element?
50       # read the first element
51       read_or_die
52
53       while @reader.node_type != 15 # end element
54         # because we read elements in DOM-style to reuse their DOM
55         # parsing code, we don't always read an element on each pass
56         # as the call to @reader.next in the innermost loop will take
57         # care of that for us.
58         if @reader.node_type == 1 # element
59           name = @reader.name
60           attributes =  {}
61
62           if @reader.has_attributes?
63             while @reader.move_to_next_attribute == 1
64               attributes[@reader.name] = @reader.value
65             end
66
67             @reader.move_to_element
68           end
69
70           yield name, attributes
71         else
72           read_or_die
73         end
74       end
75     end
76     read_or_die
77   end
78
79   ##
80   # An element-block mapping for using the LibXML reader interface.
81   #
82   # Since a lot of LibXML reader usage is boilerplate iteration through
83   # elements, it would be better to DRY and do this in a block. This
84   # could also help with error handling...?
85   def with_model
86     with_element do |model_name, _model_attributes|
87       model = MODELS[model_name]
88       fail OSM::APIBadUserInput.new("Unexpected element type #{model_name}, " +
89                                      "expected node, way or relation.") if model.nil?
90       # new in libxml-ruby >= 2, expand returns an element not associated
91       # with a document. this means that there's no encoding parameter,
92       # which means basically nothing works.
93       expanded = @reader.expand
94
95       # create a new, empty document to hold this expanded node
96       new_node = @doc.import(expanded)
97       @doc.root << new_node
98
99       yield model, new_node
100       @reader.next
101
102       # remove element from doc - it will be garbage collected and the
103       # rest of the document is re-used in the next iteration.
104       @doc.root.child.remove!
105     end
106   end
107
108   ##
109   # Checks a few invariants. Others are checked in the model methods
110   # such as save_ and delete_with_history.
111   def check(model, xml, new)
112     fail OSM::APIBadXMLError.new(model, xml) if new.nil?
113     unless new.changeset_id == @changeset.id
114       fail OSM::APIChangesetMismatchError.new(new.changeset_id, @changeset.id)
115     end
116   end
117
118   ##
119   # Consume the XML diff and try to commit it to the database. This code
120   # is *not* transactional, so code which calls it should ensure that the
121   # appropriate transaction block is in place.
122   #
123   # On a failure to meet preconditions (e.g: optimistic locking fails)
124   # an exception subclassing OSM::APIError will be thrown.
125   def commit
126     # data structure used for mapping placeholder IDs to real IDs
127     node_ids, way_ids, rel_ids = {}, {}, {}
128     ids = { :node => node_ids, :way => way_ids, :relation => rel_ids }
129
130     # take the first element and check that it is an osmChange element
131     @reader.read
132     fail OSM::APIBadUserInput.new("Document element should be 'osmChange'.") if @reader.name != 'osmChange'
133
134     result = OSM::API.new.get_xml_doc
135     result.root.name = "diffResult"
136
137     # loop at the top level, within the <osmChange> element
138     with_element do |action_name, action_attributes|
139       if action_name == 'create'
140         # create a new element. this code is agnostic of the element type
141         # because all the elements support the methods that we're using.
142         with_model do |model, xml|
143           new = model.from_xml_node(xml, true)
144           check(model, xml, new)
145
146           # when this element is saved it will get a new ID, so we save it
147           # to produce the mapping which is sent to other elements.
148           placeholder_id = xml['id'].to_i
149           fail OSM::APIBadXMLError.new(model, xml) if placeholder_id.nil?
150
151           # check if the placeholder ID has been given before and throw
152           # an exception if it has - we can't create the same element twice.
153           model_sym = model.to_s.downcase.to_sym
154           fail OSM::APIBadUserInput.new("Placeholder IDs must be unique for created elements.") if ids[model_sym].include? placeholder_id
155
156           # some elements may have placeholders for other elements in the
157           # diff, so we must fix these before saving the element.
158           new.fix_placeholders!(ids, placeholder_id)
159
160           # create element given user
161           new.create_with_history(@changeset.user)
162
163           # save placeholder => allocated ID map
164           ids[model_sym][placeholder_id] = new.id
165
166           # add the result to the document we're building for return.
167           xml_result = XML::Node.new model.to_s.downcase
168           xml_result["old_id"] = placeholder_id.to_s
169           xml_result["new_id"] = new.id.to_s
170           xml_result["new_version"] = new.version.to_s
171           result.root << xml_result
172         end
173
174       elsif action_name == 'modify'
175         # modify an existing element. again, this code doesn't directly deal
176         # with types, but uses duck typing to handle them transparently.
177         with_model do |model, xml|
178           # get the new element from the XML payload
179           new = model.from_xml_node(xml, false)
180           check(model, xml, new)
181
182           # if the ID is a placeholder then map it to the real ID
183           model_sym = model.to_s.downcase.to_sym
184           client_id = new.id
185           is_placeholder = ids[model_sym].include? client_id
186           id = is_placeholder ? ids[model_sym][client_id] : client_id
187
188           # and the old one from the database
189           old = model.find(id)
190
191           # translate any placeholder IDs to their true IDs.
192           new.fix_placeholders!(ids)
193           new.id = id
194
195           old.update_from(new, @changeset.user)
196
197           xml_result = XML::Node.new model.to_s.downcase
198           xml_result["old_id"] = client_id.to_s
199           xml_result["new_id"] = id.to_s
200           # version is updated in "old" through the update, so we must not
201           # return new.version here but old.version!
202           xml_result["new_version"] = old.version.to_s
203           result.root << xml_result
204         end
205
206       elsif action_name == 'delete'
207         # delete action. this takes a payload in API 0.6, so we need to do
208         # most of the same checks that are done for the modify.
209         with_model do |model, xml|
210           # delete doesn't have to contain a full payload, according to
211           # the wiki docs, so we just extract the things we need.
212           new_id = xml['id'].to_i
213           fail OSM::APIBadXMLError.new(model, xml, "ID attribute is required") if new_id.nil?
214
215           # if the ID is a placeholder then map it to the real ID
216           model_sym = model.to_s.downcase.to_sym
217           is_placeholder = ids[model_sym].include? new_id
218           id = is_placeholder ? ids[model_sym][new_id] : new_id
219
220           # build the "new" element by modifying the existing one
221           new = model.find(id)
222           new.changeset_id = xml['changeset'].to_i
223           new.version = xml['version'].to_i
224           check(model, xml, new)
225
226           # fetch the matching old element from the DB
227           old = model.find(id)
228
229           # can a delete have placeholders under any circumstances?
230           # if a way is modified, then deleted is that a valid diff?
231           new.fix_placeholders!(ids)
232
233           xml_result = XML::Node.new model.to_s.downcase
234           # oh, the irony... the "new" element actually contains the "old" ID
235           # a better name would have been client/server, but anyway...
236           xml_result["old_id"] = new_id.to_s
237
238           if action_attributes["if-unused"]
239             begin
240               old.delete_with_history!(new, @changeset.user)
241             rescue OSM::APIAlreadyDeletedError, OSM::APIPreconditionFailedError
242               xml_result["new_id"] = old.id.to_s
243               xml_result["new_version"] = old.version.to_s
244             end
245           else
246             old.delete_with_history!(new, @changeset.user)
247           end
248
249           result.root << xml_result
250         end
251
252       else
253         # no other actions to choose from, so it must be the users fault!
254         fail OSM::APIChangesetActionInvalid.new(action_name)
255       end
256     end
257
258     # return the XML document to be rendered back to the client
259     result
260   end
261 end