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
|
# -*- encoding: utf-8 -*-
module Aliyun
module OSS
module Multipart
##
# A multipart upload transaction
#
class Upload < Transaction
include Common::Logging
PART_SIZE = 10 * 1024 * 1024
READ_SIZE = 16 * 1024
NUM_THREAD = 10
def initialize(protocol, opts)
args = opts.dup
@protocol = protocol
@progress = args.delete(:progress)
@file = args.delete(:file)
@cpt_file = args.delete(:cpt_file)
super(args)
@file_meta = {}
@num_threads = options[:threads] || NUM_THREAD
@all_mutex = Mutex.new
@parts = []
@todo_mutex = Mutex.new
@todo_parts = []
end
# Run the upload transaction, which includes 3 stages:
# * 1a. initiate(new upload) and divide parts
# * 1b. rebuild states(resumed upload)
# * 2. upload each unfinished part
# * 3. commit the multipart upload transaction
def run
logger.info("Begin upload, file: #{@file}, "\
"checkpoint file: #{@cpt_file}, "\
"threads: #{@num_threads}")
# Rebuild transaction states from checkpoint file
# Or initiate new transaction states
rebuild
# Divide the file to upload into parts to upload separately
divide_parts if @parts.empty?
# Upload each part
@todo_parts = @parts.reject { |p| p[:done] }
(1..@num_threads).map {
Thread.new {
loop {
p = sync_get_todo_part
break unless p
upload_part(p)
}
}
}.map(&:join)
# Commit the multipart upload transaction
commit
logger.info("Done upload, file: #{@file}")
end
# Checkpoint structures:
# @example
# states = {
# :id => 'upload_id',
# :file => 'file',
# :file_meta => {
# :mtime => Time.now,
# :md5 => 1024
# },
# :parts => [
# {:number => 1, :range => [0, 100], :done => false},
# {:number => 2, :range => [100, 200], :done => true}
# ],
# :md5 => 'states_md5'
# }
def checkpoint
logger.debug("Begin make checkpoint, disable_cpt: "\
"#{options[:disable_cpt] == true}")
ensure_file_not_changed
parts = sync_get_all_parts
states = {
:id => id,
:file => @file,
:file_meta => @file_meta,
:parts => parts
}
# report progress
if @progress
done = parts.count { |p| p[:done] }
@progress.call(done.to_f / parts.size) if done > 0
end
write_checkpoint(states, @cpt_file) unless options[:disable_cpt]
logger.debug("Done make checkpoint, states: #{states}")
end
private
# Commit the transaction when all parts are succefully uploaded
# @todo handle undefined behaviors: commit succeeds in server
# but return error in client
def commit
logger.info("Begin commit transaction, id: #{id}")
parts = sync_get_all_parts.map{ |p|
Part.new(:number => p[:number], :etag => p[:etag])
}
@protocol.complete_multipart_upload(
bucket, object, id, parts, @options[:callback])
File.delete(@cpt_file) unless options[:disable_cpt]
logger.info("Done commit transaction, id: #{id}")
end
# Rebuild the states of the transaction from checkpoint file
def rebuild
logger.info("Begin rebuild transaction, checkpoint: #{@cpt_file}")
if options[:disable_cpt] || !File.exists?(@cpt_file)
initiate
else
states = load_checkpoint(@cpt_file)
if states[:file_md5] != @file_meta[:md5]
fail FileInconsistentError.new("The file to upload is changed.")
end
@id = states[:id]
@file_meta = states[:file_meta]
@parts = states[:parts]
end
logger.info("Done rebuild transaction, states: #{states}")
end
def initiate
logger.info("Begin initiate transaction")
@id = @protocol.initiate_multipart_upload(bucket, object, options)
@file_meta = {
:mtime => File.mtime(@file),
:md5 => get_file_md5(@file)
}
checkpoint
logger.info("Done initiate transaction, id: #{id}")
end
# Upload a part
def upload_part(p)
logger.debug("Begin upload part: #{p}")
result = nil
File.open(@file) do |f|
range = p[:range]
pos = range.first
f.seek(pos)
result = @protocol.upload_part(bucket, object, id, p[:number]) do |sw|
while pos < range.at(1)
bytes = [READ_SIZE, range.at(1) - pos].min
sw << f.read(bytes)
pos += bytes
end
end
end
sync_update_part(p.merge(done: true, etag: result.etag))
checkpoint
logger.debug("Done upload part: #{p}")
end
# Devide the file into parts to upload
def divide_parts
logger.info("Begin divide parts, file: #{@file}")
max_parts = 10000
file_size = File.size(@file)
part_size = [@options[:part_size] || PART_SIZE, file_size / max_parts].max
num_parts = (file_size - 1) / part_size + 1
@parts = (1..num_parts).map do |i|
{
:number => i,
:range => [(i-1) * part_size, [i * part_size, file_size].min],
:done => false
}
end
checkpoint
logger.info("Done divide parts, parts: #{@parts}")
end
def sync_get_todo_part
@todo_mutex.synchronize {
@todo_parts.shift
}
end
def sync_update_part(p)
@all_mutex.synchronize {
@parts[p[:number] - 1] = p
}
end
def sync_get_all_parts
@all_mutex.synchronize {
@parts.dup
}
end
# Ensure file not changed during uploading
def ensure_file_not_changed
return if File.mtime(@file) == @file_meta[:mtime]
if @file_meta[:md5] != get_file_md5(@file)
fail FileInconsistentError, "The file to upload is changed."
end
end
end # Upload
end # Multipart
end # OSS
end # Aliyun
|