mc/cmd/typed-errors.go

// Copyright (c) 2015-2022 MinIO, Inc.
//
// This file is part of MinIO Object Storage 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 (
	"errors"
	"fmt"
	"strings"

	"github.com/minio/mc/pkg/probe"
)

type dummyErr error

var errDummy = func() *probe.Error {
	msg := ""
	return probe.NewError(dummyErr(errors.New(msg))).Untrace()
}

type invalidArgumentErr error

var errInvalidArgument = func() *probe.Error {
	msg := "Invalid arguments provided, please refer " + "`mc <command> -h` for relevant documentation."
	return probe.NewError(invalidArgumentErr(errors.New(msg))).Untrace()
}

type unableToGuessErr error

var errUnableToGuess = func() *probe.Error {
	msg := "Unable to guess the type of copy operation."
	return probe.NewError(unableToGuessErr(errors.New(msg)))
}

type unrecognizedDiffTypeErr error

var errUnrecognizedDiffType = func(diff differType) *probe.Error {
	msg := "Unrecognized diffType: " + diff.String() + " provided."
	return probe.NewError(unrecognizedDiffTypeErr(errors.New(msg))).Untrace()
}

type invalidAliasedURLErr error

var errInvalidAliasedURL = func(URL string) *probe.Error {
	msg := "Use `mc alias set mycloud " + URL + " ...` to add an alias. Use the alias for S3 operations."
	return probe.NewError(invalidAliasedURLErr(errors.New(msg))).Untrace()
}

type invalidAliasErr error

var errInvalidAlias = func(alias string) *probe.Error {
	msg := "Alias `" + alias + "` should have alphanumeric characters such as [helloWorld0, hello_World0, ...] and begin with a letter"
	return probe.NewError(invalidAliasErr(errors.New(msg)))
}

type invalidURLErr error

var errInvalidURL = func(URL string) *probe.Error {
	msg := "URL `" + URL + "` for MinIO Client should be of the form scheme://host[:port]/ without resource component."
	return probe.NewError(invalidURLErr(errors.New(msg)))
}

type invalidAPISignatureErr error

var errInvalidAPISignature = func(api, url string) *probe.Error {
	msg := fmt.Sprintf(
		"Unrecognized API signature %s for host %s. Valid options are `[%s]`",
		api, url, strings.Join(validAPIs, ", "))
	return probe.NewError(invalidAPISignatureErr(errors.New(msg)))
}

type noMatchingHostErr error

var errNoMatchingHost = func(URL string) *probe.Error {
	msg := "No matching host found for the given URL `" + URL + "`."
	return probe.NewError(noMatchingHostErr(errors.New(msg))).Untrace()
}

type invalidSourceErr error

var errInvalidSource = func(URL string) *probe.Error {
	msg := "Invalid source `" + URL + "`."
	return probe.NewError(invalidSourceErr(errors.New(msg))).Untrace()
}

type invalidTargetErr error

var errInvalidTarget = func(URL string) *probe.Error {
	msg := "Invalid target `" + URL + "`."
	return probe.NewError(invalidTargetErr(errors.New(msg))).Untrace()
}

type requiresRecuriveErr error

var errRequiresRecursive = func(URL string) *probe.Error {
	msg := "To copy or move '" + URL + "' the --recursive flag is required."
	return probe.NewError(requiresRecuriveErr(errors.New(msg))).Untrace()
}

type copyIntoSelfErr error

var errCopyIntoSelf = func(URL string) *probe.Error {
	msg := "Copying or moving '" + URL + "' into itself is not allowed."
	return probe.NewError(copyIntoSelfErr(errors.New(msg))).Untrace()
}

type targetNotFoundErr error

var errTargetNotFound = func(URL string) *probe.Error {
	msg := "Target `" + URL + "` not found."
	return probe.NewError(targetNotFoundErr(errors.New(msg))).Untrace()
}

type overwriteNotAllowedErr struct {
	error
}

var errOverWriteNotAllowed = func(URL string) *probe.Error {
	msg := "Overwrite not allowed for `" + URL + "`. Use `--overwrite` to override this behavior."
	return probe.NewError(overwriteNotAllowedErr{errors.New(msg)})
}

type targetIsNotDirErr error

var errTargetIsNotDir = func(URL string) *probe.Error {
	msg := "Target `" + URL + "` is not a folder."
	return probe.NewError(targetIsNotDirErr(errors.New(msg))).Untrace()
}

type sourceIsDirErr error

var errSourceIsDir = func(URL string) *probe.Error {
	msg := "Source `" + URL + "` is a folder."
	return probe.NewError(sourceIsDirErr(errors.New(msg))).Untrace()
}

type sseInvalidAliasErr error

var errSSEInvalidAlias = func(prefix string) *probe.Error {
	msg := "SSE prefix " + prefix + " has an invalid alias."
	return probe.NewError(sseInvalidAliasErr(errors.New(msg))).Untrace()
}

type sseOverlappingAliasErr error

var errSSEOverlappingAlias = func(prefix, overlappingPrefix string) *probe.Error {
	msg := "SSE prefix " + prefix + " overlaps with " + overlappingPrefix
	return probe.NewError(sseOverlappingAliasErr(errors.New(msg))).Untrace()
}

type ssePrefixMatchErr error

var errSSEPrefixMatch = func() *probe.Error {
	msg := "SSE prefixes do not match any object paths."
	return probe.NewError(ssePrefixMatchErr(errors.New(msg))).Untrace()
}

type sseKeyMissingError error

var errSSEKeyMissing = func() *probe.Error {
	m := "SSE key is missing"
	return probe.NewError(sseKeyMissingError(errors.New(m))).Untrace()
}

type sseKMSKeyFormatErr error

var errSSEKMSKeyFormat = func(msg string) *probe.Error {
	m := "SSE key format error. "
	m += msg
	return probe.NewError(sseKMSKeyFormatErr(errors.New(m))).Untrace()
}

type sseClientKeyFormatErr error

var errSSEClientKeyFormat = func(msg string) *probe.Error {
	m := "Encryption key should be 44 bytes raw base64 encoded key."
	m += msg
	return probe.NewError(sseClientKeyFormatErr(errors.New(m))).Untrace()
}