mirror of
				https://github.com/go-gitea/gitea
				synced 2025-10-31 03:18:24 +00:00 
			
		
		
		
	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>
		
			
				
	
	
		
			103 lines
		
	
	
		
			2.5 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			103 lines
		
	
	
		
			2.5 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 user
 | |
| 
 | |
| import (
 | |
| 	"fmt"
 | |
| 
 | |
| 	"code.gitea.io/gitea/modules/util"
 | |
| )
 | |
| 
 | |
| //  ____ ___
 | |
| // |    |   \______ ___________
 | |
| // |    |   /  ___// __ \_  __ \
 | |
| // |    |  /\___ \\  ___/|  | \/
 | |
| // |______//____  >\___  >__|
 | |
| //              \/     \/
 | |
| 
 | |
| // ErrUserAlreadyExist represents a "user already exists" error.
 | |
| type ErrUserAlreadyExist struct {
 | |
| 	Name string
 | |
| }
 | |
| 
 | |
| // IsErrUserAlreadyExist checks if an error is a ErrUserAlreadyExists.
 | |
| func IsErrUserAlreadyExist(err error) bool {
 | |
| 	_, ok := err.(ErrUserAlreadyExist)
 | |
| 	return ok
 | |
| }
 | |
| 
 | |
| func (err ErrUserAlreadyExist) Error() string {
 | |
| 	return fmt.Sprintf("user already exists [name: %s]", err.Name)
 | |
| }
 | |
| 
 | |
| // Unwrap unwraps this error as a ErrExist error
 | |
| func (err ErrUserAlreadyExist) Unwrap() error {
 | |
| 	return util.ErrAlreadyExist
 | |
| }
 | |
| 
 | |
| // ErrUserNotExist represents a "UserNotExist" kind of error.
 | |
| type ErrUserNotExist struct {
 | |
| 	UID   int64
 | |
| 	Name  string
 | |
| 	KeyID int64
 | |
| }
 | |
| 
 | |
| // IsErrUserNotExist checks if an error is a ErrUserNotExist.
 | |
| func IsErrUserNotExist(err error) bool {
 | |
| 	_, ok := err.(ErrUserNotExist)
 | |
| 	return ok
 | |
| }
 | |
| 
 | |
| func (err ErrUserNotExist) Error() string {
 | |
| 	return fmt.Sprintf("user does not exist [uid: %d, name: %s, keyid: %d]", err.UID, err.Name, err.KeyID)
 | |
| }
 | |
| 
 | |
| // Unwrap unwraps this error as a ErrNotExist error
 | |
| func (err ErrUserNotExist) Unwrap() error {
 | |
| 	return util.ErrNotExist
 | |
| }
 | |
| 
 | |
| // ErrUserProhibitLogin represents a "ErrUserProhibitLogin" kind of error.
 | |
| type ErrUserProhibitLogin struct {
 | |
| 	UID  int64
 | |
| 	Name string
 | |
| }
 | |
| 
 | |
| // IsErrUserProhibitLogin checks if an error is a ErrUserProhibitLogin
 | |
| func IsErrUserProhibitLogin(err error) bool {
 | |
| 	_, ok := err.(ErrUserProhibitLogin)
 | |
| 	return ok
 | |
| }
 | |
| 
 | |
| func (err ErrUserProhibitLogin) Error() string {
 | |
| 	return fmt.Sprintf("user is not allowed login [uid: %d, name: %s]", err.UID, err.Name)
 | |
| }
 | |
| 
 | |
| // Unwrap unwraps this error as a ErrPermission error
 | |
| func (err ErrUserProhibitLogin) Unwrap() error {
 | |
| 	return util.ErrPermissionDenied
 | |
| }
 | |
| 
 | |
| // ErrUserInactive represents a "ErrUserInactive" kind of error.
 | |
| type ErrUserInactive struct {
 | |
| 	UID  int64
 | |
| 	Name string
 | |
| }
 | |
| 
 | |
| // IsErrUserInactive checks if an error is a ErrUserInactive
 | |
| func IsErrUserInactive(err error) bool {
 | |
| 	_, ok := err.(ErrUserInactive)
 | |
| 	return ok
 | |
| }
 | |
| 
 | |
| func (err ErrUserInactive) Error() string {
 | |
| 	return fmt.Sprintf("user is inactive [uid: %d, name: %s]", err.UID, err.Name)
 | |
| }
 | |
| 
 | |
| // Unwrap unwraps this error as a ErrPermission error
 | |
| func (err ErrUserInactive) Unwrap() error {
 | |
| 	return util.ErrPermissionDenied
 | |
| }
 |