feat: use cobra to provide subcommands, move sources to lib (#506)

- Use cobra in order to provide subcommands `serve` and `db`. - Subdir `cmd` is removed. - Subdir `cli` is created, which is a standard cobra structure. - Sources related to the core are moved to subdir `lib`. - #497 and #504 are merged. - Deprecated flags are added. See https://github.com/filebrowser/filebrowser/pull/497#discussion_r209428120. - [`viper.BindPFlags`](https://godoc.org/github.com/spf13/viper#BindPFlags) is used in order to reduce the verbosity in `serve.go`. Former-commit-id: 4b37ad82e91e01f7718cd389469814674bdf7032 [formerly c84d7fcf9c362b2aa1f9e5b57196152f53835e61] [formerly 2fef43c0382f3cc7d13e0297ccb467e38fac6982 [formerly 69a3f853bd2821d2c52a435277aaac68a468d39b]] Former-commit-id: 2f7dc1b8ee6735382cedae2053f40c546c21de45 [formerly b438417178b47ad5f7caf9cb728f4a5011a09f5e] Former-commit-id: 07bc58ab2e1ab10c30be8d0a5e760288bfc4d4dc
2018-08-21 22:42:03 +01:00
parent 93acf4a6f7
commit 0536d8342c
35 changed files with 535 additions and 840 deletions
--- a/cli/cmd/db.go
+++ b/cli/cmd/db.go
@@ -0,0 +1,24 @@
+package cmd
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+// dbCmd represents the db command
+var dbCmd = &cobra.Command{
+	Use:     "db",
+	Version: rootCmd.Version,
+	Aliases: []string{"database"},
+	Short:   "Manage a filebrowser database",
+	Long: `This is a CLI tool to ease the management of
+filebrowser database files.`,
+	Run: func(cmd *cobra.Command, args []string) {
+		fmt.Println("db called. Command not implemented, yet.")
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(dbCmd)
+}
--- a/cli/cmd/root.go
+++ b/cli/cmd/root.go
@@ -0,0 +1,75 @@
+package cmd
+
+import (
+	"log"
+	"strings"
+
+	homedir "github.com/mitchellh/go-homedir"
+	"github.com/spf13/cobra"
+	v "github.com/spf13/viper"
+)
+
+var cfgFile string
+
+// rootCmd represents the base command when called without any subcommands
+var rootCmd = &cobra.Command{
+	Use:     "filebrowser",
+	Version: "(untracked)",
+	Aliases: []string{"serve"},
+	Short:   "A stylish web-based file manager",
+	Long: `Command 'serve' is the default. Filebrowser is started
+with the provided envvars, flags and/or config file. For example:
+
+filebrowser -c config.json -p 80 -s ./srv
+
+File Browser is a static binary composed of a golang backend and
+a Vue.js frontend to create, edit, copy, move, download your files
+easily, everywhere, every time.`,
+	//	Run: func(cmd *cobra.Command, args []string) {},
+}
+
+// Execute adds all child commands to the root command and sets flags appropriately.
+// This is called by main.main(). It only needs to happen once to the rootCmd.
+func Execute() {
+	checkRootAlias()
+	if err := rootCmd.Execute(); err != nil {
+		panic(err)
+	}
+}
+
+func init() {
+	cobra.OnInitialize(initConfig)
+	rootCmd.SetVersionTemplate("File Browser {{printf \"version %s\" .Version}}\n")
+
+	rootCmd.PersistentFlags().StringVarP(&cfgFile, "config", "c", "", "config file (defaults are './.filebrowser[ext]', '$HOME/.filebrowser[ext]' or '/etc/filebrowser/.filebrowser[ext]')")
+}
+
+// initConfig reads in config file and ENV variables if set.
+func initConfig() {
+	if cfgFile == "" {
+		// Find home directory.
+		home, err := homedir.Dir()
+		if err != nil {
+			panic(err)
+		}
+		v.AddConfigPath(".")
+		v.AddConfigPath(home)
+		v.AddConfigPath("/etc/filebrowser/")
+		v.SetConfigName(".filebrowser")
+	} else {
+		// Use config file from the flag.
+		v.SetConfigFile(cfgFile)
+	}
+
+	v.SetEnvPrefix("FB")
+	v.AutomaticEnv()
+	v.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))
+
+	if err := v.ReadInConfig(); err != nil {
+		if _, ok := err.(v.ConfigParseError); ok {
+			panic(err)
+		}
+	} else {
+		log.Println("Using config file:", v.ConfigFileUsed())
+	}
+}
--- a/cli/cmd/rootalias.go
+++ b/cli/cmd/rootalias.go
@@ -0,0 +1,46 @@
+package cmd
+
+import (
+	"log"
+	"os"
+)
+
+// checkRootAlias compares the first argument provided in the CLI with a list of
+// subcmds and aliases. If no match is found, the first alias of rootCmd is added.
+func checkRootAlias() {
+	l := len(rootCmd.Aliases)
+	if l == 0 {
+		return
+	}
+	if l > 1 {
+		log.Printf("rootCmd.Aliases should contain a single string. '%s' is used.\n", rootCmd.Aliases[0])
+	}
+	if len(os.Args) > 1 {
+		for _, v := range append(nonRootSubCmds(), []string{"--help", "--version"}...) {
+			if os.Args[1] == v {
+				return
+			}
+		}
+	}
+	os.Args = append([]string{os.Args[0], rootCmd.Aliases[0]}, os.Args[1:]...)
+}
+
+// nonRootSubCmds traverses the list of subcommands of rootCmd and returns a string
+// slice containing the names and aliases of all the subcmds, except the one defined
+// in the Aliases field of rootCmd.
+func nonRootSubCmds() (l []string) {
+	for _, c := range rootCmd.Commands() {
+		isAlias := false
+		for _, a := range append(c.Aliases, c.Name()) {
+			if a == rootCmd.Aliases[0] {
+				isAlias = true
+				break
+			}
+		}
+		if !isAlias {
+			l = append(l, c.Name())
+			l = append(l, c.Aliases...)
+		}
+	}
+	return
+}
--- a/cli/cmd/serve.go
+++ b/cli/cmd/serve.go
@@ -0,0 +1,111 @@
+package cmd
+
+import (
+	filebrowser "github.com/filebrowser/filebrowser/lib"
+	"github.com/spf13/cobra"
+	v "github.com/spf13/viper"
+)
+
+// serveCmd represents the serve command
+var serveCmd = &cobra.Command{
+	Use:     "serve",
+	Version: rootCmd.Version,
+	Aliases: []string{"server"},
+	Short:   "Start filebrowser service",
+	Long:    rootCmd.Long,
+	Run: func(cmd *cobra.Command, args []string) {
+		Serve()
+	},
+	Args: cobra.NoArgs,
+}
+
+func init() {
+	rootCmd.AddCommand(serveCmd)
+
+	f := serveCmd.PersistentFlags()
+
+	flag := func(k string, i interface{}, u string) {
+		switch y := i.(type) {
+		case bool:
+			f.Bool(k, y, u)
+		case int:
+			f.Int(k, y, u)
+		case string:
+			f.String(k, y, u)
+		}
+		v.SetDefault(k, i)
+	}
+
+	flagP := func(k, p string, i interface{}, u string) {
+		switch y := i.(type) {
+		case bool:
+			f.BoolP(k, p, y, u)
+		case int:
+			f.IntP(k, p, y, u)
+		case string:
+			f.StringP(k, p, y, u)
+		}
+		v.SetDefault(k, i)
+	}
+
+	deprecated := func(k string, i interface{}, u, m string) {
+		switch y := i.(type) {
+		case bool:
+			f.Bool(k, y, u)
+		case int:
+			f.Int(k, y, u)
+		case string:
+			f.String(k, y, u)
+		}
+		f.MarkDeprecated(k, m)
+	}
+
+	// Global settings
+	flagP("port", "p", 0, "HTTP Port (default is random)")
+	flagP("address", "a", "", "Address to listen to (default is all of them)")
+	flagP("database", "d", "./filebrowser.db", "Database file")
+	flagP("log", "l", "stdout", "Errors logger; can use 'stdout', 'stderr' or file")
+	flagP("baseurl", "b", "", "Base URL")
+	flag("prefixurl", "", "Prefix URL")
+	flag("staticgen", "", "Static Generator you want to enable")
+
+	// User default settings
+	f.String("defaults.commands", "git svn hg", "Default commands option for new users")
+	v.SetDefault("defaults.commands", []string{"git", "svn", "hg"})
+
+	flagP("defaults.scope", "s", ".", "Default scope option for new users")
+	flag("defaults.viewMode", filebrowser.MosaicViewMode, "Default view mode for new users")
+	flag("defaults.allowCommands", true, "Default allow commands option for new users")
+	flag("defaults.allowEdit", true, "Default allow edit option for new users")
+	flag("defaults.allowNew", true, "Default allow new option for new users")
+	flag("defaults.allowPublish", true, "Default allow publish option for new users")
+	flag("defaults.locale", "", "Default locale for new users, set it empty to enable auto detect from browser")
+
+	// Recaptcha settings
+	flag("recaptcha.host", "https://www.google.com", "Use another host for ReCAPTCHA. recaptcha.net might be useful in China")
+	flag("recaptcha.key", "", "ReCaptcha site key")
+	flag("recaptcha.secret", "", "ReCaptcha secret")
+
+	// Auth settings
+	flag("auth.method", "default", "Switch between 'none', 'default' and 'proxy' authentication")
+	flag("auth.header", "X-Forwarded-User", "The header name used for proxy authentication")
+
+	// Bind the full flag set to the configuration
+	if err := v.BindPFlags(f); err != nil {
+		panic(err)
+	}
+
+	// Deprecated flags
+	deprecated("no-auth", false, "Disables authentication", "use --auth.method='none' instead")
+	deprecated("alternative-recaptcha", false, "Use recaptcha.net for serving and handling, useful in China", "use --recaptcha.host instead")
+	deprecated("recaptcha-key", "", "ReCaptcha site key", "use --recaptcha.key instead")
+	deprecated("recaptcha-secret", "", "ReCaptcha secret", "use --recaptcha.secret instead")
+	deprecated("scope", ".", "Default scope option for new users", "use --defaults.scope instead")
+	deprecated("commands", "git svn hg", "Default commands option for new users", "use --defaults.commands instead")
+	deprecated("view-mode", "mosaic", "Default view mode for new users", "use --defaults.viewMode instead")
+	deprecated("locale", "", "Default locale for new users, set it empty to enable auto detect from browser", "use --defaults.locale instead")
+	deprecated("allow-commands", true, "Default allow commands option for new users", "use --defaults.allowCommands instead")
+	deprecated("allow-edit", true, "Default allow edit option for new users", "use --defaults.allowEdit instead")
+	deprecated("allow-publish", true, "Default allow publish option for new users", "use --defaults.allowPublish instead")
+	deprecated("allow-new", true, "Default allow new option for new users", "use --defaults.allowNew instead")
+}
--- a/cli/cmd/server.go
+++ b/cli/cmd/server.go
@@ -0,0 +1,150 @@
+package cmd
+
+import (
+	"io/ioutil"
+	"log"
+	"net"
+	"net/http"
+	"os"
+	"path/filepath"
+
+	"github.com/asdine/storm"
+	filebrowser "github.com/filebrowser/filebrowser/lib"
+	"github.com/filebrowser/filebrowser/lib/bolt"
+	h "github.com/filebrowser/filebrowser/lib/http"
+	"github.com/filebrowser/filebrowser/lib/staticgen"
+	"github.com/hacdias/fileutils"
+	"github.com/spf13/viper"
+	"gopkg.in/natefinch/lumberjack.v2"
+)
+
+func Serve() {
+	// Set up process log before anything bad happens.
+	switch l := viper.GetString("log"); l {
+	case "stdout":
+		log.SetOutput(os.Stdout)
+	case "stderr":
+		log.SetOutput(os.Stderr)
+	case "":
+		log.SetOutput(ioutil.Discard)
+	default:
+		log.SetOutput(&lumberjack.Logger{
+			Filename:   l,
+			MaxSize:    100,
+			MaxAge:     14,
+			MaxBackups: 10,
+		})
+	}
+
+	// Validate the provided config before moving forward
+	{
+		// Map of valid authentication methods, containing a boolean value to indicate the need of Auth.Header
+		validMethods := make(map[string]bool)
+		validMethods["none"] = false
+		validMethods["default"] = false
+		validMethods["proxy"] = true
+
+		m := viper.GetString("auth.method")
+		b, ok := validMethods[m]
+		if !ok {
+			log.Fatal("The property 'auth.method' needs to be set to 'none', 'default' or 'proxy'.")
+		}
+
+		if b {
+			if viper.GetString("auth.header") == "" {
+				log.Fatal("The 'auth.header' needs to be specified when '", m, "' authentication is used.")
+			}
+			log.Println("[WARN] Filebrowser authentication is configured to '", m, "' authentication. This can cause a huge security issue if the infrastructure is not configured correctly.")
+		}
+	}
+
+	// Builds the address and a listener.
+	laddr := viper.GetString("address") + ":" + viper.GetString("port")
+	listener, err := net.Listen("tcp", laddr)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	// Tell the user the port in which is listening.
+	log.Println("Listening on", listener.Addr().String())
+
+	// Starts the server.
+	if err := http.Serve(listener, handler()); err != nil {
+		log.Fatal(err)
+	}
+}
+
+func handler() http.Handler {
+	db, err := storm.Open(viper.GetString("database"))
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	fb := &filebrowser.FileBrowser{
+		Auth: &filebrowser.Auth{
+			Method: viper.GetString("auth.method"),
+			Header: viper.GetString("auth.header"),
+		},
+		ReCaptcha: &filebrowser.ReCaptcha{
+			Host:   viper.GetString("recaptcha.host"),
+			Key:    viper.GetString("recaptcha.key"),
+			Secret: viper.GetString("recaptcha.secret"),
+		},
+		DefaultUser: &filebrowser.User{
+			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("defaults.locale"),
+			CSS:           "",
+			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},
+			Users:  bolt.UsersStore{DB: db},
+			Share:  bolt.ShareStore{DB: db},
+		},
+		NewFS: func(scope string) filebrowser.FileSystem {
+			return fileutils.Dir(scope)
+		},
+	}
+
+	fb.SetBaseURL(viper.GetString("baseurl"))
+	fb.SetPrefixURL(viper.GetString("prefixurl"))
+
+	err = fb.Setup()
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	switch viper.GetString("staticgen") {
+	case "hugo":
+		hugo := &staticgen.Hugo{
+			Root:        viper.GetString("Scope"),
+			Public:      filepath.Join(viper.GetString("Scope"), "public"),
+			Args:        []string{},
+			CleanPublic: true,
+		}
+
+		if err = fb.Attach(hugo); err != nil {
+			log.Fatal(err)
+		}
+	case "jekyll":
+		jekyll := &staticgen.Jekyll{
+			Root:        viper.GetString("Scope"),
+			Public:      filepath.Join(viper.GetString("Scope"), "_site"),
+			Args:        []string{"build"},
+			CleanPublic: true,
+		}
+
+		if err = fb.Attach(jekyll); err != nil {
+			log.Fatal(err)
+		}
+	}
+
+	return h.Handler(fb)
+}
--- a/cli/cmd/version.go
+++ b/cli/cmd/version.go
@@ -0,0 +1,26 @@
+package cmd
+
+import (
+	"text/template"
+
+	"github.com/spf13/cobra"
+)
+
+var versionCmd = &cobra.Command{
+	Use:   "version",
+	Short: "Print the version number of File Browser",
+	Long:  `All software has versions. This is File Browser's`,
+	Run: func(cmd *cobra.Command, args []string) {
+		// https://github.com/spf13/cobra/issues/724
+		t := template.New("version")
+		template.Must(t.Parse(rootCmd.VersionTemplate()))
+		err := t.Execute(rootCmd.OutOrStdout(), rootCmd)
+		if err != nil {
+			rootCmd.Println(err)
+		}
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(versionCmd)
+}