class ActiveStorage::Service::DiskService

Wraps a local disk path as an Active Storage service. See ActiveStorage::Service for the generic API documentation that applies to all services.

Attributes

root[R]

Public Class Methods

new(root:, public: false, **options) click to toggle source
# File lib/active_storage/service/disk_service.rb, line 14
def initialize(root:, public: false, **options)
  @root = root
  @public = public
end

Public Instance Methods

delete(key) click to toggle source
# File lib/active_storage/service/disk_service.rb, line 51
def delete(key)
  instrument :delete, key: key do
    File.delete path_for(key)
  rescue Errno::ENOENT
    # Ignore files already deleted
  end
end
delete_prefixed(prefix) click to toggle source
# File lib/active_storage/service/disk_service.rb, line 59
def delete_prefixed(prefix)
  instrument :delete_prefixed, prefix: prefix do
    Dir.glob(path_for("#{prefix}*")).each do |path|
      FileUtils.rm_rf(path)
    end
  end
end
download(key, &block) click to toggle source
# File lib/active_storage/service/disk_service.rb, line 26
def download(key, &block)
  if block_given?
    instrument :streaming_download, key: key do
      stream key, &block
    end
  else
    instrument :download, key: key do
      File.binread path_for(key)
    rescue Errno::ENOENT
      raise ActiveStorage::FileNotFoundError
    end
  end
end
download_chunk(key, range) click to toggle source
# File lib/active_storage/service/disk_service.rb, line 40
def download_chunk(key, range)
  instrument :download_chunk, key: key, range: range do
    File.open(path_for(key), "rb") do |file|
      file.seek range.begin
      file.read range.size
    end
  rescue Errno::ENOENT
    raise ActiveStorage::FileNotFoundError
  end
end
exist?(key) click to toggle source
# File lib/active_storage/service/disk_service.rb, line 67
def exist?(key)
  instrument :exist, key: key do |payload|
    answer = File.exist? path_for(key)
    payload[:exist] = answer
    answer
  end
end
headers_for_direct_upload(key, content_type:, **) click to toggle source
# File lib/active_storage/service/disk_service.rb, line 97
def headers_for_direct_upload(key, content_type:, **)
  { "Content-Type" => content_type }
end
upload(key, io, checksum: nil, **) click to toggle source
# File lib/active_storage/service/disk_service.rb, line 19
def upload(key, io, checksum: nil, **)
  instrument :upload, key: key, checksum: checksum do
    IO.copy_stream(io, make_path_for(key))
    ensure_integrity_of(key, checksum) if checksum
  end
end
url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:) click to toggle source
# File lib/active_storage/service/disk_service.rb, line 75
def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
  instrument :url, key: key do |payload|
    verified_token_with_expiration = ActiveStorage.verifier.generate(
      {
        key: key,
        content_type: content_type,
        content_length: content_length,
        checksum: checksum,
        service_name: name
      },
      expires_in: expires_in,
      purpose: :blob_token
    )

    generated_url = url_helpers.update_rails_disk_service_url(verified_token_with_expiration, host: current_host)

    payload[:url] = generated_url

    generated_url
  end
end

Private Instance Methods

current_host() click to toggle source
# File lib/active_storage/service/disk_service.rb, line 167
def current_host
  ActiveStorage::Current.host
end
ensure_integrity_of(key, checksum) click to toggle source
# File lib/active_storage/service/disk_service.rb, line 156
def ensure_integrity_of(key, checksum)
  unless Digest::MD5.file(path_for(key)).base64digest == checksum
    delete key
    raise ActiveStorage::IntegrityError
  end
end
folder_for(key) click to toggle source
# File lib/active_storage/service/disk_service.rb, line 148
def folder_for(key)
  [ key[0..1], key[2..3] ].join("/")
end
generate_url(key, expires_in:, filename:, content_type:, disposition:) click to toggle source
# File lib/active_storage/service/disk_service.rb, line 114
def generate_url(key, expires_in:, filename:, content_type:, disposition:)
  content_disposition = content_disposition_with(type: disposition, filename: filename)
  verified_key_with_expiration = ActiveStorage.verifier.generate(
    {
      key: key,
      disposition: content_disposition,
      content_type: content_type,
      service_name: name
    },
    expires_in: expires_in,
    purpose: :blob_key
  )

  current_uri = URI.parse(current_host)

  url_helpers.rails_disk_service_url(verified_key_with_expiration,
    protocol: current_uri.scheme,
    host: current_uri.host,
    port: current_uri.port,
    filename: filename
  )
end
make_path_for(key) click to toggle source
# File lib/active_storage/service/disk_service.rb, line 152
def make_path_for(key)
  path_for(key).tap { |path| FileUtils.mkdir_p File.dirname(path) }
end
private_url(key, expires_in:, filename:, content_type:, disposition:, **) click to toggle source
# File lib/active_storage/service/disk_service.rb, line 106
def private_url(key, expires_in:, filename:, content_type:, disposition:, **)
  generate_url(key, expires_in: expires_in, filename: filename, content_type: content_type, disposition: disposition)
end
public_url(key, filename:, content_type: nil, disposition: :attachment, **) click to toggle source
# File lib/active_storage/service/disk_service.rb, line 110
def public_url(key, filename:, content_type: nil, disposition: :attachment, **)
  generate_url(key, expires_in: nil, filename: filename, content_type: content_type, disposition: disposition)
end
stream(key) { |data| ... } click to toggle source
# File lib/active_storage/service/disk_service.rb, line 138
def stream(key)
  File.open(path_for(key), "rb") do |file|
    while data = file.read(5.megabytes)
      yield data
    end
  end
rescue Errno::ENOENT
  raise ActiveStorage::FileNotFoundError
end
url_helpers() click to toggle source
# File lib/active_storage/service/disk_service.rb, line 163
def url_helpers
  @url_helpers ||= Rails.application.routes.url_helpers
end