]> git.openstreetmap.org Git - rails.git/blobdiff - app/controllers/trace_controller.rb
Fix rubocop issue
[rails.git] / app / controllers / trace_controller.rb
index dc4672858446c44b801dd501709dd1659684059d..105405ccfdad7e0fd11b525443a4786ed496f307 100644 (file)
 class TraceController < ApplicationController
-  before_filter :authorize_web  
-  before_filter :authorize, :only => [:api_details, :api_data, :api_create]
-  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 (target_user = nil)
+  def list
     # 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?
-      @display_name = display_name
-      target_user = User.find(:first, :conditions => [ "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
-    if target_user.nil?
-      @title = "public GPS traces"
-    elsif target_user.id == @user.id
-      @title = "your GPS traces"
-    else
-      @title = "public GPS traces from #{target_user.display_name}"
-    end
-
-    @title += " tagged with #{params[:tag]}" if params[:tag]
+    @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
 
-    opt = Hash.new
-    opt[:include] = [:user, :tags] # load users and tags from db at same time as traces
+    @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 
+    # 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
-        conditions = ["(public = 1 OR user_id = ?)", @user.id] #1
-      else
-        conditions  = ["public = 1"] #2
-      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)
-      else
-        conditions = ["public = 1 AND user_id = ?", target_user.id] #4
-      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]
-      conditions[0] += " AND gpx_file_tags.tag = ?"
-      conditions << @tag;
-    end
-    
-    opt[:conditions] = conditions
-    opt[: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)
 
-    @trace_pages, @traces = paginate(:traces, opt)
-    
     # 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
-    
+
     # final helper vars for view
-    @display_name = display_name
+    @target_user = target_user
+    @display_name = target_user.display_name if target_user
     @all_tags = tagset.values
   end
 
   def mine
-    if @user
-      list(@user) unless @user.nil?
-    else
-      redirect_to :controller => 'user', :action => 'login', :referer => request.request_uri
-    end
+    redirect_to :action => :list, :display_name => current_user.display_name
   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 && @trace.visible? &&
+       (@trace.public? || @trace.user == current_user)
+      @title = t "trace.view.title", :name => @trace.name
+    else
+      flash[:error] = t "trace.view.trace_not_found"
+      redirect_to :action => "list"
     end
   rescue ActiveRecord::RecordNotFound
-    render :nothing => true, :status => :not_found
+    flash[:error] = t "trace.view.trace_not_found"
+    redirect_to :action => "list"
   end
 
   def create
-    name = params[:trace][:gpx_file].original_filename.gsub(/[^a-zA-Z0-9.]/, '_') # This makes sure filenames are sane
+    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
 
-    do_create(name, params[:trace][:tagstring], params[:trace][:description], params[:trace][:public]) do |f|
-      f.write(params[:trace][:gpx_file].read)
-    end
+        if @trace.id
+          flash[:notice] = t "trace.create.trace_uploaded"
 
-    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 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 => 'mine'
+          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
+      @trace = Trace.new(:visibility => default_visibility)
     end
+
+    @title = t "trace.create.upload_trace"
   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? && (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
+        send_file(trace.trace_name, :filename => "#{trace.id}#{trace.extension_name}", :type => trace.mime_type, :disposition => "attachment")
+      end
     else
-      render :nothing, :status => :not_found
+      head :not_found
     end
+  rescue ActiveRecord::RecordNotFound
+    head :not_found
   end
 
-  def make_public
+  def edit
+    @trace = Trace.find(params[:id])
+
+    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.visibility = params[:trace][:visibility]
+        if @trace.save
+          redirect_to :action => "view", :display_name => current_user.display_name
+        end
+      end
+    end
+  rescue ActiveRecord::RecordNotFound
+    head :not_found
+  end
+
+  def delete
     trace = Trace.find(params[:id])
-    if @user and trace.user == @user and !trace.public
-      trace.public = true
+
+    if !trace.visible?
+      head :not_found
+    elsif current_user.nil? || trace.user != current_user
+      head :forbidden
+    else
+      trace.visible = false
       trace.save
-      flash[:notice] = 'Track made public'
-      redirect_to :controller => 'trace', :action => 'view', :id => params[:id]
+      flash[:notice] = t "trace.delete.scheduled_for_deletion"
+      redirect_to :action => :list, :display_name => current_user.display_name
     end
+  rescue ActiveRecord::RecordNotFound
+    head :not_found
   end
 
   def georss
-    traces = Trace.find(:all, :conditions => ['public = true'], :order => 'timestamp DESC', :limit => 20)
-
-    rss = OSM::GeoRSS.new
+    @traces = Trace.visible_to_all.visible
 
-    #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|
-      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)
+    if params[:display_name]
+      @traces = @traces.joins(:user).where(:users => { :display_name => params[:display_name] })
     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
-    begin
-      trace = Trace.find(params[:id])
+    trace = Trace.find(params[:id])
 
-      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
-        render :nothing, :status => :forbidden
+        head :forbidden
       end
-    rescue ActiveRecord::RecordNotFound
-      render :nothing => true, :status => :not_found
-    rescue
-      render :nothing => true, :status => :internal_server_error
+    else
+      head :not_found
     end
+  rescue ActiveRecord::RecordNotFound
+    head :not_found
   end
 
   def icon
-    begin
-      trace = Trace.find(params[:id])
+    trace = Trace.find(params[:id])
 
-      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
-        render :nothing, :status => :forbidden
+        head :forbidden
       end
-    rescue ActiveRecord::RecordNotFound
-      render :nothing => true, :status => :not_found
-    rescue
-      render :nothing => true, :status => :internal_server_error
+    else
+      head :not_found
     end
+  rescue ActiveRecord::RecordNotFound
+    head :not_found
   end
 
-  def api_details
-    begin
-      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"
-      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? || trace.user == current_user
+      render :xml => trace.to_xml.to_s
+    else
+      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
 
   def api_data
-    render :action => 'data'
+    trace = Trace.visible.find(params[:id])
+
+    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
+      head :forbidden
+    end
   end
 
   def api_create
-    do_create(params[:filename], params[:tags], params[:description], true) do |f|
-      f.write(request.raw_post)
+    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 @trace.id
-      render :nothing => true
+    if params[:file].respond_to?(:read)
+      do_create(params[:file], tags, description, visibility)
+
+      if @trace.id
+        render :plain => @trace.id.to_s
+      elsif @trace.valid?
+        head :internal_server_error
+      else
+        head :bad_request
+      end
     else
-      render :nothing => true, :status => :internal_server_error
+      head :bad_request
     end
   end
 
-private
+  private
+
+  def do_create(file, tags, description, visibility)
+    # Sanitise the user's filename
+    name = file.original_filename.gsub(/[^a-zA-Z0-9.]/, "_")
 
-  def do_create(name, tags, description, public)
+    # Get a temporary filename...
     filename = "/tmp/#{rand}"
 
-    File.open(filename, "w") { |f| yield f }
+    # ...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 => 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
 
-    @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 StandardError
+        # 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 = current_user.preferences.where(:k => "gps.trace.visibility").first
+      pref.v = visibility
+      pref.save
     else
-      FileUtils.rm_f(filename)
+      current_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 = 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