]> git.openstreetmap.org Git - rails.git/blobdiff - app/controllers/trace_controller.rb
Return GPX traces as application/gpx+xml instead of text/xml
[rails.git] / app / controllers / trace_controller.rb
index e6c732d2d3b760c29fbb48e4e685a32db37a56f0..d54778c6e52018ac5cf1d1d172acd944b67f20fc 100644 (file)
@@ -1,98 +1,94 @@
 class TraceController < ApplicationController
   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 :require_user, :only => [:mine, :create, :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]
+  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
-  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]
-    if target_user.nil? and !display_name.blank?
-      target_user = User.find(:first, :conditions => [ "visible = ? and display_name = ?", true, display_name])
+    if !display_name.blank?
+      target_user = User.active.where(:display_name => display_name).first
       if target_user.nil?
-        @not_found_user = display_name
-        render :action => 'no_such_user', :status => :not_found
+        render_unknown_user display_name
         return
       end
     end
 
     # set title
     if target_user.nil?
-      @title = "Public GPS traces"
+      @title = t 'trace.list.public_traces'
     elsif @user and @user == target_user
-      @title = "Your GPS traces"
+      @title = t 'trace.list.your_traces'
     else
-      @title = "Public GPS traces from #{target_user.display_name}"
+      @title = 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
-    # 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 = ["(gpx_files.public = ? OR gpx_files.user_id = ?)", true, @user.id] #1
+        @traces = Trace.visible_to(@user) #1
       else
-        conditions  = ["gpx_files.public = ?", true] #2
+        @traces = Trace.public #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)
+        @traces = @user.traces #3 (check vs user id, so no join + can't pick up non-public traces by changing name)
       else
-        conditions = ["gpx_files.public = ? AND gpx_files.user_id = ?", true, target_user.id] #4
+        @traces = target_user.traces.public #4
       end
     end
-    
-    if params[:tag]
-      @tag = params[: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
+    if params[:tag]
+      @traces = @traces.tagged(params[:tag])
     end
-    
-    conditions[0] += " AND gpx_files.visible = ?"
-    conditions << true
 
-    @trace_pages, @traces = paginate(:traces,
-                                     :include => [:user, :tags],
-                                     :conditions => conditions,
-                                     :order => "gpx_files.timestamp DESC",
-                                     :per_page => 20)
+    @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
-    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
-    
+
     # 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
-    list(@user, "mine")
+    redirect_to :action => :list, :display_name => @user.display_name
   end
 
   def view
@@ -100,134 +96,131 @@ class TraceController < ApplicationController
 
     if @trace and @trace.visible? and
        (@trace.public? or @trace.user == @user)
-      @title = "Viewing trace #{@trace.name}"
+      @title = t 'trace.view.title', :name => @trace.name
     else
-      flash[:notice] = "Trace not found!"
+      flash[:error] = t 'trace.view.trace_not_found'
       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
     if params[:trace]
       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])
+        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."
+          flash[:notice] = t 'trace.create.trace_uploaded'
+
+          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 => '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],
-                            :public => params[:trace][:public],
+                            :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}, :without_protection => true)
     end
+
+    @title = t 'trace.create.upload_trace'
   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 Acl.no_trace_download(request.remote_ip)
+        render :text => "", :status => :forbidden
+      elsif 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 :nothing => true, :status => :not_found
+      render :text => "", :status => :not_found
     end
   rescue ActiveRecord::RecordNotFound
-    render :nothing => true, :status => :not_found
+    render :text => "", :status => :not_found
   end
 
   def edit
     @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]
+        @trace.visibility = params[:trace][:visibility]
         if @trace.save
-          redirect_to :action => 'view'
-        end        
+          redirect_to :action => 'view', :display_name => @user.display_name
+        end
       end
     else
-      render :nothing => true, :status => :forbidden
+      render :text => "", :status => :forbidden
     end
   rescue ActiveRecord::RecordNotFound
-    render :nothing => true, :status => :not_found
+    render :text => "", :status => :not_found
   end
 
   def delete
     trace = Trace.find(params[:id])
 
     if @user and trace.user == @user
-      if request.post? and trace.visible?
+      if 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
-        render :nothing => true, :status => :bad_request
+        render :text => "", :status => :not_found
       end
     else
-      render :nothing => true, :status => :forbidden
+      render :text => "", :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 => true, :status => :bad_request
-      end
-    else
-      render :nothing => true, :status => :forbidden
-    end
-  rescue ActiveRecord::RecordNotFound
-    render :nothing => true, :status => :not_found
+    render :text => "", :status => :not_found
   end
 
   def georss
-    conditions = ["gpx_files.public = ?", true]
+    traces = Trace.public.visible
 
     if params[:display_name]
-      conditions[0] += " AND users.display_name = ?"
-      conditions << params[:display_name]
+      traces = traces.joins(:user).where(:users => {:display_name => 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.tagged(params[:tag])
     end
 
-    traces = Trace.find(:all, :include => :user, :conditions => conditions, 
-                        :order => "timestamp DESC", :limit => 20)
+    traces = traces.order("timestamp DESC")
+    traces = traces.limit(20)
+    traces = traces.includes(:user)
 
     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"
@@ -238,16 +231,16 @@ class TraceController < ApplicationController
 
     if trace.inserted?
       if trace.public? or (@user and @user == trace.user)
-        expires_in 7.days, :private => !trace.public, :public => trace.public
+        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 => true, :status => :forbidden
+        render :text => "", :status => :forbidden
       end
     else
-      render :nothing => true, :status => :not_found
+      render :text => "", :status => :not_found
     end
   rescue ActiveRecord::RecordNotFound
-    render :nothing => true, :status => :not_found
+    render :text => "", :status => :not_found
   end
 
   def icon
@@ -255,69 +248,107 @@ class TraceController < ApplicationController
 
     if trace.inserted?
       if trace.public? or (@user and @user == trace.user)
-        expires_in 7.days, :private => !trace.public, :public => trace.public
+        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 => true, :status => :forbidden
+        render :text => "", :status => :forbidden
       end
     else
-      render :nothing => true, :status => :not_found
+      render :text => "", :status => :not_found
     end
   rescue ActiveRecord::RecordNotFound
-    render :nothing => true, :status => :not_found
+    render :text => "", :status => :not_found
   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"
     else
-      render :nothing => true, :status => :forbidden
+      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
+
+      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
-  rescue ActiveRecord::RecordNotFound
-    render :nothing => true, :status => :not_found
   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 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 :nothing => true, :status => :forbidden
+      render :text => "", :status => :forbidden
     end
-  rescue ActiveRecord::RecordNotFound
-    render :nothing => true, :status => :not_found
   end
 
   def api_create
-    if request.post?
-      tags = params[:tags] || ""
-      description = params[:description] || ""
-      pub = params[:public] || false
-      
-      if params[:file].respond_to?(:read)
-        do_create(params[:file], tags, description, pub)
+    tags = params[:tags] || ""
+    description = params[:description] || ""
+    visibility = params[:visibility]
 
-        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
+    if visibility.nil?
+      if params[:public] && params[:public].to_i.nonzero?
+        visibility = "public"
       else
-        render :nothing => true, :status => :bad_request
+        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 :text => "", :status => :internal_server_error
+      else
+        render :text => "", :status => :bad_request
       end
     else
-      render :nothing => true, :status => :method_not_allowed
+      render :text => "", :status => :bad_request
     end
   end
 
 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.]/, '_')
 
@@ -325,7 +356,7 @@ private
     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
@@ -333,35 +364,68 @@ private
       :name => name,
       :tagstring => tags,
       :description => description,
-      :public => public,
+      :visibility => visibility,
       :inserted => true,
       :user => @user,
       :timestamp => Time.now.getutc
-    })
+    }, :without_protection => true)
+
+    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
 
-    # Save the trace object
-    if @trace.save
-      # Rename the temporary file to the final name
-      FileUtils.mv(filename, @trace.trace_name)
+      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)
 
-      # Clear the inserted flag to make the import daemon load the trace
-      @trace.inserted = false
-      @trace.save!
+        # 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
-      # Remove the file as we have failed to update the database
-      FileUtils.rm_f(filename)
+      @user.preferences.create(:k => "gps.trace.visibility", :v => visibility)
     end
-    
-    # Finally save whether the user marked the trace as being public
-    if @trace.public?
-      if @user.trace_public_default.nil?
-        @user.preferences.create(:k => "gps.trace.public", :v => "default")
-      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
-      pref = @user.trace_public_default
-      pref.destroy unless pref.nil?
+      "public"
     end
-    
   end
 
 end