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