app/controllers/traces_controller.rb

   1 class TracesController < 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 ".public_traces"
  35              elsif current_user && current_user == target_user
  36                t ".my_traces"
  37              else
  38                t ".public_traces_from", :user => target_user.display_name
  39              end
  40
  41     @title += t ".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 ".title", :name => @trace.name
  98     else
  99       flash[:error] = t ".trace_not_found"
 100       redirect_to :action => "list"
 101     end
 102   rescue ActiveRecord::RecordNotFound
 103     flash[:error] = t ".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 StandardError => ex
 116           logger.debug ex
 117         end
 118
 119         if @trace.id
 120           flash[:notice] = t ".trace_uploaded"
 121           flash[:warning] = t ".traces_waiting", :count => current_user.traces.where(:inserted => false).count if current_user.traces.where(:inserted => false).count > 4
 122
 123           redirect_to :action => :list, :display_name => current_user.display_name
 124         end
 125       else
 126         @trace = Trace.new(:name => "Dummy",
 127                            :tagstring => params[:trace][:tagstring],
 128                            :description => params[:trace][:description],
 129                            :visibility => params[:trace][:visibility],
 130                            :inserted => false, :user => current_user,
 131                            :timestamp => Time.now.getutc)
 132         @trace.valid?
 133         @trace.errors.add(:gpx_file, "can't be blank")
 134       end
 135     else
 136       @trace = Trace.new(:visibility => default_visibility)
 137     end
 138
 139     @title = t ".upload_trace"
 140   end
 141
 142   def data
 143     trace = Trace.find(params[:id])
 144
 145     if trace.visible? && (trace.public? || (current_user && current_user == trace.user))
 146       if Acl.no_trace_download(request.remote_ip)
 147         head :forbidden
 148       elsif request.format == Mime[:xml]
 149         send_data(trace.xml_file.read, :filename => "#{trace.id}.xml", :type => request.format.to_s, :disposition => "attachment")
 150       elsif request.format == Mime[:gpx]
 151         send_data(trace.xml_file.read, :filename => "#{trace.id}.gpx", :type => request.format.to_s, :disposition => "attachment")
 152       else
 153         send_file(trace.trace_name, :filename => "#{trace.id}#{trace.extension_name}", :type => trace.mime_type, :disposition => "attachment")
 154       end
 155     else
 156       head :not_found
 157     end
 158   rescue ActiveRecord::RecordNotFound
 159     head :not_found
 160   end
 161
 162   def edit
 163     @trace = Trace.find(params[:id])
 164
 165     if !@trace.visible?
 166       head :not_found
 167     elsif current_user.nil? || @trace.user != current_user
 168       head :forbidden
 169     else
 170       @title = t ".title", :name => @trace.name
 171
 172       if request.post? && params[:trace]
 173         @trace.description = params[:trace][:description]
 174         @trace.tagstring = params[:trace][:tagstring]
 175         @trace.visibility = params[:trace][:visibility]
 176         redirect_to :action => "view", :display_name => current_user.display_name if @trace.save
 177       end
 178     end
 179   rescue ActiveRecord::RecordNotFound
 180     head :not_found
 181   end
 182
 183   def delete
 184     trace = Trace.find(params[:id])
 185
 186     if !trace.visible?
 187       head :not_found
 188     elsif current_user.nil? || (trace.user != current_user && !current_user.administrator? && !current_user.moderator?)
 189       head :forbidden
 190     else
 191       trace.visible = false
 192       trace.save
 193       flash[:notice] = t ".scheduled_for_deletion"
 194       redirect_to :action => :list, :display_name => trace.user.display_name
 195     end
 196   rescue ActiveRecord::RecordNotFound
 197     head :not_found
 198   end
 199
 200   def georss
 201     @traces = Trace.visible_to_all.visible
 202
 203     @traces = @traces.joins(:user).where(:users => { :display_name => params[:display_name] }) if params[:display_name]
 204
 205     @traces = @traces.tagged(params[:tag]) if params[:tag]
 206     @traces = @traces.order("timestamp DESC")
 207     @traces = @traces.limit(20)
 208     @traces = @traces.includes(:user)
 209   end
 210
 211   def picture
 212     trace = Trace.find(params[:id])
 213
 214     if trace.visible? && trace.inserted?
 215       if trace.public? || (current_user && current_user == trace.user)
 216         expires_in 7.days, :private => !trace.public?, :public => trace.public?
 217         send_file(trace.large_picture_name, :filename => "#{trace.id}.gif", :type => "image/gif", :disposition => "inline")
 218       else
 219         head :forbidden
 220       end
 221     else
 222       head :not_found
 223     end
 224   rescue ActiveRecord::RecordNotFound
 225     head :not_found
 226   end
 227
 228   def icon
 229     trace = Trace.find(params[:id])
 230
 231     if trace.visible? && trace.inserted?
 232       if trace.public? || (current_user && current_user == trace.user)
 233         expires_in 7.days, :private => !trace.public?, :public => trace.public?
 234         send_file(trace.icon_picture_name, :filename => "#{trace.id}_icon.gif", :type => "image/gif", :disposition => "inline")
 235       else
 236         head :forbidden
 237       end
 238     else
 239       head :not_found
 240     end
 241   rescue ActiveRecord::RecordNotFound
 242     head :not_found
 243   end
 244
 245   def api_read
 246     trace = Trace.visible.find(params[:id])
 247
 248     if trace.public? || trace.user == current_user
 249       render :xml => trace.to_xml.to_s
 250     else
 251       head :forbidden
 252     end
 253   end
 254
 255   def api_update
 256     trace = Trace.visible.find(params[:id])
 257
 258     if trace.user == current_user
 259       trace.update_from_xml(request.raw_post)
 260       trace.save!
 261
 262       head :ok
 263     else
 264       head :forbidden
 265     end
 266   end
 267
 268   def api_delete
 269     trace = Trace.visible.find(params[:id])
 270
 271     if trace.user == current_user
 272       trace.visible = false
 273       trace.save!
 274
 275       head :ok
 276     else
 277       head :forbidden
 278     end
 279   end
 280
 281   def api_data
 282     trace = Trace.visible.find(params[:id])
 283
 284     if trace.public? || trace.user == current_user
 285       if request.format == Mime[:xml]
 286         send_data(trace.xml_file.read, :filename => "#{trace.id}.xml", :type => request.format.to_s, :disposition => "attachment")
 287       elsif request.format == Mime[:gpx]
 288         send_data(trace.xml_file.read, :filename => "#{trace.id}.gpx", :type => request.format.to_s, :disposition => "attachment")
 289       else
 290         send_file(trace.trace_name, :filename => "#{trace.id}#{trace.extension_name}", :type => trace.mime_type, :disposition => "attachment")
 291       end
 292     else
 293       head :forbidden
 294     end
 295   end
 296
 297   def api_create
 298     tags = params[:tags] || ""
 299     description = params[:description] || ""
 300     visibility = params[:visibility]
 301
 302     if visibility.nil?
 303       visibility = if params[:public] && params[:public].to_i.nonzero?
 304                      "public"
 305                    else
 306                      "private"
 307                    end
 308     end
 309
 310     if params[:file].respond_to?(:read)
 311       do_create(params[:file], tags, description, visibility)
 312
 313       if @trace.id
 314         render :plain => @trace.id.to_s
 315       elsif @trace.valid?
 316         head :internal_server_error
 317       else
 318         head :bad_request
 319       end
 320     else
 321       head :bad_request
 322     end
 323   end
 324
 325   private
 326
 327   def do_create(file, tags, description, visibility)
 328     # Sanitise the user's filename
 329     name = file.original_filename.gsub(/[^a-zA-Z0-9.]/, "_")
 330
 331     # Get a temporary filename...
 332     filename = "/tmp/#{rand}"
 333
 334     # ...and save the uploaded file to that location
 335     File.open(filename, "wb") { |f| f.write(file.read) }
 336
 337     # Create the trace object, falsely marked as already
 338     # inserted to stop the import daemon trying to load it
 339     @trace = Trace.new(
 340       :name => name,
 341       :tagstring => tags,
 342       :description => description,
 343       :visibility => visibility,
 344       :inserted => true,
 345       :user => current_user,
 346       :timestamp => Time.now.getutc
 347     )
 348
 349     Trace.transaction do
 350       begin
 351         # Save the trace object
 352         @trace.save!
 353
 354         # Rename the temporary file to the final name
 355         FileUtils.mv(filename, @trace.trace_name)
 356       rescue StandardError
 357         # Remove the file as we have failed to update the database
 358         FileUtils.rm_f(filename)
 359
 360         # Pass the exception on
 361         raise
 362       end
 363
 364       begin
 365         # Clear the inserted flag to make the import daemon load the trace
 366         @trace.inserted = false
 367         @trace.save!
 368       rescue StandardError
 369         # Remove the file as we have failed to update the database
 370         FileUtils.rm_f(@trace.trace_name)
 371
 372         # Pass the exception on
 373         raise
 374       end
 375     end
 376
 377     # Finally save the user's preferred privacy level
 378     if pref = current_user.preferences.where(:k => "gps.trace.visibility").first
 379       pref.v = visibility
 380       pref.save
 381     else
 382       current_user.preferences.create(:k => "gps.trace.visibility", :v => visibility)
 383     end
 384   end
 385
 386   def offline_warning
 387     flash.now[:warning] = t "traces.offline_warning.message" if STATUS == :gpx_offline
 388   end
 389
 390   def offline_redirect
 391     redirect_to :action => :offline if STATUS == :gpx_offline
 392   end
 393
 394   def default_visibility
 395     visibility = current_user.preferences.where(:k => "gps.trace.visibility").first
 396
 397     if visibility
 398       visibility.v
 399     elsif current_user.preferences.where(:k => "gps.trace.public", :v => "default").first.nil?
 400       "private"
 401     else
 402       "public"
 403     end
 404   end
 405 end