package storage import ( "bytes" "context" "encoding/json" "github.com/qiniu/go-sdk/v7/client" "github.com/qiniu/go-sdk/v7/internal/hostprovider" "hash/crc32" "io" "os" "path/filepath" "sort" "sync" ) // ResumeUploader 表示一个分片上传的对象 type ResumeUploader struct { Client *client.Client Cfg *Config } // NewResumeUploader 表示构建一个新的分片上传的对象 func NewResumeUploader(cfg *Config) *ResumeUploader { return NewResumeUploaderEx(cfg, nil) } // NewResumeUploaderEx 表示构建一个新的分片上传的对象 func NewResumeUploaderEx(cfg *Config, clt *client.Client) *ResumeUploader { if cfg == nil { cfg = &Config{} } if clt == nil { clt = &client.DefaultClient } return &ResumeUploader{ Client: clt, Cfg: cfg, } } // Put 方法用来上传一个文件,支持断点续传和分块上传。 // // ctx 是请求的上下文。 // ret 是上传成功后返回的数据。如果 upToken 中没有设置 CallbackUrl 或 ReturnBody,那么返回的数据结构是 PutRet 结构。 // upToken 是由业务服务器颁发的上传凭证。 // key 是要上传的文件访问路径。比如:"foo/bar.jpg"。注意我们建议 key 不要以 '/' 开头。另外,key 为空字符串是合法的。 // f 是文件内容的访问接口。考虑到需要支持分块上传和断点续传,要的是 io.ReaderAt 接口,而不是 io.Reader。 // fsize 是要上传的文件大小。 // extra 是上传的一些可选项。详细见 RputExtra 结构的描述。 func (p *ResumeUploader) Put(ctx context.Context, ret interface{}, upToken string, key string, f io.ReaderAt, fsize int64, extra *RputExtra) error { return p.rput(ctx, ret, upToken, key, true, f, fsize, nil, extra) } func (p *ResumeUploader) PutWithoutSize(ctx context.Context, ret interface{}, upToken, key string, r io.Reader, extra *RputExtra) error { return p.rputWithoutSize(ctx, ret, upToken, key, true, r, extra) } // PutWithoutKey 方法用来上传一个文件,支持断点续传和分块上传。文件命名方式首先看看 // upToken 中是否设置了 saveKey,如果设置了 saveKey,那么按 saveKey 要求的规则生成 key,否则自动以文件的 hash 做 key。 // // ctx 是请求的上下文。 // ret 是上传成功后返回的数据。如果 upToken 中没有设置 CallbackUrl 或 ReturnBody,那么返回的数据结构是 PutRet 结构。 // upToken 是由业务服务器颁发的上传凭证。 // f 是文件内容的访问接口。考虑到需要支持分块上传和断点续传,要的是 io.ReaderAt 接口,而不是 io.Reader。 // fsize 是要上传的文件大小。 // extra 是上传的一些可选项。详细见 RputExtra 结构的描述。 func (p *ResumeUploader) PutWithoutKey(ctx context.Context, ret interface{}, upToken string, f io.ReaderAt, fsize int64, extra *RputExtra) error { return p.rput(ctx, ret, upToken, "", false, f, fsize, nil, extra) } // PutWithoutKeyAndSize 方法用来上传一个文件,支持断点续传和分块上传。文件命名方式首先看看 // upToken 中是否设置了 saveKey,如果设置了 saveKey,那么按 saveKey 要求的规则生成 key,否则自动以文件的 hash 做 key。 // // ctx 是请求的上下文。 // ret 是上传成功后返回的数据。如果 upToken 中没有设置 CallbackUrl 或 ReturnBody,那么返回的数据结构是 PutRet 结构。 // upToken 是由业务服务器颁发的上传凭证。 // f 是文件内容的访问接口。 // extra 是上传的一些可选项。详细见 RputExtra 结构的描述。 func (p *ResumeUploader) PutWithoutKeyAndSize(ctx context.Context, ret interface{}, upToken string, f io.Reader, extra *RputExtra) error { return p.rputWithoutSize(ctx, ret, upToken, "", false, f, extra) } // PutFile 用来上传一个文件,支持断点续传和分块上传。 // 和 Put 不同的只是一个通过提供文件路径来访问文件内容,一个通过 io.ReaderAt 来访问。 // // ctx 是请求的上下文。 // ret 是上传成功后返回的数据。如果 upToken 中没有设置 CallbackUrl 或 ReturnBody,那么返回的数据结构是 PutRet 结构。 // upToken 是由业务服务器颁发的上传凭证。 // key 是要上传的文件访问路径。比如:"foo/bar.jpg"。注意我们建议 key 不要以 '/' 开头。另外,key 为空字符串是合法的。 // localFile 是要上传的文件的本地路径。 // extra 是上传的一些可选项。详细见 RputExtra 结构的描述。 func (p *ResumeUploader) PutFile(ctx context.Context, ret interface{}, upToken, key, localFile string, extra *RputExtra) error { return p.rputFile(ctx, ret, upToken, key, true, localFile, extra) } // PutFileWithoutKey 上传一个文件,支持断点续传和分块上传。文件命名方式首先看看 // upToken 中是否设置了 saveKey,如果设置了 saveKey,那么按 saveKey 要求的规则生成 key,否则自动以文件的 hash 做 key。 // 和 PutWithoutKey 不同的只是一个通过提供文件路径来访问文件内容,一个通过 io.ReaderAt 来访问。 // // ctx 是请求的上下文。 // ret 是上传成功后返回的数据。如果 upToken 中没有设置 CallbackUrl 或 ReturnBody,那么返回的数据结构是 PutRet 结构。 // upToken 是由业务服务器颁发的上传凭证。 // localFile 是要上传的文件的本地路径。 // extra 是上传的一些可选项。详细见 RputExtra 结构的描述。 func (p *ResumeUploader) PutFileWithoutKey(ctx context.Context, ret interface{}, upToken, localFile string, extra *RputExtra) error { return p.rputFile(ctx, ret, upToken, "", false, localFile, extra) } type fileDetailsInfo struct { fileFullPath string fileInfo os.FileInfo } func (p *ResumeUploader) rput(ctx context.Context, ret interface{}, upToken string, key string, hasKey bool, f io.ReaderAt, fsize int64, fileDetails *fileDetailsInfo, extra *RputExtra) (err error) { if extra == nil { extra = &RputExtra{} } extra.init() var ( accessKey, bucket, recorderKey string fileInfo os.FileInfo = nil hostProvider hostprovider.HostProvider = nil ) if fileDetails != nil { fileInfo = fileDetails.fileInfo } if accessKey, bucket, err = getAkBucketFromUploadToken(upToken); err != nil { return } if extra.UpHost != "" { hostProvider = hostprovider.NewWithHosts([]string{extra.getUpHost(p.Cfg.UseHTTPS)}) } else { hostProvider, err = p.resumeUploaderAPIs().upHostProvider(accessKey, bucket, extra.TryTimes, extra.HostFreezeDuration) if err != nil { return } } recorderKey = getRecorderKey(extra.Recorder, upToken, key, "v1", blockSize, fileDetails) return uploadByWorkers( newResumeUploaderImpl(p, key, hasKey, upToken, hostProvider, fileInfo, extra, ret, recorderKey), ctx, newSizedChunkReader(f, fsize, blockSize)) } func (p *ResumeUploader) rputWithoutSize(ctx context.Context, ret interface{}, upToken string, key string, hasKey bool, r io.Reader, extra *RputExtra) (err error) { if extra == nil { extra = &RputExtra{} } extra.init() var ( accessKey, bucket string hostProvider hostprovider.HostProvider = nil ) if accessKey, bucket, err = getAkBucketFromUploadToken(upToken); err != nil { return } if extra.UpHost != "" { hostProvider = hostprovider.NewWithHosts([]string{extra.getUpHost(p.Cfg.UseHTTPS)}) } else { hostProvider, err = p.resumeUploaderAPIs().upHostProvider(accessKey, bucket, extra.TryTimes, extra.HostFreezeDuration) if err != nil { return } } return uploadByWorkers( newResumeUploaderImpl(p, key, hasKey, upToken, hostProvider, nil, extra, ret, ""), ctx, newUnsizedChunkReader(r, 1< 0 { if recorderData, err := impl.extra.Recorder.Get(impl.recorderKey); err == nil { recovered = impl.recover(ctx, recorderData) if len(recovered) == 0 { impl.deleteUploadRecordIfNeed(nil, true) } } } return recovered, nil } func (impl *resumeUploaderImpl) uploadChunk(ctx context.Context, c chunk) error { type ChunkRange struct { From int64 Size int64 } var ( chunkSize = int64(impl.extra.ChunkSize) apis = impl.resumeUploaderAPIs() chunkRange ChunkRange blkPutRet BlkputRet err error realChunkSize int64 totalChunkSize = int64(0) buffer = impl.bufPool.Get().(*bytes.Buffer) ) defer impl.bufPool.Put(buffer) for chunkOffset := int64(0); chunkOffset < c.size; chunkOffset += chunkRange.Size { chunkRange = ChunkRange{From: chunkOffset, Size: c.size - chunkOffset} if chunkRange.Size > chunkSize { chunkRange.Size = chunkSize } hash32 := crc32.NewIEEE() buffer.Reset() realChunkSize, err = io.Copy(hash32, io.TeeReader(io.NewSectionReader(c.reader, chunkRange.From, chunkRange.Size), buffer)) if err != nil { impl.extra.NotifyErr(int(c.id), int(c.size), err) return err } else if realChunkSize == 0 { break } else { totalChunkSize += realChunkSize } crc32Value := hash32.Sum32() seekableData := bytes.NewReader(buffer.Bytes()) if chunkOffset == 0 { err = doUploadAction(impl.upHostProvider, impl.extra.TryTimes, impl.extra.HostFreezeDuration, func(host string) error { if _, sErr := seekableData.Seek(0, io.SeekStart); sErr != nil { return sErr } if e := apis.mkBlk(ctx, impl.upToken, host, &blkPutRet, c.size, seekableData, realChunkSize); e != nil { return e } if blkPutRet.Crc32 != crc32Value || int64(blkPutRet.Offset) != chunkOffset+realChunkSize { return ErrUnmatchedChecksum } return nil }) } else { err = doUploadAction(impl.upHostProvider, impl.extra.TryTimes, impl.extra.HostFreezeDuration, func(host string) error { blkPutRet.Host = host if _, sErr := seekableData.Seek(0, io.SeekStart); sErr != nil { return sErr } if e := apis.bput(ctx, impl.upToken, &blkPutRet, seekableData, realChunkSize); e != nil { return e } if blkPutRet.Crc32 != crc32Value || int64(blkPutRet.Offset) != chunkOffset+realChunkSize { return ErrUnmatchedChecksum } return nil }) } if err != nil { impl.extra.NotifyErr(int(c.id), int(realChunkSize), err) impl.deleteUploadRecordIfNeed(err, false) return err } } blkPutRet.blkIdx = int(c.id) blkPutRet.fileOffset = c.offset blkPutRet.chunkSize = int(totalChunkSize) func() { impl.lock.Lock() defer impl.lock.Unlock() impl.extra.Progresses = append(impl.extra.Progresses, blkPutRet) impl.fileSize += c.size impl.save(ctx) }() impl.extra.Notify(blkPutRet.blkIdx, int(totalChunkSize), &blkPutRet) select { case <-ctx.Done(): return ctx.Err() default: } return nil } func (impl *resumeUploaderImpl) final(ctx context.Context) error { if impl.extra.Recorder != nil && len(impl.recorderKey) > 0 { impl.deleteUploadRecordIfNeed(nil, true) } sort.Sort(blkputRets(impl.extra.Progresses)) err := doUploadAction(impl.upHostProvider, impl.extra.TryTimes, impl.extra.HostFreezeDuration, func(host string) error { return impl.resumeUploaderAPIs().mkfile(ctx, impl.upToken, host, impl.ret, impl.key, impl.hasKey, impl.fileSize, impl.extra) }) impl.deleteUploadRecordIfNeed(err, false) return err } func (impl *resumeUploaderImpl) deleteUploadRecordIfNeed(err error, force bool) { // 无效删除之前的记录 if force || (isContextExpiredError(err) && impl.extra.Recorder != nil && len(impl.recorderKey) > 0) { _ = impl.extra.Recorder.Delete(impl.recorderKey) } } func (impl *resumeUploaderImpl) recover(ctx context.Context, recoverData []byte) (recovered []int64) { var recoveryInfo resumeUploaderRecoveryInfo if err := json.Unmarshal(recoverData, &recoveryInfo); err != nil { return nil } if impl.fileInfo == nil || recoveryInfo.FileSize != impl.fileInfo.Size() || recoveryInfo.ModTimeStamp != impl.fileInfo.ModTime().UnixNano() { return nil } if recoveryInfo.RecorderVersion != uploadRecordVersion { return } for _, c := range recoveryInfo.Contexts { if isUploadContextExpired(c.ExpiredAt) { // 有一个过期,最终其实都会无效,重传最后之前没过期的也可能会过期 return nil } impl.fileSize += int64(c.ChunkSize) impl.extra.Progresses = append(impl.extra.Progresses, BlkputRet{ blkIdx: c.Idx, fileOffset: c.Offset, chunkSize: c.ChunkSize, Ctx: c.Ctx, ExpiredAt: c.ExpiredAt, }) recovered = append(recovered, c.Offset) } return recovered } func (impl *resumeUploaderImpl) save(ctx context.Context) { var ( recoveryInfo resumeUploaderRecoveryInfo recoveredData []byte err error ) if impl.fileInfo == nil || impl.extra.Recorder == nil || len(impl.recorderKey) == 0 { return } recoveryInfo.RecorderVersion = uploadRecordVersion recoveryInfo.Region = impl.cfg.Region recoveryInfo.FileSize = impl.fileInfo.Size() recoveryInfo.ModTimeStamp = impl.fileInfo.ModTime().UnixNano() recoveryInfo.Contexts = make([]resumeUploaderRecoveryInfoContext, 0, len(impl.extra.Progresses)) for _, progress := range impl.extra.Progresses { recoveryInfo.Contexts = append(recoveryInfo.Contexts, resumeUploaderRecoveryInfoContext{ Ctx: progress.Ctx, Idx: progress.blkIdx, Offset: progress.fileOffset, ChunkSize: progress.chunkSize, ExpiredAt: progress.ExpiredAt, }) } if recoveredData, err = json.Marshal(recoveryInfo); err != nil { return } err = impl.extra.Recorder.Set(impl.recorderKey, recoveredData) } func (impl *resumeUploaderImpl) resumeUploaderAPIs() *resumeUploaderAPIs { return &resumeUploaderAPIs{Client: impl.client, Cfg: impl.cfg} }