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