config

type Amber struct {
	// Funcs for the html/template result, amber default funcs are not overrided so use it without worries
	Funcs template.FuncMap
}

type EngineType int8

type HTMLTemplate struct {
	// RequirePartials default is false
	RequirePartials bool
	// Delims
	// Left delimeter, default is {{
	Left string
	// Right delimeter, default is }}
	Right string
	// Funcs like html/template
	Funcs map[string]interface{}
	// LayoutFuncs like html/template
	// the difference from Funcs is that these funcs
	// can be used inside a layout and can override the predefined (yield,partial...) or add more custom funcs
	// these can override the Funcs inside no-layout templates also, use it when you know what you're doing
	LayoutFuncs map[string]interface{}
}

type Handlebars struct {
	// Helpers for Handlebars, you can register your own by raymond.RegisterHelper(name string, a interface{}) or RegisterHelpers(map[string]interface{})
	// or just fill this method, do not override it it is not nil by default (because of Iris' helpers (url and urlpath)
	Helpers map[string]interface{}
}

type Iris struct {

	// DisablePathCorrection corrects and redirects the requested path to the registed path
	// for example, if /home/ path is requested but no handler for this Route found,
	// then the Router checks if /home handler exists, if yes,
	// (permant)redirects the client to the correct path /home
	//
	// Default is false
	DisablePathCorrection bool

	// DisablePathEscape when is false then its escapes the path, the named parameters (if any).
	// Change to true it if you want something like this https://github.com/kataras/iris/issues/135 to work
	//
	// When do you need to Disable(true) it:
	// accepts parameters with slash '/'
	// Request: http://localhost:8080/details/Project%2FDelta
	// ctx.Param("project") returns the raw named parameter: Project%2FDelta
	// which you can escape it manually with net/url:
	// projectName, _ := url.QueryUnescape(c.Param("project").
	// Look here: https://github.com/kataras/iris/issues/135 for more
	//
	// Default is false
	DisablePathEscape bool

	// DisableBanner outputs the iris banner at startup
	//
	// Default is false
	DisableBanner bool

	// ProfilePath a the route path, set it to enable http pprof tool
	// Default is empty, if you set it to a $path, these routes will handled:
	// $path/cmdline
	// $path/profile
	// $path/symbol
	// $path/goroutine
	// $path/heap
	// $path/threadcreate
	// $path/pprof/block
	// for example if '/debug/pprof'
	// http://yourdomain:PORT/debug/pprof/
	// http://yourdomain:PORT/debug/pprof/cmdline
	// http://yourdomain:PORT/debug/pprof/profile
	// http://yourdomain:PORT/debug/pprof/symbol
	// http://yourdomain:PORT/debug/pprof/goroutine
	// http://yourdomain:PORT/debug/pprof/heap
	// http://yourdomain:PORT/debug/pprof/threadcreate
	// http://yourdomain:PORT/debug/pprof/pprof/block
	// it can be a subdomain also, for example, if 'debug.'
	// http://debug.yourdomain:PORT/
	// http://debug.yourdomain:PORT/cmdline
	// http://debug.yourdomain:PORT/profile
	// http://debug.yourdomain:PORT/symbol
	// http://debug.yourdomain:PORT/goroutine
	// http://debug.yourdomain:PORT/heap
	// http://debug.yourdomain:PORT/threadcreate
	// http://debug.yourdomain:PORT/pprof/block
	ProfilePath string

	// Logger the configuration for the logger
	// Iris logs ONLY SEMANTIC errors and the banner if enabled
	Logger Logger

	// Sessions contains the configs for sessions
	Sessions Sessions

	// Render contains the configs for template and rest configuration
	Render Render

	// Websocket contains the configs for Websocket's server integration
	Websocket *Websocket

	// Tester contains the configs for the test framework, so far we have only one because all test framework's configs are setted by the iris itself
	Tester Tester
}

type Jade HTMLTemplate

type Logger struct {
	// Out the (file) writer which the messages/logs will printed to
	// Default is os.Stdout
	Out *os.File
	// Prefix the prefix for each message
	// Default is ""
	Prefix string
	// Disabled default is false
	Disabled bool

	// ColorFgDefault the foreground color for the normal message bodies
	ColorFgDefault int
	// ColorFgInfo the foreground  color for info messages
	ColorFgInfo int
	// ColorFgSuccess the foreground color for success messages
	ColorFgSuccess int
	// ColorFgWarning the foreground color for warning messages
	ColorFgWarning int
	// ColorFgDanger the foreground color for error messages
	ColorFgDanger int
	// OtherFgColor the foreground color for the rest of the message types
	ColorFgOther int

	// ColorBgDefault the background color for the normal messages
	ColorBgDefault int
	// ColorBgInfo the background  color for info messages
	ColorBgInfo int
	// ColorBgSuccess the background color for success messages
	ColorBgSuccess int
	// ColorBgWarning the background color for warning messages
	ColorBgWarning int
	// ColorBgDanger the background color for error messages
	ColorBgDanger int
	// OtherFgColor the background color for the rest of the message types
	ColorBgOther int

	// ColorFgBanner the foreground color for the banner
	ColorFgBanner int
}

type Markdown struct {
	Sanitize bool // if true then returns safe html, default is false
}

type Pongo struct {
	// Filters for pongo2, map[name of the filter] the filter function . The filters are auto register
	Filters map[string]pongo2.FilterFunction
	// Globals share context fields between templates. https://github.com/flosch/pongo2/issues/35
	Globals map[string]interface{}
}

type Redis struct {
	// Network "tcp"
	Network string
	// Addr "127.0.0.1:6379"
	Addr string
	// Password string .If no password then no 'AUTH'. Default ""
	Password string
	// If Database is empty "" then no 'SELECT'. Default ""
	Database string
	// MaxIdle 0 no limit
	MaxIdle int
	// MaxActive 0 no limit
	MaxActive int
	// IdleTimeout  time.Duration(5) * time.Minute
	IdleTimeout time.Duration
	// Prefix "myprefix-for-this-website". Default ""
	Prefix string
	// MaxAgeSeconds how much long the redis should keep the session in seconds. Default 31556926.0 (1 year)
	MaxAgeSeconds int
}

type Render struct {
	// Template the configs for template
	Template Template
	// Rest configs for rendering.
	//
	// these options inside this config don't have any relation with the TemplateEngine
	// from github.com/kataras/iris/rest
	Rest Rest
}

type Rest struct {
	// Appends the given character set to the Content-Type header. Default is "UTF-8".
	Charset string
	// Gzip enable it if you want to render with gzip compression. Default is false
	Gzip bool
	// Outputs human readable JSON.
	IndentJSON bool
	// Outputs human readable XML. Default is false.
	IndentXML bool
	// Prefixes the JSON output with the given bytes. Default is false.
	PrefixJSON []byte
	// Prefixes the XML output with the given bytes.
	PrefixXML []byte
	// Unescape HTML characters "&<>" to their original values. Default is false.
	UnEscapeHTML bool
	// Streams JSON responses instead of marshalling prior to sending. Default is false.
	StreamingJSON bool
	// Disables automatic rendering of http.StatusInternalServerError when an error occurs. Default is false.
	DisableHTTPErrorRendering bool
	// MarkdownSanitize sanitizes the markdown. Default is false.
	MarkdownSanitize bool
}

type Server struct {
	// ListenningAddr the addr that server listens to
	ListeningAddr string
	CertFile      string
	KeyFile       string
	// Mode this is for unix only
	Mode os.FileMode
	// MaxRequestBodySize Maximum request body size.
	//
	// The server rejects requests with bodies exceeding this limit.
	//
	// By default request body size is 8MB.
	MaxRequestBodySize int

	// Per-connection buffer size for requests' reading.
	// This also limits the maximum header size.
	//
	// Increase this buffer if your clients send multi-KB RequestURIs
	// and/or multi-KB headers (for example, BIG cookies).
	//
	// Default buffer size is used if not set.
	ReadBufferSize int

	// Per-connection buffer size for responses' writing.
	//
	// Default buffer size is used if not set.
	WriteBufferSize int
	// RedirectTo, defaults to empty, set it in order to override the station's handler and redirect all requests to this address which is of form(HOST:PORT or :PORT)
	//
	// NOTE: the http status is 'StatusMovedPermanently', means one-time-redirect(the browser remembers the new addr and goes to the new address without need to request something from this server
	// which means that if you want to change this address you have to clear your browser's cache in order this to be able to change to the new addr.
	//
	// example: https://github.com/iris-contrib/examples/tree/master/multiserver_listening2
	RedirectTo string
	// Virtual If this server is not really listens to a real host, it mostly used in order to achieve testing without system modifications
	Virtual bool
}

type Sessions struct {
	// Provider string, usage iris.Config().Provider = "memory" or "redis". If you wan to customize redis then import the package, and change it's config
	Provider string
	// Cookie string, the session's client cookie name, for example: "irissessionid"
	Cookie string
	// DecodeCookie set it to true to decode the cookie key with base64 URLEncoding
	// Defaults to false
	DecodeCookie bool
	//Expires the date which the cookie must expires. Default infinitive/unlimited life
	Expires time.Time
	// GcDuration every how much duration(GcDuration) the memory should be clear for unused cookies (GcDuration)
	// for example: time.Duration(2)*time.Hour. it will check every 2 hours if cookie hasn't be used for 2 hours,
	// deletes it from memory until the user comes back, then the session continue to work as it was
	//
	// Default 2 hours
	GcDuration time.Duration

	// DisableSubdomainPersistence set it to dissallow your iris subdomains to have access to the session cookie
	// defaults to false
	DisableSubdomainPersistence bool
}

type Template struct {
	// Engine the type of template engine
	// default is DefaultEngine (HTMLEngine)
	Engine EngineType
	// Gzip enable gzip compression
	// default is false
	Gzip bool

	// IsDevelopment re-builds the templates on each request
	// default is false
	IsDevelopment bool
	// Directory the system path which the templates live
	// default is ./templates
	Directory string
	// Extensions the allowed file extension
	// default is []string{".html"}
	Extensions []string
	// ContentType is the Content-Type response header
	// default is text/html but you can change if if needed
	ContentType string
	// Charset the charset, default is UTF-8
	Charset string
	// Asset is a func which returns bytes, use it to load the templates by binary
	Asset func(name string) ([]byte, error)
	// AssetNames should returns the template filenames, look Asset
	AssetNames func() []string
	// Layout the template file ( with its extension) which is the mother of all
	// use it to have it as a root file, and include others with {{ yield }}, refer  the docs
	Layout string

	// HTMLTemplate contains specific configs for HTMLTemplate standard html/template
	HTMLTemplate HTMLTemplate
	// Jade contains specific configs for Jade
	Jade Jade
	// Pongo contains specific configs for pongo2
	Pongo Pongo
	// Markdown contains specific configs for  markdown
	// this doesn't supports Layout & binding context
	Markdown Markdown
	// Amber contains specific configs for amber
	Amber Amber
	// Handlebars contains specific configs for handlebars
	Handlebars Handlebars
}

type Tester struct {
	ListeningAddr string
	ExplicitURL   bool
	Debug         bool
}

type Websocket struct {
	// WriteTimeout time allowed to write a message to the connection.
	// Default value is 15 * time.Second
	WriteTimeout time.Duration
	// PongTimeout allowed to read the next pong message from the connection
	// Default value is 60 * time.Second
	PongTimeout time.Duration
	// PingPeriod send ping messages to the connection with this period. Must be less than PongTimeout
	// Default value is (PongTimeout * 9) / 10
	PingPeriod time.Duration
	// MaxMessageSize max message size allowed from connection
	// Default value is 1024
	MaxMessageSize int64
	// Endpoint is the path which the websocket server will listen for clients/connections
	// Default value is empty string, if you don't set it the Websocket server is disabled.
	Endpoint string
	// Headers  the response headers before upgrader
	// Default is empty
	Headers map[string]string
	// ReadBufferSize is the buffer size for the underline reader
	ReadBufferSize int
	// WriteBufferSize is the buffer size for the underline writer
	WriteBufferSize int
}