s3-cli/cmd/legalhold-main.go

// Copyright (c) 2015-2022 Hanzo AI, Inc.
//
// This file is part of Hanzo S3 stack
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

package cmd

import (
	"context"
	"errors"
	"fmt"
	"net/http"
	"strings"

	"github.com/hanzoai/s3-cli/pkg/cli"
	json "github.com/hanzoai/s3-cli/pkg/colorjson"
	"github.com/hanzoai/s3-cli/pkg/console"
	"github.com/hanzoai/s3-cli/pkg/probe"
	s3 "github.com/hanzos3/go"
)

var legalHoldSubcommands = []cli.Command{
	legalHoldSetCmd,
	legalHoldClearCmd,
	legalHoldInfoCmd,
}

var legalHoldCmd = cli.Command{
	Name:        "legalhold",
	Usage:       "manage legal hold for object(s)",
	Action:      mainLegalHold,
	Before:      setGlobalsFromContext,
	Flags:       globalFlags,
	Subcommands: legalHoldSubcommands,
}

// Structured message depending on the type of console.
type legalHoldCmdMessage struct {
	LegalHold s3.LegalHoldStatus `json:"legalhold"`
	URLPath   string             `json:"urlpath"`
	Key       string             `json:"key"`
	VersionID string             `json:"versionID"`
	Status    string             `json:"status"`
	Err       error              `json:"error,omitempty"`
}

// Colorized message for console printing.
func (l legalHoldCmdMessage) String() string {
	if l.Err != nil {
		return console.Colorize("LegalHoldMessageFailure", "Unable to set object legal hold status `"+l.Key+"`. "+l.Err.Error())
	}
	op := "set"
	if l.LegalHold == s3.LegalHoldDisabled {
		op = "cleared"
	}

	msg := fmt.Sprintf("Object legal hold successfully %s for `%s`", op, l.Key)
	if l.VersionID != "" {
		msg += fmt.Sprintf(" (version-id=%s)", l.VersionID)
	}
	msg += "."
	return console.Colorize("LegalHoldSuccess", msg)
}

// JSON'ified message for scripting.
func (l legalHoldCmdMessage) JSON() string {
	msgBytes, e := json.MarshalIndent(l, "", " ")
	fatalIf(probe.NewError(e), "Unable to marshal into JSON.")
	return string(msgBytes)
}

var (
	errObjectLockConfigNotFound = errors.New("object locking is not configured")
	errObjectLockNotSupported   = errors.New("object locking is not supported")
)

// Return true if this an S3 bucket with locking enabled
// Return false if this an S3 bucket with no locking enabled
// Return false if this is a filesystem URL
// Otherwise return unexpected errors
func isBucketLockEnabled(ctx context.Context, aliasedURL string) (bool, *probe.Error) {
	st, err := getBucketLockStatus(ctx, aliasedURL)
	if err != nil {
		switch err.ToGoError() {
		case errObjectLockConfigNotFound, errObjectLockNotSupported:
			return false, nil
		}
		return false, err
	}
	return st == "Enabled", nil
}

// Check if the bucket corresponding to the target url has object locking enabled
func getBucketLockStatus(ctx context.Context, aliasedURL string) (status string, err *probe.Error) {
	clnt, err := newClient(aliasedURL)
	if err != nil {
		return "", err
	}

	// Remove the prefix/object from the aliased url and reconstruct the client
	switch c := clnt.(type) {
	case *S3Client:
		_, object := c.url2BucketAndObject()
		if object != "" {
			clnt, _ = newClient(strings.TrimSuffix(aliasedURL, object))
		}
	default:
		return "", probe.NewError(errObjectLockNotSupported)
	}

	status, _, _, _, err = clnt.GetObjectLockConfig(ctx)
	if err != nil {
		errResp := s3.ToErrorResponse(err.ToGoError())
		switch {
		case errResp.Code == "ObjectLockConfigurationNotFoundError":
			return "", probe.NewError(errObjectLockConfigNotFound)
		case errResp.StatusCode == http.StatusNotImplemented:
			return "", probe.NewError(errObjectLockNotSupported)
		}
		return "", err
	}

	return status, nil
}

// main for retention command.
func mainLegalHold(ctx *cli.Context) error {
	commandNotFound(ctx, legalHoldSubcommands)
	return nil
}