app/controllers/trace_controller.rb

   1 class TraceController < ApplicationController
   2   layout 'site'
   3
   4   before_filter :authorize_web
   5   before_filter :set_locale
   6   before_filter :require_user, :only => [:mine, :create, :edit, :delete]
   7   before_filter :authorize, :only => [:api_details, :api_data, :api_create]
   8   before_filter :check_database_readable, :except => [:api_details, :api_data, :api_create]
   9   before_filter :check_database_writable, :only => [:create, :edit, :delete]
  10   before_filter :check_api_readable, :only => [:api_details, :api_data]
  11   before_filter :check_api_writable, :only => [:api_create]
  12   before_filter :require_allow_read_gpx, :only => [:api_details, :api_data]
  13   before_filter :require_allow_write_gpx, :only => [:api_create]
  14   before_filter :offline_warning, :only => [:mine, :view]
  15   before_filter :offline_redirect, :only => [:create, :edit, :delete, :data, :api_data, :api_create]
  16   around_filter :api_call_handle_error, :only => [:api_details, :api_data, :api_create]
  17
  18   # Counts and selects pages of GPX traces for various criteria (by user, tags, public etc.).
  19   #  target_user - if set, specifies the user to fetch traces for.  if not set will fetch all traces
  20   def list(target_user = nil, action = "list")
  21     # from display name, pick up user id if one user's traces only
  22     display_name = params[:display_name]
  23     if target_user.nil? and !display_name.blank?
  24       target_user = User.find(:first, :conditions => [ "visible = ? and display_name = ?", true, display_name])
  25       if target_user.nil?
  26         @title = t'trace.no_such_user.title'
  27         @not_found_user = display_name
  28         render :action => 'no_such_user', :status => :not_found
  29         return
  30       end
  31     end
  32
  33     # set title
  34     if target_user.nil?
  35       @title = t 'trace.list.public_traces'
  36     elsif @user and @user == target_user
  37       @title = t 'trace.list.your_traces'
  38     else
  39       @title = t 'trace.list.public_traces_from', :user => target_user.display_name
  40     end
  41
  42     @title += t 'trace.list.tagged_with', :tags => params[:tag] if params[:tag]
  43
  44     # four main cases:
  45     # 1 - all traces, logged in = all public traces + all user's (i.e + all mine)
  46     # 2 - all traces, not logged in = all public traces
  47     # 3 - user's traces, logged in as same user = all user's traces
  48     # 4 - user's traces, not logged in as that user = all user's public traces
  49     if target_user.nil? # all traces
  50       if @user
  51         conditions = ["(gpx_files.visibility in ('public', 'identifiable') OR gpx_files.user_id = ?)", @user.id] #1
  52       else
  53         conditions  = ["gpx_files.visibility in ('public', 'identifiable')"] #2
  54       end
  55     else
  56       if @user and @user == target_user
  57         conditions = ["gpx_files.user_id = ?", @user.id] #3 (check vs user id, so no join + can't pick up non-public traces by changing name)
  58       else
  59         conditions = ["gpx_files.visibility in ('public', 'identifiable') AND gpx_files.user_id = ?", target_user.id] #4
  60       end
  61     end
  62
  63     if params[:tag]
  64       @tag = params[:tag]
  65
  66       files = Tracetag.find_all_by_tag(params[:tag]).collect { |tt| tt.gpx_id }
  67
  68       if files.length > 0
  69         conditions[0] += " AND gpx_files.id IN (#{files.join(',')})"
  70       else
  71         conditions[0] += " AND 0 = 1"
  72       end
  73     end
  74
  75     conditions[0] += " AND gpx_files.visible = ?"
  76     conditions << true
  77
  78     @trace_pages, @traces = paginate(:traces,
  79                                      :include => [:user, :tags],
  80                                      :conditions => conditions,
  81                                      :order => "gpx_files.timestamp DESC",
  82                                      :per_page => 20)
  83
  84     # put together SET of tags across traces, for related links
  85     tagset = Hash.new
  86     if @traces
  87       @traces.each do |trace|
  88         trace.tags.reload if params[:tag] # if searched by tag, ActiveRecord won't bring back other tags, so do explicitly here
  89         trace.tags.each do |tag|
  90           tagset[tag.tag] = tag.tag
  91         end
  92       end
  93     end
  94
  95     # final helper vars for view
  96     @action = action
  97     @display_name = target_user.display_name if target_user
  98     @all_tags = tagset.values
  99   end
 100
 101   def mine
 102     # Load the preference of whether the user set the trace public the last time
 103     @trace = Trace.new
 104     visibility = @user.preferences.find(:first, :conditions => {:k => "gps.trace.visibility"})
 105     if visibility
 106       @trace.visibility = visibility.v
 107     elsif @user.preferences.find(:first, :conditions => {:k => "gps.trace.public", :v => "default"}).nil?
 108       @trace.visibility = "private"
 109     else
 110       @trace.visibility = "public"
 111     end
 112     list(@user, "mine")
 113   end
 114
 115   def view
 116     @trace = Trace.find(params[:id])
 117
 118     if @trace and @trace.visible? and
 119        (@trace.public? or @trace.user == @user)
 120       @title = t 'trace.view.title', :name => @trace.name
 121     else
 122       flash[:error] = t 'trace.view.trace_not_found'
 123       redirect_to :controller => 'trace', :action => 'list'
 124     end
 125   rescue ActiveRecord::RecordNotFound
 126     flash[:error] = t 'trace.view.trace_not_found'
 127     redirect_to :controller => 'trace', :action => 'list'
 128   end
 129
 130   def create
 131     if params[:trace]
 132       logger.info(params[:trace][:gpx_file].class.name)
 133       if params[:trace][:gpx_file].respond_to?(:read)
 134         begin
 135           do_create(params[:trace][:gpx_file], params[:trace][:tagstring],
 136                     params[:trace][:description], params[:trace][:visibility])
 137         rescue => ex
 138           logger.debug ex
 139         end
 140
 141         if @trace.id
 142           logger.info("id is #{@trace.id}")
 143           flash[:notice] = t 'trace.create.trace_uploaded'
 144
 145           redirect_to :action => 'mine'
 146         end
 147       else
 148         @trace = Trace.new({:name => "Dummy",
 149                             :tagstring => params[:trace][:tagstring],
 150                             :description => params[:trace][:description],
 151                             :visibility => params[:trace][:visibility],
 152                             :inserted => false, :user => @user,
 153                             :timestamp => Time.now.getutc})
 154         @trace.valid?
 155         @trace.errors.add(:gpx_file, "can't be blank")
 156       end
 157     end
 158     @title = t 'trace.create.upload_trace'
 159   end
 160
 161   def data
 162     trace = Trace.find(params[:id])
 163
 164     if trace.visible? and (trace.public? or (@user and @user == trace.user))
 165       if request.format == Mime::XML
 166         send_file(trace.xml_file, :filename => "#{trace.id}.xml", :type => Mime::XML.to_s, :disposition => 'attachment')
 167       else
 168         send_file(trace.trace_name, :filename => "#{trace.id}#{trace.extension_name}", :type => trace.mime_type, :disposition => 'attachment')
 169       end
 170     else
 171       render :nothing => true, :status => :not_found
 172     end
 173   rescue ActiveRecord::RecordNotFound
 174     render :nothing => true, :status => :not_found
 175   end
 176
 177   def edit
 178     @trace = Trace.find(params[:id])
 179
 180     if @user and @trace.user == @user
 181       @title = t 'trace.edit.title', :name => @trace.name
 182       if params[:trace]
 183         @trace.description = params[:trace][:description]
 184         @trace.tagstring = params[:trace][:tagstring]
 185         @trace.visibility = params[:trace][:visibility]
 186         if @trace.save
 187           redirect_to :action => 'view'
 188         end
 189       end
 190     else
 191       render :nothing => true, :status => :forbidden
 192     end
 193   rescue ActiveRecord::RecordNotFound
 194     render :nothing => true, :status => :not_found
 195   end
 196
 197   def delete
 198     trace = Trace.find(params[:id])
 199
 200     if @user and trace.user == @user
 201       if request.post? and trace.visible?
 202         trace.visible = false
 203         trace.save
 204         flash[:notice] = t 'trace.delete.scheduled_for_deletion'
 205         redirect_to :controller => 'traces', :action => 'mine'
 206       else
 207         render :nothing => true, :status => :bad_request
 208       end
 209     else
 210       render :nothing => true, :status => :forbidden
 211     end
 212   rescue ActiveRecord::RecordNotFound
 213     render :nothing => true, :status => :not_found
 214   end
 215
 216   def georss
 217     conditions = ["gpx_files.visibility in ('public', 'identifiable')"]
 218
 219     if params[:display_name]
 220       conditions[0] += " AND users.display_name = ?"
 221       conditions << params[:display_name]
 222     end
 223
 224     if params[:tag]
 225       conditions[0] += " AND EXISTS (SELECT * FROM gpx_file_tags AS gft WHERE gft.gpx_id = gpx_files.id AND gft.tag = ?)"
 226       conditions << params[:tag]
 227     end
 228
 229     traces = Trace.find(:all, :include => :user, :conditions => conditions,
 230                         :order => "timestamp DESC", :limit => 20)
 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, :user_login => 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_details
 276     trace = Trace.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   rescue ActiveRecord::RecordNotFound
 284     render :nothing => true, :status => :not_found
 285   end
 286
 287   def api_data
 288     trace = Trace.find(params[:id])
 289
 290     if trace.public? or trace.user == @user
 291       send_file(trace.trace_name, :filename => "#{trace.id}#{trace.extension_name}", :type => trace.mime_type, :disposition => 'attachment')
 292     else
 293       render :nothing => true, :status => :forbidden
 294     end
 295   rescue ActiveRecord::RecordNotFound
 296     render :nothing => true, :status => :not_found
 297   end
 298
 299   def api_create
 300     if request.post?
 301       tags = params[:tags] || ""
 302       description = params[:description] || ""
 303       visibility = params[:visibility]
 304
 305       if visibility.nil?
 306         if params[:public] && params[:public].to_i.nonzero?
 307           visibility = "public"
 308         else
 309           visibility = "private"
 310         end
 311       end
 312
 313       if params[:file].respond_to?(:read)
 314         do_create(params[:file], tags, description, visibility)
 315
 316         if @trace.id
 317           render :text => @trace.id.to_s, :content_type => "text/plain"
 318         elsif @trace.valid?
 319           render :nothing => true, :status => :internal_server_error
 320         else
 321           render :nothing => true, :status => :bad_request
 322         end
 323       else
 324         render :nothing => true, :status => :bad_request
 325       end
 326     else
 327       render :nothing => true, :status => :method_not_allowed
 328     end
 329   end
 330
 331 private
 332
 333   def do_create(file, tags, description, visibility)
 334     # Sanitise the user's filename
 335     name = file.original_filename.gsub(/[^a-zA-Z0-9.]/, '_')
 336
 337     # Get a temporary filename...
 338     filename = "/tmp/#{rand}"
 339
 340     # ...and save the uploaded file to that location
 341     File.open(filename, "w") { |f| f.write(file.read) }
 342
 343     # Create the trace object, falsely marked as already
 344     # inserted to stop the import daemon trying to load it
 345     @trace = Trace.new({
 346       :name => name,
 347       :tagstring => tags,
 348       :description => description,
 349       :visibility => visibility,
 350       :inserted => true,
 351       :user => @user,
 352       :timestamp => Time.now.getutc
 353     })
 354
 355     Trace.transaction do
 356       begin
 357         # Save the trace object
 358         @trace.save!
 359
 360         # Rename the temporary file to the final name
 361         FileUtils.mv(filename, @trace.trace_name)
 362       rescue Exception => ex
 363         # Remove the file as we have failed to update the database
 364         FileUtils.rm_f(filename)
 365
 366         # Pass the exception on
 367         raise
 368       end
 369
 370       begin
 371         # Clear the inserted flag to make the import daemon load the trace
 372         @trace.inserted = false
 373         @trace.save!
 374       rescue Exception => ex
 375         # Remove the file as we have failed to update the database
 376         FileUtils.rm_f(@trace.trace_name)
 377
 378         # Pass the exception on
 379         raise
 380       end
 381     end
 382
 383     # Finally save the user's preferred privacy level
 384     if pref = @user.preferences.find(:first, :conditions => {:k => "gps.trace.visibility"})
 385       pref.v = visibility
 386       pref.save
 387     else
 388       @user.preferences.create(:k => "gps.trace.visibility", :v => visibility)
 389     end
 390
 391   end
 392
 393   def offline_warning
 394     flash.now[:warning] = t 'trace.offline_warning.message' if OSM_STATUS == :gpx_offline
 395   end
 396
 397   def offline_redirect
 398     redirect_to :action => :offline if OSM_STATUS == :gpx_offline
 399   end
 400
 401 end