refactor: rename settings (#497)

License: MIT
Signed-off-by: Henrique Dias <hacdias@gmail.com>

Docker.json

@@ -2,9 +2,11 @@
   "port": 80,
   "address": "",
   "database": "/database.db",
-  "scope": "/srv",
+  "defaults": {
-  "allowCommands": true,
+    "scope": "/srv",
-  "allowEdit": true,
+    "allowCommands": true,
-  "allowNew": true,
+    "allowEdit": true,
-  "commands": []
+    "allowNew": true,
+    "commands": []
+  }
 }

cli/cmd/serve.go

@@ -25,30 +25,31 @@ to quickly create a Cobra application.`,
 }
 
 var (
-	addr            string
+	addr      string
-	database        string
+	database  string
-	scope           string
+	scope     string
-	commands        string
+	commands  string
-	logfile         string
+	logfile   string
-	staticg         string
+	staticg   string
-	locale          string
+	locale    string
-	baseurl         string
+	baseurl   string
-	prefixurl       string
+	prefixurl string
-	viewMode        string
+	viewMode  string
-	recaptchakey    string
+	port      int
-	recaptchasecret string
+	recaptcha struct {
-	port            int
+		host   string
-	auth            struct {
+		key    string
-		method      string
+		secret string
-		loginHeader string
 	}
-	noAuth         bool
+	auth struct {
-	allowCommands  bool
+		method string
-	allowEdit      bool
+		header string
-	allowNew       bool
+	}
-	allowPublish   bool
+	allowCommands bool
-	showVer        bool
+	allowEdit     bool
-	alterRecaptcha bool
+	allowNew      bool
+	allowPublish  bool
+	showVer       bool
 )
 
 func init() {
@@ -58,66 +59,77 @@ func init() {
 	serveCmd.PersistentFlags().StringVarP(&addr, "address", "a", "", "Address to listen to (default is all of them)")
 	serveCmd.PersistentFlags().StringVarP(&database, "database", "d", "./filebrowser.db", "Database file")
 	serveCmd.PersistentFlags().StringVarP(&logfile, "log", "l", "stdout", "Errors logger; can use 'stdout', 'stderr' or file")
-	serveCmd.PersistentFlags().StringVarP(&scope, "scope", "s", ".", "Default scope option for new users")
 	serveCmd.PersistentFlags().StringVarP(&baseurl, "baseurl", "b", "", "Base URL")
-	serveCmd.PersistentFlags().StringVar(&commands, "commands", "git svn hg", "Default commands option for new users")
 	serveCmd.PersistentFlags().StringVar(&prefixurl, "prefixurl", "", "Prefix URL")
-	serveCmd.PersistentFlags().StringVar(&viewMode, "view-mode", "mosaic", "Default view mode for new users")
-	serveCmd.PersistentFlags().StringVar(&recaptchakey, "recaptcha-key", "", "ReCaptcha site key")
-	serveCmd.PersistentFlags().StringVar(&recaptchasecret, "recaptcha-secret", "", "ReCaptcha secret")
-	serveCmd.PersistentFlags().BoolVar(&allowCommands, "allow-commands", true, "Default allow commands option for new users")
-	serveCmd.PersistentFlags().BoolVar(&allowEdit, "allow-edit", true, "Default allow edit option for new users")
-	serveCmd.PersistentFlags().BoolVar(&allowPublish, "allow-publish", true, "Default allow publish option for new users")
-	serveCmd.PersistentFlags().StringVar(&auth.method, "auth.method", "default", "Switch between 'none', 'default' and 'proxy' authentication.")
-	serveCmd.PersistentFlags().StringVar(&auth.loginHeader, "auth.loginHeader", "X-Forwarded-User", "The header name used for proxy authentication.")
-	serveCmd.PersistentFlags().BoolVar(&allowNew, "allow-new", true, "Default allow new option for new users")
-	serveCmd.PersistentFlags().BoolVar(&noAuth, "no-auth", false, "Disables authentication")
-	serveCmd.PersistentFlags().BoolVar(&alterRecaptcha, "alternative-recaptcha", false, "Use recaptcha.net for serving and handling, useful in China")
-	serveCmd.PersistentFlags().StringVar(&locale, "locale", "", "Default locale for new users, set it empty to enable auto detect from browser")
 	serveCmd.PersistentFlags().StringVar(&staticg, "staticgen", "", "Static Generator you want to enable")
-	serveCmd.PersistentFlags().BoolVarP(&showVer, "version", "v", false, "Show version")
 
-	viper.SetDefault("Address", "")
+	// User default values
+	serveCmd.PersistentFlags().StringVar(&commands, "defaults.commands", "git svn hg", "Default commands option for new users")
+	serveCmd.PersistentFlags().StringVarP(&scope, "defaults.scope", "s", ".", "Default scope option for new users")
+	serveCmd.PersistentFlags().StringVar(&viewMode, "defaults.viewMode", "mosaic", "Default view mode for new users")
+	serveCmd.PersistentFlags().BoolVar(&allowCommands, "defaults.allowCommands", true, "Default allow commands option for new users")
+	serveCmd.PersistentFlags().BoolVar(&allowEdit, "defaults.allowEdit", true, "Default allow edit option for new users")
+	serveCmd.PersistentFlags().BoolVar(&allowPublish, "defaults.allowPublish", true, "Default allow publish option for new users")
+	serveCmd.PersistentFlags().BoolVar(&allowNew, "defaults.allowNew", true, "Default allow new option for new users")
+	serveCmd.PersistentFlags().StringVar(&locale, "defaults.locale", "", "Default locale for new users, set it empty to enable auto detect from browser")
+
+	// Recaptcha settings
+	serveCmd.PersistentFlags().StringVar(&recaptcha.host, "recaptcha.host", "https://www.google.com", "Use another host for ReCAPTCHA. recaptcha.net might be useful in China")
+	serveCmd.PersistentFlags().StringVar(&recaptcha.key, "recaptcha.key", "", "ReCaptcha site key")
+	serveCmd.PersistentFlags().StringVar(&recaptcha.secret, "recaptcha.secret", "", "ReCaptcha secret")
+
+	// Auth settings
+	serveCmd.PersistentFlags().StringVar(&auth.method, "auth.method", "default", "Switch between 'none', 'default' and 'proxy' authentication")
+	serveCmd.PersistentFlags().StringVar(&auth.header, "auth.header", "X-Forwarded-User", "The header name used for proxy authentication")
+
 	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("StaticGen", "")
-	viper.SetDefault("AlternativeRecaptcha", false)
-	viper.SetDefault("ReCaptchaKey", "")
-	viper.SetDefault("ReCaptchaSecret", "")
 
 	viper.BindPFlag("Port", serveCmd.PersistentFlags().Lookup("port"))
 	viper.BindPFlag("Address", serveCmd.PersistentFlags().Lookup("address"))
 	viper.BindPFlag("Database", serveCmd.PersistentFlags().Lookup("database"))
-	viper.BindPFlag("Scope", serveCmd.PersistentFlags().Lookup("scope"))
 	viper.BindPFlag("Logger", serveCmd.PersistentFlags().Lookup("log"))
-	viper.BindPFlag("Commands", serveCmd.PersistentFlags().Lookup("commands"))
-	viper.BindPFlag("AllowCommands", serveCmd.PersistentFlags().Lookup("allow-commands"))
-	viper.BindPFlag("AllowEdit", serveCmd.PersistentFlags().Lookup("allow-edit"))
-	viper.BindPFlag("AllowNew", serveCmd.PersistentFlags().Lookup("allow-new"))
-	viper.BindPFlag("AllowPublish", serveCmd.PersistentFlags().Lookup("allow-publish"))
-	viper.BindPFlag("Locale", serveCmd.PersistentFlags().Lookup("locale"))
-	viper.BindPFlag("StaticGen", serveCmd.PersistentFlags().Lookup("staticgen"))
-	viper.BindPFlag("AuthMethod", serveCmd.PersistentFlags().Lookup("auth.method"))
-	viper.BindPFlag("LoginHeader", serveCmd.PersistentFlags().Lookup("auth.loginHeader"))
-	viper.BindPFlag("NoAuth", serveCmd.PersistentFlags().Lookup("no-auth"))
 	viper.BindPFlag("BaseURL", serveCmd.PersistentFlags().Lookup("baseurl"))
 	viper.BindPFlag("PrefixURL", serveCmd.PersistentFlags().Lookup("prefixurl"))
-	viper.BindPFlag("ViewMode", serveCmd.PersistentFlags().Lookup("view-mode"))
+	viper.BindPFlag("StaticGen", serveCmd.PersistentFlags().Lookup("staticgen"))
-	viper.BindPFlag("AlternativeRecaptcha", serveCmd.PersistentFlags().Lookup("alternative-recaptcha"))
+
-	viper.BindPFlag("ReCaptchaKey", serveCmd.PersistentFlags().Lookup("recaptcha-key"))
+	// User default values
-	viper.BindPFlag("ReCaptchaSecret", serveCmd.PersistentFlags().Lookup("recaptcha-secret"))
+	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", serveCmd.PersistentFlags().Lookup("defaults.scope"))
+	viper.BindPFlag("Defaults.Commands", serveCmd.PersistentFlags().Lookup("defaults.commands"))
+	viper.BindPFlag("Defaults.ViewMode", serveCmd.PersistentFlags().Lookup("defaults.viewMode"))
+	viper.BindPFlag("Defaults.AllowCommands", serveCmd.PersistentFlags().Lookup("defaults.allowCommands"))
+	viper.BindPFlag("Defaults.AllowEdit", serveCmd.PersistentFlags().Lookup("defaults.allowEdit"))
+	viper.BindPFlag("Defaults.AllowNew", serveCmd.PersistentFlags().Lookup("defaults.allowNew"))
+	viper.BindPFlag("Defaults.AllowPublish", serveCmd.PersistentFlags().Lookup("defaults.allowPublish"))
+	viper.BindPFlag("Defaults.Locale", serveCmd.PersistentFlags().Lookup("defaults.locale"))
+
+	// Recaptcha settings
+	viper.SetDefault("Recaptcha.Host", "https://www.google.com")
+	viper.SetDefault("Recaptcha.Key", "")
+	viper.SetDefault("Recaptcha.Secret", "")
+
+	viper.BindPFlag("Recaptcha.Host", serveCmd.PersistentFlags().Lookup("recaptcha.host"))
+	viper.BindPFlag("Recaptcha.Key", serveCmd.PersistentFlags().Lookup("recaptcha.key"))
+	viper.BindPFlag("Recaptcha.Secret", serveCmd.PersistentFlags().Lookup("recaptcha.secret"))
+
+	// Auth settings
+	viper.SetDefault("Auth.Method", "default")
+	viper.SetDefault("Auth.Header", "X-Fowarded-User")
+
+	viper.BindPFlag("Auth.Method", serveCmd.PersistentFlags().Lookup("auth.method"))
+	viper.BindPFlag("Auth.Header", serveCmd.PersistentFlags().Lookup("auth.header"))
 }

cli/cmd/server.go

@@ -38,13 +38,13 @@ func Serve() {
 	}
 
 	// Validate the provided config before moving forward
-	if viper.GetString("AuthMethod") != "none" && viper.GetString("AuthMethod") != "default" && viper.GetString("AuthMethod") != "proxy" {
+	if viper.GetString("Auth.Method") != "none" && viper.GetString("Auth.Method") != "default" && viper.GetString("Auth.Method") != "proxy" {
 		log.Fatal("The property 'auth.method' needs to be set to 'default' or 'proxy'.")
 	}
 
-	if viper.GetString("AuthMethod") == "proxy" {
+	if viper.GetString("Auth.Method") == "proxy" {
-		if viper.GetString("LoginHeader") == "" {
+		if viper.GetString("Auth.Header") == "" {
-			log.Fatal("The 'loginHeader' needs to be specified when 'proxy' authentication is used.")
+			log.Fatal("The 'auth.header' needs to be specified when 'proxy' authentication is used.")
 		}
 		log.Println("[WARN] Filebrowser authentication is configured to 'proxy' authentication. This can cause a huge security issue if the infrastructure is not configured correctly.")
 	}
@@ -71,32 +71,28 @@ func handler() http.Handler {
 		log.Fatal(err)
 	}
 
-	recaptchaHost := "https://www.google.com"
-	if viper.GetBool("AlternativeRecaptcha") {
-		recaptchaHost = "https://recaptcha.net"
-	}
-
 	fm := &filebrowser.FileBrowser{
-		AuthMethod:      viper.GetString("AuthMethod"),
+		Auth: &filebrowser.Auth{
-		LoginHeader:     viper.GetString("LoginHeader"),
+			Method: viper.GetString("Auth.Method"),
-		NoAuth:          viper.GetBool("NoAuth"),
+			Header: viper.GetString("Auth.Header"),
-		BaseURL:         viper.GetString("BaseURL"),
+		},
-		PrefixURL:       viper.GetString("PrefixURL"),
+		ReCaptcha: &filebrowser.ReCaptcha{
-		ReCaptchaHost:   recaptchaHost,
+			Host:   viper.GetString("Recaptcha.Host"),
-		ReCaptchaKey:    viper.GetString("ReCaptchaKey"),
+			Key:    viper.GetString("Recaptcha.Key"),
-		ReCaptchaSecret: viper.GetString("ReCaptchaSecret"),
+			Secret: viper.GetString("Recaptcha.Secret"),
+		},
 		DefaultUser: &filebrowser.User{
-			AllowCommands: viper.GetBool("AllowCommands"),
+			AllowCommands: viper.GetBool("Defaults.AllowCommands"),
-			AllowEdit:     viper.GetBool("AllowEdit"),
+			AllowEdit:     viper.GetBool("Defaults.AllowEdit"),
-			AllowNew:      viper.GetBool("AllowNew"),
+			AllowNew:      viper.GetBool("Defaults.AllowNew"),
-			AllowPublish:  viper.GetBool("AllowPublish"),
+			AllowPublish:  viper.GetBool("Defaults.AllowPublish"),
-			Commands:      viper.GetStringSlice("Commands"),
+			Commands:      viper.GetStringSlice("Defaults.Commands"),
 			Rules:         []*filebrowser.Rule{},
-			Locale:        viper.GetString("Locale"),
+			Locale:        viper.GetString("Defaults.Locale"),
 			CSS:           "",
-			Scope:         viper.GetString("Scope"),
+			Scope:         viper.GetString("Defaults.Scope"),
-			FileSystem:    fileutils.Dir(viper.GetString("Scope")),
+			FileSystem:    fileutils.Dir(viper.GetString("Defaults.Scope")),
-			ViewMode:      viper.GetString("ViewMode"),
+			ViewMode:      viper.GetString("Defaults.ViewMode"),
 		},
 		Store: &filebrowser.Store{
 			Config: bolt.ConfigStore{DB: db},
@@ -108,6 +104,9 @@ func handler() http.Handler {
 		},
 	}
 
+	fm.SetBaseURL(viper.GetString("BaseURL"))
+	fm.SetPrefixURL(viper.GetString("PrefixURL"))
+
 	err = fm.Setup()
 	if err != nil {
 		log.Fatal(err)
@@ -139,4 +138,4 @@ func handler() http.Handler {
 	}
 
 	return h.Handler(fm)
-}
+}

lib/filebrowser.go

@@ -41,6 +41,25 @@ var (
 	ErrInvalidOption      = errors.New("invalid option")
 )
 
+// ReCaptcha settings.
+type ReCaptcha struct {
+	Host   string
+	Key    string
+	Secret string
+}
+
+// Auth settings.
+type Auth struct {
+	// Define if which of the following authentication mechansims should be used:
+	// - 'default', which requires a user and a password.
+	// - 'proxy', which requires a valid user and the user name has to be provided through an
+	//   http header.
+	// - 'none', which allows anyone to access the filebrowser instance.
+	Method string
+	// If 'Method' is set to 'proxy' the header configured below is used to identify the user.
+	Header string
+}
+
 // FileBrowser is a file manager instance. It should be creating using the
 // 'New' function and not directly.
 type FileBrowser struct {
@@ -67,24 +86,11 @@ type FileBrowser struct {
 	// edited directly. Use SetBaseURL.
 	BaseURL string
 
-	// NoAuth disables the authentication. When the authentication is disabled,
+	// Authentication configuration.
-	// there will only exist one user, called "admin".
+	Auth *Auth
-	NoAuth bool
-
-	// Define if which of the following authentication mechansims should be used:
-	// - 'default', which requires a user and a password.
-	// - 'proxy', which requires a valid user and the user name has to be provided through an
-	//   http header.
-	// - 'none', which allows anyone to access the filebrowser instance.
-	AuthMethod string
-
-	// When 'AuthMethod' is set to 'proxy' the header configured below is used to identify the user.
-	LoginHeader string
 
 	// ReCaptcha host, key and secret.
-	ReCaptchaHost   string
+	ReCaptcha *ReCaptcha
-	ReCaptchaKey    string
-	ReCaptchaSecret string
 
 	// StaticGen is the static websit generator handler.
 	StaticGen StaticGen

lib/http/auth.go

@@ -51,14 +51,14 @@ func reCaptcha(host, secret, response string) (bool, error) {
 
 // authHandler processes the authentication for the user.
 func authHandler(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, error) {
-	if c.NoAuth {
+	if c.Auth.Method == "none" {
 		// NoAuth instances shouldn't call this method.
 		return 0, nil
 	}
 
-	if c.AuthMethod == "proxy" {
+	if c.Auth.Method == "proxy" {
 		// Receive the Username from the Header and check if it exists.
-		u, err := c.Store.Users.GetByUsername(r.Header.Get(c.LoginHeader), c.NewFS)
+		u, err := c.Store.Users.GetByUsername(r.Header.Get(c.Auth.Header), c.NewFS)
 		if err != nil {
 			return http.StatusForbidden, nil
 		}
@@ -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 {
+	if len(c.ReCaptcha.Secret) > 0 {
-		ok, err := reCaptcha(c.ReCaptchaHost, c.ReCaptchaSecret, cred.ReCaptcha)
+		ok, err := reCaptcha(c.ReCaptcha.Host, c.ReCaptcha.Secret, cred.ReCaptcha)
 		if err != nil {
 			return http.StatusForbidden, err
 		}
@@ -178,14 +178,14 @@ func (e extractor) ExtractToken(r *http.Request) (string, error) {
 // validateAuth is used to validate the authentication and returns the
 // User if it is valid.
 func validateAuth(c *fb.Context, r *http.Request) (bool, *fb.User) {
-	if c.NoAuth {
+	if c.Auth.Method == "none" {
 		c.User = c.DefaultUser
 		return true, c.User
 	}
 
 	// If proxy auth is used do not verify the JWT token if the header is provided.
-	if c.AuthMethod == "proxy" {
+	if c.Auth.Method == "proxy" {
-		u, err := c.Store.Users.GetByUsername(r.Header.Get(c.LoginHeader), c.NewFS)
+		u, err := c.Store.Users.GetByUsername(r.Header.Get(c.Auth.Header), c.NewFS)
 		if err != nil {
 			return false, nil
 		}

lib/http/http.go

@@ -228,12 +228,12 @@ func renderFile(c *fb.Context, w http.ResponseWriter, file string) (int, error)
 
 	data := map[string]interface{}{
 		"BaseURL":       c.RootURL(),
-		"NoAuth":        c.NoAuth,
+		"NoAuth":        c.Auth.Method == "none",
 		"Version":       fb.Version,
 		"CSS":           template.CSS(c.CSS),
-		"ReCaptcha":     c.ReCaptchaKey != "" && c.ReCaptchaSecret != "",
+		"ReCaptcha":     c.ReCaptcha.Key != "" && c.ReCaptcha.Secret != "",
-		"ReCaptchaHost": c.ReCaptchaHost,
+		"ReCaptchaHost": c.ReCaptcha.Host,
-		"ReCaptchaKey":  c.ReCaptchaKey,
+		"ReCaptchaKey":  c.ReCaptcha.Key,
 	}
 
 	if c.StaticGen != nil {

lib/http/subtitle.go

@@ -12,15 +12,15 @@ import (
 )
 
 func subtitlesHandler(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, error) {
-	files, err := ReadDir(filepath.Dir(c.File.Path))
+	files, err := readDir(filepath.Dir(c.File.Path))
 	if err != nil {
 		return http.StatusInternalServerError, err
 	}
-	var subtitles = make([]map[string]string, 0)
+	subtitles := make([]map[string]string, 0)
 	for _, file := range files {
 		ext := filepath.Ext(file.Name())
 		if ext == ".vtt" || ext == ".srt" {
-			var sub map[string]string = make(map[string]string)
+			sub := make(map[string]string)
 			sub["src"] = filepath.Dir(c.File.Path) + "/" + file.Name()
 			sub["kind"] = "subtitles"
 			sub["label"] = file.Name()
@@ -31,7 +31,7 @@ func subtitlesHandler(c *fb.Context, w http.ResponseWriter, r *http.Request) (in
 }
 
 func subtitleHandler(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, error) {
-	str, err := CleanSubtitle(c.File.Path)
+	str, err := cleanSubtitle(c.File.Path)
 	if err != nil {
 		return http.StatusInternalServerError, err
 	}
@@ -55,7 +55,7 @@ func subtitleHandler(c *fb.Context, w http.ResponseWriter, r *http.Request) (int
 
 }
 
-func CleanSubtitle(filename string) (string, error) {
+func cleanSubtitle(filename string) (string, error) {
 	b, err := ioutil.ReadFile(filename)
 	if err != nil {
 		return "", err
@@ -69,7 +69,7 @@ func CleanSubtitle(filename string) (string, error) {
 	return str, err
 }
 
-func ReadDir(dirname string) ([]os.FileInfo, error) {
+func readDir(dirname string) ([]os.FileInfo, error) {
 	f, err := os.Open(dirname)
 	if err != nil {
 		return nil, err

lib/http/users.go

@@ -276,7 +276,7 @@ func usersPutHandler(c *fb.Context, w http.ResponseWriter, r *http.Request) (int
 
 	// If we're updating the default user. Only for NoAuth
 	// implementations. Used to change the viewMode.
-	if id == 0 && c.NoAuth {
+	if id == 0 && c.Auth.Method == "none" {
 		c.DefaultUser.ViewMode = u.ViewMode
 		return http.StatusOK, nil
 	}