8a72d941d03752f3c826c4abd4f52ba2c233ae90
[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 :web_timeout, :only => [:list, :feed, :comments_feed]
19
20   # Helper methods for checking consistency
21   include ConsistencyValidations
22
23   # Create a changeset from XML.
24   def create
25     assert_method :put
26
27     cs = Changeset.from_xml(request.raw_post, true)
28
29     # Assume that Changeset.from_xml has thrown an exception if there is an error parsing the xml
30     cs.user_id = @user.id
31     cs.save_with_tags!
32
33     # Subscribe user to changeset comments
34     cs.subscribers << @user
35
36     render :text => cs.id.to_s, :content_type => "text/plain"
37   end
38
39   ##
40   # Return XML giving the basic info about the changeset. Does not
41   # return anything about the nodes, ways and relations in the changeset.
42   def read
43     changeset = Changeset.find(params[:id])
44
45     render :text => changeset.to_xml(params[:include_discussion].presence).to_s, :content_type => "text/xml"
46   end
47
48   ##
49   # marks a changeset as closed. this may be called multiple times
50   # on the same changeset, so is idempotent.
51   def close
52     assert_method :put
53
54     changeset = Changeset.find(params[:id])
55     check_changeset_consistency(changeset, @user)
56
57     # to close the changeset, we'll just set its closed_at time to
58     # now. this might not be enough if there are concurrency issues,
59     # but we'll have to wait and see.
60     changeset.set_closed_time_now
61
62     changeset.save!
63     render :text => ""
64   end
65
66   ##
67   # insert a (set of) points into a changeset bounding box. this can only
68   # increase the size of the bounding box. this is a hint that clients can
69   # set either before uploading a large number of changes, or changes that
70   # the client (but not the server) knows will affect areas further away.
71   def expand_bbox
72     # only allow POST requests, because although this method is
73     # idempotent, there is no "document" to PUT really...
74     assert_method :post
75
76     cs = Changeset.find(params[:id])
77     check_changeset_consistency(cs, @user)
78
79     # keep an array of lons and lats
80     lon = []
81     lat = []
82
83     # the request is in pseudo-osm format... this is kind-of an
84     # abuse, maybe should change to some other format?
85     doc = XML::Parser.string(request.raw_post).parse
86     doc.find("//osm/node").each do |n|
87       lon << n["lon"].to_f * GeoRecord::SCALE
88       lat << n["lat"].to_f * GeoRecord::SCALE
89     end
90
91     # add the existing bounding box to the lon-lat array
92     lon << cs.min_lon unless cs.min_lon.nil?
93     lat << cs.min_lat unless cs.min_lat.nil?
94     lon << cs.max_lon unless cs.max_lon.nil?
95     lat << cs.max_lat unless cs.max_lat.nil?
96
97     # collapse the arrays to minimum and maximum
98     cs.min_lon = lon.min
99     cs.min_lat = lat.min
100     cs.max_lon = lon.max
101     cs.max_lat = lat.max
102
103     # save the larger bounding box and return the changeset, which
104     # will include the bigger bounding box.
105     cs.save!
106     render :text => cs.to_xml.to_s, :content_type => "text/xml"
107   end
108
109   ##
110   # Upload a diff in a single transaction.
111   #
112   # This means that each change within the diff must succeed, i.e: that
113   # each version number mentioned is still current. Otherwise the entire
114   # transaction *must* be rolled back.
115   #
116   # Furthermore, each element in the diff can only reference the current
117   # changeset.
118   #
119   # Returns: a diffResult document, as described in
120   # http://wiki.openstreetmap.org/wiki/OSM_Protocol_Version_0.6
121   def upload
122     # only allow POST requests, as the upload method is most definitely
123     # not idempotent, as several uploads with placeholder IDs will have
124     # different side-effects.
125     # see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.1.2
126     assert_method :post
127
128     changeset = Changeset.find(params[:id])
129     check_changeset_consistency(changeset, @user)
130
131     diff_reader = DiffReader.new(request.raw_post, changeset)
132     Changeset.transaction do
133       result = diff_reader.commit
134       render :text => result.to_s, :content_type => "text/xml"
135     end
136   end
137
138   ##
139   # download the changeset as an osmChange document.
140   #
141   # to make it easier to revert diffs it would be better if the osmChange
142   # format were reversible, i.e: contained both old and new versions of
143   # modified elements. but it doesn't at the moment...
144   #
145   # this method cannot order the database changes fully (i.e: timestamp and
146   # version number may be too coarse) so the resulting diff may not apply
147   # to a different database. however since changesets are not atomic this
148   # behaviour cannot be guaranteed anyway and is the result of a design
149   # choice.
150   def download
151     changeset = Changeset.find(params[:id])
152
153     # get all the elements in the changeset which haven't been redacted
154     # and stick them in a big array.
155     elements = [changeset.old_nodes.unredacted,
156                 changeset.old_ways.unredacted,
157                 changeset.old_relations.unredacted].flatten
158
159     # sort the elements by timestamp and version number, as this is the
160     # almost sensible ordering available. this would be much nicer if
161     # global (SVN-style) versioning were used - then that would be
162     # unambiguous.
163     elements.sort! do |a, b|
164       if (a.timestamp == b.timestamp)
165         a.version <=> b.version
166       else
167         a.timestamp <=> b.timestamp
168       end
169     end
170
171     # create changeset and user caches
172     changeset_cache = {}
173     user_display_name_cache = {}
174
175     # create an osmChange document for the output
176     result = OSM::API.new.get_xml_doc
177     result.root.name = "osmChange"
178
179     # generate an output element for each operation. note: we avoid looking
180     # at the history because it is simpler - but it would be more correct to
181     # check these assertions.
182     elements.each do |elt|
183       result.root <<
184         if (elt.version == 1)
185           # first version, so it must be newly-created.
186           created = XML::Node.new "create"
187           created << elt.to_xml_node(changeset_cache, user_display_name_cache)
188         else
189           if 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     end
200
201     render :text => result.to_s, :content_type => "text/xml"
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     # create the results document
221     results = OSM::API.new.get_xml_doc
222
223     # add all matching changesets to the XML results document
224     changesets.order("created_at DESC").limit(100).each do |cs|
225       results.root << cs.to_xml_node
226     end
227
228     render :text => results.to_s, :content_type => "text/xml"
229   end
230
231   ##
232   # updates a changeset's tags. none of the changeset's attributes are
233   # user-modifiable, so they will be ignored.
234   #
235   # changesets are not (yet?) versioned, so we don't have to deal with
236   # history tables here. changesets are locked to a single user, however.
237   #
238   # after succesful update, returns the XML of the changeset.
239   def update
240     # request *must* be a PUT.
241     assert_method :put
242
243     changeset = Changeset.find(params[:id])
244     new_changeset = Changeset.from_xml(request.raw_post)
245
246     check_changeset_consistency(changeset, @user)
247     changeset.update_from(new_changeset, @user)
248     render :text => changeset.to_xml, :mime_type => "text/xml"
249   end
250
251   ##
252   # list edits (open changesets) in reverse chronological order
253   def list
254     if request.format == :atom && params[:max_id]
255       redirect_to url_for(params.merge(:max_id => nil)), :status => :moved_permanently
256       return
257     end
258
259     if params[:display_name]
260       user = User.find_by_display_name(params[:display_name])
261       if !user || !user.active?
262         render_unknown_user params[:display_name]
263         return
264       end
265     end
266
267     if (params[:friends] || params[:nearby]) && !@user
268       require_user
269       return
270     end
271
272     if request.format == :html && !params[:list]
273       require_oauth
274       render :action => :history, :layout => map_layout
275     else
276       changesets = conditions_nonempty(Changeset.all)
277
278       if params[:display_name]
279         if user.data_public? || user == @user
280           changesets = changesets.where(:user_id => user.id)
281         else
282           changesets = changesets.where("false")
283         end
284       elsif params[:bbox]
285         changesets = conditions_bbox(changesets, BoundingBox.from_bbox_params(params))
286       elsif params[:friends] && @user
287         changesets = changesets.where(:user_id => @user.friend_users.identifiable)
288       elsif params[:nearby] && @user
289         changesets = changesets.where(:user_id => @user.nearby)
290       end
291
292       if params[:max_id]
293         changesets = changesets.where("changesets.id <= ?", params[:max_id])
294       end
295
296       @edits = changesets.order("changesets.id DESC").limit(20).preload(:user, :changeset_tags)
297
298       render :action => :list, :layout => false
299     end
300   end
301
302   ##
303   # list edits as an atom feed
304   def feed
305     list
306   end
307
308   ##
309   # Add a comment to a changeset
310   def comment
311     # Check the arguments are sane
312     fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
313     fail OSM::APIBadUserInput.new("No text was given") if params[:text].blank?
314
315     # Extract the arguments
316     id = params[:id].to_i
317     body = params[:text]
318
319     # Find the changeset and check it is valid
320     changeset = Changeset.find(id)
321     fail OSM::APIChangesetNotYetClosedError.new(changeset) if changeset.is_open?
322
323     # Add a comment to the changeset
324     comment = changeset.comments.create(:changeset => changeset,
325                                         :body => body,
326                                         :author => @user)
327
328     # Notify current subscribers of the new comment
329     changeset.subscribers.each do |user|
330       if @user != user
331         Notifier.changeset_comment_notification(comment, user).deliver_now
332       end
333     end
334
335     # Add the commenter to the subscribers if necessary
336     changeset.subscribers << @user unless changeset.subscribers.exists?(@user.id)
337
338     # Return a copy of the updated changeset
339     render :text => changeset.to_xml.to_s, :content_type => "text/xml"
340   end
341
342   ##
343   # Adds a subscriber to the changeset
344   def subscribe
345     # Check the arguments are sane
346     fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
347
348     # Extract the arguments
349     id = params[:id].to_i
350
351     # Find the changeset and check it is valid
352     changeset = Changeset.find(id)
353     fail OSM::APIChangesetNotYetClosedError.new(changeset) if changeset.is_open?
354     fail OSM::APIChangesetAlreadySubscribedError.new(changeset) if changeset.subscribers.exists?(@user.id)
355
356     # Add the subscriber
357     changeset.subscribers << @user
358
359     # Return a copy of the updated changeset
360     render :text => changeset.to_xml.to_s, :content_type => "text/xml"
361   end
362
363   ##
364   # Removes a subscriber from the changeset
365   def unsubscribe
366     # Check the arguments are sane
367     fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
368
369     # Extract the arguments
370     id = params[:id].to_i
371
372     # Find the changeset and check it is valid
373     changeset = Changeset.find(id)
374     fail OSM::APIChangesetNotYetClosedError.new(changeset) if changeset.is_open?
375     fail OSM::APIChangesetNotSubscribedError.new(changeset) unless changeset.subscribers.exists?(@user.id)
376
377     # Remove the subscriber
378     changeset.subscribers.delete(@user)
379
380     # Return a copy of the updated changeset
381     render :text => changeset.to_xml.to_s, :content_type => "text/xml"
382   end
383
384   ##
385   # Sets visible flag on comment to false
386   def hide_comment
387     # Check the arguments are sane
388     fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
389
390     # Extract the arguments
391     id = params[:id].to_i
392
393     # Find the changeset
394     comment = ChangesetComment.find(id)
395
396     # Hide the comment
397     comment.update(:visible => false)
398
399     # Return a copy of the updated changeset
400     render :text => comment.changeset.to_xml.to_s, :content_type => "text/xml"
401   end
402
403   ##
404   # Sets visible flag on comment to true
405   def unhide_comment
406     # Check the arguments are sane
407     fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
408
409     # Extract the arguments
410     id = params[:id].to_i
411
412     # Find the changeset
413     comment = ChangesetComment.find(id)
414
415     # Unhide the comment
416     comment.update(:visible => true)
417
418     # Return a copy of the updated changeset
419     render :text => comment.changeset.to_xml.to_s, :content_type => "text/xml"
420   end
421
422   ##
423   # Get a feed of recent changeset comments
424   def comments_feed
425     if params[:id]
426       # Extract the arguments
427       id = params[:id].to_i
428
429       # Find the changeset
430       changeset = Changeset.find(id)
431
432       # Return comments for this changeset only
433       @comments = changeset.comments.includes(:author, :changeset).limit(comments_limit)
434     else
435       # Return comments
436       @comments = ChangesetComment.includes(:author, :changeset).where(:visible => :true).order("created_at DESC").limit(comments_limit).preload(:changeset)
437     end
438
439     # Render the result
440     respond_to do |format|
441       format.rss
442     end
443   rescue OSM::APIBadUserInput
444     render :text => "", :status => :bad_request
445   end
446
447   private
448
449   #------------------------------------------------------------
450   # utility functions below.
451   #------------------------------------------------------------
452
453   ##
454   # if a bounding box was specified do some sanity checks.
455   # restrict changesets to those enclosed by a bounding box
456   # we need to return both the changesets and the bounding box
457   def conditions_bbox(changesets, bbox)
458     if  bbox
459       bbox.check_boundaries
460       bbox = bbox.to_scaled
461       return changesets.where("min_lon < ? and max_lon > ? and min_lat < ? and max_lat > ?",
462                               bbox.max_lon.to_i, bbox.min_lon.to_i,
463                               bbox.max_lat.to_i, bbox.min_lat.to_i)
464     else
465       return changesets
466     end
467   end
468
469   ##
470   # restrict changesets to those by a particular user
471   def conditions_user(changesets, user, name)
472     if user.nil? && name.nil?
473       return changesets
474     else
475       # shouldn't provide both name and UID
476       fail OSM::APIBadUserInput.new("provide either the user ID or display name, but not both") if user && name
477
478       # use either the name or the UID to find the user which we're selecting on.
479       u = if name.nil?
480             # user input checking, we don't have any UIDs < 1
481             fail OSM::APIBadUserInput.new("invalid user ID") if user.to_i < 1
482             u = User.find(user.to_i)
483           else
484             u = User.find_by_display_name(name)
485           end
486
487       # make sure we found a user
488       fail OSM::APINotFoundError.new if u.nil?
489
490       # should be able to get changesets of public users only, or
491       # our own changesets regardless of public-ness.
492       unless u.data_public?
493         # get optional user auth stuff so that users can see their own
494         # changesets if they're non-public
495         setup_user_auth
496
497         fail OSM::APINotFoundError if @user.nil? || @user.id != u.id
498       end
499       return changesets.where(:user_id => u.id)
500     end
501   end
502
503   ##
504   # restrict changes to those closed during a particular time period
505   def conditions_time(changesets, time)
506     if time.nil?
507       return changesets
508     else
509       # if there is a range, i.e: comma separated, then the first is
510       # low, second is high - same as with bounding boxes.
511       if time.count(",") == 1
512         # check that we actually have 2 elements in the array
513         times = time.split(/,/)
514         fail OSM::APIBadUserInput.new("bad time range") if times.size != 2
515
516         from, to = times.collect { |t| DateTime.parse(t) }
517         return changesets.where("closed_at >= ? and created_at <= ?", from, to)
518       else
519         # if there is no comma, assume its a lower limit on time
520         return changesets.where("closed_at >= ?", DateTime.parse(time))
521       end
522     end
523     # stupid DateTime seems to throw both of these for bad parsing, so
524     # we have to catch both and ensure the correct code path is taken.
525   rescue ArgumentError => ex
526     raise OSM::APIBadUserInput.new(ex.message.to_s)
527   rescue RuntimeError => ex
528     raise OSM::APIBadUserInput.new(ex.message.to_s)
529   end
530
531   ##
532   # return changesets which are open (haven't been closed yet)
533   # we do this by seeing if the 'closed at' time is in the future. Also if we've
534   # hit the maximum number of changes then it counts as no longer open.
535   # if parameter 'open' is nill then open and closed changesets are returned
536   def conditions_open(changesets, open)
537     if open.nil?
538       return changesets
539     else
540       return changesets.where("closed_at >= ? and num_changes <= ?",
541                               Time.now.getutc, Changeset::MAX_ELEMENTS)
542     end
543   end
544
545   ##
546   # query changesets which are closed
547   # ('closed at' time has passed or changes limit is hit)
548   def conditions_closed(changesets, closed)
549     if closed.nil?
550       return changesets
551     else
552       return changesets.where("closed_at < ? or num_changes > ?",
553                               Time.now.getutc, Changeset::MAX_ELEMENTS)
554     end
555   end
556
557   ##
558   # query changesets by a list of ids
559   # (either specified as array or comma-separated string)
560   def conditions_ids(changesets, ids)
561     if ids.nil?
562       return changesets
563     elsif ids.empty?
564       fail OSM::APIBadUserInput.new("No changesets were given to search for")
565     else
566       ids = ids.split(",").collect(&:to_i)
567       return changesets.where(:id => ids)
568     end
569   end
570
571   ##
572   # eliminate empty changesets (where the bbox has not been set)
573   # this should be applied to all changeset list displays
574   def conditions_nonempty(changesets)
575     changesets.where("num_changes > 0")
576   end
577
578   ##
579   # Get the maximum number of comments to return
580   def comments_limit
581     if params[:limit]
582       if params[:limit].to_i > 0 && params[:limit].to_i <= 10000
583         params[:limit].to_i
584       else
585         fail OSM::APIBadUserInput.new("Comments limit must be between 1 and 10000")
586       end
587     else
588       100
589     end
590   end
591 end