Files
cgrates/utils/errors.go
2023-05-18 19:27:43 +02:00

275 lines
10 KiB
Go

/*
Real-time Online/Offline Charging System (OCS) for Telecom & ISP environments
Copyright (C) ITsysCOM GmbH
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>
*/
package utils
import (
"errors"
"fmt"
"strings"
)
var (
ErrNoMoreData = errors.New("NO_MORE_DATA")
ErrNotImplemented = errors.New("NOT_IMPLEMENTED")
ErrNotFound = errors.New("NOT_FOUND")
ErrDSPHostNotFound = errors.New("DSP_HOST_NOT_FOUND")
ErrDSPProfileNotFound = errors.New("DSP_PROFILE_NOT_FOUND")
ErrTimedOut = errors.New("TIMED_OUT")
ErrServerError = errors.New("SERVER_ERROR")
ErrMaxRecursionDepth = errors.New("MAX_RECURSION_DEPTH")
ErrMandatoryIeMissing = errors.New("MANDATORY_IE_MISSING")
ErrExists = errors.New("EXISTS")
ErrBrokenReference = errors.New("BROKEN_REFERENCE")
ErrParserError = errors.New("PARSER_ERROR")
ErrInvalidPath = errors.New("INVALID_PATH")
ErrInvalidKey = errors.New("INVALID_KEY")
ErrUnauthorizedDestination = errors.New("UNAUTHORIZED_DESTINATION")
ErrRatingPlanNotFound = errors.New("RATING_PLAN_NOT_FOUND")
ErrAccountNotFound = errors.New("ACCOUNT_NOT_FOUND")
ErrAccountDisabled = errors.New("ACCOUNT_DISABLED")
ErrInsufficientCredit = errors.New("INSUFFICIENT_CREDIT")
ErrNotConvertible = errors.New("NOT_CONVERTIBLE")
ErrResourceUnavailable = errors.New("RESOURCE_UNAVAILABLE")
ErrResourceUnauthorized = errors.New("RESOURCE_UNAUTHORIZED")
ErrNoActiveSession = errors.New("NO_ACTIVE_SESSION")
ErrPartiallyExecuted = errors.New("PARTIALLY_EXECUTED")
ErrMaxUsageExceeded = errors.New("MAX_USAGE_EXCEEDED")
ErrMaxCostExceeded = errors.New("MAX_COST_EXCEEDED")
ErrFilterNotPassingNoCaps = errors.New("filter not passing")
ErrNotConvertibleNoCaps = errors.New("not convertible")
ErrMandatoryIeMissingNoCaps = errors.New("mandatory information missing")
ErrUnauthorizedApi = errors.New("UNAUTHORIZED_API")
ErrUnknownApiKey = errors.New("UNKNOWN_API_KEY")
ErrReqUnsynchronized = errors.New("REQ_UNSYNCHRONIZED")
ErrUnsupporteServiceMethod = errors.New("UNSUPPORTED_SERVICE_METHOD")
ErrDisconnected = errors.New("DISCONNECTED")
ErrReplyTimeout = errors.New("REPLY_TIMEOUT")
ErrSessionNotFound = errors.New("SESSION_NOT_FOUND")
ErrJsonIncompleteComment = errors.New("JSON_INCOMPLETE_COMMENT")
ErrNotEnoughParameters = errors.New("NotEnoughParameters")
ErrNotConnected = errors.New("NOT_CONNECTED")
RalsErrorPrfx = "RALS_ERROR"
DispatcherErrorPrefix = "DISPATCHER_ERROR"
RateSErrPrfx = "RATES_ERROR"
ErrUnsupportedFormat = errors.New("UNSUPPORTED_FORMAT")
ErrNoDatabaseConn = errors.New("NO_DATABASE_CONNECTION")
ErrMaxIncrementsExceeded = errors.New("MAX_INCREMENTS_EXCEEDED")
ErrUncomputableIncrement = errors.New("UNCOMPUTABLE_INCREMENT")
ErrIndexOutOfBounds = errors.New("INDEX_OUT_OF_BOUNDS")
ErrWrongPath = errors.New("WRONG_PATH")
ErrServiceAlreadyRunning = fmt.Errorf("service already running")
ErrMaxConcurrentRPCExceededNoCaps = errors.New("max concurrent rpc exceeded") // on internal we return this error for concureq
ErrMaxConcurrentRPCExceeded = errors.New("MAX_CONCURRENT_RPC_EXCEEDED") // but the codec will rewrite it with this one to be sure that we corectly dealocate the request
ErrMaxIterationsReached = errors.New("maximum iterations reached")
ErrNegative = errors.New("NEGATIVE")
ErrCastFailed = errors.New("CAST_FAILED")
ErrMap = map[string]error{
ErrNoMoreData.Error(): ErrNoMoreData,
ErrNotImplemented.Error(): ErrNotImplemented,
ErrDSPProfileNotFound.Error(): ErrDSPProfileNotFound,
ErrDSPHostNotFound.Error(): ErrDSPHostNotFound,
ErrNotFound.Error(): ErrNotFound,
ErrTimedOut.Error(): ErrTimedOut,
ErrServerError.Error(): ErrServerError,
ErrMaxRecursionDepth.Error(): ErrMaxRecursionDepth,
ErrExists.Error(): ErrExists,
ErrBrokenReference.Error(): ErrBrokenReference,
ErrParserError.Error(): ErrParserError,
ErrInvalidPath.Error(): ErrInvalidPath,
ErrInvalidKey.Error(): ErrInvalidKey,
ErrUnauthorizedDestination.Error(): ErrUnauthorizedDestination,
ErrRatingPlanNotFound.Error(): ErrRatingPlanNotFound,
ErrInsufficientCredit.Error(): ErrInsufficientCredit,
ErrNotConvertible.Error(): ErrNotConvertible,
ErrResourceUnavailable.Error(): ErrResourceUnavailable,
ErrResourceUnauthorized.Error(): ErrResourceUnauthorized,
ErrNoActiveSession.Error(): ErrNoActiveSession,
ErrPartiallyExecuted.Error(): ErrPartiallyExecuted,
ErrMaxUsageExceeded.Error(): ErrMaxUsageExceeded,
ErrFilterNotPassingNoCaps.Error(): ErrFilterNotPassingNoCaps,
ErrNotConvertibleNoCaps.Error(): ErrNotConvertibleNoCaps,
ErrUnauthorizedApi.Error(): ErrUnauthorizedApi,
ErrUnknownApiKey.Error(): ErrUnknownApiKey,
ErrReqUnsynchronized.Error(): ErrReqUnsynchronized,
ErrUnsupporteServiceMethod.Error(): ErrUnsupporteServiceMethod,
ErrDisconnected.Error(): ErrDisconnected,
ErrReplyTimeout.Error(): ErrReplyTimeout,
ErrSessionNotFound.Error(): ErrSessionNotFound,
ErrJsonIncompleteComment.Error(): ErrJsonIncompleteComment,
ErrNotEnoughParameters.Error(): ErrNotEnoughParameters,
ErrUnsupportedFormat.Error(): ErrUnsupportedFormat,
ErrNoDatabaseConn.Error(): ErrNoDatabaseConn,
ErrMaxIncrementsExceeded.Error(): ErrMaxIncrementsExceeded,
ErrIndexOutOfBounds.Error(): ErrIndexOutOfBounds,
ErrWrongPath.Error(): ErrWrongPath,
ErrDSPHostNotFound.Error(): ErrDSPHostNotFound,
}
)
// NewCGRError initialises a new CGRError
func NewCGRError(context, apiErr, shortErr, longErr string) *CGRError {
return &CGRError{context: context, apiError: apiErr,
shortError: shortErr, longError: longErr, errorMessage: shortErr}
}
// CGRError is a context based error
// returns always errorMessage but this can be switched based on methods called on it
type CGRError struct {
context string
apiError string
shortError string
longError string
errorMessage string
}
func (err *CGRError) Context() string {
return err.context
}
func (err *CGRError) Error() string {
return err.errorMessage
}
func (err *CGRError) ActivateAPIError() {
err.errorMessage = err.apiError
}
func (err *CGRError) ActivateShortError() {
err.errorMessage = err.shortError
}
func (err *CGRError) ActivateLongError() {
err.errorMessage = err.longError
}
func NewErrMandatoryIeMissing(fields ...string) error {
return fmt.Errorf("MANDATORY_IE_MISSING: %v", fields)
}
func NewErrServerError(err error) error {
return fmt.Errorf("SERVER_ERROR: %s", err)
}
func NewErrServiceNotOperational(serv string) error {
return fmt.Errorf("SERVICE_NOT_OPERATIONAL: %s", serv)
}
func NewErrNotConnected(serv string) error {
return fmt.Errorf("NOT_CONNECTED: %s", serv)
}
func NewErrRALs(err error) error {
return fmt.Errorf("%s:%s", RalsErrorPrfx, err)
}
func NewErrResourceS(err error) error {
return fmt.Errorf("RESOURCES_ERROR:%s", err)
}
func NewErrRouteS(err error) error {
return fmt.Errorf("ROUTES_ERROR:%s", err)
}
func NewErrAttributeS(err error) error {
return fmt.Errorf("ATTRIBUTES_ERROR:%s", err)
}
func NewErrChargerS(err error) error {
return fmt.Errorf("CHARGERS_ERROR:%s", err)
}
func NewErrStatS(err error) error {
return fmt.Errorf("STATS_ERROR:%s", err)
}
func NewErrCDRS(err error) error {
return fmt.Errorf("CDRS_ERROR:%s", err)
}
func NewErrThresholdS(err error) error {
return fmt.Errorf("THRESHOLDS_ERROR:%s", err)
}
func NewErrDispatcherS(err error) error {
return fmt.Errorf("%s:%s", DispatcherErrorPrefix, err.Error())
}
func NewErrRateS(err error) error {
return fmt.Errorf("%s:%s", RateSErrPrfx, err.Error())
}
// Centralized returns for APIs
func APIErrorHandler(errIn error) (err error) {
cgrErr, ok := errIn.(*CGRError)
if !ok {
err = errIn
if err != ErrNotFound && err != ErrDSPProfileNotFound && err != ErrDSPHostNotFound {
err = NewErrServerError(err)
}
return
}
cgrErr.ActivateAPIError()
return cgrErr
}
func NewErrStringCast(valIface interface{}) error {
return fmt.Errorf("cannot cast value: %v to string", valIface)
}
func NewErrFldStringCast(fldName string, valIface interface{}) error {
return fmt.Errorf("cannot cast field: %s with value: %v to string", fldName, valIface)
}
func ErrHasPrefix(err error, prfx string) (has bool) {
if err == nil {
return
}
return strings.HasPrefix(err.Error(), prfx)
}
func ErrPrefix(err error, reason string) error {
return fmt.Errorf("%s:%s", err.Error(), reason)
}
func ErrPrefixNotFound(reason string) error {
return ErrPrefix(ErrNotFound, reason)
}
func ErrPrefixNotErrNotImplemented(reason string) error {
return ErrPrefix(ErrNotImplemented, reason)
}
func ErrEnvNotFound(key string) error {
return ErrPrefix(ErrNotFound, "ENV_VAR:"+key)
}
func ErrPathNotReachable(path string) error {
return fmt.Errorf("path:%+q is not reachable", path)
}
func ErrNotConvertibleTF(from, to string) error {
return fmt.Errorf("%s : from: %s to:%s", ErrNotConvertibleNoCaps.Error(), from, to)
}
// NewSTIRError returns a error with a *stir_authorize prefix
func NewSTIRError(reason string) error {
return fmt.Errorf("%s: %s", MetaSTIRAuthenticate, reason)
}