Improve code readability

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

diff --git a/app/controllers/trace_controller.rb b/app/controllers/trace_controller.rb
index f7f323e9c5af550a7284b7c63f6f4598a82c102e..60b5a4585330309f5c7aa1bf873ae6e5fe220dea 100644 (file)
--- a/app/controllers/trace_controller.rb
+++ b/app/controllers/trace_controller.rb
@@ -1,51 +1,418 @@
 class TraceController < ApplicationController
 class TraceController < ApplicationController

-  before_filter :authorize_web  
-  layout 'site'
+  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

   def list
   def list

-    @traces = Trace.find(:all, :conditions => ['public = true'])
+    # from display name, pick up user id if one user's traces only
+    display_name = params[:display_name]
+    unless display_name.blank?
+      target_user = User.active.where(:display_name => display_name).first
+      if target_user.nil?
+        render_unknown_user display_name
+        return
+      end
+    end
+
+    # set title
+    @title = if target_user.nil?
+               t "trace.list.public_traces"
+             elsif @user && @user == target_user
+               t "trace.list.your_traces"
+             else
+               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)
+    # 2 - all traces, not logged in = all public 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
+    @traces = if target_user.nil? # all traces
+                if @user
+                  Trace.visible_to(@user) # 1
+                else
+                  Trace.visible_to_all # 2
+                end
+              elsif @user && @user == target_user
+                @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]
+
+    @page = (params[:page] || 1).to_i
+    @page_size = 20
+
+    @traces = @traces.visible
+    @traces = @traces.order("timestamp 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
+    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
+
+    # final helper vars for view
+    @target_user = target_user
+    @display_name = target_user.display_name if target_user
+    @all_tags = tagset.values

   end
 
   def mine
   end
 
   def mine

-    @traces = Trace.find(:all, :conditions => ['user_id = ?', @user.id])
+    redirect_to :action => :list, :display_name => @user.display_name

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

-    unless @trace.public
-      if @user
-        render :nothing, :status => 401 if @trace.user.id != @user.id
-      end
+
+    if @trace && @trace.visible? &&
+       (@trace.public? || @trace.user == @user)
+      @title = t "trace.view.title", :name => @trace.name
+    else
+      flash[:error] = t "trace.view.trace_not_found"
+      redirect_to :controller => "trace", :action => "list"

     end
     end

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

   end
 
   def create
   end
 
   def create

-    filename = "/tmp/#{rand}"
+    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
+          flash[:notice] = t "trace.create.trace_uploaded"
+
+          if @user.traces.where(:inserted => false).count > 4
+            flash[:warning] = t "trace.trace_header.traces_waiting", :count => @user.traces.where(:inserted => false).count
+          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
+      @trace = Trace.new(:visibility => default_visibility)
+    end
+
+    @title = t "trace.create.upload_trace"
+  end
+
+  def data
+    trace = Trace.find(params[:id])

 
 

-    File.open(filename, "w") { |f| f.write(@params['trace']['gpx_file'].read) }
-    @params['trace']['name'] = @params['trace']['gpx_file'].original_filename.gsub(/[^a-zA-Z0-9.]/, '_') # This makes sure filenames are sane
-    @params['trace'].delete('gpx_file') # let's remove the field from the hash, because there's no such field in the DB anyway.
-    @trace = Trace.new(@params['trace'])
-    @trace.inserted = false
-    @trace.user_id = @user.id
-    @trace.timestamp = Time.now
-    if @trace.save
-      logger.info("id is #{@trace.id}")
-      `mv #{filename} /tmp/#{@trace.id}.gpx`
-      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.visible? && (trace.public? || (@user && @user == trace.user))
+      if Acl.no_trace_download(request.remote_ip)
+        render :text => "", :status => :forbidden
+      elsif request.format == Mime::XML
+        send_file(trace.xml_file, :filename => "#{trace.id}.xml", :type => request.format.to_s, :disposition => "attachment")
+      elsif request.format == Mime::GPX
+        send_file(trace.xml_file, :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
+      render :text => "", :status => :not_found
+    end
+  rescue ActiveRecord::RecordNotFound
+    render :text => "", :status => :not_found
+  end
+
+  def edit
+    @trace = Trace.find(params[:id])
+
+    if !@trace.visible?
+      render :text => "", :status => :not_found
+    elsif @user.nil? || @trace.user != @user
+      render :text => "", :status => :forbidden
+    else
+      @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", :display_name => @user.display_name
+        end
+      end
+    end
+  rescue ActiveRecord::RecordNotFound
+    render :text => "", :status => :not_found
+  end
+
+  def delete
+    trace = Trace.find(params[:id])
+
+    if !trace.visible?
+      render :text => "", :status => :not_found
+    elsif @user.nil? || trace.user != @user
+      render :text => "", :status => :forbidden
+    else
+      trace.visible = false
+      trace.save
+      flash[:notice] = t "trace.delete.scheduled_for_deletion"
+      redirect_to :action => :list, :display_name => @user.display_name
+    end
+  rescue ActiveRecord::RecordNotFound
+    render :text => "", :status => :not_found
+  end
+
+  def georss
+    @traces = Trace.visible_to_all.visible
+
+    if params[:display_name]
+      @traces = @traces.joins(:user).where(:users => { :display_name => params[:display_name] })

     end
 
     end
 

-    redirect_to :action => 'mine'
+    @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])

-    send_data(trace.large_picture, :filename => "#{trace.id}.gif", :type => 'image/png', :disposition => 'inline') if trace.public
+
+    if trace.visible? && trace.inserted?
+      if trace.public? || (@user && @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
+        render :text => "", :status => :forbidden
+      end
+    else
+      render :text => "", :status => :not_found
+    end
+  rescue ActiveRecord::RecordNotFound
+    render :text => "", :status => :not_found

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

-    send_data(trace.icon_picture, :filename => "#{trace.id}.gif", :type => 'image/gif', :disposition => 'inline') if trace.public
+
+    if trace.visible? && trace.inserted?
+      if trace.public? || (@user && @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
+        render :text => "", :status => :forbidden
+      end
+    else
+      render :text => "", :status => :not_found
+    end
+  rescue ActiveRecord::RecordNotFound
+    render :text => "", :status => :not_found

   end
 
   end
 

+  def api_read
+    trace = Trace.visible.find(params[:id])
+
+    if trace.public? || trace.user == @user
+      render :text => trace.to_xml.to_s, :content_type => "text/xml"
+    else
+      render :text => "", :status => :forbidden
+    end
+  end
+
+  def api_update
+    trace = Trace.visible.find(params[:id])
+
+    if trace.user == @user
+      new_trace = Trace.from_xml(request.raw_post)
+
+      unless new_trace && 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 :text => "", :status => :ok
+    else
+      render :text => "", :status => :forbidden
+    end
+  end
+
+  def api_delete
+    trace = Trace.visible.find(params[:id])
+
+    if trace.user == @user
+      trace.visible = false
+      trace.save!
+
+      render :text => "", :status => :ok
+    else
+      render :text => "", :status => :forbidden
+    end
+  end
+
+  def api_data
+    trace = Trace.visible.find(params[:id])
+
+    if trace.public? || trace.user == @user
+      if request.format == Mime::XML
+        send_file(trace.xml_file, :filename => "#{trace.id}.xml", :type => request.format.to_s, :disposition => "attachment")
+      elsif request.format == Mime::GPX
+        send_file(trace.xml_file, :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
+      render :text => "", :status => :forbidden
+    end
+  end
+
+  def api_create
+    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
+        render :text => @trace.id.to_s, :content_type => "text/plain"
+      elsif @trace.valid?
+        render :text => "", :status => :internal_server_error
+      else
+        render :text => "", :status => :bad_request
+      end
+    else
+      render :text => "", :status => :bad_request
+    end
+  end
+
+  private
+
+  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}"
+
+    # ...and save the uploaded file to that location
+    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
+    @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 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 = @user.preferences.where(:k => "gps.trace.visibility").first
+      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.where(:k => "gps.trace.visibility").first
+
+    if visibility
+      visibility.v
+    elsif @user.preferences.where(:k => "gps.trace.public", :v => "default").first.nil?
+      "private"
+    else
+      "public"
+    end
+  end

 end
 end