1 # The ChangesetController is the RESTful interface to Changeset objects
3 class ChangesetController < ApplicationController
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]
20 # Helper methods for checking consistency
21 include ConsistencyValidations
23 # Create a changeset from XML.
27 cs = Changeset.from_xml(request.raw_post, true)
29 # Assume that Changeset.from_xml has thrown an exception if there is an error parsing the xml
33 # Subscribe user to changeset comments
34 cs.subscribers << @user
36 render :text => cs.id.to_s, :content_type => "text/plain"
40 # Return XML giving the basic info about the changeset. Does not
41 # return anything about the nodes, ways and relations in the changeset.
43 changeset = Changeset.find(params[:id])
45 render :text => changeset.to_xml(params[:include_discussion].presence).to_s, :content_type => "text/xml"
49 # marks a changeset as closed. this may be called multiple times
50 # on the same changeset, so is idempotent.
54 changeset = Changeset.find(params[:id])
55 check_changeset_consistency(changeset, @user)
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
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.
72 # only allow POST requests, because although this method is
73 # idempotent, there is no "document" to PUT really...
76 cs = Changeset.find(params[:id])
77 check_changeset_consistency(cs, @user)
79 # keep an array of lons and lats
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
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?
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
101 # save the larger bounding box and return the changeset, which
102 # will include the bigger bounding box.
104 render :text => cs.to_xml.to_s, :content_type => "text/xml"
108 # Upload a diff in a single transaction.
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.
114 # Furthermore, each element in the diff can only reference the current
117 # Returns: a diffResult document, as described in
118 # http://wiki.openstreetmap.org/wiki/OSM_Protocol_Version_0.6
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
126 changeset = Changeset.find(params[:id])
127 check_changeset_consistency(changeset, @user)
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"
137 # download the changeset as an osmChange document.
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...
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
149 changeset = Changeset.find(params[:id])
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
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
161 elements.sort! do |a, b|
162 if (a.timestamp == b.timestamp)
163 a.version <=> b.version
165 a.timestamp <=> b.timestamp
169 # create changeset and user caches
171 user_display_name_cache = {}
173 # create an osmChange document for the output
174 result = OSM::API.new.get_xml_doc
175 result.root.name = "osmChange"
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|
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)
189 modified = XML::Node.new "modify"
190 modified << elt.to_xml_node(changeset_cache, user_display_name_cache)
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)
199 render :text => result.to_s, :content_type => "text/xml"
203 # query changesets by bounding box, time, user or open/closed status.
205 # find any bounding box
206 bbox = BoundingBox.from_bbox_params(params) if params["bbox"]
208 # create the conditions that the user asked for. some or all of
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"])
218 # create the results document
219 results = OSM::API.new.get_xml_doc
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
226 render :text => results.to_s, :content_type => "text/xml"
230 # updates a changeset's tags. none of the changeset's attributes are
231 # user-modifiable, so they will be ignored.
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.
236 # after succesful update, returns the XML of the changeset.
238 # request *must* be a PUT.
241 changeset = Changeset.find(params[:id])
242 new_changeset = Changeset.from_xml(request.raw_post)
244 if new_changeset.nil?
245 render :text => "", :status => :bad_request
247 check_changeset_consistency(changeset, @user)
248 changeset.update_from(new_changeset, @user)
249 render :text => changeset.to_xml, :mime_type => "text/xml"
254 # list edits (open changesets) in reverse chronological order
256 if request.format == :atom && params[:max_id]
257 redirect_to url_for(params.merge(:max_id => nil)), :status => :moved_permanently
261 if params[:display_name]
262 user = User.find_by_display_name(params[:display_name])
263 if !user || !user.active?
264 render_unknown_user params[:display_name]
269 if (params[:friends] || params[:nearby]) && !@user
274 if request.format == :html && !params[:list]
276 render :action => :history, :layout => map_layout
278 changesets = conditions_nonempty(Changeset.all)
280 if params[:display_name]
281 if user.data_public? || user == @user
282 changesets = changesets.where(:user_id => user.id)
284 changesets = changesets.where("false")
287 changesets = conditions_bbox(changesets, BoundingBox.from_bbox_params(params))
288 elsif params[:friends] && @user
289 changesets = changesets.where(:user_id => @user.friend_users.identifiable)
290 elsif params[:nearby] && @user
291 changesets = changesets.where(:user_id => @user.nearby)
295 changesets = changesets.where("changesets.id <= ?", params[:max_id])
298 @edits = changesets.order("changesets.id DESC").limit(20).preload(:user, :changeset_tags)
300 render :action => :list, :layout => false
305 # list edits as an atom feed
311 # Add a comment to a changeset
313 # Check the arguments are sane
314 fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
315 fail OSM::APIBadUserInput.new("No text was given") if params[:text].blank?
317 # Extract the arguments
318 id = params[:id].to_i
321 # Find the changeset and check it is valid
322 changeset = Changeset.find(id)
323 fail OSM::APIChangesetNotYetClosedError.new(changeset) if changeset.is_open?
325 # Add a comment to the changeset
326 comment = changeset.comments.create(:changeset => changeset,
330 # Notify current subscribers of the new comment
331 changeset.subscribers.each do |user|
333 Notifier.changeset_comment_notification(comment, user).deliver_now
337 # Add the commenter to the subscribers if necessary
338 changeset.subscribers << @user unless changeset.subscribers.exists?(@user.id)
340 # Return a copy of the updated changeset
341 render :text => changeset.to_xml.to_s, :content_type => "text/xml"
345 # Adds a subscriber to the changeset
347 # Check the arguments are sane
348 fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
350 # Extract the arguments
351 id = params[:id].to_i
353 # Find the changeset and check it is valid
354 changeset = Changeset.find(id)
355 fail OSM::APIChangesetNotYetClosedError.new(changeset) if changeset.is_open?
356 fail OSM::APIChangesetAlreadySubscribedError.new(changeset) if changeset.subscribers.exists?(@user.id)
359 changeset.subscribers << @user
361 # Return a copy of the updated changeset
362 render :text => changeset.to_xml.to_s, :content_type => "text/xml"
366 # Removes a subscriber from the changeset
368 # Check the arguments are sane
369 fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
371 # Extract the arguments
372 id = params[:id].to_i
374 # Find the changeset and check it is valid
375 changeset = Changeset.find(id)
376 fail OSM::APIChangesetNotYetClosedError.new(changeset) if changeset.is_open?
377 fail OSM::APIChangesetNotSubscribedError.new(changeset) unless changeset.subscribers.exists?(@user.id)
379 # Remove the subscriber
380 changeset.subscribers.delete(@user)
382 # Return a copy of the updated changeset
383 render :text => changeset.to_xml.to_s, :content_type => "text/xml"
387 # Sets visible flag on comment to false
389 # Check the arguments are sane
390 fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
392 # Extract the arguments
393 id = params[:id].to_i
396 comment = ChangesetComment.find(id)
399 comment.update(:visible => false)
401 # Return a copy of the updated changeset
402 render :text => comment.changeset.to_xml.to_s, :content_type => "text/xml"
406 # Sets visible flag on comment to true
408 # Check the arguments are sane
409 fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
411 # Extract the arguments
412 id = params[:id].to_i
415 comment = ChangesetComment.find(id)
418 comment.update(:visible => true)
420 # Return a copy of the updated changeset
421 render :text => comment.changeset.to_xml.to_s, :content_type => "text/xml"
425 # Get a feed of recent changeset comments
428 # Extract the arguments
429 id = params[:id].to_i
432 changeset = Changeset.find(id)
434 # Return comments for this changeset only
435 @comments = changeset.comments.includes(:author, :changeset).limit(comments_limit)
438 @comments = ChangesetComment.includes(:author, :changeset).where(:visible => :true).order("created_at DESC").limit(comments_limit).preload(:changeset)
442 respond_to do |format|
445 rescue OSM::APIBadUserInput
446 render :text => "", :status => :bad_request
451 #------------------------------------------------------------
452 # utility functions below.
453 #------------------------------------------------------------
456 # if a bounding box was specified do some sanity checks.
457 # restrict changesets to those enclosed by a bounding box
458 # we need to return both the changesets and the bounding box
459 def conditions_bbox(changesets, bbox)
461 bbox.check_boundaries
462 bbox = bbox.to_scaled
463 return changesets.where("min_lon < ? and max_lon > ? and min_lat < ? and max_lat > ?",
464 bbox.max_lon.to_i, bbox.min_lon.to_i,
465 bbox.max_lat.to_i, bbox.min_lat.to_i)
472 # restrict changesets to those by a particular user
473 def conditions_user(changesets, user, name)
474 if user.nil? && name.nil?
477 # shouldn't provide both name and UID
478 fail OSM::APIBadUserInput.new("provide either the user ID or display name, but not both") if user && name
480 # use either the name or the UID to find the user which we're selecting on.
482 # user input checking, we don't have any UIDs < 1
483 fail OSM::APIBadUserInput.new("invalid user ID") if user.to_i < 1
484 u = User.find(user.to_i)
486 u = User.find_by_display_name(name)
489 # make sure we found a user
490 fail OSM::APINotFoundError.new if u.nil?
492 # should be able to get changesets of public users only, or
493 # our own changesets regardless of public-ness.
494 unless u.data_public?
495 # get optional user auth stuff so that users can see their own
496 # changesets if they're non-public
499 fail OSM::APINotFoundError if @user.nil? || @user.id != u.id
501 return changesets.where(:user_id => u.id)
506 # restrict changes to those closed during a particular time period
507 def conditions_time(changesets, time)
511 # if there is a range, i.e: comma separated, then the first is
512 # low, second is high - same as with bounding boxes.
513 if time.count(",") == 1
514 # check that we actually have 2 elements in the array
515 times = time.split(/,/)
516 fail OSM::APIBadUserInput.new("bad time range") if times.size != 2
518 from, to = times.collect { |t| DateTime.parse(t) }
519 return changesets.where("closed_at >= ? and created_at <= ?", from, to)
521 # if there is no comma, assume its a lower limit on time
522 return changesets.where("closed_at >= ?", DateTime.parse(time))
525 # stupid DateTime seems to throw both of these for bad parsing, so
526 # we have to catch both and ensure the correct code path is taken.
527 rescue ArgumentError => ex
528 raise OSM::APIBadUserInput.new(ex.message.to_s)
529 rescue RuntimeError => ex
530 raise OSM::APIBadUserInput.new(ex.message.to_s)
534 # return changesets which are open (haven't been closed yet)
535 # we do this by seeing if the 'closed at' time is in the future. Also if we've
536 # hit the maximum number of changes then it counts as no longer open.
537 # if parameter 'open' is nill then open and closed changesets are returned
538 def conditions_open(changesets, open)
542 return changesets.where("closed_at >= ? and num_changes <= ?",
543 Time.now.getutc, Changeset::MAX_ELEMENTS)
548 # query changesets which are closed
549 # ('closed at' time has passed or changes limit is hit)
550 def conditions_closed(changesets, closed)
554 return changesets.where("closed_at < ? or num_changes > ?",
555 Time.now.getutc, Changeset::MAX_ELEMENTS)
560 # query changesets by a list of ids
561 # (either specified as array or comma-separated string)
562 def conditions_ids(changesets, ids)
566 fail OSM::APIBadUserInput.new("No changesets were given to search for")
568 ids = ids.split(",").collect(&:to_i)
569 return changesets.where(:id => ids)
574 # eliminate empty changesets (where the bbox has not been set)
575 # this should be applied to all changeset list displays
576 def conditions_nonempty(changesets)
577 changesets.where("num_changes > 0")
581 # Get the maximum number of comments to return
584 if params[:limit].to_i > 0 && params[:limit].to_i <= 10000
587 fail OSM::APIBadUserInput.new("Comments limit must be between 1 and 10000")