Class: Paperclip::Attachment

Inherits:
Object
  • Object
show all
Includes:
IOStream
Defined in:
lib/paperclip/attachment.rb

Overview

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.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from IOStream

#stream_to, #to_tempfile

Constructor Details

#initialize(name, instance, options = {}) ⇒ Attachment

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.

Options include:

url - a relative URL of the attachment. This is interpolated using interpolator path - where on the filesystem to store the attachment. This is interpolated using interpolator styles - a hash of options for processing the attachment. See has_attached_file for the details only_process - style args to be run through the post-processor. This defaults to the empty list default_url - a URL for the missing image default_style - the style to use when don’t specify an argument to e.g. #url, #path storage - the storage mechanism. Defaults to :filesystem use_timestamp - whether to append an anti-caching timestamp to image URLs. Defaults to true whiny, whiny_thumbnails - whether to raise when thumbnailing fails use_default_time_zone - related to use_timestamp. Defaults to true hash_digest - a string representing a class that will be used to hash URLs for obfuscation hash_data - the relative URL for the hash data. This is interpolated using interpolator hash_secret - a secret passed to the hash_digest convert_options - flags passed to the convert command for processing source_file_options - flags passed to the convert command that controls how the file is read processors - classes that transform the attachment. Defaults to [:thumbnail] preserve_files - whether to keep files on the filesystem when deleting to clearing the attachment. Defaults to false interpolator - the object used to interpolate filenames and URLs. Defaults to Paperclip::Interpolations url_generator - the object used to generate URLs, using the interpolator. Defaults to Paperclip::UrlGenerator escape_url - Perform URI escaping to URLs. Defaults to true



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/paperclip/attachment.rb', line 67

def initialize(name, instance, options = {})
  @name              = name
  @instance          = instance

  options = self.class.default_options.merge(options)

  @options               = options
  @post_processing       = true
  @queued_for_delete     = []
  @queued_for_write      = {}
  @errors                = {}
  @dirty                 = false
  @interpolator          = options[:interpolator]
  @url_generator         = options[:url_generator].new(self, @options)
  @source_file_options   = options[:source_file_options]
  @whiny                 = options[:whiny]

  initialize_storage
end

Instance Attribute Details

#convert_options ⇒ Object (readonly)

Returns the value of attribute convert_options.



37
38
39
 
# File 'lib/paperclip/attachment.rb', line 37

def convert_options
  @convert_options
end

#default_style ⇒ Object (readonly)

Returns the value of attribute default_style.



37
38
39
 
# File 'lib/paperclip/attachment.rb', line 37

def default_style
  @default_style
end

#instance ⇒ Object (readonly)

Returns the value of attribute instance.



37
38
39
 
# File 'lib/paperclip/attachment.rb', line 37

def instance
  @instance
end

#interpolator ⇒ Object (readonly)

Returns the value of attribute interpolator.



37
38
39
 
# File 'lib/paperclip/attachment.rb', line 37

def interpolator
  @interpolator
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



37
38
39
 
# File 'lib/paperclip/attachment.rb', line 37

def name
  @name
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



37
38
39
 
# File 'lib/paperclip/attachment.rb', line 37

def options
  @options
end

#post_processing ⇒ Object

Returns the value of attribute post_processing.



39
40
41
 
# File 'lib/paperclip/attachment.rb', line 39

def post_processing
  @post_processing
end

#queued_for_write ⇒ Object (readonly)

Returns the value of attribute queued_for_write.



37
38
39
 
# File 'lib/paperclip/attachment.rb', line 37

def queued_for_write
  @queued_for_write
end

#source_file_options ⇒ Object (readonly)

Returns the value of attribute source_file_options.



37
38
39
 
# File 'lib/paperclip/attachment.rb', line 37

def source_file_options
  @source_file_options
end

#whiny ⇒ Object (readonly)

Returns the value of attribute whiny.



37
38
39
 
# File 'lib/paperclip/attachment.rb', line 37

def whiny
  @whiny
end

Class Method Details

.default_options ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/paperclip/attachment.rb', line 12

def self.default_options
  @default_options ||= {
    :convert_options       => {},
    :default_style         => :original,
    :default_url           => "/:attachment/:style/missing.png",
    :escape_url            => true,
    :restricted_characters => /[&$+,\/:;=?@<>\[\]\{\}\|\\\^~%# ]/,
    :hash_data             => ":class/:attachment/:id/:style/:updated_at",
    :hash_digest           => "SHA1",
    :interpolator          => Paperclip::Interpolations,
    :only_process          => [],
    :path                  => ":rails_root/public:url",
    :preserve_files        => false,
    :processors            => [:thumbnail],
    :source_file_options   => {},
    :storage               => :filesystem,
    :styles                => {},
    :url                   => "/system/:attachment/:id/:style/:filename",
    :url_generator         => Paperclip::UrlGenerator,
    :use_default_time_zone => true,
    :use_timestamp         => true,
    :whiny                 => Paperclip.options[:whiny] || Paperclip.options[:whiny_thumbnails]
  }
end

.interpolations ⇒ Object

Paths and URLs can have a number of variables interpolated into them to vary the storage location based on name, id, style, class, etc. This method is a deprecated access into supplying and retrieving these interpolations. Future access should use either Paperclip.interpolates or extend the Paperclip::Interpolations module directly.



312
313
314
315
316
317
 
# File 'lib/paperclip/attachment.rb', line 312

def self.interpolations
  warn('[DEPRECATION] Paperclip::Attachment.interpolations is deprecated ' +
       'and will be removed from future versions. ' +
       'Use Paperclip.interpolates instead')
  Paperclip::Interpolations
end

Instance Method Details

#assign(uploaded_file) ⇒ Object

What gets called when you call instance.attachment = File. It clears errors, assigns attributes, and processes the file. It also queues up the previous file for deletion, to be flushed away on #save of its host. In addition to form uploads, you can also assign another Paperclip attachment:

new_user.avatar = old_user.avatar



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
 
# File 'lib/paperclip/attachment.rb', line 93

def assign uploaded_file
  ensure_required_accessors!

  if uploaded_file.is_a?(Paperclip::Attachment)
    uploaded_filename = uploaded_file.original_filename
    uploaded_file = uploaded_file.to_file(:original)
    close_uploaded_file = uploaded_file.respond_to?(:close)
  else
    instance_write(:uploaded_file, uploaded_file) if uploaded_file
  end

  return nil unless valid_assignment?(uploaded_file)

  uploaded_file.binmode if uploaded_file.respond_to? :binmode
  self.clear

  return nil if uploaded_file.nil?

  uploaded_filename ||= uploaded_file.original_filename
  stores_fingerprint             = @instance.respond_to?("#{name}_fingerprint".to_sym)
  @queued_for_write[:original]   = to_tempfile(uploaded_file)
  instance_write(:file_name,       cleanup_filename(uploaded_filename.strip))
  instance_write(:content_type,    uploaded_file.content_type.to_s.strip)
  instance_write(:file_size,       uploaded_file.size.to_i)
  instance_write(:fingerprint,     generate_fingerprint(uploaded_file)) if stores_fingerprint
  instance_write(:updated_at,      Time.now)

  @dirty = true

  post_process(*@options[:only_process]) if post_processing

  # Reset the file size if the original file was reprocessed.
  instance_write(:file_size,   @queued_for_write[:original].size.to_i)
  instance_write(:fingerprint, generate_fingerprint(@queued_for_write[:original])) if stores_fingerprint
ensure
  uploaded_file.close if close_uploaded_file
end

#clear ⇒ Object

Clears out the attachment. Has the same effect as previously assigning nil to the attachment. Does NOT save. If you wish to clear AND save, use #destroy.



224
225
226
227
228
 
# File 'lib/paperclip/attachment.rb', line 224

def clear
  queue_existing_for_delete
  @queued_for_write  = {}
  @errors            = {}
end

#content_type ⇒ Object

Returns the content_type of the file as originally assigned, and lives in the <attachment>_content_type attribute of the model.



271
272
273
 
# File 'lib/paperclip/attachment.rb', line 271

def content_type
  instance_read(:content_type)
end

#destroy ⇒ Object

Destroys the attachment. Has the same effect as previously assigning nil to the attachment *and saving*. This is permanent. If you wish to wipe out the existing attachment but not save, use #clear.



233
234
235
236
237
238
 
# File 'lib/paperclip/attachment.rb', line 233

def destroy
  unless @options[:preserve_files]
    clear
    save
  end
end

#dirty? ⇒ Boolean

Returns true if there are changes that need to be saved.

Returns:

  • (Boolean) 


208
209
210
 
# File 'lib/paperclip/attachment.rb', line 208

def dirty?
  @dirty
end

#errors ⇒ Object

Returns an array containing the errors on this attachment.



203
204
205
 
# File 'lib/paperclip/attachment.rb', line 203

def errors
  @errors
end

#file? ⇒ Boolean Also known as: present?

Returns true if a file has been assigned.

Returns:

  • (Boolean) 


347
348
349
 
# File 'lib/paperclip/attachment.rb', line 347

def file?
  !original_filename.blank?
end

#fingerprint ⇒ Object

Returns the hash of the file as originally assigned, and lives in the <attachment>_fingerprint attribute of the model.



259
260
261
262
263
264
265
266
267
 
# File 'lib/paperclip/attachment.rb', line 259

def fingerprint
  if instance_read(:fingerprint)
    instance_read(:fingerprint)
  elsif @instance.respond_to?("#{name}_fingerprint".to_sym)
    @queued_for_write[:original] && generate_fingerprint(@queued_for_write[:original])
  else
    nil
  end
end

#generate_fingerprint(source) ⇒ Object 



297
298
299
300
301
302
303
304
305
 
# File 'lib/paperclip/attachment.rb', line 297

def generate_fingerprint(source)
  if source.respond_to?(:path) && source.path && !source.path.blank?
    Digest::MD5.file(source.path).to_s
  else
    data = source.read
    source.rewind if source.respond_to?(:rewind)
    Digest::MD5.hexdigest(data)
  end
end

#hash_key(style_name = default_style) ⇒ Object

Returns a unique hash suitable for obfuscating the URL of an otherwise publicly viewable attachment.

Raises:

  • (ArgumentError) 


290
291
292
293
294
295
 
# File 'lib/paperclip/attachment.rb', line 290

def hash_key(style_name = default_style)
  raise ArgumentError, "Unable to generate hash without :hash_secret" unless @options[:hash_secret]
  require 'openssl' unless defined?(OpenSSL)
  data = interpolate(@options[:hash_data], style_name)
  OpenSSL::HMAC.hexdigest(OpenSSL::Digest.const_get(@options[:hash_digest]).new, @options[:hash_secret], data)
end

#instance_read(attr) ⇒ Object

Reads the attachment-specific attribute on the instance. See instance_write for more details.



365
366
367
368
369
370
371
 
# File 'lib/paperclip/attachment.rb', line 365

def instance_read(attr)
  getter = :"#{name}_#{attr}"
  responds = instance.respond_to?(getter)
  cached = self.instance_variable_get("@_#{getter}")
  return cached if cached
  instance.send(getter) if responds || attr.to_s == "file_name"
end

#instance_write(attr, value) ⇒ Object

Writes the attachment-specific attribute on the instance. For example, instance_write(:file_name, “me.jpg”) will write “me.jpg” to the instance’s “avatar_file_name” field (assuming the attachment is called avatar).



356
357
358
359
360
361
 
# File 'lib/paperclip/attachment.rb', line 356

def instance_write(attr, value)
  setter = :"#{name}_#{attr}="
  responds = instance.respond_to?(setter)
  self.instance_variable_set("@_#{setter.to_s.chop}", value)
  instance.send(setter, value) if responds || attr.to_s == "file_name"
end

#original_filename ⇒ Object

Returns the name of the file as originally assigned, and lives in the <attachment>_file_name attribute of the model.



247
248
249
 
# File 'lib/paperclip/attachment.rb', line 247

def original_filename
  instance_read(:file_name)
end

#path(style_name = default_style) ⇒ Object

Returns the path of the attachment as defined by the :path option. If the file is stored in the filesystem the path refers to the path of the file on disk. If the file is stored in S3, the path is the “key” part of the URL, and the :bucket option refers to the S3 bucket.



167
168
169
170
 
# File 'lib/paperclip/attachment.rb', line 167

def path(style_name = default_style)
  path = original_filename.nil? ? nil : interpolate(path_option, style_name)
  path.respond_to?(:unescape) ? path.unescape : path
end

#processors ⇒ Object 



192
193
194
195
196
197
198
199
200
 
# File 'lib/paperclip/attachment.rb', line 192

def processors
  processing_option = @options[:processors]

  if processing_option.respond_to?(:call)
    processing_option.call(instance)
  else
    processing_option
  end
end

#reprocess!(*style_args) ⇒ Object

This method really shouldn’t be called that often. It’s expected use is in the paperclip:refresh rake task and that’s it. It will regenerate all thumbnails forcefully, by reobtaining the original file and going through the post-process again.



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/paperclip/attachment.rb', line 323

def reprocess!(*style_args)
  new_original = Tempfile.new("paperclip-reprocess")
  new_original.binmode
  if old_original = to_file(:original)
    new_original.write( old_original.respond_to?(:get) ? old_original.get : old_original.read )
    new_original.rewind

    @queued_for_write = { :original => new_original }
    instance_write(:updated_at, Time.now)
    post_process(*style_args)

    old_original.close if old_original.respond_to?(:close)
    old_original.unlink if old_original.respond_to?(:unlink)

    save
  else
    true
  end
rescue Errno::EACCES => e
  warn "#{e} - skipping file"
  false
end

#save ⇒ Object

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.



214
215
216
217
218
219
 
# File 'lib/paperclip/attachment.rb', line 214

def save
  flush_deletes unless @options[:keep_old_files]
  flush_writes
  @dirty = false
  true
end

#size ⇒ Object

Returns the size of the file as originally assigned, and lives in the <attachment>_file_size attribute of the model.



253
254
255
 
# File 'lib/paperclip/attachment.rb', line 253

def size
  instance_read(:file_size) || (@queued_for_write[:original] && @queued_for_write[:original].size)
end

#styles ⇒ Object 



181
182
183
184
185
186
187
188
189
190
 
# File 'lib/paperclip/attachment.rb', line 181

def styles
  styling_option = @options[:styles]
  if styling_option.respond_to?(:call) || !@normalized_styles
    @normalized_styles = ActiveSupport::OrderedHash.new
    (styling_option.respond_to?(:call) ? styling_option.call(self) : styling_option).each do |name, args|
      @normalized_styles[name] = Paperclip::Style.new(name, args.dup, self)
    end
  end
  @normalized_styles
end

#time_zone ⇒ Object

The time zone to use for timestamp interpolation. Using the default time zone ensures that results are consistent across all threads.



284
285
286
 
# File 'lib/paperclip/attachment.rb', line 284

def time_zone
  @options[:use_default_time_zone] ? Time.zone_default : Time.zone
end

#to_s(style_name = default_style) ⇒ Object

Alias to url



173
174
175
 
# File 'lib/paperclip/attachment.rb', line 173

def to_s style_name = default_style
  url(style_name)
end

#updated_at ⇒ Object

Returns the last modified time of the file as originally assigned, and lives in the <attachment>_updated_at attribute of the model.



277
278
279
280
 
# File 'lib/paperclip/attachment.rb', line 277

def updated_at
  time = instance_read(:updated_at)
  time && time.to_f.to_i
end

#uploaded_file ⇒ Object

Returns the uploaded file if present.



241
242
243
 
# File 'lib/paperclip/attachment.rb', line 241

def uploaded_file
  instance_read(:uploaded_file)
end

#url(style_name = default_style, options = {}) ⇒ Object

Returns the public URL of the attachment with a given style. This does not necessarily need to point to a file that your Web server can access and can instead point to an action in your app, for example for fine grained security; this has a serious performance tradeoff.

Options:

timestamp - Add a timestamp to the end of the URL. Default: true. escape - Perform URI escaping to the URL. Default: true.

Global controls (set on has_attached_file):

interpolator - The object that fills in a URL pattern’s variables. default_url - The image to show when the attachment has no image. url - The URL for a saved image. url_generator - The object that generates a URL. Default: Paperclip::UrlGenerator.

As mentioned just above, the object that generates this URL can be passed in, for finer control. This object must respond to two methods:

#new(Paperclip::Attachment, options_hash) #for(style_name, options_hash)



153
154
155
156
157
158
159
160
161
 
# File 'lib/paperclip/attachment.rb', line 153

def url(style_name = default_style, options = {})
  default_options = {:timestamp => @options[:use_timestamp], :escape => @options[:escape_url]}

  if options == true || options == false # Backwards compatibility.
    @url_generator.for(style_name, default_options.merge(:timestamp => options))
  else
    @url_generator.for(style_name, default_options.merge(options))
  end
end