]> git.openstreetmap.org Git - rails.git/blob - app/controllers/changeset_controller.rb
5b55980e3e93f0ff41f070a339b5fc38036bd1cd
[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_id = @user.id
32     cs.save_with_tags!
33
34     # Subscribe user to changeset comments
35     cs.subscribers << @user
36
37     render :text => cs.id.to_s, :content_type => "text/plain"
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 :text => changeset.to_xml(params[:include_discussion].presence).to_s, :content_type => "text/xml"
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, @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     render :text => ""
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, @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).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 :text => cs.to_xml.to_s, :content_type => "text/xml"
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, @user)
131
132     diff_reader = DiffReader.new(request.raw_post, changeset)
133     Changeset.transaction do
134       result = diff_reader.commit
135       render :text => result.to_s, :content_type => "text/xml"
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         else
190           if 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     end
201
202     render :text => result.to_s, :content_type => "text/xml"
203   end
204
205   ##
206   # query changesets by bounding box, time, user or open/closed status.
207   def query
208     # find any bounding box
209     bbox = BoundingBox.from_bbox_params(params) if params["bbox"]
210
211     # create the conditions that the user asked for. some or all of
212     # these may be nil.
213     changesets = Changeset.all
214     changesets = conditions_bbox(changesets, bbox)
215     changesets = conditions_user(changesets, params["user"], params["display_name"])
216     changesets = conditions_time(changesets, params["time"])
217     changesets = conditions_open(changesets, params["open"])
218     changesets = conditions_closed(changesets, params["closed"])
219     changesets = conditions_ids(changesets, params["changesets"])
220
221     # create the results document
222     results = OSM::API.new.get_xml_doc
223
224     # add all matching changesets to the XML results document
225     changesets.order("created_at DESC").limit(100).each do |cs|
226       results.root << cs.to_xml_node
227     end
228
229     render :text => results.to_s, :content_type => "text/xml"
230   end
231
232   ##
233   # updates a changeset's tags. none of the changeset's attributes are
234   # user-modifiable, so they will be ignored.
235   #
236   # changesets are not (yet?) versioned, so we don't have to deal with
237   # history tables here. changesets are locked to a single user, however.
238   #
239   # after succesful update, returns the XML of the changeset.
240   def update
241     # request *must* be a PUT.
242     assert_method :put
243
244     changeset = Changeset.find(params[:id])
245     new_changeset = Changeset.from_xml(request.raw_post)
246
247     check_changeset_consistency(changeset, @user)
248     changeset.update_from(new_changeset, @user)
249     render :text => changeset.to_xml, :mime_type => "text/xml"
250   end
251
252   ##
253   # list edits (open changesets) in reverse chronological order
254   def list
255     if request.format == :atom && params[:max_id]
256       redirect_to url_for(params.merge(:max_id => nil)), :status => :moved_permanently
257       return
258     end
259
260     if params[:display_name]
261       user = User.find_by_display_name(params[:display_name])
262       if !user || !user.active?
263         render_unknown_user params[:display_name]
264         return
265       end
266     end
267
268     if (params[:friends] || params[:nearby]) && !@user
269       require_user
270       return
271     end
272
273     if request.format == :html && !params[:list]
274       require_oauth
275       render :action => :history, :layout => map_layout
276     else
277       changesets = conditions_nonempty(Changeset.all)
278
279       if params[:display_name]
280         if user.data_public? || user == @user
281           changesets = changesets.where(:user_id => user.id)
282         else
283           changesets = changesets.where("false")
284         end
285       elsif params[:bbox]
286         changesets = conditions_bbox(changesets, BoundingBox.from_bbox_params(params))
287       elsif params[:friends] && @user
288         changesets = changesets.where(:user_id => @user.friend_users.identifiable)
289       elsif params[:nearby] && @user
290         changesets = changesets.where(:user_id => @user.nearby)
291       end
292
293       if params[:max_id]
294         changesets = changesets.where("changesets.id <= ?", params[:max_id])
295       end
296
297       @edits = changesets.order("changesets.id DESC").limit(20).preload(:user, :changeset_tags, :comments)
298
299       render :action => :list, :layout => false
300     end
301   end
302
303   ##
304   # list edits as an atom feed
305   def feed
306     list
307   end
308
309   ##
310   # Add a comment to a changeset
311   def comment
312     # Check the arguments are sane
313     fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
314     fail OSM::APIBadUserInput.new("No text was given") if params[:text].blank?
315
316     # Extract the arguments
317     id = params[:id].to_i
318     body = params[:text]
319
320     # Find the changeset and check it is valid
321     changeset = Changeset.find(id)
322     fail OSM::APIChangesetNotYetClosedError.new(changeset) if changeset.is_open?
323
324     # Add a comment to the changeset
325     comment = changeset.comments.create(:changeset => changeset,
326                                         :body => body,
327                                         :author => @user)
328
329     # Notify current subscribers of the new comment
330     changeset.subscribers.each do |user|
331       if @user != user
332         Notifier.changeset_comment_notification(comment, user).deliver_now
333       end
334     end
335
336     # Add the commenter to the subscribers if necessary
337     changeset.subscribers << @user unless changeset.subscribers.exists?(@user.id)
338
339     # Return a copy of the updated changeset
340     render :text => changeset.to_xml.to_s, :content_type => "text/xml"
341   end
342
343   ##
344   # Adds a subscriber to the changeset
345   def subscribe
346     # Check the arguments are sane
347     fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
348
349     # Extract the arguments
350     id = params[:id].to_i
351
352     # Find the changeset and check it is valid
353     changeset = Changeset.find(id)
354     fail OSM::APIChangesetNotYetClosedError.new(changeset) if changeset.is_open?
355     fail OSM::APIChangesetAlreadySubscribedError.new(changeset) if changeset.subscribers.exists?(@user.id)
356
357     # Add the subscriber
358     changeset.subscribers << @user
359
360     # Return a copy of the updated changeset
361     render :text => changeset.to_xml.to_s, :content_type => "text/xml"
362   end
363
364   ##
365   # Removes a subscriber from the changeset
366   def unsubscribe
367     # Check the arguments are sane
368     fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
369
370     # Extract the arguments
371     id = params[:id].to_i
372
373     # Find the changeset and check it is valid
374     changeset = Changeset.find(id)
375     fail OSM::APIChangesetNotYetClosedError.new(changeset) if changeset.is_open?
376     fail OSM::APIChangesetNotSubscribedError.new(changeset) unless changeset.subscribers.exists?(@user.id)
377
378     # Remove the subscriber
379     changeset.subscribers.delete(@user)
380
381     # Return a copy of the updated changeset
382     render :text => changeset.to_xml.to_s, :content_type => "text/xml"
383   end
384
385   ##
386   # Sets visible flag on comment to false
387   def hide_comment
388     # Check the arguments are sane
389     fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
390
391     # Extract the arguments
392     id = params[:id].to_i
393
394     # Find the changeset
395     comment = ChangesetComment.find(id)
396
397     # Hide the comment
398     comment.update(:visible => false)
399
400     # Return a copy of the updated changeset
401     render :text => comment.changeset.to_xml.to_s, :content_type => "text/xml"
402   end
403
404   ##
405   # Sets visible flag on comment to true
406   def unhide_comment
407     # Check the arguments are sane
408     fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
409
410     # Extract the arguments
411     id = params[:id].to_i
412
413     # Find the changeset
414     comment = ChangesetComment.find(id)
415
416     # Unhide the comment
417     comment.update(:visible => true)
418
419     # Return a copy of the updated changeset
420     render :text => comment.changeset.to_xml.to_s, :content_type => "text/xml"
421   end
422
423   ##
424   # Get a feed of recent changeset comments
425   def comments_feed
426     if params[:id]
427       # Extract the arguments
428       id = params[:id].to_i
429
430       # Find the changeset
431       changeset = Changeset.find(id)
432
433       # Return comments for this changeset only
434       @comments = changeset.comments.includes(:author, :changeset).limit(comments_limit)
435     else
436       # Return comments
437       @comments = ChangesetComment.includes(:author, :changeset).where(:visible => :true).order("created_at DESC").limit(comments_limit).preload(:changeset)
438     end
439
440     # Render the result
441     respond_to do |format|
442       format.rss
443     end
444   rescue OSM::APIBadUserInput
445     render :text => "", :status => :bad_request
446   end
447
448   private
449
450   #------------------------------------------------------------
451   # utility functions below.
452   #------------------------------------------------------------
453
454   ##
455   # if a bounding box was specified do some sanity checks.
456   # restrict changesets to those enclosed by a bounding box
457   # we need to return both the changesets and the bounding box
458   def conditions_bbox(changesets, bbox)
459     if bbox
460       bbox.check_boundaries
461       bbox = bbox.to_scaled
462       return changesets.where("min_lon < ? and max_lon > ? and min_lat < ? and max_lat > ?",
463                               bbox.max_lon.to_i, bbox.min_lon.to_i,
464                               bbox.max_lat.to_i, bbox.min_lat.to_i)
465     else
466       return changesets
467     end
468   end
469
470   ##
471   # restrict changesets to those by a particular user
472   def conditions_user(changesets, user, name)
473     if user.nil? && name.nil?
474       return changesets
475     else
476       # shouldn't provide both name and UID
477       fail OSM::APIBadUserInput.new("provide either the user ID or display name, but not both") if user && name
478
479       # use either the name or the UID to find the user which we're selecting on.
480       u = if name.nil?
481             # user input checking, we don't have any UIDs < 1
482             fail OSM::APIBadUserInput.new("invalid user ID") if user.to_i < 1
483             u = User.find(user.to_i)
484           else
485             u = User.find_by_display_name(name)
486           end
487
488       # make sure we found a user
489       fail OSM::APINotFoundError.new if u.nil?
490
491       # should be able to get changesets of public users only, or
492       # our own changesets regardless of public-ness.
493       unless u.data_public?
494         # get optional user auth stuff so that users can see their own
495         # changesets if they're non-public
496         setup_user_auth
497
498         fail OSM::APINotFoundError if @user.nil? || @user.id != u.id
499       end
500       return changesets.where(:user_id => u.id)
501     end
502   end
503
504   ##
505   # restrict changes to those closed during a particular time period
506   def conditions_time(changesets, time)
507     if time.nil?
508       return changesets
509     else
510       # if there is a range, i.e: comma separated, then the first is
511       # low, second is high - same as with bounding boxes.
512       if time.count(",") == 1
513         # check that we actually have 2 elements in the array
514         times = time.split(/,/)
515         fail OSM::APIBadUserInput.new("bad time range") if times.size != 2
516
517         from, to = times.collect { |t| DateTime.parse(t) }
518         return changesets.where("closed_at >= ? and created_at <= ?", from, to)
519       else
520         # if there is no comma, assume its a lower limit on time
521         return changesets.where("closed_at >= ?", DateTime.parse(time))
522       end
523     end
524     # stupid DateTime seems to throw both of these for bad parsing, so
525     # we have to catch both and ensure the correct code path is taken.
526   rescue ArgumentError => ex
527     raise OSM::APIBadUserInput.new(ex.message.to_s)
528   rescue RuntimeError => ex
529     raise OSM::APIBadUserInput.new(ex.message.to_s)
530   end
531
532   ##
533   # return changesets which are open (haven't been closed yet)
534   # we do this by seeing if the 'closed at' time is in the future. Also if we've
535   # hit the maximum number of changes then it counts as no longer open.
536   # if parameter 'open' is nill then open and closed changesets are returned
537   def conditions_open(changesets, open)
538     if open.nil?
539       return changesets
540     else
541       return changesets.where("closed_at >= ? and num_changes <= ?",
542                               Time.now.getutc, Changeset::MAX_ELEMENTS)
543     end
544   end
545
546   ##
547   # query changesets which are closed
548   # ('closed at' time has passed or changes limit is hit)
549   def conditions_closed(changesets, closed)
550     if closed.nil?
551       return changesets
552     else
553       return changesets.where("closed_at < ? or num_changes > ?",
554                               Time.now.getutc, Changeset::MAX_ELEMENTS)
555     end
556   end
557
558   ##
559   # query changesets by a list of ids
560   # (either specified as array or comma-separated string)
561   def conditions_ids(changesets, ids)
562     if ids.nil?
563       return changesets
564     elsif ids.empty?
565       fail OSM::APIBadUserInput.new("No changesets were given to search for")
566     else
567       ids = ids.split(",").collect(&:to_i)
568       return changesets.where(:id => ids)
569     end
570   end
571
572   ##
573   # eliminate empty changesets (where the bbox has not been set)
574   # this should be applied to all changeset list displays
575   def conditions_nonempty(changesets)
576     changesets.where("num_changes > 0")
577   end
578
579   ##
580   # Get the maximum number of comments to return
581   def comments_limit
582     if params[:limit]
583       if params[:limit].to_i > 0 && params[:limit].to_i <= 10000
584         params[:limit].to_i
585       else
586         fail OSM::APIBadUserInput.new("Comments limit must be between 1 and 10000")
587       end
588     else
589       100
590     end
591   end
592 end