]> git.openstreetmap.org Git - rails.git/blob - app/controllers/api/changesets_controller.rb
Merge remote-tracking branch 'upstream/pull/2381'
[rails.git] / app / controllers / api / changesets_controller.rb
1 # The ChangesetController is the RESTful interface to Changeset objects
2
3 module Api
4   class ChangesetsController < ApiController
5     layout "site"
6     require "xml/libxml"
7
8     before_action :authorize, :only => [:create, :update, :upload, :close, :subscribe, :unsubscribe]
9
10     authorize_resource
11
12     before_action :require_public_data, :only => [:create, :update, :upload, :close, :subscribe, :unsubscribe]
13     before_action :check_api_writable, :only => [:create, :update, :upload, :subscribe, :unsubscribe]
14     before_action :check_api_readable, :except => [:create, :update, :upload, :download, :query, :subscribe, :unsubscribe]
15     around_action :api_call_handle_error
16     around_action :api_call_timeout, :except => [:upload]
17
18     # Helper methods for checking consistency
19     include ConsistencyValidations
20
21     # Create a changeset from XML.
22     def create
23       assert_method :put
24
25       cs = Changeset.from_xml(request.raw_post, true)
26
27       # Assume that Changeset.from_xml has thrown an exception if there is an error parsing the xml
28       cs.user = current_user
29       cs.save_with_tags!
30
31       # Subscribe user to changeset comments
32       cs.subscribers << current_user
33
34       render :plain => cs.id.to_s
35     end
36
37     ##
38     # Return XML giving the basic info about the changeset. Does not
39     # return anything about the nodes, ways and relations in the changeset.
40     def show
41       @changeset = Changeset.find(params[:id])
42       @include_discussion = params[:include_discussion].presence
43       render "changeset"
44     end
45
46     ##
47     # marks a changeset as closed. this may be called multiple times
48     # on the same changeset, so is idempotent.
49     def close
50       assert_method :put
51
52       changeset = Changeset.find(params[:id])
53       check_changeset_consistency(changeset, current_user)
54
55       # to close the changeset, we'll just set its closed_at time to
56       # now. this might not be enough if there are concurrency issues,
57       # but we'll have to wait and see.
58       changeset.set_closed_time_now
59
60       changeset.save!
61       head :ok
62     end
63
64     ##
65     # Upload a diff in a single transaction.
66     #
67     # This means that each change within the diff must succeed, i.e: that
68     # each version number mentioned is still current. Otherwise the entire
69     # transaction *must* be rolled back.
70     #
71     # Furthermore, each element in the diff can only reference the current
72     # changeset.
73     #
74     # Returns: a diffResult document, as described in
75     # http://wiki.openstreetmap.org/wiki/OSM_Protocol_Version_0.6
76     def upload
77       # only allow POST requests, as the upload method is most definitely
78       # not idempotent, as several uploads with placeholder IDs will have
79       # different side-effects.
80       # see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.1.2
81       assert_method :post
82
83       changeset = Changeset.find(params[:id])
84       check_changeset_consistency(changeset, current_user)
85
86       diff_reader = DiffReader.new(request.raw_post, changeset)
87       Changeset.transaction do
88         result = diff_reader.commit
89         render :xml => result.to_s
90       end
91     end
92
93     ##
94     # download the changeset as an osmChange document.
95     #
96     # to make it easier to revert diffs it would be better if the osmChange
97     # format were reversible, i.e: contained both old and new versions of
98     # modified elements. but it doesn't at the moment...
99     #
100     # this method cannot order the database changes fully (i.e: timestamp and
101     # version number may be too coarse) so the resulting diff may not apply
102     # to a different database. however since changesets are not atomic this
103     # behaviour cannot be guaranteed anyway and is the result of a design
104     # choice.
105     def download
106       changeset = Changeset.find(params[:id])
107
108       # get all the elements in the changeset which haven't been redacted
109       # and stick them in a big array.
110       elements = [changeset.old_nodes.unredacted,
111                   changeset.old_ways.unredacted,
112                   changeset.old_relations.unredacted].flatten
113
114       # sort the elements by timestamp and version number, as this is the
115       # almost sensible ordering available. this would be much nicer if
116       # global (SVN-style) versioning were used - then that would be
117       # unambiguous.
118       elements.sort! do |a, b|
119         if a.timestamp == b.timestamp
120           a.version <=> b.version
121         else
122           a.timestamp <=> b.timestamp
123         end
124       end
125
126       # create changeset and user caches
127       changeset_cache = {}
128       user_display_name_cache = {}
129
130       # create an osmChange document for the output
131       result = OSM::API.new.get_xml_doc
132       result.root.name = "osmChange"
133
134       # generate an output element for each operation. note: we avoid looking
135       # at the history because it is simpler - but it would be more correct to
136       # check these assertions.
137       elements.each do |elt|
138         result.root <<
139           if elt.version == 1
140             # first version, so it must be newly-created.
141             created = XML::Node.new "create"
142             created << elt.to_xml_node(changeset_cache, user_display_name_cache)
143           elsif elt.visible
144             # must be a modify
145             modified = XML::Node.new "modify"
146             modified << elt.to_xml_node(changeset_cache, user_display_name_cache)
147           else
148             # if the element isn't visible then it must have been deleted
149             deleted = XML::Node.new "delete"
150             deleted << elt.to_xml_node(changeset_cache, user_display_name_cache)
151           end
152       end
153
154       render :xml => result.to_s
155     end
156
157     ##
158     # query changesets by bounding box, time, user or open/closed status.
159     def query
160       # find any bounding box
161       bbox = BoundingBox.from_bbox_params(params) if params["bbox"]
162
163       # create the conditions that the user asked for. some or all of
164       # these may be nil.
165       changesets = Changeset.all
166       changesets = conditions_bbox(changesets, bbox)
167       changesets = conditions_user(changesets, params["user"], params["display_name"])
168       changesets = conditions_time(changesets, params["time"])
169       changesets = conditions_open(changesets, params["open"])
170       changesets = conditions_closed(changesets, params["closed"])
171       changesets = conditions_ids(changesets, params["changesets"])
172
173       # sort and limit the changesets
174       changesets = changesets.order("created_at DESC").limit(100)
175
176       # preload users, tags and comments, and render result
177       @changesets = changesets.preload(:user, :changeset_tags, :comments)
178       render "changesets"
179     end
180
181     ##
182     # updates a changeset's tags. none of the changeset's attributes are
183     # user-modifiable, so they will be ignored.
184     #
185     # changesets are not (yet?) versioned, so we don't have to deal with
186     # history tables here. changesets are locked to a single user, however.
187     #
188     # after succesful update, returns the XML of the changeset.
189     def update
190       # request *must* be a PUT.
191       assert_method :put
192
193       @changeset = Changeset.find(params[:id])
194       new_changeset = Changeset.from_xml(request.raw_post)
195
196       check_changeset_consistency(@changeset, current_user)
197       @changeset.update_from(new_changeset, current_user)
198       render "changeset"
199     end
200
201     ##
202     # Adds a subscriber to the changeset
203     def subscribe
204       # Check the arguments are sane
205       raise OSM::APIBadUserInput, "No id was given" unless params[:id]
206
207       # Extract the arguments
208       id = params[:id].to_i
209
210       # Find the changeset and check it is valid
211       changeset = Changeset.find(id)
212       raise OSM::APIChangesetAlreadySubscribedError, changeset if changeset.subscribers.exists?(current_user.id)
213
214       # Add the subscriber
215       changeset.subscribers << current_user
216
217       # Return a copy of the updated changeset
218       @changeset = changeset
219       render "changeset"
220     end
221
222     ##
223     # Removes a subscriber from the changeset
224     def unsubscribe
225       # Check the arguments are sane
226       raise OSM::APIBadUserInput, "No id was given" unless params[:id]
227
228       # Extract the arguments
229       id = params[:id].to_i
230
231       # Find the changeset and check it is valid
232       changeset = Changeset.find(id)
233       raise OSM::APIChangesetNotSubscribedError, changeset unless changeset.subscribers.exists?(current_user.id)
234
235       # Remove the subscriber
236       changeset.subscribers.delete(current_user)
237
238       # Return a copy of the updated changeset
239       @changeset = changeset
240       render "changeset"
241     end
242
243     private
244
245     #------------------------------------------------------------
246     # utility functions below.
247     #------------------------------------------------------------
248
249     ##
250     # if a bounding box was specified do some sanity checks.
251     # restrict changesets to those enclosed by a bounding box
252     # we need to return both the changesets and the bounding box
253     def conditions_bbox(changesets, bbox)
254       if bbox
255         bbox.check_boundaries
256         bbox = bbox.to_scaled
257
258         changesets.where("min_lon < ? and max_lon > ? and min_lat < ? and max_lat > ?",
259                          bbox.max_lon.to_i, bbox.min_lon.to_i,
260                          bbox.max_lat.to_i, bbox.min_lat.to_i)
261       else
262         changesets
263       end
264     end
265
266     ##
267     # restrict changesets to those by a particular user
268     def conditions_user(changesets, user, name)
269       if user.nil? && name.nil?
270         changesets
271       else
272         # shouldn't provide both name and UID
273         raise OSM::APIBadUserInput, "provide either the user ID or display name, but not both" if user && name
274
275         # use either the name or the UID to find the user which we're selecting on.
276         u = if name.nil?
277               # user input checking, we don't have any UIDs < 1
278               raise OSM::APIBadUserInput, "invalid user ID" if user.to_i < 1
279
280               u = User.find(user.to_i)
281             else
282               u = User.find_by(:display_name => name)
283             end
284
285         # make sure we found a user
286         raise OSM::APINotFoundError if u.nil?
287
288         # should be able to get changesets of public users only, or
289         # our own changesets regardless of public-ness.
290         unless u.data_public?
291           # get optional user auth stuff so that users can see their own
292           # changesets if they're non-public
293           setup_user_auth
294
295           raise OSM::APINotFoundError if current_user.nil? || current_user != u
296         end
297
298         changesets.where(:user_id => u.id)
299       end
300     end
301
302     ##
303     # restrict changes to those closed during a particular time period
304     def conditions_time(changesets, time)
305       if time.nil?
306         changesets
307       elsif time.count(",") == 1
308         # if there is a range, i.e: comma separated, then the first is
309         # low, second is high - same as with bounding boxes.
310
311         # check that we actually have 2 elements in the array
312         times = time.split(/,/)
313         raise OSM::APIBadUserInput, "bad time range" if times.size != 2
314
315         from, to = times.collect { |t| Time.parse(t) }
316         changesets.where("closed_at >= ? and created_at <= ?", from, to)
317       else
318         # if there is no comma, assume its a lower limit on time
319         changesets.where("closed_at >= ?", Time.parse(time))
320       end
321       # stupid Time seems to throw both of these for bad parsing, so
322       # we have to catch both and ensure the correct code path is taken.
323     rescue ArgumentError => e
324       raise OSM::APIBadUserInput, e.message.to_s
325     rescue RuntimeError => e
326       raise OSM::APIBadUserInput, e.message.to_s
327     end
328
329     ##
330     # return changesets which are open (haven't been closed yet)
331     # we do this by seeing if the 'closed at' time is in the future. Also if we've
332     # hit the maximum number of changes then it counts as no longer open.
333     # if parameter 'open' is nill then open and closed changesets are returned
334     def conditions_open(changesets, open)
335       if open.nil?
336         changesets
337       else
338         changesets.where("closed_at >= ? and num_changes <= ?",
339                          Time.now.getutc, Changeset::MAX_ELEMENTS)
340       end
341     end
342
343     ##
344     # query changesets which are closed
345     # ('closed at' time has passed or changes limit is hit)
346     def conditions_closed(changesets, closed)
347       if closed.nil?
348         changesets
349       else
350         changesets.where("closed_at < ? or num_changes > ?",
351                          Time.now.getutc, Changeset::MAX_ELEMENTS)
352       end
353     end
354
355     ##
356     # query changesets by a list of ids
357     # (either specified as array or comma-separated string)
358     def conditions_ids(changesets, ids)
359       if ids.nil?
360         changesets
361       elsif ids.empty?
362         raise OSM::APIBadUserInput, "No changesets were given to search for"
363       else
364         ids = ids.split(",").collect(&:to_i)
365         changesets.where(:id => ids)
366       end
367     end
368   end
369 end