From 58f5f81d9d38a20939167fcf6b41030c6d34db1c Mon Sep 17 00:00:00 2001 From: Henrique Dias Date: Mon, 6 Aug 2018 17:18:23 +0100 Subject: [PATCH] refactor: rename settings License: MIT Signed-off-by: Henrique Dias --- cmd/filebrowser/main.go | 159 ++++++++++++++++++++++------------------ filebrowser.go | 11 ++- http/auth.go | 4 +- http/http.go | 6 +- 4 files changed, 102 insertions(+), 78 deletions(-) diff --git a/cmd/filebrowser/main.go b/cmd/filebrowser/main.go index d1c3d634..b9d1f7b4 100644 --- a/cmd/filebrowser/main.go +++ b/cmd/filebrowser/main.go @@ -2,6 +2,14 @@ package main import ( "fmt" + "io/ioutil" + "log" + "net" + "net/http" + "os" + "path/filepath" + "strings" + "github.com/asdine/storm" "github.com/filebrowser/filebrowser" "github.com/filebrowser/filebrowser/bolt" @@ -11,13 +19,7 @@ import ( flag "github.com/spf13/pflag" "github.com/spf13/viper" "gopkg.in/natefinch/lumberjack.v2" - "io/ioutil" - "log" - "net" - "net/http" - "os" - "path/filepath" - "strings") +) var ( addr string @@ -53,70 +55,85 @@ func init() { flag.StringVarP(&addr, "address", "a", "", "Address to listen to (default is all of them)") flag.StringVarP(&database, "database", "d", "./filebrowser.db", "Database file") flag.StringVarP(&logfile, "log", "l", "stdout", "Errors logger; can use 'stdout', 'stderr' or file") - flag.StringVarP(&scope, "scope", "s", ".", "Default scope option for new users") flag.StringVarP(&baseurl, "baseurl", "b", "", "Base URL") - flag.StringVar(&commands, "commands", "git svn hg", "Default commands option for new users") flag.StringVar(&prefixurl, "prefixurl", "", "Prefix URL") - flag.StringVar(&viewMode, "view-mode", "mosaic", "Default view mode for new users") - flag.StringVar(&recaptchakey, "recaptcha-key", "", "ReCaptcha site key") - flag.StringVar(&recaptchasecret, "recaptcha-secret", "", "ReCaptcha secret") - flag.BoolVar(&allowCommands, "allow-commands", true, "Default allow commands option for new users") - flag.BoolVar(&allowEdit, "allow-edit", true, "Default allow edit option for new users") - flag.BoolVar(&allowPublish, "allow-publish", true, "Default allow publish option for new users") - flag.StringVar(&auth.method, "auth.method", "default", "Switch between 'none', 'default' and 'proxy' authentication.") - flag.StringVar(&auth.loginHeader, "auth.loginHeader", "X-Forwarded-User", "The header name used for proxy authentication.") - flag.BoolVar(&allowNew, "allow-new", true, "Default allow new option for new users") - flag.BoolVar(&noAuth, "no-auth", false, "Disables authentication") - flag.BoolVar(&alterRecaptcha, "alternative-recaptcha", false, "Use recaptcha.net for serving and handling, useful in China") - flag.StringVar(&locale, "locale", "", "Default locale for new users, set it empty to enable auto detect from browser") flag.StringVar(&staticg, "staticgen", "", "Static Generator you want to enable") flag.BoolVarP(&showVer, "version", "v", false, "Show version") + + // User default values + flag.StringVar(&commands, "defaults.commands", "git svn hg", "Default commands option for new users") + flag.StringVarP(&scope, "defaults.scope", "s", ".", "Default scope option for new users") + flag.StringVar(&viewMode, "defaults.viewMode", "mosaic", "Default view mode for new users") + flag.BoolVar(&allowCommands, "defaults.allowCommands", true, "Default allow commands option for new users") + flag.BoolVar(&allowEdit, "defaults.allowEdit", true, "Default allow edit option for new users") + flag.BoolVar(&allowPublish, "defaults.allowPublish", true, "Default allow publish option for new users") + flag.BoolVar(&allowNew, "defaults.allowNew", true, "Default allow new option for new users") + flag.StringVar(&locale, "defaults.locale", "", "Default locale for new users, set it empty to enable auto detect from browser") + + // Recaptcha settings + flag.BoolVar(&alterRecaptcha, "recaptcha.alternative", false, "Use recaptcha.net for serving and handling, useful in China") + flag.StringVar(&recaptchakey, "recaptcha.key", "", "ReCaptcha site key") + flag.StringVar(&recaptchasecret, "recaptcha.secret", "", "ReCaptcha secret") + + // Auth settings + flag.BoolVar(&noAuth, "noAuth", false, "Disables authentication") + flag.StringVar(&auth.method, "auth.method", "default", "Switch between 'none', 'default' and 'proxy' authentication.") + flag.StringVar(&auth.loginHeader, "auth.loginHeader", "X-Forwarded-User", "The header name used for proxy authentication.") } func setupViper() { - viper.SetDefault("Address", "") viper.SetDefault("Port", "0") + viper.SetDefault("Address", "") viper.SetDefault("Database", "./filebrowser.db") - viper.SetDefault("Scope", ".") viper.SetDefault("Logger", "stdout") - viper.SetDefault("Commands", []string{"git", "svn", "hg"}) - viper.SetDefault("AllowCommmands", true) - viper.SetDefault("AllowEdit", true) - viper.SetDefault("AllowNew", true) - viper.SetDefault("AllowPublish", true) - viper.SetDefault("StaticGen", "") - viper.SetDefault("Locale", "") - viper.SetDefault("AuthMethod", "default") - viper.SetDefault("LoginHeader", "X-Fowarded-User") - viper.SetDefault("NoAuth", false) viper.SetDefault("BaseURL", "") viper.SetDefault("PrefixURL", "") - viper.SetDefault("ViewMode", filebrowser.MosaicViewMode) - viper.SetDefault("AlternativeRecaptcha", false) - viper.SetDefault("ReCaptchaKey", "") - viper.SetDefault("ReCaptchaSecret", "") + viper.SetDefault("StaticGen", "") + viper.SetDefault("NoAuth", false) viper.BindPFlag("Port", flag.Lookup("port")) viper.BindPFlag("Address", flag.Lookup("address")) viper.BindPFlag("Database", flag.Lookup("database")) - viper.BindPFlag("Scope", flag.Lookup("scope")) viper.BindPFlag("Logger", flag.Lookup("log")) - viper.BindPFlag("Commands", flag.Lookup("commands")) - viper.BindPFlag("AllowCommands", flag.Lookup("allow-commands")) - viper.BindPFlag("AllowEdit", flag.Lookup("allow-edit")) - viper.BindPFlag("AllowNew", flag.Lookup("allow-new")) - viper.BindPFlag("AllowPublish", flag.Lookup("allow-publish")) - viper.BindPFlag("Locale", flag.Lookup("locale")) - viper.BindPFlag("StaticGen", flag.Lookup("staticgen")) - viper.BindPFlag("AuthMethod", flag.Lookup("auth.method")) - viper.BindPFlag("LoginHeader", flag.Lookup("auth.loginHeader")) - viper.BindPFlag("NoAuth", flag.Lookup("no-auth")) viper.BindPFlag("BaseURL", flag.Lookup("baseurl")) viper.BindPFlag("PrefixURL", flag.Lookup("prefixurl")) - viper.BindPFlag("ViewMode", flag.Lookup("view-mode")) - viper.BindPFlag("AlternativeRecaptcha", flag.Lookup("alternative-recaptcha")) - viper.BindPFlag("ReCaptchaKey", flag.Lookup("recaptcha-key")) - viper.BindPFlag("ReCaptchaSecret", flag.Lookup("recaptcha-secret")) + viper.BindPFlag("StaticGen", flag.Lookup("staticgen")) + viper.BindPFlag("NoAuth", flag.Lookup("no-auth")) + + // User default values + viper.SetDefault("Defaults.Scope", ".") + viper.SetDefault("Defaults.Commands", []string{"git", "svn", "hg"}) + viper.SetDefault("Defaults.ViewMode", filebrowser.MosaicViewMode) + viper.SetDefault("Defaults.AllowCommmands", true) + viper.SetDefault("Defaults.AllowEdit", true) + viper.SetDefault("Defaults.AllowNew", true) + viper.SetDefault("Defaults.AllowPublish", true) + viper.SetDefault("Defaults.Locale", "") + + viper.BindPFlag("Defaults.Scope", flag.Lookup("defaults.scope")) + viper.BindPFlag("Defaults.Commands", flag.Lookup("defaults.commands")) + viper.BindPFlag("Defaults.ViewMode", flag.Lookup("defaults.viewMode")) + viper.BindPFlag("Defaults.AllowCommands", flag.Lookup("defaults.allowCommands")) + viper.BindPFlag("Defaults.AllowEdit", flag.Lookup("defaults.allowEdit")) + viper.BindPFlag("Defaults.AllowNew", flag.Lookup("defaults.allowNew")) + viper.BindPFlag("Defaults.AllowPublish", flag.Lookup("defaults.allowPublish")) + viper.BindPFlag("Defaults.Locale", flag.Lookup("defaults.locale")) + + // Recaptcha settings + viper.SetDefault("Recaptcha.Alternative", false) + viper.SetDefault("Recaptcha.Key", "") + viper.SetDefault("Recaptcha.Secret", "") + + viper.BindPFlag("Recaptcha.Alternative", flag.Lookup("recaptcha.alternative")) + viper.BindPFlag("Recaptcha.Key", flag.Lookup("recaptcha.key")) + viper.BindPFlag("Recaptcha.Secret", flag.Lookup("recaptcha.secret")) + + // Auth settings + viper.SetDefault("AuthMethod", "default") + viper.SetDefault("LoginHeader", "X-Fowarded-User") + + viper.BindPFlag("AuthMethod", flag.Lookup("auth.method")) + viper.BindPFlag("LoginHeader", flag.Lookup("auth.loginHeader")) viper.SetConfigName("filebrowser") viper.AddConfigPath(".") @@ -209,31 +226,33 @@ func handler() http.Handler { } recaptchaHost := "https://www.google.com" - if viper.GetBool("AlternativeRecaptcha") { + if viper.GetBool("Recaptcha.Alternative") { recaptchaHost = "https://recaptcha.net" } fm := &filebrowser.FileBrowser{ - AuthMethod: viper.GetString("AuthMethod"), - LoginHeader: viper.GetString("LoginHeader"), - NoAuth: viper.GetBool("NoAuth"), - BaseURL: viper.GetString("BaseURL"), - PrefixURL: viper.GetString("PrefixURL"), - ReCaptchaHost: recaptchaHost, - ReCaptchaKey: viper.GetString("ReCaptchaKey"), - ReCaptchaSecret: viper.GetString("ReCaptchaSecret"), + AuthMethod: viper.GetString("AuthMethod"), + LoginHeader: viper.GetString("LoginHeader"), + NoAuth: viper.GetBool("NoAuth"), + BaseURL: viper.GetString("BaseURL"), + PrefixURL: viper.GetString("PrefixURL"), + ReCaptcha: &filebrowser.ReCaptcha{ + Host: recaptchaHost, + Key: viper.GetString("Recaptcha.Key"), + Secret: viper.GetString("Recaptcha.Secret"), + }, DefaultUser: &filebrowser.User{ - AllowCommands: viper.GetBool("AllowCommands"), - AllowEdit: viper.GetBool("AllowEdit"), - AllowNew: viper.GetBool("AllowNew"), - AllowPublish: viper.GetBool("AllowPublish"), - Commands: viper.GetStringSlice("Commands"), + AllowCommands: viper.GetBool("Defaults.AllowCommands"), + AllowEdit: viper.GetBool("Defaults.AllowEdit"), + AllowNew: viper.GetBool("Defaults.AllowNew"), + AllowPublish: viper.GetBool("Defaults.AllowPublish"), + Commands: viper.GetStringSlice("Defaults.Commands"), Rules: []*filebrowser.Rule{}, - Locale: viper.GetString("Locale"), + Locale: viper.GetString("Defaults.Locale"), CSS: "", - Scope: viper.GetString("Scope"), - FileSystem: fileutils.Dir(viper.GetString("Scope")), - ViewMode: viper.GetString("ViewMode"), + Scope: viper.GetString("Defaults.Scope"), + FileSystem: fileutils.Dir(viper.GetString("Defaults.Scope")), + ViewMode: viper.GetString("Defaults.ViewMode"), }, Store: &filebrowser.Store{ Config: bolt.ConfigStore{DB: db}, diff --git a/filebrowser.go b/filebrowser.go index ed1ac681..ddf26eac 100644 --- a/filebrowser.go +++ b/filebrowser.go @@ -41,6 +41,13 @@ var ( ErrInvalidOption = errors.New("invalid option") ) +// ReCaptcha settings. +type ReCaptcha struct { + Host string + Key string + Secret string +} + // FileBrowser is a file manager instance. It should be creating using the // 'New' function and not directly. type FileBrowser struct { @@ -82,9 +89,7 @@ type FileBrowser struct { LoginHeader string // ReCaptcha host, key and secret. - ReCaptchaHost string - ReCaptchaKey string - ReCaptchaSecret string + ReCaptcha *ReCaptcha // StaticGen is the static websit generator handler. StaticGen StaticGen diff --git a/http/auth.go b/http/auth.go index 58d12212..d184e34a 100644 --- a/http/auth.go +++ b/http/auth.go @@ -80,8 +80,8 @@ func authHandler(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, er } // If ReCaptcha is enabled, check the code. - if len(c.ReCaptchaSecret) > 0 { - ok, err := reCaptcha(c.ReCaptchaHost, c.ReCaptchaSecret, cred.ReCaptcha) + if len(c.ReCaptcha.Secret) > 0 { + ok, err := reCaptcha(c.ReCaptcha.Host, c.ReCaptcha.Secret, cred.ReCaptcha) if err != nil { return http.StatusForbidden, err } diff --git a/http/http.go b/http/http.go index a5e93311..55e43eef 100644 --- a/http/http.go +++ b/http/http.go @@ -231,9 +231,9 @@ func renderFile(c *fb.Context, w http.ResponseWriter, file string) (int, error) "NoAuth": c.NoAuth, "Version": fb.Version, "CSS": template.CSS(c.CSS), - "ReCaptcha": c.ReCaptchaKey != "" && c.ReCaptchaSecret != "", - "ReCaptchaHost": c.ReCaptchaHost, - "ReCaptchaKey": c.ReCaptchaKey, + "ReCaptcha": c.ReCaptcha.Key != "" && c.ReCaptcha.Secret != "", + "ReCaptchaHost": c.ReCaptcha.Host, + "ReCaptchaKey": c.ReCaptcha.Key, } if c.StaticGen != nil {