betelgeuse-paperclip 2.2.8.1
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE +26 -0
- data/README.rdoc +172 -0
- data/Rakefile +77 -0
- data/generators/paperclip/USAGE +5 -0
- data/generators/paperclip/paperclip_generator.rb +27 -0
- data/generators/paperclip/templates/paperclip_migration.rb.erb +19 -0
- data/init.rb +1 -0
- data/lib/paperclip.rb +351 -0
- data/lib/paperclip/attachment.rb +404 -0
- data/lib/paperclip/callback_compatability.rb +33 -0
- data/lib/paperclip/geometry.rb +115 -0
- data/lib/paperclip/iostream.rb +58 -0
- data/lib/paperclip/matchers.rb +4 -0
- data/lib/paperclip/matchers/have_attached_file_matcher.rb +49 -0
- data/lib/paperclip/matchers/validate_attachment_content_type_matcher.rb +66 -0
- data/lib/paperclip/matchers/validate_attachment_presence_matcher.rb +48 -0
- data/lib/paperclip/matchers/validate_attachment_size_matcher.rb +83 -0
- data/lib/paperclip/processor.rb +48 -0
- data/lib/paperclip/storage.rb +432 -0
- data/lib/paperclip/thumbnail.rb +70 -0
- data/lib/paperclip/upfile.rb +48 -0
- data/shoulda_macros/paperclip.rb +68 -0
- data/tasks/paperclip_tasks.rake +79 -0
- metadata +109 -0
@@ -0,0 +1,58 @@
|
|
1
|
+
# Provides method that can be included on File-type objects (IO, StringIO, Tempfile, etc) to allow stream copying
|
2
|
+
# and Tempfile conversion.
|
3
|
+
module IOStream
|
4
|
+
|
5
|
+
# Returns a Tempfile containing the contents of the readable object.
|
6
|
+
def to_tempfile
|
7
|
+
tempfile = Tempfile.new("stream")
|
8
|
+
tempfile.binmode
|
9
|
+
self.stream_to(tempfile)
|
10
|
+
end
|
11
|
+
|
12
|
+
# Copies one read-able object from one place to another in blocks, obviating the need to load
|
13
|
+
# the whole thing into memory. Defaults to 8k blocks. If this module is included in both
|
14
|
+
# StringIO and Tempfile, then either can have its data copied anywhere else without typing
|
15
|
+
# worries or memory overhead worries. Returns a File if a String is passed in as the destination
|
16
|
+
# and returns the IO or Tempfile as passed in if one is sent as the destination.
|
17
|
+
def stream_to path_or_file, in_blocks_of = 8192
|
18
|
+
dstio = case path_or_file
|
19
|
+
when String then File.new(path_or_file, "wb+")
|
20
|
+
when IO then path_or_file
|
21
|
+
when Tempfile then path_or_file
|
22
|
+
end
|
23
|
+
buffer = ""
|
24
|
+
self.rewind
|
25
|
+
while self.read(in_blocks_of, buffer) do
|
26
|
+
dstio.write(buffer)
|
27
|
+
end
|
28
|
+
dstio.rewind
|
29
|
+
dstio
|
30
|
+
end
|
31
|
+
end
|
32
|
+
|
33
|
+
class IO #:nodoc:
|
34
|
+
include IOStream
|
35
|
+
end
|
36
|
+
|
37
|
+
%w( Tempfile StringIO ).each do |klass|
|
38
|
+
if Object.const_defined? klass
|
39
|
+
Object.const_get(klass).class_eval do
|
40
|
+
include IOStream
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
44
|
+
|
45
|
+
# Corrects a bug in Windows when asking for Tempfile size.
|
46
|
+
if defined? Tempfile
|
47
|
+
class Tempfile
|
48
|
+
def size
|
49
|
+
if @tmpfile
|
50
|
+
@tmpfile.fsync
|
51
|
+
@tmpfile.flush
|
52
|
+
@tmpfile.stat.size
|
53
|
+
else
|
54
|
+
0
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
@@ -0,0 +1,49 @@
|
|
1
|
+
module Paperclip
|
2
|
+
module Shoulda
|
3
|
+
module Matchers
|
4
|
+
def have_attached_file name
|
5
|
+
HaveAttachedFileMatcher.new(name)
|
6
|
+
end
|
7
|
+
|
8
|
+
class HaveAttachedFileMatcher
|
9
|
+
def initialize attachment_name
|
10
|
+
@attachment_name = attachment_name
|
11
|
+
end
|
12
|
+
|
13
|
+
def matches? subject
|
14
|
+
@subject = subject
|
15
|
+
responds? && has_column? && included?
|
16
|
+
end
|
17
|
+
|
18
|
+
def failure_message
|
19
|
+
"Should have an attachment named #{@attachment_name}"
|
20
|
+
end
|
21
|
+
|
22
|
+
def negative_failure_message
|
23
|
+
"Should not have an attachment named #{@attachment_name}"
|
24
|
+
end
|
25
|
+
|
26
|
+
def description
|
27
|
+
"have an attachment named #{@attachment_name}"
|
28
|
+
end
|
29
|
+
|
30
|
+
protected
|
31
|
+
|
32
|
+
def responds?
|
33
|
+
methods = @subject.instance_methods
|
34
|
+
methods.include?("#{@attachment_name}") &&
|
35
|
+
methods.include?("#{@attachment_name}=") &&
|
36
|
+
methods.include?("#{@attachment_name}?")
|
37
|
+
end
|
38
|
+
|
39
|
+
def has_column?
|
40
|
+
@subject.column_names.include?("#{@attachment_name}_file_name")
|
41
|
+
end
|
42
|
+
|
43
|
+
def included?
|
44
|
+
@subject.ancestors.include?(Paperclip::InstanceMethods)
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
@@ -0,0 +1,66 @@
|
|
1
|
+
module Paperclip
|
2
|
+
module Shoulda
|
3
|
+
module Matchers
|
4
|
+
def validate_attachment_content_type name
|
5
|
+
ValidateAttachmentContentTypeMatcher.new(name)
|
6
|
+
end
|
7
|
+
|
8
|
+
class ValidateAttachmentContentTypeMatcher
|
9
|
+
def initialize attachment_name
|
10
|
+
@attachment_name = attachment_name
|
11
|
+
end
|
12
|
+
|
13
|
+
def allowing *types
|
14
|
+
@allowed_types = types.flatten
|
15
|
+
self
|
16
|
+
end
|
17
|
+
|
18
|
+
def rejecting *types
|
19
|
+
@rejected_types = types.flatten
|
20
|
+
self
|
21
|
+
end
|
22
|
+
|
23
|
+
def matches? subject
|
24
|
+
@subject = subject
|
25
|
+
@allowed_types && @rejected_types &&
|
26
|
+
allowed_types_allowed? && rejected_types_rejected?
|
27
|
+
end
|
28
|
+
|
29
|
+
def failure_message
|
30
|
+
"Content types #{@allowed_types.join(", ")} should be accepted" +
|
31
|
+
" and #{@rejected_types.join(", ")} rejected by #{@attachment_name}"
|
32
|
+
end
|
33
|
+
|
34
|
+
def negative_failure_message
|
35
|
+
"Content types #{@allowed_types.join(", ")} should be rejected" +
|
36
|
+
" and #{@rejected_types.join(", ")} accepted by #{@attachment_name}"
|
37
|
+
end
|
38
|
+
|
39
|
+
def description
|
40
|
+
"validate the content types allowed on attachment #{@attachment_name}"
|
41
|
+
end
|
42
|
+
|
43
|
+
protected
|
44
|
+
|
45
|
+
def allow_types?(types)
|
46
|
+
types.all? do |type|
|
47
|
+
file = StringIO.new(".")
|
48
|
+
file.content_type = type
|
49
|
+
attachment = @subject.new.attachment_for(@attachment_name)
|
50
|
+
attachment.assign(file)
|
51
|
+
attachment.errors[:content_type].nil?
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
55
|
+
def allowed_types_allowed?
|
56
|
+
allow_types?(@allowed_types)
|
57
|
+
end
|
58
|
+
|
59
|
+
def rejected_types_rejected?
|
60
|
+
not allow_types?(@rejected_types)
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
66
|
+
|
@@ -0,0 +1,48 @@
|
|
1
|
+
module Paperclip
|
2
|
+
module Shoulda
|
3
|
+
module Matchers
|
4
|
+
def validate_attachment_presence name
|
5
|
+
ValidateAttachmentPresenceMatcher.new(name)
|
6
|
+
end
|
7
|
+
|
8
|
+
class ValidateAttachmentPresenceMatcher
|
9
|
+
def initialize attachment_name
|
10
|
+
@attachment_name = attachment_name
|
11
|
+
end
|
12
|
+
|
13
|
+
def matches? subject
|
14
|
+
@subject = subject
|
15
|
+
error_when_not_valid? && no_error_when_valid?
|
16
|
+
end
|
17
|
+
|
18
|
+
def failure_message
|
19
|
+
"Attachment #{@attachment_name} should be required"
|
20
|
+
end
|
21
|
+
|
22
|
+
def negative_failure_message
|
23
|
+
"Attachment #{@attachment_name} should not be required"
|
24
|
+
end
|
25
|
+
|
26
|
+
def description
|
27
|
+
"require presence of attachment #{@attachment_name}"
|
28
|
+
end
|
29
|
+
|
30
|
+
protected
|
31
|
+
|
32
|
+
def error_when_not_valid?
|
33
|
+
@attachment = @subject.new.send(@attachment_name)
|
34
|
+
@attachment.assign(nil)
|
35
|
+
not @attachment.errors[:presence].nil?
|
36
|
+
end
|
37
|
+
|
38
|
+
def no_error_when_valid?
|
39
|
+
@file = StringIO.new(".")
|
40
|
+
@attachment = @subject.new.send(@attachment_name)
|
41
|
+
@attachment.assign(@file)
|
42
|
+
@attachment.errors[:presence].nil?
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
|
@@ -0,0 +1,83 @@
|
|
1
|
+
module Paperclip
|
2
|
+
module Shoulda
|
3
|
+
module Matchers
|
4
|
+
def validate_attachment_size name
|
5
|
+
ValidateAttachmentSizeMatcher.new(name)
|
6
|
+
end
|
7
|
+
|
8
|
+
class ValidateAttachmentSizeMatcher
|
9
|
+
def initialize attachment_name
|
10
|
+
@attachment_name = attachment_name
|
11
|
+
@low, @high = 0, (1.0/0)
|
12
|
+
end
|
13
|
+
|
14
|
+
def less_than size
|
15
|
+
@high = size
|
16
|
+
self
|
17
|
+
end
|
18
|
+
|
19
|
+
def greater_than size
|
20
|
+
@low = size
|
21
|
+
self
|
22
|
+
end
|
23
|
+
|
24
|
+
def in range
|
25
|
+
@low, @high = range.first, range.last
|
26
|
+
self
|
27
|
+
end
|
28
|
+
|
29
|
+
def matches? subject
|
30
|
+
@subject = subject
|
31
|
+
lower_than_low? && higher_than_low? && lower_than_high? && higher_than_high?
|
32
|
+
end
|
33
|
+
|
34
|
+
def failure_message
|
35
|
+
"Attachment #{@attachment_name} must be between #{@low} and #{@high} bytes"
|
36
|
+
end
|
37
|
+
|
38
|
+
def negative_failure_message
|
39
|
+
"Attachment #{@attachment_name} cannot be between #{@low} and #{@high} bytes"
|
40
|
+
end
|
41
|
+
|
42
|
+
def description
|
43
|
+
"validate the size of attachment #{@attachment_name}"
|
44
|
+
end
|
45
|
+
|
46
|
+
protected
|
47
|
+
|
48
|
+
def override_method object, method, &replacement
|
49
|
+
(class << object; self; end).class_eval do
|
50
|
+
define_method(method, &replacement)
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
def passes_validation_with_size(new_size)
|
55
|
+
file = StringIO.new(".")
|
56
|
+
override_method(file, :size){ new_size }
|
57
|
+
attachment = @subject.new.attachment_for(@attachment_name)
|
58
|
+
attachment.assign(file)
|
59
|
+
attachment.errors[:size].nil?
|
60
|
+
end
|
61
|
+
|
62
|
+
def lower_than_low?
|
63
|
+
not passes_validation_with_size(@low - 1)
|
64
|
+
end
|
65
|
+
|
66
|
+
def higher_than_low?
|
67
|
+
passes_validation_with_size(@low + 1)
|
68
|
+
end
|
69
|
+
|
70
|
+
def lower_than_high?
|
71
|
+
return true if @high == (1.0/0)
|
72
|
+
passes_validation_with_size(@high - 1)
|
73
|
+
end
|
74
|
+
|
75
|
+
def higher_than_high?
|
76
|
+
return true if @high == (1.0/0)
|
77
|
+
not passes_validation_with_size(@high + 1)
|
78
|
+
end
|
79
|
+
end
|
80
|
+
end
|
81
|
+
end
|
82
|
+
end
|
83
|
+
|
@@ -0,0 +1,48 @@
|
|
1
|
+
module Paperclip
|
2
|
+
# Paperclip processors allow you to modify attached files when they are
|
3
|
+
# attached in any way you are able. Paperclip itself uses command-line
|
4
|
+
# programs for its included Thumbnail processor, but custom processors
|
5
|
+
# are not required to follow suit.
|
6
|
+
#
|
7
|
+
# Processors are required to be defined inside the Paperclip module and
|
8
|
+
# are also required to be a subclass of Paperclip::Processor. There are
|
9
|
+
# only two methods you must implement to properly be a subclass:
|
10
|
+
# #initialize and #make. Initialize's arguments are the file that will
|
11
|
+
# be operated on (which is an instance of File), and a hash of options
|
12
|
+
# that were defined in has_attached_file's style hash.
|
13
|
+
#
|
14
|
+
# All #make needs to do is return an instance of File (Tempfile is
|
15
|
+
# acceptable) which contains the results of the processing.
|
16
|
+
#
|
17
|
+
# See Paperclip.run for more information about using command-line
|
18
|
+
# utilities from within Processors.
|
19
|
+
class Processor
|
20
|
+
attr_accessor :file, :options, :attachment
|
21
|
+
|
22
|
+
def initialize file, options = {}, attachment = nil
|
23
|
+
@file = file
|
24
|
+
@options = options
|
25
|
+
@attachment = attachment
|
26
|
+
end
|
27
|
+
|
28
|
+
def make
|
29
|
+
end
|
30
|
+
|
31
|
+
def self.make file, options = {}, attachment = nil
|
32
|
+
new(file, options, attachment).make
|
33
|
+
end
|
34
|
+
end
|
35
|
+
|
36
|
+
# Due to how ImageMagick handles its image format conversion and how Tempfile
|
37
|
+
# handles its naming scheme, it is necessary to override how Tempfile makes
|
38
|
+
# its names so as to allow for file extensions. Idea taken from the comments
|
39
|
+
# on this blog post:
|
40
|
+
# http://marsorange.com/archives/of-mogrify-ruby-tempfile-dynamic-class-definitions
|
41
|
+
class Tempfile < ::Tempfile
|
42
|
+
# Replaces Tempfile's +make_tmpname+ with one that honors file extensions.
|
43
|
+
def make_tmpname(basename, n)
|
44
|
+
extension = File.extname(basename)
|
45
|
+
sprintf("%s,%d,%d%s", File.basename(basename, extension), $$, n, extension)
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
@@ -0,0 +1,432 @@
|
|
1
|
+
module Paperclip
|
2
|
+
module Storage
|
3
|
+
|
4
|
+
# The default place to store attachments is in the filesystem. Files on the local
|
5
|
+
# filesystem can be very easily served by Apache without requiring a hit to your app.
|
6
|
+
# They also can be processed more easily after they've been saved, as they're just
|
7
|
+
# normal files. There is one Filesystem-specific option for has_attached_file.
|
8
|
+
# * +path+: The location of the repository of attachments on disk. This can (and, in
|
9
|
+
# almost all cases, should) be coordinated with the value of the +url+ option to
|
10
|
+
# allow files to be saved into a place where Apache can serve them without
|
11
|
+
# hitting your app. Defaults to
|
12
|
+
# ":rails_root/public/:attachment/:id/:style/:basename.:extension"
|
13
|
+
# By default this places the files in the app's public directory which can be served
|
14
|
+
# directly. If you are using capistrano for deployment, a good idea would be to
|
15
|
+
# make a symlink to the capistrano-created system directory from inside your app's
|
16
|
+
# public directory.
|
17
|
+
# See Paperclip::Attachment#interpolate for more information on variable interpolaton.
|
18
|
+
# :path => "/var/app/attachments/:class/:id/:style/:basename.:extension"
|
19
|
+
module Filesystem
|
20
|
+
def self.extended base
|
21
|
+
end
|
22
|
+
|
23
|
+
def exists?(style = default_style)
|
24
|
+
if original_filename
|
25
|
+
File.exist?(path(style))
|
26
|
+
else
|
27
|
+
false
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
# Returns representation of the data of the file assigned to the given
|
32
|
+
# style, in the format most representative of the current storage.
|
33
|
+
def to_file style = default_style
|
34
|
+
@queued_for_write[style] || (File.new(path(style), 'rb') if exists?(style))
|
35
|
+
end
|
36
|
+
alias_method :to_io, :to_file
|
37
|
+
|
38
|
+
def flush_writes #:nodoc:
|
39
|
+
@queued_for_write.each do |style, file|
|
40
|
+
file.close
|
41
|
+
FileUtils.mkdir_p(File.dirname(path(style)))
|
42
|
+
logger.info("[paperclip] saving #{path(style)}")
|
43
|
+
FileUtils.mv(file.path, path(style))
|
44
|
+
FileUtils.chmod(0644, path(style))
|
45
|
+
end
|
46
|
+
@queued_for_write = {}
|
47
|
+
end
|
48
|
+
|
49
|
+
def flush_deletes #:nodoc:
|
50
|
+
@queued_for_delete.each do |path|
|
51
|
+
begin
|
52
|
+
logger.info("[paperclip] deleting #{path}")
|
53
|
+
FileUtils.rm(path) if File.exist?(path)
|
54
|
+
rescue Errno::ENOENT => e
|
55
|
+
# ignore file-not-found, let everything else pass
|
56
|
+
end
|
57
|
+
begin
|
58
|
+
while(true)
|
59
|
+
path = File.dirname(path)
|
60
|
+
FileUtils.rmdir(path)
|
61
|
+
end
|
62
|
+
rescue Errno::EEXIST, Errno::ENOTEMPTY, Errno::ENOENT, Errno::EINVAL, Errno::ENOTDIR
|
63
|
+
# Stop trying to remove parent directories
|
64
|
+
rescue SystemCallError => e
|
65
|
+
logger.info("[paperclip] There was an unexpected error while deleting directories: #{e.class}")
|
66
|
+
# Ignore it
|
67
|
+
end
|
68
|
+
end
|
69
|
+
@queued_for_delete = []
|
70
|
+
end
|
71
|
+
end
|
72
|
+
|
73
|
+
# Amazon's S3 file hosting service is a scalable, easy place to store files for
|
74
|
+
# distribution. You can find out more about it at http://aws.amazon.com/s3
|
75
|
+
# There are a few S3-specific options for has_attached_file:
|
76
|
+
# * +s3_credentials+: Takes a path, a File, or a Hash. The path (or File) must point
|
77
|
+
# to a YAML file containing the +access_key_id+ and +secret_access_key+ that Amazon
|
78
|
+
# gives you. You can 'environment-space' this just like you do to your
|
79
|
+
# database.yml file, so different environments can use different accounts:
|
80
|
+
# development:
|
81
|
+
# access_key_id: 123...
|
82
|
+
# secret_access_key: 123...
|
83
|
+
# test:
|
84
|
+
# access_key_id: abc...
|
85
|
+
# secret_access_key: abc...
|
86
|
+
# production:
|
87
|
+
# access_key_id: 456...
|
88
|
+
# secret_access_key: 456...
|
89
|
+
# This is not required, however, and the file may simply look like this:
|
90
|
+
# access_key_id: 456...
|
91
|
+
# secret_access_key: 456...
|
92
|
+
# In which case, those access keys will be used in all environments. You can also
|
93
|
+
# put your bucket name in this file, instead of adding it to the code directly.
|
94
|
+
# This is useful when you want the same account but a different bucket for
|
95
|
+
# development versus production.
|
96
|
+
# * +s3_permissions+: This is a String that should be one of the "canned" access
|
97
|
+
# policies that S3 provides (more information can be found here:
|
98
|
+
# http://docs.amazonwebservices.com/AmazonS3/2006-03-01/RESTAccessPolicy.html#RESTCannedAccessPolicies)
|
99
|
+
# The default for Paperclip is "public-read".
|
100
|
+
# * +s3_protocol+: The protocol for the URLs generated to your S3 assets. Can be either
|
101
|
+
# 'http' or 'https'. Defaults to 'http' when your :s3_permissions are 'public-read' (the
|
102
|
+
# default), and 'https' when your :s3_permissions are anything else.
|
103
|
+
# * +s3_headers+: A hash of headers such as {'Expires' => 1.year.from_now.httpdate}
|
104
|
+
# * +bucket+: This is the name of the S3 bucket that will store your files. Remember
|
105
|
+
# that the bucket must be unique across all of Amazon S3. If the bucket does not exist
|
106
|
+
# Paperclip will attempt to create it. The bucket name will not be interpolated.
|
107
|
+
# You can define the bucket as a Proc if you want to determine it's name at runtime.
|
108
|
+
# Paperclip will call that Proc with attachment as the only argument.
|
109
|
+
# * +s3_host_alias+: The fully-qualified domain name (FQDN) that is the alias to the
|
110
|
+
# S3 domain of your bucket. Used with the :s3_alias_url url interpolation. See the
|
111
|
+
# link in the +url+ entry for more information about S3 domains and buckets.
|
112
|
+
# * +url+: There are three options for the S3 url. You can choose to have the bucket's name
|
113
|
+
# placed domain-style (bucket.s3.amazonaws.com) or path-style (s3.amazonaws.com/bucket).
|
114
|
+
# Lastly, you can specify a CNAME (which requires the CNAME to be specified as
|
115
|
+
# :s3_alias_url. You can read more about CNAMEs and S3 at
|
116
|
+
# http://docs.amazonwebservices.com/AmazonS3/latest/index.html?VirtualHosting.html
|
117
|
+
# Normally, this won't matter in the slightest and you can leave the default (which is
|
118
|
+
# path-style, or :s3_path_url). But in some cases paths don't work and you need to use
|
119
|
+
# the domain-style (:s3_domain_url). Anything else here will be treated like path-style.
|
120
|
+
# NOTE: If you use a CNAME for use with CloudFront, you can NOT specify https as your
|
121
|
+
# :s3_protocol; This is *not supported* by S3/CloudFront. Finally, when using the host
|
122
|
+
# alias, the :bucket parameter is ignored, as the hostname is used as the bucket name
|
123
|
+
# by S3.
|
124
|
+
# * +path+: This is the key under the bucket in which the file will be stored. The
|
125
|
+
# URL will be constructed from the bucket and the path. This is what you will want
|
126
|
+
# to interpolate. Keys should be unique, like filenames, and despite the fact that
|
127
|
+
# S3 (strictly speaking) does not support directories, you can still use a / to
|
128
|
+
# separate parts of your file name.
|
129
|
+
module S3
|
130
|
+
def self.extended base
|
131
|
+
require 'right_aws'
|
132
|
+
base.instance_eval do
|
133
|
+
@s3_credentials = parse_credentials(@options[:s3_credentials])
|
134
|
+
@bucket = @options[:bucket] || @s3_credentials[:bucket]
|
135
|
+
@bucket = @bucket.call(self) if @bucket.is_a?(Proc)
|
136
|
+
@s3_options = @options[:s3_options] || {}
|
137
|
+
@s3_permissions = @options[:s3_permissions] || 'public-read'
|
138
|
+
@s3_protocol = @options[:s3_protocol] || (@s3_permissions == 'public-read' ? 'http' : 'https')
|
139
|
+
@s3_headers = @options[:s3_headers] || {}
|
140
|
+
@s3_host_alias = @options[:s3_host_alias]
|
141
|
+
@url = ":s3_path_url" unless @url.to_s.match(/^:s3.*url$/)
|
142
|
+
end
|
143
|
+
base.class.interpolations[:s3_alias_url] = lambda do |attachment, style|
|
144
|
+
"#{attachment.s3_protocol}://#{attachment.s3_host_alias}/#{attachment.path(style).gsub(%r{^/}, "")}"
|
145
|
+
end
|
146
|
+
base.class.interpolations[:s3_path_url] = lambda do |attachment, style|
|
147
|
+
"#{attachment.s3_protocol}://s3.amazonaws.com/#{attachment.bucket_name}/#{attachment.path(style).gsub(%r{^/}, "")}"
|
148
|
+
end
|
149
|
+
base.class.interpolations[:s3_domain_url] = lambda do |attachment, style|
|
150
|
+
"#{attachment.s3_protocol}://#{attachment.bucket_name}.s3.amazonaws.com/#{attachment.path(style).gsub(%r{^/}, "")}"
|
151
|
+
end
|
152
|
+
end
|
153
|
+
|
154
|
+
def s3
|
155
|
+
@s3 ||= RightAws::S3.new(@s3_credentials[:access_key_id],
|
156
|
+
@s3_credentials[:secret_access_key],
|
157
|
+
@s3_options)
|
158
|
+
end
|
159
|
+
|
160
|
+
def s3_bucket
|
161
|
+
@s3_bucket ||= s3.bucket(@bucket, true, @s3_permissions)
|
162
|
+
end
|
163
|
+
|
164
|
+
def bucket_name
|
165
|
+
@bucket
|
166
|
+
end
|
167
|
+
|
168
|
+
def s3_host_alias
|
169
|
+
@s3_host_alias
|
170
|
+
end
|
171
|
+
|
172
|
+
def parse_credentials creds
|
173
|
+
creds = find_credentials(creds).stringify_keys
|
174
|
+
(creds[ENV['RAILS_ENV']] || creds).symbolize_keys
|
175
|
+
end
|
176
|
+
|
177
|
+
def exists?(style = default_style)
|
178
|
+
s3_bucket.key(path(style)) ? true : false
|
179
|
+
end
|
180
|
+
|
181
|
+
def s3_protocol
|
182
|
+
@s3_protocol
|
183
|
+
end
|
184
|
+
|
185
|
+
# Returns representation of the data of the file assigned to the given
|
186
|
+
# style, in the format most representative of the current storage.
|
187
|
+
def to_file style = default_style
|
188
|
+
@queued_for_write[style] || s3_bucket.key(path(style))
|
189
|
+
end
|
190
|
+
alias_method :to_io, :to_file
|
191
|
+
|
192
|
+
def flush_writes #:nodoc:
|
193
|
+
@queued_for_write.each do |style, file|
|
194
|
+
begin
|
195
|
+
logger.info("[paperclip] saving #{path(style)}")
|
196
|
+
key = s3_bucket.key(path(style))
|
197
|
+
key.data = file
|
198
|
+
key.put(nil, @s3_permissions, {'Content-type' => instance_read(:content_type)}.merge(@s3_headers))
|
199
|
+
rescue RightAws::AwsError => e
|
200
|
+
raise
|
201
|
+
end
|
202
|
+
end
|
203
|
+
@queued_for_write = {}
|
204
|
+
end
|
205
|
+
|
206
|
+
def flush_deletes #:nodoc:
|
207
|
+
@queued_for_delete.each do |path|
|
208
|
+
begin
|
209
|
+
logger.info("[paperclip] deleting #{path}")
|
210
|
+
if file = s3_bucket.key(path)
|
211
|
+
file.delete
|
212
|
+
end
|
213
|
+
rescue RightAws::AwsError
|
214
|
+
# Ignore this.
|
215
|
+
end
|
216
|
+
end
|
217
|
+
@queued_for_delete = []
|
218
|
+
end
|
219
|
+
|
220
|
+
def find_credentials creds
|
221
|
+
case creds
|
222
|
+
when File
|
223
|
+
YAML.load_file(creds.path)
|
224
|
+
when String
|
225
|
+
YAML.load_file(creds)
|
226
|
+
when Hash
|
227
|
+
creds
|
228
|
+
else
|
229
|
+
raise ArgumentError, "Credentials are not a path, file, or hash."
|
230
|
+
end
|
231
|
+
end
|
232
|
+
private :find_credentials
|
233
|
+
|
234
|
+
end
|
235
|
+
|
236
|
+
# Store files in a database.
|
237
|
+
#
|
238
|
+
# Usage is identical to the file system storage version, except:
|
239
|
+
#
|
240
|
+
# 1. In your model specify the "database" storage option; for example:
|
241
|
+
# has_attached_file :avatar, :storage => :database
|
242
|
+
#
|
243
|
+
# 2. The file will be stored in a column called [attachment name]_file (e.g. "avatar_file") by default.
|
244
|
+
#
|
245
|
+
# To specify a different column name, use :column, like this:
|
246
|
+
# has_attached_file :avatar, :storage => :database, :column => 'avatar_data'
|
247
|
+
#
|
248
|
+
# If you have defined different styles, these files will be stored in additional columns called
|
249
|
+
# [attachment name]_[style name]_file (e.g. "avatar_thumb_file") by default.
|
250
|
+
#
|
251
|
+
# To specify different column names for styles, use :column in the style definition, like this:
|
252
|
+
# has_attached_file :avatar,
|
253
|
+
# :storage => :database,
|
254
|
+
# :styles => {
|
255
|
+
# :medium => {:geometry => "300x300>", :column => 'medium_file'},
|
256
|
+
# :thumb => {:geometry => "100x100>", :column => 'thumb_file'}
|
257
|
+
# }
|
258
|
+
#
|
259
|
+
# 3. You need to create these new columns in your migrations or you'll get an exception. Example:
|
260
|
+
# add_column :users, :avatar_file, :binary
|
261
|
+
# add_column :users, :avatar_medium_file, :binary
|
262
|
+
# add_column :users, :avatar_thumb_file, :binary
|
263
|
+
#
|
264
|
+
# Note the "binary" migration will not work for the LONGBLOB type in MySQL for the
|
265
|
+
# file_contents column. You may need to craft a SQL statement for your migration,
|
266
|
+
# depending on which database server you are using. Here's an example migration for MySQL:
|
267
|
+
# execute 'ALTER TABLE users ADD COLUMN avatar_file LONGBLOB'
|
268
|
+
# execute 'ALTER TABLE users ADD COLUMN avatar_medium_file LONGBLOB'
|
269
|
+
# execute 'ALTER TABLE users ADD COLUMN avatar_thumb_file LONGBLOB'
|
270
|
+
#
|
271
|
+
# 4. To avoid performance problems loading all of the BLOB columns every time you access
|
272
|
+
# your ActiveRecord object, a class method is provided on your model called
|
273
|
+
# “select_without_file_columns_for.” This is set to a :select scope hash that will
|
274
|
+
# instruct ActiveRecord::Base.find to load all of the columns except the BLOB/file data columns.
|
275
|
+
#
|
276
|
+
# If you’re using Rails 2.3, you can specify this as a default scope:
|
277
|
+
# default_scope select_without_file_columns_for(:avatar)
|
278
|
+
#
|
279
|
+
# Or if you’re using Rails 2.1 or 2.2 you can use it to create a named scope:
|
280
|
+
# named_scope :without_file_data, select_without_file_columns_for(:avatar)
|
281
|
+
#
|
282
|
+
# 5. By default, URLs will be set to this pattern:
|
283
|
+
# /:relative_root/:class/:attachment/:id?style=:style
|
284
|
+
#
|
285
|
+
# Example:
|
286
|
+
# /app-root-url/users/avatars/23?style=original
|
287
|
+
#
|
288
|
+
# The idea here is that to retrieve a file from the database storage, you will need some
|
289
|
+
# controller's code to be executed.
|
290
|
+
#
|
291
|
+
# Once you pick a controller to use for downloading, you can add this line
|
292
|
+
# to generate the download action for the default URL/action (the plural attachment name),
|
293
|
+
# "avatars" in this example:
|
294
|
+
# downloads_files_for :user, :avatar
|
295
|
+
#
|
296
|
+
# Or you can write a download method manually if there are security, logging or other
|
297
|
+
# requirements.
|
298
|
+
#
|
299
|
+
# If you prefer a different URL for downloading files you can specify that in the model; e.g.:
|
300
|
+
# has_attached_file :avatar, :storage => :database, :url => '/users/show_avatar/:id/:style'
|
301
|
+
#
|
302
|
+
# 6. Add a route for the download to the controller which will handle downloads, if necessary.
|
303
|
+
#
|
304
|
+
# The default URL, /:relative_root/:class/:attachment/:id?style=:style, will be matched by
|
305
|
+
# the default route: :controller/:action/:id
|
306
|
+
#
|
307
|
+
module Database
|
308
|
+
def self.extended base
|
309
|
+
base.instance_eval do
|
310
|
+
@file_columns = @options[:file_columns]
|
311
|
+
if @url == base.class.default_options[:url]
|
312
|
+
@url = ":relative_root/:class/:attachment/:id?style=:style"
|
313
|
+
end
|
314
|
+
end
|
315
|
+
base.class.interpolations[:relative_root] = lambda do |attachment, style|
|
316
|
+
begin
|
317
|
+
if ActionController::AbstractRequest.respond_to?(:relative_url_root)
|
318
|
+
relative_url_root = ActionController::AbstractRequest.relative_url_root
|
319
|
+
end
|
320
|
+
rescue NameError
|
321
|
+
end
|
322
|
+
if !relative_url_root && ActionController::Base.respond_to?(:relative_url_root)
|
323
|
+
relative_url_root = ActionController::Base.relative_url_root
|
324
|
+
end
|
325
|
+
relative_url_root
|
326
|
+
end
|
327
|
+
ActiveRecord::Base.logger.info("[paperclip] Database Storage Initalized.")
|
328
|
+
end
|
329
|
+
|
330
|
+
def column_for_style style
|
331
|
+
@file_columns[style.to_sym]
|
332
|
+
end
|
333
|
+
|
334
|
+
def instance_read_file(style)
|
335
|
+
column = column_for_style(style)
|
336
|
+
responds = instance.respond_to?(column)
|
337
|
+
cached = self.instance_variable_get("@_#{column}")
|
338
|
+
return cached if cached
|
339
|
+
# The blob attribute will not be present if select_without_file_columns_for was used
|
340
|
+
instance.reload :select => column if !instance.attribute_present?(column) && !instance.new_record?
|
341
|
+
instance.send(column) if responds
|
342
|
+
end
|
343
|
+
|
344
|
+
def instance_write_file(style, value)
|
345
|
+
setter = :"#{column_for_style(style)}="
|
346
|
+
responds = instance.respond_to?(setter)
|
347
|
+
self.instance_variable_set("@_#{setter.to_s.chop}", value)
|
348
|
+
instance.send(setter, value) if responds
|
349
|
+
end
|
350
|
+
|
351
|
+
def file_contents(style = default_style)
|
352
|
+
instance_read_file(style)
|
353
|
+
end
|
354
|
+
alias_method :data, :file_contents
|
355
|
+
|
356
|
+
def exists?(style = default_style)
|
357
|
+
!file_contents(style).nil?
|
358
|
+
end
|
359
|
+
|
360
|
+
# Returns representation of the data of the file assigned to the given
|
361
|
+
# style, in the format most representative of the current storage.
|
362
|
+
def to_file style = default_style
|
363
|
+
if @queued_for_write[style]
|
364
|
+
@queued_for_write[style]
|
365
|
+
elsif exists?(style)
|
366
|
+
tempfile = Tempfile.new instance_read(:file_name)
|
367
|
+
tempfile.write file_contents(style)
|
368
|
+
tempfile
|
369
|
+
else
|
370
|
+
nil
|
371
|
+
end
|
372
|
+
end
|
373
|
+
alias_method :to_io, :to_file
|
374
|
+
|
375
|
+
def path style = default_style
|
376
|
+
original_filename.nil? ? nil : column_for_style(style)
|
377
|
+
end
|
378
|
+
|
379
|
+
def assign uploaded_file
|
380
|
+
|
381
|
+
# Assign standard metadata attributes and perform post processing as usual
|
382
|
+
super
|
383
|
+
|
384
|
+
# Save the file contents for all styles in ActiveRecord immediately (before save)
|
385
|
+
@queued_for_write.each do |style, file|
|
386
|
+
instance_write_file(style, file.read)
|
387
|
+
end
|
388
|
+
|
389
|
+
# If we are assigning another Paperclip attachment, then fixup the
|
390
|
+
# filename and content type; necessary since Tempfile is used in to_file
|
391
|
+
if uploaded_file.is_a?(Paperclip::Attachment)
|
392
|
+
instance_write(:file_name, uploaded_file.instance_read(:file_name))
|
393
|
+
instance_write(:content_type, uploaded_file.instance_read(:content_type))
|
394
|
+
end
|
395
|
+
end
|
396
|
+
|
397
|
+
def queue_existing_for_delete
|
398
|
+
[:original, *@styles.keys].uniq.each do |style|
|
399
|
+
instance_write_file(style, nil)
|
400
|
+
end
|
401
|
+
instance_write(:file_name, nil)
|
402
|
+
instance_write(:content_type, nil)
|
403
|
+
instance_write(:file_size, nil)
|
404
|
+
instance_write(:updated_at, nil)
|
405
|
+
end
|
406
|
+
|
407
|
+
def flush_writes
|
408
|
+
@queued_for_write = {}
|
409
|
+
end
|
410
|
+
|
411
|
+
def flush_deletes
|
412
|
+
@queued_for_delete = []
|
413
|
+
end
|
414
|
+
|
415
|
+
module ControllerClassMethods
|
416
|
+
def self.included(base)
|
417
|
+
base.extend(self)
|
418
|
+
end
|
419
|
+
def downloads_files_for(model, attachment)
|
420
|
+
define_method("#{attachment.to_s.pluralize}") do
|
421
|
+
model_record = Object.const_get(model.to_s.camelize.to_sym).find(params[:id])
|
422
|
+
style = params[:style] ? params[:style] : 'original'
|
423
|
+
send_data model_record.send(attachment).file_contents(style),
|
424
|
+
:filename => model_record.send("#{attachment}_file_name".to_sym),
|
425
|
+
:type => model_record.send("#{attachment}_content_type".to_sym)
|
426
|
+
end
|
427
|
+
end
|
428
|
+
end
|
429
|
+
end
|
430
|
+
|
431
|
+
end
|
432
|
+
end
|