Refactor MQ/OSRM engines a la @karussell patch

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

diff --git a/app/controllers/trace_controller.rb b/app/controllers/trace_controller.rb
index dc4672858446c44b801dd501709dd1659684059d..9c4a9d8bd18952816f0f267aacec2d378a3a61fc 100644 (file)
--- a/app/controllers/trace_controller.rb
+++ b/app/controllers/trace_controller.rb
@@ -1,227 +1,425 @@
 class TraceController < ApplicationController
 class TraceController < ApplicationController

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

   layout 'site'
   layout 'site'

- 
+
+  skip_before_filter :verify_authenticity_token, :only => [:api_create, :api_read, :api_update, :api_delete, :api_data]
+  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]
+

   # 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)
+  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?
-      @display_name = display_name
-      target_user = User.find(:first, :conditions => [ "display_name = ?", display_name])
+    if !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
     if target_user.nil?
     end
 
     # set title
     if target_user.nil?

-      @title = "public GPS traces"
-    elsif target_user.id == @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]
-
-    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
 
     # 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 = ["(public = 1 OR user_id = ?)", @user.id] #1
+        @traces = Trace.visible_to(@user) #1

       else
       else

-        conditions  = ["public = 1"] #2
+        @traces = Trace.public #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
+        @traces = @user.traces #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
+        @traces = target_user.traces.public #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]
     if params[:tag]

-      @tag = params[:tag]
-      conditions[0] += " AND gpx_file_tags.tag = ?"
-      conditions << @tag;
+      @traces = @traces.tagged(params[:tag])

     end
     end

-    
-    opt[:conditions] = conditions
-    opt[:per_page] = 20

 
 

-    @trace_pages, @traces = paginate(:traces, opt)
-    
+    @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 = Hash.new
     # 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
+    @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

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

     @all_tags = tagset.values
   end
 
   def mine
     @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 => @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 => :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[:error] = t 'trace.view.trace_not_found'
+      redirect_to :controller => 'trace', :action => 'list'

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

-    render :nothing => true, :status => :not_found
+    flash[:error] = 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
+    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

 
 

-    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
+          logger.info("id is #{@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 @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 => 'mine'
+          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
     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 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
     else

-      render :nothing, :status => :not_found
+      render :text => "", :status => :not_found
+    end
+  rescue ActiveRecord::RecordNotFound
+    render :text => "", :status => :not_found
+  end
+
+  def edit
+    @trace = Trace.find(params[:id])
+
+    if not @trace.visible?
+      render :text => "", :status => :not_found
+    elsif @user.nil? or @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
     end

+  rescue ActiveRecord::RecordNotFound
+    render :text => "", :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
+
+    if not trace.visible?
+      render :text => "", :status => :not_found
+    elsif @user.nil? or trace.user != @user
+      render :text => "", :status => :forbidden
+    else
+      trace.visible = false

       trace.save
       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 => @user.display_name

     end
     end

+  rescue ActiveRecord::RecordNotFound
+    render :text => "", :status => :not_found

   end
 
   def georss
   end
 
   def georss

-    traces = Trace.find(:all, :conditions => ['public = true'], :order => 'timestamp DESC', :limit => 20)
+    @traces = Trace.public.visible

 
 

-    rss = OSM::GeoRSS.new
+    if params[:display_name]
+      @traces = @traces.joins(:user).where(:users => {:display_name => params[:display_name]})
+    end

 
 

-    #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[:tag]
+      @traces = @traces.tagged(params[:tag])

     end
 
     end
 

-    render :text => rss.to_s, :content_type => "application/rss+xml"
+    @traces = @traces.order("timestamp DESC")
+    @traces = @traces.limit(20)
+    @traces = @traces.includes(:user)

   end
 
   def picture
   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 :text => "", :status => :forbidden

       end
       end

-    rescue ActiveRecord::RecordNotFound
-      render :nothing => true, :status => :not_found
-    rescue
-      render :nothing => true, :status => :internal_server_error
+    else
+      render :text => "", :status => :not_found

     end
     end

+  rescue ActiveRecord::RecordNotFound
+    render :text => "", :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 :text => "", :status => :forbidden

       end
       end

-    rescue ActiveRecord::RecordNotFound
-      render :nothing => true, :status => :not_found
-    rescue
-      render :nothing => true, :status => :internal_server_error
+    else
+      render :text => "", :status => :not_found

     end
     end

+  rescue ActiveRecord::RecordNotFound
+    render :text => "", :status => :not_found

   end
 
   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
+    if trace.public? or 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 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
       end

-    rescue ActiveRecord::RecordNotFound
-      render :nothing => true, :status => :not_found
-    rescue
-      render :nothing => true, :status => :internal_server_error
+
+      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
     end
   end
 
   def api_data

-    render :action => 'data'
+    trace = Trace.find(params[:id])
+
+    if trace.public? or trace.user == @user
+      if request.format == Mime::XML or request.format == Mime::GPX
+        send_file(trace.xml_file, :filename => "#{trace.id}.xml", :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
   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?
+      if params[:public] && params[:public].to_i.nonzero?
+        visibility = "public"
+      else
+        visibility = "private"
+      end

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

-      render :nothing => true, :status => :internal_server_error
+      render :text => "", :status => :bad_request

     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, "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 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.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

 
 

-    @trace = Trace.new({:name => name, :tagstring => tags,
-                        :description => description, :public => public})
-    @trace.inserted = false
-    @trace.user = @user
-    @trace.timestamp = Time.now
+  def default_visibility
+    visibility = @user.preferences.where(:k => "gps.trace.visibility").first

 
 

-    if @trace.save
-      File.rename(filename, @trace.trace_name)
+    if visibility
+      visibility.v
+    elsif @user.preferences.where(:k => "gps.trace.public", :v => "default").first.nil?
+      "private"

     else
     else

-      FileUtils.rm_f(filename)
+      "public"

     end
   end
 
     end
   end