rbac

type AuthDTO struct {
	BaseDTO

	// 采用的验证机制
	Mechanism string `json:"mechanism"`

	// 最终要执行的动作,
	// 例如: login(登录), sign_up(注册), reset_password(重置密码), 等
	Action string `json:"action"`

	// 表示验证的步骤
	Step string `json:"step"`

	// 将要验证的账号,
	// 它可能是 UserName | UserID | UserEmail | UserPhone | ...
	Account string `json:"account"`

	// 将要验证的机密内容, 例如：密码, 等...
	Secret lang.Base64 `json:"secret"`

	// 其它扩展属性
	Parameters map[string]string `json:"parameters"`
}

type AuthResult struct {

	// 有效期:
	Term

	Mechanism  string `json:"mechanism"` // 采用的认证机制
	UserID     UserID `json:"uid"`       // 被认证的用户ID
	DomainName string `json:"domain"`    // 认证针对的域名
	OK         string `json:"ok"`        // 是否认证成功

}

type AuthService interface {
	Handle(c context.Context, action string, a []*AuthDTO) ([]*AuthDTO, error)
}

type AuthVO struct {
	BaseVO

	Auth []*AuthDTO `json:"auth"` // 用于验证的信息
}

type AvatarDTO struct {
	ID AvatarID `json:"id"`

	BaseDTO

	Label string `json:"label"`
	Name  string `json:"name"`
	URL   string `json:"url"`
}

type AvatarID int64

type AvatarQuery struct {
	Conditions Conditions
	Pagination Pagination
	All        bool // 查询全部条目
}

type AvatarService interface {
	Find(c context.Context, id AvatarID) (*AvatarDTO, error)
	List(c context.Context, q *AvatarQuery) ([]*AvatarDTO, error)
	ListAll(c context.Context) ([]*AvatarDTO, error)
}

type AvatarVO struct {
	BaseVO

	Avatars []*AvatarDTO `json:"avatars"`
}

type BaseDTO struct {
	UUID lang.UUID `json:"uuid"`

	CreatedAt lang.Time `json:"created_at"`
	UpdatedAt lang.Time `json:"updated_at"`
	DeletedAt lang.Time `json:"deleted_at"`

	Group   GroupID `json:"group"` // 该对象的默认权限分组
	Owner   UserID  `json:"owner"`
	Creator UserID  `json:"creator"`
	Updater UserID  `json:"updater"`
}

type BaseVO struct {
	Status     int         `json:"status"`
	Message    string      `json:"message"`
	Error      string      `json:"error"`
	Time       time.Time   `json:"time"`
	Timestamp  lang.Time   `json:"timestamp"`
	Pagination *Pagination `json:"pagination"`
}

type Conditions struct {
	Query string   `json:"query"`
	Args  []string `json:"args"`
}

type CurrentUser struct {

	// 有效期
	Term

	UserID   UserID              `json:"user"`
	Username UserName            `json:"username"`
	Nickname string              `json:"nickname"`
	Language localization.Locale `json:"language"` // 该用户的本地化语言，取值示例：("zh_cn")
	Avatar   string              `json:"avatar"`
	Email    EmailAddress        `json:"email"`
	Roles    RoleNameList        `json:"roles"`

	Properties map[string]string `json:"properties"`

	AuthResults []*AuthResult `json:"auth_results"` // 主要用于 2FA
}

type EmailAddress string

type EmailAddressDTO struct {
	ID EmailAddressID `json:"id"`

	BaseDTO

	Address EmailAddress `json:"address"`
}

type EmailAddressID int64

type EmailAddressQuery struct {
	Conditions Conditions
	Pagination Pagination
	All        bool // 查询全部条目
}

type EmailAddressService interface {
	Insert(c context.Context, o *EmailAddressDTO) (*EmailAddressDTO, error)
	Update(c context.Context, id EmailAddressID, o *EmailAddressDTO) (*EmailAddressDTO, error)
	Delete(c context.Context, id EmailAddressID) error

	Find(c context.Context, id EmailAddressID) (*EmailAddressDTO, error)
	List(c context.Context, q *EmailAddressQuery) ([]*EmailAddressDTO, error)
}

type FullPhoneNumber PhoneNumber

type GroupDTO struct {
	ID GroupID `json:"id"`

	BaseDTO

	Name        GroupName `json:"name"`
	Label       string    `json:"label"`
	Description string    `json:"description"`

	Roles   RoleNameList `json:"roles"`
	Enabled bool         `json:"enabled"`
}

type GroupID int64

type GroupName string

type GroupQuery struct {
	Conditions Conditions
	Pagination Pagination
	All        bool // 查询全部条目
}

type GroupService interface {
	Insert(c context.Context, o *GroupDTO) (*GroupDTO, error)
	Update(c context.Context, id GroupID, o *GroupDTO) (*GroupDTO, error)
	Delete(c context.Context, id GroupID) error

	Find(c context.Context, id GroupID) (*GroupDTO, error)
	List(c context.Context, q *GroupQuery) ([]*GroupDTO, error)
}

type GroupVO struct {
	BaseVO

	Groups []*GroupDTO `json:"groups"`
}

type ModuleInfo interface {
	Name() string
	Version() string
	Revision() int
}

type Pagination struct {
	Page  int64 `json:"page"`  // 页码, first=1
	Size  int   `json:"size"`  // 页大小
	Total int64 `json:"total"` // 所有页面的条目总数
}

type PermissionCache interface {
	Clear()
	Find(c context.Context, want *PermissionDTO) (*PermissionDTO, error)
}

type PermissionChecker interface {
	GetSubjectContext() *SubjectContext

	// 添加用户具有的角色
	AddRolesHad(roles ...RoleName) PermissionChecker

	// 添加可接受访问的用户角色
	AddRolesAccepted(roles ...RoleName) PermissionChecker

	// 接受匿名者访问
	AcceptAnonymous() PermissionChecker

	// 检查目标对象的访问权限
	CheckObject(o *BaseDTO) error

	// 完成最终的检查
	Check() error
}

type PermissionDTO struct {
	ID PermissionID `json:"id"`

	BaseDTO

	Method      string       `json:"method"`
	Path        string       `json:"path"`
	AcceptRoles RoleNameList `json:"accept_roles"`
	Enabled     bool         `json:"enabled"`
}

type PermissionID int64

type PermissionQuery struct {
	Conditions Conditions
	Pagination Pagination
	All        bool // 查询全部条目
}

type PermissionService interface {
	Insert(c context.Context, o *PermissionDTO) (*PermissionDTO, error)
	Update(c context.Context, id PermissionID, o *PermissionDTO) (*PermissionDTO, error)
	Delete(c context.Context, id PermissionID) error

	Find(c context.Context, id PermissionID) (*PermissionDTO, error)
	List(c context.Context, q *PermissionQuery) ([]*PermissionDTO, error)
	ListAll(c context.Context) ([]*PermissionDTO, error)

	GetCache() PermissionCache
}

type PermissionVO struct {
	BaseVO

	Permissions []*PermissionDTO `json:"permissions"`
}

type PhoneNumber string

type PhoneNumberDTO struct {
	ID PhoneNumberID `json:"id"`

	BaseDTO

	RegionCode2  RegionPhoneCode   `json:"region"`
	SimpleNumber SimplePhoneNumber `json:"simple_number"`
	FullNumber   FullPhoneNumber   `json:"full_number"`
}

type PhoneNumberID int64

type PhoneNumberQuery struct {
	Conditions Conditions
	Pagination Pagination
	All        bool // 查询全部条目
}

type PhoneNumberService interface {
	Insert(c context.Context, o *PhoneNumberDTO) (*PhoneNumberDTO, error)
	Update(c context.Context, id PhoneNumberID, o *PhoneNumberDTO) (*PhoneNumberDTO, error)
	Delete(c context.Context, id PhoneNumberID) error

	Find(c context.Context, id PhoneNumberID) (*PhoneNumberDTO, error)
	List(c context.Context, q *PhoneNumberQuery) ([]*PhoneNumberDTO, error)
}

type PurePhoneNumber PhoneNumber

type RegionCode2 string

type RegionCode3 string

type RegionDTO struct {
	ID RegionID `json:"id"`

	BaseDTO

	FlagURL     string          `json:"flag_url"`    // 国旗（或区旗）图标的URL
	DisplayName string          `json:"label"`       // 显示名称，通常是本地化的名称
	SimpleName  string          `json:"simple_name"` // 区域简称，例如：chn(中国), fra(France), usa(United States)
	FullName    string          `json:"full_name"`   // 完整的名称，例如：中华人民共和国(PRC)
	Code2       RegionCode2     `json:"code_xx"`     // 二字符区域码
	Code3       RegionCode3     `json:"code_xxx"`    // 三字符区域码
	PhoneCode   RegionPhoneCode `json:"phone_code"`  // 电话区域码
}

type RegionID int

type RegionPhoneCode string

type RegionQuery struct {
	Conditions Conditions
	Pagination Pagination
	All        bool // 查询全部条目
}

type RegionService interface {
	Insert(c context.Context, o *RegionDTO) (*RegionDTO, error)
	Update(c context.Context, id RegionID, o *RegionDTO) (*RegionDTO, error)
	Delete(c context.Context, id RegionID) error

	Find(c context.Context, id RegionID) (*RegionDTO, error)
	List(c context.Context, q *RegionQuery) ([]*RegionDTO, error)
}

type RoleDTO struct {
	ID RoleID `json:"id"`

	BaseDTO

	Name        RoleName `json:"name"`
	Description string   `json:"description"`
}

type RoleID int64

type RoleName string

type RoleNameList string

type RoleQuery struct {
	Conditions Conditions
	Pagination Pagination
	All        bool // 查询全部条目
}

type RoleService interface {
	Insert(c context.Context, o *RoleDTO) (*RoleDTO, error)
	Update(c context.Context, id RoleID, o *RoleDTO) (*RoleDTO, error)
	Delete(c context.Context, id RoleID) error

	Find(c context.Context, id RoleID) (*RoleDTO, error)
	List(c context.Context, q *RoleQuery) ([]*RoleDTO, error)
}

type RoleVO struct {
	BaseVO

	Roles []*RoleDTO `json:"roles"`
}

type SessionDTO struct {
	ID SessionID `json:"id"`

	BaseDTO
	CurrentUser

	Authenticated bool `json:"authenticated"` // 是否已验证
}

type SessionID SessionIID

type SessionIID int64

type SessionService interface {
	Find(c context.Context, id SessionID) (*SessionDTO, error)

	Insert(c context.Context, se *SessionDTO) (*SessionDTO, error)

	Update(c context.Context, id SessionID, se *SessionDTO) (*SessionDTO, error)
}

type SessionUUID lang.UUID

type SessionVO struct {
	BaseVO

	Sessions []*SessionDTO `json:"sessions"`
}

type SimplePhoneNumber PhoneNumber

type SubjectContext struct {
	Authenticated bool

	Token   *TokenDTO
	Session *SessionDTO
	Subject *SubjectDTO

	Checker PermissionChecker
	Service SubjectService

	// 当前用户具有的角色
	HaveRoles []RoleName

	// 当前操作可接受的角色
	AcceptedRoles []RoleName
}

type SubjectDTO struct {
	ID SubjectID `json:"id"`

	Authenticated bool       `json:"authenticated"` // 是否已验证
	Token         TokenDTO   `json:"token"`
	Session       SessionDTO `json:"session"`
}

type SubjectID int64

type SubjectService interface {
	GetCurrent(c context.Context) (*SubjectDTO, error)

	GetCurrentChecker(c context.Context) (PermissionChecker, error)

	GetCurrentContext(c context.Context) (*SubjectContext, error)
}

type SubjectVO struct {
	BaseVO

	Subject *SubjectDTO `json:"subject"`
}

type Term struct {
	StartedAt lang.Time `json:"started_at"` // 生效时间
	ExpiredAt lang.Time `json:"expired_at"` // 过期时间
}

type TokenDTO struct {
	NotBefore lang.Time `json:"not_before"`

	NotAfter lang.Time `json:"not_after"`

	SessionID SessionID `json:"session_id"` // 会话的 ID

	SessionUUID SessionUUID `json:"session_uuid"` // 会话的 UUID

}

type TokenService interface {
	GetCurrent(c context.Context) (*TokenDTO, error)

	PutCurrent(c context.Context, token *TokenDTO) (*TokenDTO, error)
}

type TokenVO struct {
	BaseVO

	Tokens []*TokenDTO `json:"tokens"`
}

type UserDTO struct {
	ID UserID `json:"id"`

	BaseDTO

	Name     UserName     `json:"name"`
	NickName string       `json:"nickname"`
	Avatar   string       `json:"avatar"`
	Phone    string       `json:"phone"`
	Email    string       `json:"email"`
	Language string       `json:"language"`
	Roles    RoleNameList `json:"roles"`
	Enabled  bool         `json:"enabled"`
}

type UserID int64

type UserInfo struct {
	CurrentUser
}

type UserInfoBinding struct {
	// contains filtered or unexported fields
}

type UserName string

type UserQuery struct {
	Conditions Conditions
	Pagination Pagination
	All        bool // 查询全部条目
}

type UserService interface {
	Insert(c context.Context, o *UserDTO) (*UserDTO, error)
	Update(c context.Context, id UserID, o *UserDTO) (*UserDTO, error)
	Delete(c context.Context, id UserID) error

	Find(c context.Context, id UserID) (*UserDTO, error)
	List(c context.Context, q *UserQuery) ([]*UserDTO, error)
}

type UserVO struct {
	BaseVO

	Users []*UserDTO `json:"users"`
}

type VOGetter interface {
	GetVO() *BaseVO
}