web admin: add backup/restore

2025-12-07 06:40:54 +03:00 · 2021-01-22 19:42:18 +01:00
parent 820169c5c6
commit 80f5ccd357
17 changed files with 1231 additions and 780 deletions
--- a/httpd/api_maintenance.go
+++ b/httpd/api_maintenance.go
@@ -11,40 +11,56 @@ import (
 	"strconv"
 	"strings"

+	"github.com/go-chi/render"
+
 	"github.com/drakkan/sftpgo/common"
 	"github.com/drakkan/sftpgo/dataprovider"
 	"github.com/drakkan/sftpgo/logger"
 	"github.com/drakkan/sftpgo/vfs"
 )

+func validateBackupFile(outputFile string) (string, error) {
+	if outputFile == "" {
+		return "", errors.New("Invalid or missing output-file")
+	}
+	if filepath.IsAbs(outputFile) {
+		return "", fmt.Errorf("Invalid output-file %#v: it must be a relative path", outputFile)
+	}
+	if strings.Contains(outputFile, "..") {
+		return "", fmt.Errorf("Invalid output-file %#v", outputFile)
+	}
+	outputFile = filepath.Join(backupsPath, outputFile)
+	return outputFile, nil
+}
+
 func dumpData(w http.ResponseWriter, r *http.Request) {
-	var outputFile, indent string
-	if _, ok := r.URL.Query()["output_file"]; ok {
-		outputFile = strings.TrimSpace(r.URL.Query().Get("output_file"))
+	var outputFile, outputData, indent string
+	if _, ok := r.URL.Query()["output-file"]; ok {
+		outputFile = strings.TrimSpace(r.URL.Query().Get("output-file"))
+	}
+	if _, ok := r.URL.Query()["output-data"]; ok {
+		outputData = strings.TrimSpace(r.URL.Query().Get("output-data"))
 	}
 	if _, ok := r.URL.Query()["indent"]; ok {
 		indent = strings.TrimSpace(r.URL.Query().Get("indent"))
 	}
-	if outputFile == "" {
-		sendAPIResponse(w, r, errors.New("Invalid or missing output_file"), "", http.StatusBadRequest)
-		return
+
+	if outputData != "1" {
+		var err error
+		outputFile, err = validateBackupFile(outputFile)
+		if err != nil {
+			sendAPIResponse(w, r, err, "", http.StatusBadRequest)
+			return
+		}
+
+		err = os.MkdirAll(filepath.Dir(outputFile), 0700)
+		if err != nil {
+			logger.Warn(logSender, "", "dumping data error: %v, output file: %#v", err, outputFile)
+			sendAPIResponse(w, r, err, "", getRespStatus(err))
+			return
+		}
+		logger.Debug(logSender, "", "dumping data to: %#v", outputFile)
 	}
-	if filepath.IsAbs(outputFile) {
-		sendAPIResponse(w, r, fmt.Errorf("Invalid output_file %#v: it must be a relative path", outputFile), "", http.StatusBadRequest)
-		return
-	}
-	if strings.Contains(outputFile, "..") {
-		sendAPIResponse(w, r, fmt.Errorf("Invalid output_file %#v", outputFile), "", http.StatusBadRequest)
-		return
-	}
-	outputFile = filepath.Join(backupsPath, outputFile)
-	err := os.MkdirAll(filepath.Dir(outputFile), 0700)
-	if err != nil {
-		logger.Warn(logSender, "", "dumping data error: %v, output file: %#v", err, outputFile)
-		sendAPIResponse(w, r, err, "", getRespStatus(err))
-		return
-	}
-	logger.Debug(logSender, "", "dumping data to: %#v", outputFile)

 	backup, err := dataprovider.DumpData()
 	if err != nil {
@@ -52,6 +68,13 @@ func dumpData(w http.ResponseWriter, r *http.Request) {
 		sendAPIResponse(w, r, err, "", getRespStatus(err))
 		return
 	}
+
+	if outputData == "1" {
+		w.Header().Set("Content-Disposition", "attachment; filename=\"sftpgo-backup.json\"")
+		render.JSON(w, r, backup)
+		return
+	}
+
 	var dump []byte
 	if indent == "1" {
 		dump, err = json.MarshalIndent(backup, "", "  ")
@@ -70,6 +93,28 @@ func dumpData(w http.ResponseWriter, r *http.Request) {
 	sendAPIResponse(w, r, err, "Data saved", http.StatusOK)
 }

+func loadDataFromRequest(w http.ResponseWriter, r *http.Request) {
+	r.Body = http.MaxBytesReader(w, r.Body, MaxRestoreSize)
+	_, scanQuota, mode, err := getLoaddataOptions(r)
+	if err != nil {
+		sendAPIResponse(w, r, err, "", http.StatusBadRequest)
+		return
+	}
+
+	content, err := ioutil.ReadAll(r.Body)
+	if err != nil || len(content) == 0 {
+		if len(content) == 0 {
+			err = dataprovider.NewValidationError("request body is required")
+		}
+		sendAPIResponse(w, r, err, "", getRespStatus(err))
+		return
+	}
+	if err := restoreBackup(content, "", scanQuota, mode); err != nil {
+		sendAPIResponse(w, r, err, "", getRespStatus(err))
+	}
+	sendAPIResponse(w, r, err, "Data restored", http.StatusOK)
+}
+
 func loadData(w http.ResponseWriter, r *http.Request) {
 	inputFile, scanQuota, mode, err := getLoaddataOptions(r)
 	if err != nil {
@@ -96,30 +141,34 @@ func loadData(w http.ResponseWriter, r *http.Request) {
 		sendAPIResponse(w, r, err, "", getRespStatus(err))
 		return
 	}
+	if err := restoreBackup(content, inputFile, scanQuota, mode); err != nil {
+		sendAPIResponse(w, r, err, "", getRespStatus(err))
+	}
+	sendAPIResponse(w, r, err, "Data restored", http.StatusOK)
+}
+
+func restoreBackup(content []byte, inputFile string, scanQuota, mode int) error {
 	dump, err := dataprovider.ParseDumpData(content)
 	if err != nil {
-		sendAPIResponse(w, r, err, fmt.Sprintf("Unable to parse input file: %#v", inputFile), http.StatusBadRequest)
-		return
+		return dataprovider.NewValidationError(fmt.Sprintf("Unable to parse backup content: %v", err))
 	}

 	if err = RestoreFolders(dump.Folders, inputFile, scanQuota); err != nil {
-		sendAPIResponse(w, r, err, "", getRespStatus(err))
-		return
+		return err
 	}

 	if err = RestoreUsers(dump.Users, inputFile, mode, scanQuota); err != nil {
-		sendAPIResponse(w, r, err, "", getRespStatus(err))
-		return
+		return err
 	}

 	if err = RestoreAdmins(dump.Admins, inputFile, mode); err != nil {
-		sendAPIResponse(w, r, err, "", getRespStatus(err))
-		return
+		return err
 	}

 	logger.Debug(logSender, "", "backup restored, users: %v, folders: %v, admins: %vs",
 		len(dump.Users), len(dump.Folders), len(dump.Admins))
-	sendAPIResponse(w, r, err, "Data restored", http.StatusOK)
+
+	return nil
 }

 func getLoaddataOptions(r *http.Request) (string, int, int, error) {
@@ -127,19 +176,21 @@ func getLoaddataOptions(r *http.Request) (string, int, int, error) {
 	var err error
 	scanQuota := 0
 	restoreMode := 0
-	if _, ok := r.URL.Query()["input_file"]; ok {
-		inputFile = strings.TrimSpace(r.URL.Query().Get("input_file"))
+	if _, ok := r.URL.Query()["input-file"]; ok {
+		inputFile = strings.TrimSpace(r.URL.Query().Get("input-file"))
 	}
-	if _, ok := r.URL.Query()["scan_quota"]; ok {
-		scanQuota, err = strconv.Atoi(r.URL.Query().Get("scan_quota"))
+	if _, ok := r.URL.Query()["scan-quota"]; ok {
+		scanQuota, err = strconv.Atoi(r.URL.Query().Get("scan-quota"))
 		if err != nil {
 			err = fmt.Errorf("invalid scan_quota: %v", err)
+			return inputFile, scanQuota, restoreMode, err
 		}
 	}
 	if _, ok := r.URL.Query()["mode"]; ok {
 		restoreMode, err = strconv.Atoi(r.URL.Query().Get("mode"))
 		if err != nil {
 			err = fmt.Errorf("invalid mode: %v", err)
+			return inputFile, scanQuota, restoreMode, err
 		}
 	}
 	return inputFile, scanQuota, restoreMode, err