Refactored user_role and controller. Now much more DRY.

[rails.git] / app / controllers / trace_controller.rb

diff --git a/app/controllers/trace_controller.rb b/app/controllers/trace_controller.rb
index 06ae5dc3b7e1910d6614295d9f5e791b0ec876dc..84026e8cd4d420f6f437778df8924db6c6179777 100644 (file)
--- a/app/controllers/trace_controller.rb
+++ b/app/controllers/trace_controller.rb
@@ -1,11 +1,18 @@
 class TraceController < ApplicationController
   layout 'site'
 
 class TraceController < ApplicationController
   layout 'site'
 

-  before_filter :authorize_web  
+  before_filter :authorize_web
+  before_filter :set_locale
+  before_filter :require_user, :only => [:mine, :create, :edit, :delete]

   before_filter :authorize, :only => [:api_details, :api_data, :api_create]
   before_filter :authorize, :only => [:api_details, :api_data, :api_create]

-  before_filter :check_database_availability, :except => [:api_details, :api_data, :api_create]
-  before_filter :check_read_availability, :only => [:api_details, :api_data, :api_create]
- 
+  before_filter :check_database_readable, :except => [:api_details, :api_data, :api_create]
+  before_filter :check_database_writable, :only => [:create, :edit, :delete]
+  before_filter :check_api_readable, :only => [:api_details, :api_data]
+  before_filter :check_api_writable, :only => [:api_create]
+  before_filter :require_allow_read_gpx, :only => [:api_details, :api_data]
+  before_filter :require_allow_write_gpx, :only => [:api_create]
+  around_filter :api_call_handle_error, :only => [:api_details, :api_data, :api_create]
+

   # Counts and selects pages of GPX traces for various criteria (by user, tags, public etc.).
   #  target_user - if set, specifies the user to fetch traces for.  if not set will fetch all traces
   def list(target_user = nil, action = "list")
   # Counts and selects pages of GPX traces for various criteria (by user, tags, public etc.).
   #  target_user - if set, specifies the user to fetch traces for.  if not set will fetch all traces
   def list(target_user = nil, action = "list")


@@ -13,18 +20,24 @@ class TraceController < ApplicationController
     display_name = params[:display_name]
     if target_user.nil? and !display_name.blank?
       target_user = User.find(:first, :conditions => [ "visible = ? and display_name = ?", true, display_name])
     display_name = params[:display_name]
     if target_user.nil? and !display_name.blank?
       target_user = User.find(:first, :conditions => [ "visible = ? and display_name = ?", true, display_name])

+      if target_user.nil?
+        @title = t'trace.no_such_user.title'
+        @not_found_user = display_name
+        render :action => 'no_such_user', :status => :not_found
+        return
+      end

     end
 
     # set title
     if target_user.nil?
     end
 
     # set title
     if target_user.nil?

-      @title = "Public GPS traces"
+      @title = t 'trace.list.public_traces'

     elsif @user and @user == target_user
     elsif @user and @user == target_user

-      @title = "Your GPS traces"
+      @title = t 'trace.list.your_traces'

     else
     else

-      @title = "Public GPS traces from #{target_user.display_name}"
+      @title = t 'trace.list.public_traces_from', :user => target_user.display_name

     end
 
     end
 

-    @title += " tagged with #{params[:tag]}" if params[:tag]
+    @title += t 'trace.list.tagged_with', :tags => params[:tag] if params[:tag]

 
     # four main cases:
     # 1 - all traces, logged in = all public traces + all user's (i.e + all mine)
 
     # four main cases:
     # 1 - all traces, logged in = all public traces + all user's (i.e + all mine)


@@ -33,22 +46,28 @@ class TraceController < ApplicationController
     # 4 - user's traces, not logged in as that user = all user's public traces
     if target_user.nil? # all traces
       if @user
     # 4 - user's traces, not logged in as that user = all user's public traces
     if target_user.nil? # all traces
       if @user

-        conditions = ["(gpx_files.public = ? OR gpx_files.user_id = ?)", true, @user.id] #1
+        conditions = ["(gpx_files.visibility in ('public', 'identifiable') OR gpx_files.user_id = ?)", @user.id] #1

       else
       else

-        conditions  = ["gpx_files.public = ?", true] #2
+        conditions  = ["gpx_files.visibility in ('public', 'identifiable')"] #2

       end
     else
       if @user and @user == target_user
         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)
       else
       end
     else
       if @user and @user == target_user
         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)
       else

-        conditions = ["gpx_files.public = ? AND gpx_files.user_id = ?", true, target_user.id] #4
+        conditions = ["gpx_files.visibility in ('public', 'identifiable') AND gpx_files.user_id = ?", target_user.id] #4

       end
     end
     
     if params[:tag]
       @tag = params[:tag]
       end
     end
     
     if params[:tag]
       @tag = params[:tag]

-      conditions[0] += " AND EXISTS (SELECT * FROM gpx_file_tags AS gft WHERE gft.gpx_id = gpx_files.id AND gft.tag = ?)"
-      conditions << @tag
+
+      files = Tracetag.find_all_by_tag(params[:tag]).collect { |tt| tt.gpx_id }
+
+      if files.length > 0
+        conditions[0] += " AND gpx_files.id IN (#{files.join(',')})"
+      else
+        conditions[0] += " AND 0 = 1"
+      end

     end
     
     conditions[0] += " AND gpx_files.visible = ?"
     end
     
     conditions[0] += " AND gpx_files.visible = ?"


@@ -78,17 +97,17 @@ class TraceController < ApplicationController
   end
 
   def mine
   end
 
   def mine

-    if @user
-      @trace = Trace.new
-      unless @user.trace_public_default.nil?
-        @trace.public = true
-      else 
-        @trace.public = false
-      end
-      list(@user, "mine") unless @user.nil?
-    else
-      redirect_to :controller => 'user', :action => 'login', :referer => request.request_uri
+    # Load the preference of whether the user set the trace public the last time
+    @trace = Trace.new
+    visibility = @user.preferences.find(:first, :conditions => {:k => "gps.trace.visibility"})
+    if visibility
+      @trace.visibility = visibility.v
+    elsif @user.preferences.find(:first, :conditions => {:k => "gps.trace.public", :v => "default"}).nil?
+      @trace.visibility = "private"
+    else 
+      @trace.visibility = "public"

     end
     end

+    list(@user, "mine")

   end
 
   def view
   end
 
   def view


@@ -96,38 +115,44 @@ class TraceController < ApplicationController
 
     if @trace and @trace.visible? and
        (@trace.public? or @trace.user == @user)
 
     if @trace and @trace.visible? and
        (@trace.public? or @trace.user == @user)

-      @title = "Viewing trace #{@trace.name}"
+      @title = t 'trace.view.title', :name => @trace.name

     else
     else

-      flash[:notice] = "Trace not found!"
+      flash[:notice] = t 'trace.view.trace_not_found'

       redirect_to :controller => 'trace', :action => 'list'
     end
   rescue ActiveRecord::RecordNotFound
       redirect_to :controller => 'trace', :action => 'list'
     end
   rescue ActiveRecord::RecordNotFound

-    flash[:notice] = "Trace not found!"
+    flash[:notice] = t 'trace.view.trace_not_found'

     redirect_to :controller => 'trace', :action => 'list'
   end
 
   def create
     redirect_to :controller => 'trace', :action => 'list'
   end
 
   def create

-    logger.info(params[:trace][:gpx_file].class.name)
-    if params[:trace][:gpx_file].respond_to?(:read)
-      do_create(params[:trace][:gpx_file], params[:trace][:tagstring],
-                params[:trace][:description], params[:trace][:public])
+    if params[:trace]
+      logger.info(params[:trace][:gpx_file].class.name)
+      if params[:trace][:gpx_file].respond_to?(:read)
+        begin
+          do_create(params[:trace][:gpx_file], params[:trace][:tagstring],
+                    params[:trace][:description], params[:trace][:visibility])
+        rescue
+        end

 
 

-      if @trace.id
-        logger.info("id is #{@trace.id}")
-        flash[:notice] = "Your GPX file has been uploaded and is awaiting insertion in to the database. This will usually happen within half an hour, and an email will be sent to you on completion."
+        if @trace.id
+          logger.info("id is #{@trace.id}")
+          flash[:notice] = t 'trace.create.trace_uploaded'

 
 

-        redirect_to :action => 'mine'
+          redirect_to :action => 'mine'
+        end
+      else
+        @trace = Trace.new({:name => "Dummy",
+                            :tagstring => params[:trace][:tagstring],
+                            :description => params[:trace][:description],
+                            :visibility => params[:trace][:visibility],
+                            :inserted => false, :user => @user,
+                            :timestamp => Time.now.getutc})
+        @trace.valid?
+        @trace.errors.add(:gpx_file, "can't be blank")

       end
       end

-    else
-      @trace = Trace.new({:name => "Dummy",
-                          :tagstring => params[:trace][:tagstring],
-                          :description => params[:trace][:description],
-                          :public => params[:trace][:public],
-                          :inserted => false, :user => @user,
-                          :timestamp => Time.now})
-      @trace.valid?
-      @trace.errors.add(:gpx_file, "can't be blank")

     end
     end

+    @title = t 'trace.create.upload_trace'

   end
 
   def data
   end
 
   def data


@@ -140,7 +165,7 @@ class TraceController < ApplicationController
         send_file(trace.trace_name, :filename => "#{trace.id}#{trace.extension_name}", :type => trace.mime_type, :disposition => 'attachment')
       end
     else
         send_file(trace.trace_name, :filename => "#{trace.id}#{trace.extension_name}", :type => trace.mime_type, :disposition => 'attachment')
       end
     else

-      render :nothing, :status => :not_found
+      render :nothing => true, :status => :not_found

     end
   rescue ActiveRecord::RecordNotFound
     render :nothing => true, :status => :not_found
     end
   rescue ActiveRecord::RecordNotFound
     render :nothing => true, :status => :not_found


@@ -150,15 +175,17 @@ class TraceController < ApplicationController
     @trace = Trace.find(params[:id])
 
     if @user and @trace.user == @user
     @trace = Trace.find(params[:id])
 
     if @user and @trace.user == @user

+      @title = t 'trace.edit.title', :name => @trace.name

       if params[:trace]
         @trace.description = params[:trace][:description]
         @trace.tagstring = params[:trace][:tagstring]
       if params[:trace]
         @trace.description = params[:trace][:description]
         @trace.tagstring = params[:trace][:tagstring]

+        @trace.visibility = params[:trace][:visibility]

         if @trace.save
           redirect_to :action => 'view'
         end        
       end
     else
         if @trace.save
           redirect_to :action => 'view'
         end        
       end
     else

-      render :nothing, :status => :forbidden
+      render :nothing => true, :status => :forbidden

     end
   rescue ActiveRecord::RecordNotFound
     render :nothing => true, :status => :not_found
     end
   rescue ActiveRecord::RecordNotFound
     render :nothing => true, :status => :not_found


@@ -171,39 +198,20 @@ class TraceController < ApplicationController
       if request.post? and trace.visible?
         trace.visible = false
         trace.save
       if request.post? and trace.visible?
         trace.visible = false
         trace.save

-        flash[:notice] = 'Track scheduled for deletion'
+        flash[:notice] = t 'trace.delete.scheduled_for_deletion'

         redirect_to :controller => 'traces', :action => 'mine'
       else
         redirect_to :controller => 'traces', :action => 'mine'
       else

-        render :nothing, :status => :bad_request
-      end
-    else
-      render :nothing, :status => :forbidden
-    end
-  rescue ActiveRecord::RecordNotFound
-    render :nothing => true, :status => :not_found
-  end
-
-  def make_public
-    trace = Trace.find(params[:id])
-
-    if @user and trace.user == @user
-      if request.post? and !trace.public?
-        trace.public = true
-        trace.save
-        flash[:notice] = 'Track made public'
-        redirect_to :controller => 'trace', :action => 'view', :id => params[:id]
-      else
-        render :nothing, :status => :bad_request
+        render :nothing => true, :status => :bad_request

       end
     else
       end
     else

-      render :nothing, :status => :forbidden
+      render :nothing => true, :status => :forbidden

     end
   rescue ActiveRecord::RecordNotFound
     render :nothing => true, :status => :not_found
   end
 
   def georss
     end
   rescue ActiveRecord::RecordNotFound
     render :nothing => true, :status => :not_found
   end
 
   def georss

-    conditions = ["gpx_files.public = ?", true]
+    conditions = ["gpx_files.visibility in ('public', 'identifiable')"]

 
     if params[:display_name]
       conditions[0] += " AND users.display_name = ?"
 
     if params[:display_name]
       conditions[0] += " AND users.display_name = ?"


@@ -232,9 +240,10 @@ class TraceController < ApplicationController
 
     if trace.inserted?
       if trace.public? or (@user and @user == trace.user)
 
     if trace.inserted?
       if trace.public? or (@user and @user == trace.user)

+        expires_in 7.days, :private => !trace.public?, :public => trace.public?

         send_file(trace.large_picture_name, :filename => "#{trace.id}.gif", :type => 'image/gif', :disposition => 'inline')
       else
         send_file(trace.large_picture_name, :filename => "#{trace.id}.gif", :type => 'image/gif', :disposition => 'inline')
       else

-        render :nothing, :status => :forbidden
+        render :nothing => true, :status => :forbidden

       end
     else
       render :nothing => true, :status => :not_found
       end
     else
       render :nothing => true, :status => :not_found


@@ -248,9 +257,10 @@ class TraceController < ApplicationController
 
     if trace.inserted?
       if trace.public? or (@user and @user == trace.user)
 
     if trace.inserted?
       if trace.public? or (@user and @user == trace.user)

+        expires_in 7.days, :private => !trace.public?, :public => trace.public?

         send_file(trace.icon_picture_name, :filename => "#{trace.id}_icon.gif", :type => 'image/gif', :disposition => 'inline')
       else
         send_file(trace.icon_picture_name, :filename => "#{trace.id}_icon.gif", :type => 'image/gif', :disposition => 'inline')
       else

-        render :nothing, :status => :forbidden
+        render :nothing => true, :status => :forbidden

       end
     else
       render :nothing => true, :status => :not_found
       end
     else
       render :nothing => true, :status => :not_found


@@ -285,12 +295,28 @@ class TraceController < ApplicationController
 
   def api_create
     if request.post?
 
   def api_create
     if request.post?

-      do_create(params[:file], params[:tags], params[:description], params[:public])
+      tags = params[:tags] || ""
+      description = params[:description] || ""
+      visibility = params[:visibility]
+
+      if visibility.nil?
+        if params[:public] && params[:public].to_i.nonzero?
+          visibility = "public"
+        else
+          visibility = "private"
+        end
+      end

 
 

-      if @trace.id
-        render :text => @trace.id.to_s, :content_type => "text/plain"
-      elsif @trace.valid?
-        render :nothing => true, :status => :internal_server_error
+      if params[:file].respond_to?(:read)
+        do_create(params[:file], tags, description, visibility)
+
+        if @trace.id
+          render :text => @trace.id.to_s, :content_type => "text/plain"
+        elsif @trace.valid?
+          render :nothing => true, :status => :internal_server_error
+        else
+          render :nothing => true, :status => :bad_request
+        end

       else
         render :nothing => true, :status => :bad_request
       end
       else
         render :nothing => true, :status => :bad_request
       end


@@ -301,32 +327,62 @@ class TraceController < ApplicationController
 
 private
 
 
 private
 

-  def do_create(file, tags, description, public)
+  def do_create(file, tags, description, visibility)
+    # Sanitise the user's filename

     name = file.original_filename.gsub(/[^a-zA-Z0-9.]/, '_')
     name = file.original_filename.gsub(/[^a-zA-Z0-9.]/, '_')

+
+    # Get a temporary filename...

     filename = "/tmp/#{rand}"
 
     filename = "/tmp/#{rand}"
 

+    # ...and save the uploaded file to that location

     File.open(filename, "w") { |f| f.write(file.read) }
 
     File.open(filename, "w") { |f| f.write(file.read) }
 

-    @trace = Trace.new({:name => name, :tagstring => tags,
-                        :description => description, :public => public})
-    @trace.inserted = false
-    @trace.user = @user
-    @trace.timestamp = Time.now
+    # Create the trace object, falsely marked as already
+    # inserted to stop the import daemon trying to load it
+    @trace = Trace.new({
+      :name => name,
+      :tagstring => tags,
+      :description => description,
+      :visibility => visibility,
+      :inserted => true,
+      :user => @user,
+      :timestamp => Time.now.getutc
+    })
+
+    Trace.transaction do
+      begin
+        # Save the trace object
+        @trace.save!
+
+        # Rename the temporary file to the final name
+        FileUtils.mv(filename, @trace.trace_name)
+      rescue Exception => ex
+        # Remove the file as we have failed to update the database
+        FileUtils.rm_f(filename)
+
+        # Pass the exception on
+        raise
+      end

 
 

-    if @trace.save
-      FileUtils.mv(filename, @trace.trace_name)
-    else
-      FileUtils.rm_f(filename)
-    end
-    
-    # Finally save whether the user marked the trace as being public
-    if @trace.public?
-      if @user.trace_public_default.nil?
-        @user.preferences.create(:k => "gps.trace.public", :v => "default")
+      begin
+        # Clear the inserted flag to make the import daemon load the trace
+        @trace.inserted = false
+        @trace.save!
+      rescue Exception => ex
+        # Remove the file as we have failed to update the database
+        FileUtils.rm_f(@trace.trace_name)
+
+        # Pass the exception on
+        raise

       end
       end

+    end
+
+    # Finally save the user's preferred privacy level
+    if pref = @user.preferences.find(:first, :conditions => {:k => "gps.trace.visibility"})
+      pref.v = visibility
+      pref.save

     else
     else

-      pref = @user.trace_public_default
-      pref.destroy unless pref.nil?
+      @user.preferences.create(:k => "gps.trace.visibility", :v => visibility)

     end
     
   end
     end
     
   end