Tidy up the note model a bit

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

diff --git a/app/controllers/trace_controller.rb b/app/controllers/trace_controller.rb
index 0467e66bac49028fff5a56f21c4d84b55fe1e8ba..2cd3117ddbbe0c9456d46e4d0359544a3d75caaf 100644 (file)
--- a/app/controllers/trace_controller.rb
+++ b/app/controllers/trace_controller.rb
@@ -1,63 +1,95 @@
 class TraceController < ApplicationController
   layout 'site'
 
 class TraceController < ApplicationController
   layout 'site'
 

-  before_filter :authorize_web  
-  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 :authorize_web
+  before_filter :set_locale
+  before_filter :require_user, :only => [:mine, :create, :edit, :delete]
+  before_filter :authorize, :only => [:api_create, :api_read, :api_update, :api_delete, :api_data]
+  before_filter :check_database_readable, :except => [:api_read, :api_data]
+  before_filter :check_database_writable, :only => [:create, :edit, :delete, :api_create, :api_update, :api_delete]
+  before_filter :check_api_readable, :only => [:api_read, :api_data]
+  before_filter :check_api_writable, :only => [:api_create, :api_update, :api_delete]
+  before_filter :require_allow_read_gpx, :only => [:api_read, :api_data]
+  before_filter :require_allow_write_gpx, :only => [:api_create, :api_update, :api_delete]
+  before_filter :offline_warning, :only => [:mine, :view]
+  before_filter :offline_redirect, :only => [:create, :edit, :delete, :data, :api_create, :api_delete, :api_data]
+  around_filter :api_call_handle_error, :only => [:api_create, :api_read, :api_update, :api_delete, :api_data]
+
+  caches_action :list, :unless => :logged_in?, :layout => false
+  caches_action :view, :layout => false
+  caches_action :georss, :layout => true
+  cache_sweeper :trace_sweeper, :only => [:create, :edit, :delete, :api_create, :api_update, :api_delete], :unless => STATUS == :database_offline
+  cache_sweeper :tracetag_sweeper, :only => [:create, :edit, :delete, :api_create, :api_update, :api_delete], :unless => STATUS == :database_offline
+

   # 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

-  def list(target_user = nil, action = "list")
+  def 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.blank?
-      target_user = User.find(:first, :conditions => [ "display_name = ?", display_name])
+    if !display_name.blank?
+      target_user = User.find(:first, :conditions => { :status => ["active", "confirmed"], :display_name => 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"
-    elsif @user and @user.id == target_user.id
-      @title = "Your GPS traces"
+      @title = t 'trace.list.public_traces'
+    elsif @user and @user == target_user
+      @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)
     # 2 - all traces, not logged in = all public traces
 
     # four main cases:
     # 1 - all traces, logged in = all public traces + all user's (i.e + all mine)
     # 2 - all traces, not logged in = all public traces

-    # 3 - user's traces, logged in as same user = all user's traces 
+    # 3 - user's traces, logged in as same user = all user's traces

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

       else
       else

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

       end
     else
       end
     else

-      if @user and @user.id == target_user.id
+      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.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 = 1 AND gpx_files.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

-    
+

     if params[:tag]
       @tag = params[:tag]
     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
     end

-    
-    conditions[0] += " AND gpx_files.visible = 1"

 
 

-    @trace_pages, @traces = paginate(:traces,
-                                     :include => [:user, :tags],
-                                     :conditions => conditions,
-                                     :order => "gpx_files.timestamp DESC",
-                                     :per_page => 20)
+    conditions[0] += " AND gpx_files.visible = ?"
+    conditions << true
+
+    @page = (params[:page] || 1).to_i
+    @page_size = 20
+
+    @traces = Trace.find(:all,
+                         :include => [:user, :tags],
+                         :conditions => conditions,
+                         :order => "gpx_files.timestamp DESC",
+                         :offset => (@page - 1) * @page_size,
+                         :limit => @page_size)

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


@@ -69,58 +101,69 @@ class TraceController < ApplicationController
         end
       end
     end
         end
       end
     end

-    
+

     # final helper vars for view
     # final helper vars for view

-    @action = action
+    @target_user = target_user

     @display_name = target_user.display_name if target_user
     @all_tags = tagset.values
   end
 
   def mine
     @display_name = target_user.display_name if target_user
     @all_tags = tagset.values
   end
 
   def mine

-    if @user
-      list(@user, "mine") unless @user.nil?
-    else
-      redirect_to :controller => 'user', :action => 'login', :referer => request.request_uri
-    end
+    redirect_to :action => :list, :display_name => @user.display_name

   end
 
   def view
     @trace = Trace.find(params[:id])
 
     if @trace and @trace.visible? and
   end
 
   def view
     @trace = Trace.find(params[:id])
 
     if @trace and @trace.visible? and

-       (@trace.public? or @trace.user.id == @user.id)
-      @title = "Viewing trace #{@trace.name}"
+       (@trace.public? or @trace.user == @user)
+      @title = t 'trace.view.title', :name => @trace.name

     else
     else

-      flash[:notice] = "Trace not found!"
+      flash[:error] = 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[:error] = 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 => ex
+          logger.debug ex
+        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'
+          if @user.traces.count(:conditions => { :inserted => false }) > 4
+            flash[:warning] = t 'trace.trace_header.traces_waiting', :count => @user.traces.count(:conditions => { :inserted => false })
+          end
+
+          redirect_to :action => :list, :display_name => @user.display_name
+        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
     else
       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")
+      @trace = Trace.new(:visibility => default_visibility)

     end
     end

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

   end
 
   def data
   end
 
   def data


@@ -133,7 +176,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


@@ -143,15 +186,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'
         if @trace.save
           redirect_to :action => 'view'

-        end        
+        end

       end
     else
       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


@@ -164,39 +209,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'
-        redirect_to :controller => 'traces', :action => 'mine'
+        flash[:notice] = t 'trace.delete.scheduled_for_deletion'
+        redirect_to :action => :list, :display_name => @user.display_name

       else
       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 = 1"]
+    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 = ?"


@@ -208,13 +234,13 @@ class TraceController < ApplicationController
       conditions << params[:tag]
     end
 
       conditions << params[:tag]
     end
 

-    traces = Trace.find(:all, :include => :user, :conditions => conditions, 
+    traces = Trace.find(:all, :include => :user, :conditions => conditions,

                         :order => "timestamp DESC", :limit => 20)
 
     rss = OSM::GeoRSS.new
 
     traces.each do |trace|
                         :order => "timestamp DESC", :limit => 20)
 
     rss = OSM::GeoRSS.new
 
     traces.each do |trace|

-      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)
+      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, :display_name => 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
 
     render :text => rss.to_s, :content_type => "application/rss+xml"


@@ -225,9 +251,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


@@ -241,9 +268,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


@@ -252,38 +280,88 @@ class TraceController < ApplicationController
     render :nothing => true, :status => :not_found
   end
 
     render :nothing => true, :status => :not_found
   end
 

-  def api_details
-    trace = Trace.find(params[:id])
+  def api_read
+    trace = Trace.find(params[:id], :conditions => { :visible => true })

 
     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
 
     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
+  end
+
+  def api_update
+    trace = Trace.find(params[:id], :conditions => { :visible => true })
+
+    if trace.user == @user
+      new_trace = Trace.from_xml(request.raw_post)
+
+      unless new_trace and new_trace.id == trace.id
+        raise OSM::APIBadUserInput.new("The id in the url (#{trace.id}) is not the same as provided in the xml (#{new_trace.id})")
+      end
+
+      trace.description = new_trace.description
+      trace.tags = new_trace.tags
+      trace.visibility = new_trace.visibility
+      trace.save!
+
+      render :nothing => true, :status => :ok
+    else
+      render :nothing => true, :status => :forbidden
+    end
+  end
+
+  def api_delete
+    trace = Trace.find(params[:id], :conditions => { :visible => true })
+
+    if trace.user == @user
+      trace.visible = false
+      trace.save!
+
+      render :nothing => true, :status => :ok
+    else
+      render :nothing => true, :status => :forbidden
+    end

   end
 
   def api_data
     trace = Trace.find(params[:id])
 
     if trace.public? or trace.user == @user
   end
 
   def api_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')
+      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 => :forbidden
     end
     else
       render :nothing => true, :status => :forbidden
     end

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

   end
 
   def api_create
     if request.post?
   end
 
   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 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
+        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


@@ -294,22 +372,83 @@ 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
+
+      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
+
+    # 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
+      @user.preferences.create(:k => "gps.trace.visibility", :v => visibility)
+    end
+
+  end
+
+  def offline_warning
+    flash.now[:warning] = t 'trace.offline_warning.message' if STATUS == :gpx_offline
+  end
+
+  def offline_redirect
+    redirect_to :action => :offline if STATUS == :gpx_offline
+  end
+
+  def default_visibility
+    visibility = @user.preferences.find(:first, :conditions => {:k => "gps.trace.visibility"})

 
 

-    if @trace.save
-      FileUtils.mv(filename, @trace.trace_name)
+    if visibility
+      visibility.v
+    elsif @user.preferences.find(:first, :conditions => {:k => "gps.trace.public", :v => "default"}).nil?
+      "private"

     else
     else

-      FileUtils.rm_f(filename)
+      "public"

     end
   end
 
     end
   end