gitea/models/user/user_system.go

// Copyright 2022 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT

package user

import (
	"strings"

	"code.gitea.io/gitea/modules/structs"
)

// NewGhostUser creates and returns a fake user for someone has deleted their account.
func NewGhostUser() *User {
	return &User{
		ID:        -1,
		Name:      "Ghost",
		LowerName: "ghost",
	}
}

// IsGhost check if user is fake user for a deleted account
func (u *User) IsGhost() bool {
	if u == nil {
		return false
	}
	return u.ID == -1 && u.Name == "Ghost"
}

// NewReplaceUser creates and returns a fake user for external user
func NewReplaceUser(name string) *User {
	return &User{
		ID:        -1,
		Name:      name,
		LowerName: strings.ToLower(name),
	}
}

const (
	BotUserID   = -2
	BotUserName = "[robot]gitea-bots"
)

// NewBotUser creates and returns a fake user for running the build.
func NewBotUser() *User {
	return &User{
		ID:                      BotUserID,
		Name:                    "[robot]gitea-bots",
		LowerName:               "[robot]gitea-bots",
		IsActive:                true,
		FullName:                "Gitea Bots",
		Email:                   "teabot@gitea.io",
		KeepEmailPrivate:        true,
		LoginName:               "[robot]gitea-bots",
		Type:                    UserTypeIndividual,
		AllowCreateOrganization: true,
		Visibility:              structs.VisibleTypePublic,
	}
}

func (u *User) IsBots() bool {
	if u == nil {
		return false
	}
	return u.ID == BotUserID && u.Name == BotUserName
}