jro_apps/redmine Commit - r10467:251f263abdc5

Let the attachment filename be specified on upload (#12125)....

Jean-Philippe Lang -

r10467:251f263abdc5

parent child

Context file:

r10467:251f263abdc5

Collapse all files

app/controllers/attachments_controller.rb +1 -1

             # Redmine - project management software
             # Copyright (C) 2006-2012  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             class AttachmentsController < ApplicationController
               before_filter :find_project, :except => :upload
               before_filter :file_readable, :read_authorize, :only => [:show, :download, :thumbnail]
               before_filter :delete_authorize, :only => :destroy
               before_filter :authorize_global, :only => :upload
               accept_api_auth :show, :download, :upload
               def show
                 respond_to do |format|
                   format.html {
                     if @attachment.is_diff?
                       @diff = File.new(@attachment.diskfile, "rb").read
                       @diff_type = params[:type] || User.current.pref[:diff_type] || 'inline'
                       @diff_type = 'inline' unless %w(inline sbs).include?(@diff_type)
                       # Save diff type as user preference
                       if User.current.logged? && @diff_type != User.current.pref[:diff_type]
                         User.current.pref[:diff_type] = @diff_type
                         User.current.preference.save
                       end
                       render :action => 'diff'
                     elsif @attachment.is_text? && @attachment.filesize <= Setting.file_max_size_displayed.to_i.kilobyte
                       @content = File.new(@attachment.diskfile, "rb").read
                       render :action => 'file'
                     else
                       download
                     end
                   }
                   format.api
                 end
               end
               def download
                 if @attachment.container.is_a?(Version) || @attachment.container.is_a?(Project)
                   @attachment.increment_download
                 end
                 if stale?(:etag => @attachment.digest)
                   # images are sent inline
                   send_file @attachment.diskfile, :filename => filename_for_content_disposition(@attachment.filename),
                                                   :type => detect_content_type(@attachment),
                                                   :disposition => (@attachment.image? ? 'inline' : 'attachment')
                 end
               end
               def thumbnail
                 if @attachment.thumbnailable? && thumbnail = @attachment.thumbnail(:size => params[:size])
                   if stale?(:etag => thumbnail)
                     send_file thumbnail,
                       :filename => filename_for_content_disposition(@attachment.filename),
                       :type => detect_content_type(@attachment),
                       :disposition => 'inline'
                   end
                 else
                   # No thumbnail for the attachment or thumbnail could not be created
                   render :nothing => true, :status => 404
                 end
               end
               def upload
                 # Make sure that API users get used to set this content type
                 # as it won't trigger Rails' automatic parsing of the request body for parameters
                 unless request.content_type == 'application/octet-stream'
                   render :nothing => true, :status => 406
                   return
                 end
                 @attachment = Attachment.new(:file => request.raw_post)
                 @attachment.author = User.current
-                @attachment.filename = Redmine::Utils.random_hex(16)
+                @attachment.filename = params[:filename].presence || Redmine::Utils.random_hex(16)
                 if @attachment.save
                   respond_to do |format|
                     format.api { render :action => 'upload', :status => :created }
                   end
                 else
                   respond_to do |format|
                     format.api { render_validation_errors(@attachment) }
                   end
                 end
               end
               def destroy
                 if @attachment.container.respond_to?(:init_journal)
                   @attachment.container.init_journal(User.current)
                 end
                 # Make sure association callbacks are called
                 @attachment.container.attachments.delete(@attachment)
                 redirect_to_referer_or project_path(@project)
               end
             private
               def find_project
                 @attachment = Attachment.find(params[:id])
                 # Show 404 if the filename in the url is wrong
                 raise ActiveRecord::RecordNotFound if params[:filename] && params[:filename] != @attachment.filename
                 @project = @attachment.project
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               # Checks that the file exists and is readable
               def file_readable
                 @attachment.readable? ? true : render_404
               end
               def read_authorize
                 @attachment.visible? ? true : deny_access
               end
               def delete_authorize
                 @attachment.deletable? ? true : deny_access
               end
               def detect_content_type(attachment)
                 content_type = attachment.content_type
                 if content_type.blank?
                   content_type = Redmine::MimeType.of(attachment.filename)
                 end
                 content_type.to_s
               end
             end

test/integration/api_test/attachments_test.rb +12 0

             # Redmine - project management software
             # Copyright (C) 2006-2012  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require File.expand_path('../../../test_helper', __FILE__)
             class ApiTest::AttachmentsTest < ActionController::IntegrationTest
               fixtures :projects, :trackers, :issue_statuses, :issues,
                        :enumerations, :users, :issue_categories,
                        :projects_trackers,
                        :roles,
                        :member_roles,
                        :members,
                        :enabled_modules,
                        :workflows,
                        :attachments
               def setup
                 Setting.rest_api_enabled = '1'
                 set_fixtures_attachments_directory
               end
               def teardown
                 set_tmp_attachments_directory
               end
               test "GET /attachments/:id.xml should return the attachment" do
                 get '/attachments/7.xml', {}, credentials('jsmith')
                 assert_response :success
                 assert_equal 'application/xml', @response.content_type
                 assert_tag :tag => 'attachment',
                   :child => {
                     :tag => 'id',
                     :content => '7',
                     :sibling => {
                       :tag => 'filename',
                       :content => 'archive.zip',
                       :sibling => {
                         :tag => 'content_url',
                         :content => 'http://www.example.com/attachments/download/7/archive.zip'
                       }
                     }
                   }
               end
               test "GET /attachments/:id.xml should deny access without credentials" do
                 get '/attachments/7.xml'
                 assert_response 401
                 set_tmp_attachments_directory
               end
               test "GET /attachments/download/:id/:filename should return the attachment content" do
                 get '/attachments/download/7/archive.zip', {}, credentials('jsmith')
                 assert_response :success
                 assert_equal 'application/octet-stream', @response.content_type
                 set_tmp_attachments_directory
               end
               test "GET /attachments/download/:id/:filename should deny access without credentials" do
                 get '/attachments/download/7/archive.zip'
                 assert_response 302
                 set_tmp_attachments_directory
               end
               test "POST /uploads.xml should return the token" do
                 set_tmp_attachments_directory
                 assert_difference 'Attachment.count' do
                   post '/uploads.xml', 'File content', {"CONTENT_TYPE" => 'application/octet-stream'}.merge(credentials('jsmith'))
                   assert_response :created
                   assert_equal 'application/xml', response.content_type
                 end
                 xml = Hash.from_xml(response.body)
                 assert_kind_of Hash, xml['upload']
                 token = xml['upload']['token']
                 assert_not_nil token
                 attachment = Attachment.first(:order => 'id DESC')
                 assert_equal token, attachment.token
                 assert_nil attachment.container
                 assert_equal 2, attachment.author_id
                 assert_equal 'File content'.size, attachment.filesize
                 assert attachment.content_type.blank?
                 assert attachment.filename.present?
                 assert_match /\d+_[0-9a-z]+/, attachment.diskfile
                 assert File.exist?(attachment.diskfile)
                 assert_equal 'File content', File.read(attachment.diskfile)
               end
               test "POST /uploads.json should return the token" do
                 set_tmp_attachments_directory
                 assert_difference 'Attachment.count' do
                   post '/uploads.json', 'File content', {"CONTENT_TYPE" => 'application/octet-stream'}.merge(credentials('jsmith'))
                   assert_response :created
                   assert_equal 'application/json', response.content_type
                 end
                 json = ActiveSupport::JSON.decode(response.body)
                 assert_kind_of Hash, json['upload']
                 token = json['upload']['token']
                 assert_not_nil token
                 attachment = Attachment.first(:order => 'id DESC')
                 assert_equal token, attachment.token
               end
+              test "POST /uploads.xml should accept :filename param as the attachment filename" do
+                set_tmp_attachments_directory
+                assert_difference 'Attachment.count' do
+                  post '/uploads.xml?filename=test.txt', 'File content', {"CONTENT_TYPE" => 'application/octet-stream'}.merge(credentials('jsmith'))
+                  assert_response :created
+                end
+                attachment = Attachment.order('id DESC').first
+                assert_equal 'test.txt', attachment.filename
+                assert_match /_test\.txt$/, attachment.diskfile
+              end
               test "POST /uploads.xml should not accept other content types" do
                 set_tmp_attachments_directory
                 assert_no_difference 'Attachment.count' do
                   post '/uploads.xml', 'PNG DATA', {"CONTENT_TYPE" => 'image/png'}.merge(credentials('jsmith'))
                   assert_response 406
                 end
               end
               test "POST /uploads.xml should return errors if file is too big" do
                 set_tmp_attachments_directory
                 with_settings :attachment_max_size => 1 do
                   assert_no_difference 'Attachment.count' do
                     post '/uploads.xml', ('x' * 2048), {"CONTENT_TYPE" => 'application/octet-stream'}.merge(credentials('jsmith'))
                     assert_response 422
                     assert_tag 'error', :content => /exceeds the maximum allowed file size/
                   end
                 end
               end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages