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
  13   # Counts and selects pages of GPX traces for various criteria (by user, tags, public etc.).
  14   #  target_user - if set, specifies the user to fetch traces for.  if not set will fetch all traces
  15   def list(target_user = nil, action = "list")
  16     # from display name, pick up user id if one user's traces only
  17     display_name = params[:display_name]
  18     if target_user.nil? and !display_name.blank?
  19       target_user = User.find(:first, :conditions => [ "visible = ? and display_name = ?", true, display_name])
  20       if target_user.nil?
  21         @title = t'trace.no_such_user.title'
  22         @not_found_user = display_name
  23         render :action => 'no_such_user', :status => :not_found
  24         return
  25       end
  26     end
  27
  28     # set title
  29     if target_user.nil?
  30       @title = t 'trace.list.public_traces'
  31     elsif @user and @user == target_user
  32       @title = t 'trace.list.your_traces'
  33     else
  34       @title = t 'trace.list.public_traces_from', :user => target_user.display_name
  35     end
  36
  37     @title += t 'trace.list.tagged_with', :tags => params[:tag] if params[:tag]
  38
  39     # four main cases:
  40     # 1 - all traces, logged in = all public traces + all user's (i.e + all mine)
  41     # 2 - all traces, not logged in = all public traces
  42     # 3 - user's traces, logged in as same user = all user's traces
  43     # 4 - user's traces, not logged in as that user = all user's public traces
  44     if target_user.nil? # all traces
  45       if @user
  46         conditions = ["(gpx_files.visibility <> 'private' OR gpx_files.user_id = ?)", @user.id] #1
  47       else
  48         conditions  = ["gpx_files.visibility <> 'private'"] #2
  49       end
  50     else
  51       if @user and @user == target_user
  52         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)
  53       else
  54         conditions = ["gpx_files.public <> 'private' AND gpx_files.user_id = ?", target_user.id] #4
  55       end
  56     end
  57
  58     if params[:tag]
  59       @tag = params[:tag]
  60
  61       files = Tracetag.find_all_by_tag(params[:tag]).collect { |tt| tt.gpx_id }
  62
  63       if files.length > 0
  64         conditions[0] += " AND gpx_files.id IN (#{files.join(',')})"
  65       else
  66         conditions[0] += " AND 0 = 1"
  67       end
  68     end
  69
  70     conditions[0] += " AND gpx_files.visible = ?"
  71     conditions << true
  72
  73     @trace_pages, @traces = paginate(:traces,
  74                                      :include => [:user, :tags],
  75                                      :conditions => conditions,
  76                                      :order => "gpx_files.timestamp DESC",
  77                                      :per_page => 20)
  78
  79     # put together SET of tags across traces, for related links
  80     tagset = Hash.new
  81     if @traces
  82       @traces.each do |trace|
  83         trace.tags.reload if params[:tag] # if searched by tag, ActiveRecord won't bring back other tags, so do explicitly here
  84         trace.tags.each do |tag|
  85           tagset[tag.tag] = tag.tag
  86         end
  87       end
  88     end
  89
  90     # final helper vars for view
  91     @action = action
  92     @display_name = target_user.display_name if target_user
  93     @all_tags = tagset.values
  94   end
  95
  96   def mine
  97     # Load the preference of whether the user set the trace public the last time
  98     @trace = Trace.new
  99     visibility = @user.preferences.find(:first, :conditions => {:k => "gps.trace.visibility"})
 100     if visibility
 101       @trace.visibility = visibility.v
 102     elsif @user.preferences.find(:first, :conditions => {:k => "gps.trace.public", :v => "default"}).nil?
 103       @trace.visibility = "private"
 104     else
 105       @trace.visibility = "public"
 106     end
 107     list(@user, "mine")
 108   end
 109
 110   def view
 111     @trace = Trace.find(params[:id])
 112
 113     if @trace and @trace.visible? and
 114        (@trace.public? or @trace.user == @user)
 115       @title = t 'trace.view.title', :name => @trace.name
 116     else
 117       flash[:notice] = t 'trace.view.trace_not_found'
 118       redirect_to :controller => 'trace', :action => 'list'
 119     end
 120   rescue ActiveRecord::RecordNotFound
 121     flash[:notice] = t 'trace.view.trace_not_found'
 122     redirect_to :controller => 'trace', :action => 'list'
 123   end
 124
 125   def create
 126     if params[:trace]
 127       logger.info(params[:trace][:gpx_file].class.name)
 128       if params[:trace][:gpx_file].respond_to?(:read)
 129         do_create(params[:trace][:gpx_file], params[:trace][:tagstring],
 130                   params[:trace][:description], params[:trace][:visibility])
 131
 132         if @trace.id
 133           logger.info("id is #{@trace.id}")
 134           flash[:notice] = t 'trace.create.trace_uploaded'
 135
 136           redirect_to :action => 'mine'
 137         end
 138       else
 139         @trace = Trace.new({:name => "Dummy",
 140                             :tagstring => params[:trace][:tagstring],
 141                             :description => params[:trace][:description],
 142                             :visibility => params[:trace][:visibility],
 143                             :inserted => false, :user => @user,
 144                             :timestamp => Time.now.getutc})
 145         @trace.valid?
 146         @trace.errors.add(:gpx_file, "can't be blank")
 147       end
 148     end
 149     @title = t 'trace.create.upload_trace'
 150   end
 151
 152   def data
 153     trace = Trace.find(params[:id])
 154
 155     if trace.visible? and (trace.public? or (@user and @user == trace.user))
 156       if request.format == Mime::XML
 157         send_file(trace.xml_file, :filename => "#{trace.id}.xml", :type => Mime::XML.to_s, :disposition => 'attachment')
 158       else
 159         send_file(trace.trace_name, :filename => "#{trace.id}#{trace.extension_name}", :type => trace.mime_type, :disposition => 'attachment')
 160       end
 161     else
 162       render :nothing => true, :status => :not_found
 163     end
 164   rescue ActiveRecord::RecordNotFound
 165     render :nothing => true, :status => :not_found
 166   end
 167
 168   def edit
 169     @trace = Trace.find(params[:id])
 170
 171     if @user and @trace.user == @user
 172       @title = t 'trace.edit.title', :name => @trace.name
 173       if params[:trace]
 174         @trace.description = params[:trace][:description]
 175         @trace.tagstring = params[:trace][:tagstring]
 176         @trace.visibility = params[:trace][:visibility]
 177         if @trace.save
 178           redirect_to :action => 'view'
 179         end
 180       end
 181     else
 182       render :nothing => true, :status => :forbidden
 183     end
 184   rescue ActiveRecord::RecordNotFound
 185     render :nothing => true, :status => :not_found
 186   end
 187
 188   def delete
 189     trace = Trace.find(params[:id])
 190
 191     if @user and trace.user == @user
 192       if request.post? and trace.visible?
 193         trace.visible = false
 194         trace.save
 195         flash[:notice] = t 'trace.delete.scheduled_for_deletion'
 196         redirect_to :controller => 'traces', :action => 'mine'
 197       else
 198         render :nothing => true, :status => :bad_request
 199       end
 200     else
 201       render :nothing => true, :status => :forbidden
 202     end
 203   rescue ActiveRecord::RecordNotFound
 204     render :nothing => true, :status => :not_found
 205   end
 206
 207   def georss
 208     conditions = ["gpx_files.visibility <> 'private'"]
 209
 210     if params[:display_name]
 211       conditions[0] += " AND users.display_name = ?"
 212       conditions << params[:display_name]
 213     end
 214
 215     if params[:tag]
 216       conditions[0] += " AND EXISTS (SELECT * FROM gpx_file_tags AS gft WHERE gft.gpx_id = gpx_files.id AND gft.tag = ?)"
 217       conditions << params[:tag]
 218     end
 219
 220     traces = Trace.find(:all, :include => :user, :conditions => conditions,
 221                         :order => "timestamp DESC", :limit => 20)
 222
 223     rss = OSM::GeoRSS.new
 224
 225     traces.each do |trace|
 226       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)
 227     end
 228
 229     render :text => rss.to_s, :content_type => "application/rss+xml"
 230   end
 231
 232   def picture
 233     trace = Trace.find(params[:id])
 234
 235     if trace.inserted?
 236       if trace.public? or (@user and @user == trace.user)
 237         expires_in 7.days, :private => !trace.public?, :public => trace.public?
 238         send_file(trace.large_picture_name, :filename => "#{trace.id}.gif", :type => 'image/gif', :disposition => 'inline')
 239       else
 240         render :nothing => true, :status => :forbidden
 241       end
 242     else
 243       render :nothing => true, :status => :not_found
 244     end
 245   rescue ActiveRecord::RecordNotFound
 246     render :nothing => true, :status => :not_found
 247   end
 248
 249   def icon
 250     trace = Trace.find(params[:id])
 251
 252     if trace.inserted?
 253       if trace.public? or (@user and @user == trace.user)
 254         expires_in 7.days, :private => !trace.public?, :public => trace.public?
 255         send_file(trace.icon_picture_name, :filename => "#{trace.id}_icon.gif", :type => 'image/gif', :disposition => 'inline')
 256       else
 257         render :nothing => true, :status => :forbidden
 258       end
 259     else
 260       render :nothing => true, :status => :not_found
 261     end
 262   rescue ActiveRecord::RecordNotFound
 263     render :nothing => true, :status => :not_found
 264   end
 265
 266   def api_details
 267     trace = Trace.find(params[:id])
 268
 269     if trace.public? or trace.user == @user
 270       render :text => trace.to_xml.to_s, :content_type => "text/xml"
 271     else
 272       render :nothing => true, :status => :forbidden
 273     end
 274   rescue ActiveRecord::RecordNotFound
 275     render :nothing => true, :status => :not_found
 276   end
 277
 278   def api_data
 279     trace = Trace.find(params[:id])
 280
 281     if trace.public? or trace.user == @user
 282       send_file(trace.trace_name, :filename => "#{trace.id}#{trace.extension_name}", :type => trace.mime_type, :disposition => 'attachment')
 283     else
 284       render :nothing => true, :status => :forbidden
 285     end
 286   rescue ActiveRecord::RecordNotFound
 287     render :nothing => true, :status => :not_found
 288   end
 289
 290   def api_create
 291     if request.post?
 292       tags = params[:tags] || ""
 293       description = params[:description] || ""
 294       visibility = params[:visibility] || false
 295
 296       if params[:public] && !visibility
 297         visibility = "public"
 298       end
 299
 300       if params[:file].respond_to?(:read)
 301         do_create(params[:file], tags, description, visibility)
 302
 303         if @trace.id
 304           render :text => @trace.id.to_s, :content_type => "text/plain"
 305         elsif @trace.valid?
 306           render :nothing => true, :status => :internal_server_error
 307         else
 308           render :nothing => true, :status => :bad_request
 309         end
 310       else
 311         render :nothing => true, :status => :bad_request
 312       end
 313     else
 314       render :nothing => true, :status => :method_not_allowed
 315     end
 316   end
 317
 318 private
 319
 320   def do_create(file, tags, description, visibility)
 321     # Sanitise the user's filename
 322     name = file.original_filename.gsub(/[^a-zA-Z0-9.]/, '_')
 323
 324     # Get a temporary filename...
 325     filename = "/tmp/#{rand}"
 326
 327     # ...and save the uploaded file to that location
 328     File.open(filename, "w") { |f| f.write(file.read) }
 329
 330     # Create the trace object, falsely marked as already
 331     # inserted to stop the import daemon trying to load it
 332     @trace = Trace.new({
 333       :name => name,
 334       :tagstring => tags,
 335       :description => description,
 336       :visibility => visibility,
 337       :inserted => true,
 338       :user => @user,
 339       :timestamp => Time.now.getutc
 340     })
 341
 342     # Save the trace object
 343     if @trace.save
 344       # Rename the temporary file to the final name
 345       FileUtils.mv(filename, @trace.trace_name)
 346
 347       # Clear the inserted flag to make the import daemon load the trace
 348       @trace.inserted = false
 349       @trace.save!
 350     else
 351       # Remove the file as we have failed to update the database
 352       FileUtils.rm_f(filename)
 353     end
 354
 355     # Finally save the user's preferred previacy level
 356     if pref = @user.preferences.find(:first, :conditions => {:k => "gps.trace.visibility"})
 357       pref.v = visibility
 358       pref.save
 359     else
 360       @user.preferences.create(:k => "gps.trace.visibility", :v => visibility)
 361     end
 362
 363   end
 364
 365 end