ergo/irc/errors.go

// Copyright (c) 2012-2014 Jeremy Latt
// Copyright (c) 2014-2015 Edmund Huber
// Copyright (c) 2016-2017 Daniel Oaks <daniel@danieloaks.net>
// released under the MIT license

package irc

import (
	"errors"
	"fmt"
	"time"

	"github.com/ergochat/ergo/irc/utils"
)

// Runtime Errors
var (
	errAccountAlreadyRegistered        = errors.New("Account already exists")
	errAccountAlreadyUnregistered      = errors.New("Account was already unregistered")
	errAccountAlreadyVerified          = errors.New("Account is already verified")
	errAccountCantDropPrimaryNick      = errors.New("Can't unreserve primary nickname")
	errAccountCreation                 = errors.New("Account could not be created")
	errAccountDoesNotExist             = errors.New("Account does not exist")
	errAccountInvalidCredentials       = errors.New("Invalid account credentials")
	errAccountBadPassphrase            = errors.New("Passphrase contains forbidden characters or is otherwise invalid")
	errAccountNickReservationFailed    = errors.New("Could not (un)reserve nick")
	errAccountNotLoggedIn              = errors.New("You're not logged into an account")
	errAccountAlreadyLoggedIn          = errors.New("You're already logged into an account")
	errAccountPasswordInvalid          = errors.New("Password incorrect")
	errAccountTooManyNicks             = errors.New("Account has too many reserved nicks")
	errAccountUnverified               = errors.New("Account is not yet verified")
	errAccountSuspended                = errors.New("Account has been suspended")
	errAccountVerificationFailed       = errors.New("Account verification failed")
	errAccountVerificationInvalidCode  = errors.New("Invalid verification code")
	errAccountUpdateFailed             = errors.New("Error while updating your account information")
	errAccountMustHoldNick             = errors.New("You must hold that nickname in order to register it")
	errAccountBadUnregisterCredentials = errors.New("Invalid credentials for unregistering account")
	errAccountBadSetting               = errors.New("Invalid account setting")
	errAuthRequired                    = errors.New("You must be logged into an account to do this")
	errAuthzidAuthcidMismatch          = errors.New("authcid and authzid must be the same")
	errCertfpAlreadyExists             = errors.New("An account already exists for your certificate fingerprint")
	errChannelNotOwnedByAccount        = errors.New("Channel not owned by the specified account")
	errChannelTransferNotOffered       = errors.New("You weren't offered ownership of that channel")
	errChannelAlreadyRegistered        = errors.New("Channel is already registered")
	errChannelNotRegistered            = errors.New("Channel is not registered")
	errChannelNameInUse                = errors.New("Channel name in use")
	errInvalidChannelName              = errors.New("Invalid channel name")
	errMonitorLimitExceeded            = errors.New("Monitor limit exceeded")
	errNickMissing                     = errors.New("nick missing")
	errNicknameInvalid                 = errors.New("invalid nickname")
	errNicknameInUse                   = errors.New("nickname in use")
	errInsecureReattach                = errors.New("insecure reattach")
	errNicknameReserved                = errors.New("nickname is reserved")
	errNickAccountMismatch             = errors.New("Your nickname must match your account name; try logging out and logging back in with SASL")
	errNoExistingBan                   = errors.New("Ban does not exist")
	errNoSuchChannel                   = errors.New("No such channel")
	errChannelPurged                   = errors.New("This channel was purged by the server operators and cannot be used")
	errChannelPurgedAlready            = errors.New("This channel was already purged and cannot be purged again")
	errConfusableIdentifier            = errors.New("This identifier is confusable with one already in use")
	errInsufficientPrivs               = errors.New("Insufficient privileges")
	errInvalidUsername                 = errors.New("Invalid username")
	errFeatureDisabled                 = errors.New("That feature is disabled")
	errBanned                          = errors.New("IP or nickmask banned")
	errInvalidParams                   = utils.ErrInvalidParams
	errNoVhost                         = errors.New("You do not have an approved vhost")
	errLimitExceeded                   = errors.New("Limit exceeded")
	errNoop                            = errors.New("Action was a no-op")
	errCASFailed                       = errors.New("Compare-and-swap update of database value failed")
	errEmptyCredentials                = errors.New("No more credentials are approved")
	errCredsExternallyManaged          = errors.New("Credentials are externally managed and cannot be changed here")
	errNoSCRAMCredentials              = errors.New("SCRAM credentials are not initialized for this account; consult the user guide")
	errInvalidMultilineBatch           = errors.New("Invalid multiline batch")
	errTimedOut                        = errors.New("Operation timed out")
	errInvalidUtf8                     = errors.New("Message rejected for invalid utf8")
	errClientDestroyed                 = errors.New("Client was already destroyed")
	errTooManyChannels                 = errors.New("You have joined too many channels")
	errWrongChannelKey                 = errors.New("Cannot join password-protected channel without the password")
	errInviteOnly                      = errors.New("Cannot join invite-only channel without an invite")
	errRegisteredOnly                  = errors.New("Cannot join registered-only channel without an account")
	errValidEmailRequired              = errors.New("A valid e-mail address is required")
	errValidNostrIdentifierRequired    = errors.New("A valid nostr identifier is required")
	errUnsupportedCallbackNamespace    = errors.New("Unsupported callback namespace")
	errInvalidAccountRename            = errors.New("Account renames can only change the casefolding of the account name")
	errNameReserved                    = errors.New("Name reserved due to a prior registration")
	errInvalidBearerTokenType          = errors.New("invalid bearer token type")
)

// String Errors
var (
	errCouldNotStabilize = errors.New("Could not stabilize string while casefolding")
	errStringIsEmpty     = errors.New("String is empty")
	errInvalidCharacter  = errors.New("Invalid character")
)

type CertKeyError struct {
	Err error
}

func (ck *CertKeyError) Error() string {
	return fmt.Sprintf("Invalid TLS cert/key pair: %v", ck.Err)
}

type ThrottleError struct {
	time.Duration
}

func (te *ThrottleError) Error() string {
	return fmt.Sprintf(`Please wait at least %v and try again`, te.Duration.Round(time.Millisecond))
}