turning the session off for the changeset controller, to come in line with the other...
[rails.git] / app / controllers / changeset_controller.rb
1 # The ChangesetController is the RESTful interface to Changeset objects
2
3 class ChangesetController < ApplicationController
4   require 'xml/libxml'
5
6   session :off
7   before_filter :authorize, :only => [:create, :update, :delete, :upload, :include, :close]
8   before_filter :check_write_availability, :only => [:create, :update, :delete, :upload, :include]
9   before_filter :check_read_availability, :except => [:create, :update, :delete, :upload, :download, :query]
10   after_filter :compress_output
11
12   # Help methods for checking boundary sanity and area size
13   include MapBoundary
14
15   # Helper methods for checking consistency
16   include ConsistencyValidations
17
18   # Create a changeset from XML.
19   def create
20     if request.put?
21       cs = Changeset.from_xml(request.raw_post, true)
22
23       if cs
24         cs.user_id = @user.id
25         cs.save_with_tags!
26         render :text => cs.id.to_s, :content_type => "text/plain"
27       else
28         render :nothing => true, :status => :bad_request
29       end
30     else
31       render :nothing => true, :status => :method_not_allowed
32     end
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     begin
40       changeset = Changeset.find(params[:id])
41       render :text => changeset.to_xml.to_s, :content_type => "text/xml"
42     rescue ActiveRecord::RecordNotFound
43       render :nothing => true, :status => :not_found
44     end
45   end
46   
47   ##
48   # marks a changeset as closed. this may be called multiple times
49   # on the same changeset, so is idempotent.
50   def close 
51     unless request.put?
52       render :nothing => true, :status => :method_not_allowed
53       return
54     end
55     
56     changeset = Changeset.find(params[:id])    
57     check_changeset_consistency(changeset, @user)
58
59     # to close the changeset, we'll just set its closed_at time to
60     # now. this might not be enough if there are concurrency issues, 
61     # but we'll have to wait and see.
62     changeset.set_closed_time_now
63
64     changeset.save!
65     render :nothing => true
66   rescue ActiveRecord::RecordNotFound
67     render :nothing => true, :status => :not_found
68   rescue OSM::APIError => ex
69     render ex.render_opts
70   end
71
72   ##
73   # insert a (set of) points into a changeset bounding box. this can only
74   # increase the size of the bounding box. this is a hint that clients can
75   # set either before uploading a large number of changes, or changes that
76   # the client (but not the server) knows will affect areas further away.
77   def expand_bbox
78     # only allow POST requests, because although this method is
79     # idempotent, there is no "document" to PUT really...
80     if request.post?
81       cs = Changeset.find(params[:id])
82       check_changeset_consistency(cs, @user)
83
84       # keep an array of lons and lats
85       lon = Array.new
86       lat = Array.new
87
88       # the request is in pseudo-osm format... this is kind-of an
89       # abuse, maybe should change to some other format?
90       doc = XML::Parser.string(request.raw_post).parse
91       doc.find("//osm/node").each do |n|
92         lon << n['lon'].to_f * GeoRecord::SCALE
93         lat << n['lat'].to_f * GeoRecord::SCALE
94       end
95
96       # add the existing bounding box to the lon-lat array
97       lon << cs.min_lon unless cs.min_lon.nil?
98       lat << cs.min_lat unless cs.min_lat.nil?
99       lon << cs.max_lon unless cs.max_lon.nil?
100       lat << cs.max_lat unless cs.max_lat.nil?
101
102       # collapse the arrays to minimum and maximum
103       cs.min_lon, cs.min_lat, cs.max_lon, cs.max_lat = 
104         lon.min, lat.min, lon.max, lat.max
105
106       # save the larger bounding box and return the changeset, which
107       # will include the bigger bounding box.
108       cs.save!
109       render :text => cs.to_xml.to_s, :content_type => "text/xml"
110
111     else
112       render :nothing => true, :status => :method_not_allowed
113     end
114
115   rescue ActiveRecord::RecordNotFound
116     render :nothing => true, :status => :not_found
117   rescue OSM::APIError => ex
118     render ex.render_opts
119   end
120
121   ##
122   # Upload a diff in a single transaction.
123   #
124   # This means that each change within the diff must succeed, i.e: that
125   # each version number mentioned is still current. Otherwise the entire
126   # transaction *must* be rolled back.
127   #
128   # Furthermore, each element in the diff can only reference the current
129   # changeset.
130   #
131   # Returns: a diffResult document, as described in 
132   # http://wiki.openstreetmap.org/index.php/OSM_Protocol_Version_0.6
133   def upload
134     # only allow POST requests, as the upload method is most definitely
135     # not idempotent, as several uploads with placeholder IDs will have
136     # different side-effects.
137     # see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.1.2
138     unless request.post?
139       render :nothing => true, :status => :method_not_allowed
140       return
141     end
142
143     changeset = Changeset.find(params[:id])
144     check_changeset_consistency(changeset, @user)
145     
146     diff_reader = DiffReader.new(request.raw_post, changeset)
147     Changeset.transaction do
148       result = diff_reader.commit
149       render :text => result.to_s, :content_type => "text/xml"
150     end
151     
152   rescue ActiveRecord::RecordNotFound
153     render :nothing => true, :status => :not_found
154   rescue OSM::APIError => ex
155     render ex.render_opts
156   end
157
158   ##
159   # download the changeset as an osmChange document.
160   #
161   # to make it easier to revert diffs it would be better if the osmChange
162   # format were reversible, i.e: contained both old and new versions of 
163   # modified elements. but it doesn't at the moment...
164   #
165   # this method cannot order the database changes fully (i.e: timestamp and
166   # version number may be too coarse) so the resulting diff may not apply
167   # to a different database. however since changesets are not atomic this 
168   # behaviour cannot be guaranteed anyway and is the result of a design
169   # choice.
170   def download
171     changeset = Changeset.find(params[:id])
172     
173     # get all the elements in the changeset and stick them in a big array.
174     elements = [changeset.old_nodes, 
175                 changeset.old_ways, 
176                 changeset.old_relations].flatten
177     
178     # sort the elements by timestamp and version number, as this is the 
179     # almost sensible ordering available. this would be much nicer if 
180     # global (SVN-style) versioning were used - then that would be 
181     # unambiguous.
182     elements.sort! do |a, b| 
183       if (a.timestamp == b.timestamp)
184         a.version <=> b.version
185       else
186         a.timestamp <=> b.timestamp 
187       end
188     end
189     
190     # create an osmChange document for the output
191     result = OSM::API.new.get_xml_doc
192     result.root.name = "osmChange"
193
194     # generate an output element for each operation. note: we avoid looking
195     # at the history because it is simpler - but it would be more correct to 
196     # check these assertions.
197     elements.each do |elt|
198       result.root <<
199         if (elt.version == 1) 
200           # first version, so it must be newly-created.
201           created = XML::Node.new "create"
202           created << elt.to_xml_node
203         else
204           # get the previous version from the element history
205           prev_elt = elt.class.find(:first, :conditions => 
206                                     ['id = ? and version = ?',
207                                      elt.id, elt.version])
208           unless elt.visible
209             # if the element isn't visible then it must have been deleted, so
210             # output the *previous* XML
211             deleted = XML::Node.new "delete"
212             deleted << prev_elt.to_xml_node
213           else
214             # must be a modify, for which we don't need the previous version
215             # yet...
216             modified = XML::Node.new "modify"
217             modified << elt.to_xml_node
218           end
219         end
220     end
221
222     render :text => result.to_s, :content_type => "text/xml"
223             
224   rescue ActiveRecord::RecordNotFound
225     render :nothing => true, :status => :not_found
226   rescue OSM::APIError => ex
227     render ex.render_opts
228   end
229
230   ##
231   # query changesets by bounding box, time, user or open/closed status.
232   def query
233     # create the conditions that the user asked for. some or all of
234     # these may be nil.
235     conditions = conditions_bbox(params['bbox'])
236     conditions = cond_merge conditions, conditions_user(params['user'])
237     conditions = cond_merge conditions, conditions_time(params['time'])
238     conditions = cond_merge conditions, conditions_open(params['open'])
239
240     # create the results document
241     results = OSM::API.new.get_xml_doc
242
243     # add all matching changesets to the XML results document
244     Changeset.find(:all, 
245                    :conditions => conditions, 
246                    :limit => 100,
247                    :order => 'created_at desc').each do |cs|
248       results.root << cs.to_xml_node
249     end
250
251     render :text => results.to_s, :content_type => "text/xml"
252
253   rescue ActiveRecord::RecordNotFound
254     render :nothing => true, :status => :not_found
255   rescue OSM::APIError => ex
256     render ex.render_opts
257   end
258   
259   ##
260   # updates a changeset's tags. none of the changeset's attributes are
261   # user-modifiable, so they will be ignored.
262   #
263   # changesets are not (yet?) versioned, so we don't have to deal with
264   # history tables here. changesets are locked to a single user, however.
265   #
266   # after succesful update, returns the XML of the changeset.
267   def update
268     # request *must* be a PUT.
269     unless request.put?
270       render :nothing => true, :status => :method_not_allowed
271       return
272     end
273     
274     changeset = Changeset.find(params[:id])
275     new_changeset = Changeset.from_xml(request.raw_post)
276
277     unless new_changeset.nil?
278       check_changeset_consistency(changeset, @user)
279       changeset.update_from(new_changeset, @user)
280       render :text => changeset.to_xml, :mime_type => "text/xml"
281     else
282       
283       render :nothing => true, :status => :bad_request
284     end
285       
286   rescue ActiveRecord::RecordNotFound
287     render :nothing => true, :status => :not_found
288   rescue OSM::APIError => ex
289     render ex.render_opts
290   end
291
292 private
293   #------------------------------------------------------------
294   # utility functions below.
295   #------------------------------------------------------------  
296
297   ##
298   # merge two conditions
299   def cond_merge(a, b)
300     if a and b
301       a_str = a.shift
302       b_str = b.shift
303       return [ a_str + " and " + b_str ] + a + b
304     elsif a 
305       return a
306     else b
307       return b
308     end
309   end
310
311   ##
312   # if a bounding box was specified then parse it and do some sanity 
313   # checks. this is mostly the same as the map call, but without the 
314   # area restriction.
315   def conditions_bbox(bbox)
316     unless bbox.nil?
317       raise OSM::APIBadUserInput.new("Bounding box should be min_lon,min_lat,max_lon,max_lat") unless bbox.count(',') == 3
318       bbox = sanitise_boundaries(bbox.split(/,/))
319       raise OSM::APIBadUserInput.new("Minimum longitude should be less than maximum.") unless bbox[0] <= bbox[2]
320       raise OSM::APIBadUserInput.new("Minimum latitude should be less than maximum.") unless bbox[1] <= bbox[3]
321       return ['min_lon < ? and max_lon > ? and min_lat < ? and max_lat > ?',
322               bbox[2] * GeoRecord::SCALE, bbox[0] * GeoRecord::SCALE, bbox[3]* GeoRecord::SCALE, bbox[1] * GeoRecord::SCALE]
323     else
324       return nil
325     end
326   end
327
328   ##
329   # restrict changesets to those by a particular user
330   def conditions_user(user)
331     unless user.nil?
332       # user input checking, we don't have any UIDs < 1
333       raise OSM::APIBadUserInput.new("invalid user ID") if user.to_i < 1
334
335       u = User.find(user.to_i)
336       # should be able to get changesets of public users only, or 
337       # our own changesets regardless of public-ness.
338       unless u.data_public?
339         # get optional user auth stuff so that users can see their own
340         # changesets if they're non-public
341         setup_user_auth
342         
343         raise OSM::APINotFoundError if @user.nil? or @user.id != u.id
344       end
345       return ['user_id = ?', u.id]
346     else
347       return nil
348     end
349   end
350
351   ##
352   # restrict changes to those during a particular time period
353   def conditions_time(time) 
354     unless time.nil?
355       # if there is a range, i.e: comma separated, then the first is 
356       # low, second is high - same as with bounding boxes.
357       if time.count(',') == 1
358         # check that we actually have 2 elements in the array
359         times = time.split(/,/)
360         raise OSM::APIBadUserInput.new("bad time range") if times.size != 2 
361
362         from, to = times.collect { |t| DateTime.parse(t) }
363         return ['closed_at >= ? and created_at <= ?', from, to]
364       else
365         # if there is no comma, assume its a lower limit on time
366         return ['closed_at >= ?', DateTime.parse(time)]
367       end
368     else
369       return nil
370     end
371     # stupid DateTime seems to throw both of these for bad parsing, so
372     # we have to catch both and ensure the correct code path is taken.
373   rescue ArgumentError => ex
374     raise OSM::APIBadUserInput.new(ex.message.to_s)
375   rescue RuntimeError => ex
376     raise OSM::APIBadUserInput.new(ex.message.to_s)
377   end
378
379   ##
380   # restrict changes to those which are open
381   def conditions_open(open)
382     return open.nil? ? nil : ['closed_at >= ?', DateTime.now]
383   end
384
385 end