1 # The ChangesetController is the RESTful interface to Changeset objects
3 class ChangesetController < ApplicationController
7 skip_before_filter :verify_authenticity_token, :except => [:list]
8 before_filter :authorize_web, :only => [:list]
9 before_filter :set_locale, :only => [:list]
10 before_filter :authorize, :only => [:create, :update, :delete, :upload, :include, :close]
11 before_filter :require_allow_write_api, :only => [:create, :update, :delete, :upload, :include, :close]
12 before_filter :require_public_data, :only => [:create, :update, :delete, :upload, :include, :close]
13 before_filter :check_api_writable, :only => [:create, :update, :delete, :upload, :include]
14 before_filter :check_api_readable, :except => [:create, :update, :delete, :upload, :download, :query, :list]
15 before_filter(:only => [:list]) { |c| c.check_database_readable(true) }
16 after_filter :compress_output
17 around_filter :api_call_handle_error, :except => [:list]
18 around_filter :web_timeout, :only => [:list]
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
32 render :text => cs.id.to_s, :content_type => "text/plain"
36 # Return XML giving the basic info about the changeset. Does not
37 # return anything about the nodes, ways and relations in the changeset.
39 changeset = Changeset.find(params[:id])
40 render :text => changeset.to_xml.to_s, :content_type => "text/xml"
44 # marks a changeset as closed. this may be called multiple times
45 # on the same changeset, so is idempotent.
49 changeset = Changeset.find(params[:id])
50 check_changeset_consistency(changeset, @user)
52 # to close the changeset, we'll just set its closed_at time to
53 # now. this might not be enough if there are concurrency issues,
54 # but we'll have to wait and see.
55 changeset.set_closed_time_now
58 render :nothing => true
62 # insert a (set of) points into a changeset bounding box. this can only
63 # increase the size of the bounding box. this is a hint that clients can
64 # set either before uploading a large number of changes, or changes that
65 # the client (but not the server) knows will affect areas further away.
67 # only allow POST requests, because although this method is
68 # idempotent, there is no "document" to PUT really...
71 cs = Changeset.find(params[:id])
72 check_changeset_consistency(cs, @user)
74 # keep an array of lons and lats
78 # the request is in pseudo-osm format... this is kind-of an
79 # abuse, maybe should change to some other format?
80 doc = XML::Parser.string(request.raw_post).parse
81 doc.find("//osm/node").each do |n|
82 lon << n['lon'].to_f * GeoRecord::SCALE
83 lat << n['lat'].to_f * GeoRecord::SCALE
86 # add the existing bounding box to the lon-lat array
87 lon << cs.min_lon unless cs.min_lon.nil?
88 lat << cs.min_lat unless cs.min_lat.nil?
89 lon << cs.max_lon unless cs.max_lon.nil?
90 lat << cs.max_lat unless cs.max_lat.nil?
92 # collapse the arrays to minimum and maximum
93 cs.min_lon, cs.min_lat, cs.max_lon, cs.max_lat =
94 lon.min, lat.min, lon.max, lat.max
96 # save the larger bounding box and return the changeset, which
97 # will include the bigger bounding box.
99 render :text => cs.to_xml.to_s, :content_type => "text/xml"
103 # Upload a diff in a single transaction.
105 # This means that each change within the diff must succeed, i.e: that
106 # each version number mentioned is still current. Otherwise the entire
107 # transaction *must* be rolled back.
109 # Furthermore, each element in the diff can only reference the current
112 # Returns: a diffResult document, as described in
113 # http://wiki.openstreetmap.org/wiki/OSM_Protocol_Version_0.6
115 # only allow POST requests, as the upload method is most definitely
116 # not idempotent, as several uploads with placeholder IDs will have
117 # different side-effects.
118 # see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.1.2
121 changeset = Changeset.find(params[:id])
122 check_changeset_consistency(changeset, @user)
124 diff_reader = DiffReader.new(request.raw_post, changeset)
125 Changeset.transaction do
126 result = diff_reader.commit
127 render :text => result.to_s, :content_type => "text/xml"
132 # download the changeset as an osmChange document.
134 # to make it easier to revert diffs it would be better if the osmChange
135 # format were reversible, i.e: contained both old and new versions of
136 # modified elements. but it doesn't at the moment...
138 # this method cannot order the database changes fully (i.e: timestamp and
139 # version number may be too coarse) so the resulting diff may not apply
140 # to a different database. however since changesets are not atomic this
141 # behaviour cannot be guaranteed anyway and is the result of a design
144 changeset = Changeset.find(params[:id])
146 # get all the elements in the changeset and stick them in a big array.
147 elements = [changeset.old_nodes,
149 changeset.old_relations].flatten
151 # sort the elements by timestamp and version number, as this is the
152 # almost sensible ordering available. this would be much nicer if
153 # global (SVN-style) versioning were used - then that would be
155 elements.sort! do |a, b|
156 if (a.timestamp == b.timestamp)
157 a.version <=> b.version
159 a.timestamp <=> b.timestamp
163 # create an osmChange document for the output
164 result = OSM::API.new.get_xml_doc
165 result.root.name = "osmChange"
167 # generate an output element for each operation. note: we avoid looking
168 # at the history because it is simpler - but it would be more correct to
169 # check these assertions.
170 elements.each do |elt|
172 if (elt.version == 1)
173 # first version, so it must be newly-created.
174 created = XML::Node.new "create"
175 created << elt.to_xml_node
177 # get the previous version from the element history
178 prev_elt = elt.class.find([elt.id, elt.version])
180 # if the element isn't visible then it must have been deleted, so
181 # output the *previous* XML
182 deleted = XML::Node.new "delete"
183 deleted << prev_elt.to_xml_node
185 # must be a modify, for which we don't need the previous version
187 modified = XML::Node.new "modify"
188 modified << elt.to_xml_node
193 render :text => result.to_s, :content_type => "text/xml"
197 # query changesets by bounding box, time, user or open/closed status.
199 # find any bounding box
201 bbox = BoundingBox.from_bbox_params(params)
204 # create the conditions that the user asked for. some or all of
206 changesets = Changeset.scoped
207 changesets = conditions_bbox(changesets, bbox)
208 changesets = conditions_user(changesets, params['user'], params['display_name'])
209 changesets = conditions_time(changesets, params['time'])
210 changesets = conditions_open(changesets, params['open'])
211 changesets = conditions_closed(changesets, params['closed'])
213 # create the results document
214 results = OSM::API.new.get_xml_doc
216 # add all matching changesets to the XML results document
217 changesets.order("created_at DESC").limit(100).each do |cs|
218 results.root << cs.to_xml_node
221 render :text => results.to_s, :content_type => "text/xml"
225 # updates a changeset's tags. none of the changeset's attributes are
226 # user-modifiable, so they will be ignored.
228 # changesets are not (yet?) versioned, so we don't have to deal with
229 # history tables here. changesets are locked to a single user, however.
231 # after succesful update, returns the XML of the changeset.
233 # request *must* be a PUT.
236 changeset = Changeset.find(params[:id])
237 new_changeset = Changeset.from_xml(request.raw_post)
239 unless new_changeset.nil?
240 check_changeset_consistency(changeset, @user)
241 changeset.update_from(new_changeset, @user)
242 render :text => changeset.to_xml, :mime_type => "text/xml"
245 render :nothing => true, :status => :bad_request
252 # list edits (open changesets) in reverse chronological order
254 if request.format == :atom and params[:page]
255 redirect_to params.merge({ :page => nil }), :status => :moved_permanently
257 changesets = conditions_nonempty(Changeset.scoped)
259 if params[:display_name]
260 user = User.find_by_display_name(params[:display_name])
262 if user and user.active?
263 if user.data_public? or user == @user
264 changesets = changesets.where(:user_id => user.id)
266 changesets = changesets.where("false")
268 elsif request.format == :html
269 @title = t 'user.no_such_user.title'
270 @not_found_user = params[:display_name]
271 render :template => 'user/no_such_user', :status => :not_found
276 bbox = BoundingBox.from_bbox_params(params)
277 elsif params[:minlon] and params[:minlat] and params[:maxlon] and params[:maxlat]
278 bbox = BoundingBox.from_lon_lat_params(params)
282 changesets = conditions_bbox(changesets, bbox)
283 bbox_link = render_to_string :partial => "bbox", :object => bbox
287 user_link = render_to_string :partial => "user", :object => user
291 @title = t 'changeset.list.title_user_bbox', :user => user.display_name, :bbox => bbox.to_s
292 @heading = t 'changeset.list.heading_user_bbox', :user => user.display_name, :bbox => bbox.to_s
293 @description = t 'changeset.list.description_user_bbox', :user => user_link, :bbox => bbox_link
295 @title = t 'changeset.list.title_user', :user => user.display_name
296 @heading = t 'changeset.list.heading_user', :user => user.display_name
297 @description = t 'changeset.list.description_user', :user => user_link
299 @title = t 'changeset.list.title_bbox', :bbox => bbox.to_s
300 @heading = t 'changeset.list.heading_bbox', :bbox => bbox.to_s
301 @description = t 'changeset.list.description_bbox', :bbox => bbox_link
303 @title = t 'changeset.list.title'
304 @heading = t 'changeset.list.heading'
305 @description = t 'changeset.list.description'
308 @page = (params[:page] || 1).to_i
313 @edits = changesets.order("changesets.created_at DESC").offset((@page - 1) * @page_size).limit(@page_size).preload(:user, :changeset_tags)
318 #------------------------------------------------------------
319 # utility functions below.
320 #------------------------------------------------------------
323 # if a bounding box was specified do some sanity checks.
324 # restrict changesets to those enclosed by a bounding box
325 # we need to return both the changesets and the bounding box
326 def conditions_bbox(changesets, bbox)
328 bbox.check_boundaries
329 bbox = bbox.to_scaled
330 return changesets.where("min_lon < ? and max_lon > ? and min_lat < ? and max_lat > ?",
331 bbox.max_lon.to_i, bbox.min_lon.to_i,
332 bbox.max_lat.to_i, bbox.min_lat.to_i)
339 # restrict changesets to those by a particular user
340 def conditions_user(changesets, user, name)
341 unless user.nil? and name.nil?
342 # shouldn't provide both name and UID
343 raise OSM::APIBadUserInput.new("provide either the user ID or display name, but not both") if user and name
345 # use either the name or the UID to find the user which we're selecting on.
347 # user input checking, we don't have any UIDs < 1
348 raise OSM::APIBadUserInput.new("invalid user ID") if user.to_i < 1
349 u = User.find(user.to_i)
351 u = User.find_by_display_name(name)
354 # make sure we found a user
355 raise OSM::APINotFoundError.new if u.nil?
357 # should be able to get changesets of public users only, or
358 # our own changesets regardless of public-ness.
359 unless u.data_public?
360 # get optional user auth stuff so that users can see their own
361 # changesets if they're non-public
364 raise OSM::APINotFoundError if @user.nil? or @user.id != u.id
366 return changesets.where(:user_id => u.id)
373 # restrict changes to those closed during a particular time period
374 def conditions_time(changesets, time)
376 # if there is a range, i.e: comma separated, then the first is
377 # low, second is high - same as with bounding boxes.
378 if time.count(',') == 1
379 # check that we actually have 2 elements in the array
380 times = time.split(/,/)
381 raise OSM::APIBadUserInput.new("bad time range") if times.size != 2
383 from, to = times.collect { |t| DateTime.parse(t) }
384 return changesets.where("closed_at >= ? and created_at <= ?", from, to)
386 # if there is no comma, assume its a lower limit on time
387 return changesets.where("closed_at >= ?", DateTime.parse(time))
392 # stupid DateTime seems to throw both of these for bad parsing, so
393 # we have to catch both and ensure the correct code path is taken.
394 rescue ArgumentError => ex
395 raise OSM::APIBadUserInput.new(ex.message.to_s)
396 rescue RuntimeError => ex
397 raise OSM::APIBadUserInput.new(ex.message.to_s)
401 # return changesets which are open (haven't been closed yet)
402 # we do this by seeing if the 'closed at' time is in the future. Also if we've
403 # hit the maximum number of changes then it counts as no longer open.
404 # if parameter 'open' is nill then open and closed changesets are returned
405 def conditions_open(changesets, open)
409 return changesets.where("closed_at >= ? and num_changes <= ?",
410 Time.now.getutc, Changeset::MAX_ELEMENTS)
415 # query changesets which are closed
416 # ('closed at' time has passed or changes limit is hit)
417 def conditions_closed(changesets, closed)
421 return changesets.where("closed_at < ? or num_changes > ?",
422 Time.now.getutc, Changeset::MAX_ELEMENTS)
427 # eliminate empty changesets (where the bbox has not been set)
428 # this should be applied to all changeset list displays
429 def conditions_nonempty(changesets)
430 return changesets.where("num_changes > 0")