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

cmd/config.go

@@ -89,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/root.go

@@ -213,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/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})

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/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.3"
+	Version = "v2.0.4"
 )