admin

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 1, 2026 License: MIT Imports: 31 Imported by: 0

Documentation

Index

Constants

View Source
const DefaultAdminPassword = "123456"

Variables

View Source
var StableKey = regexp.MustCompile(`^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)+$`)

Functions

func TokenHash

func TokenHash(value string) string

Types

type Actor

type Actor struct {
	User        models.User
	Permissions map[string]bool
	SessionID   string
}

func (*Actor) Can

func (a *Actor) Can(key string) bool

func (*Actor) Level

func (a *Actor) Level() int

func (*Actor) Scope

func (a *Actor) Scope(ownerColumn, departmentColumn string) func(*gorm.DB) *gorm.DB

Scope 在列表、详情和写入请求上使用同样的数据范围.

type App

type App struct {
	Options               Options
	DB                    *gorm.DB
	Redis                 redis.UniversalClient
	Runtime               Runtime
	Router                *gin.Engine
	Disk                  fs.Filesystem
	Realtime              *realtime.Hub
	CacheKeys             map[string]constants.Definition
	PermissionDefinitions map[string]Permission
	MenuDefinitions       []Menu
	SettingDefinitions    map[string]SettingDefinition
}

App 持有后台定义和容器提供的共享资源。

func From

func From(r cc.Resolver) (*App, error)

From resolves the module from a specific application container.

func New

func New(o Options, runtime Runtime, db *gorm.DB, client redis.UniversalClient, disk fs.Filesystem) (*App, error)

func Resolve

func Resolve() *App

Resolve 返回当前应用容器中的后台上下文。

func (*App) ActorForSession

func (a *App) ActorForSession(id string) (*Actor, error)

ActorForSession reloads a durable session and its current roles for background work.

func (*App) Authenticate

func (a *App) Authenticate(token string) (*Actor, error)

Authenticate 从数据库读取当前账号和角色, 修改授权无需等待旧缓存过期.

func (*App) CacheSetting

func (a *App) CacheSetting(ctx context.Context, row models.Setting) error

CacheSetting 只接受较新的配置版本,避免多实例并发时旧值回写。

func (*App) CheckRoles

func (a *App) CheckRoles(current *Actor, ids []uint) error

CheckRoles 防止管理员给自己或下属分配超出自身权限的角色.

func (*App) Close

func (a *App) Close() error

Close shuts down the owning application.

func (*App) CreateAdmin

func (a *App) CreateAdmin(username, password string) error

CreateAdmin 只在显式命令中创建账号, 不重置已有管理员密码.

func (*App) FileDisk

func (a *App) FileDisk(ctx context.Context, location *storage.Config) (fs.Filesystem, storage.Config, error)

FileDisk使用文件原始存储位置;切换上传驱动不改变已上传附件的位置。

func (*App) Handler

func (a *App) Handler() (http.Handler, error)

Handler 返回应用装配后的HTTP处理链。

func (*App) InstallDefaults

func (a *App) InstallDefaults(ctx context.Context, username, password string) error

InstallDefaults 仅在安装时补齐基础资料,不重置管理员或覆盖已编辑的数据。

func (*App) Key

func (a *App) Key(d constants.Definition, args ...any) string

Key adds the application/environment namespace to a registered key pattern.

func (*App) MenuList

func (a *App) MenuList(locale string) []Menu

func (*App) Menus

func (a *App) Menus(actor *Actor, locale string) ([]Menu, error)

Menus 合并代码菜单和自定义菜单, 仅返回当前用户有权访问的页面.

func (*App) PermissionList

func (a *App) PermissionList(locale string) map[string]Permission

func (*App) Setting

func (a *App) Setting(ctx context.Context, key string) (json.RawMessage, error)

Setting 返回组内单个JSON值,保密字段只在服务端解密。

func (*App) SyncSettings

func (a *App) SyncSettings(ctx context.Context) error

SyncSettings 补齐组和新字段,不覆盖已有配置。

func (*App) ValidateMenu

func (a *App) ValidateMenu(menu *models.Menu, editing bool) error

type LinkSystem

type LinkSystem struct {
	Key         string
	Origin      string
	Secret      string
	Permissions []string
}

LinkSystem 显式注册受信任的外部系统, 不向后台开放任意系统密钥编辑.

type Menu struct {
	Type       int    `json:"type"`
	Key        string `json:"key"`
	ParentKey  string `json:"parent_key"`
	Title      string `json:"title"`
	Path       string `json:"path"`
	Component  string `json:"component,omitempty"`
	Permission string `json:"permission,omitempty"`
	Icon       string `json:"icon,omitempty"`
	Sort       int    `json:"sort"`
	URL        string `json:"url,omitempty"`
	Mode       string `json:"mode,omitempty"`
	SystemKey  string `json:"system_key,omitempty"`
	Hidden     bool   `json:"hidden,omitempty"`
	Status     int    `json:"status"`
	KeepAlive  bool   `json:"keep_alive"`
	FixedTab   bool   `json:"fixed_tab"`
	FullPage   bool   `json:"full_page"`
	Children   []Menu `json:"children,omitempty"`
}

type Options

type Options struct {
	Name           string
	Environment    string
	WSAddr         string
	WSPath         string
	AdminPrefix    string
	Storage        string
	Disk           fs.Filesystem
	AllowedOrigins []string
	Menus          []Menu
	Permissions    []Permission
	CacheKeys      []constants.Definition
	Settings       []SettingDefinition
	LinkSystems    []LinkSystem
	Routes         func(*App, *gin.RouterGroup)
	PublicRoutes   func(*App, *gin.Engine)
	WSValidate     func(context.Context, realtime.Principal) error
	WSAuthorize    func(context.Context, realtime.Principal, string) error
	Realtime       func(*App, *realtime.Hub) error
	AccessTTL      time.Duration
	RefreshTTL     time.Duration
}

Options 仅声明应用实际需要配置的入口, 业务直接追加代码定义.

type Permission

type Permission struct {
	Key       string `json:"key"`
	Title     string `json:"title"`
	ParentKey string `json:"parent_key"`
}

type Runtime

type Runtime interface {
	NewHTTPServer(context.Context, string) (*http.Server, error)
	Close(...time.Duration) error
}

Runtime 提供应用已有的HTTP服务与退出能力。

type SettingDefinition

type SettingDefinition struct {
	Key     string          `json:"key"`
	Title   string          `json:"title"`
	Group   string          `json:"group"`
	Kind    string          `json:"kind"`
	Input   string          `json:"input"`
	Options []SettingOption `json:"options,omitempty"`
	Remark  string          `json:"remark,omitempty"`
	Sort    int             `json:"sort"`
	Default any             `json:"default"`
	Secret  bool            `json:"secret"`
	When    map[string]any  `json:"when,omitempty"`
}

type SettingOption

type SettingOption struct {
	Label string `json:"label"`
	Value any    `json:"value"`
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL