123456789_123456789_123456789_123456789_123456789_

Class: ActiveStorage::Service::DiskService

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::ActiveStorage::Service, ::ActiveSupport::Autoload
Instance Chain:
self, ::ActiveStorage::Service
Inherits: ActiveStorage::Service
Defined in: activestorage/lib/active_storage/service/disk_service.rb

Overview

Active Storage Disk Service

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

Class Method Summary

::ActiveStorage::Service - Inherited

.configure

Configure an Active Storage service by name from a set of configurations, typically loaded from a YAML file.
.build

Override in subclasses that stitch together multiple services and hence need to build additional services using the configurator.

::ActiveSupport::Autoload - Extended

autoload, autoload_at, autoload_under, eager_autoload, eager_load!

Instance Attribute Summary

::ActiveStorage::Service - Inherited

#name, #public?

Instance Method Summary

::ActiveStorage::Service - Inherited

#compose

Concatenate multiple files into a single “composed” file.
#delete

Delete the file at the key.
#delete_prefixed

Delete files at keys starting with the prefix.
#download

Return the content of the file at the key.
#download_chunk

Return the partial content in the byte range of the file at the key.
#exist?

Return true if a file exists at the key.
#headers_for_direct_upload

Returns a ::Hash of headers for #url_for_direct_upload requests.
#open,
#update_metadata

Update metadata for the file identified by key in the service.
#upload

Upload the io to the key specified.
#url

Returns the URL for the file at the key.
#url_for_direct_upload

Returns a signed, temporary URL that a direct upload file can be PUT to on the key.
#content_disposition_with, #custom_metadata_headers, #instrument, #private_url, #public_url, #service_name

Constructor Details

.new(root:, public: false, **options) ⇒ DiskService

[ GitHub ] 

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 16



def initialize(root:, public: false, **options)
  @root = root
  @public = public
end


  







Instance Attribute Details



  

    #root   (rw)
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 14



attr_accessor :root


  







Instance Method Details



  

    #compose(source_keys, destination_key)  
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 105



def compose(source_keys, destination_key, **)
  File.open(make_path_for(destination_key), "w") do |destination_file|
    source_keys.each do |source_key|
      File.open(path_for(source_key), "rb") do |source_file|
        IO.copy_stream(source_file, destination_file)
      end
    end
  end
end


  








  

    #delete(key)  
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 53



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)  
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 61



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)  
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 28



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)  
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 42



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


  








  

    #ensure_integrity_of(key, checksum)   (private)
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 163



def ensure_integrity_of(key, checksum)
  unless OpenSSL::Digest::MD5.file(path_for(key)).base64digest == checksum
    delete key
    raise ActiveStorage::IntegrityError
  end
end


  








  

    #exist?(key)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 69



def exist?(key)
  instrument :exist, key: key do |payload|
    answer = File.exist? path_for(key)
    payload[:exist] = answer
    answer
  end
end


  








  

    #folder_for(key)   (private)
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 155



def folder_for(key)
  [ key[0..1], key[2..3] ].join("/")
end


  








  

    #generate_url(key, expires_in:, filename:, content_type:, disposition:)   (private)
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 124



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
  )

  if url_options.blank?
    raise ArgumentError, "Cannot generate URL for #{filename} using Disk service, please set ActiveStorage::Current.url_options."
  end

  url_helpers.rails_disk_service_url(verified_key_with_expiration, filename: filename, **url_options)
end


  








  

    #headers_for_direct_upload(key, content_type:)  
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 97



def headers_for_direct_upload(key, content_type:, **)
  { "Content-Type" => content_type }
end


  








  

    #make_path_for(key)   (private)
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 159



def make_path_for(key)
  path_for(key).tap { |path| FileUtils.mkdir_p File.dirname(path) }
end


  








  

    #path_for(key)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 101



def path_for(key) # :nodoc:
  File.join root, folder_for(key), key
end


  








  

    #private_url(key, expires_in:, filename:, content_type:, disposition:)   (private)
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 116



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)   (private)
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 120



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)   (private)
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 145



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


  








  

    #upload(key, io, checksum: nil)  
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 21



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:, custom_metadata: {})  
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 77



def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:, custom_metadata: {})
  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
    )

    url_helpers.update_rails_disk_service_url(verified_token_with_expiration, url_options).tap do |generated_url|
      payload[:url] = generated_url
    end
  end
end


  








  

    #url_helpers   (private)
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 170



def url_helpers
  @url_helpers ||= Rails.application.routes.url_helpers
end


  








  

    #url_options   (private)
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/disk_service.rb', line 174



def url_options
  ActiveStorage::Current.url_options
end