add backup/restore REST API

2025-12-07 14:50:55 +03:00 · 2019-12-27 23:12:44 +01:00
parent f49c280a7f
commit ae094d3479
26 changed files with 673 additions and 29 deletions
--- a/httpd/api_maintenance.go
+++ b/httpd/api_maintenance.go
@@ -0,0 +1,125 @@
+package httpd
+
+import (
+	"encoding/json"
+	"errors"
+	"fmt"
+	"io/ioutil"
+	"net/http"
+	"os"
+	"path/filepath"
+	"strconv"
+	"strings"
+
+	"github.com/drakkan/sftpgo/dataprovider"
+	"github.com/drakkan/sftpgo/logger"
+)
+
+func dumpData(w http.ResponseWriter, r *http.Request) {
+	var outputFile string
+	if _, ok := r.URL.Query()["output_file"]; ok {
+		outputFile = strings.TrimSpace(r.URL.Query().Get("output_file"))
+	}
+	if len(outputFile) == 0 {
+		sendAPIResponse(w, r, errors.New("Invalid or missing output_file"), "", http.StatusBadRequest)
+		return
+	}
+	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)
+	logger.Debug(logSender, "", "dumping data to: %#v", outputFile)
+
+	users, err := dataprovider.DumpUsers(dataProvider)
+	if err != nil {
+		logger.Warn(logSender, "", "dumping data error: %v, output file: %#v", err, outputFile)
+		sendAPIResponse(w, r, err, "", getRespStatus(err))
+		return
+	}
+	dump, err := json.Marshal(BackupData{
+		Users: users,
+	})
+	if err == nil {
+		os.MkdirAll(filepath.Dir(outputFile), 0777)
+		err = ioutil.WriteFile(outputFile, dump, 0666)
+	}
+	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 completed, output file: %#v, error: %v", outputFile, err)
+	sendAPIResponse(w, r, err, "Data saved", http.StatusOK)
+}
+
+func loadData(w http.ResponseWriter, r *http.Request) {
+	var inputFile string
+	var err error
+	scanQuota := 0
+	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 err != nil {
+			err = errors.New("Invalid scan_quota")
+			sendAPIResponse(w, r, err, "", http.StatusBadRequest)
+			return
+		}
+	}
+	if !filepath.IsAbs(inputFile) {
+		sendAPIResponse(w, r, fmt.Errorf("Invalid input_file %#v: it must be an absolute path", inputFile), "", http.StatusBadRequest)
+		return
+	}
+	fi, err := os.Stat(inputFile)
+	if err != nil {
+		sendAPIResponse(w, r, err, "", getRespStatus(err))
+		return
+	}
+	if fi.Size() > maxRestoreSize {
+		sendAPIResponse(w, r, err, fmt.Sprintf("Unable to restore input file: %#v size too big: %v/%v", inputFile, fi.Size(),
+			maxRestoreSize), http.StatusBadRequest)
+		return
+	}
+
+	content, err := ioutil.ReadFile(inputFile)
+	if err != nil {
+		sendAPIResponse(w, r, err, "", getRespStatus(err))
+		return
+	}
+	var dump BackupData
+	err = json.Unmarshal(content, &dump)
+	if err != nil {
+		sendAPIResponse(w, r, err, fmt.Sprintf("Unable to parse input file: %#v", inputFile), http.StatusBadRequest)
+		return
+	}
+
+	for _, user := range dump.Users {
+		u, err := dataprovider.UserExists(dataProvider, user.Username)
+		if err == nil {
+			user.ID = u.ID
+			err = dataprovider.UpdateUser(dataProvider, user)
+			user.Password = "[redacted]"
+			logger.Debug(logSender, "", "restoring existing user: %+v, dump file: %#v, error: %v", user, inputFile, err)
+		} else {
+			err = dataprovider.AddUser(dataProvider, user)
+			user.Password = "[redacted]"
+			logger.Debug(logSender, "", "adding new user: %+v, dump file: %#v, error: %v", user, inputFile, err)
+		}
+		if err != nil {
+			sendAPIResponse(w, r, err, "", getRespStatus(err))
+			return
+		}
+		if scanQuota == 1 || (scanQuota == 2 && user.HasQuotaRestrictions()) {
+			logger.Debug(logSender, "", "starting quota scan for restored user: %#v", user.Username)
+			doQuotaScan(user)
+		}
+	}
+	logger.Debug(logSender, "", "backup restored, users: %v", len(dump.Users))
+	sendAPIResponse(w, r, err, "Data restored", http.StatusOK)
+}