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