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