Use CanCanCan for search controller
[rails.git] / app / controllers / changesets_controller.rb
1 # The ChangesetController is the RESTful interface to Changeset objects
2
3 class ChangesetsController < ApplicationController
4   layout "site"
5   require "xml/libxml"
6
7   skip_before_action :verify_authenticity_token, :except => [:index]
8   before_action :authorize_web, :only => [:index, :feed]
9   before_action :set_locale, :only => [:index, :feed]
10   before_action :authorize, :only => [:create, :update, :upload, :close, :subscribe, :unsubscribe]
11   before_action :require_allow_write_api, :only => [:create, :update, :upload, :close, :subscribe, :unsubscribe]
12   before_action :require_public_data, :only => [:create, :update, :upload, :close, :subscribe, :unsubscribe]
13   before_action :check_api_writable, :only => [:create, :update, :upload, :subscribe, :unsubscribe]
14   before_action :check_api_readable, :except => [:create, :update, :upload, :download, :query, :index, :feed, :subscribe, :unsubscribe]
15   before_action(:only => [:index, :feed]) { |c| c.check_database_readable(true) }
16   around_action :api_call_handle_error, :except => [:index, :feed]
17   around_action :api_call_timeout, :except => [:index, :feed, :upload]
18   around_action :web_timeout, :only => [:index, :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 = current_user
31     cs.save_with_tags!
32
33     # Subscribe user to changeset comments
34     cs.subscribers << current_user
35
36     render :plain => cs.id.to_s
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 :xml => changeset.to_xml(params[:include_discussion].presence).to_s
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, current_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     head :ok
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, current_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, :options => XML::Parser::Options::NOERROR).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 = lon.min
99     cs.min_lat = lat.min
100     cs.max_lon = lon.max
101     cs.max_lat = lat.max
102
103     # save the larger bounding box and return the changeset, which
104     # will include the bigger bounding box.
105     cs.save!
106     render :xml => cs.to_xml.to_s
107   end
108
109   ##
110   # Upload a diff in a single transaction.
111   #
112   # This means that each change within the diff must succeed, i.e: that
113   # each version number mentioned is still current. Otherwise the entire
114   # transaction *must* be rolled back.
115   #
116   # Furthermore, each element in the diff can only reference the current
117   # changeset.
118   #
119   # Returns: a diffResult document, as described in
120   # http://wiki.openstreetmap.org/wiki/OSM_Protocol_Version_0.6
121   def upload
122     # only allow POST requests, as the upload method is most definitely
123     # not idempotent, as several uploads with placeholder IDs will have
124     # different side-effects.
125     # see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.1.2
126     assert_method :post
127
128     changeset = Changeset.find(params[:id])
129     check_changeset_consistency(changeset, current_user)
130
131     diff_reader = DiffReader.new(request.raw_post, changeset)
132     Changeset.transaction do
133       result = diff_reader.commit
134       render :xml => result.to_s
135     end
136   end
137
138   ##
139   # download the changeset as an osmChange document.
140   #
141   # to make it easier to revert diffs it would be better if the osmChange
142   # format were reversible, i.e: contained both old and new versions of
143   # modified elements. but it doesn't at the moment...
144   #
145   # this method cannot order the database changes fully (i.e: timestamp and
146   # version number may be too coarse) so the resulting diff may not apply
147   # to a different database. however since changesets are not atomic this
148   # behaviour cannot be guaranteed anyway and is the result of a design
149   # choice.
150   def download
151     changeset = Changeset.find(params[:id])
152
153     # get all the elements in the changeset which haven't been redacted
154     # and stick them in a big array.
155     elements = [changeset.old_nodes.unredacted,
156                 changeset.old_ways.unredacted,
157                 changeset.old_relations.unredacted].flatten
158
159     # sort the elements by timestamp and version number, as this is the
160     # almost sensible ordering available. this would be much nicer if
161     # global (SVN-style) versioning were used - then that would be
162     # unambiguous.
163     elements.sort! do |a, b|
164       if a.timestamp == b.timestamp
165         a.version <=> b.version
166       else
167         a.timestamp <=> b.timestamp
168       end
169     end
170
171     # create changeset and user caches
172     changeset_cache = {}
173     user_display_name_cache = {}
174
175     # create an osmChange document for the output
176     result = OSM::API.new.get_xml_doc
177     result.root.name = "osmChange"
178
179     # generate an output element for each operation. note: we avoid looking
180     # at the history because it is simpler - but it would be more correct to
181     # check these assertions.
182     elements.each do |elt|
183       result.root <<
184         if elt.version == 1
185           # first version, so it must be newly-created.
186           created = XML::Node.new "create"
187           created << elt.to_xml_node(changeset_cache, user_display_name_cache)
188         elsif 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
199     render :xml => result.to_s
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     # sort and limit the changesets
219     changesets = changesets.order("created_at DESC").limit(100)
220
221     # preload users, tags and comments
222     changesets = changesets.preload(:user, :changeset_tags, :comments)
223
224     # create the results document
225     results = OSM::API.new.get_xml_doc
226
227     # add all matching changesets to the XML results document
228     changesets.order("created_at DESC").limit(100).each do |cs|
229       results.root << cs.to_xml_node
230     end
231
232     render :xml => results.to_s
233   end
234
235   ##
236   # updates a changeset's tags. none of the changeset's attributes are
237   # user-modifiable, so they will be ignored.
238   #
239   # changesets are not (yet?) versioned, so we don't have to deal with
240   # history tables here. changesets are locked to a single user, however.
241   #
242   # after succesful update, returns the XML of the changeset.
243   def update
244     # request *must* be a PUT.
245     assert_method :put
246
247     changeset = Changeset.find(params[:id])
248     new_changeset = Changeset.from_xml(request.raw_post)
249
250     check_changeset_consistency(changeset, current_user)
251     changeset.update_from(new_changeset, current_user)
252     render :xml => changeset.to_xml.to_s
253   end
254
255   ##
256   # list non-empty changesets in reverse chronological order
257   def index
258     @params = params.permit(:display_name, :bbox, :friends, :nearby, :max_id, :list)
259
260     if request.format == :atom && @params[:max_id]
261       redirect_to url_for(@params.merge(:max_id => nil)), :status => :moved_permanently
262       return
263     end
264
265     if @params[:display_name]
266       user = User.find_by(:display_name => @params[:display_name])
267       if !user || !user.active?
268         render_unknown_user @params[:display_name]
269         return
270       end
271     end
272
273     if (@params[:friends] || @params[:nearby]) && !current_user
274       require_user
275       return
276     end
277
278     if request.format == :html && !@params[:list]
279       require_oauth
280       render :action => :history, :layout => map_layout
281     else
282       changesets = conditions_nonempty(Changeset.all)
283
284       if @params[:display_name]
285         changesets = if user.data_public? || user == current_user
286                        changesets.where(:user_id => user.id)
287                      else
288                        changesets.where("false")
289                      end
290       elsif @params[:bbox]
291         changesets = conditions_bbox(changesets, BoundingBox.from_bbox_params(params))
292       elsif @params[:friends] && current_user
293         changesets = changesets.where(:user_id => current_user.friend_users.identifiable)
294       elsif @params[:nearby] && current_user
295         changesets = changesets.where(:user_id => current_user.nearby)
296       end
297
298       changesets = changesets.where("changesets.id <= ?", @params[:max_id]) if @params[:max_id]
299
300       @edits = changesets.order("changesets.id DESC").limit(20).preload(:user, :changeset_tags, :comments)
301
302       render :action => :index, :layout => false
303     end
304   end
305
306   ##
307   # list edits as an atom feed
308   def feed
309     index
310   end
311
312   ##
313   # Adds a subscriber to the changeset
314   def subscribe
315     # Check the arguments are sane
316     raise OSM::APIBadUserInput, "No id was given" unless params[:id]
317
318     # Extract the arguments
319     id = params[:id].to_i
320
321     # Find the changeset and check it is valid
322     changeset = Changeset.find(id)
323     raise OSM::APIChangesetAlreadySubscribedError, changeset if changeset.subscribers.exists?(current_user.id)
324
325     # Add the subscriber
326     changeset.subscribers << current_user
327
328     # Return a copy of the updated changeset
329     render :xml => changeset.to_xml.to_s
330   end
331
332   ##
333   # Removes a subscriber from the changeset
334   def unsubscribe
335     # Check the arguments are sane
336     raise OSM::APIBadUserInput, "No id was given" unless params[:id]
337
338     # Extract the arguments
339     id = params[:id].to_i
340
341     # Find the changeset and check it is valid
342     changeset = Changeset.find(id)
343     raise OSM::APIChangesetNotSubscribedError, changeset unless changeset.subscribers.exists?(current_user.id)
344
345     # Remove the subscriber
346     changeset.subscribers.delete(current_user)
347
348     # Return a copy of the updated changeset
349     render :xml => changeset.to_xml.to_s
350   end
351
352   private
353
354   #------------------------------------------------------------
355   # utility functions below.
356   #------------------------------------------------------------
357
358   ##
359   # if a bounding box was specified do some sanity checks.
360   # restrict changesets to those enclosed by a bounding box
361   # we need to return both the changesets and the bounding box
362   def conditions_bbox(changesets, bbox)
363     if bbox
364       bbox.check_boundaries
365       bbox = bbox.to_scaled
366
367       changesets.where("min_lon < ? and max_lon > ? and min_lat < ? and max_lat > ?",
368                        bbox.max_lon.to_i, bbox.min_lon.to_i,
369                        bbox.max_lat.to_i, bbox.min_lat.to_i)
370     else
371       changesets
372     end
373   end
374
375   ##
376   # restrict changesets to those by a particular user
377   def conditions_user(changesets, user, name)
378     if user.nil? && name.nil?
379       changesets
380     else
381       # shouldn't provide both name and UID
382       raise OSM::APIBadUserInput, "provide either the user ID or display name, but not both" if user && name
383
384       # use either the name or the UID to find the user which we're selecting on.
385       u = if name.nil?
386             # user input checking, we don't have any UIDs < 1
387             raise OSM::APIBadUserInput, "invalid user ID" if user.to_i < 1
388
389             u = User.find(user.to_i)
390           else
391             u = User.find_by(:display_name => name)
392           end
393
394       # make sure we found a user
395       raise OSM::APINotFoundError if u.nil?
396
397       # should be able to get changesets of public users only, or
398       # our own changesets regardless of public-ness.
399       unless u.data_public?
400         # get optional user auth stuff so that users can see their own
401         # changesets if they're non-public
402         setup_user_auth
403
404         raise OSM::APINotFoundError if current_user.nil? || current_user != u
405       end
406
407       changesets.where(:user_id => u.id)
408     end
409   end
410
411   ##
412   # restrict changes to those closed during a particular time period
413   def conditions_time(changesets, time)
414     if time.nil?
415       changesets
416     elsif time.count(",") == 1
417       # if there is a range, i.e: comma separated, then the first is
418       # low, second is high - same as with bounding boxes.
419
420       # check that we actually have 2 elements in the array
421       times = time.split(/,/)
422       raise OSM::APIBadUserInput, "bad time range" if times.size != 2
423
424       from, to = times.collect { |t| Time.parse(t) }
425       changesets.where("closed_at >= ? and created_at <= ?", from, to)
426     else
427       # if there is no comma, assume its a lower limit on time
428       changesets.where("closed_at >= ?", Time.parse(time))
429     end
430     # stupid Time seems to throw both of these for bad parsing, so
431     # we have to catch both and ensure the correct code path is taken.
432   rescue ArgumentError => ex
433     raise OSM::APIBadUserInput, ex.message.to_s
434   rescue RuntimeError => ex
435     raise OSM::APIBadUserInput, ex.message.to_s
436   end
437
438   ##
439   # return changesets which are open (haven't been closed yet)
440   # we do this by seeing if the 'closed at' time is in the future. Also if we've
441   # hit the maximum number of changes then it counts as no longer open.
442   # if parameter 'open' is nill then open and closed changesets are returned
443   def conditions_open(changesets, open)
444     if open.nil?
445       changesets
446     else
447       changesets.where("closed_at >= ? and num_changes <= ?",
448                        Time.now.getutc, Changeset::MAX_ELEMENTS)
449     end
450   end
451
452   ##
453   # query changesets which are closed
454   # ('closed at' time has passed or changes limit is hit)
455   def conditions_closed(changesets, closed)
456     if closed.nil?
457       changesets
458     else
459       changesets.where("closed_at < ? or num_changes > ?",
460                        Time.now.getutc, Changeset::MAX_ELEMENTS)
461     end
462   end
463
464   ##
465   # query changesets by a list of ids
466   # (either specified as array or comma-separated string)
467   def conditions_ids(changesets, ids)
468     if ids.nil?
469       changesets
470     elsif ids.empty?
471       raise OSM::APIBadUserInput, "No changesets were given to search for"
472     else
473       ids = ids.split(",").collect(&:to_i)
474       changesets.where(:id => ids)
475     end
476   end
477
478   ##
479   # eliminate empty changesets (where the bbox has not been set)
480   # this should be applied to all changeset list displays
481   def conditions_nonempty(changesets)
482     changesets.where("num_changes > 0")
483   end
484 end