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`.
2025-11-26 14:25:26 +08:00 · 2018-08-21 22:42:03 +01:00
parent b1eb90767d
commit 69a3f853bd
35 changed files with 535 additions and 840 deletions
--- a/lib/http/users.go
+++ b/lib/http/users.go
@@ -0,0 +1,383 @@
+package http
+
+import (
+	"encoding/json"
+	"errors"
+	"net/http"
+	"os"
+	"sort"
+	"strconv"
+	"strings"
+
+	fb "github.com/filebrowser/filebrowser/lib"
+)
+
+type modifyRequest struct {
+	What  string `json:"what"`  // Answer to: what data type?
+	Which string `json:"which"` // Answer to: which field?
+}
+
+type modifyUserRequest struct {
+	modifyRequest
+	Data *fb.User `json:"data"`
+}
+
+// usersHandler is the entry point of the users API. It's just a router
+// to send the request to its
+func usersHandler(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, error) {
+	// If the user isn't admin and isn't making a PUT
+	// request, then return forbidden.
+	if !c.User.Admin && r.Method != http.MethodPut {
+		return http.StatusForbidden, nil
+	}
+
+	switch r.Method {
+	case http.MethodGet:
+		return usersGetHandler(c, w, r)
+	case http.MethodPost:
+		return usersPostHandler(c, w, r)
+	case http.MethodDelete:
+		return usersDeleteHandler(c, w, r)
+	case http.MethodPut:
+		return usersPutHandler(c, w, r)
+	}
+
+	return http.StatusNotImplemented, nil
+}
+
+// getUserID returns the id from the user which is present
+// in the request url. If the url is invalid and doesn't
+// contain a valid ID, it returns an fb.Error.
+func getUserID(r *http.Request) (int, error) {
+	// Obtains the ID in string from the URL and converts
+	// it into an integer.
+	sid := strings.TrimPrefix(r.URL.Path, "/")
+	sid = strings.TrimSuffix(sid, "/")
+	id, err := strconv.Atoi(sid)
+	if err != nil {
+		return http.StatusBadRequest, err
+	}
+
+	return id, nil
+}
+
+// getUser returns the user which is present in the request
+// body. If the body is empty or the JSON is invalid, it
+// returns an fb.Error.
+func getUser(c *fb.Context, r *http.Request) (*fb.User, string, error) {
+	// Checks if the request body is empty.
+	if r.Body == nil {
+		return nil, "", fb.ErrEmptyRequest
+	}
+
+	// Parses the request body and checks if it's well formed.
+	mod := &modifyUserRequest{}
+	err := json.NewDecoder(r.Body).Decode(mod)
+	if err != nil {
+		return nil, "", err
+	}
+
+	// Checks if the request type is right.
+	if mod.What != "user" {
+		return nil, "", fb.ErrWrongDataType
+	}
+
+	mod.Data.FileSystem = c.NewFS(mod.Data.Scope)
+	return mod.Data, mod.Which, nil
+}
+
+func usersGetHandler(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, error) {
+	// Request for the default user data.
+	if r.URL.Path == "/base" {
+		return renderJSON(w, c.DefaultUser)
+	}
+
+	// Request for the listing of users.
+	if r.URL.Path == "/" {
+		users, err := c.Store.Users.Gets(c.NewFS)
+		if err != nil {
+			return http.StatusInternalServerError, err
+		}
+
+		for _, u := range users {
+			// Removes the user password so it won't
+			// be sent to the front-end.
+			u.Password = ""
+		}
+
+		sort.Slice(users, func(i, j int) bool {
+			return users[i].ID < users[j].ID
+		})
+
+		return renderJSON(w, users)
+	}
+
+	id, err := getUserID(r)
+	if err != nil {
+		return http.StatusInternalServerError, err
+	}
+
+	u, err := c.Store.Users.Get(id, c.NewFS)
+	if err == fb.ErrExist {
+		return http.StatusNotFound, err
+	}
+
+	if err != nil {
+		return http.StatusInternalServerError, err
+	}
+
+	u.Password = ""
+	return renderJSON(w, u)
+}
+
+func usersPostHandler(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, error) {
+	if r.URL.Path != "/" {
+		return http.StatusMethodNotAllowed, nil
+	}
+
+	u, _, err := getUser(c, r)
+	if err != nil {
+		return http.StatusBadRequest, err
+	}
+
+	// Checks if username isn't empty.
+	if u.Username == "" {
+		return http.StatusBadRequest, fb.ErrEmptyUsername
+	}
+
+	// Checks if scope isn't empty.
+	if u.Scope == "" {
+		return http.StatusBadRequest, fb.ErrEmptyScope
+	}
+
+	// Checks if password isn't empty.
+	if u.Password == "" {
+		return http.StatusBadRequest, fb.ErrEmptyPassword
+	}
+
+	// Initialize rules if they're not initialized.
+	if u.Rules == nil {
+		u.Rules = []*fb.Rule{}
+	}
+
+	// If the view mode is empty, initialize with the default one.
+	if u.ViewMode == "" {
+		u.ViewMode = c.DefaultUser.ViewMode
+	}
+
+	// Initialize commands if not initialized.
+	if u.Commands == nil {
+		u.Commands = []string{}
+	}
+
+	// It's a new user so the ID will be auto created.
+	if u.ID != 0 {
+		u.ID = 0
+	}
+
+	// Checks if the scope exists.
+	if code, err := checkFS(u.Scope); err != nil {
+		return code, err
+	}
+
+	// Hashes the password.
+	pw, err := fb.HashPassword(u.Password)
+	if err != nil {
+		return http.StatusInternalServerError, err
+	}
+
+	u.Password = pw
+	u.ViewMode = fb.MosaicViewMode
+
+	// Saves the user to the database.
+	err = c.Store.Users.Save(u)
+	if err == fb.ErrExist {
+		return http.StatusConflict, err
+	}
+
+	if err != nil {
+		return http.StatusInternalServerError, err
+	}
+
+	// Set the Location header and return.
+	w.Header().Set("Location", "/settings/users/"+strconv.Itoa(u.ID))
+	w.WriteHeader(http.StatusCreated)
+	return 0, nil
+}
+
+func checkFS(path string) (int, error) {
+	info, err := os.Stat(path)
+
+	if err != nil {
+		if !os.IsNotExist(err) {
+			return http.StatusInternalServerError, err
+		}
+
+		err = os.MkdirAll(path, 0666)
+		if err != nil {
+			return http.StatusInternalServerError, err
+		}
+
+		return 0, nil
+	}
+
+	if !info.IsDir() {
+		return http.StatusBadRequest, errors.New("Scope is not a dir")
+	}
+
+	return 0, nil
+}
+
+func usersDeleteHandler(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, error) {
+	if r.URL.Path == "/" {
+		return http.StatusMethodNotAllowed, nil
+	}
+
+	id, err := getUserID(r)
+	if err != nil {
+		return http.StatusInternalServerError, err
+	}
+
+	// Deletes the user from the database.
+	err = c.Store.Users.Delete(id)
+	if err == fb.ErrNotExist {
+		return http.StatusNotFound, fb.ErrNotExist
+	}
+
+	if err != nil {
+		return http.StatusInternalServerError, err
+	}
+
+	return http.StatusOK, nil
+}
+
+func usersPutHandler(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, error) {
+	// New users should be created on /api/users.
+	if r.URL.Path == "/" {
+		return http.StatusMethodNotAllowed, nil
+	}
+
+	// Gets the user ID from the URL and checks if it's valid.
+	id, err := getUserID(r)
+	if err != nil {
+		return http.StatusInternalServerError, err
+	}
+
+	// Checks if the user has permission to access this page.
+	if !c.User.Admin && id != c.User.ID {
+		return http.StatusForbidden, nil
+	}
+
+	// Gets the user from the request body.
+	u, which, err := getUser(c, r)
+	if err != nil {
+		return http.StatusBadRequest, err
+	}
+
+	// If we're updating the default user. Only for NoAuth
+	// implementations. Used to change the viewMode.
+	if id == 0 && c.Auth.Method == "none" {
+		c.DefaultUser.ViewMode = u.ViewMode
+		return http.StatusOK, nil
+	}
+
+	// Updates the CSS and locale.
+	if which == "partial" {
+		c.User.CSS = u.CSS
+		c.User.Locale = u.Locale
+		c.User.ViewMode = u.ViewMode
+
+		err = c.Store.Users.Update(c.User, "CSS", "Locale", "ViewMode")
+		if err != nil {
+			return http.StatusInternalServerError, err
+		}
+
+		return http.StatusOK, nil
+	}
+
+	// Updates the Password.
+	if which == "password" {
+		if u.Password == "" {
+			return http.StatusBadRequest, fb.ErrEmptyPassword
+		}
+
+		if id == c.User.ID && c.User.LockPassword {
+			return http.StatusForbidden, nil
+		}
+
+		c.User.Password, err = fb.HashPassword(u.Password)
+		if err != nil {
+			return http.StatusInternalServerError, err
+		}
+
+		err = c.Store.Users.Update(c.User, "Password")
+		if err != nil {
+			return http.StatusInternalServerError, err
+		}
+
+		return http.StatusOK, nil
+	}
+
+	// If can only be all.
+	if which != "all" {
+		return http.StatusBadRequest, fb.ErrInvalidUpdateField
+	}
+
+	// Checks if username isn't empty.
+	if u.Username == "" {
+		return http.StatusBadRequest, fb.ErrEmptyUsername
+	}
+
+	// Checks if filesystem isn't empty.
+	if u.Scope == "" {
+		return http.StatusBadRequest, fb.ErrEmptyScope
+	}
+
+	// Checks if the scope exists.
+	if code, err := checkFS(u.Scope); err != nil {
+		return code, err
+	}
+
+	// Initialize rules if they're not initialized.
+	if u.Rules == nil {
+		u.Rules = []*fb.Rule{}
+	}
+
+	// Initialize commands if not initialized.
+	if u.Commands == nil {
+		u.Commands = []string{}
+	}
+
+	// Gets the current saved user from the in-memory map.
+	suser, err := c.Store.Users.Get(id, c.NewFS)
+	if err == fb.ErrNotExist {
+		return http.StatusNotFound, nil
+	}
+
+	if err != nil {
+		return http.StatusInternalServerError, err
+	}
+
+	u.ID = id
+
+	// Changes the password if the request wants it.
+	if u.Password != "" {
+		pw, err := fb.HashPassword(u.Password)
+		if err != nil {
+			return http.StatusInternalServerError, err
+		}
+
+		u.Password = pw
+	} else {
+		u.Password = suser.Password
+	}
+
+	// Updates the whole User struct because we always are supposed
+	// to send a new entire object.
+	err = c.Store.Users.Update(u)
+	if err != nil {
+		return http.StatusInternalServerError, err
+	}
+
+	return http.StatusOK, nil
+}