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