mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-05-15 10:32:40 +00:00
dd30d9d5c0
The function `GetByBean` has an obvious defect that when the fields are
empty values, it will be ignored. Then users will get a wrong result
which is possibly used to make a security problem.
To avoid the possibility, this PR removed function `GetByBean` and all
references.
And some new generic functions have been introduced to be used.
The recommand usage like below.
```go
// if query an object according id
obj, err := db.GetByID[Object](ctx, id)
// query with other conditions
obj, err := db.Get[Object](ctx, builder.Eq{"a": a, "b":b})
```
93 lines
2 KiB
Go
93 lines
2 KiB
Go
// Copyright 2021 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package db
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"code.gitea.io/gitea/modules/util"
|
|
)
|
|
|
|
// ErrCancelled represents an error due to context cancellation
|
|
type ErrCancelled struct {
|
|
Message string
|
|
}
|
|
|
|
// IsErrCancelled checks if an error is a ErrCancelled.
|
|
func IsErrCancelled(err error) bool {
|
|
_, ok := err.(ErrCancelled)
|
|
return ok
|
|
}
|
|
|
|
func (err ErrCancelled) Error() string {
|
|
return "Cancelled: " + err.Message
|
|
}
|
|
|
|
// ErrCancelledf returns an ErrCancelled for the provided format and args
|
|
func ErrCancelledf(format string, args ...any) error {
|
|
return ErrCancelled{
|
|
fmt.Sprintf(format, args...),
|
|
}
|
|
}
|
|
|
|
// ErrSSHDisabled represents an "SSH disabled" error.
|
|
type ErrSSHDisabled struct{}
|
|
|
|
// IsErrSSHDisabled checks if an error is a ErrSSHDisabled.
|
|
func IsErrSSHDisabled(err error) bool {
|
|
_, ok := err.(ErrSSHDisabled)
|
|
return ok
|
|
}
|
|
|
|
func (err ErrSSHDisabled) Error() string {
|
|
return "SSH is disabled"
|
|
}
|
|
|
|
// ErrNotExist represents a non-exist error.
|
|
type ErrNotExist struct {
|
|
Resource string
|
|
ID int64
|
|
}
|
|
|
|
// IsErrNotExist checks if an error is an ErrNotExist
|
|
func IsErrNotExist(err error) bool {
|
|
_, ok := err.(ErrNotExist)
|
|
return ok
|
|
}
|
|
|
|
func (err ErrNotExist) Error() string {
|
|
name := "record"
|
|
if err.Resource != "" {
|
|
name = err.Resource
|
|
}
|
|
|
|
if err.ID != 0 {
|
|
return fmt.Sprintf("%s does not exist [id: %d]", name, err.ID)
|
|
}
|
|
return fmt.Sprintf("%s does not exist", name)
|
|
}
|
|
|
|
// Unwrap unwraps this as a ErrNotExist err
|
|
func (err ErrNotExist) Unwrap() error {
|
|
return util.ErrNotExist
|
|
}
|
|
|
|
// ErrConditionRequired represents an error which require condition.
|
|
type ErrConditionRequired struct{}
|
|
|
|
// IsErrConditionRequired checks if an error is an ErrConditionRequired
|
|
func IsErrConditionRequired(err error) bool {
|
|
_, ok := err.(ErrConditionRequired)
|
|
return ok
|
|
}
|
|
|
|
func (err ErrConditionRequired) Error() string {
|
|
return "condition is required"
|
|
}
|
|
|
|
// Unwrap unwraps this as a ErrNotExist err
|
|
func (err ErrConditionRequired) Unwrap() error {
|
|
return util.ErrInvalidArgument
|
|
}
|