auth

type AuthProvider interface {

	// 认证名称
	GetName() string

	// 注册时需要执行的
	OnProviderRegister(a *GinAuth) error

	// 登录引导
	OnGuideLogin(c *gin.Context) error

	// 登录账号
	OnLogin(c *gin.Context) (User, error)
	// 第三方登录回调
	OnLoginCallback(c *gin.Context) (User, error)
	OnLogout(c *gin.Context) (User, error)
}

type AuthRender interface {

	// 注册时需要执行的
	OnRenderRegister(a *GinAuth) error

	// 错误渲染
	Error(c *gin.Context) (*Result, error)

	// 登录引导
	GuideLogin(c *gin.Context) (*Result, error)

	// 错误登录
	FailLogin(c *gin.Context) (*Result, error)

	// 成功登录
	SuccessLogin(c *gin.Context, u User) (*Result, error)

	// 登出账号
	Logout(c *gin.Context) (*Result, error)
}

type AuthToken interface {

	// 新Token
	NewToken(user map[string]string) (token string, expiredAt int64, err error)

	// 清除Token
	ClearToken(token string) error

	// 清除用户的Token
	ClearTokenOfUser(uid string, provider string) error

	// 查找token
	FindToken(token string) (user map[string]string)
}

type Config struct {
	Path struct {
		// Auth工具挂载的地址。如：/auth
		Mount string
		// Auth工具挂载的Web服务的站点基础路径。如：http://localhost:8090/api，主要用于构建回调地址用。
		RootURL string
		// 域名
		Domain string
		// 登录成功之后的跳转地址，如果需要的话
		RedirectAfterLogin string
		// Token写入cookie时使用名字
		TokenKey string
		// Token在头部请求时的名字
		HeaderKey string
	}

	Response struct {
		// 默认返回类型
		DefaultResultType ResultType

		NotFoundHandler func(c *gin.Context)
	}

	Core struct {

		// 路由
		Router *gin.Engine

		// 数据库连接
		DB *gorm.DB

		// token管理
		AuthToken AuthToken

		// 用户存储
		UserStore user_store.UserStoreInterface

		// Session
		Session Session

		// 是否打开日志功能
		LogMod bool
		Logger log.Logger
	}
}

type GinAuth struct {
	Config   Config
	Handlers GinAuthHandlers
	// contains filtered or unexported fields
}

type GinAuthHandler func(c *gin.Context, p AuthProvider, r AuthRender)

type GinAuthHandlers struct {
	GetLoginHandler      GinAuthHandler
	PostLoginHandler     GinAuthHandler
	LogoutHandler        func(c *gin.Context, a *GinAuth)
	LoginCallbackHandler GinAuthHandler
}

type Result struct {
	StatusCode int
	RspType    ResultType
	Value      interface{}
	Key        string
}

type ResultType string

type Session interface {
	// 对一个request启动session，默认要检查csrf
	StartSession(c *gin.Context, noCheckCsrf bool)
	// 从session获取值
	GetValue(c *gin.Context, key string) (v interface{}, exist bool)
	// 按字符串格式读取一个session值
	GetValueString(c *gin.Context, key string) string
	// 写入session
	SetValue(c *gin.Context, key string, v interface{})
	// 移除值
	DelValue(c *gin.Context, key string)
	// 清空session
	ClearSession(c *gin.Context)
}

type User interface {
	GetID() string
	GetProvider() string
	GetRole() string
	GetToken() string
	GetExpired() int64
	SetToken(v string, expiredAt int64)
	GetMapData() map[string]string
}