Make system tests run by default
[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   }.freeze
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       if model.nil?
89         raise OSM::APIBadUserInput, "Unexpected element type #{model_name}, " \
90                                        "expected node, way or relation."
91       end
92       # new in libxml-ruby >= 2, expand returns an element not associated
93       # with a document. this means that there's no encoding parameter,
94       # which means basically nothing works.
95       expanded = @reader.expand
96
97       # create a new, empty document to hold this expanded node
98       new_node = @doc.import(expanded)
99       @doc.root << new_node
100
101       yield model, new_node
102       @reader.next
103
104       # remove element from doc - it will be garbage collected and the
105       # rest of the document is re-used in the next iteration.
106       @doc.root.child.remove!
107     end
108   end
109
110   ##
111   # Checks a few invariants. Others are checked in the model methods
112   # such as save_ and delete_with_history.
113   def check(model, xml, new)
114     raise OSM::APIBadXMLError.new(model, xml) if new.nil?
115     unless new.changeset_id == @changeset.id
116       raise OSM::APIChangesetMismatchError.new(new.changeset_id, @changeset.id)
117     end
118   end
119
120   ##
121   # Consume the XML diff and try to commit it to the database. This code
122   # is *not* transactional, so code which calls it should ensure that the
123   # appropriate transaction block is in place.
124   #
125   # On a failure to meet preconditions (e.g: optimistic locking fails)
126   # an exception subclassing OSM::APIError will be thrown.
127   def commit
128     # data structure used for mapping placeholder IDs to real IDs
129     ids = { :node => {}, :way => {}, :relation => {} }
130
131     # take the first element and check that it is an osmChange element
132     @reader.read
133     raise OSM::APIBadUserInput, "Document element should be 'osmChange'." if @reader.name != "osmChange"
134
135     result = OSM::API.new.get_xml_doc
136     result.root.name = "diffResult"
137
138     # loop at the top level, within the <osmChange> element
139     with_element do |action_name, action_attributes|
140       if action_name == "create"
141         # create a new element. this code is agnostic of the element type
142         # because all the elements support the methods that we're using.
143         with_model do |model, xml|
144           new = model.from_xml_node(xml, true)
145           check(model, xml, new)
146
147           # when this element is saved it will get a new ID, so we save it
148           # to produce the mapping which is sent to other elements.
149           placeholder_id = xml["id"].to_i
150           raise OSM::APIBadXMLError.new(model, xml) if placeholder_id.nil?
151
152           # check if the placeholder ID has been given before and throw
153           # an exception if it has - we can't create the same element twice.
154           model_sym = model.to_s.downcase.to_sym
155           raise OSM::APIBadUserInput, "Placeholder IDs must be unique for created elements." if ids[model_sym].include? placeholder_id
156
157           # some elements may have placeholders for other elements in the
158           # diff, so we must fix these before saving the element.
159           new.fix_placeholders!(ids, placeholder_id)
160
161           # create element given user
162           new.create_with_history(@changeset.user)
163
164           # save placeholder => allocated ID map
165           ids[model_sym][placeholder_id] = new.id
166
167           # add the result to the document we're building for return.
168           xml_result = XML::Node.new model.to_s.downcase
169           xml_result["old_id"] = placeholder_id.to_s
170           xml_result["new_id"] = new.id.to_s
171           xml_result["new_version"] = new.version.to_s
172           result.root << xml_result
173         end
174
175       elsif action_name == "modify"
176         # modify an existing element. again, this code doesn't directly deal
177         # with types, but uses duck typing to handle them transparently.
178         with_model do |model, xml|
179           # get the new element from the XML payload
180           new = model.from_xml_node(xml, false)
181           check(model, xml, new)
182
183           # if the ID is a placeholder then map it to the real ID
184           model_sym = model.to_s.downcase.to_sym
185           client_id = new.id
186           is_placeholder = ids[model_sym].include? client_id
187           id = is_placeholder ? ids[model_sym][client_id] : client_id
188
189           # and the old one from the database
190           old = model.find(id)
191
192           # translate any placeholder IDs to their true IDs.
193           new.fix_placeholders!(ids)
194           new.id = id
195
196           old.update_from(new, @changeset.user)
197
198           xml_result = XML::Node.new model.to_s.downcase
199           xml_result["old_id"] = client_id.to_s
200           xml_result["new_id"] = id.to_s
201           # version is updated in "old" through the update, so we must not
202           # return new.version here but old.version!
203           xml_result["new_version"] = old.version.to_s
204           result.root << xml_result
205         end
206
207       elsif action_name == "delete"
208         # delete action. this takes a payload in API 0.6, so we need to do
209         # most of the same checks that are done for the modify.
210         with_model do |model, xml|
211           # delete doesn't have to contain a full payload, according to
212           # the wiki docs, so we just extract the things we need.
213           new_id = xml["id"].to_i
214           raise OSM::APIBadXMLError.new(model, xml, "ID attribute is required") if new_id.nil?
215
216           # if the ID is a placeholder then map it to the real ID
217           model_sym = model.to_s.downcase.to_sym
218           is_placeholder = ids[model_sym].include? new_id
219           id = is_placeholder ? ids[model_sym][new_id] : new_id
220
221           # build the "new" element by modifying the existing one
222           new = model.find(id)
223           new.changeset_id = xml["changeset"].to_i
224           new.version = xml["version"].to_i
225           check(model, xml, new)
226
227           # fetch the matching old element from the DB
228           old = model.find(id)
229
230           # can a delete have placeholders under any circumstances?
231           # if a way is modified, then deleted is that a valid diff?
232           new.fix_placeholders!(ids)
233
234           xml_result = XML::Node.new model.to_s.downcase
235           # oh, the irony... the "new" element actually contains the "old" ID
236           # a better name would have been client/server, but anyway...
237           xml_result["old_id"] = new_id.to_s
238
239           if action_attributes["if-unused"]
240             begin
241               old.delete_with_history!(new, @changeset.user)
242             rescue OSM::APIAlreadyDeletedError, OSM::APIPreconditionFailedError
243               xml_result["new_id"] = old.id.to_s
244               xml_result["new_version"] = old.version.to_s
245             end
246           else
247             old.delete_with_history!(new, @changeset.user)
248           end
249
250           result.root << xml_result
251         end
252
253       else
254         # no other actions to choose from, so it must be the users fault!
255         raise OSM::APIChangesetActionInvalid, action_name
256       end
257     end
258
259     # return the XML document to be rendered back to the client
260     result
261   end
262 end