api

Documentation

Index

• Variables
• func CheckPermission(p, n model.Permission) error
• func GetClear_public(ctx *gin.Context) (data any, err group.Error)
• func GetClear_root(ctx *gin.Context) (data any, err group.Error)
• func GetDownload_users(ctx *gin.Context) (any, group.Error)
• func GetEngine() (*gin.Engine, error)
• func GetExec(ctx *gin.Context) (any, group.Error)
• func GetGet_users(ctx *gin.Context) (any, group.Error)
• func GetList(ctx *gin.Context) (any, group.Error)
• func GetLog(ctx *gin.Context) (any, group.Error)
• func GetMe(ctx *gin.Context) (any, group.Error)
• func GetModify_follow(ctx *gin.Context) (any, group.Error)
• func GetOnline(ctx *gin.Context) (any, group.Error)
• func GetPing(ctx *gin.Context) (any, group.Error)
• func GetRegister(ctx *gin.Context) (any, group.Error)
• func GetRemove_job(ctx *gin.Context) (any, group.Error)
• func GetRestart(ctx *gin.Context) (any, group.Error)
• func GetSet_permission(ctx *gin.Context) (any, group.Error)
• func GetToken(ctx *gin.Context) (any, group.Error)
• func GetUpdate(ctx *gin.Context) (any, group.Error)
• func GetVersion(ctx *gin.Context) (any, group.Error)
• func IsAdmin(ctx *gin.Context)
• func PostAdd_job(ctx *gin.Context) (any, group.Error)
• func PostSubmit(ctx *gin.Context) (any, group.Error)
• func PostTest_job(ctx *gin.Context) (any, group.Error)
• func SetUser(ctx *gin.Context)
• func WrapError(data any, err error) (any, group.Error)

Variables

var (
	ErrNoAuthCode = errors.New("webhook/api: no authentication code")
	ErrAuth       = errors.New("webhook/api: authentication failure")
)

var Admin = group.Group{
	Path:        "admin",
	Middlewares: gin.HandlersChain{IsAdmin},
	Handlers: group.Chain{
		GetExec,
		GetGet_users,
		GetSet_permission,
		GetLog,
		GetRestart,
		GetClear_public,
		GetClear_root,
		GetUpdate,
		GetDownload_users,
	},
}

var Api = group.Group{
	Middlewares: gin.HandlersChain{group.CORS},
	Customize: func(r gin.IRouter) {
		r.StaticFS("/public", request.DefaultDownloadSystem(config.Global.Path.FullPath.Public))
	},
	Groups: []group.Group{Visitor, {
		Middlewares: gin.HandlersChain{SetUser},
		Groups:      []group.Group{Submitter, Admin},
	}},
}

var CmdList string

var ErrAppoint1 = errors.New("webhook/api: only the owner can appoint the administrator")

var ErrAppoint2 = errors.New("webhook/api: only the administrator can appoint others")

var ErrHasOwner = errors.New("webhook/api: there can only be one owner")

var (
	ErrNoAdmin = errors.New("webhook/api: no administrator permission")
)

var ErrNoRepost = group.NewError(1, `Form key "repost" not found. A "null" value must be pass in if there is no repost.`)

var Submitter = group.Group{
	Path: "submitter",

	Handlers: group.Chain{
		GetMe,
		GetPing,
		GetRemove_job,
		GetModify_follow,
		PostSubmit,
		PostAdd_job,
		PostTest_job,
	},
}

var Visitor = group.Group{
	Handlers: group.Chain{
		GetVersion,
		GetList,
		GetOnline,
		GetToken,
		GetRegister,
	},
}

Functions

func CheckPermission

func CheckPermission(p, n model.Permission) error

func GetClear_public

func GetClear_public(ctx *gin.Context) (data any, err group.Error)

func GetClear_root

func GetClear_root(ctx *gin.Context) (data any, err group.Error)

func GetDownload_users

func GetDownload_users(ctx *gin.Context) (any, group.Error)

func GetEngine

func GetEngine() (*gin.Engine, error)

func GetExec

func GetExec(ctx *gin.Context) (any, group.Error)

func GetGet_users

func GetGet_users(ctx *gin.Context) (any, group.Error)

func GetList

func GetList(ctx *gin.Context) (any, group.Error)

查看资源目录

func GetLog

func GetLog(ctx *gin.Context) (any, group.Error)

读取日志

func GetMe

func GetMe(ctx *gin.Context) (any, group.Error)

获取自身信息

func GetModify_follow

func GetModify_follow(ctx *gin.Context) (any, group.Error)

更新监听列表

func GetOnline

func GetOnline(ctx *gin.Context) (any, group.Error)

获取当前在线状态

func GetPing

func GetPing(ctx *gin.Context) (any, group.Error)

更新在线时间

func GetRegister

func GetRegister(ctx *gin.Context) (any, group.Error)

新建用户

func GetRemove_job

func GetRemove_job(ctx *gin.Context) (any, group.Error)

移除任务

func GetRestart

func GetRestart(ctx *gin.Context) (any, group.Error)

func GetSet_permission

func GetSet_permission(ctx *gin.Context) (any, group.Error)

func GetToken

func GetToken(ctx *gin.Context) (any, group.Error)

获取注册所需 Token

func GetUpdate

func GetUpdate(ctx *gin.Context) (any, group.Error)

主动更新主页

func GetVersion

func GetVersion(ctx *gin.Context) (any, group.Error)

当前版本号

func IsAdmin

func IsAdmin(ctx *gin.Context)

func PostAdd_job

func PostAdd_job(ctx *gin.Context) (any, group.Error)

新增任务

func PostSubmit

func PostSubmit(ctx *gin.Context) (any, group.Error)

提交博文

func PostTest_job

func PostTest_job(ctx *gin.Context) (any, group.Error)

测试单个任务

func SetUser

func SetUser(ctx *gin.Context)

func WrapError

func WrapError(data any, err error) (any, group.Error)