8fbbe1362605992668f143909d89d88a83f83550
[rails.git] / app / controllers / changeset_controller.rb
1 # The ChangesetController is the RESTful interface to Changeset objects
2
3 class ChangesetController < ApplicationController
4   layout "site"
5   require "xml/libxml"
6
7   skip_before_action :verify_authenticity_token, :except => [:list]
8   before_action :authorize_web, :only => [:list, :feed, :comments_feed]
9   before_action :set_locale, :only => [:list, :feed, :comments_feed]
10   before_action :authorize, :only => [:create, :update, :delete, :upload, :include, :close, :comment, :subscribe, :unsubscribe, :hide_comment, :unhide_comment]
11   before_action :require_moderator, :only => [:hide_comment, :unhide_comment]
12   before_action :require_allow_write_api, :only => [:create, :update, :delete, :upload, :include, :close, :comment, :subscribe, :unsubscribe, :hide_comment, :unhide_comment]
13   before_action :require_public_data, :only => [:create, :update, :delete, :upload, :include, :close, :comment, :subscribe, :unsubscribe]
14   before_action :check_api_writable, :only => [:create, :update, :delete, :upload, :include, :comment, :subscribe, :unsubscribe, :hide_comment, :unhide_comment]
15   before_action :check_api_readable, :except => [:create, :update, :delete, :upload, :download, :query, :list, :feed, :comment, :subscribe, :unsubscribe, :comments_feed]
16   before_action(:only => [:list, :feed, :comments_feed]) { |c| c.check_database_readable(true) }
17   around_action :api_call_handle_error, :except => [:list, :feed, :comments_feed]
18   around_action :api_call_timeout, :except => [:list, :feed, :comments_feed, :upload]
19   around_action :web_timeout, :only => [:list, :feed, :comments_feed]
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 read
44     changeset = Changeset.find(params[:id])
45
46     render :xml => changeset.to_xml(params[:include_discussion].presence).to_s
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     render :xml => cs.to_xml.to_s
108   end
109
110   ##
111   # Upload a diff in a single transaction.
112   #
113   # This means that each change within the diff must succeed, i.e: that
114   # each version number mentioned is still current. Otherwise the entire
115   # transaction *must* be rolled back.
116   #
117   # Furthermore, each element in the diff can only reference the current
118   # changeset.
119   #
120   # Returns: a diffResult document, as described in
121   # http://wiki.openstreetmap.org/wiki/OSM_Protocol_Version_0.6
122   def upload
123     # only allow POST requests, as the upload method is most definitely
124     # not idempotent, as several uploads with placeholder IDs will have
125     # different side-effects.
126     # see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.1.2
127     assert_method :post
128
129     changeset = Changeset.find(params[:id])
130     check_changeset_consistency(changeset, current_user)
131
132     diff_reader = DiffReader.new(request.raw_post, changeset)
133     Changeset.transaction do
134       result = diff_reader.commit
135       render :xml => result.to_s
136     end
137   end
138
139   ##
140   # download the changeset as an osmChange document.
141   #
142   # to make it easier to revert diffs it would be better if the osmChange
143   # format were reversible, i.e: contained both old and new versions of
144   # modified elements. but it doesn't at the moment...
145   #
146   # this method cannot order the database changes fully (i.e: timestamp and
147   # version number may be too coarse) so the resulting diff may not apply
148   # to a different database. however since changesets are not atomic this
149   # behaviour cannot be guaranteed anyway and is the result of a design
150   # choice.
151   def download
152     changeset = Changeset.find(params[:id])
153
154     # get all the elements in the changeset which haven't been redacted
155     # and stick them in a big array.
156     elements = [changeset.old_nodes.unredacted,
157                 changeset.old_ways.unredacted,
158                 changeset.old_relations.unredacted].flatten
159
160     # sort the elements by timestamp and version number, as this is the
161     # almost sensible ordering available. this would be much nicer if
162     # global (SVN-style) versioning were used - then that would be
163     # unambiguous.
164     elements.sort! do |a, b|
165       if a.timestamp == b.timestamp
166         a.version <=> b.version
167       else
168         a.timestamp <=> b.timestamp
169       end
170     end
171
172     # create changeset and user caches
173     changeset_cache = {}
174     user_display_name_cache = {}
175
176     # create an osmChange document for the output
177     result = OSM::API.new.get_xml_doc
178     result.root.name = "osmChange"
179
180     # generate an output element for each operation. note: we avoid looking
181     # at the history because it is simpler - but it would be more correct to
182     # check these assertions.
183     elements.each do |elt|
184       result.root <<
185         if elt.version == 1
186           # first version, so it must be newly-created.
187           created = XML::Node.new "create"
188           created << elt.to_xml_node(changeset_cache, user_display_name_cache)
189         elsif elt.visible
190           # must be a modify
191           modified = XML::Node.new "modify"
192           modified << elt.to_xml_node(changeset_cache, user_display_name_cache)
193         else
194           # if the element isn't visible then it must have been deleted
195           deleted = XML::Node.new "delete"
196           deleted << elt.to_xml_node(changeset_cache, user_display_name_cache)
197         end
198     end
199
200     render :xml => result.to_s
201   end
202
203   ##
204   # query changesets by bounding box, time, user or open/closed status.
205   def query
206     # find any bounding box
207     bbox = BoundingBox.from_bbox_params(params) if params["bbox"]
208
209     # create the conditions that the user asked for. some or all of
210     # these may be nil.
211     changesets = Changeset.all
212     changesets = conditions_bbox(changesets, bbox)
213     changesets = conditions_user(changesets, params["user"], params["display_name"])
214     changesets = conditions_time(changesets, params["time"])
215     changesets = conditions_open(changesets, params["open"])
216     changesets = conditions_closed(changesets, params["closed"])
217     changesets = conditions_ids(changesets, params["changesets"])
218
219     # sort and limit the changesets
220     changesets = changesets.order("created_at DESC").limit(100)
221
222     # preload users, tags and comments
223     changesets = changesets.preload(:user, :changeset_tags, :comments)
224
225     # create the results document
226     results = OSM::API.new.get_xml_doc
227
228     # add all matching changesets to the XML results document
229     changesets.order("created_at DESC").limit(100).each do |cs|
230       results.root << cs.to_xml_node
231     end
232
233     render :xml => results.to_s
234   end
235
236   ##
237   # updates a changeset's tags. none of the changeset's attributes are
238   # user-modifiable, so they will be ignored.
239   #
240   # changesets are not (yet?) versioned, so we don't have to deal with
241   # history tables here. changesets are locked to a single user, however.
242   #
243   # after succesful update, returns the XML of the changeset.
244   def update
245     # request *must* be a PUT.
246     assert_method :put
247
248     changeset = Changeset.find(params[:id])
249     new_changeset = Changeset.from_xml(request.raw_post)
250
251     check_changeset_consistency(changeset, current_user)
252     changeset.update_from(new_changeset, current_user)
253     render :xml => changeset.to_xml.to_s
254   end
255
256   ##
257   # list non-empty changesets in reverse chronological order
258   def list
259     @params = params.permit(:display_name, :bbox, :friends, :nearby, :max_id, :list)
260
261     if request.format == :atom && @params[:max_id]
262       redirect_to url_for(@params.merge(:max_id => nil)), :status => :moved_permanently
263       return
264     end
265
266     if @params[:display_name]
267       user = User.find_by(:display_name => @params[:display_name])
268       if !user || !user.active?
269         render_unknown_user @params[:display_name]
270         return
271       end
272     end
273
274     if (@params[:friends] || @params[:nearby]) && !current_user
275       require_user
276       return
277     end
278
279     if request.format == :html && !@params[:list]
280       require_oauth
281       render :action => :history, :layout => map_layout
282     else
283       changesets = conditions_nonempty(Changeset.all)
284
285       if @params[:display_name]
286         changesets = if user.data_public? || user == current_user
287                        changesets.where(:user_id => user.id)
288                      else
289                        changesets.where("false")
290                      end
291       elsif @params[:bbox]
292         changesets = conditions_bbox(changesets, BoundingBox.from_bbox_params(params))
293       elsif @params[:friends] && current_user
294         changesets = changesets.where(:user_id => current_user.friend_users.identifiable)
295       elsif @params[:nearby] && current_user
296         changesets = changesets.where(:user_id => current_user.nearby)
297       end
298
299       if @params[:max_id]
300         changesets = changesets.where("changesets.id <= ?", @params[:max_id])
301       end
302
303       @edits = changesets.order("changesets.id DESC").limit(20).preload(:user, :changeset_tags, :comments)
304
305       render :action => :list, :layout => false
306     end
307   end
308
309   ##
310   # list edits as an atom feed
311   def feed
312     list
313   end
314
315   ##
316   # Add a comment to a changeset
317   def comment
318     # Check the arguments are sane
319     raise OSM::APIBadUserInput, "No id was given" unless params[:id]
320     raise OSM::APIBadUserInput, "No text was given" if params[:text].blank?
321
322     # Extract the arguments
323     id = params[:id].to_i
324     body = params[:text]
325
326     # Find the changeset and check it is valid
327     changeset = Changeset.find(id)
328     raise OSM::APIChangesetNotYetClosedError, changeset if changeset.is_open?
329
330     # Add a comment to the changeset
331     comment = changeset.comments.create(:changeset => changeset,
332                                         :body => body,
333                                         :author => current_user)
334
335     # Notify current subscribers of the new comment
336     changeset.subscribers.visible.each do |user|
337       if current_user != user
338         Notifier.changeset_comment_notification(comment, user).deliver_now
339       end
340     end
341
342     # Add the commenter to the subscribers if necessary
343     changeset.subscribers << current_user unless changeset.subscribers.exists?(current_user.id)
344
345     # Return a copy of the updated changeset
346     render :xml => changeset.to_xml.to_s
347   end
348
349   ##
350   # Adds a subscriber to the changeset
351   def subscribe
352     # Check the arguments are sane
353     raise OSM::APIBadUserInput, "No id was given" unless params[:id]
354
355     # Extract the arguments
356     id = params[:id].to_i
357
358     # Find the changeset and check it is valid
359     changeset = Changeset.find(id)
360     raise OSM::APIChangesetNotYetClosedError, changeset if changeset.is_open?
361     raise OSM::APIChangesetAlreadySubscribedError, changeset if changeset.subscribers.exists?(current_user.id)
362
363     # Add the subscriber
364     changeset.subscribers << current_user
365
366     # Return a copy of the updated changeset
367     render :xml => changeset.to_xml.to_s
368   end
369
370   ##
371   # Removes a subscriber from the changeset
372   def unsubscribe
373     # Check the arguments are sane
374     raise OSM::APIBadUserInput, "No id was given" unless params[:id]
375
376     # Extract the arguments
377     id = params[:id].to_i
378
379     # Find the changeset and check it is valid
380     changeset = Changeset.find(id)
381     raise OSM::APIChangesetNotYetClosedError, changeset if changeset.is_open?
382     raise OSM::APIChangesetNotSubscribedError, changeset unless changeset.subscribers.exists?(current_user.id)
383
384     # Remove the subscriber
385     changeset.subscribers.delete(current_user)
386
387     # Return a copy of the updated changeset
388     render :xml => changeset.to_xml.to_s
389   end
390
391   ##
392   # Sets visible flag on comment to false
393   def hide_comment
394     # Check the arguments are sane
395     raise OSM::APIBadUserInput, "No id was given" unless params[:id]
396
397     # Extract the arguments
398     id = params[:id].to_i
399
400     # Find the changeset
401     comment = ChangesetComment.find(id)
402
403     # Hide the comment
404     comment.update(:visible => false)
405
406     # Return a copy of the updated changeset
407     render :xml => comment.changeset.to_xml.to_s
408   end
409
410   ##
411   # Sets visible flag on comment to true
412   def unhide_comment
413     # Check the arguments are sane
414     raise OSM::APIBadUserInput, "No id was given" unless params[:id]
415
416     # Extract the arguments
417     id = params[:id].to_i
418
419     # Find the changeset
420     comment = ChangesetComment.find(id)
421
422     # Unhide the comment
423     comment.update(:visible => true)
424
425     # Return a copy of the updated changeset
426     render :xml => comment.changeset.to_xml.to_s
427   end
428
429   ##
430   # Get a feed of recent changeset comments
431   def comments_feed
432     if params[:id]
433       # Extract the arguments
434       id = params[:id].to_i
435
436       # Find the changeset
437       changeset = Changeset.find(id)
438
439       # Return comments for this changeset only
440       @comments = changeset.comments.includes(:author, :changeset).limit(comments_limit)
441     else
442       # Return comments
443       @comments = ChangesetComment.includes(:author, :changeset).where(:visible => true).order("created_at DESC").limit(comments_limit).preload(:changeset)
444     end
445
446     # Render the result
447     respond_to do |format|
448       format.rss
449     end
450   rescue OSM::APIBadUserInput
451     head :bad_request
452   end
453
454   private
455
456   #------------------------------------------------------------
457   # utility functions below.
458   #------------------------------------------------------------
459
460   ##
461   # if a bounding box was specified do some sanity checks.
462   # restrict changesets to those enclosed by a bounding box
463   # we need to return both the changesets and the bounding box
464   def conditions_bbox(changesets, bbox)
465     if bbox
466       bbox.check_boundaries
467       bbox = bbox.to_scaled
468
469       changesets.where("min_lon < ? and max_lon > ? and min_lat < ? and max_lat > ?",
470                        bbox.max_lon.to_i, bbox.min_lon.to_i,
471                        bbox.max_lat.to_i, bbox.min_lat.to_i)
472     else
473       changesets
474     end
475   end
476
477   ##
478   # restrict changesets to those by a particular user
479   def conditions_user(changesets, user, name)
480     if user.nil? && name.nil?
481       changesets
482     else
483       # shouldn't provide both name and UID
484       raise OSM::APIBadUserInput, "provide either the user ID or display name, but not both" if user && name
485
486       # use either the name or the UID to find the user which we're selecting on.
487       u = if name.nil?
488             # user input checking, we don't have any UIDs < 1
489             raise OSM::APIBadUserInput, "invalid user ID" if user.to_i < 1
490             u = User.find(user.to_i)
491           else
492             u = User.find_by(:display_name => name)
493           end
494
495       # make sure we found a user
496       raise OSM::APINotFoundError if u.nil?
497
498       # should be able to get changesets of public users only, or
499       # our own changesets regardless of public-ness.
500       unless u.data_public?
501         # get optional user auth stuff so that users can see their own
502         # changesets if they're non-public
503         setup_user_auth
504
505         raise OSM::APINotFoundError if current_user.nil? || current_user != u
506       end
507
508       changesets.where(:user_id => u.id)
509     end
510   end
511
512   ##
513   # restrict changes to those closed during a particular time period
514   def conditions_time(changesets, time)
515     if time.nil?
516       return changesets
517     elsif time.count(",") == 1
518       # if there is a range, i.e: comma separated, then the first is
519       # low, second is high - same as with bounding boxes.
520
521       # check that we actually have 2 elements in the array
522       times = time.split(/,/)
523       raise OSM::APIBadUserInput, "bad time range" if times.size != 2
524
525       from, to = times.collect { |t| Time.parse(t) }
526       return changesets.where("closed_at >= ? and created_at <= ?", from, to)
527     else
528       # if there is no comma, assume its a lower limit on time
529       return changesets.where("closed_at >= ?", Time.parse(time))
530     end
531     # stupid Time seems to throw both of these for bad parsing, so
532     # we have to catch both and ensure the correct code path is taken.
533   rescue ArgumentError => ex
534     raise OSM::APIBadUserInput, ex.message.to_s
535   rescue RuntimeError => ex
536     raise OSM::APIBadUserInput, ex.message.to_s
537   end
538
539   ##
540   # return changesets which are open (haven't been closed yet)
541   # we do this by seeing if the 'closed at' time is in the future. Also if we've
542   # hit the maximum number of changes then it counts as no longer open.
543   # if parameter 'open' is nill then open and closed changesets are returned
544   def conditions_open(changesets, open)
545     if open.nil?
546       changesets
547     else
548       changesets.where("closed_at >= ? and num_changes <= ?",
549                        Time.now.getutc, Changeset::MAX_ELEMENTS)
550     end
551   end
552
553   ##
554   # query changesets which are closed
555   # ('closed at' time has passed or changes limit is hit)
556   def conditions_closed(changesets, closed)
557     if closed.nil?
558       changesets
559     else
560       changesets.where("closed_at < ? or num_changes > ?",
561                        Time.now.getutc, Changeset::MAX_ELEMENTS)
562     end
563   end
564
565   ##
566   # query changesets by a list of ids
567   # (either specified as array or comma-separated string)
568   def conditions_ids(changesets, ids)
569     if ids.nil?
570       changesets
571     elsif ids.empty?
572       raise OSM::APIBadUserInput, "No changesets were given to search for"
573     else
574       ids = ids.split(",").collect(&:to_i)
575       changesets.where(:id => ids)
576     end
577   end
578
579   ##
580   # eliminate empty changesets (where the bbox has not been set)
581   # this should be applied to all changeset list displays
582   def conditions_nonempty(changesets)
583     changesets.where("num_changes > 0")
584   end
585
586   ##
587   # Get the maximum number of comments to return
588   def comments_limit
589     if params[:limit]
590       if params[:limit].to_i > 0 && params[:limit].to_i <= 10000
591         params[:limit].to_i
592       else
593         raise OSM::APIBadUserInput, "Comments limit must be between 1 and 10000"
594       end
595     else
596       100
597     end
598   end
599 end