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
|
# frozen_string_literal: true
require 'pathname'
require 'thread'
require 'set'
require 'tmpdir'
module Aws
module S3
# @api private
class FileDownloader
MIN_CHUNK_SIZE = 5 * 1024 * 1024
MAX_PARTS = 10_000
THREAD_COUNT = 10
def initialize(options = {})
@client = options[:client] || Client.new
end
# @return [Client]
attr_reader :client
def download(destination, options = {})
@path = destination
@mode = options[:mode] || 'auto'
@thread_count = options[:thread_count] || THREAD_COUNT
@chunk_size = options[:chunk_size]
@params = {
bucket: options[:bucket],
key: options[:key],
}
@params[:version_id] = options[:version_id] if options[:version_id]
# checksum_mode only supports the value "ENABLED"
# falsey values (false/nil) or "DISABLED" should be considered
# disabled and the api parameter should be unset.
if (checksum_mode = options.fetch(:checksum_mode, 'ENABLED'))
@params[:checksum_mode] = checksum_mode unless checksum_mode.upcase == 'DISABLED'
end
@on_checksum_validated = options[:on_checksum_validated]
@progress_callback = options[:progress_callback]
validate!
Aws::Plugins::UserAgent.metric('S3_TRANSFER') do
case @mode
when 'auto' then multipart_download
when 'single_request' then single_request
when 'get_range'
if @chunk_size
resp = @client.head_object(@params)
multithreaded_get_by_ranges(resp.content_length)
else
msg = 'In :get_range mode, :chunk_size must be provided'
raise ArgumentError, msg
end
else
msg = "Invalid mode #{@mode} provided, "\
'mode should be :single_request, :get_range or :auto'
raise ArgumentError, msg
end
end
end
private
def validate!
if @on_checksum_validated && @params[:checksum_mode] != 'ENABLED'
raise ArgumentError, "You must set checksum_mode: 'ENABLED' " +
"when providing a on_checksum_validated callback"
end
if @on_checksum_validated && !@on_checksum_validated.respond_to?(:call)
raise ArgumentError, 'on_checksum_validated must be callable'
end
end
def multipart_download
resp = @client.head_object(@params.merge(part_number: 1))
count = resp.parts_count
if count.nil? || count <= 1
if resp.content_length <= MIN_CHUNK_SIZE
single_request
else
multithreaded_get_by_ranges(resp.content_length)
end
else
# partNumber is an option
resp = @client.head_object(@params)
if resp.content_length <= MIN_CHUNK_SIZE
single_request
else
compute_mode(resp.content_length, count)
end
end
end
def compute_mode(file_size, count)
chunk_size = compute_chunk(file_size)
part_size = (file_size.to_f / count.to_f).ceil
if chunk_size < part_size
multithreaded_get_by_ranges(file_size)
else
multithreaded_get_by_parts(count, file_size)
end
end
def construct_chunks(file_size)
offset = 0
default_chunk_size = compute_chunk(file_size)
chunks = []
while offset < file_size
progress = offset + default_chunk_size
progress = file_size if progress > file_size
chunks << "bytes=#{offset}-#{progress - 1}"
offset = progress
end
chunks
end
def compute_chunk(file_size)
if @chunk_size && @chunk_size > file_size
raise ArgumentError, ":chunk_size shouldn't exceed total file size."
else
@chunk_size || [
(file_size.to_f / MAX_PARTS).ceil, MIN_CHUNK_SIZE
].max.to_i
end
end
def batches(chunks, mode)
chunks = (1..chunks) if mode.eql? 'part_number'
chunks.each_slice(@thread_count).to_a
end
def multithreaded_get_by_ranges(file_size)
offset = 0
default_chunk_size = compute_chunk(file_size)
chunks = []
part_number = 1 # parts start at 1
while offset < file_size
progress = offset + default_chunk_size
progress = file_size if progress > file_size
range = "bytes=#{offset}-#{progress - 1}"
chunks << Part.new(
part_number: part_number,
size: (progress-offset),
params: @params.merge(range: range)
)
part_number += 1
offset = progress
end
download_in_threads(PartList.new(chunks), file_size)
end
def multithreaded_get_by_parts(n_parts, total_size)
parts = (1..n_parts).map do |part|
Part.new(part_number: part, params: @params.merge(part_number: part))
end
download_in_threads(PartList.new(parts), total_size)
end
def download_in_threads(pending, total_size)
threads = []
if @progress_callback
progress = MultipartProgress.new(pending, total_size, @progress_callback)
end
@thread_count.times do
thread = Thread.new do
begin
while part = pending.shift
if progress
part.params[:on_chunk_received] =
proc do |_chunk, bytes, total|
progress.call(part.part_number, bytes, total)
end
end
resp = @client.get_object(part.params)
write(resp)
if @on_checksum_validated && resp.checksum_validated
@on_checksum_validated.call(resp.checksum_validated, resp)
end
end
nil
rescue => error
# keep other threads from downloading other parts
pending.clear!
raise error
end
end
threads << thread
end
threads.map(&:value).compact
end
def write(resp)
range, _ = resp.content_range.split(' ').last.split('/')
head, _ = range.split('-').map {|s| s.to_i}
File.write(@path, resp.body.read, head)
end
def single_request
params = @params.merge(response_target: @path)
params[:on_chunk_received] = single_part_progress if @progress_callback
resp = @client.get_object(params)
return resp unless @on_checksum_validated
if resp.checksum_validated
@on_checksum_validated.call(resp.checksum_validated, resp)
end
resp
end
def single_part_progress
proc do |_chunk, bytes_read, total_size|
@progress_callback.call([bytes_read], [total_size], total_size)
end
end
class Part < Struct.new(:part_number, :size, :params)
include Aws::Structure
end
# @api private
class PartList
include Enumerable
def initialize(parts = [])
@parts = parts
@mutex = Mutex.new
end
def shift
@mutex.synchronize { @parts.shift }
end
def size
@mutex.synchronize { @parts.size }
end
def clear!
@mutex.synchronize { @parts.clear }
end
def each(&block)
@mutex.synchronize { @parts.each(&block) }
end
end
# @api private
class MultipartProgress
def initialize(parts, total_size, progress_callback)
@bytes_received = Array.new(parts.size, 0)
@part_sizes = parts.map(&:size)
@total_size = total_size
@progress_callback = progress_callback
end
def call(part_number, bytes_received, total)
# part numbers start at 1
@bytes_received[part_number - 1] = bytes_received
# part size may not be known until we get the first response
@part_sizes[part_number - 1] ||= total
@progress_callback.call(@bytes_received, @part_sizes, @total_size)
end
end
end
end
end
|