716fcfcf72
A lot of our code is repeatedly testing if individual errors are specific types of Not Exist errors. This is repetitative and unnecesary. `Unwrap() error` provides a common way of labelling an error as a NotExist error and we can/should use this. This PR has chosen to use the common `io/fs` errors e.g. `fs.ErrNotExist` for our errors. This is in some ways not completely correct as these are not filesystem errors but it seems like a reasonable thing to do and would allow us to simplify a lot of our code to `errors.Is(err, fs.ErrNotExist)` instead of `package.IsErr...NotExist(err)` I am open to suggestions to use a different base error - perhaps `models/db.ErrNotExist` if that would be felt to be better. Signed-off-by: Andrew Thornton <art27@cantab.net> Co-authored-by: delvh <dev.lh@web.de>
107 lines
2.9 KiB
Go
107 lines
2.9 KiB
Go
// Copyright 2021 The Gitea Authors. All rights reserved.
|
|
// Use of this source code is governed by a MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package db
|
|
|
|
import (
|
|
"fmt"
|
|
"regexp"
|
|
"strings"
|
|
"unicode/utf8"
|
|
|
|
"code.gitea.io/gitea/modules/util"
|
|
)
|
|
|
|
var (
|
|
// ErrNameEmpty name is empty error
|
|
ErrNameEmpty = util.SilentWrap{Message: "name is empty", Err: util.ErrInvalidArgument}
|
|
|
|
// AlphaDashDotPattern characters prohibited in a user name (anything except A-Za-z0-9_.-)
|
|
AlphaDashDotPattern = regexp.MustCompile(`[^\w-\.]`)
|
|
)
|
|
|
|
// ErrNameReserved represents a "reserved name" error.
|
|
type ErrNameReserved struct {
|
|
Name string
|
|
}
|
|
|
|
// IsErrNameReserved checks if an error is a ErrNameReserved.
|
|
func IsErrNameReserved(err error) bool {
|
|
_, ok := err.(ErrNameReserved)
|
|
return ok
|
|
}
|
|
|
|
func (err ErrNameReserved) Error() string {
|
|
return fmt.Sprintf("name is reserved [name: %s]", err.Name)
|
|
}
|
|
|
|
// Unwrap unwraps this as a ErrInvalid err
|
|
func (err ErrNameReserved) Unwrap() error {
|
|
return util.ErrInvalidArgument
|
|
}
|
|
|
|
// ErrNamePatternNotAllowed represents a "pattern not allowed" error.
|
|
type ErrNamePatternNotAllowed struct {
|
|
Pattern string
|
|
}
|
|
|
|
// IsErrNamePatternNotAllowed checks if an error is an ErrNamePatternNotAllowed.
|
|
func IsErrNamePatternNotAllowed(err error) bool {
|
|
_, ok := err.(ErrNamePatternNotAllowed)
|
|
return ok
|
|
}
|
|
|
|
func (err ErrNamePatternNotAllowed) Error() string {
|
|
return fmt.Sprintf("name pattern is not allowed [pattern: %s]", err.Pattern)
|
|
}
|
|
|
|
// Unwrap unwraps this as a ErrInvalid err
|
|
func (err ErrNamePatternNotAllowed) Unwrap() error {
|
|
return util.ErrInvalidArgument
|
|
}
|
|
|
|
// ErrNameCharsNotAllowed represents a "character not allowed in name" error.
|
|
type ErrNameCharsNotAllowed struct {
|
|
Name string
|
|
}
|
|
|
|
// IsErrNameCharsNotAllowed checks if an error is an ErrNameCharsNotAllowed.
|
|
func IsErrNameCharsNotAllowed(err error) bool {
|
|
_, ok := err.(ErrNameCharsNotAllowed)
|
|
return ok
|
|
}
|
|
|
|
func (err ErrNameCharsNotAllowed) Error() string {
|
|
return fmt.Sprintf("name is invalid [%s]: must be valid alpha or numeric or dash(-_) or dot characters", err.Name)
|
|
}
|
|
|
|
// Unwrap unwraps this as a ErrInvalid err
|
|
func (err ErrNameCharsNotAllowed) Unwrap() error {
|
|
return util.ErrInvalidArgument
|
|
}
|
|
|
|
// IsUsableName checks if name is reserved or pattern of name is not allowed
|
|
// based on given reserved names and patterns.
|
|
// Names are exact match, patterns can be prefix or suffix match with placeholder '*'.
|
|
func IsUsableName(names, patterns []string, name string) error {
|
|
name = strings.TrimSpace(strings.ToLower(name))
|
|
if utf8.RuneCountInString(name) == 0 {
|
|
return ErrNameEmpty
|
|
}
|
|
|
|
for i := range names {
|
|
if name == names[i] {
|
|
return ErrNameReserved{name}
|
|
}
|
|
}
|
|
|
|
for _, pat := range patterns {
|
|
if pat[0] == '*' && strings.HasSuffix(name, pat[1:]) ||
|
|
(pat[len(pat)-1] == '*' && strings.HasPrefix(name, pat[:len(pat)-1])) {
|
|
return ErrNamePatternNotAllowed{pat}
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|