web

type ApiRouter struct {
	*WebApiRouter
	*MatchRule
}

type Config struct {
	// Disabled 禁用 上层 初始化服务时候 可以判断该属性 如果为 配置 true 则不去初始化服务
	Disabled bool `json:"disabled,omitempty" yaml:"disabled,omitempty"`

	Host           string `json:"host,omitempty"`
	Port           int    `json:"port,omitempty"`
	Context        string `json:"context,omitempty"`
	AssetsDir      string `json:"assetsDir,omitempty"`
	AssetsSeparate string `json:"assetsSeparate,omitempty"` // assets 分割字符 默认 assets/
	FilesDir       string `json:"filesDir,omitempty"`
	FilesSeparate  string `json:"filesSeparate,omitempty"` // files 分割字符 默认 files/

	MaxMultipartMemory int64 `json:"maxMultipartMemory,omitempty"`

	Tls *ConfigTls `json:"tls,omitempty"`

	Locations     []*ConfigLocation         `json:"locations,omitempty"`
	Replaces      map[string]*ConfigReplace `json:"replaces,omitempty"`
	GinDefaultLog bool                      `json:"ginDefaultLog,omitempty"`
	GinErrorLog   bool                      `json:"ginErrorLog,omitempty"`
}

type ConfigLocation struct {
	Path string `json:"path,omitempty"`
	To   string `json:"to,omitempty"`
}

type ConfigReplace struct {
	Path        string `json:"path,omitempty"`
	ContentType string `json:"contentType,omitempty"`
	Content     string `json:"content,omitempty"`
	Append      string `json:"append,omitempty"`
}

type ConfigTls struct {
	Open     bool   `json:"open,omitempty"`
	CertFile string `json:"certFile,omitempty"`
	KeyFile  string `json:"keyFile,omitempty"`
}

type Filter struct {
	WebFilter
	*MatchRule
}

type IWebService interface {
	Init() (err error)
	Serve() (err error)
	RequestRead(request *WebRequest) []byte
	SetStatus(request *WebRequest, status int)
	GetHeader(request *WebRequest, key string) string
	SetHeader(request *WebRequest, key, value string)
	ResponseWrite(request *WebRequest, data []byte)
	ResponseWriteByReader(request *WebRequest, reader io.Reader) (written int64, err error)
	GetParam(request *WebRequest, key string) string
	RawQuery(request *WebRequest) string
	ClientIP(request *WebRequest) string
	UserAgent(request *WebRequest) string
}

type Interceptor struct {
	WebInterceptor
	*MatchRule
}

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

type Option func(*WebServer)

type WebApi struct {
	Path   string // 路由
	Method string // HTTP 方法 GET、POST 等
	// contains filtered or unexported fields
}

type WebApiHandleFunc func(request *WebRequest) (res any, err error)

type WebApiRouter struct {
	Path     string // 路由
	Method   string // HTTP 方法 GET、POST 等
	Comment  string // 说明
	NotLogin bool   // 不需要登录
	NotLog   bool   // 不需要日志
	// contains filtered or unexported fields
}

type WebFilter interface {
	GetName() string           // 定义名称
	Order() int                // 顺序 正序 排序 值越小 则优先
	GetMatch() WebRequestMatch // 请求 匹配 配置
	DoFilter(request *WebRequest, chain WebFilterChain) (err error)
}

type WebFilterChain func(request *WebRequest) (err error)

type WebInterceptor interface {
	GetName() string           // 定义名称
	Order() int                // 顺序 正序 排序 值越小 则优先
	GetMatch() WebRequestMatch // 请求 匹配 配置
	Before(request *WebRequest) (toContinue bool, err error)
	After(request *WebRequest) (toContinue bool, err error)
}

type WebRequest struct {
	Path            string        `json:"path,omitempty"`
	Method          string        `json:"method,omitempty"`
	WebSession      *WebSession   `json:"webSession,omitempty"`
	StartTime       time.Time     `json:"startTime,omitempty"`
	EndTime         time.Time     `json:"endTime,omitempty"`
	HandleStartTime time.Time     `json:"handleStartTime,omitempty"`
	HandleEndTime   time.Time     `json:"handleEndTime,omitempty"`
	Response        any           `json:"response,omitempty"`
	WebApiRouter    *WebApiRouter `json:"webApiRouter,omitempty"`

	Body []byte `json:"-"`
	// contains filtered or unexported fields
}

type WebRequestMatch struct {
	Includes []string // 包含路径 表达式 匹配 路径
	Excludes []string // 忽略路径 表达式 匹配 路径
	Methods  []string // HTTP 方法 GET、POST 等
}

type WebResponse struct {
	Code string      `json:"code"`
	Msg  string      `json:"msg,omitempty"`
	Data interface{} `json:"data,omitempty"`
}

type WebServer struct {
	IWebService

	framework.Logger
	// contains filtered or unexported fields
}

type WebSession struct {
}