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.



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

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

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

  @url                   = options[:url]
  @url                   = @url.call(self) if @url.is_a?(Proc)
  @path                  = options[:path]
  @path                  = @path.call(self) if @path.is_a?(Proc)
  @styles                = options[:styles]
  @normalized_styles     = nil
  @default_url           = options[:default_url]
  @default_style         = options[:default_style]
  @storage               = options[:storage]
  @use_timestamp         = options[:use_timestamp]
  @whiny                 = options[:whiny_thumbnails] || options[:whiny]
  @use_default_time_zone = options[:use_default_time_zone]
  @hash_digest           = options[:hash_digest]
  @hash_data             = options[:hash_data]
  @hash_secret           = options[:hash_secret]
  @convert_options       = options[:convert_options]
  @processors            = options[:processors]
  @options               = options
  @post_processing       = true
  @queued_for_delete     = []
  @queued_for_write      = {}
  @errors                = {}
  @dirty                 = false

  initialize_storage
end

Instance Attribute Details

#convert_options ⇒ Object (readonly)

Returns the value of attribute convert_options.



27
28
29
 
# File 'lib/paperclip/attachment.rb', line 27

def convert_options
  @convert_options
end

#default_style ⇒ Object (readonly)

Returns the value of attribute default_style.



27
28
29
 
# File 'lib/paperclip/attachment.rb', line 27

def default_style
  @default_style
end

#instance ⇒ Object (readonly)

Returns the value of attribute instance.



27
28
29
 
# File 'lib/paperclip/attachment.rb', line 27

def instance
  @instance
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



27
28
29
 
# File 'lib/paperclip/attachment.rb', line 27

def name
  @name
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



27
28
29
 
# File 'lib/paperclip/attachment.rb', line 27

def options
  @options
end

#post_processing ⇒ Object

Returns the value of attribute post_processing.



28
29
30
 
# File 'lib/paperclip/attachment.rb', line 28

def post_processing
  @post_processing
end

#queued_for_write ⇒ Object (readonly)

Returns the value of attribute queued_for_write.



27
28
29
 
# File 'lib/paperclip/attachment.rb', line 27

def queued_for_write
  @queued_for_write
end

#whiny ⇒ Object (readonly)

Returns the value of attribute whiny.



27
28
29
 
# File 'lib/paperclip/attachment.rb', line 27

def whiny
  @whiny
end

Class Method Details

.default_options ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/paperclip/attachment.rb', line 9

def self.default_options
  @default_options ||= {
    :url                   => "/system/:attachment/:id/:style/:filename",
    :path                  => ":rails_root/public:url",
    :styles                => {},
    :processors            => [:thumbnail],
    :convert_options       => {},
    :default_url           => "/:attachment/:style/missing.png",
    :default_style         => :original,
    :storage               => :filesystem,
    :use_timestamp         => true,
    :whiny                 => Paperclip.options[:whiny] || Paperclip.options[:whiny_thumbnails],
    :use_default_time_zone => true,
    :hash_digest           => "SHA1",
    :hash_data             => ":class/:attachment/:id/:style/:updated_at"
  }
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.



237
238
239
240
241
242
 
# File 'lib/paperclip/attachment.rb', line 237

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, processes the file, and runs validations. 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

If the file that is assigned is not valid, the processing (i.e. thumbnailing, etc) will NOT be run.



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

def assign uploaded_file
  ensure_required_accessors!

  if uploaded_file.is_a?(Paperclip::Attachment)
    uploaded_file = uploaded_file.to_file(:original)
    close_uploaded_file = uploaded_file.respond_to?(:close)
  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?

  @queued_for_write[:original]   = to_tempfile(uploaded_file)
  instance_write(:file_name,       uploaded_file.original_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))
  instance_write(:updated_at,      Time.now)

  @dirty = true

  post_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]))
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.



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

def clear
  queue_existing_for_delete
  @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.



200
201
202
 
# File 'lib/paperclip/attachment.rb', line 200

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.



175
176
177
178
 
# File 'lib/paperclip/attachment.rb', line 175

def destroy
  clear
  save
end

#dirty? ⇒ Boolean

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

Returns:

  • (Boolean) 


151
152
153
 
# File 'lib/paperclip/attachment.rb', line 151

def dirty?
  @dirty
end

#errors ⇒ Object

Returns an array containing the errors on this attachment.



146
147
148
 
# File 'lib/paperclip/attachment.rb', line 146

def errors
  @errors
end

#file? ⇒ Boolean Also known as: present?

Returns true if a file has been assigned.

Returns:

  • (Boolean) 


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

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.



194
195
196
 
# File 'lib/paperclip/attachment.rb', line 194

def fingerprint
  instance_read(:fingerprint) || (@queued_for_write[:original] && generate_fingerprint(@queued_for_write[:original]))
end

#generate_fingerprint(source) ⇒ Object 



226
227
228
229
230
 
# File 'lib/paperclip/attachment.rb', line 226

def generate_fingerprint(source)
  data = source.read
  source.rewind if source.respond_to?(:rewind)
  Digest::MD5.hexdigest(data)
end

#hash(style_name = default_style) ⇒ Object

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

Raises:

  • (ArgumentError) 


219
220
221
222
223
224
 
# File 'lib/paperclip/attachment.rb', line 219

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

#instance_read(attr) ⇒ Object

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



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

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).



279
280
281
282
283
284
 
# File 'lib/paperclip/attachment.rb', line 279

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.



182
183
184
 
# File 'lib/paperclip/attachment.rb', line 182

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.



136
137
138
 
# File 'lib/paperclip/attachment.rb', line 136

def path style_name = default_style
  original_filename.nil? ? nil : interpolate(@path, style_name)
end

#processors ⇒ Object 



76
77
78
 
# File 'lib/paperclip/attachment.rb', line 76

def processors
  @processors.respond_to?(:call) ? @processors.call(instance) : @processors
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.



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/paperclip/attachment.rb', line 248

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 }
    post_process(*style_args)

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

    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.



157
158
159
160
161
162
 
# File 'lib/paperclip/attachment.rb', line 157

def save
  flush_deletes
  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.



188
189
190
 
# File 'lib/paperclip/attachment.rb', line 188

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

#styles ⇒ Object 



66
67
68
69
70
71
72
73
74
 
# File 'lib/paperclip/attachment.rb', line 66

def styles
  if @styles.respond_to?(:call) || !@normalized_styles
    @normalized_styles = {}
    (@styles.respond_to?(:call) ? @styles.call(self) : @styles).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.



213
214
215
 
# File 'lib/paperclip/attachment.rb', line 213

def time_zone
  @use_default_time_zone ? Time.zone_default : Time.zone
end

#to_s(style_name = default_style) ⇒ Object

Alias to url



141
142
143
 
# File 'lib/paperclip/attachment.rb', line 141

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.



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

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

#url(style_name = default_style, use_timestamp = @use_timestamp) ⇒ Object

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. Set use_timestamp to false if you want to stop the attachment update time appended to the url



127
128
129
130
 
# File 'lib/paperclip/attachment.rb', line 127

def url(style_name = default_style, use_timestamp = @use_timestamp)
  url = original_filename.nil? ? interpolate(@default_url, style_name) : interpolate(@url, style_name)
  use_timestamp && updated_at ? [url, updated_at].compact.join(url.include?("?") ? "&" : "?") : url
end