Standardise on double quoted strings
[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_filter :verify_authenticity_token, :except => [:list]
8   before_filter :authorize_web, :only => [:list, :feed, :comments_feed]
9   before_filter :set_locale, :only => [:list, :feed, :comments_feed]
10   before_filter :authorize, :only => [:create, :update, :delete, :upload, :include, :close, :comment, :subscribe, :unsubscribe, :hide_comment, :unhide_comment]
11   before_filter :require_moderator, :only => [:hide_comment, :unhide_comment]
12   before_filter :require_allow_write_api, :only => [:create, :update, :delete, :upload, :include, :close, :comment, :subscribe, :unsubscribe, :hide_comment, :unhide_comment]
13   before_filter :require_public_data, :only => [:create, :update, :delete, :upload, :include, :close, :comment, :subscribe, :unsubscribe]
14   before_filter :check_api_writable, :only => [:create, :update, :delete, :upload, :include, :comment, :subscribe, :unsubscribe, :hide_comment, :unhide_comment]
15   before_filter :check_api_readable, :except => [:create, :update, :delete, :upload, :download, :query, :list, :feed, :comment, :subscribe, :unsubscribe, :comments_feed]
16   before_filter(:only => [:list, :feed, :comments_feed]) { |c| c.check_database_readable(true) }
17   after_filter :compress_output
18   around_filter :api_call_handle_error, :except => [:list, :feed, :comments_feed]
19   around_filter :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, cs.min_lat, cs.max_lon, cs.max_lat =
100       lon.min, lat.min, lon.max, lat.max
101
102     # save the larger bounding box and return the changeset, which
103     # will include the bigger bounding box.
104     cs.save!
105     render :text => cs.to_xml.to_s, :content_type => "text/xml"
106   end
107
108   ##
109   # Upload a diff in a single transaction.
110   #
111   # This means that each change within the diff must succeed, i.e: that
112   # each version number mentioned is still current. Otherwise the entire
113   # transaction *must* be rolled back.
114   #
115   # Furthermore, each element in the diff can only reference the current
116   # changeset.
117   #
118   # Returns: a diffResult document, as described in
119   # http://wiki.openstreetmap.org/wiki/OSM_Protocol_Version_0.6
120   def upload
121     # only allow POST requests, as the upload method is most definitely
122     # not idempotent, as several uploads with placeholder IDs will have
123     # different side-effects.
124     # see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.1.2
125     assert_method :post
126
127     changeset = Changeset.find(params[:id])
128     check_changeset_consistency(changeset, @user)
129
130     diff_reader = DiffReader.new(request.raw_post, changeset)
131     Changeset.transaction do
132       result = diff_reader.commit
133       render :text => result.to_s, :content_type => "text/xml"
134     end
135   end
136
137   ##
138   # download the changeset as an osmChange document.
139   #
140   # to make it easier to revert diffs it would be better if the osmChange
141   # format were reversible, i.e: contained both old and new versions of
142   # modified elements. but it doesn't at the moment...
143   #
144   # this method cannot order the database changes fully (i.e: timestamp and
145   # version number may be too coarse) so the resulting diff may not apply
146   # to a different database. however since changesets are not atomic this
147   # behaviour cannot be guaranteed anyway and is the result of a design
148   # choice.
149   def download
150     changeset = Changeset.find(params[:id])
151
152     # get all the elements in the changeset which haven't been redacted
153     # and stick them in a big array.
154     elements = [changeset.old_nodes.unredacted,
155                 changeset.old_ways.unredacted,
156                 changeset.old_relations.unredacted].flatten
157
158     # sort the elements by timestamp and version number, as this is the
159     # almost sensible ordering available. this would be much nicer if
160     # global (SVN-style) versioning were used - then that would be
161     # unambiguous.
162     elements.sort! do |a, b|
163       if (a.timestamp == b.timestamp)
164         a.version <=> b.version
165       else
166         a.timestamp <=> b.timestamp
167       end
168     end
169
170     # create changeset and user caches
171     changeset_cache = {}
172     user_display_name_cache = {}
173
174     # create an osmChange document for the output
175     result = OSM::API.new.get_xml_doc
176     result.root.name = "osmChange"
177
178     # generate an output element for each operation. note: we avoid looking
179     # at the history because it is simpler - but it would be more correct to
180     # check these assertions.
181     elements.each do |elt|
182       result.root <<
183         if (elt.version == 1)
184           # first version, so it must be newly-created.
185           created = XML::Node.new "create"
186           created << elt.to_xml_node(changeset_cache, user_display_name_cache)
187         else
188           if elt.visible
189             # must be a modify
190             modified = XML::Node.new "modify"
191             modified << elt.to_xml_node(changeset_cache, user_display_name_cache)
192           else
193             # if the element isn't visible then it must have been deleted
194             deleted = XML::Node.new "delete"
195             deleted << elt.to_xml_node(changeset_cache, user_display_name_cache)
196           end
197         end
198     end
199
200     render :text => result.to_s, :content_type => "text/xml"
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     # create the results document
220     results = OSM::API.new.get_xml_doc
221
222     # add all matching changesets to the XML results document
223     changesets.order("created_at DESC").limit(100).each do |cs|
224       results.root << cs.to_xml_node
225     end
226
227     render :text => results.to_s, :content_type => "text/xml"
228   end
229
230   ##
231   # updates a changeset's tags. none of the changeset's attributes are
232   # user-modifiable, so they will be ignored.
233   #
234   # changesets are not (yet?) versioned, so we don't have to deal with
235   # history tables here. changesets are locked to a single user, however.
236   #
237   # after succesful update, returns the XML of the changeset.
238   def update
239     # request *must* be a PUT.
240     assert_method :put
241
242     changeset = Changeset.find(params[:id])
243     new_changeset = Changeset.from_xml(request.raw_post)
244
245     if new_changeset.nil?
246       render :text => "", :status => :bad_request
247     else
248       check_changeset_consistency(changeset, @user)
249       changeset.update_from(new_changeset, @user)
250       render :text => changeset.to_xml, :mime_type => "text/xml"
251     end
252   end
253
254   ##
255   # list edits (open changesets) in reverse chronological order
256   def list
257     if request.format == :atom && params[:max_id]
258       redirect_to params.merge(:max_id => nil), :status => :moved_permanently
259       return
260     end
261
262     if params[:display_name]
263       user = User.find_by_display_name(params[:display_name])
264       if !user || !user.active?
265         render_unknown_user params[:display_name]
266         return
267       end
268     end
269
270     if (params[:friends] || params[:nearby]) && !@user && request.format == :html
271       require_user
272       return
273     end
274
275     if request.format == :html && !params[:list]
276       require_oauth
277       render :action => :history, :layout => map_layout
278     else
279       changesets = conditions_nonempty(Changeset.all)
280
281       if params[:display_name]
282         if user.data_public? || user == @user
283           changesets = changesets.where(:user_id => user.id)
284         else
285           changesets = changesets.where("false")
286         end
287       elsif params[:bbox]
288         changesets = conditions_bbox(changesets, BoundingBox.from_bbox_params(params))
289       elsif params[:friends] && @user
290         changesets = changesets.where(:user_id => @user.friend_users.identifiable)
291       elsif params[:nearby] && @user
292         changesets = changesets.where(:user_id => @user.nearby)
293       end
294
295       if params[:max_id]
296         changesets = changesets.where("changesets.id <= ?", params[:max_id])
297       end
298
299       @edits = changesets.order("changesets.id DESC").limit(20).preload(:user, :changeset_tags)
300
301       render :action => :list, :layout => false
302     end
303   end
304
305   ##
306   # list edits as an atom feed
307   def feed
308     list
309   end
310
311   ##
312   # Add a comment to a changeset
313   def comment
314     # Check the arguments are sane
315     fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
316     fail OSM::APIBadUserInput.new("No text was given") if params[:text].blank?
317
318     # Extract the arguments
319     id = params[:id].to_i
320     body = params[:text]
321
322     # Find the changeset and check it is valid
323     changeset = Changeset.find(id)
324     fail OSM::APIChangesetNotYetClosedError.new(changeset) if changeset.is_open?
325
326     # Add a comment to the changeset
327     comment = changeset.comments.create(:changeset => changeset,
328                                         :body => body,
329                                         :author => @user)
330
331     # Notify current subscribers of the new comment
332     changeset.subscribers.each do |user|
333       if @user != user
334         Notifier.changeset_comment_notification(comment, user).deliver_now
335       end
336     end
337
338     # Add the commenter to the subscribers if necessary
339     changeset.subscribers << @user unless changeset.subscribers.exists?(@user.id)
340
341     # Return a copy of the updated changeset
342     render :text => changeset.to_xml.to_s, :content_type => "text/xml"
343   end
344
345   ##
346   # Adds a subscriber to the changeset
347   def subscribe
348     # Check the arguments are sane
349     fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
350
351     # Extract the arguments
352     id = params[:id].to_i
353
354     # Find the changeset and check it is valid
355     changeset = Changeset.find(id)
356     fail OSM::APIChangesetNotYetClosedError.new(changeset) if changeset.is_open?
357     fail OSM::APIChangesetAlreadySubscribedError.new(changeset) if changeset.subscribers.exists?(@user.id)
358
359     # Add the subscriber
360     changeset.subscribers << @user
361
362     # Return a copy of the updated changeset
363     render :text => changeset.to_xml.to_s, :content_type => "text/xml"
364   end
365
366   ##
367   # Removes a subscriber from the changeset
368   def unsubscribe
369     # Check the arguments are sane
370     fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
371
372     # Extract the arguments
373     id = params[:id].to_i
374
375     # Find the changeset and check it is valid
376     changeset = Changeset.find(id)
377     fail OSM::APIChangesetNotYetClosedError.new(changeset) if changeset.is_open?
378     fail OSM::APIChangesetNotSubscribedError.new(changeset) unless changeset.subscribers.exists?(@user.id)
379
380     # Remove the subscriber
381     changeset.subscribers.delete(@user)
382
383     # Return a copy of the updated changeset
384     render :text => changeset.to_xml.to_s, :content_type => "text/xml"
385   end
386
387   ##
388   # Sets visible flag on comment to false
389   def hide_comment
390     # Check the arguments are sane
391     fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
392
393     # Extract the arguments
394     id = params[:id].to_i
395
396     # Find the changeset
397     comment = ChangesetComment.find(id)
398
399     # Hide the comment
400     comment.update(:visible => false)
401
402     # Return a copy of the updated changeset
403     render :text => comment.changeset.to_xml.to_s, :content_type => "text/xml"
404   end
405
406   ##
407   # Sets visible flag on comment to true
408   def unhide_comment
409     # Check the arguments are sane
410     fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
411
412     # Extract the arguments
413     id = params[:id].to_i
414
415     # Find the changeset
416     comment = ChangesetComment.find(id)
417
418     # Unhide the comment
419     comment.update(:visible => true)
420
421     # Return a copy of the updated changeset
422     render :text => comment.changeset.to_xml.to_s, :content_type => "text/xml"
423   end
424
425   ##
426   # Get a feed of recent changeset comments
427   def comments_feed
428     if params[:id]
429       # Extract the arguments
430       id = params[:id].to_i
431
432       # Find the changeset
433       changeset = Changeset.find(id)
434
435       # Return comments for this changeset only
436       @comments = changeset.comments.includes(:author, :changeset).limit(comments_limit)
437     else
438       # Return comments
439       @comments = ChangesetComment.includes(:author, :changeset).where(:visible => :true).order("created_at DESC").limit(comments_limit).preload(:changeset)
440     end
441
442     # Render the result
443     respond_to do |format|
444       format.rss
445     end
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