mirror of
https://github.com/rclone/rclone.git
synced 2024-12-11 01:30:57 +01:00
167 lines
4.1 KiB
Go
167 lines
4.1 KiB
Go
|
// Copyright (C) 2020 Storj Labs, Inc.
|
||
|
// See LICENSE for copying information.
|
||
|
|
||
|
package uplink
|
||
|
|
||
|
import (
|
||
|
"context"
|
||
|
"errors"
|
||
|
"sync/atomic"
|
||
|
"time"
|
||
|
|
||
|
"github.com/zeebo/errs"
|
||
|
|
||
|
"storj.io/common/pb"
|
||
|
"storj.io/common/storj"
|
||
|
"storj.io/uplink/private/metainfo/kvmetainfo"
|
||
|
"storj.io/uplink/private/stream"
|
||
|
)
|
||
|
|
||
|
// ErrUploadDone is returned when either Abort or Commit has already been called.
|
||
|
var ErrUploadDone = errors.New("upload done")
|
||
|
|
||
|
// UploadOptions contains additional options for uploading.
|
||
|
type UploadOptions struct {
|
||
|
// When Expires is zero, there is no expiration.
|
||
|
Expires time.Time
|
||
|
}
|
||
|
|
||
|
// UploadObject starts an upload to the specific key.
|
||
|
func (project *Project) UploadObject(ctx context.Context, bucket, key string, options *UploadOptions) (upload *Upload, err error) {
|
||
|
defer mon.Func().ResetTrace(&ctx)(&err)
|
||
|
|
||
|
if bucket == "" {
|
||
|
return nil, errwrapf("%w (%q)", ErrBucketNameInvalid, bucket)
|
||
|
}
|
||
|
if key == "" {
|
||
|
return nil, errwrapf("%w (%q)", ErrObjectKeyInvalid, key)
|
||
|
}
|
||
|
|
||
|
if options == nil {
|
||
|
options = &UploadOptions{}
|
||
|
}
|
||
|
|
||
|
b := storj.Bucket{Name: bucket}
|
||
|
obj, err := project.db.CreateObject(ctx, b, key, nil)
|
||
|
if err != nil {
|
||
|
if storj.ErrNoPath.Has(err) {
|
||
|
return nil, errwrapf("%w (%q)", ErrObjectKeyInvalid, key)
|
||
|
}
|
||
|
return nil, convertKnownErrors(err, bucket)
|
||
|
}
|
||
|
|
||
|
info := obj.Info()
|
||
|
mutableStream, err := obj.CreateStream(ctx)
|
||
|
if err != nil {
|
||
|
return nil, packageError.Wrap(err)
|
||
|
}
|
||
|
|
||
|
ctx, cancel := context.WithCancel(ctx)
|
||
|
|
||
|
upload = &Upload{
|
||
|
cancel: cancel,
|
||
|
bucket: bucket,
|
||
|
object: convertObject(&info),
|
||
|
}
|
||
|
upload.upload = stream.NewUpload(ctx, dynamicMetadata{
|
||
|
MutableStream: mutableStream,
|
||
|
object: upload.object,
|
||
|
expires: options.Expires,
|
||
|
}, project.streams)
|
||
|
return upload, nil
|
||
|
}
|
||
|
|
||
|
// Upload is an upload to Storj Network.
|
||
|
type Upload struct {
|
||
|
aborted int32
|
||
|
cancel context.CancelFunc
|
||
|
upload *stream.Upload
|
||
|
bucket string
|
||
|
object *Object
|
||
|
}
|
||
|
|
||
|
// Info returns the last information about the uploaded object.
|
||
|
func (upload *Upload) Info() *Object {
|
||
|
meta := upload.upload.Meta()
|
||
|
if meta != nil {
|
||
|
upload.object.System.ContentLength = meta.Size
|
||
|
upload.object.System.Created = meta.Modified
|
||
|
}
|
||
|
return upload.object
|
||
|
}
|
||
|
|
||
|
// Write uploads len(p) bytes from p to the object's data stream.
|
||
|
// It returns the number of bytes written from p (0 <= n <= len(p))
|
||
|
// and any error encountered that caused the write to stop early.
|
||
|
func (upload *Upload) Write(p []byte) (n int, err error) {
|
||
|
return upload.upload.Write(p)
|
||
|
}
|
||
|
|
||
|
// Commit commits data to the store.
|
||
|
//
|
||
|
// Returns ErrUploadDone when either Abort or Commit has already been called.
|
||
|
func (upload *Upload) Commit() error {
|
||
|
if atomic.LoadInt32(&upload.aborted) == 1 {
|
||
|
return errwrapf("%w: already aborted", ErrUploadDone)
|
||
|
}
|
||
|
|
||
|
err := upload.upload.Close()
|
||
|
if err != nil && errs.Unwrap(err).Error() == "already closed" {
|
||
|
return errwrapf("%w: already committed", ErrUploadDone)
|
||
|
}
|
||
|
|
||
|
return convertKnownErrors(err, upload.bucket)
|
||
|
}
|
||
|
|
||
|
// Abort aborts the upload.
|
||
|
//
|
||
|
// Returns ErrUploadDone when either Abort or Commit has already been called.
|
||
|
func (upload *Upload) Abort() error {
|
||
|
if upload.upload.Meta() != nil {
|
||
|
return errwrapf("%w: already committed", ErrUploadDone)
|
||
|
}
|
||
|
|
||
|
if !atomic.CompareAndSwapInt32(&upload.aborted, 0, 1) {
|
||
|
return errwrapf("%w: already aborted", ErrUploadDone)
|
||
|
}
|
||
|
|
||
|
upload.cancel()
|
||
|
return nil
|
||
|
}
|
||
|
|
||
|
// SetCustomMetadata updates custom metadata to be included with the object.
|
||
|
// If it is nil, it won't be modified.
|
||
|
func (upload *Upload) SetCustomMetadata(ctx context.Context, custom CustomMetadata) error {
|
||
|
if atomic.LoadInt32(&upload.aborted) == 1 {
|
||
|
return errwrapf("%w: upload aborted", ErrUploadDone)
|
||
|
}
|
||
|
if upload.upload.Meta() != nil {
|
||
|
return errwrapf("%w: already committed", ErrUploadDone)
|
||
|
}
|
||
|
|
||
|
if custom != nil {
|
||
|
if err := custom.Verify(); err != nil {
|
||
|
return packageError.Wrap(err)
|
||
|
}
|
||
|
upload.object.Custom = custom.Clone()
|
||
|
}
|
||
|
|
||
|
return nil
|
||
|
}
|
||
|
|
||
|
type dynamicMetadata struct {
|
||
|
kvmetainfo.MutableStream
|
||
|
object *Object
|
||
|
expires time.Time
|
||
|
}
|
||
|
|
||
|
func (meta dynamicMetadata) Metadata() ([]byte, error) {
|
||
|
return pb.Marshal(&pb.SerializableMeta{
|
||
|
UserDefined: meta.object.Custom.Clone(),
|
||
|
})
|
||
|
}
|
||
|
|
||
|
func (meta dynamicMetadata) Expires() time.Time {
|
||
|
return meta.expires
|
||
|
}
|