core

type Context interface {
	// ShouldBindQuery 反序列化 querystring
	// tag: `form:"xxx"` (注：不要写成 query)
	ShouldBindQuery(obj interface{}) error

	// ShouldBindPostForm 反序列化 postform (querystring会被忽略)
	// tag: `form:"xxx"`
	ShouldBindPostForm(obj interface{}) error

	// ShouldBindForm 同时反序列化 querystring 和 postform;
	// 当 querystring 和 postform 存在相同字段时，postform 优先使用。
	// tag: `form:"xxx"`
	ShouldBindForm(obj interface{}) error

	// ShouldBindJSON 反序列化 postjson
	// tag: `json:"xxx"`
	ShouldBindJSON(obj interface{}) error

	// ShouldBindURI 反序列化 path 参数(如路由路径为 /user/:name)
	// tag: `uri:"xxx"`
	ShouldBindURI(obj interface{}) error

	// Redirect 重定向
	Redirect(code int, location string)

	// HTML 返回界面
	HTML(name string, obj interface{})

	// 返回 Json
	JSON(data interface{})

	// Header 获取 Header 对象
	Header() http.Header

	// GetHeader 获取 Header
	GetHeader(key string) string

	// SetHeader 设置 Header
	SetHeader(key, value string)

	// SetCookie 设置cookie
	SetCookie(key, value string)

	// Cookie 根据cookie的key获取值
	Cookie(key string) (value string, err error)

	// RequestInputParams 获取所有参数
	RequestInputParams() url.Values

	// RequestPostFormParams  获取 PostForm 参数
	RequestPostFormParams() url.Values

	// Request 获取 Request 对象
	Request() *http.Request

	// Method 获取 Request.Method
	Method() string
	// Host 获取 Request.Host
	Host() string
	// Path 获取 请求的路径 Request.URL.Path (不附带 querystring)
	Path() string
	// URI 获取 unescape 后的 Request.URL.RequestURI()
	URI() string
	// resource 获取 请求方式和全路径拼接好的字符串
	// 如GET:/api/v1/userlist
	Resource() string

	// 终止并返回信息
	AbortWithError(interface{})

	// CtxGet 获取上下文自定义的一些参数
	CtxGet(key string) interface{}

	// 设置自定义参数在上下文中
	CtxSet(key string, v interface{})

	// 获取二次封装的参数
	CtxGetParams() any

	Next()

	Ctx() *gin.Context

	// 返回通过参数构建好查询参数参数的gorm.DB
	TX(optFunc ...TxOptsFunc) *gorm.DB

	Core() Core

	// 获取用户
	Auth() string

	// 生成新的db查询
	NewTX(optFunc ...TxOptsFunc) *gorm.DB
}

type Core interface {

	// 封装了服务启动和关闭
	// 方便快速启动
	Run()

	// 关闭整个服务
	Shutdown()

	// gin的engine, 用于原生gin方法
	// 可以更灵活的实现开发
	Engine() *gin.Engine

	Group(elativePath string, handlers ...HandlerFunc) RouterGroup

	// 缓存
	Cache() cache.Store

	// 关系数据库
	RDB() rdb.Store

	// session
	Session() session.Session

	// 限流器
	Limiter() *rate.Limiter

	// 配置
	Config() *config.Config

	// 添加启动时的一些作业
	AddStartJobList(...mux.StartJobFunc)
	// contains filtered or unexported methods
}

type FuncCores func(*options)

type HandlerFunc func(Context)

type IRoutes interface {
	// Any(string, ...HandlerFunc)
	//需要填写相对路由路径, 名称, 参数, 及中间件, 用于在 api 文档和菜单中注册
	//参数为如果为空, 该方法不会在 api 文档中进行注册
	GET(relativePath, pathName string, params interface{}, handlers ...HandlerFunc) (source *Sources)
	//需要填写相对路由路径, 名称, 参数, 及中间件, 用于在 api 文档和菜单中注册
	//参数为如果为空, 该方法不会在 api 文档中进行注册
	PUT(relativePath, pathName string, params interface{}, handlers ...HandlerFunc) (source *Sources)
	//需要填写相对路由路径, 名称, 参数, 及中间件, 用于在 api 文档和菜单中注册
	//参数为如果为空, 该方法不会在 api 文档中进行注册
	POST(relativePath, pathName string, params interface{}, handlers ...HandlerFunc) (source *Sources)
	//需要填写相对路由路径, 名称, 参数, 及中间件, 用于在 api 文档和菜单中注册
	//参数为如果为空, 该方法不会在 api 文档中进行注册
	DELETE(relativePath, pathName string, params interface{}, handlers ...HandlerFunc) (source *Sources)
}

type RouterGroup interface {
	Group(api, apiName string, handlers ...HandlerFunc) RouterGroup
	IRoutes
	RouterSource
	Core() Core
}

type RouterSource interface {

	// 用于设置某些路由不必写入资源库
	NotWithSource() RouterGroup

	// 用于设置设置模块/api权限
	//
	// 默认所有菜单,api都需要权限设置
	//
	// 对于通用模块如用户个人设置等信息, 可以设置为权限例外, 可以灵活的在初始化阶段完成权限配置
	WithPermission(t int8) RouterGroup

	// 设置为前端路由或非路由
	//
	// 模块部分默认为前端路由(菜单), 默认值 SOURCE_ROUTER_IS = 1, api默认非路由, 为按钮权限, 默认值 SOURCE_ROUTER_NAN=0
	//
	// 通过该方法可以灵活的配置接口/模块的显示规则
	WithRouter(t int8) RouterGroup

	// 去除前端菜单路由前缀,
	//
	// 例如api接口转为前端路由: /ajax/user/list => /user/list
	WithMenuNotPrefix(prefix string) RouterGroup

	// 设置路由隐藏
	WithHidden() RouterGroup

	// 设置前端Meta信息
	WithMeta(key string, value interface{}) RouterGroup
}

type SignatureOptFunc func(*signatureOption)

type Sources struct {
	SourcesBase
	rdb.Model
	Children []*Sources `json:"children" gorm:"-"`
}

type SourcesBase struct {
	Code  string `json:"code" gorm:"comment:资源代码;uniqueIndex"`           // 资源code
	Name  string `json:"name" gorm:"comment:资源名称;index"`                 // 资源名称,
	Desc  string `json:"desc" gorm:"comment:资源说明"`                       // 资源描述,可用作title
	PCode string `json:"pcode" gorm:"comment:上层资源code;index"`            // 父级code
	Level int8   `json:"level" gorm:"comment:资源层级;index"`                // 层级, 方便定位数据
	Api   string `json:"api" gorm:"comment:资源路径;index"`                  // 资源访问api
	Type  int8   `json:"type" gorm:"comment:资源类型,0表示都可以显示, 1表示受限;index"` // 用于区分资源类型, 可以设置那些是用做权限配置的
	Sort  string `json:"sort" gorm:"comment:资源排序"`                       // 前端菜单顺序
	// API文档用, 请求方法
	Method     string `json:"method" gorm:"comment:后台接口方法"`        // api接口路径
	Params     string `json:"params" gorm:"comment:前端请求参数"`        // db中存储的参数字符串
	AcceptType string `json:"accept_type" gorm:"comment:前端请求参数类型"` // 约束接口传参方式
	// 前端路由菜单用
	IsRouter  int8            `json:"is_router" gorm:"comment:前端用路由判断;index"`            // 主要用于某些button需要展示路由上
	Path      string          `json:"path" gorm:"comment:前端用路径;index"`                   // 前端用组件方法
	Component string          `json:"component" gorm:"comment:组件名称"`                     // 前端组件名称
	Meta      rdb.ModeMapJson `json:"meta" gorm:"type:varchar(1000);comment:前端用路由参数元信息"` // 前端组件原信息
}

type TxOptsFunc func(*txOpts)