Merge branch 'notes'
[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]
9   before_filter :set_locale, :only => [:list, :feed]
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, :feed]
15   before_filter(:only => [:list, :feed]) { |c| c.check_database_readable(true) }
16   after_filter :compress_output
17   around_filter :api_call_handle_error, :except => [:list, :feed]
18   around_filter :web_timeout, :only => [:list, :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     render :text => cs.id.to_s, :content_type => "text/plain"
33   end
34
35   ##
36   # Return XML giving the basic info about the changeset. Does not
37   # return anything about the nodes, ways and relations in the changeset.
38   def read
39     changeset = Changeset.find(params[:id])
40     render :text => changeset.to_xml.to_s, :content_type => "text/xml"
41   end
42
43   ##
44   # marks a changeset as closed. this may be called multiple times
45   # on the same changeset, so is idempotent.
46   def close
47     assert_method :put
48
49     changeset = Changeset.find(params[:id])
50     check_changeset_consistency(changeset, @user)
51
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
56
57     changeset.save!
58     render :nothing => true
59   end
60
61   ##
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.
66   def expand_bbox
67     # only allow POST requests, because although this method is
68     # idempotent, there is no "document" to PUT really...
69     assert_method :post
70
71     cs = Changeset.find(params[:id])
72     check_changeset_consistency(cs, @user)
73
74     # keep an array of lons and lats
75     lon = Array.new
76     lat = Array.new
77
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
84     end
85
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?
91
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
95
96     # save the larger bounding box and return the changeset, which
97     # will include the bigger bounding box.
98     cs.save!
99     render :text => cs.to_xml.to_s, :content_type => "text/xml"
100   end
101
102   ##
103   # Upload a diff in a single transaction.
104   #
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.
108   #
109   # Furthermore, each element in the diff can only reference the current
110   # changeset.
111   #
112   # Returns: a diffResult document, as described in
113   # http://wiki.openstreetmap.org/wiki/OSM_Protocol_Version_0.6
114   def upload
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
119     assert_method :post
120
121     changeset = Changeset.find(params[:id])
122     check_changeset_consistency(changeset, @user)
123
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"
128     end
129   end
130
131   ##
132   # download the changeset as an osmChange document.
133   #
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...
137   #
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
142   # choice.
143   def download
144     changeset = Changeset.find(params[:id])
145
146     # get all the elements in the changeset which haven't been redacted
147     # and stick them in a big array.
148     elements = [changeset.old_nodes.unredacted,
149                 changeset.old_ways.unredacted,
150                 changeset.old_relations.unredacted].flatten
151
152     # sort the elements by timestamp and version number, as this is the
153     # almost sensible ordering available. this would be much nicer if
154     # global (SVN-style) versioning were used - then that would be
155     # unambiguous.
156     elements.sort! do |a, b|
157       if (a.timestamp == b.timestamp)
158         a.version <=> b.version
159       else
160         a.timestamp <=> b.timestamp
161       end
162     end
163
164     # create changeset and user caches
165     changeset_cache = {}
166     user_display_name_cache = {}
167
168     # create an osmChange document for the output
169     result = OSM::API.new.get_xml_doc
170     result.root.name = "osmChange"
171
172     # generate an output element for each operation. note: we avoid looking
173     # at the history because it is simpler - but it would be more correct to
174     # check these assertions.
175     elements.each do |elt|
176       result.root <<
177         if (elt.version == 1)
178           # first version, so it must be newly-created.
179           created = XML::Node.new "create"
180           created << elt.to_xml_node(changeset_cache, user_display_name_cache)
181         else
182           unless elt.visible
183             # if the element isn't visible then it must have been deleted
184             deleted = XML::Node.new "delete"
185             deleted << elt.to_xml_node(changeset_cache, user_display_name_cache)
186           else
187             # must be a modify
188             modified = XML::Node.new "modify"
189             modified << elt.to_xml_node(changeset_cache, user_display_name_cache)
190           end
191         end
192     end
193
194     render :text => result.to_s, :content_type => "text/xml"
195   end
196
197   ##
198   # query changesets by bounding box, time, user or open/closed status.
199   def query
200     # find any bounding box
201     if params['bbox']
202       bbox = BoundingBox.from_bbox_params(params)
203     end
204
205     # create the conditions that the user asked for. some or all of
206     # these may be nil.
207     changesets = Changeset.scoped
208     changesets = conditions_bbox(changesets, bbox)
209     changesets = conditions_user(changesets, params['user'], params['display_name'])
210     changesets = conditions_time(changesets, params['time'])
211     changesets = conditions_open(changesets, params['open'])
212     changesets = conditions_closed(changesets, params['closed'])
213
214     # create the results document
215     results = OSM::API.new.get_xml_doc
216
217     # add all matching changesets to the XML results document
218     changesets.order("created_at DESC").limit(100).each do |cs|
219       results.root << cs.to_xml_node
220     end
221
222     render :text => results.to_s, :content_type => "text/xml"
223   end
224
225   ##
226   # updates a changeset's tags. none of the changeset's attributes are
227   # user-modifiable, so they will be ignored.
228   #
229   # changesets are not (yet?) versioned, so we don't have to deal with
230   # history tables here. changesets are locked to a single user, however.
231   #
232   # after succesful update, returns the XML of the changeset.
233   def update
234     # request *must* be a PUT.
235     assert_method :put
236
237     changeset = Changeset.find(params[:id])
238     new_changeset = Changeset.from_xml(request.raw_post)
239
240     unless new_changeset.nil?
241       check_changeset_consistency(changeset, @user)
242       changeset.update_from(new_changeset, @user)
243       render :text => changeset.to_xml, :mime_type => "text/xml"
244     else
245
246       render :nothing => true, :status => :bad_request
247     end
248   end
249
250   ##
251   # list edits (open changesets) in reverse chronological order
252   def list
253     if request.format == :atom and params[:page]
254       redirect_to params.merge({ :page => nil }), :status => :moved_permanently
255     else
256       changesets = conditions_nonempty(Changeset.scoped)
257
258       if params[:display_name]
259         user = User.find_by_display_name(params[:display_name])
260
261         if user and user.active?
262           if user.data_public? or user == @user
263             changesets = changesets.where(:user_id => user.id)
264           else
265             changesets = changesets.where("false")
266           end
267         else
268           render_unknown_user params[:display_name]
269           return
270         end
271       end
272
273       if params[:friends]
274         if @user
275           changesets = changesets.where(:user_id => @user.friend_users.public)
276         elsif request.format == :html
277           require_user
278           return
279         end
280       end
281
282       if params[:nearby]
283         if @user
284           changesets = changesets.where(:user_id => @user.nearby)
285         elsif request.format == :html
286           require_user
287           return
288         end
289       end
290
291       if params[:bbox]
292         bbox = BoundingBox.from_bbox_params(params)
293       elsif params[:minlon] and params[:minlat] and params[:maxlon] and params[:maxlat]
294         bbox = BoundingBox.from_lon_lat_params(params)
295       end
296
297       if bbox
298         changesets = conditions_bbox(changesets, bbox)
299         bbox_link = render_to_string :partial => "bbox", :object => bbox
300       end
301
302       if user
303         user_link = render_to_string :partial => "user", :object => user
304       end
305
306       if params[:friends] and @user
307         @title =  t 'changeset.list.title_friend'
308         @heading =  t 'changeset.list.heading_friend'
309         @description = t 'changeset.list.description_friend'
310       elsif params[:nearby] and @user
311         @title = t 'changeset.list.title_nearby'
312         @heading = t 'changeset.list.heading_nearby'
313         @description = t 'changeset.list.description_nearby'
314       elsif user and bbox
315         @title =  t 'changeset.list.title_user_bbox', :user => user.display_name, :bbox => bbox.to_s
316         @heading =  t 'changeset.list.heading_user_bbox', :user => user.display_name, :bbox => bbox.to_s
317         @description = t 'changeset.list.description_user_bbox', :user => user_link, :bbox => bbox_link
318       elsif user
319         @title =  t 'changeset.list.title_user', :user => user.display_name
320         @heading =  t 'changeset.list.heading_user', :user => user.display_name
321         @description = t 'changeset.list.description_user', :user => user_link
322       elsif bbox
323         @title =  t 'changeset.list.title_bbox', :bbox => bbox.to_s
324         @heading =  t 'changeset.list.heading_bbox', :bbox => bbox.to_s
325         @description = t 'changeset.list.description_bbox', :bbox => bbox_link
326       else
327         @title =  t 'changeset.list.title'
328         @heading =  t 'changeset.list.heading'
329         @description = t 'changeset.list.description'
330       end
331
332       @page = (params[:page] || 1).to_i
333       @page_size = 20
334
335       @edits = changesets.order("changesets.created_at DESC").offset((@page - 1) * @page_size).limit(@page_size).preload(:user, :changeset_tags)
336
337       render :action => :list
338     end
339   end
340
341   ##
342   # list edits as an atom feed
343   def feed
344     list
345   end
346
347 private
348   #------------------------------------------------------------
349   # utility functions below.
350   #------------------------------------------------------------
351
352   ##
353   # if a bounding box was specified do some sanity checks.
354   # restrict changesets to those enclosed by a bounding box
355   # we need to return both the changesets and the bounding box
356   def conditions_bbox(changesets, bbox)
357     if  bbox
358       bbox.check_boundaries
359       bbox = bbox.to_scaled
360       return changesets.where("min_lon < ? and max_lon > ? and min_lat < ? and max_lat > ?",
361                               bbox.max_lon.to_i, bbox.min_lon.to_i,
362                               bbox.max_lat.to_i, bbox.min_lat.to_i)
363     else
364       return changesets
365     end
366   end
367
368   ##
369   # restrict changesets to those by a particular user
370   def conditions_user(changesets, user, name)
371     unless user.nil? and name.nil?
372       # shouldn't provide both name and UID
373       raise OSM::APIBadUserInput.new("provide either the user ID or display name, but not both") if user and name
374
375       # use either the name or the UID to find the user which we're selecting on.
376       u = if name.nil?
377             # user input checking, we don't have any UIDs < 1
378             raise OSM::APIBadUserInput.new("invalid user ID") if user.to_i < 1
379             u = User.find(user.to_i)
380           else
381             u = User.find_by_display_name(name)
382           end
383
384       # make sure we found a user
385       raise OSM::APINotFoundError.new if u.nil?
386
387       # should be able to get changesets of public users only, or
388       # our own changesets regardless of public-ness.
389       unless u.data_public?
390         # get optional user auth stuff so that users can see their own
391         # changesets if they're non-public
392         setup_user_auth
393
394         raise OSM::APINotFoundError if @user.nil? or @user.id != u.id
395       end
396       return changesets.where(:user_id => u.id)
397     else
398       return changesets
399     end
400   end
401
402   ##
403   # restrict changes to those closed during a particular time period
404   def conditions_time(changesets, time)
405     unless time.nil?
406       # if there is a range, i.e: comma separated, then the first is
407       # low, second is high - same as with bounding boxes.
408       if time.count(',') == 1
409         # check that we actually have 2 elements in the array
410         times = time.split(/,/)
411         raise OSM::APIBadUserInput.new("bad time range") if times.size != 2
412
413         from, to = times.collect { |t| DateTime.parse(t) }
414         return changesets.where("closed_at >= ? and created_at <= ?", from, to)
415       else
416         # if there is no comma, assume its a lower limit on time
417         return changesets.where("closed_at >= ?", DateTime.parse(time))
418       end
419     else
420       return changesets
421     end
422     # stupid DateTime seems to throw both of these for bad parsing, so
423     # we have to catch both and ensure the correct code path is taken.
424   rescue ArgumentError => ex
425     raise OSM::APIBadUserInput.new(ex.message.to_s)
426   rescue RuntimeError => ex
427     raise OSM::APIBadUserInput.new(ex.message.to_s)
428   end
429
430   ##
431   # return changesets which are open (haven't been closed yet)
432   # we do this by seeing if the 'closed at' time is in the future. Also if we've
433   # hit the maximum number of changes then it counts as no longer open.
434   # if parameter 'open' is nill then open and closed changesets are returned
435   def conditions_open(changesets, open)
436     if open.nil?
437       return changesets
438     else
439       return changesets.where("closed_at >= ? and num_changes <= ?",
440                               Time.now.getutc, Changeset::MAX_ELEMENTS)
441     end
442   end
443
444   ##
445   # query changesets which are closed
446   # ('closed at' time has passed or changes limit is hit)
447   def conditions_closed(changesets, closed)
448     if closed.nil?
449       return changesets
450     else
451       return changesets.where("closed_at < ? or num_changes > ?",
452                               Time.now.getutc, Changeset::MAX_ELEMENTS)
453     end
454   end
455
456   ##
457   # eliminate empty changesets (where the bbox has not been set)
458   # this should be applied to all changeset list displays
459   def conditions_nonempty(changesets)
460     return changesets.where("num_changes > 0")
461   end
462
463 end