Class: CarrierWave::Storage::Fog::File

Inherits:
Object
  • Object
show all
Includes:
Utilities::FileName, Utilities::Uri
Defined in:
lib/carrierwave/storage/fog.rb

Constant Summary collapse

DEFAULT_S3_REGION =
'us-east-1'.freeze

Constants included from Utilities::Uri

Utilities::Uri::SAFE_STRING, Utilities::Uri::UNSAFE

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utilities::FileName

#basename, #extension

Constructor Details

#initialize(uploader, base, path) ⇒ File

Returns a new instance of File.


277
278
279
# File 'lib/carrierwave/storage/fog.rb', line 277

def initialize(uploader, base, path)
  @uploader, @base, @path, @content_type = uploader, base, path, nil
end

Instance Attribute Details

#pathObject (readonly)

Current local path to file

Returns

String

a path to file


177
178
179
# File 'lib/carrierwave/storage/fog.rb', line 177

def path
  @path
end

Instance Method Details

#attributesObject

Return all attributes from file

Returns

Hash

attributes from file


186
187
188
# File 'lib/carrierwave/storage/fog.rb', line 186

def attributes
  file.attributes
end

#authenticated_url(options = {}) ⇒ Object

Return a temporary authenticated url to a private file, if available Only supported for AWS, Rackspace, Google, AzureRM and Aliyun providers

Returns

String

temporary authenticated url

or
NilClass

no authenticated url available


200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
# File 'lib/carrierwave/storage/fog.rb', line 200

def authenticated_url(options = {})
  if ['AWS', 'Google', 'Rackspace', 'OpenStack', 'AzureRM', 'Aliyun', 'backblaze'].include?(@uploader.fog_credentials[:provider])
    # avoid a get by using local references
    local_directory = connection.directories.new(:key => @uploader.fog_directory)
    local_file = local_directory.files.new(:key => path)
    expire_at = options[:expire_at] || ::Fog::Time.now.since(@uploader.fog_authenticated_url_expiration.to_i)
    case @uploader.fog_credentials[:provider]
    when 'AWS', 'Google'
      # Older versions of fog-google do not support options as a parameter
      if url_options_supported?(local_file)
        local_file.url(expire_at, options)
      else
        warn "Options hash not supported in #{local_file.class}. You may need to upgrade your Fog provider."
        local_file.url(expire_at)
      end
    when 'Rackspace', 'OpenStack'
      connection.get_object_https_url(@uploader.fog_directory, path, expire_at, options)
    when 'Aliyun'
      expire_at -= Time.now
      local_file.url(expire_at)
    else
      local_file.url(expire_at)
    end
  end
end

#content_typeObject

Lookup value for file content-type header

Returns

String

value of content-type


233
234
235
# File 'lib/carrierwave/storage/fog.rb', line 233

def content_type
  @content_type || file.try(:content_type)
end

#content_type=(new_content_type) ⇒ Object

Set non-default content-type header (default is file.content_type)

Returns

String

returns new content type value


244
245
246
# File 'lib/carrierwave/storage/fog.rb', line 244

def content_type=(new_content_type)
  @content_type = new_content_type
end

#copy_to(new_path) ⇒ CarrierWave::Storage::Fog::File

Creates a copy of this file and returns it.

Parameters

new_path (String)

The path where the file should be copied to.

Returns

Returns:


442
443
444
445
# File 'lib/carrierwave/storage/fog.rb', line 442

def copy_to(new_path)
  file.copy(@uploader.fog_directory, new_path, copy_options)
  CarrierWave::Storage::Fog::File.new(@uploader, @base, new_path)
end

#deleteObject

Remove the file from service

Returns

Boolean

true for success or raises error


255
256
257
258
259
260
# File 'lib/carrierwave/storage/fog.rb', line 255

def delete
  # avoid a get by just using local reference
  directory.files.new(:key => path).destroy.tap do |result|
    @file = nil if result
  end
end

#exists?Boolean

Check if the file exists on the remote service

Returns

Boolean

true if file exists or false

Returns:

  • (Boolean)

318
319
320
# File 'lib/carrierwave/storage/fog.rb', line 318

def exists?
  !!file
end

#filename(options = {}) ⇒ Object

Return file name, if available

Returns

String

file name

or
NilClass

no file name available


426
427
428
429
# File 'lib/carrierwave/storage/fog.rb', line 426

def filename(options = {})
  return unless (file_url = url(options))
  CGI.unescape(file_url.split('?').first).gsub(/.*\/(.*?$)/, '\1')
end

#headersObject

deprecated: All attributes from file (includes headers)

Returns

Hash

attributes from file


269
270
271
272
273
274
275
# File 'lib/carrierwave/storage/fog.rb', line 269

def headers
  location = caller.first
  warning = "[yellow][WARN] headers is deprecated, use attributes instead[/]"
  warning << " [light_black](#{location})[/]"
  Formatador.display_line(warning)
  attributes
end

#public_urlObject

Return a url to a public file, if available

Returns

String

public url

or
NilClass

no public url available


354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
# File 'lib/carrierwave/storage/fog.rb', line 354

def public_url
  encoded_path = encode_path(path)
  if (host = @uploader.asset_host)
    if host.respond_to? :call
      "#{host.call(self)}/#{encoded_path}"
    else
      "#{host}/#{encoded_path}"
    end
  else
    # AWS/Google optimized for speed over correctness
    case fog_provider
    when 'AWS'
      # check if some endpoint is set in fog_credentials
      if @uploader.fog_credentials.has_key?(:endpoint)
        "#{@uploader.fog_credentials[:endpoint]}/#{@uploader.fog_directory}/#{encoded_path}"
      else
        protocol = @uploader.fog_use_ssl_for_aws ? "https" : "http"

        subdomain_regex = /^(?:[a-z]|\d(?!\d{0,2}(?:\d{1,3}){3}$))(?:[a-z0-9\.]|(?![\-])|\-(?![\.])){1,61}[a-z0-9]$/
        valid_subdomain = @uploader.fog_directory.to_s =~ subdomain_regex && !(protocol == 'https' && @uploader.fog_directory =~ /\./)

        # if directory is a valid subdomain, use that style for access
        if valid_subdomain
          s3_subdomain = @uploader.fog_aws_accelerate ? "s3-accelerate" : "s3"
          "#{protocol}://#{@uploader.fog_directory}.#{s3_subdomain}.amazonaws.com/#{encoded_path}"
        else # directory is not a valid subdomain, so use path style for access
          region = @uploader.fog_credentials[:region].to_s
          host   = case region
                   when DEFAULT_S3_REGION, ''
                     's3.amazonaws.com'
                   else
                     "s3.#{region}.amazonaws.com"
                   end
          "#{protocol}://#{host}/#{@uploader.fog_directory}/#{encoded_path}"
        end
      end
    when 'Google'
      # https://cloud.google.com/storage/docs/access-public-data
      "https://storage.googleapis.com/#{@uploader.fog_directory}/#{encoded_path}"
    else
      # avoid a get by just using local reference
      directory.files.new(:key => path).public_url
    end
  end
end

#readObject

Read content of file from service

Returns

String

contents of file


287
288
289
290
291
292
293
294
295
296
297
298
299
# File 'lib/carrierwave/storage/fog.rb', line 287

def read
  file_body = file.body

  return if file_body.nil?
  return file_body unless file_body.is_a?(::File)

  # Fog::Storage::XXX::File#body could return the source file which was uploaded to the remote server.
  return read_source_file if ::File.exist?(file_body.path)

  # If the source file doesn't exist, the remote content is read
  @file = nil
  file.body
end

#sizeObject

Return size of file body

Returns

Integer

size of file body


308
309
310
# File 'lib/carrierwave/storage/fog.rb', line 308

def size
  file.nil? ? 0 : file.content_length
end

#store(new_file) ⇒ Object

Write file to service

Returns

Boolean

true on success or raises error


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
# File 'lib/carrierwave/storage/fog.rb', line 328

def store(new_file)
  if new_file.is_a?(self.class)
    new_file.copy_to(path)
  else
    fog_file = new_file.to_file
    @content_type ||= new_file.content_type
    @file = directory.files.create({
      :body         => fog_file || new_file.read,
      :content_type => @content_type,
      :key          => path,
      :public       => @uploader.fog_public
    }.merge(@uploader.fog_attributes))
    fog_file.close if fog_file && !fog_file.closed?
  end
  true
end

#to_fileObject

Return the local file

Returns

File

The local file as Ruby's File class

or
NilClass

When there's no file, or the file is remotely stored


456
457
458
459
460
461
462
463
464
# File 'lib/carrierwave/storage/fog.rb', line 456

def to_file
  return nil unless file.body.is_a? ::File

  if file.body.closed?
    ::File.open(file.body.path) # Reopen if it's already closed
  else
    file.body
  end
end

#url(options = {}) ⇒ Object

Return url to file, if available

Returns

String

url

or
NilClass

no url available


409
410
411
412
413
414
415
# File 'lib/carrierwave/storage/fog.rb', line 409

def url(options = {})
  if !@uploader.fog_public
    authenticated_url(options)
  else
    public_url
  end
end