bigo

type BeforeFunc func(ResponseWriter)

type BeforeHandler func(rw http.ResponseWriter, req *http.Request) bool

type Bigo struct {
	inject.Injector

	*Router
	// contains filtered or unexported fields
}

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

type Config struct {
	AppName  string   `json:"AppName"`  //应用名称
	WorkDir  string   `json:"WorkDir"`  //工作目录,默认为运行目录
	LogDir   string   `json:"LogDir"`   //日志目录,默认为$WORKDIR/log
	LogLevel LogLevel `json:"LogLevel"` //日志等级,0.none 1.info 2.debug 3.error ,默认在DEV,TEST下为1,PROD下为3

	HttpAddr string `json:"HttpAddr"` //http监听地址,默认在0.0.0.0
	HttpPort int    `json:"HttpPort"` //http监听端口,默认为3000

	HttpsAddr     string `json:"HttpsAddr"`     //https监听地址,默认在0.0.0.0
	HttpsPort     int    `json:"HttpsPort"`     //https监听地址,默认为443
	HttpsCertFile string `json:"HttpsCertFile"` //https证书文件路径
	HttpsKeyFile  string `json:"HttpsKeyFile"`  //https证书key文件路径
	EnableHttps   bool   `json:"EnableHttps"`   //是否开启https服务，默认false
	ForceHttps    bool   `json:"ForceHttps"`    //是否强制将http请求转为https,默认为false

	EnableGzip bool `json:"EnableGzip"` //是否开启gzip,默认true,如果开启,并且客户端接受gzip的话责对会话进行gzip压缩
	ForceGzip  bool `json:"ForceGzip"`  //是否强制开启gzip,默认false,如果开启,不管客户端接不接受,都会以gzip进行传输

	EnableMinify           bool        `json:"EnableMinify"`           //默认为true,是否对.html .js .css 进行最小化处理
	StaticExtensionsToGzip []string    `json:"StaticExtensionsToGzip"` //使用gzip进行压缩传输的静态文件后缀,受客户端协议或FORCE_GZIP影响
	Statics                []StaticOpt `json:"Statics"`                //静态目录,数组
	I18n                   *I18nOpt    `json:"i18n"`                   //本地化配置
	Tmpl                   *TmplOpt    `json:"Tmpl"`                   //模板引擎配置
	RunMode                string      `json:"RunMode"`                //运行模式，DEV为开发模式，PROD为发布模式,TEST为测试模式
	DevOpt                 *SubConfig  `json:"DEV"`                    //对于DEV模式下的配置，RUN_MODE为DEV时会覆盖顶级配置
	TestOpt                *SubConfig  `json:"TEST"`                   //对于TEST模式下的配置，RUN_MODE为TEST时会覆盖顶级配置
	ProdOpt                *SubConfig  `json:"PROD"`                   //对于PROD模式下的配置，RUN_MODE为PROD时会覆盖顶级配置

	CutomOpt map[string]interface{} `json:"Cutom"` //自定义选项
}

type Context struct {
	inject.Injector

	*Router
	Req  Request
	Resp ResponseWriter

	Render // Not nil only if you use macaran.Render middleware.
	ILocale
	Data map[string]interface{}
	// contains filtered or unexported fields
}

type Delims struct {
	// Left delimiter, defaults to {{
	Left string
	// Right delimiter, defaults to }}
	Right string
}

type HTMLOptions struct {
	// Layout template name. Overrides Options.Layout.
	Layout string
}

type Handle func(http.ResponseWriter, *http.Request, Params)

type Handler interface{}

type I18nOpt struct {
	Enable          bool     `json:"Enable"`          //是否开启
	SubUrl          string   `json:"SubUrl"`          //子目录，默认为空
	Directory       string   `json:"Directory"`       //存放本地化文件的目录，默认为 "conf/locale"
	CustomDirectory string   `json:"CustomDirectory"` //用于重载的本地化文件目录,默认为 "custom/conf/locale"
	Langs           []string `json:"Langs"`           //支持的语言，顺序是有意义的
	Names           []string `json:"Names"`           //语言的本地化名称,和上面一一对应
	Format          string   `json:"Format"`          //本地化文件命名风格，默认为 "locale_%s.ini"
	Parameter       string   `json:"Parameter"`       //指示当前语言的 URL 参数名，默认为 "lang"
	Redirect        bool     `json:"Redirect"`        //当通过 URL 参数指定语言时是否重定向，默认为 false
	TmplName        string   `json:"TmplName"`        //存放在模板中的本地化对象变量名称，默认为 "i18n"
}

type I18nOptions struct {
	// Suburl of path. Default is empty.
	SubURL string
	// Directory to load locale files. Default is "conf/locale"
	Directory string
	// Custom directory to overload locale files. Default is "custom/conf/locale"
	CustomDirectory string
	// Langauges that will be supported, order is meaningful.
	Langs []string
	// Human friendly names corresponding to Langs list.
	Names []string
	// Locale file naming style. Default is "locale_%s.ini".
	Format string
	// Name of language parameter name in URL. Default is "lang".
	Parameter string
	// Redirect when user uses get parameter to specify language.
	Redirect bool
	// Name that maps into template variable. Default is "i18n".
	TmplName string
}

type ILocale interface {
	Language() string
	Tr(string, ...interface{}) string
}

type KMap map[string]interface{}

type LangType struct {
	Lang, Name string
}

type Locale struct {
	i18n.Locale
}

type LogLevel int

type Logger struct {
	*log.Logger
}

type LoggerWriter struct {
	io.Writer
	// contains filtered or unexported fields
}

type Params map[string]string

type Render interface {
	http.ResponseWriter
	RW() http.ResponseWriter

	JSON(int, interface{})
	JSONString(interface{}) (string, error)
	RawData(int, []byte)
	RenderData(int, []byte)
	HTML(int, string, interface{}, ...HTMLOptions)
	HTMLSet(int, string, string, interface{}, ...HTMLOptions)
	HTMLSetString(string, string, interface{}, ...HTMLOptions) (string, error)
	HTMLString(string, interface{}, ...HTMLOptions) (string, error)
	HTMLSetBytes(string, string, interface{}, ...HTMLOptions) ([]byte, error)
	HTMLBytes(string, interface{}, ...HTMLOptions) ([]byte, error)
	XML(int, interface{})
	Error(int, ...string)
	Status(int)
	SetTemplatePath(string, string)
	HasTemplateSet(string) bool
}

type RenderOptions struct {
	// Directory to load templates. Default is "templates".
	Directory string
	// Layout template name. Will not render a layout if "". Default is to "".
	Layout string
	// Extensions to parse template files from. Defaults are [".tmpl", ".html"].
	Extensions []string
	// Funcs is a slice of FuncMaps to apply to the template upon compilation. This is useful for helper functions. Default is [].
	Funcs []template.FuncMap
	// Delims sets the action delimiters to the specified strings in the Delims struct.
	Delims Delims
	// Appends the given charset to the Content-Type header. Default is "UTF-8".
	Charset string
	// Outputs human readable JSON.
	IndentJSON bool
	// Outputs human readable XML.
	IndentXML bool
	// Prefixes the JSON output with the given bytes.
	PrefixJSON []byte
	// Prefixes the XML output with the given bytes.
	PrefixXML []byte
	// Allows changing of output to XHTML instead of HTML. Default is "text/html"
	HTMLContentType string
	// TemplateFileSystem is the interface for supporting any implmentation of template file system.
	TemplateFileSystem
}

type Request struct {
	*http.Request
}

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

type ResponseWriter interface {
	http.ResponseWriter
	http.Flusher
	// Status returns the status code of the response or 0 if the response has not been written.
	Status() int
	// Written returns whether or not the ResponseWriter has been written.
	Written() bool
	// Size returns the size of the response body.
	Size() int
	// Before allows for a function to be called before the ResponseWriter has been written to. This is
	// useful for setting headers or any other operations that must happen before a response has been written.
	Before(BeforeFunc)
}

type ReturnHandler func(*Context, []reflect.Value)

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

type SecureOptions struct {
	// AllowedHosts is a list of fully qualified domain names that are allowed. Default is empty list, which allows any and all host names.
	AllowedHosts []string
	// If SSLRedirect is set to true, then only allow https requests. Default is false.
	SSLRedirect bool
	// SSLHost is the host name that is used to redirect http requests to https. Default is "", which indicates to use the same host.
	SSLHost string
	// SSLProxyHeaders is set of header keys with associated values that would indicate a valid https request. Useful when using Nginx: `map[string]string{"X-Forwarded-Proto": "https"}`. Default is blank map.
	SSLProxyHeaders map[string]string
	// STSSeconds is the max-age of the Strict-Transport-Security header. Default is 0, which would NOT include the header.
	STSSeconds int64
	// If STSIncludeSubdomains is set to true, the `includeSubdomains` will be appended to the Strict-Transport-Security header. Default is false.
	STSIncludeSubdomains bool
	// If FrameDeny is set to true, adds the X-Frame-Options header with the value of `DENY`. Default is false.
	FrameDeny bool
	// CustomFrameOptionsValue allows the X-Frame-Options header value to be set with a custom value. This overrides the FrameDeny option.
	CustomFrameOptionsValue string
	// If ContentTypeNosniff is true, adds the X-Content-Type-Options header with the value `nosniff`. Default is false.
	ContentTypeNosniff bool
	// If BrowserXssFilter is true, adds the X-XSS-Protection header with the value `1; mode=block`. Default is false.
	BrowserXssFilter bool
	// ContentSecurityPolicy allows the Content-Security-Policy header value to be set with a custom value. Default is "".
	ContentSecurityPolicy string
	// When developing, the AllowedHosts, SSL, and STS options can cause some unwanted effects. Usually testing happens on http, not https, and one localhost, not your production domain... we check `if Env == Prod`.
	// If you would like your development environment to mimic production with complete Host blocking, SSL redirects, and STS headers, set this to true. Default if false.
	DisableProdCheck bool
}

type StaticOpt struct {
	Path        string `json:"Path"`        //静态目录的路径
	Prefix      string `json:"Prefix"`      //此目录在url中的前缀，如果不设置则为/
	SkipLogging bool   `json:"SkipLogging"` //默认在DEV,TEST模式下为false,在PROD模式下为true. 是否跳过log输出
	IndexFile   string `json:"IndexFile"`   //如果指定，则以此文件为索引文件
}

type StaticOptions struct {
	// Prefix is the optional prefix used to serve the static directory content
	Prefix string
	// SkipLogging will disable [Static] log messages when a static file is served.
	SkipLogging bool
	// IndexFile defines which file to serve as index if it exists.
	IndexFile string
	// Expires defines which user-defined function to use for producing a HTTP Expires Header
	// https://developers.google.com/speed/docs/insights/LeverageBrowserCaching
	Expires func() string
	// FileSystem is the interface for supporting any implmentation of file system.
	FileSystem http.FileSystem
}

type SubConfig map[string]interface{}

type TemplateFile interface {
	Name() string
	Data() []byte
	Ext() string
}

type TemplateFileSystem interface {
	ListFiles() []TemplateFile
}

type TmplOpt struct {
	Enable          bool     `json:"Enable"`          //是否启动模板引擎，默认为false
	Directory       string   `json:"Directory"`       //模板文件目录，默认为 "views"
	Extensions      []string `json:"Extensions"`      //模板文件后缀，默认为 [".tmpl", ".html"]
	Delims          []string `json:"Delims"`          //模板语法分隔符，默认为 ["{{", "}}"]
	Charset         string   `json:"Charset"`         //追加的 Content-Type 头信息，默认为 "UTF-8"
	IndentJSON      bool     `json:"IndentJSON"`      //渲染具有缩进格式的 JSON，默认为不缩进
	IndentXML       bool     `json:"IndentXML"`       //渲染具有缩进格式的 XML，默认为不缩进
	HTMLContentType string   `json:"HTMLContentType"` //默认为 "text/html"
}

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

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

type TplRender struct {
	http.ResponseWriter

	Opt             *RenderOptions
	CompiledCharset string
	// contains filtered or unexported fields
}

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