chore: version v2.0.4

Former-commit-id: ed0fcd880038c88122f3791bb7e1dd72aebc4490 [formerly 1528e0038353c351ab614fd13c79c8c03a0b7c5a] [formerly e1164b51bd061190976d5d9bd6f50352279ebead [formerly 477ad73ef1]]
Former-commit-id: 06c62a56d5bc335e1092a81bf5e28b7c9a257f82 [formerly f690c1178915409b6ea62d0e4a126d5a05228a2b]
Former-commit-id: 4a51dbc5c2ec941ba2a6f66b3f811d38faf11bdd

.gitignore

@@ -3,3 +3,4 @@
 *.bak
 _old
 rice-box.go
+.idea/

auth/auth.go

@@ -10,4 +10,6 @@ import (
 type Auther interface {
 	// Auth is called to authenticate a request.
 	Auth(r *http.Request, s *users.Storage, root string) (*users.User, error)
+	// LoginPage indicates if this auther needs a login page.
+	LoginPage() bool
 }

auth/json.go

@@ -59,6 +59,11 @@ func (a JSONAuth) Auth(r *http.Request, sto *users.Storage, root string) (*users
 	return u, nil
 }
 
+// LoginPage tells that json auth doesn't require a login page.
+func (a JSONAuth) LoginPage() bool {
+	return true
+}
+
 const reCaptchaAPI = "/recaptcha/api/siteverify"
 
 // ReCaptcha identifies a recaptcha conenction.

auth/none.go

@@ -17,3 +17,8 @@ type NoAuth struct{}
 func (a NoAuth) Auth(r *http.Request, sto *users.Storage, root string) (*users.User, error) {
 	return sto.Get(root, uint(1))
 }
+
+// LoginPage tells that no auth doesn't require a login page.
+func (a NoAuth) LoginPage() bool {
+	return false
+}

auth/proxy.go

@@ -27,3 +27,8 @@ func (a ProxyAuth) Auth(r *http.Request, sto *users.Storage, root string) (*user
 
 	return user, err
 }
+
+// LoginPage tells that proxy auth doesn't require a login page.
+func (a ProxyAuth) LoginPage() bool {
+	return false
+}

cmd/cmds.go

@@ -11,11 +11,10 @@ func init() {
 }
 
 var cmdsCmd = &cobra.Command{
-	Use:     "cmds",
-	Version: rootCmd.Version,
-	Short:   "Command runner management utility",
-	Long:    `Command runner management utility.`,
-	Args:    cobra.NoArgs,
+	Use:   "cmds",
+	Short: "Command runner management utility",
+	Long:  `Command runner management utility.`,
+	Args:  cobra.NoArgs,
 }
 
 func printEvents(m map[string][]string) {

cmd/config.go

@@ -20,11 +20,10 @@ func init() {
 }
 
 var configCmd = &cobra.Command{
-	Use:     "config",
-	Version: rootCmd.Version,
-	Short:   "Configuration management utility",
-	Long:    `Configuration management utility.`,
-	Args:    cobra.NoArgs,
+	Use:   "config",
+	Short: "Configuration management utility",
+	Long:  `Configuration management utility.`,
+	Args:  cobra.NoArgs,
 }
 
 func addConfigFlags(flags *pflag.FlagSet) {
@@ -90,6 +89,7 @@ func printSettings(ser *settings.Server, set *settings.Settings, auther auth.Aut
 	w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
 
 	fmt.Fprintf(w, "Sign up:\t%t\n", set.Signup)
+	fmt.Fprintf(w, "Create User Dir:\t%t\n", set.CreateUserDir)
 	fmt.Fprintf(w, "Auth method:\t%s\n", set.AuthMethod)
 	fmt.Fprintf(w, "Shell:\t%s\t\n", strings.Join(set.Shell, " "))
 	fmt.Fprintln(w, "\nBranding:")

cmd/docs.go

@@ -111,7 +111,7 @@ func generateMarkdown(cmd *cobra.Command, w io.Writer) {
 	checkErr(err)
 }
 
-func generateFlagsTable(fs *pflag.FlagSet, buf *bytes.Buffer) {
+func generateFlagsTable(fs *pflag.FlagSet, buf io.StringWriter) {
 	buf.WriteString("| Name | Shorthand | Usage |\n")
 	buf.WriteString("|------|-----------|-------|\n")
 

cmd/hash.go

@@ -12,11 +12,10 @@ func init() {
 }
 
 var hashCmd = &cobra.Command{
-	Use:     "hash <password>",
-	Version: rootCmd.Version,
-	Short:   "Hashes a password",
-	Long:    `Hashes a password using bcrypt algorithm.`,
-	Args:    cobra.ExactArgs(1),
+	Use:   "hash <password>",
+	Short: "Hashes a password",
+	Long:  `Hashes a password using bcrypt algorithm.`,
+	Args:  cobra.ExactArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		pwd, err := users.HashPwd(args[0])
 		checkErr(err)

cmd/root.go

@@ -15,7 +15,6 @@ import (
 	"github.com/filebrowser/filebrowser/v2/settings"
 	"github.com/filebrowser/filebrowser/v2/storage"
 	"github.com/filebrowser/filebrowser/v2/users"
-	"github.com/filebrowser/filebrowser/v2/version"
 	homedir "github.com/mitchellh/go-homedir"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
@@ -55,9 +54,8 @@ func addServerFlags(flags *pflag.FlagSet) {
 }
 
 var rootCmd = &cobra.Command{
-	Use:     "filebrowser",
-	Version: version.Version,
-	Short:   "A stylish web-based file browser",
+	Use:   "filebrowser",
+	Short: "A stylish web-based file browser",
 	Long: `File Browser CLI lets you create the database to use with File Browser,
 manage your users and all the configurations without acessing the
 web interface.
@@ -215,8 +213,9 @@ func setupLog(logMethod string) {
 
 func quickSetup(flags *pflag.FlagSet, d pythonData) {
 	set := &settings.Settings{
-		Key:    generateKey(),
-		Signup: false,
+		Key:           generateKey(),
+		Signup:        false,
+		CreateUserDir: false,
 		Defaults: settings.UserDefaults{
 			Scope:  ".",
 			Locale: "en",

cmd/rules.go

@@ -19,7 +19,6 @@ func init() {
 
 var rulesCmd = &cobra.Command{
 	Use:     "rules",
-	Version: rootCmd.Version,
 	Short:   "Rules management utility",
 	Long: `On each subcommand you'll have available at least two flags:
 "username" and "id". You must either set only one of them

cmd/upgrade.go

@@ -14,9 +14,8 @@ func init() {
 }
 
 var upgradeCmd = &cobra.Command{
-	Use:     "upgrade",
-	Version: rootCmd.Version,
-	Short:   "Upgrades an old configuration",
+	Use:   "upgrade",
+	Short: "Upgrades an old configuration",
 	Long: `Upgrades an old configuration. This command DOES NOT
 import share links because they are incompatible with
 this version.`,

cmd/users.go

@@ -18,11 +18,10 @@ func init() {
 }
 
 var usersCmd = &cobra.Command{
-	Use:     "users",
-	Version: rootCmd.Version,
-	Short:   "Users management utility",
-	Long:    `Users management utility.`,
-	Args:    cobra.NoArgs,
+	Use:   "users",
+	Short: "Users management utility",
+	Long:  `Users management utility.`,
+	Args:  cobra.NoArgs,
 }
 
 func printUsers(users []*users.User) {

cmd/users_add.go

@@ -30,6 +30,19 @@ var usersAddCmd = &cobra.Command{
 		}
 
 		s.Defaults.Apply(user)
+
+		servSettings, err := d.store.Settings.GetServer()
+		checkErr(err)
+		//since getUserDefaults() polluted s.Defaults.Scope
+		//which makes the Scope not the one saved in the db
+		//we need the right s.Defaults.Scope here
+		s2, err := d.store.Settings.Get()
+		checkErr(err)
+
+		userHome, err := s2.MakeUserDir(user.Username, user.Scope, servSettings.Root)
+		checkErr(err)
+		user.Scope = userHome
+
 		err = d.store.Users.Save(user)
 		checkErr(err)
 		printUsers([]*users.User{user})

cmd/utils.go

@@ -62,18 +62,20 @@ type pythonData struct {
 
 func dbExists(path string) (bool, error) {
 	stat, err := os.Stat(path)
+	if err == nil {
+		return stat.Size() != 0, nil
+	}
 
 	if os.IsNotExist(err) {
-		return false, nil
-	} else if err != nil {
-		return false, err
+		d := filepath.Dir(path)
+		_, err = os.Stat(d)
+		if os.IsNotExist(err) {
+			os.MkdirAll(d, 0700)
+			return false, nil
+		}
 	}
 
-	if stat.Size() == 0 {
-		return false, nil
-	}
-
-	return true, nil
+	return false, err
 }
 
 func python(fn pythonFunc, cfg pythonConfig) cobraFunc {

cmd/version.go

@@ -1,32 +1,20 @@
 package cmd
 
 import (
-	"text/template"
+	"fmt"
 
+	"github.com/filebrowser/filebrowser/v2/version"
 	"github.com/spf13/cobra"
 )
 
 func init() {
 	rootCmd.AddCommand(versionCmd)
-	cmdsCmd.AddCommand(versionCmd)
-	configCmd.AddCommand(versionCmd)
-	hashCmd.AddCommand(versionCmd)
-	upgradeCmd.AddCommand(versionCmd)
-	rulesCmd.AddCommand(versionCmd)
-	usersCmd.AddCommand(versionCmd)
 }
 
 var versionCmd = &cobra.Command{
 	Use:   "version",
-	Short: "Print the version number of File Browser",
-	Long:  `All software has versions. This is File Browser's`,
+	Short: "Print the version number",
 	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)
-		}
+		fmt.Println("File Browser Version " + version.Version)
 	},
 }

files/listing.go

@@ -2,6 +2,7 @@ package files
 
 import (
 	"sort"
+	"strings"
 
 	"github.com/maruel/natural"
 )
@@ -68,7 +69,7 @@ func (l byName) Less(i, j int) bool {
 		return false
 	}
 
-	return natural.Less(l.Items[i].Name, l.Items[j].Name)
+	return natural.Less(strings.ToLower(l.Items[j].Name), strings.ToLower(l.Items[i].Name))
 }
 
 // By Size

go.mod

@@ -21,12 +21,12 @@ require (
 	github.com/kardianos/osext v0.0.0-20170510131534-ae77be60afb1 // indirect
 	github.com/kr/pretty v0.1.0 // indirect
 	github.com/maruel/natural v0.0.0-20180416170133-dbcb3e2e8cf1
-	github.com/mholt/archiver v3.1.0+incompatible
+	github.com/mholt/archiver v3.1.1+incompatible
 	github.com/mholt/caddy v0.11.1
 	github.com/mitchellh/go-homedir v1.0.0
 	github.com/nwaples/rardecode v1.0.0 // indirect
 	github.com/pelletier/go-toml v1.2.0
-	github.com/pierrec/lz4 v2.0.5+incompatible // indirect
+	github.com/pierrec/lz4 v0.0.0-20190131084431-473cd7ce01a1 // indirect
 	github.com/spf13/afero v1.1.2
 	github.com/spf13/cobra v0.0.3
 	github.com/spf13/pflag v1.0.3

go.sum

@@ -57,6 +57,8 @@ github.com/maruel/natural v0.0.0-20180416170133-dbcb3e2e8cf1 h1:PEhRT94KBTY4E0Kd
 github.com/maruel/natural v0.0.0-20180416170133-dbcb3e2e8cf1/go.mod h1:wI697HNhDFM/vBruYM3ckbszQ2+DOIeH9qdBKMdf288=
 github.com/mholt/archiver v3.1.0+incompatible h1:S1rFZ7umHtN6cG+6cusrfoXTMPqp6u/R89iKxBYJd4w=
 github.com/mholt/archiver v3.1.0+incompatible/go.mod h1:Dh2dOXnSdiLxRiPoVfIr/fI1TwETms9B8CTWfeh7ROU=
+github.com/mholt/archiver v3.1.1+incompatible h1:1dCVxuqs0dJseYEhi5pl7MYPH9zDa1wBi7mF09cbNkU=
+github.com/mholt/archiver v3.1.1+incompatible/go.mod h1:Dh2dOXnSdiLxRiPoVfIr/fI1TwETms9B8CTWfeh7ROU=
 github.com/mholt/caddy v0.11.1 h1:oNfejqftVesLoFxw53Gh17aBPNbTxQ9xJw1pn4IiAPk=
 github.com/mholt/caddy v0.11.1/go.mod h1:Wb1PlT4DAYSqOEd03MsqkdkXnTxA8v9pKjdpxbqM1kY=
 github.com/mitchellh/go-homedir v1.0.0 h1:vKb8ShqSby24Yrqr/yDYkuFz8d0WUjys40rvnGC8aR0=
@@ -67,8 +69,11 @@ github.com/nwaples/rardecode v1.0.0 h1:r7vGuS5akxOnR4JQSkko62RJ1ReCMXxQRPtxsiFMB
 github.com/nwaples/rardecode v1.0.0/go.mod h1:5DzqNKiOdpKKBH87u8VlvAnPZMXcGRhxWkRpHbbfGS0=
 github.com/pelletier/go-toml v1.2.0 h1:T5zMGML61Wp+FlcbWjRDT7yAxhJNAiPPLOFECq181zc=
 github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic=
+github.com/pierrec/lz4 v0.0.0-20190131084431-473cd7ce01a1 h1:0utzB5Mn6QyMzIeOn+oD7pjKQLjJwfM9bz6TkPPdxcw=
+github.com/pierrec/lz4 v0.0.0-20190131084431-473cd7ce01a1/go.mod h1:3/3N9NVKO0jef7pBehbT1qWhCMrIgbYNnFAZCqQ5LRc=
 github.com/pierrec/lz4 v2.0.5+incompatible h1:2xWsjqPFWcplujydGg4WmhC/6fZqK42wMM8aXeqhl0I=
 github.com/pierrec/lz4 v2.0.5+incompatible/go.mod h1:pdkljMzZIN41W+lC3N2tnIh5sFi+IEE17M5jbnwPHcY=
+github.com/pkg/profile v1.2.1/go.mod h1:hJw3o1OdXxsrSjjVksARp5W95eeEaEfptyVZyv6JUPA=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/spf13/afero v1.1.2 h1:m8/z1t7/fwjysjQRYbP0RD+bUIF/8tJwPdEZsI83ACI=

http/raw.go

@@ -2,7 +2,6 @@ package http
 
 import (
 	"errors"
-	"fmt"
 	"net/http"
 	"net/url"
 	"path/filepath"
@@ -82,7 +81,6 @@ var rawHandler = withUser(func(w http.ResponseWriter, r *http.Request, d *data)
 func addFile(ar archiver.Writer, d *data, path string) error {
 	// Checks are always done with paths with "/" as path separator.
 	path = strings.Replace(path, "\\", "/", -1)
-	fmt.Println(path)
 	if !d.Check(path) {
 		return nil
 	}

http/settings.go

@@ -9,22 +9,24 @@ import (
 )
 
 type settingsData struct {
-	Signup   bool                  `json:"signup"`
-	Defaults settings.UserDefaults `json:"defaults"`
-	Rules    []rules.Rule          `json:"rules"`
-	Branding settings.Branding     `json:"branding"`
-	Shell    []string              `json:"shell"`
-	Commands map[string][]string   `json:"commands"`
+	Signup        bool                  `json:"signup"`
+	CreateUserDir bool                  `json:"createUserDir"`
+	Defaults      settings.UserDefaults `json:"defaults"`
+	Rules         []rules.Rule          `json:"rules"`
+	Branding      settings.Branding     `json:"branding"`
+	Shell         []string              `json:"shell"`
+	Commands      map[string][]string   `json:"commands"`
 }
 
 var settingsGetHandler = withAdmin(func(w http.ResponseWriter, r *http.Request, d *data) (int, error) {
 	data := &settingsData{
-		Signup:   d.settings.Signup,
-		Defaults: d.settings.Defaults,
-		Rules:    d.settings.Rules,
-		Branding: d.settings.Branding,
-		Shell:    d.settings.Shell,
-		Commands: d.settings.Commands,
+		Signup:        d.settings.Signup,
+		CreateUserDir: d.settings.CreateUserDir,
+		Defaults:      d.settings.Defaults,
+		Rules:         d.settings.Rules,
+		Branding:      d.settings.Branding,
+		Shell:         d.settings.Shell,
+		Commands:      d.settings.Commands,
 	}
 
 	return renderJSON(w, r, data)
@@ -38,6 +40,7 @@ var settingsPutHandler = withAdmin(func(w http.ResponseWriter, r *http.Request,
 	}
 
 	d.settings.Signup = req.Signup
+	d.settings.CreateUserDir = req.CreateUserDir
 	d.settings.Defaults = req.Defaults
 	d.settings.Rules = req.Rules
 	d.settings.Branding = req.Branding

http/static.go

@@ -21,6 +21,11 @@ func handleWithStaticData(w http.ResponseWriter, r *http.Request, d *data, box *
 
 	staticURL := strings.TrimPrefix(d.server.BaseURL+"/static", "/")
 
+	auther, err := d.store.Auth.Get(d.settings.AuthMethod)
+	if err != nil {
+		return http.StatusInternalServerError, err
+	}
+
 	data := map[string]interface{}{
 		"Name":            d.settings.Branding.Name,
 		"DisableExternal": d.settings.Branding.DisableExternal,
@@ -29,6 +34,7 @@ func handleWithStaticData(w http.ResponseWriter, r *http.Request, d *data, box *
 		"StaticURL":       staticURL,
 		"Signup":          d.settings.Signup,
 		"NoAuth":          d.settings.AuthMethod == auth.MethodNoAuth,
+		"LoginPage":       auther.LoginPage(),
 		"CSS":             false,
 		"ReCaptcha":       false,
 	}

http/users.go

@@ -2,6 +2,7 @@ package http
 
 import (
 	"encoding/json"
+	"log"
 	"net/http"
 	"sort"
 	"strconv"
@@ -119,6 +120,14 @@ var userPostHandler = withAdmin(func(w http.ResponseWriter, r *http.Request, d *
 		return http.StatusInternalServerError, err
 	}
 
+	userHome, err := d.settings.MakeUserDir(req.Data.Username, req.Data.Scope, d.server.Root)
+	if err != nil {
+		log.Printf("create user: failed to mkdir user home dir: [%s]", userHome)
+		return http.StatusInternalServerError, err
+	}
+	req.Data.Scope = userHome
+	log.Printf("user: %s, home dir: [%s].", req.Data.Username, userHome)
+
 	err = d.store.Users.Save(req.Data)
 	if err != nil {
 		return http.StatusInternalServerError, err

settings/dir.go

@@ -0,0 +1,75 @@
+package settings
+
+import (
+	"errors"
+	"log"
+	"os"
+	"regexp"
+	"strings"
+
+	"github.com/spf13/afero"
+)
+
+var (
+	invalidFilenameChars = regexp.MustCompile(`[^0-9A-Za-z@_\-.]`)
+
+	dashes = regexp.MustCompile(`[\-]+`)
+)
+
+// MakeUserDir makes the user directory according to settings.
+func (settings *Settings) MakeUserDir(username, userScope, serverRoot string) (string, error) {
+	var err error
+	userScope = strings.TrimSpace(userScope)
+	if userScope == "" || userScope == "./" {
+		userScope = "."
+	}
+
+	if !settings.CreateUserDir {
+		return userScope, nil
+	}
+
+	fs := afero.NewBasePathFs(afero.NewOsFs(), serverRoot)
+
+	// Use the default auto create logic only if specific scope is not the default scope
+	if userScope != settings.Defaults.Scope {
+		// Try create the dir, for example: settings.Defaults.Scope == "." and userScope == "./foo"
+		if userScope != "." {
+			err = fs.MkdirAll(userScope, os.ModePerm)
+			if err != nil {
+				log.Printf("create user: failed to mkdir user home dir: [%s]", userScope)
+			}
+		}
+		return userScope, err
+	}
+
+	// Clean username first
+	username = cleanUsername(username)
+	if username == "" || username == "-" || username == "." {
+		log.Printf("create user: invalid user for home dir creation: [%s]", username)
+		return "", errors.New("invalid user for home dir creation")
+	}
+
+	// Create default user dir
+	userHomeBase := settings.Defaults.Scope + string(os.PathSeparator) + "users"
+	userHome := userHomeBase + string(os.PathSeparator) + username
+	err = fs.MkdirAll(userHome, os.ModePerm)
+	if err != nil {
+		log.Printf("create user: failed to mkdir user home dir: [%s]", userHome)
+	} else {
+		log.Printf("create user: mkdir user home dir: [%s] successfully.", userHome)
+	}
+	return userHome, err
+}
+
+func cleanUsername(s string) string {
+	// Remove any trailing space to avoid ending on -
+	s = strings.Trim(s, " ")
+	s = strings.Replace(s, "..", "", -1)
+
+	// Replace all characters which not in the list `0-9A-Za-z@_\-.` with a dash
+	s = invalidFilenameChars.ReplaceAllString(s, "-")
+
+	// Remove any multiple dashes caused by replacements above
+	s = dashes.ReplaceAllString(s, "-")
+	return s
+}

settings/settings.go

@@ -12,14 +12,15 @@ type AuthMethod string
 
 // Settings contain the main settings of the application.
 type Settings struct {
-	Key        []byte              `json:"key"`
-	Signup     bool                `json:"signup"`
-	Defaults   UserDefaults        `json:"defaults"`
-	AuthMethod AuthMethod          `json:"authMethod"`
-	Branding   Branding            `json:"branding"`
-	Commands   map[string][]string `json:"commands"`
-	Shell      []string            `json:"shell"`
-	Rules      []rules.Rule        `json:"rules"`
+	Key           []byte              `json:"key"`
+	Signup        bool                `json:"signup"`
+	CreateUserDir bool                `json:"createUserDir"`
+	Defaults      UserDefaults        `json:"defaults"`
+	AuthMethod    AuthMethod          `json:"authMethod"`
+	Branding      Branding            `json:"branding"`
+	Commands      map[string][]string `json:"commands"`
+	Shell         []string            `json:"shell"`
+	Rules         []rules.Rule        `json:"rules"`
 }
 
 // GetRules implements rules.Provider.

storage/bolt/importer/users.go

@@ -8,7 +8,7 @@ import (
 	"github.com/filebrowser/filebrowser/v2/rules"
 	"github.com/filebrowser/filebrowser/v2/storage"
 	"github.com/filebrowser/filebrowser/v2/users"
-	"go.etcd.io/bbolt"
+	bolt "go.etcd.io/bbolt"
 )
 
 type oldUser struct {

version/version.go

@@ -2,5 +2,5 @@ package version
 
 const (
 	// Version is the current File Browser version.
-	Version = "v2.0.2"
+	Version = "v2.0.4"
 )