diff --git a/api-backups.go b/api-backups.go new file mode 100644 index 0000000..672fde2 --- /dev/null +++ b/api-backups.go @@ -0,0 +1,117 @@ +package main + +import ( + "os" + "path/filepath" + "sort" + "strings" + "time" + + "github.com/gin-gonic/gin" +) + +// @Summary Creates a backup of the database. +// @Router /backups [post] +// @Success 200 {object} CreateBackupDTO +// @Security Bearer +// @tags Backups +func (app *appContext) CreateBackup(gc *gin.Context) { + backup := app.makeBackup() + gc.JSON(200, backup) +} + +// @Summary Download a specific backup file. Requires auth, so can't be accessed plainly in the browser. +// @Param fname path string true "backup filename" +// @Router /backups/{fname} [get] +// @Produce octet-stream +// @Produce json +// @Success 200 {body} file +// @Failure 400 {object} boolResponse +// @Security Bearer +// @tags Backups +func (app *appContext) GetBackup(gc *gin.Context) { + fname := gc.Param("fname") + // Hopefully this is enough to ensure the path isn't malicious. Hidden behind bearer auth anyway so shouldn't matter too much I guess. + ok := (strings.HasPrefix(fname, BACKUP_PREFIX) || strings.HasPrefix(fname, BACKUP_UPLOAD_PREFIX+BACKUP_PREFIX)) && strings.HasSuffix(fname, BACKUP_SUFFIX) + t, err := time.Parse(BACKUP_DATEFMT, strings.TrimSuffix(strings.TrimPrefix(strings.TrimPrefix(fname, BACKUP_UPLOAD_PREFIX), BACKUP_PREFIX), BACKUP_SUFFIX)) + if !ok || err != nil || t.IsZero() { + app.debug.Printf("Ignoring backup DL request due to fname: %v\n", err) + respondBool(400, false, gc) + return + } + path := app.config.Section("backups").Key("path").String() + fullpath := filepath.Join(path, fname) + gc.FileAttachment(fullpath, fname) +} + +// @Summary Get a list of backups. +// @Router /backups [get] +// @Produce json +// @Success 200 {object} GetBackupsDTO +// @Security Bearer +// @tags Backups +func (app *appContext) GetBackups(gc *gin.Context) { + path := app.config.Section("backups").Key("path").String() + backups := app.getBackups() + sort.Sort(backups) + resp := GetBackupsDTO{} + resp.Backups = make([]CreateBackupDTO, backups.count) + + for i, item := range backups.files[:backups.count] { + resp.Backups[i].Name = item.Name() + fullpath := filepath.Join(path, item.Name()) + resp.Backups[i].Path = fullpath + resp.Backups[i].Date = backups.dates[i].Unix() + fstat, err := os.Stat(fullpath) + if err == nil { + resp.Backups[i].Size = fileSize(fstat.Size()) + } + } + gc.JSON(200, resp) +} + +// @Summary Restore a backup file stored locally to the server. +// @Param fname path string true "backup filename" +// @Router /backups/restore/{fname} [post] +// @Produce json +// @Failure 400 {object} boolResponse +// @Security Bearer +// @tags Backups +func (app *appContext) RestoreLocalBackup(gc *gin.Context) { + fname := gc.Param("fname") + // Hopefully this is enough to ensure the path isn't malicious. Hidden behind bearer auth anyway so shouldn't matter too much I guess. + ok := strings.HasPrefix(fname, BACKUP_PREFIX) && strings.HasSuffix(fname, BACKUP_SUFFIX) + t, err := time.Parse(BACKUP_DATEFMT, strings.TrimSuffix(strings.TrimPrefix(fname, BACKUP_PREFIX), BACKUP_SUFFIX)) + if !ok || err != nil || t.IsZero() { + app.debug.Printf("Ignoring backup DL request due to fname: %v\n", err) + respondBool(400, false, gc) + return + } + path := app.config.Section("backups").Key("path").String() + fullpath := filepath.Join(path, fname) + LOADBAK = fullpath + app.restart(gc) +} + +// @Summary Restore a backup file uploaded by the user. +// @Param file formData file true ".bak file" +// @Router /backups/restore [post] +// @Produce json +// @Failure 400 {object} boolResponse +// @Security Bearer +// @tags Backups +func (app *appContext) RestoreBackup(gc *gin.Context) { + file, err := gc.FormFile("backups-file") + if err != nil { + app.err.Printf("Failed to get file from form data: %v\n", err) + respondBool(400, false, gc) + return + } + app.debug.Printf("Got uploaded file \"%s\"\n", file.Filename) + path := app.config.Section("backups").Key("path").String() + fullpath := filepath.Join(path, BACKUP_UPLOAD_PREFIX+BACKUP_PREFIX+time.Now().Local().Format(BACKUP_DATEFMT)+BACKUP_SUFFIX) + gc.SaveUploadedFile(file, fullpath) + app.debug.Printf("Saved to \"%s\"\n", fullpath) + LOADBAK = fullpath + app.restart(gc) +} diff --git a/args.go b/args.go index 398c2a4..e7eb6f3 100644 --- a/args.go +++ b/args.go @@ -23,6 +23,7 @@ func (app *appContext) loadArgs(firstCall bool) { HOST = flag.String("host", "", "alternate address to host web ui on.") PORT = flag.Int("port", 0, "alternate port to host web ui on.") flag.IntVar(PORT, "p", 0, "SHORTHAND") + _LOADBAK = flag.String("restore", "", "path to database backup to restore.") DEBUG = flag.Bool("debug", false, "Enables debug logging.") PPROF = flag.Bool("pprof", false, "Exposes pprof profiler on /debug/pprof.") SWAGGER = flag.Bool("swagger", false, "Enable swagger at /swagger/index.html") @@ -41,6 +42,9 @@ func (app *appContext) loadArgs(firstCall bool) { if *PPROF { os.Setenv("PPROF", "1") } + if *_LOADBAK != "" { + LOADBAK = *_LOADBAK + } } if os.Getenv("SWAGGER") == "1" { diff --git a/backups.go b/backups.go new file mode 100644 index 0000000..95e2fad --- /dev/null +++ b/backups.go @@ -0,0 +1,180 @@ +package main + +import ( + "fmt" + "os" + "path/filepath" + "sort" + "strings" + "time" +) + +const ( + BACKUP_PREFIX = "jfa-go-db-" + BACKUP_UPLOAD_PREFIX = "upload-" + BACKUP_DATEFMT = "2006-01-02T15-04-05" + BACKUP_SUFFIX = ".bak" +) + +type BackupList struct { + files []os.DirEntry + dates []time.Time + count int +} + +func (bl BackupList) Len() int { return len(bl.files) } +func (bl BackupList) Swap(i, j int) { + bl.files[i], bl.files[j] = bl.files[j], bl.files[i] + bl.dates[i], bl.dates[j] = bl.dates[j], bl.dates[i] +} + +func (bl BackupList) Less(i, j int) bool { + // Push non-backup files to the end of the array, + // Since they didn't have a date parsed. + if bl.dates[i].IsZero() { + return false + } + if bl.dates[j].IsZero() { + return true + } + // Sort by oldest first + return bl.dates[j].After(bl.dates[i]) +} + +// Get human-readable file size from f.Size() result. +// https://programming.guide/go/formatting-byte-size-to-human-readable-format.html +func fileSize(l int64) string { + const unit = 1000 + if l < unit { + return fmt.Sprintf("%dB", l) + } + div, exp := int64(unit), 0 + for n := l / unit; n >= unit; n /= unit { + div *= unit + exp++ + } + return fmt.Sprintf("%.1f%c", float64(l)/float64(div), "KMGTPE"[exp]) +} + +func (app *appContext) getBackups() *BackupList { + path := app.config.Section("backups").Key("path").String() + err := os.MkdirAll(path, 0755) + if err != nil { + app.err.Printf("Failed to create backup directory \"%s\": %v\n", path, err) + return nil + } + items, err := os.ReadDir(path) + if err != nil { + app.err.Printf("Failed to read backup directory \"%s\": %v\n", path, err) + return nil + } + backups := &BackupList{} + backups.files = items + backups.dates = make([]time.Time, len(items)) + backups.count = 0 + for i, item := range items { + if item.IsDir() || !(strings.HasSuffix(item.Name(), BACKUP_SUFFIX)) { + continue + } + t, err := time.Parse(BACKUP_DATEFMT, strings.TrimSuffix(strings.TrimPrefix(strings.TrimPrefix(item.Name(), BACKUP_UPLOAD_PREFIX), BACKUP_PREFIX), BACKUP_SUFFIX)) + if err != nil { + app.debug.Printf("Failed to parse backup filename \"%s\": %v\n", item.Name(), err) + continue + } + backups.dates[i] = t + backups.count++ + } + return backups +} + +func (app *appContext) makeBackup() (fileDetails CreateBackupDTO) { + toKeep := app.config.Section("backups").Key("keep_n_backups").MustInt(20) + fname := BACKUP_PREFIX + time.Now().Local().Format(BACKUP_DATEFMT) + BACKUP_SUFFIX + path := app.config.Section("backups").Key("path").String() + backups := app.getBackups() + if backups == nil { + return + } + toDelete := backups.count + 1 - toKeep + // fmt.Printf("toDelete: %d, backCount: %d, keep: %d, length: %d\n", toDelete, backups.count, toKeep, len(backups.files)) + if toDelete > 0 && toDelete <= backups.count { + sort.Sort(backups) + for _, item := range backups.files[:toDelete] { + fullpath := filepath.Join(path, item.Name()) + app.debug.Printf("Deleting old backup \"%s\"\n", item.Name()) + err := os.Remove(fullpath) + if err != nil { + app.err.Printf("Failed to delete old backup \"%s\": %v\n", fullpath, err) + return + } + } + } + fullpath := filepath.Join(path, fname) + f, err := os.Create(fullpath) + if err != nil { + app.err.Printf("Failed to open backup file \"%s\": %v\n", fullpath, err) + return + } + defer f.Close() + _, err = app.storage.db.Badger().Backup(f, 0) + if err != nil { + app.err.Printf("Failed to create backup: %v\n", err) + return + } + + fstat, err := f.Stat() + if err != nil { + app.err.Printf("Failed to get info on new backup: %v\n", err) + return + } + fileDetails.Size = fileSize(fstat.Size()) + fileDetails.Name = fname + fileDetails.Path = fullpath + // fmt.Printf("Created backup %+v\n", fileDetails) + return +} + +func (app *appContext) loadPendingBackup() { + if LOADBAK == "" { + return + } + oldPath := filepath.Join(app.dataPath, "db-"+string(time.Now().Unix())+"-pre-"+filepath.Base(LOADBAK)) + app.info.Printf("Moving existing database to \"%s\"\n", oldPath) + err := os.Rename(app.storage.db_path, oldPath) + if err != nil { + app.err.Fatalf("Failed to move existing database: %v\n", err) + } + + app.ConnectDB() + defer app.storage.db.Close() + + f, err := os.Open(LOADBAK) + if err != nil { + app.err.Fatalf("Failed to open backup file \"%s\": %v\n", LOADBAK, err) + } + err = app.storage.db.Badger().Load(f, 256) + f.Close() + if err != nil { + app.err.Fatalf("Failed to restore backup file \"%s\": %v\n", LOADBAK, err) + } + app.info.Printf("Restored backup \"%s\".", LOADBAK) + LOADBAK = "" +} + +func newBackupDaemon(app *appContext) *housekeepingDaemon { + interval := time.Duration(app.config.Section("backups").Key("every_n_minutes").MustInt(1440)) * time.Minute + daemon := housekeepingDaemon{ + Stopped: false, + ShutdownChannel: make(chan string), + Interval: interval, + period: interval, + app: app, + } + daemon.jobs = []func(app *appContext){ + func(app *appContext) { + app.debug.Println("Backups: Creating backup") + app.makeBackup() + }, + } + return &daemon +} diff --git a/config.go b/config.go index aa9c214..91ea6bd 100644 --- a/config.go +++ b/config.go @@ -112,6 +112,10 @@ func (app *appContext) loadConfig() error { app.MustSetValue("telegram", "show_on_reg", "true") + app.MustSetValue("backups", "every_n_minutes", "1440") + app.MustSetValue("backups", "path", filepath.Join(app.dataPath, "backups")) + app.MustSetValue("backups", "keep_n_backups", "20") + app.config.Section("jellyfin").Key("version").SetValue(version) app.config.Section("jellyfin").Key("device").SetValue("jfa-go") app.config.Section("jellyfin").Key("device_id").SetValue(fmt.Sprintf("jfa-go-%s-%s", version, commit)) diff --git a/config/config-base.json b/config/config-base.json index d45dadf..5bcb500 100644 --- a/config/config-base.json +++ b/config/config-base.json @@ -1557,6 +1557,48 @@ } } }, + "backups": { + "order": [], + "meta": { + "name": "Backups", + "description": "Settings for database backups. Press the \"Backups\" button above to create, download and restore backups." + }, + "settings": { + "enabled": { + "name": "Scheduled Backups", + "required": false, + "requires_restart": true, + "type": "bool", + "value": false, + "description": "Enable to generate database backups on a schedule." + }, + "path": { + "name": "Backup Path", + "required": false, + "requires_restart": true, + "type": "text", + "value": "", + "description": "Path to directory to store backups in. defaults to /backups." + }, + "every_n_minutes": { + "name": "Backup frequency (Minutes)", + "required": false, + "requires_restart": true, + "depends_true": "enabled", + "type": "number", + "value": 1440, + "description": "Backup after this many minutes has passed since the last. Resets every restart." + }, + "keep_n_backups": { + "name": "Number of backups to keep", + "required": false, + "requires_restart": true, + "type": "number", + "value": 20, + "description": "Number of most recent backups to keep. Once this is hit, the oldest backup will be deleted before doing a new one." + } + } + }, "welcome_email": { "order": [], "meta": { diff --git a/daemon.go b/daemon.go index 9a6a9d1..245800d 100644 --- a/daemon.go +++ b/daemon.go @@ -75,7 +75,7 @@ func (app *appContext) clearTelegram() { } func (app *appContext) clearActivities() { - app.debug.Println("Husekeeping: Cleaning up Activity log...") + app.debug.Println("Housekeeping: Cleaning up Activity log...") keepCount := app.config.Section("activity_log").Key("keep_n_records").MustInt(1000) maxAgeDays := app.config.Section("activity_log").Key("delete_after_days").MustInt(90) minAge := time.Now().AddDate(0, 0, -maxAgeDays) diff --git a/html/admin.html b/html/admin.html index a035767..e34603a 100644 --- a/html/admin.html +++ b/html/admin.html @@ -328,6 +328,47 @@ + +