jro_apps/redmine Commit - r10761:c99b638d61cc

Store attachments in subdirectories (#5298)....

Jean-Philippe Lang -

r10761:c99b638d61cc

parent child

Context file:

r10761:c99b638d61cc

Collapse all files

db/migrate/20121213084931_add_attachments_disk_directory.rb created 644 +9 0

@@ -0,0 +1,9
	1	class AddAttachmentsDiskDirectory < ActiveRecord::Migration
	2	def up
	3	add_column :attachments, :disk_directory, :string
	4	end
	5
	6	def down
	7	remove_column :attachments, :disk_directory
	8	end
	9	end

app/models/attachment.rb +38 -7

             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require "digest/md5"
+            require "fileutils"
             class Attachment < ActiveRecord::Base
               belongs_to :container, :polymorphic => true
               def filename=(arg)
                 write_attribute :filename, sanitize_filename(arg.to_s)
-                if new_record? && disk_filename.blank?
-                  self.disk_filename = Attachment.disk_filename(filename)
-                end
                 filename
               end
               # and computes its MD5 hash
               def files_to_final_location
                 if @temp_file && (@temp_file.size > 0)
+                  self.disk_directory = target_directory
+                  self.disk_filename = Attachment.disk_filename(filename, disk_directory)
                   logger.info("Saving attachment '#{self.diskfile}' (#{@temp_file.size} bytes)")
+                  path = File.dirname(diskfile)
+                  unless File.directory?(path)
+                    FileUtils.mkdir_p(path)
+                  end
                   md5 = Digest::MD5.new
                   File.open(diskfile, "wb") do |f|
                     if @temp_file.respond_to?(:read)
               # Returns file's location on disk
               def diskfile
-                File.join(self.class.storage_path, disk_filename.to_s)
+                File.join(self.class.storage_path, disk_directory.to_s, disk_filename.to_s)
               end
               def title
                 Attachment.where("created_on < ? AND (container_type IS NULL OR container_type = '')", Time.now - age).destroy_all
               end
+              # Moves an existing attachment to its target directory
+              def move_to_target_directory!
+                if !new_record? & readable?
+                  src = diskfile
+                  self.disk_directory = target_directory
+                  dest = diskfile
+                  if src != dest && FileUtils.mkdir_p(File.dirname(dest)) && FileUtils.mv(src, dest)
+                    update_column :disk_directory, disk_directory
+                  end
+                end
+              end
+              # Moves existing attachments that are stored at the root of the files
+              # directory (ie. created before Redmine 2.3) to their target subdirectories
+              def self.move_from_root_to_target_directory
+                Attachment.where("disk_directory IS NULL OR disk_directory = ''").find_each do |attachment|
+                  attachment.move_to_target_directory!
+                end
+              end
               private
               # Physically deletes the file from the file system
                 @filename = just_filename.gsub(/[\/\?\%\*\:\|\"\'<>]+/, '_')
               end
-              # Returns an ASCII or hashed filename
+              # Returns the subdirectory in which the attachment will be saved
-              def self.disk_filename(filename)
+              def target_directory
+                time = created_on || DateTime.now
+                time.strftime("%Y/%m")
+              end
+              # Returns an ASCII or hashed filename that do not
+              # exists yet in the given subdirectory
+              def self.disk_filename(filename, directory=nil)
                 timestamp = DateTime.now.strftime("%y%m%d%H%M%S")
                 ascii = ''
                 if filename =~ %r{^[a-zA-Z0-9_\.\-]*$}
                   # keep the extension if any
                   ascii << $1 if filename =~ %r{(\.[a-zA-Z0-9]+)$}
                 end
-                while File.exist?(File.join(@@storage_path, "#{timestamp}_#{ascii}"))
+                while File.exist?(File.join(storage_path, directory.to_s, "#{timestamp}_#{ascii}"))
                   timestamp.succ!
                 end
                 "#{timestamp}_#{ascii}"

lib/tasks/redmine.rake +5 0

                 task :prune => :environment do
                   Attachment.prune
                 end
+                desc 'Moves attachments stored at the root of the file directory (ie. created before Redmine 2.3) to their subdirectories'
+                task :move_to_subdirectories => :environment do
+                  Attachment.move_from_root_to_target_directory
+                end
               end
               namespace :tokens do

test/fixtures/attachments.yml +33 0

               downloads: 0
               content_type: text/plain
               disk_filename: 060719210727_error281.txt
+              disk_directory: "2006/07"
               container_id: 3
               digest: b91e08d0cf966d5c6ff411bd8c4cc3a2
               id: 1
               downloads: 0
               content_type: text/plain
               disk_filename: 060719210727_document.txt
+              disk_directory: "2006/07"
               container_id: 1
               digest: b91e08d0cf966d5c6ff411bd8c4cc3a2
               id: 2
               downloads: 0
               content_type: image/gif
               disk_filename: 060719210727_logo.gif
+              disk_directory: "2006/07"
               container_id: 4
               digest: b91e08d0cf966d5c6ff411bd8c4cc3a2
               id: 3
               container_id: 3
               downloads: 0
               disk_filename: 060719210727_source.rb
+              disk_directory: "2006/07"
               digest: b91e08d0cf966d5c6ff411bd8c4cc3a2
               id: 4
               filesize: 153
               container_id: 3
               downloads: 0
               disk_filename: 060719210727_changeset_iso8859-1.diff
+              disk_directory: "2006/07"
               digest: b91e08d0cf966d5c6ff411bd8c4cc3a2
               id: 5
               filesize: 687
               container_id: 3
               downloads: 0
               disk_filename: 060719210727_archive.zip
+              disk_directory: "2006/07"
               digest: b91e08d0cf966d5c6ff411bd8c4cc3a2
               id: 6
               filesize: 157
               container_id: 4
               downloads: 0
               disk_filename: 060719210727_archive.zip
+              disk_directory: "2006/07"
               digest: b91e08d0cf966d5c6ff411bd8c4cc3a2
               id: 7
               filesize: 157
               container_id: 1
               downloads: 0
               disk_filename: 060719210727_project_file.zip
+              disk_directory: "2006/07"
               digest: b91e08d0cf966d5c6ff411bd8c4cc3a2
               id: 8
               filesize: 320
               container_id: 1
               downloads: 0
               disk_filename: 060719210727_archive.zip
+              disk_directory: "2006/07"
               digest: b91e08d0cf966d5c6ff411bd8c4cc3a2
               id: 9
               filesize: 452
               container_id: 2
               downloads: 0
               disk_filename: 060719210727_picture.jpg
+              disk_directory: "2006/07"
               digest: b91e08d0cf966d5c6ff411bd8c4cc3a2
               id: 10
               filesize: 452
               container_id: 1
               downloads: 0
               disk_filename: 060719210727_picture.jpg
+              disk_directory: "2006/07"
               digest: b91e08d0cf966d5c6ff411bd8c4cc3a2
               id: 11
               filesize: 452
               container_id: 1
               downloads: 0
               disk_filename: 060719210727_version_file.zip
+              disk_directory: "2006/07"
               digest: b91e08d0cf966d5c6ff411bd8c4cc3a2
               id: 12
               filesize: 452
               container_id: 1
               downloads: 0
               disk_filename: 060719210727_foo.zip
+              disk_directory: "2006/07"
               digest: b91e08d0cf966d5c6ff411bd8c4cc3a2
               id: 13
               filesize: 452
               container_id: 3
               downloads: 0
               disk_filename: 060719210727_changeset_utf8.diff
+              disk_directory: "2006/07"
               digest: b91e08d0cf966d5c6ff411bd8c4cc3a2
               id: 14
               filesize: 687
               container_id: 14
               downloads: 0
               disk_filename: 060719210727_changeset_utf8.diff
+              disk_directory: "2006/07"
               digest: b91e08d0cf966d5c6ff411bd8c4cc3a2
               filesize: 687
               filename: private.diff
               downloads: 0
               created_on: 2010-11-23 16:14:50 +09:00
               disk_filename: 101123161450_testfile_1.png
+              disk_directory: "2010/11"
               container_id: 14
               digest: 8e0294de2441577c529f170b6fb8f638
               id: 16
               downloads: 0
               created_on: 2010-12-23 16:14:50 +09:00
               disk_filename: 101223161450_testfile_2.png
+              disk_directory: "2010/12"
               container_id: 14
               digest: 6bc2963e8d7ea0d3e68d12d1fba3d6ca
               id: 17
               downloads: 0
               created_on: 2011-01-23 16:14:50 +09:00
               disk_filename: 101123161450_testfile_1.png
+              disk_directory: "2010/11"
               container_id: 14
               digest: 8e0294de2441577c529f170b6fb8f638
               id: 18
               downloads: 0
               created_on: 2011-02-23 16:14:50 +09:00
               disk_filename: 101223161450_testfile_2.png
+              disk_directory: "2010/12"
               container_id: 14
               digest: 6bc2963e8d7ea0d3e68d12d1fba3d6ca
               id: 19
               filename: Testテスト.PNG
               filesize: 3582
               author_id: 2
+            attachments_020:
+              content_type: text/plain
+              downloads: 0
+              created_on: 2012-05-12 16:14:50 +09:00
+              disk_filename: 120512161450_root_attachment.txt
+              disk_directory:
+              container_id: 14
+              digest: b0fe2abdb2599743d554a61d7da7ff74
+              id: 20
+              container_type: Issue
+              description: ""
+              filename: root_attachment.txt
+              filesize: 54
+              author_id: 2

test/fixtures/files/2006/07/060719210727_archive.zip ~~test/fixtures/files/060719210727_archive.zip~~ renamed 0 0

NO CONTENT: file renamed from test/fixtures/files/060719210727_archive.zip to test/fixtures/files/2006/07/060719210727_archive.zip

test/fixtures/files/2006/07/060719210727_changeset_iso8859-1.diff ~~test/fixtures/files/060719210727_changeset_iso8859-1.diff~~ renamed 0 0

NO CONTENT: file renamed from test/fixtures/files/060719210727_changeset_iso8859-1.diff to test/fixtures/files/2006/07/060719210727_changeset_iso8859-1.diff

test/fixtures/files/2006/07/060719210727_changeset_utf8.diff ~~test/fixtures/files/060719210727_changeset_utf8.diff~~ renamed 0 0

NO CONTENT: file renamed from test/fixtures/files/060719210727_changeset_utf8.diff to test/fixtures/files/2006/07/060719210727_changeset_utf8.diff

test/fixtures/files/2006/07/060719210727_source.rb ~~test/fixtures/files/060719210727_source.rb~~ renamed 0 0

NO CONTENT: file renamed from test/fixtures/files/060719210727_source.rb to test/fixtures/files/2006/07/060719210727_source.rb

test/fixtures/files/2010/11/101123161450_testfile_1.png ~~test/fixtures/files/101123161450_testfile_1.png~~ renamed 0 0

NO CONTENT: file renamed from test/fixtures/files/101123161450_testfile_1.png to test/fixtures/files/2010/11/101123161450_testfile_1.png

test/fixtures/files/2010/12/101223161450_testfile_2.png ~~test/fixtures/files/101223161450_testfile_2.png~~ renamed 0 0

NO CONTENT: file renamed from test/fixtures/files/101223161450_testfile_2.png to test/fixtures/files/2010/12/101223161450_testfile_2.png

test/unit/attachment_test.rb +33 0

@@ -52,10 +52,25 class AttachmentTest < ActiveSupport::TestCase
52	assert_equal 'text/plain', a.content_type	52	assert_equal 'text/plain', a.content_type
53	assert_equal 0, a.downloads	53	assert_equal 0, a.downloads
54	assert_equal '1478adae0d4eb06d35897518540e25d6', a.digest	54	assert_equal '1478adae0d4eb06d35897518540e25d6', a.digest
		55
		56	assert a.disk_directory
		57	assert_match %r{\A\d{4}/\d{2}\z}, a.disk_directory
		58
55	assert File.exist?(a.diskfile)	59	assert File.exist?(a.diskfile)
56	assert_equal 59, File.size(a.diskfile)	60	assert_equal 59, File.size(a.diskfile)
57	end	61	end
58		62
		63	def test_copy_should_preserve_attributes
		64	a = Attachment.find(1)
		65	copy = a.copy
		66
		67	assert_save copy
		68	copy = Attachment.order('id DESC').first
		69	%w(filename filesize content_type author_id created_on description digest disk_filename disk_directory diskfile).each do \|attribute\|
		70	assert_equal a.send(attribute), copy.send(attribute), "#{attribute} was different"
		71	end
		72	end
		73
59	def test_size_should_be_validated_for_new_file	74	def test_size_should_be_validated_for_new_file
60	with_settings :attachment_max_size => 0 do	75	with_settings :attachment_max_size => 0 do
61	a = Attachment.new(:container => Issue.find(1),	76	a = Attachment.new(:container => Issue.find(1),
@@ -123,6 +138,9 class AttachmentTest < ActiveSupport::TestCase
123	end	138	end
124		139
125	def test_identical_attachments_at_the_same_time_should_not_overwrite	140	def test_identical_attachments_at_the_same_time_should_not_overwrite
		141	time = DateTime.now
		142	DateTime.stubs(:now).returns(time)
		143
126	a1 = Attachment.create!(:container => Issue.find(1),	144	a1 = Attachment.create!(:container => Issue.find(1),
127	:file => uploaded_test_file("testfile.txt", ""),	145	:file => uploaded_test_file("testfile.txt", ""),
128	:author => User.find(1))	146	:author => User.find(1))
@@ -168,6 +186,21 class AttachmentTest < ActiveSupport::TestCase
168	end	186	end
169	end	187	end
170		188
		189	def test_move_from_root_to_target_directory_should_move_root_files
		190	a = Attachment.find(20)
		191	assert a.disk_directory.blank?
		192	# Create a real file for this fixture
		193	File.open(a.diskfile, "w") do \|f\|
		194	f.write "test file at the root of files directory"
		195	end
		196	assert a.readable?
		197	Attachment.move_from_root_to_target_directory
		198
		199	a.reload
		200	assert_equal '2012/05', a.disk_directory
		201	assert a.readable?
		202	end
		203
171	context "Attachmnet.attach_files" do	204	context "Attachmnet.attach_files" do
172	should "attach the file" do	205	should "attach the file" do
173	issue = Issue.first	206	issue = Issue.first

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