2
2
mirror of https://github.com/octoleo/restic.git synced 2024-12-03 02:18:23 +00:00
restic/internal/backend/swift/swift.go

346 lines
8.9 KiB
Go
Raw Normal View History

package swift
import (
2017-06-03 15:39:57 +00:00
"context"
"crypto/md5"
"encoding/hex"
2017-05-01 08:13:03 +00:00
"fmt"
"hash"
"io"
2017-05-01 08:13:03 +00:00
"net/http"
"path"
"strconv"
"strings"
"time"
2017-07-23 12:21:03 +00:00
"github.com/restic/restic/internal/backend"
"github.com/restic/restic/internal/backend/sema"
2017-07-23 12:21:03 +00:00
"github.com/restic/restic/internal/debug"
"github.com/restic/restic/internal/errors"
2017-07-24 15:42:25 +00:00
"github.com/restic/restic/internal/restic"
2017-07-23 12:21:03 +00:00
2020-12-17 11:47:53 +00:00
"github.com/cenkalti/backoff/v4"
2021-04-09 09:24:28 +00:00
"github.com/ncw/swift/v2"
)
// beSwift is a backend which stores the data on a swift endpoint.
type beSwift struct {
2021-08-07 20:20:49 +00:00
conn *swift.Connection
connections uint
sem sema.Semaphore
2021-08-07 20:20:49 +00:00
container string // Container name
prefix string // Prefix of object names in the container
2017-05-01 08:13:03 +00:00
backend.Layout
}
2017-06-03 15:39:57 +00:00
// ensure statically that *beSwift implements restic.Backend.
var _ restic.Backend = &beSwift{}
// Open opens the swift backend at a container in region. The container is
// created if it does not exist yet.
2021-04-09 09:24:28 +00:00
func Open(ctx context.Context, cfg Config, rt http.RoundTripper) (restic.Backend, error) {
2017-05-01 08:13:03 +00:00
debug.Log("config %#v", cfg)
sem, err := sema.New(cfg.Connections)
2017-06-05 22:33:25 +00:00
if err != nil {
return nil, err
}
be := &beSwift{
conn: &swift.Connection{
UserName: cfg.UserName,
UserId: cfg.UserID,
Domain: cfg.Domain,
DomainId: cfg.DomainID,
ApiKey: cfg.APIKey,
AuthUrl: cfg.AuthURL,
Region: cfg.Region,
Tenant: cfg.Tenant,
TenantId: cfg.TenantID,
TenantDomain: cfg.TenantDomain,
TenantDomainId: cfg.TenantDomainID,
TrustId: cfg.TrustID,
StorageUrl: cfg.StorageURL,
AuthToken: cfg.AuthToken.Unwrap(),
ApplicationCredentialId: cfg.ApplicationCredentialID,
ApplicationCredentialName: cfg.ApplicationCredentialName,
ApplicationCredentialSecret: cfg.ApplicationCredentialSecret.Unwrap(),
ConnectTimeout: time.Minute,
Timeout: time.Minute,
2017-05-01 08:13:03 +00:00
Transport: rt,
},
2021-08-07 20:20:49 +00:00
connections: cfg.Connections,
sem: sem,
container: cfg.Container,
prefix: cfg.Prefix,
2017-05-01 08:13:03 +00:00
Layout: &backend.DefaultLayout{
Path: cfg.Prefix,
Join: path.Join,
},
}
// Authenticate if needed
if !be.conn.Authenticated() {
2021-04-09 09:24:28 +00:00
if err := be.conn.Authenticate(ctx); err != nil {
return nil, errors.Wrap(err, "conn.Authenticate")
}
}
// Ensure container exists
2021-04-09 09:24:28 +00:00
switch _, _, err := be.conn.Container(ctx, be.container); err {
case nil:
// Container exists
case swift.ContainerNotFound:
2021-04-09 09:24:28 +00:00
err = be.createContainer(ctx, cfg.DefaultContainerPolicy)
if err != nil {
return nil, errors.Wrap(err, "beSwift.createContainer")
}
default:
return nil, errors.Wrap(err, "conn.Container")
}
2017-05-01 08:13:03 +00:00
return be, nil
}
2021-04-09 09:24:28 +00:00
func (be *beSwift) createContainer(ctx context.Context, policy string) error {
var h swift.Headers
if policy != "" {
h = swift.Headers{
"X-Storage-Policy": policy,
}
}
2021-04-09 09:24:28 +00:00
return be.conn.ContainerCreate(ctx, be.container, h)
}
2021-08-07 20:20:49 +00:00
func (be *beSwift) Connections() uint {
return be.connections
}
// Location returns this backend's location (the container name).
func (be *beSwift) Location() string {
return be.container
}
// Hasher may return a hash function for calculating a content hash for the backend
func (be *beSwift) Hasher() hash.Hash {
return md5.New()
}
// HasAtomicReplace returns whether Save() can atomically replace files
func (be *beSwift) HasAtomicReplace() bool {
return true
}
// Load runs fn with a reader that yields the contents of the file at h at the
// given offset.
func (be *beSwift) Load(ctx context.Context, h restic.Handle, length int, offset int64, fn func(rd io.Reader) error) error {
return backend.DefaultLoad(ctx, h, length, offset, be.openReader, fn)
}
func (be *beSwift) openReader(ctx context.Context, h restic.Handle, length int, offset int64) (io.ReadCloser, error) {
debug.Log("Load %v, length %v, offset %v", h, length, offset)
if err := h.Valid(); err != nil {
2020-12-17 11:47:53 +00:00
return nil, backoff.Permanent(err)
}
if offset < 0 {
return nil, errors.New("offset is negative")
}
if length < 0 {
return nil, errors.Errorf("invalid length %d", length)
}
2017-05-01 08:13:03 +00:00
objName := be.Filename(h)
2017-05-01 08:13:03 +00:00
headers := swift.Headers{}
if offset > 0 {
headers["Range"] = fmt.Sprintf("bytes=%d-", offset)
}
2017-05-01 08:13:03 +00:00
if length > 0 {
headers["Range"] = fmt.Sprintf("bytes=%d-%d", offset, offset+int64(length)-1)
}
2017-05-01 08:13:03 +00:00
if _, ok := headers["Range"]; ok {
debug.Log("Load(%v) send range %v", h, headers["Range"])
}
be.sem.GetToken()
2021-04-09 09:24:28 +00:00
obj, _, err := be.conn.ObjectOpen(ctx, be.container, objName, false, headers)
if err != nil {
2017-05-01 08:13:03 +00:00
debug.Log(" err %v", err)
be.sem.ReleaseToken()
2017-05-01 08:13:03 +00:00
return nil, errors.Wrap(err, "conn.ObjectOpen")
}
return be.sem.ReleaseTokenOnClose(obj, nil), nil
}
// Save stores data in the backend at the handle.
func (be *beSwift) Save(ctx context.Context, h restic.Handle, rd restic.RewindReader) error {
if err := h.Valid(); err != nil {
2020-12-17 11:47:53 +00:00
return backoff.Permanent(err)
}
2017-05-01 08:13:03 +00:00
objName := be.Filename(h)
2017-05-01 08:13:03 +00:00
debug.Log("Save %v at %v", h, objName)
be.sem.GetToken()
defer be.sem.ReleaseToken()
encoding := "binary/octet-stream"
2017-05-01 08:13:03 +00:00
debug.Log("PutObject(%v, %v, %v)", be.container, objName, encoding)
hdr := swift.Headers{"Content-Length": strconv.FormatInt(rd.Length(), 10)}
2021-04-09 09:24:28 +00:00
_, err := be.conn.ObjectPut(ctx,
be.container, objName, rd, true, hex.EncodeToString(rd.Hash()),
encoding, hdr)
// swift does not return the upload length
debug.Log("%v, err %#v", objName, err)
return errors.Wrap(err, "client.PutObject")
}
// Stat returns information about a blob.
2017-06-03 15:39:57 +00:00
func (be *beSwift) Stat(ctx context.Context, h restic.Handle) (bi restic.FileInfo, err error) {
debug.Log("%v", h)
2017-05-01 08:13:03 +00:00
objName := be.Filename(h)
be.sem.GetToken()
defer be.sem.ReleaseToken()
2021-04-09 09:24:28 +00:00
obj, _, err := be.conn.Object(ctx, be.container, objName)
if err != nil {
debug.Log("Object() err %v", err)
return restic.FileInfo{}, errors.Wrap(err, "conn.Object")
}
return restic.FileInfo{Size: obj.Bytes, Name: h.Name}, nil
}
// Test returns true if a blob of the given type and name exists in the backend.
2017-06-03 15:39:57 +00:00
func (be *beSwift) Test(ctx context.Context, h restic.Handle) (bool, error) {
2017-05-01 08:13:03 +00:00
objName := be.Filename(h)
be.sem.GetToken()
defer be.sem.ReleaseToken()
2021-04-09 09:24:28 +00:00
switch _, _, err := be.conn.Object(ctx, be.container, objName); err {
case nil:
return true, nil
case swift.ObjectNotFound:
return false, nil
default:
return false, errors.Wrap(err, "conn.Object")
}
}
// Remove removes the blob with the given name and type.
2017-06-03 15:39:57 +00:00
func (be *beSwift) Remove(ctx context.Context, h restic.Handle) error {
2017-05-01 08:13:03 +00:00
objName := be.Filename(h)
be.sem.GetToken()
defer be.sem.ReleaseToken()
2021-04-09 09:24:28 +00:00
err := be.conn.ObjectDelete(ctx, be.container, objName)
debug.Log("Remove(%v) -> err %v", h, err)
return errors.Wrap(err, "conn.ObjectDelete")
}
// List runs fn for each file in the backend which has the type t. When an
// error occurs (or fn returns an error), List stops and returns it.
func (be *beSwift) List(ctx context.Context, t restic.FileType, fn func(restic.FileInfo) error) error {
debug.Log("listing %v", t)
prefix, _ := be.Basedir(t)
prefix += "/"
2021-04-09 09:24:28 +00:00
err := be.conn.ObjectsWalk(ctx, be.container, &swift.ObjectsOpts{Prefix: prefix},
func(ctx context.Context, opts *swift.ObjectsOpts) (interface{}, error) {
be.sem.GetToken()
2021-04-09 09:24:28 +00:00
newObjects, err := be.conn.Objects(ctx, be.container, opts)
be.sem.ReleaseToken()
if err != nil {
return nil, errors.Wrap(err, "conn.ObjectNames")
}
for _, obj := range newObjects {
m := path.Base(strings.TrimPrefix(obj.Name, prefix))
if m == "" {
continue
}
fi := restic.FileInfo{
Name: m,
Size: obj.Bytes,
}
err := fn(fi)
if err != nil {
return nil, err
}
if ctx.Err() != nil {
return nil, ctx.Err()
}
}
return newObjects, nil
})
2017-05-01 08:13:03 +00:00
if err != nil {
return err
}
return ctx.Err()
}
// Remove keys for a specified backend type.
2017-06-03 15:39:57 +00:00
func (be *beSwift) removeKeys(ctx context.Context, t restic.FileType) error {
return be.List(ctx, t, func(fi restic.FileInfo) error {
return be.Remove(ctx, restic.Handle{Type: t, Name: fi.Name})
})
}
2017-05-01 08:13:03 +00:00
// IsNotExist returns true if the error is caused by a not existing file.
func (be *beSwift) IsNotExist(err error) bool {
var e *swift.Error
return errors.As(err, &e) && e.StatusCode == http.StatusNotFound
2017-05-01 08:13:03 +00:00
}
// Delete removes all restic objects in the container.
// It will not remove the container itself.
2017-06-03 15:39:57 +00:00
func (be *beSwift) Delete(ctx context.Context) error {
alltypes := []restic.FileType{
restic.PackFile,
restic.KeyFile,
restic.LockFile,
restic.SnapshotFile,
restic.IndexFile}
for _, t := range alltypes {
2017-06-03 15:39:57 +00:00
err := be.removeKeys(ctx, t)
if err != nil {
return nil
}
}
2017-06-03 15:39:57 +00:00
err := be.Remove(ctx, restic.Handle{Type: restic.ConfigFile})
2017-05-01 08:13:03 +00:00
if err != nil && !be.IsNotExist(err) {
return err
}
return nil
}
// Close does nothing
func (be *beSwift) Close() error { return nil }