123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227 |
- package iris
- import (
- "fmt"
- "io/ioutil"
- "net"
- "os"
- "os/user"
- "path/filepath"
- "runtime"
- "strings"
- "github.com/kataras/golog"
- "github.com/kataras/iris/context"
- "github.com/kataras/iris/core/netutil"
- "github.com/BurntSushi/toml"
- "github.com/kataras/sitemap"
- "github.com/kataras/tunnel"
- "gopkg.in/yaml.v3"
- )
- const globalConfigurationKeyword = "~"
- // homeConfigurationFilename returns the physical location of the global configuration(yaml or toml) file.
- // This is useful when we run multiple iris servers that share the same
- // configuration, even with custom values at its "Other" field.
- // It will return a file location
- // which targets to $HOME or %HOMEDRIVE%+%HOMEPATH% + "iris" + the given "ext".
- func homeConfigurationFilename(ext string) string {
- return filepath.Join(homeDir(), "iris"+ext)
- }
- func homeDir() (home string) {
- u, err := user.Current()
- if u != nil && err == nil {
- home = u.HomeDir
- }
- if home == "" {
- home = os.Getenv("HOME")
- }
- if home == "" {
- if runtime.GOOS == "plan9" {
- home = os.Getenv("home")
- } else if runtime.GOOS == "windows" {
- home = os.Getenv("HOMEDRIVE") + os.Getenv("HOMEPATH")
- if home == "" {
- home = os.Getenv("USERPROFILE")
- }
- }
- }
- return
- }
- func parseYAML(filename string) (Configuration, error) {
- c := DefaultConfiguration()
- // get the abs
- // which will try to find the 'filename' from current workind dir too.
- yamlAbsPath, err := filepath.Abs(filename)
- if err != nil {
- return c, fmt.Errorf("parse yaml: %w", err)
- }
- // read the raw contents of the file
- data, err := ioutil.ReadFile(yamlAbsPath)
- if err != nil {
- return c, fmt.Errorf("parse yaml: %w", err)
- }
- // put the file's contents as yaml to the default configuration(c)
- if err := yaml.Unmarshal(data, &c); err != nil {
- return c, fmt.Errorf("parse yaml: %w", err)
- }
- return c, nil
- }
- // YAML reads Configuration from a configuration.yml file.
- //
- // Accepts the absolute path of the cfg.yml.
- // An error will be shown to the user via panic with the error message.
- // Error may occur when the cfg.yml does not exist or is not formatted correctly.
- //
- // Note: if the char '~' passed as "filename" then it tries to load and return
- // the configuration from the $home_directory + iris.yml,
- // see `WithGlobalConfiguration` for more information.
- //
- // Usage:
- // app.Configure(iris.WithConfiguration(iris.YAML("myconfig.yml"))) or
- // app.Run([iris.Runner], iris.WithConfiguration(iris.YAML("myconfig.yml"))).
- func YAML(filename string) Configuration {
- // check for globe configuration file and use that, otherwise
- // return the default configuration if file doesn't exist.
- if filename == globalConfigurationKeyword {
- filename = homeConfigurationFilename(".yml")
- if _, err := os.Stat(filename); os.IsNotExist(err) {
- panic("default configuration file '" + filename + "' does not exist")
- }
- }
- c, err := parseYAML(filename)
- if err != nil {
- panic(err)
- }
- return c
- }
- // TOML reads Configuration from a toml-compatible document file.
- // Read more about toml's implementation at:
- // https://github.com/toml-lang/toml
- //
- //
- // Accepts the absolute path of the configuration file.
- // An error will be shown to the user via panic with the error message.
- // Error may occur when the file does not exist or is not formatted correctly.
- //
- // Note: if the char '~' passed as "filename" then it tries to load and return
- // the configuration from the $home_directory + iris.tml,
- // see `WithGlobalConfiguration` for more information.
- //
- // Usage:
- // app.Configure(iris.WithConfiguration(iris.TOML("myconfig.tml"))) or
- // app.Run([iris.Runner], iris.WithConfiguration(iris.TOML("myconfig.tml"))).
- func TOML(filename string) Configuration {
- c := DefaultConfiguration()
- // check for globe configuration file and use that, otherwise
- // return the default configuration if file doesn't exist.
- if filename == globalConfigurationKeyword {
- filename = homeConfigurationFilename(".tml")
- if _, err := os.Stat(filename); os.IsNotExist(err) {
- panic("default configuration file '" + filename + "' does not exist")
- }
- }
- // get the abs
- // which will try to find the 'filename' from current workind dir too.
- tomlAbsPath, err := filepath.Abs(filename)
- if err != nil {
- panic(fmt.Errorf("toml: %w", err))
- }
- // read the raw contents of the file
- data, err := ioutil.ReadFile(tomlAbsPath)
- if err != nil {
- panic(fmt.Errorf("toml :%w", err))
- }
- // put the file's contents as toml to the default configuration(c)
- if _, err := toml.Decode(string(data), &c); err != nil {
- panic(fmt.Errorf("toml :%w", err))
- }
- // Author's notes:
- // The toml's 'usual thing' for key naming is: the_config_key instead of TheConfigKey
- // but I am always prefer to use the specific programming language's syntax
- // and the original configuration name fields for external configuration files
- // so we do 'toml: "TheConfigKeySameAsTheConfigField" instead.
- return c
- }
- // Configurator is just an interface which accepts the framework instance.
- //
- // It can be used to register a custom configuration with `Configure` in order
- // to modify the framework instance.
- //
- // Currently Configurator is being used to describe the configuration's fields values.
- type Configurator func(*Application)
- // WithGlobalConfiguration will load the global yaml configuration file
- // from the home directory and it will set/override the whole app's configuration
- // to that file's contents. The global configuration file can be modified by user
- // and be used by multiple iris instances.
- //
- // This is useful when we run multiple iris servers that share the same
- // configuration, even with custom values at its "Other" field.
- //
- // Usage: `app.Configure(iris.WithGlobalConfiguration)` or `app.Run([iris.Runner], iris.WithGlobalConfiguration)`.
- var WithGlobalConfiguration = func(app *Application) {
- app.Configure(WithConfiguration(YAML(globalConfigurationKeyword)))
- }
- // WithLogLevel sets the `Configuration.LogLevel` field.
- func WithLogLevel(level string) Configurator {
- return func(app *Application) {
- if app.logger == nil {
- app.logger = golog.Default
- }
- app.logger.SetLevel(level) // can be fired through app.Configure.
- app.config.LogLevel = level
- }
- }
- // WithSocketSharding sets the `Configuration.SocketSharding` field to true.
- func WithSocketSharding(app *Application) {
- // Note(@kataras): It could be a host Configurator but it's an application setting in order
- // to configure it through yaml/toml files as well.
- app.config.SocketSharding = true
- }
- // WithoutServerError will cause to ignore the matched "errors"
- // from the main application's `Run/Listen` function.
- //
- // Usage:
- // err := app.Listen(":8080", iris.WithoutServerError(iris.ErrServerClosed))
- // will return `nil` if the server's error was `http/iris#ErrServerClosed`.
- //
- // See `Configuration#IgnoreServerErrors []string` too.
- //
- // Example: https://github.com/kataras/iris/tree/master/_examples/http-server/listen-addr/omit-server-errors
- func WithoutServerError(errors ...error) Configurator {
- return func(app *Application) {
- if len(errors) == 0 {
- return
- }
- errorsAsString := make([]string, len(errors))
- for i, e := range errors {
- errorsAsString[i] = e.Error()
- }
- app.config.IgnoreServerErrors = append(app.config.IgnoreServerErrors, errorsAsString...)
- }
- }
- // WithoutStartupLog turns off the information send, once, to the terminal when the main server is open.
- var WithoutStartupLog = func(app *Application) {
- app.config.DisableStartupLog = true
- }
- // WithoutBanner is a conversion for the `WithoutStartupLog` option.
- //
- // Turns off the information send, once, to the terminal when the main server is open.
- var WithoutBanner = WithoutStartupLog
- // WithoutInterruptHandler disables the automatic graceful server shutdown
- // when control/cmd+C pressed.
- var WithoutInterruptHandler = func(app *Application) {
- app.config.DisableInterruptHandler = true
- }
- // WithoutPathCorrection disables the PathCorrection setting.
- //
- // See `Configuration`.
- var WithoutPathCorrection = func(app *Application) {
- app.config.DisablePathCorrection = true
- }
- // WithPathIntelligence enables the EnablePathIntelligence setting.
- //
- // See `Configuration`.
- var WithPathIntelligence = func(app *Application) {
- app.config.EnablePathIntelligence = true
- }
- // WithoutPathCorrectionRedirection disables the PathCorrectionRedirection setting.
- //
- // See `Configuration`.
- var WithoutPathCorrectionRedirection = func(app *Application) {
- app.config.DisablePathCorrection = false
- app.config.DisablePathCorrectionRedirection = true
- }
- // WithoutBodyConsumptionOnUnmarshal disables BodyConsumptionOnUnmarshal setting.
- //
- // See `Configuration`.
- var WithoutBodyConsumptionOnUnmarshal = func(app *Application) {
- app.config.DisableBodyConsumptionOnUnmarshal = true
- }
- // WithEmptyFormError enables the setting `FireEmptyFormError`.
- //
- // See `Configuration`.
- var WithEmptyFormError = func(app *Application) {
- app.config.FireEmptyFormError = true
- }
- // WithPathEscape sets the EnablePathEscape setting to true.
- //
- // See `Configuration`.
- var WithPathEscape = func(app *Application) {
- app.config.EnablePathEscape = true
- }
- // WithLowercaseRouting enables for lowercase routing by
- // setting the `ForceLowercaseRoutes` to true.
- //
- // See `Configuration`.
- var WithLowercaseRouting = func(app *Application) {
- app.config.ForceLowercaseRouting = true
- }
- // WithOptimizations can force the application to optimize for the best performance where is possible.
- //
- // See `Configuration`.
- var WithOptimizations = func(app *Application) {
- app.config.EnableOptimizations = true
- }
- // WithFireMethodNotAllowed enables the FireMethodNotAllowed setting.
- //
- // See `Configuration`.
- var WithFireMethodNotAllowed = func(app *Application) {
- app.config.FireMethodNotAllowed = true
- }
- // WithoutAutoFireStatusCode sets the DisableAutoFireStatusCode setting to true.
- //
- // See `Configuration`.
- var WithoutAutoFireStatusCode = func(app *Application) {
- app.config.DisableAutoFireStatusCode = true
- }
- // WithResetOnFireErrorCode sets the ResetOnFireErrorCode setting to true.
- //
- // See `Configuration`.
- var WithResetOnFireErrorCode = func(app *Application) {
- app.config.ResetOnFireErrorCode = true
- }
- // WithTimeFormat sets the TimeFormat setting.
- //
- // See `Configuration`.
- func WithTimeFormat(timeformat string) Configurator {
- return func(app *Application) {
- app.config.TimeFormat = timeformat
- }
- }
- // WithCharset sets the Charset setting.
- //
- // See `Configuration`.
- func WithCharset(charset string) Configurator {
- return func(app *Application) {
- app.config.Charset = charset
- }
- }
- // WithPostMaxMemory sets the maximum post data size
- // that a client can send to the server, this differs
- // from the overral request body size which can be modified
- // by the `context#SetMaxRequestBodySize` or `iris#LimitRequestBodySize`.
- //
- // Defaults to 32MB or 32 << 20 or 32*iris.MB if you prefer.
- func WithPostMaxMemory(limit int64) Configurator {
- return func(app *Application) {
- app.config.PostMaxMemory = limit
- }
- }
- // WithRemoteAddrHeader adds a new request header name
- // that can be used to validate the client's real IP.
- func WithRemoteAddrHeader(header ...string) Configurator {
- return func(app *Application) {
- for _, h := range header {
- exists := false
- for _, v := range app.config.RemoteAddrHeaders {
- if v == h {
- exists = true
- }
- }
- if !exists {
- app.config.RemoteAddrHeaders = append(app.config.RemoteAddrHeaders, h)
- }
- }
- }
- }
- // WithoutRemoteAddrHeader removes an existing request header name
- // that can be used to validate and parse the client's real IP.
- //
- // Look `context.RemoteAddr()` for more.
- func WithoutRemoteAddrHeader(headerName string) Configurator {
- return func(app *Application) {
- tmp := app.config.RemoteAddrHeaders[:0]
- for _, v := range app.config.RemoteAddrHeaders {
- if v != headerName {
- tmp = append(tmp, v)
- }
- }
- app.config.RemoteAddrHeaders = tmp
- }
- }
- // WithRemoteAddrPrivateSubnet adds a new private sub-net to be excluded from `context.RemoteAddr`.
- // See `WithRemoteAddrHeader` too.
- func WithRemoteAddrPrivateSubnet(startIP, endIP string) Configurator {
- return func(app *Application) {
- app.config.RemoteAddrPrivateSubnets = append(app.config.RemoteAddrPrivateSubnets, netutil.IPRange{
- Start: net.ParseIP(startIP),
- End: net.ParseIP(endIP),
- })
- }
- }
- // WithSSLProxyHeader sets a SSLProxyHeaders key value pair.
- // Example: WithSSLProxyHeader("X-Forwarded-Proto", "https").
- // See `Context.IsSSL` for more.
- func WithSSLProxyHeader(headerKey, headerValue string) Configurator {
- return func(app *Application) {
- if app.config.SSLProxyHeaders == nil {
- app.config.SSLProxyHeaders = make(map[string]string)
- }
- app.config.SSLProxyHeaders[headerKey] = headerValue
- }
- }
- // WithHostProxyHeader sets a HostProxyHeaders key value pair.
- // Example: WithHostProxyHeader("X-Host").
- // See `Context.Host` for more.
- func WithHostProxyHeader(headers ...string) Configurator {
- return func(app *Application) {
- if app.config.HostProxyHeaders == nil {
- app.config.HostProxyHeaders = make(map[string]bool)
- }
- for _, k := range headers {
- app.config.HostProxyHeaders[k] = true
- }
- }
- }
- // WithOtherValue adds a value based on a key to the Other setting.
- //
- // See `Configuration.Other`.
- func WithOtherValue(key string, val interface{}) Configurator {
- return func(app *Application) {
- if app.config.Other == nil {
- app.config.Other = make(map[string]interface{})
- }
- app.config.Other[key] = val
- }
- }
- // WithSitemap enables the sitemap generator.
- // Use the Route's `SetLastMod`, `SetChangeFreq` and `SetPriority` to modify
- // the sitemap's URL child element properties.
- //
- // It accepts a "startURL" input argument which
- // is the prefix for the registered routes that will be included in the sitemap.
- //
- // If more than 50,000 static routes are registered then sitemaps will be splitted and a sitemap index will be served in
- // /sitemap.xml.
- //
- // If `Application.I18n.Load/LoadAssets` is called then the sitemap will contain translated links for each static route.
- //
- // If the result does not complete your needs you can take control
- // and use the github.com/kataras/sitemap package to generate a customized one instead.
- //
- // Example: https://github.com/kataras/iris/tree/master/_examples/sitemap.
- func WithSitemap(startURL string) Configurator {
- sitemaps := sitemap.New(startURL)
- return func(app *Application) {
- var defaultLang string
- if tags := app.I18n.Tags(); len(tags) > 0 {
- defaultLang = tags[0].String()
- sitemaps.DefaultLang(defaultLang)
- }
- for _, r := range app.GetRoutes() {
- if !r.IsStatic() || r.Subdomain != "" {
- continue
- }
- loc := r.StaticPath()
- var translatedLinks []sitemap.Link
- for _, tag := range app.I18n.Tags() {
- lang := tag.String()
- langPath := lang
- href := ""
- if lang == defaultLang {
- // http://domain.com/en-US/path to just http://domain.com/path if en-US is the default language.
- langPath = ""
- }
- if app.I18n.PathRedirect {
- // then use the path prefix.
- // e.g. http://domain.com/el-GR/path
- if langPath == "" { // fix double slashes http://domain.com// when self-included default language.
- href = loc
- } else {
- href = "/" + langPath + loc
- }
- } else if app.I18n.Subdomain {
- // then use the subdomain.
- // e.g. http://el.domain.com/path
- scheme := netutil.ResolveSchemeFromVHost(startURL)
- host := strings.TrimLeft(startURL, scheme)
- if langPath != "" {
- href = scheme + strings.Split(langPath, "-")[0] + "." + host + loc
- } else {
- href = loc
- }
- } else if p := app.I18n.URLParameter; p != "" {
- // then use the URL parameter.
- // e.g. http://domain.com/path?lang=el-GR
- href = loc + "?" + p + "=" + lang
- } else {
- // then skip it, we can't generate the link at this state.
- continue
- }
- translatedLinks = append(translatedLinks, sitemap.Link{
- Rel: "alternate",
- Hreflang: lang,
- Href: href,
- })
- }
- sitemaps.URL(sitemap.URL{
- Loc: loc,
- LastMod: r.LastMod,
- ChangeFreq: r.ChangeFreq,
- Priority: r.Priority,
- Links: translatedLinks,
- })
- }
- for _, s := range sitemaps.Build() {
- contentCopy := make([]byte, len(s.Content))
- copy(contentCopy, s.Content)
- handler := func(ctx Context) {
- ctx.ContentType(context.ContentXMLHeaderValue)
- ctx.Write(contentCopy) // nolint:errcheck
- }
- if app.builded {
- routes := app.CreateRoutes([]string{MethodGet, MethodHead, MethodOptions}, s.Path, handler)
- for _, r := range routes {
- if err := app.Router.AddRouteUnsafe(r); err != nil {
- app.Logger().Errorf("sitemap route: %v", err)
- }
- }
- } else {
- app.HandleMany("GET HEAD OPTIONS", s.Path, handler)
- }
- }
- }
- }
- // WithTunneling is the `iris.Configurator` for the `iris.Configuration.Tunneling` field.
- // It's used to enable http tunneling for an Iris Application, per registered host
- //
- // Alternatively use the `iris.WithConfiguration(iris.Configuration{Tunneling: iris.TunnelingConfiguration{ ...}}}`.
- var WithTunneling = func(app *Application) {
- conf := TunnelingConfiguration{
- Tunnels: []Tunnel{{}}, // create empty tunnel, its addr and name are set right before host serve.
- }
- app.config.Tunneling = conf
- }
- type (
- // TunnelingConfiguration contains configuration
- // for the optional tunneling through ngrok feature.
- // Note that the ngrok should be already installed at the host machine.
- TunnelingConfiguration = tunnel.Configuration
- // Tunnel is the Tunnels field of the TunnelingConfiguration structure.
- Tunnel = tunnel.Tunnel
- )
- // Configuration holds the necessary settings for an Iris Application instance.
- // All fields are optionally, the default values will work for a common web application.
- //
- // A Configuration value can be passed through `WithConfiguration` Configurator.
- // Usage:
- // conf := iris.Configuration{ ... }
- // app := iris.New()
- // app.Configure(iris.WithConfiguration(conf)) OR
- // app.Run/Listen(..., iris.WithConfiguration(conf)).
- type Configuration struct {
- // vhost is private and set only with .Run/Listen methods, it cannot be changed after the first set.
- // It can be retrieved by the context if needed (i.e router for subdomains)
- vhost string
- // LogLevel is the log level the application should use to output messages.
- // Logger, by default, is mostly used on Build state but it is also possible
- // that debug error messages could be thrown when the app is running, e.g.
- // when malformed data structures try to be sent on Client (i.e Context.JSON/JSONP/XML...).
- //
- // Defaults to "info". Possible values are:
- // * "disable"
- // * "fatal"
- // * "error"
- // * "warn"
- // * "info"
- // * "debug"
- LogLevel string `json:"logLevel" yaml:"LogLevel" toml:"LogLevel" env:"LOG_LEVEL"`
- // SocketSharding enables SO_REUSEPORT (or SO_REUSEADDR for windows)
- // on all registered Hosts.
- // This option allows linear scaling server performance on multi-CPU servers.
- //
- // Please read the following:
- // 1. https://stackoverflow.com/a/14388707
- // 2. https://stackoverflow.com/a/59692868
- // 3. https://www.nginx.com/blog/socket-sharding-nginx-release-1-9-1/
- // 4. (BOOK) Learning HTTP/2: A Practical Guide for Beginners:
- // Page 37, To Shard or Not to Shard?
- //
- // Defaults to false.
- SocketSharding bool `json:"socketSharding" yaml:"SocketSharding" toml:"SocketSharding" env:"SOCKET_SHARDING"`
- // Tunneling can be optionally set to enable ngrok http(s) tunneling for this Iris app instance.
- // See the `WithTunneling` Configurator too.
- Tunneling TunnelingConfiguration `json:"tunneling,omitempty" yaml:"Tunneling" toml:"Tunneling"`
- // IgnoreServerErrors will cause to ignore the matched "errors"
- // from the main application's `Run` function.
- // This is a slice of string, not a slice of error
- // users can register these errors using yaml or toml configuration file
- // like the rest of the configuration fields.
- //
- // See `WithoutServerError(...)` function too.
- //
- // Example: https://github.com/kataras/iris/tree/master/_examples/http-server/listen-addr/omit-server-errors
- //
- // Defaults to an empty slice.
- IgnoreServerErrors []string `json:"ignoreServerErrors,omitempty" yaml:"IgnoreServerErrors" toml:"IgnoreServerErrors"`
- // DisableStartupLog if set to true then it turns off the write banner on server startup.
- //
- // Defaults to false.
- DisableStartupLog bool `json:"disableStartupLog,omitempty" yaml:"DisableStartupLog" toml:"DisableStartupLog"`
- // DisableInterruptHandler if set to true then it disables the automatic graceful server shutdown
- // when control/cmd+C pressed.
- // Turn this to true if you're planning to handle this by your own via a custom host.Task.
- //
- // Defaults to false.
- DisableInterruptHandler bool `json:"disableInterruptHandler,omitempty" yaml:"DisableInterruptHandler" toml:"DisableInterruptHandler"`
- // DisablePathCorrection disables the correcting
- // and redirecting or executing directly the handler of
- // the requested path to the registered 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,
- // (permanent)redirects the client to the correct path /home.
- //
- // See `DisablePathCorrectionRedirection` to enable direct handler execution instead of redirection.
- //
- // Defaults to false.
- DisablePathCorrection bool `json:"disablePathCorrection,omitempty" yaml:"DisablePathCorrection" toml:"DisablePathCorrection"`
- // DisablePathCorrectionRedirection works whenever configuration.DisablePathCorrection is set to false
- // and if DisablePathCorrectionRedirection set to true then it will fire the handler of the matching route without
- // the trailing slash ("/") instead of send a redirection status.
- //
- // Defaults to false.
- DisablePathCorrectionRedirection bool `json:"disablePathCorrectionRedirection,omitempty" yaml:"DisablePathCorrectionRedirection" toml:"DisablePathCorrectionRedirection"`
- // EnablePathIntelligence if set to true,
- // the router will redirect HTTP "GET" not found pages to the most closest one path(if any). For example
- // you register a route at "/contact" path -
- // a client tries to reach it by "/cont", the path will be automatic fixed
- // and the client will be redirected to the "/contact" path
- // instead of getting a 404 not found response back.
- //
- // Defaults to false.
- EnablePathIntelligence bool `json:"enablePathIntelligence,omitempty" yaml:"EnablePathIntelligence" toml:"EnablePathIntelligence"`
- // EnablePathEscape when is true then its escapes the path and the named parameters (if any).
- // When do you need to Disable(false) 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").
- //
- // Defaults to false.
- EnablePathEscape bool `json:"enablePathEscape,omitempty" yaml:"EnablePathEscape" toml:"EnablePathEscape"`
- // ForceLowercaseRouting if enabled, converts all registered routes paths to lowercase
- // and it does lowercase the request path too for matching.
- //
- // Defaults to false.
- ForceLowercaseRouting bool `json:"forceLowercaseRouting,omitempty" yaml:"ForceLowercaseRouting" toml:"ForceLowercaseRouting"`
- // FireMethodNotAllowed if it's true router checks for StatusMethodNotAllowed(405) and
- // fires the 405 error instead of 404
- // Defaults to false.
- FireMethodNotAllowed bool `json:"fireMethodNotAllowed,omitempty" yaml:"FireMethodNotAllowed" toml:"FireMethodNotAllowed"`
- // DisableAutoFireStatusCode if true then it turns off the http error status code
- // handler automatic execution on error code from a `Context.StatusCode` call.
- // By-default a custom http error handler will be fired when "Context.StatusCode(errorCode)" called.
- //
- // Defaults to false.
- DisableAutoFireStatusCode bool `json:"disableAutoFireStatusCode,omitempty" yaml:"DisableAutoFireStatusCode" toml:"DisableAutoFireStatusCode"`
- // ResetOnFireErrorCode if true then any previously response body or headers through
- // response recorder will be ignored and the router
- // will fire the registered (or default) HTTP error handler instead.
- // See `core/router/handler#FireErrorCode` and `Context.EndRequest` for more details.
- //
- // Read more at: https://github.com/kataras/iris/issues/1531
- //
- // Defaults to false.
- ResetOnFireErrorCode bool `json:"resetOnFireErrorCode,omitempty" yaml:"ResetOnFireErrorCode" toml:"ResetOnFireErrorCode"`
- // EnableOptimization when this field is true
- // then the application tries to optimize for the best performance where is possible.
- //
- // Defaults to false.
- EnableOptimizations bool `json:"enableOptimizations,omitempty" yaml:"EnableOptimizations" toml:"EnableOptimizations"`
- // DisableBodyConsumptionOnUnmarshal manages the reading behavior of the context's body readers/binders.
- // If set to true then it
- // disables the body consumption by the `context.UnmarshalBody/ReadJSON/ReadXML`.
- //
- // By-default io.ReadAll` is used to read the body from the `context.Request.Body which is an `io.ReadCloser`,
- // if this field set to true then a new buffer will be created to read from and the request body.
- // The body will not be changed and existing data before the
- // context.UnmarshalBody/ReadJSON/ReadXML will be not consumed.
- DisableBodyConsumptionOnUnmarshal bool `json:"disableBodyConsumptionOnUnmarshal,omitempty" yaml:"DisableBodyConsumptionOnUnmarshal" toml:"DisableBodyConsumptionOnUnmarshal"`
- // FireEmptyFormError returns if set to tue true then the `context.ReadBody/ReadForm`
- // will return an `iris.ErrEmptyForm` on empty request form data.
- FireEmptyFormError bool `json:"fireEmptyFormError,omitempty" yaml:"FireEmptyFormError" toml:"FireEmptyFormError"`
- // TimeFormat time format for any kind of datetime parsing
- // Defaults to "Mon, 02 Jan 2006 15:04:05 GMT".
- TimeFormat string `json:"timeFormat,omitempty" yaml:"TimeFormat" toml:"TimeFormat"`
- // Charset character encoding for various rendering
- // used for templates and the rest of the responses
- // Defaults to "utf-8".
- Charset string `json:"charset,omitempty" yaml:"Charset" toml:"Charset"`
- // PostMaxMemory sets the maximum post data size
- // that a client can send to the server, this differs
- // from the overral request body size which can be modified
- // by the `context#SetMaxRequestBodySize` or `iris#LimitRequestBodySize`.
- //
- // Defaults to 32MB or 32 << 20 if you prefer.
- PostMaxMemory int64 `json:"postMaxMemory" yaml:"PostMaxMemory" toml:"PostMaxMemory"`
- // +----------------------------------------------------+
- // | Context's keys for values used on various featuers |
- // +----------------------------------------------------+
- // Context values' keys for various features.
- //
- // LocaleContextKey is used by i18n to get the current request's locale, which contains a translate function too.
- //
- // Defaults to "iris.locale".
- LocaleContextKey string `json:"localeContextKey,omitempty" yaml:"LocaleContextKey" toml:"LocaleContextKey"`
- // LanguageContextKey is the context key which a language can be modified by a middleware.
- // It has the highest priority over the rest and if it is empty then it is ignored,
- // if it set to a static string of "default" or to the default language's code
- // then the rest of the language extractors will not be called at all and
- // the default language will be set instead.
- //
- // Use with `Context.SetLanguage("el-GR")`.
- //
- // See `i18n.ExtractFunc` for a more organised way of the same feature.
- // Defaults to "iris.locale.language".
- LanguageContextKey string `json:"languageContextKey,omitempty" yaml:"LanguageContextKey" toml:"LanguageContextKey"`
- // VersionContextKey is the context key which an API Version can be modified
- // via a middleware through `SetVersion` method, e.g. `versioning.SetVersion(ctx, "1.0, 1.1")`.
- // Defaults to "iris.api.version".
- VersionContextKey string `json:"versionContextKey" yaml:"VersionContextKey" toml:"VersionContextKey"`
- // ViewEngineContextKey is the context's values key
- // responsible to store and retrieve(view.Engine) the current view engine.
- // A middleware or a Party can modify its associated value to change
- // a view engine that `ctx.View` will render through.
- // If not an engine is registered by the end-developer
- // then its associated value is always nil,
- // meaning that the default value is nil.
- // See `Party.RegisterView` and `Context.ViewEngine` methods as well.
- //
- // Defaults to "iris.view.engine".
- ViewEngineContextKey string `json:"viewEngineContextKey,omitempty" yaml:"ViewEngineContextKey" toml:"ViewEngineContextKey"`
- // ViewLayoutContextKey is the context's values key
- // responsible to store and retrieve(string) the current view layout.
- // A middleware can modify its associated value to change
- // the layout that `ctx.View` will use to render a template.
- //
- // Defaults to "iris.view.layout".
- ViewLayoutContextKey string `json:"viewLayoutContextKey,omitempty" yaml:"ViewLayoutContextKey" toml:"ViewLayoutContextKey"`
- // ViewDataContextKey is the context's values key
- // responsible to store and retrieve(interface{}) the current view binding data.
- // A middleware can modify its associated value to change
- // the template's data on-fly.
- //
- // Defaults to "iris.view.data".
- ViewDataContextKey string `json:"viewDataContextKey,omitempty" yaml:"ViewDataContextKey" toml:"ViewDataContextKey"`
- // RemoteAddrHeaders are the allowed request headers names
- // that can be valid to parse the client's IP based on.
- // By-default no "X-" header is consired safe to be used for retrieving the
- // client's IP address, because those headers can manually change by
- // the client. But sometimes are useful e.g. when behind a proxy
- // you want to enable the "X-Forwarded-For" or when cloudflare
- // you want to enable the "CF-Connecting-IP", indeed you
- // can allow the `ctx.RemoteAddr()` to use any header
- // that the client may sent.
- //
- // Defaults to an empty slice but an example usage is:
- // RemoteAddrHeaders {
- // "X-Real-Ip",
- // "X-Forwarded-For",
- // "CF-Connecting-IP",
- // }
- //
- // Look `context.RemoteAddr()` for more.
- RemoteAddrHeaders []string `json:"remoteAddrHeaders,omitempty" yaml:"RemoteAddrHeaders" toml:"RemoteAddrHeaders"`
- // RemoteAddrHeadersForce forces the `Context.RemoteAddr()` method
- // to return the first entry of a request header as a fallback,
- // even if that IP is a part of the `RemoteAddrPrivateSubnets` list.
- // The default behavior, if a remote address is part of the `RemoteAddrPrivateSubnets`,
- // is to retrieve the IP from the `Request.RemoteAddr` field instead.
- RemoteAddrHeadersForce bool `json:"remoteAddrHeadersForce,omitempty" yaml:"RemoteAddrHeadersForce" toml:"RemoteAddrHeadersForce"`
- // RemoteAddrPrivateSubnets defines the private sub-networks.
- // They are used to be compared against
- // IP Addresses fetched through `RemoteAddrHeaders` or `Context.Request.RemoteAddr`.
- // For details please navigate through: https://github.com/kataras/iris/issues/1453
- // Defaults to:
- // {
- // Start: net.ParseIP("10.0.0.0"),
- // End: net.ParseIP("10.255.255.255"),
- // },
- // {
- // Start: net.ParseIP("100.64.0.0"),
- // End: net.ParseIP("100.127.255.255"),
- // },
- // {
- // Start: net.ParseIP("172.16.0.0"),
- // End: net.ParseIP("172.31.255.255"),
- // },
- // {
- // Start: net.ParseIP("192.0.0.0"),
- // End: net.ParseIP("192.0.0.255"),
- // },
- // {
- // Start: net.ParseIP("192.168.0.0"),
- // End: net.ParseIP("192.168.255.255"),
- // },
- // {
- // Start: net.ParseIP("198.18.0.0"),
- // End: net.ParseIP("198.19.255.255"),
- // }
- //
- // Look `Context.RemoteAddr()` for more.
- RemoteAddrPrivateSubnets []netutil.IPRange `json:"remoteAddrPrivateSubnets" yaml:"RemoteAddrPrivateSubnets" toml:"RemoteAddrPrivateSubnets"`
- // SSLProxyHeaders defines the set of header key values
- // that would indicate a valid https Request (look `Context.IsSSL()`).
- // Example: `map[string]string{"X-Forwarded-Proto": "https"}`.
- //
- // Defaults to empty map.
- SSLProxyHeaders map[string]string `json:"sslProxyHeaders" yaml:"SSLProxyHeaders" toml:"SSLProxyHeaders"`
- // HostProxyHeaders defines the set of headers that may hold a proxied hostname value for the clients.
- // Look `Context.Host()` for more.
- // Defaults to empty map.
- HostProxyHeaders map[string]bool `json:"hostProxyHeaders" yaml:"HostProxyHeaders" toml:"HostProxyHeaders"`
- // Other are the custom, dynamic options, can be empty.
- // This field used only by you to set any app's options you want.
- //
- // Defaults to empty map.
- Other map[string]interface{} `json:"other,omitempty" yaml:"Other" toml:"Other"`
- }
- var _ context.ConfigurationReadOnly = &Configuration{}
- // GetVHost returns the non-exported vhost config field.
- func (c Configuration) GetVHost() string {
- return c.vhost
- }
- // GetLogLevel returns the LogLevel field.
- func (c Configuration) GetLogLevel() string {
- return c.vhost
- }
- // GetSocketSharding returns the SocketSharding field.
- func (c Configuration) GetSocketSharding() bool {
- return c.SocketSharding
- }
- // GetDisablePathCorrection returns the DisablePathCorrection field.
- func (c Configuration) GetDisablePathCorrection() bool {
- return c.DisablePathCorrection
- }
- // GetDisablePathCorrectionRedirection returns the DisablePathCorrectionRedirection field.
- func (c Configuration) GetDisablePathCorrectionRedirection() bool {
- return c.DisablePathCorrectionRedirection
- }
- // GetEnablePathIntelligence returns the EnablePathIntelligence field.
- func (c Configuration) GetEnablePathIntelligence() bool {
- return c.EnablePathIntelligence
- }
- // GetEnablePathEscape returns the EnablePathEscape field.
- func (c Configuration) GetEnablePathEscape() bool {
- return c.EnablePathEscape
- }
- // GetForceLowercaseRouting returns the ForceLowercaseRouting field.
- func (c Configuration) GetForceLowercaseRouting() bool {
- return c.ForceLowercaseRouting
- }
- // GetFireMethodNotAllowed returns the FireMethodNotAllowed field.
- func (c Configuration) GetFireMethodNotAllowed() bool {
- return c.FireMethodNotAllowed
- }
- // GetEnableOptimizations returns the EnableOptimizations.
- func (c Configuration) GetEnableOptimizations() bool {
- return c.EnableOptimizations
- }
- // GetDisableBodyConsumptionOnUnmarshal returns the DisableBodyConsumptionOnUnmarshal field.
- func (c Configuration) GetDisableBodyConsumptionOnUnmarshal() bool {
- return c.DisableBodyConsumptionOnUnmarshal
- }
- // GetFireEmptyFormError returns the DisableBodyConsumptionOnUnmarshal field.
- func (c Configuration) GetFireEmptyFormError() bool {
- return c.FireEmptyFormError
- }
- // GetDisableAutoFireStatusCode returns the DisableAutoFireStatusCode field.
- func (c Configuration) GetDisableAutoFireStatusCode() bool {
- return c.DisableAutoFireStatusCode
- }
- // GetResetOnFireErrorCode returns ResetOnFireErrorCode field.
- func (c Configuration) GetResetOnFireErrorCode() bool {
- return c.ResetOnFireErrorCode
- }
- // GetTimeFormat returns the TimeFormat field.
- func (c Configuration) GetTimeFormat() string {
- return c.TimeFormat
- }
- // GetCharset returns the Charset field.
- func (c Configuration) GetCharset() string {
- return c.Charset
- }
- // GetPostMaxMemory returns the PostMaxMemory field.
- func (c Configuration) GetPostMaxMemory() int64 {
- return c.PostMaxMemory
- }
- // GetLocaleContextKey returns the LocaleContextKey field.
- func (c Configuration) GetLocaleContextKey() string {
- return c.LocaleContextKey
- }
- // GetLanguageContextKey returns the LanguageContextKey field.
- func (c Configuration) GetLanguageContextKey() string {
- return c.LanguageContextKey
- }
- // GetVersionContextKey returns the VersionContextKey field.
- func (c Configuration) GetVersionContextKey() string {
- return c.VersionContextKey
- }
- // GetViewEngineContextKey returns the ViewEngineContextKey field.
- func (c Configuration) GetViewEngineContextKey() string {
- return c.ViewEngineContextKey
- }
- // GetViewLayoutContextKey returns the ViewLayoutContextKey field.
- func (c Configuration) GetViewLayoutContextKey() string {
- return c.ViewLayoutContextKey
- }
- // GetViewDataContextKey returns the ViewDataContextKey field.
- func (c Configuration) GetViewDataContextKey() string {
- return c.ViewDataContextKey
- }
- // GetRemoteAddrHeaders returns the RemoteAddrHeaders field.
- func (c Configuration) GetRemoteAddrHeaders() []string {
- return c.RemoteAddrHeaders
- }
- // GetRemoteAddrHeadersForce returns RemoteAddrHeadersForce field.
- func (c Configuration) GetRemoteAddrHeadersForce() bool {
- return c.RemoteAddrHeadersForce
- }
- // GetSSLProxyHeaders returns the SSLProxyHeaders field.
- func (c Configuration) GetSSLProxyHeaders() map[string]string {
- return c.SSLProxyHeaders
- }
- // GetRemoteAddrPrivateSubnets returns the RemoteAddrPrivateSubnets field.
- func (c Configuration) GetRemoteAddrPrivateSubnets() []netutil.IPRange {
- return c.RemoteAddrPrivateSubnets
- }
- // GetHostProxyHeaders returns the HostProxyHeaders field.
- func (c Configuration) GetHostProxyHeaders() map[string]bool {
- return c.HostProxyHeaders
- }
- // GetOther returns the Other field.
- func (c Configuration) GetOther() map[string]interface{} {
- return c.Other
- }
- // WithConfiguration sets the "c" values to the framework's configurations.
- //
- // Usage:
- // app.Listen(":8080", iris.WithConfiguration(iris.Configuration{/* fields here */ }))
- // or
- // iris.WithConfiguration(iris.YAML("./cfg/iris.yml"))
- // or
- // iris.WithConfiguration(iris.TOML("./cfg/iris.tml"))
- func WithConfiguration(c Configuration) Configurator {
- return func(app *Application) {
- main := app.config
- if main == nil {
- app.config = &c
- return
- }
- if v := c.LogLevel; v != "" {
- main.LogLevel = v
- }
- if v := c.SocketSharding; v {
- main.SocketSharding = v
- }
- if len(c.Tunneling.Tunnels) > 0 {
- main.Tunneling = c.Tunneling
- }
- if v := c.IgnoreServerErrors; len(v) > 0 {
- main.IgnoreServerErrors = append(main.IgnoreServerErrors, v...)
- }
- if v := c.DisableStartupLog; v {
- main.DisableStartupLog = v
- }
- if v := c.DisableInterruptHandler; v {
- main.DisableInterruptHandler = v
- }
- if v := c.DisablePathCorrection; v {
- main.DisablePathCorrection = v
- }
- if v := c.DisablePathCorrectionRedirection; v {
- main.DisablePathCorrectionRedirection = v
- }
- if v := c.EnablePathIntelligence; v {
- main.EnablePathIntelligence = v
- }
- if v := c.EnablePathEscape; v {
- main.EnablePathEscape = v
- }
- if v := c.ForceLowercaseRouting; v {
- main.ForceLowercaseRouting = v
- }
- if v := c.EnableOptimizations; v {
- main.EnableOptimizations = v
- }
- if v := c.FireMethodNotAllowed; v {
- main.FireMethodNotAllowed = v
- }
- if v := c.DisableAutoFireStatusCode; v {
- main.DisableAutoFireStatusCode = v
- }
- if v := c.ResetOnFireErrorCode; v {
- main.ResetOnFireErrorCode = v
- }
- if v := c.DisableBodyConsumptionOnUnmarshal; v {
- main.DisableBodyConsumptionOnUnmarshal = v
- }
- if v := c.FireEmptyFormError; v {
- main.FireEmptyFormError = v
- }
- if v := c.TimeFormat; v != "" {
- main.TimeFormat = v
- }
- if v := c.Charset; v != "" {
- main.Charset = v
- }
- if v := c.PostMaxMemory; v > 0 {
- main.PostMaxMemory = v
- }
- if v := c.LocaleContextKey; v != "" {
- main.LocaleContextKey = v
- }
- if v := c.LanguageContextKey; v != "" {
- main.LanguageContextKey = v
- }
- if v := c.VersionContextKey; v != "" {
- main.VersionContextKey = v
- }
- if v := c.ViewEngineContextKey; v != "" {
- main.ViewEngineContextKey = v
- }
- if v := c.ViewLayoutContextKey; v != "" {
- main.ViewLayoutContextKey = v
- }
- if v := c.ViewDataContextKey; v != "" {
- main.ViewDataContextKey = v
- }
- if v := c.RemoteAddrHeaders; len(v) > 0 {
- main.RemoteAddrHeaders = v
- }
- if v := c.RemoteAddrHeadersForce; v {
- main.RemoteAddrHeadersForce = v
- }
- if v := c.RemoteAddrPrivateSubnets; len(v) > 0 {
- main.RemoteAddrPrivateSubnets = v
- }
- if v := c.SSLProxyHeaders; len(v) > 0 {
- if main.SSLProxyHeaders == nil {
- main.SSLProxyHeaders = make(map[string]string, len(v))
- }
- for key, value := range v {
- main.SSLProxyHeaders[key] = value
- }
- }
- if v := c.HostProxyHeaders; len(v) > 0 {
- if main.HostProxyHeaders == nil {
- main.HostProxyHeaders = make(map[string]bool, len(v))
- }
- for key, value := range v {
- main.HostProxyHeaders[key] = value
- }
- }
- if v := c.Other; len(v) > 0 {
- if main.Other == nil {
- main.Other = make(map[string]interface{}, len(v))
- }
- for key, value := range v {
- main.Other[key] = value
- }
- }
- }
- }
- // DefaultConfiguration returns the default configuration for an iris station, fills the main Configuration
- func DefaultConfiguration() Configuration {
- return Configuration{
- LogLevel: "info",
- SocketSharding: false,
- DisableStartupLog: false,
- DisableInterruptHandler: false,
- DisablePathCorrection: false,
- EnablePathEscape: false,
- ForceLowercaseRouting: false,
- FireMethodNotAllowed: false,
- DisableBodyConsumptionOnUnmarshal: false,
- FireEmptyFormError: false,
- DisableAutoFireStatusCode: false,
- TimeFormat: "Mon, 02 Jan 2006 15:04:05 GMT",
- Charset: "utf-8",
- // PostMaxMemory is for post body max memory.
- //
- // The request body the size limit
- // can be set by the middleware `LimitRequestBodySize`
- // or `context#SetMaxRequestBodySize`.
- PostMaxMemory: 32 << 20, // 32MB
- LocaleContextKey: "iris.locale",
- LanguageContextKey: "iris.locale.language",
- VersionContextKey: "iris.api.version",
- ViewEngineContextKey: "iris.view.engine",
- ViewLayoutContextKey: "iris.view.layout",
- ViewDataContextKey: "iris.view.data",
- RemoteAddrHeaders: nil,
- RemoteAddrHeadersForce: false,
- RemoteAddrPrivateSubnets: []netutil.IPRange{
- {
- Start: net.ParseIP("10.0.0.0"),
- End: net.ParseIP("10.255.255.255"),
- },
- {
- Start: net.ParseIP("100.64.0.0"),
- End: net.ParseIP("100.127.255.255"),
- },
- {
- Start: net.ParseIP("172.16.0.0"),
- End: net.ParseIP("172.31.255.255"),
- },
- {
- Start: net.ParseIP("192.0.0.0"),
- End: net.ParseIP("192.0.0.255"),
- },
- {
- Start: net.ParseIP("192.168.0.0"),
- End: net.ParseIP("192.168.255.255"),
- },
- {
- Start: net.ParseIP("198.18.0.0"),
- End: net.ParseIP("198.19.255.255"),
- },
- },
- SSLProxyHeaders: make(map[string]string),
- HostProxyHeaders: make(map[string]bool),
- EnableOptimizations: false,
- Other: make(map[string]interface{}),
- }
- }
|