mirror of
https://github.com/cloudreve/cloudreve.git
synced 2025-11-01 00:57:15 +08:00
463 lines
13 KiB
Go
463 lines
13 KiB
Go
package serializer
|
||
|
||
import (
|
||
"context"
|
||
"errors"
|
||
"fmt"
|
||
"strings"
|
||
|
||
"github.com/cloudreve/Cloudreve/v4/pkg/filemanager/lock"
|
||
"github.com/cloudreve/Cloudreve/v4/pkg/logging"
|
||
"github.com/gin-gonic/gin"
|
||
"github.com/samber/lo"
|
||
)
|
||
|
||
// AppError 应用错误，实现了error接口
|
||
type AppError struct {
|
||
Code int
|
||
Msg string
|
||
RawError error
|
||
}
|
||
|
||
// NewError 返回新的错误对象
|
||
func NewError(code int, msg string, err error) AppError {
|
||
return AppError{
|
||
Code: code,
|
||
Msg: msg,
|
||
RawError: err,
|
||
}
|
||
}
|
||
|
||
// NewErrorFromResponse 从 serializer.Response 构建错误
|
||
func NewErrorFromResponse(resp *Response) AppError {
|
||
return AppError{
|
||
Code: resp.Code,
|
||
Msg: resp.Msg,
|
||
RawError: errors.New(resp.Error),
|
||
}
|
||
}
|
||
|
||
// WithError 将应用error携带标准库中的error
|
||
func (err *AppError) WithError(raw error) AppError {
|
||
return AppError{
|
||
Code: err.Code,
|
||
Msg: err.Msg,
|
||
RawError: raw,
|
||
}
|
||
}
|
||
|
||
// Error 返回业务代码确定的可读错误信息
|
||
func (err AppError) Error() string {
|
||
if err.RawError != nil {
|
||
return fmt.Sprintf("%s: %s", err.Msg, err.RawError.Error())
|
||
}
|
||
return err.Msg
|
||
}
|
||
|
||
func (err AppError) ErrCode() int {
|
||
var inheritedErr AppError
|
||
if errors.As(err.RawError, &inheritedErr) {
|
||
return inheritedErr.ErrCode()
|
||
}
|
||
return err.Code
|
||
}
|
||
|
||
func (err AppError) Unwrap() error {
|
||
return err.RawError
|
||
}
|
||
|
||
// 三位数错误编码为复用http原本含义
|
||
// 五位数错误编码为应用自定义错误
|
||
// 五开头的五位数错误编码为服务器端错误，比如数据库操作失败
|
||
// 四开头的五位数错误编码为客户端错误，有时候是客户端代码写错了，有时候是用户操作错误
|
||
const (
|
||
// CodeNotFullySuccess 未完全成功
|
||
CodeNotFullySuccess = 203
|
||
// CodeCheckLogin 未登录
|
||
CodeCheckLogin = 401
|
||
// CodeNoPermissionErr 未授权访问
|
||
CodeNoPermissionErr = 403
|
||
// CodeNotFound 资源未找到
|
||
CodeNotFound = 404
|
||
// CodeConflict 资源冲突
|
||
CodeConflict = 409
|
||
// CodeUploadFailed 上传出错
|
||
CodeUploadFailed = 40002
|
||
// CodeCreateFolderFailed 目录创建失败
|
||
CodeCreateFolderFailed = 40003
|
||
// CodeObjectExist 对象已存在
|
||
CodeObjectExist = 40004
|
||
// CodeSignExpired 签名过期
|
||
CodeSignExpired = 40005
|
||
// CodePolicyNotAllowed 当前存储策略不允许
|
||
CodePolicyNotAllowed = 40006
|
||
// CodeGroupNotAllowed 用户组无法进行此操作
|
||
CodeGroupNotAllowed = 40007
|
||
// CodeAdminRequired 非管理用户组
|
||
CodeAdminRequired = 40008
|
||
// CodeMasterNotFound 主机节点未注册
|
||
CodeMasterNotFound = 40009
|
||
// CodeUploadSessionExpired 上传会话已过期
|
||
CodeUploadSessionExpired = 40011
|
||
// CodeInvalidChunkIndex 无效的分片序号
|
||
CodeInvalidChunkIndex = 40012
|
||
// CodeInvalidContentLength 无效的正文长度
|
||
CodeInvalidContentLength = 40013
|
||
// CodePhoneRequired 未绑定手机
|
||
CodePhoneRequired = 40010
|
||
// CodeBatchSourceSize 超出批量获取外链限制
|
||
CodeBatchSourceSize = 40014
|
||
// CodeBatchAria2Size 超出最大 Aria2 任务数量限制
|
||
CodeBatchAria2Size = 40015
|
||
// CodeParentNotExist 父目录不存在
|
||
CodeParentNotExist = 40016
|
||
// CodeUserBaned 用户不活跃
|
||
CodeUserBaned = 40017
|
||
// CodeUserNotActivated 用户不活跃
|
||
CodeUserNotActivated = 40018
|
||
// CodeFeatureNotEnabled 此功能未开启
|
||
CodeFeatureNotEnabled = 40019
|
||
// CodeCredentialInvalid 凭证无效
|
||
CodeCredentialInvalid = 40020
|
||
// CodeUserNotFound 用户不存在
|
||
CodeUserNotFound = 40021
|
||
// Code2FACodeErr 二步验证代码错误
|
||
Code2FACodeErr = 40022
|
||
// CodeLoginSessionNotExist 登录会话不存在
|
||
CodeLoginSessionNotExist = 40023
|
||
// CodeInitializeAuthn 无法初始化 WebAuthn
|
||
CodeInitializeAuthn = 40024
|
||
// CodeWebAuthnCredentialError WebAuthn 凭证无效
|
||
CodeWebAuthnCredentialError = 40025
|
||
// CodeCaptchaError 验证码错误
|
||
CodeCaptchaError = 40026
|
||
// CodeCaptchaRefreshNeeded 验证码需要刷新
|
||
CodeCaptchaRefreshNeeded = 40027
|
||
// CodeFailedSendEmail 邮件发送失败
|
||
CodeFailedSendEmail = 40028
|
||
// CodeInvalidTempLink 临时链接无效
|
||
CodeInvalidTempLink = 40029
|
||
// CodeTempLinkExpired 临时链接过期
|
||
CodeTempLinkExpired = 40030
|
||
// CodeEmailProviderBaned 邮箱后缀被禁用
|
||
CodeEmailProviderBaned = 40031
|
||
// CodeEmailExisted 邮箱已被使用
|
||
CodeEmailExisted = 40032
|
||
// CodeEmailSent 邮箱已重新发送
|
||
CodeEmailSent = 40033
|
||
// CodeUserCannotActivate 用户无法激活
|
||
CodeUserCannotActivate = 40034
|
||
// 存储策略不存在
|
||
CodePolicyNotExist = 40035
|
||
// 无法删除默认存储策略
|
||
CodeDeleteDefaultPolicy = 40036
|
||
// 存储策略下还有文件
|
||
CodePolicyUsedByFiles = 40037
|
||
// 存储策略绑定了用户组
|
||
CodePolicyUsedByGroups = 40038
|
||
// 用户组不存在
|
||
CodeGroupNotFound = 40039
|
||
// 对系统用户组执行非法操作
|
||
CodeInvalidActionOnSystemGroup = 40040
|
||
// 用户组正在被使用
|
||
CodeGroupUsedByUser = 40041
|
||
// 为初始用户更改用户组
|
||
CodeChangeGroupForDefaultUser = 40042
|
||
// 对系统用户执行非法操作
|
||
CodeInvalidActionOnDefaultUser = 40043
|
||
// 文件不存在
|
||
CodeFileNotFound = 40044
|
||
// 列取文件失败
|
||
CodeListFilesError = 40045
|
||
// 对系统节点进行非法操作
|
||
CodeInvalidActionOnSystemNode = 40046
|
||
// 创建文件系统出错
|
||
CodeCreateFSError = 40047
|
||
// 创建任务出错
|
||
CodeCreateTaskError = 40048
|
||
// 文件尺寸太大
|
||
CodeFileTooLarge = 40049
|
||
// 文件类型不允许
|
||
CodeFileTypeNotAllowed = 40050
|
||
// 用户容量不足
|
||
CodeInsufficientCapacity = 40051
|
||
// 对象名非法
|
||
CodeIllegalObjectName = 40052
|
||
// 不支持对根目录执行此操作
|
||
CodeRootProtected = 40053
|
||
// 当前目录下已经有同名文件正在上传中
|
||
CodeConflictUploadOngoing = 40054
|
||
// 文件信息不一致
|
||
CodeMetaMismatch = 40055
|
||
// 不支持该格式的压缩文件
|
||
CodeUnsupportedArchiveType = 40056
|
||
// 可用存储策略发生变化
|
||
CodePolicyChanged = 40057
|
||
// 分享链接无效
|
||
CodeShareLinkNotFound = 40058
|
||
// 不能转存自己的分享
|
||
CodeSaveOwnShare = 40059
|
||
// 从机无法向主机发送回调请求
|
||
CodeSlavePingMaster = 40060
|
||
// Cloudreve 版本不一致
|
||
CodeVersionMismatch = 40061
|
||
// 积分不足
|
||
CodeInsufficientCredit = 40062
|
||
// 用户组冲突
|
||
CodeGroupConflict = 40063
|
||
// 当前已处于此用户组中
|
||
CodeGroupInvalid = 40064
|
||
// 兑换码无效
|
||
CodeInvalidGiftCode = 40065
|
||
// 已绑定了对应账号
|
||
CodeOpenIDBindConflict = 40066
|
||
// 对应账号已被绑定其他账号
|
||
CodeOpenIDBindOtherAccount = 40067
|
||
// 未绑定对应账号
|
||
CodeOpenIDNotLinked = 40068
|
||
// 密码不正确
|
||
CodeIncorrectPassword = 40069
|
||
// 分享无法预览
|
||
CodeDisabledSharePreview = 40070
|
||
// 签名无效
|
||
CodeInvalidSign = 40071
|
||
// 管理员无法购买用户组
|
||
CodeFulfillAdminGroup = 40072
|
||
// Lock confliced
|
||
CodeLockConflict = 40073
|
||
// Too many uris
|
||
CodeTooManyUris = 40074
|
||
// Lock token expired
|
||
CodeLockExpired = 40075
|
||
// Current updated version is stale
|
||
CodeStaleVersion = 40076
|
||
// CodeEntityNotExist Entity not exist
|
||
CodeEntityNotExist = 40077
|
||
// CodeFileDeleted File is deleted in recycle bin
|
||
CodeFileDeleted = 40078
|
||
// CodeFileCountLimitedReached file count limited reached
|
||
CodeFileCountLimitedReached = 40079
|
||
// CodeInvalidPassword invalid password
|
||
CodeInvalidPassword = 40080
|
||
// CodeBatchOperationNotFullyCompleted batch operation not fully completed
|
||
CodeBatchOperationNotFullyCompleted = 40081
|
||
// CodeOwnerOnly owner operation only
|
||
CodeOwnerOnly = 40082
|
||
// CodePurchaseRequired purchase required
|
||
CodePurchaseRequired = 40083
|
||
// CodeManagedAccountMinimumOpenID managed account minimum openid
|
||
CodeManagedAccountMinimumOpenID = 40084
|
||
// CodeAmountTooSmall amount too small
|
||
CodeAmountTooSmall = 40085
|
||
// CodeNodeUsedByStoragePolicy node used by storage policy
|
||
CodeNodeUsedByStoragePolicy = 40086
|
||
// CodeDomainNotLicensed domain not licensed
|
||
CodeDomainNotLicensed = 40087
|
||
// CodeDBError 数据库操作失败
|
||
CodeDBError = 50001
|
||
// CodeEncryptError 加密失败
|
||
CodeEncryptError = 50002
|
||
// CodeIOFailed IO操作失败
|
||
CodeIOFailed = 50004
|
||
// CodeInternalSetting 内部设置参数错误
|
||
CodeInternalSetting = 50005
|
||
// CodeCacheOperation 缓存操作失败
|
||
CodeCacheOperation = 50006
|
||
// CodeCallbackError 回调失败
|
||
CodeCallbackError = 50007
|
||
// 后台设置更新失败
|
||
CodeUpdateSetting = 50008
|
||
// 跨域策略添加失败
|
||
CodeAddCORS = 50009
|
||
// 节点不可用
|
||
CodeNodeOffline = 50010
|
||
// 文件元信息查询失败
|
||
CodeQueryMetaFailed = 50011
|
||
//CodeParamErr 各种奇奇怪怪的参数错误
|
||
CodeParamErr = 40001
|
||
// CodeNotSet 未定错误，后续尝试从error中获取
|
||
CodeNotSet = -1
|
||
)
|
||
|
||
// DBErrDeprecated 数据库操作失败
|
||
func DBErr(c context.Context, msg string, err error) Response {
|
||
if msg == "" {
|
||
msg = "Database operation failed."
|
||
}
|
||
return ErrWithDetails(c, CodeDBError, msg, err)
|
||
}
|
||
|
||
// DBErrDeprecated 数据库操作失败
|
||
func DBErrDeprecated(msg string, err error) Response {
|
||
if msg == "" {
|
||
msg = "Database operation failed."
|
||
}
|
||
return ErrDeprecated(CodeDBError, msg, err)
|
||
}
|
||
|
||
// ParamErr 各种参数错误
|
||
func ParamErr(c context.Context, msg string, err error) Response {
|
||
if msg == "" {
|
||
msg = "Invalid parameters."
|
||
}
|
||
return ErrWithDetails(c, CodeParamErr, msg, err)
|
||
}
|
||
|
||
// ParamErrDeprecated 各种参数错误
|
||
// Deprecated
|
||
func ParamErrDeprecated(msg string, err error) Response {
|
||
if msg == "" {
|
||
msg = "Invalid parameters."
|
||
}
|
||
return ErrDeprecated(CodeParamErr, msg, err)
|
||
}
|
||
|
||
// ErrDeprecated 通用错误处理
|
||
func ErrDeprecated(errCode int, msg string, err error) Response {
|
||
// 底层错误是AppError，则尝试从AppError中获取详细信息
|
||
var appError AppError
|
||
if errors.As(err, &appError) {
|
||
errCode = appError.Code
|
||
err = appError.RawError
|
||
msg = appError.Msg
|
||
}
|
||
|
||
res := Response{
|
||
Code: errCode,
|
||
Msg: msg,
|
||
}
|
||
// 生产环境隐藏底层报错
|
||
if err != nil && gin.Mode() != gin.ReleaseMode {
|
||
res.Error = err.Error()
|
||
}
|
||
return res
|
||
}
|
||
|
||
// ErrWithDetails 通用错误处理
|
||
func ErrWithDetails(c context.Context, errCode int, msg string, err error) Response {
|
||
res := Response{
|
||
Code: errCode,
|
||
Msg: msg,
|
||
CorrelationID: logging.CorrelationID(c).String(),
|
||
}
|
||
|
||
// 底层错误是AppError，则尝试从AppError中获取详细信息
|
||
var appError AppError
|
||
if errors.As(err, &appError) {
|
||
res.Code = appError.ErrCode()
|
||
err = appError.RawError
|
||
res.Msg = appError.Msg
|
||
|
||
// Special case for error with detail data
|
||
switch res.Code {
|
||
case CodeLockConflict:
|
||
var lockConflict lock.ConflictError
|
||
if errors.As(err, &lockConflict) {
|
||
res.Data = lockConflict
|
||
}
|
||
case CodeBatchOperationNotFullyCompleted:
|
||
var errs *AggregateError
|
||
if errors.As(err, &errs) {
|
||
res.AggregatedError = errs.Expand(c)
|
||
}
|
||
}
|
||
}
|
||
|
||
// 生产环境隐藏底层报错
|
||
if err != nil && gin.Mode() != gin.ReleaseMode {
|
||
res.Error = err.Error()
|
||
}
|
||
|
||
return res
|
||
}
|
||
|
||
// Err Builds error response without addition details, code and message will
|
||
// be retrieved from error if possible
|
||
func Err(c context.Context, err error) Response {
|
||
return ErrWithDetails(c, CodeNotSet, "", err)
|
||
}
|
||
|
||
// AggregateError is a special error type that contains multiple errors
|
||
type AggregateError struct {
|
||
errs map[string]error
|
||
}
|
||
|
||
// NewAggregateError creates a new AggregateError
|
||
func NewAggregateError() *AggregateError {
|
||
return &AggregateError{
|
||
errs: make(map[string]error, 0),
|
||
}
|
||
}
|
||
|
||
func (e *AggregateError) Error() string {
|
||
return fmt.Sprintf("aggregate error: one or more operation failed")
|
||
}
|
||
|
||
// Add adds an error to the aggregate
|
||
func (e *AggregateError) Add(id string, err error) {
|
||
e.errs[id] = err
|
||
}
|
||
|
||
// Merge merges another aggregate error into this one
|
||
func (e *AggregateError) Merge(err error) bool {
|
||
var errs *AggregateError
|
||
if errors.As(err, &errs) {
|
||
for id, err := range errs.errs {
|
||
e.errs[id] = err
|
||
}
|
||
|
||
return true
|
||
}
|
||
return false
|
||
}
|
||
|
||
// Raw returns the raw error map
|
||
func (e *AggregateError) Raw() map[string]error {
|
||
return e.errs
|
||
}
|
||
|
||
func (e *AggregateError) Remove(id string) {
|
||
delete(e.errs, id)
|
||
}
|
||
|
||
// Expand expands the aggregate error into a list of responses
|
||
func (e *AggregateError) Expand(ctx context.Context) map[string]Response {
|
||
return lo.MapEntries(e.errs, func(id string, err error) (string, Response) {
|
||
return id, Err(ctx, err)
|
||
})
|
||
}
|
||
|
||
// Aggregate aggregates the error and returns nil if there is no error;
|
||
// otherwise returns the error itself
|
||
func (e *AggregateError) Aggregate() error {
|
||
if len(e.errs) == 0 {
|
||
return nil
|
||
}
|
||
|
||
msg := "One or more operation failed"
|
||
if len(e.errs) == 1 {
|
||
for _, err := range e.errs {
|
||
msg = err.Error()
|
||
}
|
||
}
|
||
|
||
return NewError(CodeBatchOperationNotFullyCompleted, msg, e)
|
||
}
|
||
|
||
func (e *AggregateError) FormatFirstN(n int) string {
|
||
if len(e.errs) == 0 {
|
||
return ""
|
||
}
|
||
|
||
res := make([]string, 0, n)
|
||
for id, err := range e.errs {
|
||
res = append(res, fmt.Sprintf("%s: %s", id, err.Error()))
|
||
if len(res) >= n {
|
||
break
|
||
}
|
||
}
|
||
|
||
return strings.Join(res, ", ")
|
||
|
||
}
|