Class: ActiveStorage::Service::DiskService

# 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

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

def delete_prefixed(prefix)
  instrument :delete_prefixed, prefix: prefix do
    prefix_path = path_for(prefix)

    # File.expand_path (called within path_for) strips trailing slashes.
    # Restore trailing separator if the original prefix had one, so that
    # the glob "prefix/*" matches files inside the directory, not siblings
    # whose names start with the prefix string.
    prefix_path += "/" if prefix.end_with?("/")

    escaped = escape_glob_metacharacters(prefix_path)
    Dir.glob("#{escaped}*").each do |path|
      FileUtils.rm_rf(path)
    end
  end
end

# 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

# 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

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

def ensure_integrity_of(key, checksum)
  return if File.open(path_for(key), "rb") do |file|
    compute_checksum(file)
  end == checksum

  delete key
  raise ActiveStorage::IntegrityError
end

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

def escape_glob_metacharacters(path)
  path.gsub(/[\[\]*?{}\\]/) { |c| "\\#{c}" }
end

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

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

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

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

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

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

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

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

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

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

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

def path_for(key) # :nodoc:
  if key.blank?
    raise ActiveStorage::InvalidKeyError, "key is blank"
  end

  # Reject keys with dot segments as defense in depth. This prevents path traversal both outside
  # and within the storage root. The root containment check below is a more fundamental check on
  # path traversal outside of the disk service root.
  begin
    if key.split("/").intersect?(%w[. ..])
      raise ActiveStorage::InvalidKeyError, "key has path traversal segments"
    end
  rescue Encoding::CompatibilityError
    raise ActiveStorage::InvalidKeyError, "key has incompatible encoding"
  end

  begin
    path = File.expand_path(File.join(root, folder_for(key), key))
  rescue ArgumentError
    # ArgumentError catches null bytes
    raise ActiveStorage::InvalidKeyError, "key is an invalid string"
  end

  # The resolved path must be inside the root directory.
  unless path.start_with?(File.expand_path(root) + "/")
    raise ActiveStorage::InvalidKeyError, "key is outside of disk service root"
  end

  path
end

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

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

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

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

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

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

# 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

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

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

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

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

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

def url_options
  ActiveStorage::Current.url_options
end