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 288a4a67b676d6002f50fd1ea638ea68e5dc52b8..84026e8cd4d420f6f437778df8924db6c6179777 100644 (file)
--- a/app/controllers/trace_controller.rb
+++ b/app/controllers/trace_controller.rb
@@ -1,28 +1,43 @@
 class TraceController < ApplicationController
 class TraceController < ApplicationController

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

   layout 'site'
   layout 'site'

- 
+
+  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 :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
   # 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

-  #  paging_action - the action that will be linked back to from view
-  def list (target_user = nil, paging_action = 'list')
-    @title = 'public GPS traces'
-    @title += " tagged with #{params[:tag]}" if params[:tag]
-    @traces_per_page = 20
-    page_index = params[:page] ? params[:page].to_i - 1 : 0 # nice 1-based page -> 0-based page index
-
+  def list(target_user = nil, action = "list")

     # from display name, pick up user id if one user's traces only
     display_name = params[:display_name]
     # from display name, pick up user id if one user's traces only
     display_name = params[:display_name]

-    if target_user.nil? and display_name and display_name != ''
-      @paging_action = 'view'
-      @display_name = display_name
-      @title += " from #{@display_name}"
-      target_user = User.find(:first, :conditions => [ "display_name = ?", 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
 
     end
 

-    opt = Hash.new
-    opt[:include] = [:user, :tags] # load users and tags from db at same time as traces
+    # set title
+    if target_user.nil?
+      @title = t 'trace.list.public_traces'
+    elsif @user and @user == target_user
+      @title = t 'trace.list.your_traces'
+    else
+      @title = t 'trace.list.public_traces_from', :user => target_user.display_name
+    end
+
+    @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)


@@ -31,40 +46,39 @@ 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 = ["(public = 1 OR user_id = ?)", @user.id] #1
+        conditions = ["(gpx_files.visibility in ('public', 'identifiable') OR gpx_files.user_id = ?)", @user.id] #1

       else
       else

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

       end
     else
       end
     else

-      if @user and @user.id == target_user.id
-        conditions = ["user_id = ?", @user.id] #3 (check vs user id, so no join + can't pick up non-public traces by changing name)
+      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
       else

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

       end
     end
       end
     end

-    conditions[0] += " AND users.display_name != ''" # users need to set display name before traces will be exposed

     
     

-    opt[:order] = 'timestamp DESC'

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

-      conditions[0] += " AND gpx_file_tags.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
     
     end
     

-    opt[:conditions] = conditions
+    conditions[0] += " AND gpx_files.visible = ?"
+    conditions << true

 
 

-    # count traces using all options except limit
-    @max_trace = Trace.count(opt)
-    @max_page = Integer((@max_trace + 1) / @traces_per_page) 
-    
-    # last step before fetch - add paging options
-    opt[:limit] = @traces_per_page
-    if page_index > 0
-      opt[:offset] = @traces_per_page * page_index
-    end
+    @trace_pages, @traces = paginate(:traces,
+                                     :include => [:user, :tags],
+                                     :conditions => conditions,
+                                     :order => "gpx_files.timestamp DESC",
+                                     :per_page => 20)

 
 

-    @traces = Trace.find(:all , opt)
-    

     # put together SET of tags across traces, for related links
     tagset = Hash.new
     if @traces
     # put together SET of tags across traces, for related links
     tagset = Hash.new
     if @traces


@@ -77,158 +91,300 @@ class TraceController < ApplicationController
     end
     
     # final helper vars for view
     end
     
     # final helper vars for view

-    @display_name = display_name
+    @action = action
+    @display_name = target_user.display_name if target_user

     @all_tags = tagset.values
     @all_tags = tagset.values

-    @paging_action = paging_action # the action that paging requests should route back to, e.g. 'list' or 'mine'
-    @page = page_index + 1 # nice 1-based external page numbers

   end
 
   def mine
   end
 
   def mine

-    if @user
-      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
     @trace = Trace.find(params[:id])
   end
 
   def view
     @trace = Trace.find(params[:id])

-    unless @trace.public
-      if @user
-        render :nothing, :status => :forbidden if @trace.user.id != @user.id
-      end
+
+    if @trace and @trace.visible? and
+       (@trace.public? or @trace.user == @user)
+      @title = t 'trace.view.title', :name => @trace.name
+    else
+      flash[:notice] = t 'trace.view.trace_not_found'
+      redirect_to :controller => 'trace', :action => 'list'

     end
     end

+  rescue ActiveRecord::RecordNotFound
+    flash[:notice] = t 'trace.view.trace_not_found'
+    redirect_to :controller => 'trace', :action => 'list'

   end
 
   def create
   end
 
   def create

-    name = params[:trace][:gpx_file].original_filename.gsub(/[^a-zA-Z0-9.]/, '_') # This makes sure filenames are sane
-
-    do_create(name, params[:trace][:tagstring], params[:trace][:description], params[:trace][:public]) do |f|
-      f.write(params[:trace][:gpx_file].read)
-    end
+    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
     end

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

   end
 
   def data
     trace = Trace.find(params[:id])
   end
 
   def data
     trace = Trace.find(params[:id])

-    if trace and (trace.public? or (@user and @user == trace.user))
-      send_file(trace.trace_name, :filename => "#{trace.id}#{trace.extension_name}", :type => trace.mime_type, :disposition => 'attachment')
+
+    if trace.visible? and (trace.public? or (@user and @user == trace.user))
+      if request.format == Mime::XML
+        send_file(trace.xml_file, :filename => "#{trace.id}.xml", :type => Mime::XML.to_s, :disposition => 'attachment')
+      else
+        send_file(trace.trace_name, :filename => "#{trace.id}#{trace.extension_name}", :type => trace.mime_type, :disposition => 'attachment')
+      end
+    else
+      render :nothing => true, :status => :not_found
+    end
+  rescue ActiveRecord::RecordNotFound
+    render :nothing => true, :status => :not_found
+  end
+
+  def edit
+    @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]
+        @trace.visibility = params[:trace][:visibility]
+        if @trace.save
+          redirect_to :action => 'view'
+        end        
+      end

     else
     else

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

     end
     end

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

   end
 
   end
 

-  def make_public
+  def delete

     trace = Trace.find(params[:id])
     trace = Trace.find(params[:id])

-    if @user and trace.user == @user and !trace.public
-      trace.public = true
-      trace.save
-      flash[:notice] = 'Track made public'
-      redirect_to :controller => 'trace', :action => 'view', :id => params[:id]
+
+    if @user and trace.user == @user
+      if request.post? and trace.visible?
+        trace.visible = false
+        trace.save
+        flash[:notice] = t 'trace.delete.scheduled_for_deletion'
+        redirect_to :controller => 'traces', :action => 'mine'
+      else
+        render :nothing => true, :status => :bad_request
+      end
+    else
+      render :nothing => true, :status => :forbidden

     end
     end

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

   end
 
   def georss
   end
 
   def georss

-    traces = Trace.find(:all, :conditions => ['public = true'], :order => 'timestamp DESC', :limit => 20)
+    conditions = ["gpx_files.visibility in ('public', 'identifiable')"]
+
+    if params[:display_name]
+      conditions[0] += " AND users.display_name = ?"
+      conditions << params[:display_name]
+    end
+
+    if params[:tag]
+      conditions[0] += " AND EXISTS (SELECT * FROM gpx_file_tags AS gft WHERE gft.gpx_id = gpx_files.id AND gft.tag = ?)"
+      conditions << params[:tag]
+    end
+
+    traces = Trace.find(:all, :include => :user, :conditions => conditions, 
+                        :order => "timestamp DESC", :limit => 20)

 
     rss = OSM::GeoRSS.new
 
 
     rss = OSM::GeoRSS.new
 

-    #def add(latitude=0, longitude=0, title_text='dummy title', url='http://www.example.com/', description_text='dummy description', timestamp=Time.now)

     traces.each do |trace|
     traces.each do |trace|

-      rss.add(trace.latitude, trace.longitude, trace.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)
+      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)

     end
 
     render :text => rss.to_s, :content_type => "application/rss+xml"
   end
 
   def picture
     end
 
     render :text => rss.to_s, :content_type => "application/rss+xml"
   end
 
   def picture

-    begin
-      trace = Trace.find(params[:id])
+    trace = Trace.find(params[:id])

 
 

+    if trace.inserted?

       if trace.public? or (@user and @user == trace.user)
       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
       end

-    rescue ActiveRecord::RecordNotFound
+    else

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

-    rescue
-      render :nothing => true, :status => :internal_server_error

     end
     end

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

   end
 
   def icon
   end
 
   def icon

-    begin
-      trace = Trace.find(params[:id])
+    trace = Trace.find(params[:id])

 
 

+    if trace.inserted?

       if trace.public? or (@user and @user == trace.user)
       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
       end

-    rescue ActiveRecord::RecordNotFound
+    else

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

-    rescue
-      render :nothing => true, :status => :internal_server_error

     end
     end

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

   end
 
   def api_details
   end
 
   def api_details

-    begin
-      trace = Trace.find(params[:id])
+    trace = Trace.find(params[:id])

 
 

-      if trace.public? or trace.user == @user
-        render :text => trace.to_xml.to_s, :content_type => "text/xml"
-      else
-        render :nothing => true, :status => :forbidden
-      end
-    rescue ActiveRecord::RecordNotFound
-      render :nothing => true, :status => :not_found
-    rescue
-      render :nothing => true, :status => :internal_server_error
+    if trace.public? or trace.user == @user
+      render :text => trace.to_xml.to_s, :content_type => "text/xml"
+    else
+      render :nothing => true, :status => :forbidden

     end
     end

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

   end
 
   def api_data
   end
 
   def api_data

-    render :action => 'data'
+    trace = Trace.find(params[:id])
+
+    if trace.public? or trace.user == @user
+      send_file(trace.trace_name, :filename => "#{trace.id}#{trace.extension_name}", :type => trace.mime_type, :disposition => 'attachment')
+    else
+      render :nothing => true, :status => :forbidden
+    end
+  rescue ActiveRecord::RecordNotFound
+    render :nothing => true, :status => :not_found

   end
 
   def api_create
   end
 
   def api_create

-    do_create(params[:filename], params[:tags], params[:description], true) do |f|
-      f.write(request.raw_post)
-    end
+    if request.post?
+      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 params[:file].respond_to?(:read)
+        do_create(params[:file], tags, description, visibility)

 
 

-    if @trace.id
-      render :nothing => true
+        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
     else

-      render :nothing => true, :status => :internal_server_error
+      render :nothing => true, :status => :method_not_allowed

     end
   end
 
 private
 
     end
   end
 
 private
 

-  def do_create(name, tags, description, public)
+  def do_create(file, tags, description, visibility)
+    # Sanitise the user's filename
+    name = file.original_filename.gsub(/[^a-zA-Z0-9.]/, '_')
+
+    # Get a temporary filename...

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

-    File.open(filename, "w") { |f| yield f }
+    # ...and save the uploaded file to that location
+    File.open(filename, "w") { |f| f.write(file.read) }
+
+    # 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

 
 

-    @trace = Trace.new({:name => name, :tagstring => tags,
-                        :description => description, :public => public})
-    @trace.inserted = false
-    @trace.user = @user
-    @trace.timestamp = Time.now
+      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)

 
 

-    if @trace.save
-      File.rename(filename, @trace.trace_name)
+        # Pass the exception on
+        raise
+      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

-      FileUtils.rm_f(filename)
+      @user.preferences.create(:k => "gps.trace.visibility", :v => visibility)

     end
     end

+    

   end
 
 end
   end
 
 end