Class: ActiveStorage::Blob

Inherits:
Record
  • Object
show all
Includes:
Analyzable, Identifiable, Representable
Defined in:
app/models/active_storage/blob.rb

Overview

Active Storage Blob

A blob is a record that contains the metadata about a file and a key for where that file resides on the service. Blobs can be created in two ways:

  1. Ahead of the file being uploaded server-side to the service, via create_and_upload!. A rewindable io with the file contents must be available at the server for this operation.

  2. Ahead of the file being directly uploaded client-side to the service, via create_before_direct_upload!.

The first option doesn’t require any client-side JavaScript integration, and can be used by any other back-end service that deals with files. The second option is faster, since you’re not using your own server as a staging point for uploads, and can work with deployments like Heroku that do not provide large amounts of disk space.

Blobs are intended to be immutable in as-so-far as their reference to a specific file goes. You’re allowed to update a blob’s metadata on a subsequent pass, but you should not update the key or change the uploaded file. If you need to create a derivative or otherwise change the blob, simply create a new blob and purge the old one.

Defined Under Namespace

Modules: Analyzable, Identifiable, Representable

Constant Summary collapse

MINIMUM_TOKEN_LENGTH = 
28

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Representable

#preprocessed, #preview, #previewable?, #representable?, #representation, #variable?, #variant

Methods included from Identifiable

#identified?, #identify, #identify_without_saving

Methods included from Analyzable

#analyze, #analyze_later, #analyzed?

Class Method Details

.build_after_unfurling(key: nil, io:, filename:, content_type: nil, metadata: nil, service_name: nil, identify: true, record: nil) ⇒ Object

:nodoc:



87
88
89
90
91
 
# File 'app/models/active_storage/blob.rb', line 87

def build_after_unfurling(key: nil, io:, filename:, content_type: nil, metadata: nil, service_name: nil, identify: true, record: nil) # :nodoc:
  new(key: key, filename: filename, content_type: content_type, metadata: metadata, service_name: service_name).tap do |blob|
    blob.unfurl(io, identify: identify)
  end
end

.combine_signed_id_purposes(purpose) ⇒ Object

Customize signed ID purposes for backwards compatibility.



127
128
129
 
# File 'app/models/active_storage/blob.rb', line 127

def combine_signed_id_purposes(purpose) # :nodoc:
  purpose.to_s
end

.compose(blobs, filename:, content_type: nil, metadata: nil) ⇒ Object

Concatenate multiple blobs into a single “composed” blob.

Raises:

  • (ActiveRecord::RecordNotSaved) 


148
149
150
151
152
153
154
155
156
157
 
# File 'app/models/active_storage/blob.rb', line 148

def compose(blobs, filename:, content_type: nil, metadata: nil)
  raise ActiveRecord::RecordNotSaved, "All blobs must be persisted." if blobs.any?(&:new_record?)

  content_type ||= blobs.pluck(:content_type).compact.first

  new(filename: filename, content_type: content_type, metadata: metadata, byte_size: blobs.sum(&:byte_size)).tap do |combined_blob|
    combined_blob.compose(blobs.pluck(:key))
    combined_blob.save!
  end
end

.create_after_unfurling!(key: nil, io:, filename:, content_type: nil, metadata: nil, service_name: nil, identify: true, record: nil) ⇒ Object

:nodoc:



93
94
95
 
# File 'app/models/active_storage/blob.rb', line 93

def create_after_unfurling!(key: nil, io:, filename:, content_type: nil, metadata: nil, service_name: nil, identify: true, record: nil) # :nodoc:
  build_after_unfurling(key: key, io: io, filename: filename, content_type: content_type, metadata: metadata, service_name: service_name, identify: identify).tap(&:save!)
end

.create_and_upload!(key: nil, io:, filename:, content_type: nil, metadata: nil, service_name: nil, identify: true, record: nil) ⇒ Object

Creates a new blob instance and then uploads the contents of the given io to the service. The blob instance is going to be saved before the upload begins to prevent the upload clobbering another due to key collisions. When providing a content type, pass identify: false to bypass automatic content type inference.



102
103
104
105
106
 
# File 'app/models/active_storage/blob.rb', line 102

def create_and_upload!(key: nil, io:, filename:, content_type: nil, metadata: nil, service_name: nil, identify: true, record: nil)
  create_after_unfurling!(key: key, io: io, filename: filename, content_type: content_type, metadata: metadata, service_name: service_name, identify: identify).tap do |blob|
    blob.upload_without_unfurling(io)
  end
end

.create_before_direct_upload!(key: nil, filename:, byte_size:, checksum:, content_type: nil, metadata: nil, service_name: nil, record: nil) ⇒ Object

Returns a saved blob without uploading a file to the service. This blob will point to a key where there is no file yet. It’s intended to be used together with a client-side upload, which will first create the blob in order to produce the signed URL for uploading. This signed URL points to the key generated by the blob. Once the form using the direct upload is submitted, the blob can be associated with the right record using the signed ID.



113
114
115
 
# File 'app/models/active_storage/blob.rb', line 113

def create_before_direct_upload!(key: nil, filename:, byte_size:, checksum:, content_type: nil, metadata: nil, service_name: nil, record: nil)
  create! key: key, filename: filename, byte_size: byte_size, checksum: checksum, content_type: content_type, metadata: metadata, service_name: service_name
end

.find_signed(id, record: nil, purpose: :blob_id) ⇒ Object

You can use the signed ID of a blob to refer to it on the client side without fear of tampering. This is particularly helpful for direct uploads where the client-side needs to refer to the blob that was created ahead of the upload itself on form submission.

The signed ID is also used to create stable URLs for the blob through the BlobsController.



75
76
77
 
# File 'app/models/active_storage/blob.rb', line 75

def find_signed(id, record: nil, purpose: :blob_id)
  super(id, purpose: purpose)
end

.find_signed!(id, record: nil, purpose: :blob_id) ⇒ Object

Works like find_signed, but will raise an ActiveSupport::MessageVerifier::InvalidSignature exception if the signed_id has either expired, has a purpose mismatch, is for another record, or has been tampered with. It will also raise an ActiveRecord::RecordNotFound exception if the valid signed id can’t find a record.



83
84
85
 
# File 'app/models/active_storage/blob.rb', line 83

def find_signed!(id, record: nil, purpose: :blob_id)
  super(id, purpose: purpose)
end

.generate_unique_secure_token(length: MINIMUM_TOKEN_LENGTH) ⇒ Object

To prevent problems with case-insensitive filesystems, especially in combination with databases which treat indices as case-sensitive, all blob keys generated are going to only contain the base-36 character alphabet and will therefore be lowercase. To maintain the same or higher amount of entropy as in the base-58 encoding used by has_secure_token the number of bytes used is increased to 28 from the standard 24



122
123
124
 
# File 'app/models/active_storage/blob.rb', line 122

def generate_unique_secure_token(length: MINIMUM_TOKEN_LENGTH)
  SecureRandom.base36(length)
end

.scope_for_strict_loading ⇒ Object

:nodoc:



139
140
141
142
143
144
145
 
# File 'app/models/active_storage/blob.rb', line 139

def scope_for_strict_loading # :nodoc:
  if strict_loading_by_default? && ActiveStorage.track_variants
    includes(variant_records: { image_attachment: :blob }, preview_image_attachment: :blob)
  else
    all
  end
end

.signed_id_verifier ⇒ Object

Customize the default signed ID verifier for backwards compatibility.

We override the reader (.signed_id_verifier) instead of just calling the writer (.signed_id_verifier=) to guard against the case where ActiveStorage.verifier isn’t yet initialized at load time.



135
136
137
 
# File 'app/models/active_storage/blob.rb', line 135

def signed_id_verifier # :nodoc:
  @signed_id_verifier ||= ActiveStorage.verifier
end

Instance Method Details

#attachments ⇒ Object

:method:

Returns the associated ActiveStorage::Attachments.



38
 
# File 'app/models/active_storage/blob.rb', line 38

has_many :attachments

#audio? ⇒ Boolean

Returns true if the content_type of this blob is in the audio range, like audio/mpeg.

Returns:

  • (Boolean) 


195
196
197
 
# File 'app/models/active_storage/blob.rb', line 195

def audio?
  content_type.start_with?("audio")
end

#compose(keys) ⇒ Object

:nodoc:



268
269
270
271
 
# File 'app/models/active_storage/blob.rb', line 268

def compose(keys) # :nodoc:
  self.composed = true
  service.compose(keys, key, **service_metadata)
end

#content_type_for_serving ⇒ Object

:nodoc:



229
230
231
 
# File 'app/models/active_storage/blob.rb', line 229

def content_type_for_serving # :nodoc:
  forcibly_serve_as_binary? ? ActiveStorage.binary_content_type : content_type
end

#custom_metadata ⇒ Object 



181
182
183
 
# File 'app/models/active_storage/blob.rb', line 181

def custom_metadata
  self[:metadata][:custom] || {}
end

#custom_metadata=(metadata) ⇒ Object 



185
186
187
 
# File 'app/models/active_storage/blob.rb', line 185

def custom_metadata=(metadata)
  self[:metadata] = self[:metadata].merge(custom: metadata)
end

#delete ⇒ Object

Deletes the files on the service associated with the blob. This should only be done if the blob is going to be deleted as well or you will essentially have a dead reference. It’s recommended to use #purge and #purge_later methods in most circumstances.



315
316
317
318
 
# File 'app/models/active_storage/blob.rb', line 315

def delete
  service.delete(key)
  service.delete_prefixed("variants/#{key}/") if image?
end

#download(&block) ⇒ Object

Downloads the file associated with this blob. If no block is given, the entire file is read into memory and returned. That’ll use a lot of RAM for very large files. If a block is given, then the download is streamed and yielded in chunks.



275
276
277
 
# File 'app/models/active_storage/blob.rb', line 275

def download(&block)
  service.download key, &block
end

#download_chunk(range) ⇒ Object

Downloads a part of the file associated with this blob.



280
281
282
 
# File 'app/models/active_storage/blob.rb', line 280

def download_chunk(range)
  service.download_chunk key, range
end

#filename ⇒ Object

Returns an ActiveStorage::Filename instance of the filename that can be queried for basename, extension, and a sanitized version of the filename that’s safe to use in URLs.



177
178
179
 
# File 'app/models/active_storage/blob.rb', line 177

def filename
  ActiveStorage::Filename.new(self[:filename])
end

#forced_disposition_for_serving ⇒ Object

:nodoc:



233
234
235
236
237
 
# File 'app/models/active_storage/blob.rb', line 233

def forced_disposition_for_serving # :nodoc:
  if forcibly_serve_as_binary? || !allowed_inline?
    :attachment
  end
end

#image? ⇒ Boolean

Returns true if the content_type of this blob is in the image range, like image/png.

Returns:

  • (Boolean) 


190
191
192
 
# File 'app/models/active_storage/blob.rb', line 190

def image?
  content_type.start_with?("image")
end

#key ⇒ Object

Returns the key pointing to the file on the service that’s associated with this blob. The key is the secure-token format from Rails in lower case. So it’ll look like: xtapjjcjiudrlk3tmwyjgpuobabd. This key is not intended to be revealed directly to the user. Always refer to blobs using the signed_id or a verified form of the key.



169
170
171
172
 
# File 'app/models/active_storage/blob.rb', line 169

def key
  # We can't wait until the record is first saved to have a key for it
  self[:key] ||= self.class.generate_unique_secure_token(length: MINIMUM_TOKEN_LENGTH)
end

#mirror_later ⇒ Object

:nodoc:



308
309
310
 
# File 'app/models/active_storage/blob.rb', line 308

def mirror_later # :nodoc:
  service.mirror_later key, checksum: checksum if service.respond_to?(:mirror_later)
end

#open(tmpdir: nil, &block) ⇒ Object

Downloads the blob to a tempfile on disk. Yields the tempfile.

The tempfile’s name is prefixed with ActiveStorage- and the blob’s ID. Its extension matches that of the blob.

By default, the tempfile is created in Dir.tmpdir. Pass tmpdir: to create it in a different directory:

blob.open(tmpdir: "/path/to/tmp") do |file|
  # ...
end

The tempfile is automatically closed and unlinked after the given block is executed.

Raises ActiveStorage::IntegrityError if the downloaded data does not match the blob’s checksum.



297
298
299
300
301
302
303
304
305
306
 
# File 'app/models/active_storage/blob.rb', line 297

def open(tmpdir: nil, &block)
  service.open(
    key,
    checksum: checksum,
    verify: !composed,
    name: [ "ActiveStorage-#{id}-", filename.extension_with_delimiter ],
    tmpdir: tmpdir,
    &block
  )
end

#purge ⇒ Object

Destroys the blob record and then deletes the file on the service. This is the recommended way to dispose of unwanted blobs. Note, though, that deleting the file off the service will initiate an HTTP connection to the service, which may be slow or prevented, so you should not use this method inside a transaction or in callbacks. Use #purge_later instead.



323
324
325
326
327
 
# File 'app/models/active_storage/blob.rb', line 323

def purge
  destroy
  delete if previously_persisted?
rescue ActiveRecord::InvalidForeignKey
end

#purge_later ⇒ Object

Enqueues an ActiveStorage::PurgeJob to call #purge. This is the recommended way to purge blobs from a transaction, an Active Record callback, or in any other real-time scenario.



331
332
333
 
# File 'app/models/active_storage/blob.rb', line 331

def purge_later
  ActiveStorage::PurgeJob.perform_later(self)
end

#service ⇒ Object

Returns an instance of service, which can be configured globally or per attachment



336
337
338
 
# File 'app/models/active_storage/blob.rb', line 336

def service
  services.fetch(service_name)
end

#service_headers_for_direct_upload ⇒ Object

Returns a Hash of headers for service_url_for_direct_upload requests.



225
226
227
 
# File 'app/models/active_storage/blob.rb', line 225

def service_headers_for_direct_upload
  service.headers_for_direct_upload key, filename: filename, content_type: content_type, content_length: byte_size, checksum: checksum, custom_metadata: custom_metadata
end

#service_url_for_direct_upload(expires_in: ActiveStorage.service_urls_expire_in) ⇒ Object

Returns a URL that can be used to directly upload a file for this blob on the service. This URL is intended to be short-lived for security and only generated on-demand by the client-side JavaScript responsible for doing the uploading.



220
221
222
 
# File 'app/models/active_storage/blob.rb', line 220

def service_url_for_direct_upload(expires_in: ActiveStorage.service_urls_expire_in)
  service.url_for_direct_upload key, expires_in: expires_in, content_type: content_type, content_length: byte_size, checksum: checksum, custom_metadata: custom_metadata
end

#signed_id(purpose: :blob_id, expires_in: nil, expires_at: nil) ⇒ Object

Returns a signed ID for this blob that’s suitable for reference on the client-side without fear of tampering.



161
162
163
 
# File 'app/models/active_storage/blob.rb', line 161

def signed_id(purpose: :blob_id, expires_in: nil, expires_at: nil)
  super
end

#text? ⇒ Boolean

Returns true if the content_type of this blob is in the text range, like text/plain.

Returns:

  • (Boolean) 


205
206
207
 
# File 'app/models/active_storage/blob.rb', line 205

def text?
  content_type.start_with?("text")
end

#unattached ⇒ Object

:singleton-method:

Returns the blobs that aren’t attached to any record.



44
 
# File 'app/models/active_storage/blob.rb', line 44

scope :unattached, -> { where.missing(:attachments) }

#unfurl(io, identify: true) ⇒ Object

:nodoc:



257
258
259
260
261
262
 
# File 'app/models/active_storage/blob.rb', line 257

def unfurl(io, identify: true) # :nodoc:
  self.checksum     = compute_checksum_in_chunks(io)
  self.content_type = extract_content_type(io) if content_type.nil? || identify
  self.byte_size    = io.size
  self.identified   = true
end

#upload(io, identify: true) ⇒ Object

Uploads the io to the service on the key for this blob. Blobs are intended to be immutable, so you shouldn’t be using this method after a file has already been uploaded to fit with a blob. If you want to create a derivative blob, you should instead simply create a new blob based on the old one.

Prior to uploading, we compute the checksum, which is sent to the service for transit integrity validation. If the checksum does not match what the service receives, an exception will be raised. We also measure the size of the io and store that in byte_size on the blob record. The content type is automatically extracted from the io unless you specify a content_type and pass identify as false.

Normally, you do not have to call this method directly at all. Use the create_and_upload! class method instead. If you do use this method directly, make sure you are using it on a persisted Blob as otherwise another blob’s data might get overwritten on the service.



252
253
254
255
 
# File 'app/models/active_storage/blob.rb', line 252

def upload(io, identify: true)
  unfurl io, identify: identify
  upload_without_unfurling io
end

#upload_without_unfurling(io) ⇒ Object

:nodoc:



264
265
266
 
# File 'app/models/active_storage/blob.rb', line 264

def upload_without_unfurling(io) # :nodoc:
  service.upload key, io, checksum: checksum, **service_metadata
end

#url(expires_in: ActiveStorage.service_urls_expire_in, disposition: :inline, filename: nil, **options) ⇒ Object

Returns the URL of the blob on the service. This returns a permanent URL for public files, and returns a short-lived URL for private files. Private files are signed, and not for public use. Instead, the URL should only be exposed as a redirect from a stable, possibly authenticated URL. Hiding the URL behind a redirect also allows you to change services without updating all URLs.



213
214
215
216
 
# File 'app/models/active_storage/blob.rb', line 213

def url(expires_in: ActiveStorage.service_urls_expire_in, disposition: :inline, filename: nil, **options)
  service.url key, expires_in: expires_in, filename: ActiveStorage::Filename.wrap(filename || self.filename),
    content_type: content_type_for_serving, disposition: forced_disposition_for_serving || disposition, **options
end

#video? ⇒ Boolean

Returns true if the content_type of this blob is in the video range, like video/mp4.

Returns:

  • (Boolean) 


200
201
202
 
# File 'app/models/active_storage/blob.rb', line 200

def video?
  content_type.start_with?("video")
end