forked from thoughtbot/paperclip
-
Notifications
You must be signed in to change notification settings - Fork 0
/
attachment.rb
226 lines (196 loc) · 7.41 KB
/
attachment.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
module Paperclip
# The Attachment class manages the files for a given attachment. It saves when the model saves,
# deletes when the model is destroyed, and processes the file upon assignment.
class Attachment
attr_reader :name, :instance, :file, :styles, :default_style
# Creates an Attachment object. +name+ is the name of the attachment, +instance+ is the
# ActiveRecord object instance it's attached to, and +options+ is the same as the hash
# passed to +has_attached_file+.
def initialize name, instance, options
@name = name
@instance = instance
@url = options[:url] ||
"/:attachment/:id/:style/:basename.:extension"
@path = options[:path] ||
":rails_root/public/:attachment/:id/:style/:basename.:extension"
@styles = options[:styles] || {}
@default_url = options[:default_url] || "/:attachment/:style/missing.png"
@validations = options[:validations] || []
@default_style = options[:default_style] || :original
@queued_for_delete = []
@processed_files = {}
@errors = []
@validation_errors = nil
@dirty = false
normalize_style_definition
@file = File.new(path) if original_filename && File.exists?(path)
end
# What gets called when you call instance.attachment = File. It clears errors,
# assigns attributes, processes the file, and runs validations. It also queues up
# the previous file for deletion, to be flushed away on #save of its host.
def assign uploaded_file
queue_existing_for_delete
@errors = []
@validation_errors = nil
return nil unless valid_file?(uploaded_file)
@file = uploaded_file.to_tempfile
@instance[:"#{@name}_file_name"] = uploaded_file.original_filename
@instance[:"#{@name}_content_type"] = uploaded_file.content_type
@instance[:"#{@name}_file_size"] = uploaded_file.size
@dirty = true
post_process
ensure
validate
end
# Returns the public URL of the attachment, with a given style. Note that this
# does not necessarily need to point to a file that your web server can access
# and can point to an action in your app, if you need fine grained security.
# This is not recommended if you don't need the security, however, for
# performance reasons.
def url style = nil
interpolate(@url, style) || interpolate(@default_url, style)
end
# Alias to +url+
def to_s style = nil
url(style)
end
# Returns true if there are any errors on this attachment.
def valid?
errors.length == 0
end
# Returns an array containing the errors on this attachment.
def errors
@errors.compact.uniq
end
# Returns true if there are changes that need to be saved.
def dirty?
@dirty
end
# Saves the file, if there are no errors. If there are, it flushes them to
# the instance's errors and returns false, cancelling the save.
def save
if valid?
flush_deletes
flush_writes
true
else
flush_errors
false
end
end
# Returns an +IO+ representing the data of the file assigned to the given
# style. Useful for streaming with +send_file+.
def to_io style = nil
begin
@processed_files[style] || File.new(path(style))
rescue Errno::ENOENT
nil
end
end
# Returns the name of the file as originally assigned, and as lives in the
# <attachment>_file_name attribute of the model.
def original_filename
instance[:"#{name}_file_name"]
end
# A hash of procs that are run during the interpolation of a path or url.
# A variable of the format :name will be replaced with the return value of
# the proc named ":name". Each lambda takes the attachment and the current
# style as arguments. This hash can be added to with your own proc if
# necessary.
def self.interpolations
@interpolations ||= {
:rails_root => lambda{|attachment,style| RAILS_ROOT },
:class => lambda{|attachment,style| attachment.instance.class.to_s.pluralize },
:basename => lambda do |attachment,style|
attachment.original_filename.gsub(/\.(.*?)$/, "")
end,
:extension => lambda do |attachment,style|
((style = attachment.styles[style]) && style.last) ||
File.extname(attachment.original_filename).gsub(/^\.+/, "")
end,
:id => lambda{|attachment,style| attachment.instance.id },
:attachment => lambda{|attachment,style| attachment.name.to_s.pluralize },
:style => lambda{|attachment,style| style || attachment.default_style },
}
end
private
def valid_file? file #:nodoc:
file.respond_to?(:original_filename) && file.respond_to?(:content_type)
end
def validate #:nodoc:
unless @validation_errors
@validation_errors = @validations.collect do |v|
v.call(self, instance)
end.flatten.compact.uniq
@errors += @validation_errors
end
end
def normalize_style_definition
@styles.each do |name, args|
dimensions, format = [args, nil].flatten[0..1]
format = nil if format == ""
@styles[name] = [dimensions, format]
end
end
def post_process #:nodoc:
return nil if @file.nil?
@styles.each do |name, args|
begin
dimensions, format = args
@processed_files[name] = Thumbnail.make(self.file,
dimensions,
format,
@whiny_thumbnails)
rescue Errno::ENOENT => e
@errors << "could not be processed because the file does not exist."
rescue PaperclipError => e
@errors << e.message
end
end
@processed_files[:original] = @file
end
def interpolate pattern, style = nil #:nodoc:
style ||= @default_style
pattern = pattern.dup
self.class.interpolations.each do |tag, l|
pattern.gsub!(/:#{tag}/) do |match|
l.call( self, style )
end
end
pattern.gsub(%r{/+}, "/")
end
def path style = nil #:nodoc:
interpolate(@path, style)
end
def queue_existing_for_delete #:nodoc:
@queued_for_delete += @processed_files.values
@file = nil
@processed_files = {}
@instance[:"#{@name}_file_name"] = nil
@instance[:"#{@name}_content_type"] = nil
@instance[:"#{@name}_file_size"] = nil
end
def flush_errors #:nodoc:
@errors.each do |error|
instance.errors.add(name, error)
end
end
def flush_writes #:nodoc:
@processed_files.each do |style, file|
FileUtils.mkdir_p( File.dirname(path(style)) )
@processed_files[style] = file.stream_to(path(style)) unless file.path == path(style)
end
@file = @processed_files[nil]
end
def flush_deletes #:nodoc:
@queued_for_delete.compact.each do |file|
begin
FileUtils.rm(file.path)
rescue Errno::ENOENT => e
# ignore them
end
end
@queued_for_delete = []
end
end
end