Fix rubocop issue

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

diff --git a/app/controllers/trace_controller.rb b/app/controllers/trace_controller.rb
index 3942cb7fe3d8964eb80eb7733eacee0f9c490de3..105405ccfdad7e0fd11b525443a4786ed496f307 100644 (file)
--- a/app/controllers/trace_controller.rb
+++ b/app/controllers/trace_controller.rb
@@ -1,333 +1,412 @@
 class TraceController < ApplicationController
 class TraceController < ApplicationController

-  layout 'site'
-
-  before_filter :authorize_web  
-  before_filter :require_user, :only => [:mine, :edit, :delete, :make_public]
-  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, :make_public]
-  before_filter :check_api_readable, :only => [:api_details, :api_data]
-  before_filter :check_api_writable, :only => [:api_create]
- 
+  layout "site", :except => :georss
+
+  skip_before_action :verify_authenticity_token, :only => [:api_create, :api_read, :api_update, :api_delete, :api_data]
+  before_action :authorize_web
+  before_action :set_locale
+  before_action :require_user, :only => [:mine, :create, :edit, :delete]
+  before_action :authorize, :only => [:api_create, :api_read, :api_update, :api_delete, :api_data]
+  before_action :check_database_readable, :except => [:api_read, :api_data]
+  before_action :check_database_writable, :only => [:create, :edit, :delete, :api_create, :api_update, :api_delete]
+  before_action :check_api_readable, :only => [:api_read, :api_data]
+  before_action :check_api_writable, :only => [:api_create, :api_update, :api_delete]
+  before_action :require_allow_read_gpx, :only => [:api_read, :api_data]
+  before_action :require_allow_write_gpx, :only => [:api_create, :api_update, :api_delete]
+  before_action :offline_warning, :only => [:mine, :view]
+  before_action :offline_redirect, :only => [:create, :edit, :delete, :data, :api_create, :api_delete, :api_data]
+  around_action :api_call_handle_error, :only => [:api_create, :api_read, :api_update, :api_delete, :api_data]
+

   # 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 => [ "visible = 1 and display_name = ?", display_name])
+    if display_name.present?
+      target_user = User.active.where(:display_name => display_name).first
+      if target_user.nil?
+        render_unknown_user display_name
+        return
+      end

     end
 
     # set title
     end
 
     # set title

-    if target_user.nil?
-      @title = "Public GPS traces"
-    elsif @user and @user == target_user
-      @title = "Your GPS traces"
-    else
-      @title = "Public GPS traces from #{target_user.display_name}"
-    end
+    @title = if target_user.nil?
+               t "trace.list.public_traces"
+             elsif current_user && current_user == target_user
+               t "trace.list.your_traces"
+             else
+               t "trace.list.public_traces_from", :user => target_user.display_name
+             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
     # 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
-      else
-        conditions  = ["gpx_files.public = 1"] #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
-        conditions = ["gpx_files.public = 1 AND gpx_files.user_id = ?", target_user.id] #4
-      end
-    end
-    
-    if params[:tag]
-      @tag = params[:tag]
-
-      files = Tracetag.find_all_by_tag(params[:tag]).collect { |tt| tt.gpx_id }
-      conditions[0] += " AND gpx_files.id IN (#{files.join(',')})"
-    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)
+    @traces = if target_user.nil? # all traces
+                if current_user
+                  Trace.visible_to(current_user) # 1
+                else
+                  Trace.visible_to_all # 2
+                end
+              elsif current_user && current_user == target_user
+                current_user.traces # 3 (check vs user id, so no join + can't pick up non-public traces by changing name)
+              else
+                target_user.traces.visible_to_all # 4
+              end
+
+    @traces = @traces.tagged(params[:tag]) if params[:tag]
+
+    @params = params.permit(:display_name, :tag)
+
+    @page = (params[:page] || 1).to_i
+    @page_size = 20
+
+    @traces = @traces.visible
+    @traces = @traces.order(:id => :desc)
+    @traces = @traces.offset((@page - 1) * @page_size)
+    @traces = @traces.limit(@page_size)
+    @traces = @traces.includes(:user, :tags)

 
     # put together SET of tags across traces, for related links
 
     # put together SET of tags across traces, for related links

-    tagset = Hash.new
-    if @traces
-      @traces.each do |trace|
-        trace.tags.reload if params[:tag] # if searched by tag, ActiveRecord won't bring back other tags, so do explicitly here
-        trace.tags.each do |tag|
-          tagset[tag.tag] = tag.tag
-        end
+    tagset = {}
+    @traces.each do |trace|
+      trace.tags.reload if params[:tag] # if searched by tag, ActiveRecord won't bring back other tags, so do explicitly here
+      trace.tags.each do |tag|
+        tagset[tag.tag] = tag.tag

       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

-    list(@user, "mine")
+    redirect_to :action => :list, :display_name => current_user.display_name

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

-    if @trace and @trace.visible? and
-       (@trace.public? or @trace.user == @user)
-      @title = "Viewing trace #{@trace.name}"
+    if @trace && @trace.visible? &&
+       (@trace.public? || @trace.user == current_user)
+      @title = t "trace.view.title", :name => @trace.name

     else
     else

-      flash[:notice] = "Trace not found!"
-      redirect_to :controller => 'trace', :action => 'list'
+      flash[:error] = t "trace.view.trace_not_found"
+      redirect_to :action => "list"

     end
   rescue ActiveRecord::RecordNotFound
     end
   rescue ActiveRecord::RecordNotFound

-    flash[:notice] = "Trace not found!"
-    redirect_to :controller => 'trace', :action => 'list'
+    flash[:error] = t "trace.view.trace_not_found"
+    redirect_to :action => "list"

   end
 
   def create
   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 request.post?
+      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 StandardError => 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
+          flash[:notice] = t "trace.create.trace_uploaded"

 
 

-        redirect_to :action => 'mine'
+          if current_user.traces.where(:inserted => false).count > 4
+            flash[:warning] = t "trace.trace_header.traces_waiting", :count => current_user.traces.where(:inserted => false).count
+          end
+
+          redirect_to :action => :list, :display_name => current_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 => current_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
     trace = Trace.find(params[:id])
 
   end
 
   def data
     trace = Trace.find(params[:id])
 

-    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')
+    if trace.visible? && (trace.public? || (current_user && current_user == trace.user))
+      if Acl.no_trace_download(request.remote_ip)
+        head :forbidden
+      elsif request.format == Mime[:xml]
+        send_data(trace.xml_file.read, :filename => "#{trace.id}.xml", :type => request.format.to_s, :disposition => "attachment")
+      elsif request.format == Mime[:gpx]
+        send_data(trace.xml_file.read, :filename => "#{trace.id}.gpx", :type => request.format.to_s, :disposition => "attachment")

       else
       else

-        send_file(trace.trace_name, :filename => "#{trace.id}#{trace.extension_name}", :type => trace.mime_type, :disposition => 'attachment')
+        send_file(trace.trace_name, :filename => "#{trace.id}#{trace.extension_name}", :type => trace.mime_type, :disposition => "attachment")

       end
     else
       end
     else

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

     end
   rescue ActiveRecord::RecordNotFound
     end
   rescue ActiveRecord::RecordNotFound

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

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

-    if @user and @trace.user == @user
-      if params[:trace]
+    if !@trace.visible?
+      head :not_found
+    elsif current_user.nil? || @trace.user != current_user
+      head :forbidden
+    else
+      @title = t "trace.edit.title", :name => @trace.name
+
+      if request.post? && params[:trace]

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

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

         if @trace.save
         if @trace.save

-          redirect_to :action => 'view'
-        end        
+          redirect_to :action => "view", :display_name => current_user.display_name
+        end

       end
       end

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

     end
   rescue ActiveRecord::RecordNotFound
     end
   rescue ActiveRecord::RecordNotFound

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

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

-    if @user and trace.user == @user
-      if request.post? and trace.visible?
-        trace.visible = false
-        trace.save
-        flash[:notice] = 'Track scheduled for deletion'
-        redirect_to :controller => 'traces', :action => 'mine'
-      else
-        render :nothing => true, :status => :bad_request
-      end
+    if !trace.visible?
+      head :not_found
+    elsif current_user.nil? || trace.user != current_user
+      head :forbidden

     else
     else

-      render :nothing => true, :status => :forbidden
+      trace.visible = false
+      trace.save
+      flash[:notice] = t "trace.delete.scheduled_for_deletion"
+      redirect_to :action => :list, :display_name => current_user.display_name

     end
   rescue ActiveRecord::RecordNotFound
     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 => true, :status => :bad_request
-      end
-    else
-      render :nothing => true, :status => :forbidden
-    end
-  rescue ActiveRecord::RecordNotFound
-    render :nothing => true, :status => :not_found
+    head :not_found

   end
 
   def georss
   end
 
   def georss

-    conditions = ["gpx_files.public = 1"]
+    @traces = Trace.visible_to_all.visible

 
     if params[:display_name]
 
     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]
+      @traces = @traces.joins(:user).where(:users => { :display_name => params[:display_name] })

     end
 
     end
 

-    traces = Trace.find(:all, :include => :user, :conditions => conditions, 
-                        :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)
-    end
-
-    render :text => rss.to_s, :content_type => "application/rss+xml"
+    @traces = @traces.tagged(params[:tag]) if params[:tag]
+    @traces = @traces.order("timestamp DESC")
+    @traces = @traces.limit(20)
+    @traces = @traces.includes(:user)

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

-    if trace.inserted?
-      if trace.public? or (@user and @user == trace.user)
-        send_file(trace.large_picture_name, :filename => "#{trace.id}.gif", :type => 'image/gif', :disposition => 'inline')
+    if trace.visible? && trace.inserted?
+      if trace.public? || (current_user && current_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
       else

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

       end
     else
       end
     else

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

     end
   rescue ActiveRecord::RecordNotFound
     end
   rescue ActiveRecord::RecordNotFound

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

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

-    if trace.inserted?
-      if trace.public? or (@user and @user == trace.user)
-        send_file(trace.icon_picture_name, :filename => "#{trace.id}_icon.gif", :type => 'image/gif', :disposition => 'inline')
+    if trace.visible? && trace.inserted?
+      if trace.public? || (current_user && current_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
       else

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

       end
     else
       end
     else

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

     end
   rescue ActiveRecord::RecordNotFound
     end
   rescue ActiveRecord::RecordNotFound

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

   end
 
   end
 

-  def api_details
-    trace = Trace.find(params[:id])
+  def api_read
+    trace = Trace.visible.find(params[:id])

 
 

-    if trace.public? or trace.user == @user
-      render :text => trace.to_xml.to_s, :content_type => "text/xml"
+    if trace.public? || trace.user == current_user
+      render :xml => trace.to_xml.to_s

     else
     else

-      render :nothing => true, :status => :forbidden
+      head :forbidden
+    end
+  end
+
+  def api_update
+    trace = Trace.visible.find(params[:id])
+
+    if trace.user == current_user
+      trace.update_from_xml(request.raw_post)
+      trace.save!
+
+      head :ok
+    else
+      head :forbidden
+    end
+  end
+
+  def api_delete
+    trace = Trace.visible.find(params[:id])
+
+    if trace.user == current_user
+      trace.visible = false
+      trace.save!
+
+      head :ok
+    else
+      head :forbidden

     end
     end

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

   end
 
   def api_data
   end
 
   def api_data

-    trace = Trace.find(params[:id])
+    trace = Trace.visible.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 trace.public? || trace.user == current_user
+      if request.format == Mime[:xml]
+        send_data(trace.xml_file.read, :filename => "#{trace.id}.xml", :type => request.format.to_s, :disposition => "attachment")
+      elsif request.format == Mime[:gpx]
+        send_data(trace.xml_file.read, :filename => "#{trace.id}.gpx", :type => request.format.to_s, :disposition => "attachment")
+      else
+        send_file(trace.trace_name, :filename => "#{trace.id}#{trace.extension_name}", :type => trace.mime_type, :disposition => "attachment")
+      end

     else
     else

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

     end
     end

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

   end
 
   def api_create
   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?
+      visibility = if params[:public] && params[:public].to_i.nonzero?
+                     "public"
+                   else
+                     "private"
+                   end
+    end
+
+    if params[:file].respond_to?(:read)
+      do_create(params[:file], tags, description, visibility)

 
       if @trace.id
 
       if @trace.id

-        render :text => @trace.id.to_s, :content_type => "text/plain"
+        render :plain => @trace.id.to_s

       elsif @trace.valid?
       elsif @trace.valid?

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

       else
       else

-        render :nothing => true, :status => :bad_request
+        head :bad_request

       end
     else
       end
     else

-      render :nothing => true, :status => :method_not_allowed
+      head :bad_request

     end
   end
 
     end
   end
 

-private
+  private

 
 

-  def do_create(file, tags, description, public)
+  def do_create(file, tags, description, visibility)

     # Sanitise the user's filename
     # 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}"
 
     # ...and save the uploaded file to that location
 
     # Get a temporary filename...
     filename = "/tmp/#{rand}"
 
     # ...and save the uploaded file to that location

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

 
     # Create the trace object, falsely marked as already
     # inserted to stop the import daemon trying to load it
 
     # Create the trace object, falsely marked as already
     # inserted to stop the import daemon trying to load it

-    @trace = Trace.new({
+    @trace = Trace.new(

       :name => name,
       :tagstring => tags,
       :description => description,
       :name => name,
       :tagstring => tags,
       :description => description,

-      :public => public,
+      :visibility => visibility,

       :inserted => true,
       :inserted => true,

-      :user => @user,
-      :timestamp => Time.now
-    })
-
-    # Save the trace object
-    if @trace.save
-      # Rename the temporary file to the final name
-      FileUtils.mv(filename, @trace.trace_name)
-
-      # Clear the inserted flag to make the import daemon load the trace
-      @trace.inserted = false
-      @trace.save!
+      :user => current_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 StandardError
+        # 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 StandardError
+        # 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 = current_user.preferences.where(:k => "gps.trace.visibility").first
+      pref.v = visibility
+      pref.save

     else
     else

-      # Remove the file as we have failed to update the database
-      FileUtils.rm_f(filename)
+      current_user.preferences.create(:k => "gps.trace.visibility", :v => visibility)

     end
   end
 
     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 = current_user.preferences.where(:k => "gps.trace.visibility").first
+
+    if visibility
+      visibility.v
+    elsif current_user.preferences.where(:k => "gps.trace.public", :v => "default").first.nil?
+      "private"
+    else
+      "public"
+    end
+  end

 end
 end