Merge branch 'master' into openstreetbugs
[rails.git] / app / controllers / trace_controller.rb
1 class TraceController < ApplicationController
2   layout 'site'
3
4   skip_before_filter :verify_authenticity_token, :only => [:api_create, :api_read, :api_update, :api_delete, :api_data]
5   before_filter :authorize_web
6   before_filter :set_locale
7   before_filter :require_user, :only => [:mine, :create, :edit, :delete]
8   before_filter :authorize, :only => [:api_create, :api_read, :api_update, :api_delete, :api_data]
9   before_filter :check_database_readable, :except => [:api_read, :api_data]
10   before_filter :check_database_writable, :only => [:create, :edit, :delete, :api_create, :api_update, :api_delete]
11   before_filter :check_api_readable, :only => [:api_read, :api_data]
12   before_filter :check_api_writable, :only => [:api_create, :api_update, :api_delete]
13   before_filter :require_allow_read_gpx, :only => [:api_read, :api_data]
14   before_filter :require_allow_write_gpx, :only => [:api_create, :api_update, :api_delete]
15   before_filter :offline_warning, :only => [:mine, :view]
16   before_filter :offline_redirect, :only => [:create, :edit, :delete, :data, :api_create, :api_delete, :api_data]
17   around_filter :api_call_handle_error, :only => [:api_create, :api_read, :api_update, :api_delete, :api_data]
18
19   caches_action :list, :unless => :logged_in?, :layout => false
20   caches_action :view, :layout => false
21   caches_action :georss, :layout => true
22   cache_sweeper :trace_sweeper, :only => [:create, :edit, :delete, :api_create, :api_update, :api_delete]
23   cache_sweeper :tracetag_sweeper, :only => [:create, :edit, :delete, :api_create, :api_update, :api_delete]
24
25   # Counts and selects pages of GPX traces for various criteria (by user, tags, public etc.).
26   #  target_user - if set, specifies the user to fetch traces for.  if not set will fetch all traces
27   def list
28     # from display name, pick up user id if one user's traces only
29     display_name = params[:display_name]
30     if !display_name.blank?
31       target_user = User.active.where(:display_name => display_name).first
32       if target_user.nil?
33         @title = t'trace.no_such_user.title'
34         @not_found_user = display_name
35         render :action => 'no_such_user', :status => :not_found
36         return
37       end
38     end
39
40     # set title
41     if target_user.nil?
42       @title = t 'trace.list.public_traces'
43     elsif @user and @user == target_user
44       @title = t 'trace.list.your_traces'
45     else
46       @title = t 'trace.list.public_traces_from', :user => target_user.display_name
47     end
48
49     @title += t 'trace.list.tagged_with', :tags => params[:tag] if params[:tag]
50
51     # four main cases:
52     # 1 - all traces, logged in = all public traces + all user's (i.e + all mine)
53     # 2 - all traces, not logged in = all public traces
54     # 3 - user's traces, logged in as same user = all user's traces
55     # 4 - user's traces, not logged in as that user = all user's public traces
56     if target_user.nil? # all traces
57       if @user
58         @traces = Trace.visible_to(@user) #1
59       else
60         @traces = Trace.public #2
61       end
62     else
63       if @user and @user == target_user
64         @traces = @user.traces #3 (check vs user id, so no join + can't pick up non-public traces by changing name)
65       else
66         @traces = target_user.traces.public #4
67       end
68     end
69
70     if params[:tag]
71       @tag = params[:tag]
72
73       files = Tracetag.where(:tag => params[:tag]).select(:gpx_id).all
74
75       if files.length > 0
76         @traces = @traces.where(:id => files.collect { |tt| tt.gpx_id })
77       end
78     end
79
80     @page = (params[:page] || 1).to_i
81     @page_size = 20
82
83     @traces = @traces.visible
84     @traces = @traces.order("timestamp DESC")
85     @traces = @traces.offset((@page - 1) * @page_size)
86     @traces = @traces.limit(@page_size)
87     @traces = @traces.includes(:user, :tags)
88
89     # put together SET of tags across traces, for related links
90     tagset = Hash.new
91     @traces.each do |trace|
92       trace.tags.reload if params[:tag] # if searched by tag, ActiveRecord won't bring back other tags, so do explicitly here
93       trace.tags.each do |tag|
94         tagset[tag.tag] = tag.tag
95       end
96     end
97
98     # final helper vars for view
99     @target_user = target_user
100     @display_name = target_user.display_name if target_user
101     @all_tags = tagset.values
102   end
103
104   def mine
105     redirect_to :action => :list, :display_name => @user.display_name
106   end
107
108   def view
109     @trace = Trace.find(params[:id])
110
111     if @trace and @trace.visible? and
112        (@trace.public? or @trace.user == @user)
113       @title = t 'trace.view.title', :name => @trace.name
114     else
115       flash[:error] = t 'trace.view.trace_not_found'
116       redirect_to :controller => 'trace', :action => 'list'
117     end
118   rescue ActiveRecord::RecordNotFound
119     flash[:error] = t 'trace.view.trace_not_found'
120     redirect_to :controller => 'trace', :action => 'list'
121   end
122
123   def create
124     if params[:trace]
125       logger.info(params[:trace][:gpx_file].class.name)
126
127       if params[:trace][:gpx_file].respond_to?(:read)
128         begin
129           do_create(params[:trace][:gpx_file], params[:trace][:tagstring],
130                     params[:trace][:description], params[:trace][:visibility])
131         rescue => ex
132           logger.debug ex
133         end
134
135         if @trace.id
136           logger.info("id is #{@trace.id}")
137           flash[:notice] = t 'trace.create.trace_uploaded'
138
139           if @user.traces.count(:conditions => { :inserted => false }) > 4
140             flash[:warning] = t 'trace.trace_header.traces_waiting', :count => @user.traces.count(:conditions => { :inserted => false })
141           end
142
143           redirect_to :action => :list, :display_name => @user.display_name
144         end
145       else
146         @trace = Trace.new({:name => "Dummy",
147                             :tagstring => params[:trace][:tagstring],
148                             :description => params[:trace][:description],
149                             :visibility => params[:trace][:visibility],
150                             :inserted => false, :user => @user,
151                             :timestamp => Time.now.getutc})
152         @trace.valid?
153         @trace.errors.add(:gpx_file, "can't be blank")
154       end
155     else
156       @trace = Trace.new(:visibility => default_visibility)
157     end
158
159     @title = t 'trace.create.upload_trace'
160   end
161
162   def data
163     trace = Trace.find(params[:id])
164
165     if trace.visible? and (trace.public? or (@user and @user == trace.user))
166       if request.format == Mime::XML
167         send_file(trace.xml_file, :filename => "#{trace.id}.xml", :type => Mime::XML.to_s, :disposition => 'attachment')
168       else
169         send_file(trace.trace_name, :filename => "#{trace.id}#{trace.extension_name}", :type => trace.mime_type, :disposition => 'attachment')
170       end
171     else
172       render :nothing => true, :status => :not_found
173     end
174   rescue ActiveRecord::RecordNotFound
175     render :nothing => true, :status => :not_found
176   end
177
178   def edit
179     @trace = Trace.find(params[:id])
180
181     if @user and @trace.user == @user
182       @title = t 'trace.edit.title', :name => @trace.name
183       if params[:trace]
184         @trace.description = params[:trace][:description]
185         @trace.tagstring = params[:trace][:tagstring]
186         @trace.visibility = params[:trace][:visibility]
187         if @trace.save
188           redirect_to :action => 'view'
189         end
190       end
191     else
192       render :nothing => true, :status => :forbidden
193     end
194   rescue ActiveRecord::RecordNotFound
195     render :nothing => true, :status => :not_found
196   end
197
198   def delete
199     trace = Trace.find(params[:id])
200
201     if @user and trace.user == @user
202       if request.post? and trace.visible?
203         trace.visible = false
204         trace.save
205         flash[:notice] = t 'trace.delete.scheduled_for_deletion'
206         redirect_to :action => :list, :display_name => @user.display_name
207       else
208         render :nothing => true, :status => :bad_request
209       end
210     else
211       render :nothing => true, :status => :forbidden
212     end
213   rescue ActiveRecord::RecordNotFound
214     render :nothing => true, :status => :not_found
215   end
216
217   def georss
218     traces = Trace.public
219
220     if params[:display_name]
221       traces = traces.joins(:user).where(:users => {:display_name => params[:display_name]})
222     end
223
224     if params[:tag]
225       traces = traces.where("EXISTS (SELECT * FROM gpx_file_tags AS gft WHERE gft.gpx_id = gpx_files.id AND gft.tag = ?)")
226     end
227
228     traces = traces.order("timestamp DESC")
229     traces = traces.limit(20)
230     traces = traces.includes(:user)
231
232     rss = OSM::GeoRSS.new
233
234     traces.each do |trace|
235       rss.add(trace.latitude, trace.longitude, trace.name, trace.user.display_name, url_for({:controller => 'trace', :action => 'view', :id => trace.id, :display_name => trace.user.display_name}), "<img src='#{url_for({:controller => 'trace', :action => 'icon', :id => trace.id, :display_name => trace.user.display_name})}'> GPX file with #{trace.size} points from #{trace.user.display_name}", trace.timestamp)
236     end
237
238     render :text => rss.to_s, :content_type => "application/rss+xml"
239   end
240
241   def picture
242     trace = Trace.find(params[:id])
243
244     if trace.inserted?
245       if trace.public? or (@user and @user == trace.user)
246         expires_in 7.days, :private => !trace.public?, :public => trace.public?
247         send_file(trace.large_picture_name, :filename => "#{trace.id}.gif", :type => 'image/gif', :disposition => 'inline')
248       else
249         render :nothing => true, :status => :forbidden
250       end
251     else
252       render :nothing => true, :status => :not_found
253     end
254   rescue ActiveRecord::RecordNotFound
255     render :nothing => true, :status => :not_found
256   end
257
258   def icon
259     trace = Trace.find(params[:id])
260
261     if trace.inserted?
262       if trace.public? or (@user and @user == trace.user)
263         expires_in 7.days, :private => !trace.public?, :public => trace.public?
264         send_file(trace.icon_picture_name, :filename => "#{trace.id}_icon.gif", :type => 'image/gif', :disposition => 'inline')
265       else
266         render :nothing => true, :status => :forbidden
267       end
268     else
269       render :nothing => true, :status => :not_found
270     end
271   rescue ActiveRecord::RecordNotFound
272     render :nothing => true, :status => :not_found
273   end
274
275   def api_read
276     trace = Trace.visible.find(params[:id])
277
278     if trace.public? or trace.user == @user
279       render :text => trace.to_xml.to_s, :content_type => "text/xml"
280     else
281       render :nothing => true, :status => :forbidden
282     end
283   end
284
285   def api_update
286     trace = Trace.visible.find(params[:id])
287
288     if trace.user == @user
289       new_trace = Trace.from_xml(request.raw_post)
290
291       unless new_trace and new_trace.id == trace.id
292         raise OSM::APIBadUserInput.new("The id in the url (#{trace.id}) is not the same as provided in the xml (#{new_trace.id})")
293       end
294
295       trace.description = new_trace.description
296       trace.tags = new_trace.tags
297       trace.visibility = new_trace.visibility
298       trace.save!
299
300       render :nothing => true, :status => :ok
301     else
302       render :nothing => true, :status => :forbidden
303     end
304   end
305
306   def api_delete
307     trace = Trace.visible.find(params[:id])
308
309     if trace.user == @user
310       trace.visible = false
311       trace.save!
312
313       render :nothing => true, :status => :ok
314     else
315       render :nothing => true, :status => :forbidden
316     end
317   end
318
319   def api_data
320     trace = Trace.find(params[:id])
321
322     if trace.public? or trace.user == @user
323       if request.format == Mime::XML
324         send_file(trace.xml_file, :filename => "#{trace.id}.xml", :type => Mime::XML.to_s, :disposition => 'attachment')
325       else
326         send_file(trace.trace_name, :filename => "#{trace.id}#{trace.extension_name}", :type => trace.mime_type, :disposition => 'attachment')
327       end
328     else
329       render :nothing => true, :status => :forbidden
330     end
331   end
332
333   def api_create
334     if request.post?
335       tags = params[:tags] || ""
336       description = params[:description] || ""
337       visibility = params[:visibility]
338
339       if visibility.nil?
340         if params[:public] && params[:public].to_i.nonzero?
341           visibility = "public"
342         else
343           visibility = "private"
344         end
345       end
346
347       if params[:file].respond_to?(:read)
348         do_create(params[:file], tags, description, visibility)
349
350         if @trace.id
351           render :text => @trace.id.to_s, :content_type => "text/plain"
352         elsif @trace.valid?
353           render :nothing => true, :status => :internal_server_error
354         else
355           render :nothing => true, :status => :bad_request
356         end
357       else
358         render :nothing => true, :status => :bad_request
359       end
360     else
361       render :nothing => true, :status => :method_not_allowed
362     end
363   end
364
365 private
366
367   def do_create(file, tags, description, visibility)
368     # Sanitise the user's filename
369     name = file.original_filename.gsub(/[^a-zA-Z0-9.]/, '_')
370
371     # Get a temporary filename...
372     filename = "/tmp/#{rand}"
373
374     # ...and save the uploaded file to that location
375     File.open(filename, "w") { |f| f.write(file.read) }
376
377     # Create the trace object, falsely marked as already
378     # inserted to stop the import daemon trying to load it
379     @trace = Trace.new({
380       :name => name,
381       :tagstring => tags,
382       :description => description,
383       :visibility => visibility,
384       :inserted => true,
385       :user => @user,
386       :timestamp => Time.now.getutc
387     })
388
389     Trace.transaction do
390       begin
391         # Save the trace object
392         @trace.save!
393
394         # Rename the temporary file to the final name
395         FileUtils.mv(filename, @trace.trace_name)
396       rescue Exception => ex
397         # Remove the file as we have failed to update the database
398         FileUtils.rm_f(filename)
399
400         # Pass the exception on
401         raise
402       end
403
404       begin
405         # Clear the inserted flag to make the import daemon load the trace
406         @trace.inserted = false
407         @trace.save!
408       rescue Exception => ex
409         # Remove the file as we have failed to update the database
410         FileUtils.rm_f(@trace.trace_name)
411
412         # Pass the exception on
413         raise
414       end
415     end
416
417     # Finally save the user's preferred privacy level
418     if pref = @user.preferences.where(:k => "gps.trace.visibility").first
419       pref.v = visibility
420       pref.save
421     else
422       @user.preferences.create(:k => "gps.trace.visibility", :v => visibility)
423     end
424
425   end
426
427   def offline_warning
428     flash.now[:warning] = t 'trace.offline_warning.message' if STATUS == :gpx_offline
429   end
430
431   def offline_redirect
432     redirect_to :action => :offline if STATUS == :gpx_offline
433   end
434
435   def default_visibility
436     visibility = @user.preferences.where(:k => "gps.trace.visibility").first
437
438     if visibility
439       visibility.v
440     elsif @user.preferences.where(:k => "gps.trace.public", :v => "default").first.nil?
441       "private"
442     else
443       "public"
444     end
445   end
446
447 end