1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 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 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 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 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
|
require 'fog/aws/models/storage/versions'
module Fog
module AWS
class Storage
class File < Fog::Model
MIN_MULTIPART_CHUNK_SIZE = 5242880
MAX_SINGLE_PUT_SIZE = 5368709120
MULTIPART_COPY_THRESHOLD = 15728640
# @see AWS Object docs http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectOps.html
identity :key, :aliases => 'Key'
attr_writer :body
attribute :cache_control, :aliases => 'Cache-Control'
attribute :content_disposition, :aliases => 'Content-Disposition'
attribute :content_encoding, :aliases => 'Content-Encoding'
attribute :content_length, :aliases => ['Content-Length', 'Size'], :type => :integer
attribute :content_md5, :aliases => 'Content-MD5'
attribute :content_type, :aliases => 'Content-Type'
attribute :etag, :aliases => ['Etag', 'ETag']
attribute :expires, :aliases => 'Expires'
attribute :last_modified, :aliases => ['Last-Modified', 'LastModified']
attribute :metadata
attribute :owner, :aliases => 'Owner'
attribute :storage_class, :aliases => ['x-amz-storage-class', 'StorageClass']
attribute :encryption, :aliases => 'x-amz-server-side-encryption'
attribute :encryption_key, :aliases => 'x-amz-server-side-encryption-customer-key'
attribute :version, :aliases => 'x-amz-version-id'
attribute :kms_key_id, :aliases => 'x-amz-server-side-encryption-aws-kms-key-id'
attribute :tags, :aliases => 'x-amz-tagging'
UploadPartData = Struct.new(:part_number, :upload_options, :etag)
class PartList
def initialize(parts = [])
@parts = parts
@mutex = Mutex.new
end
def push(part)
@mutex.synchronize { @parts.push(part) }
end
def shift
@mutex.synchronize { @parts.shift }
end
def clear!
@mutex.synchronize { @parts.clear }
end
def size
@mutex.synchronize { @parts.size }
end
def to_a
@mutex.synchronize { @parts.dup }
end
end
# @note Chunk size to use for multipart uploads.
# Use small chunk sizes to minimize memory. E.g. 5242880 = 5mb
attr_reader :multipart_chunk_size
def multipart_chunk_size=(mp_chunk_size)
raise ArgumentError.new("minimum multipart_chunk_size is #{MIN_MULTIPART_CHUNK_SIZE}") if mp_chunk_size < MIN_MULTIPART_CHUNK_SIZE
@multipart_chunk_size = mp_chunk_size
end
# @note Number of threads used to copy files.
def concurrency=(concurrency)
raise ArgumentError.new('minimum concurrency is 1') if concurrency.to_i < 1
@concurrency = concurrency.to_i
end
def concurrency
@concurrency || 1
end
def acl
requires :directory, :key
service.get_object_acl(directory.key, key).body['AccessControlList']
end
# Set file's access control list (ACL).
#
# valid acls: private, public-read, public-read-write, authenticated-read, bucket-owner-read, bucket-owner-full-control
#
# @param [String] new_acl one of valid options
# @return [String] @acl
#
def acl=(new_acl)
valid_acls = ['private', 'public-read', 'public-read-write', 'authenticated-read', 'bucket-owner-read', 'bucket-owner-full-control']
unless valid_acls.include?(new_acl)
raise ArgumentError.new("acl must be one of [#{valid_acls.join(', ')}]")
end
@acl = new_acl
end
# Get file's body if exists, else ''.
#
# @return [File]
#
def body
return attributes[:body] if attributes[:body]
return '' unless last_modified
file = collection.get(identity)
if file
attributes[:body] = file.body
else
attributes[:body] = ''
end
end
# Set body attribute.
#
# @param [File] new_body
# @return [File] attributes[:body]
#
def body=(new_body)
attributes[:body] = new_body
end
# Get the file instance's directory.
#
# @return [Fog::AWS::Storage::Directory]
#
def directory
@directory
end
# Copy object from one bucket to other bucket.
#
# required attributes: directory, key
#
# @param target_directory_key [String]
# @param target_file_key [String]
# @param options [Hash] options for copy_object method
# @return [String] Fog::AWS::Files#head status of directory contents
#
def copy(target_directory_key, target_file_key, options = {})
requires :directory, :key
# With a single PUT operation you can upload objects up to 5 GB in size. Automatically set MP for larger objects.
self.multipart_chunk_size = MIN_MULTIPART_CHUNK_SIZE * 2 if !multipart_chunk_size && self.content_length.to_i > MAX_SINGLE_PUT_SIZE
if multipart_chunk_size && self.content_length.to_i >= multipart_chunk_size
upload_part_options = options.select { |key, _| ALLOWED_UPLOAD_PART_OPTIONS.include?(key.to_sym) }
upload_part_options = upload_part_options.merge({ 'x-amz-copy-source' => "#{directory.key}/#{key}" })
multipart_copy(options, upload_part_options, target_directory_key, target_file_key)
else
service.copy_object(directory.key, key, target_directory_key, target_file_key, options)
end
target_directory = service.directories.new(:key => target_directory_key)
target_directory.files.head(target_file_key)
end
# Destroy file via http DELETE.
#
# required attributes: directory, key
#
# @param options [Hash]
# @option options versionId []
# @return [Boolean] true if successful
#
def destroy(options = {})
requires :directory, :key
attributes[:body] = nil if options['versionId'] == version
service.delete_object(directory.key, key, options)
true
end
remove_method :metadata
def metadata
attributes.reject {|key, value| !(key.to_s =~ /^x-amz-/)}
end
remove_method :metadata=
def metadata=(new_metadata)
merge_attributes(new_metadata)
end
remove_method :owner=
def owner=(new_owner)
if new_owner
attributes[:owner] = {
:display_name => new_owner['DisplayName'] || new_owner[:display_name],
:id => new_owner['ID'] || new_owner[:id]
}
end
end
def public?
acl.any? {|grant| grant['Grantee']['URI'] == 'http://acs.amazonaws.com/groups/global/AllUsers' && grant['Permission'] == 'READ'}
end
# Set Access-Control-List permissions.
#
# valid new_publics: public_read, private
#
# @param [String] new_public
# @return [String] new_public
#
def public=(new_public)
if new_public
@acl = 'public-read'
else
@acl = 'private'
end
new_public
end
# Get publicly accessible url via http GET.
# Checks permissions before creating.
# Defaults to s3 subdomain or compliant bucket name
#
# required attributes: directory, key
#
# @return [String] public url
#
def public_url
requires :directory, :key
if public?
service.request_url(
:bucket_name => directory.key,
:object_name => key
)
else
nil
end
end
# Save file with body as contents to directory.key with name key via http PUT
#
# required attributes: body, directory, key
#
# @param [Hash] options
# @option options [String] acl sets x-amz-acl HTTP header. Valid values include, private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control
# @option options [String] cache_control sets Cache-Control header. For example, 'No-cache'
# @option options [String] content_disposition sets Content-Disposition HTTP header. For exampple, 'attachment; filename=testing.txt'
# @option options [String] content_encoding sets Content-Encoding HTTP header. For example, 'x-gzip'
# @option options [String] content_md5 sets Content-MD5. For example, '79054025255fb1a26e4bc422aef54eb4'
# @option options [String] content_type Content-Type. For example, 'text/plain'
# @option options [String] expires sets number of seconds before AWS Object expires.
# @option options [String] storage_class sets x-amz-storage-class HTTP header. Defaults to 'STANDARD'. Or, 'REDUCED_REDUNDANCY'
# @option options [String] encryption sets HTTP encryption header. Set to 'AES256' to encrypt files at rest on S3
# @option options [String] tags sets x-amz-tagging HTTP header. For example, 'Org-Id=1' or 'Org-Id=1&Service=MyService'
# @return [Boolean] true if no errors
#
def save(options = {})
requires :body, :directory, :key
if options != {}
Fog::Logger.deprecation("options param is deprecated, use acl= instead [light_black](#{caller.first})[/]")
end
options['x-amz-acl'] ||= @acl if @acl
options['Cache-Control'] = cache_control if cache_control
options['Content-Disposition'] = content_disposition if content_disposition
options['Content-Encoding'] = content_encoding if content_encoding
options['Content-MD5'] = content_md5 if content_md5
options['Content-Type'] = content_type if content_type
options['Expires'] = expires if expires
options.merge!(metadata)
options['x-amz-storage-class'] = storage_class if storage_class
options['x-amz-tagging'] = tags if tags
options.merge!(encryption_headers)
# With a single PUT operation you can upload objects up to 5 GB in size. Automatically set MP for larger objects.
self.multipart_chunk_size = MIN_MULTIPART_CHUNK_SIZE if !multipart_chunk_size && Fog::Storage.get_body_size(body) > MAX_SINGLE_PUT_SIZE
if multipart_chunk_size && Fog::Storage.get_body_size(body) >= multipart_chunk_size && body.respond_to?(:read)
data = multipart_save(options)
merge_attributes(data.body)
else
data = service.put_object(directory.key, key, body, options)
merge_attributes(data.headers.reject {|key, value| ['Content-Length', 'Content-Type'].include?(key)})
end
self.etag = self.etag.gsub('"','') if self.etag
self.content_length = Fog::Storage.get_body_size(body)
self.content_type ||= Fog::Storage.get_content_type(body)
true
end
# Get a url for file.
#
# required attributes: key
#
# @param expires [String] number of seconds (since 1970-01-01 00:00) before url expires
# @param options [Hash]
# @return [String] url
#
def url(expires, options = {})
requires :key
collection.get_url(key, expires, options)
end
# File version if exists or creates new version.
# @return [Fog::AWS::Storage::Version]
#
def versions
@versions ||= begin
Fog::AWS::Storage::Versions.new(
:file => self,
:service => service
)
end
end
private
def directory=(new_directory)
@directory = new_directory
end
def multipart_save(options)
# Initiate the upload
res = service.initiate_multipart_upload(directory.key, key, options)
upload_id = res.body["UploadId"]
# Store ETags of upload parts
part_tags = []
# Upload each part
# TODO: optionally upload chunks in parallel using threads
# (may cause network performance problems with many small chunks)
# TODO: Support large chunk sizes without reading the chunk into memory
if body.respond_to?(:rewind)
body.rewind rescue nil
end
while (chunk = body.read(multipart_chunk_size)) do
part_upload = service.upload_part(directory.key, key, upload_id, part_tags.size + 1, chunk, part_headers(chunk, options))
part_tags << part_upload.headers["ETag"]
end
if part_tags.empty? #it is an error to have a multipart upload with no parts
part_upload = service.upload_part(directory.key, key, upload_id, 1, '', part_headers('', options))
part_tags << part_upload.headers["ETag"]
end
rescue
# Abort the upload & reraise
service.abort_multipart_upload(directory.key, key, upload_id) if upload_id
raise
else
# Complete the upload
service.complete_multipart_upload(directory.key, key, upload_id, part_tags)
end
def multipart_copy(options, upload_part_options, target_directory_key, target_file_key)
# Initiate the upload
res = service.initiate_multipart_upload(target_directory_key, target_file_key, options)
upload_id = res.body["UploadId"]
# Store ETags of upload parts
part_tags = []
pending = PartList.new(create_part_list(upload_part_options))
thread_count = self.concurrency
completed = PartList.new
errors = upload_in_threads(target_directory_key, target_file_key, upload_id, pending, completed, thread_count)
raise errors.first if errors.any?
part_tags = completed.to_a.sort_by { |part| part.part_number }.map(&:etag)
rescue => e
# Abort the upload & reraise
service.abort_multipart_upload(target_directory_key, target_file_key, upload_id) if upload_id
raise
else
# Complete the upload
service.complete_multipart_upload(target_directory_key, target_file_key, upload_id, part_tags)
end
def encryption_headers
if encryption && encryption_key
encryption_customer_key_headers
elsif encryption
{ 'x-amz-server-side-encryption' => encryption, 'x-amz-server-side-encryption-aws-kms-key-id' => kms_key_id }.reject {|_, value| value.nil?}
else
{}
end
end
def part_headers(chunk, options)
md5 = Base64.encode64(OpenSSL::Digest::MD5.digest(chunk)).strip
encryption_keys = encryption_customer_key_headers.keys
encryption_headers = options.select { |key| encryption_keys.include?(key) }
{ 'Content-MD5' => md5 }.merge(encryption_headers)
end
def encryption_customer_key_headers
{
'x-amz-server-side-encryption-customer-algorithm' => encryption,
'x-amz-server-side-encryption-customer-key' => Base64.encode64(encryption_key.to_s).chomp!,
'x-amz-server-side-encryption-customer-key-md5' => Base64.encode64(OpenSSL::Digest::MD5.digest(encryption_key.to_s)).chomp!
}
end
def create_part_list(upload_part_options)
current_pos = 0
count = 0
pending = []
while current_pos < self.content_length do
start_pos = current_pos
end_pos = [current_pos + self.multipart_chunk_size, self.content_length - 1].min
range = "bytes=#{start_pos}-#{end_pos}"
part_options = upload_part_options.dup
part_options['x-amz-copy-source-range'] = range
pending << UploadPartData.new(count + 1, part_options, nil)
count += 1
current_pos = end_pos + 1
end
pending
end
def upload_in_threads(target_directory_key, target_file_key, upload_id, pending, completed, thread_count)
threads = []
thread_count.times do
thread = Thread.new do
begin
while part = pending.shift
part_upload = service.upload_part_copy(target_directory_key, target_file_key, upload_id, part.part_number, part.upload_options)
part.etag = part_upload.body['ETag']
completed.push(part)
end
rescue => error
pending.clear!
error
end
end
thread.abort_on_exception = true
threads << thread
end
threads.map(&:value).compact
end
end
end
end
end
|