package datastore import ( "fmt" "os" "path" "time" plog "github.com/portainer/portainer/api/datastore/log" ) var backupDefaults = struct { backupDir string commonDir string }{ "backups", "common", } var backupLog = plog.NewScopedLog("database, backup") // // Backup Helpers // // createBackupFolders create initial folders for backups func (store *Store) createBackupFolders() { // create common dir commonDir := store.commonBackupDir() if exists, _ := store.fileService.FileExists(commonDir); !exists { if err := os.MkdirAll(commonDir, 0700); err != nil { backupLog.Error("Error while creating common backup folder", err) } } } func (store *Store) databasePath() string { return store.connection.GetDatabaseFilePath() } func (store *Store) commonBackupDir() string { return path.Join(store.connection.GetStorePath(), backupDefaults.backupDir, backupDefaults.commonDir) } func (store *Store) copyDBFile(from string, to string) error { backupLog.Info(fmt.Sprintf("Copying db file from %s to %s", from, to)) err := store.fileService.Copy(from, to, true) if err != nil { backupLog.Error("Failed", err) } return err } // BackupOptions provide a helper to inject backup options type BackupOptions struct { Version int // I can't find this used for anything other than a filename BackupDir string BackupFileName string BackupPath string } // getBackupRestoreOptions returns options to store db at common backup dir location; used by: // - db backup prior to version upgrade // - db rollback func getBackupRestoreOptions(backupDir string) *BackupOptions { return &BackupOptions{ BackupDir: backupDir, //connection.commonBackupDir(), BackupFileName: beforePortainerVersionUpgradeBackup, } } // Backup current database with default options func (store *Store) Backup() (string, error) { return store.backupWithOptions(nil) } func (store *Store) setupOptions(options *BackupOptions) *BackupOptions { if options == nil { options = &BackupOptions{} } if options.Version == 0 { version, err := store.version() if err != nil { version = 0 } options.Version = version } if options.BackupDir == "" { options.BackupDir = store.commonBackupDir() } if options.BackupFileName == "" { options.BackupFileName = fmt.Sprintf("%s.%s.%s", store.connection.GetDatabaseFileName(), fmt.Sprintf("%03d", options.Version), time.Now().Format("20060102150405")) } if options.BackupPath == "" { options.BackupPath = path.Join(options.BackupDir, options.BackupFileName) } return options } // BackupWithOptions backup current database with options func (store *Store) backupWithOptions(options *BackupOptions) (string, error) { backupLog.Info("creating db backup") store.createBackupFolders() options = store.setupOptions(options) dbPath := store.databasePath() if err := store.Close(); err != nil { return options.BackupPath, fmt.Errorf( "error closing datastore before creating backup: %v", err, ) } if err := store.copyDBFile(dbPath, options.BackupPath); err != nil { return options.BackupPath, err } if _, err := store.Open(); err != nil { return options.BackupPath, fmt.Errorf( "error opening datastore after creating backup: %v", err, ) } return options.BackupPath, nil } // RestoreWithOptions previously saved backup for the current Edition with options // Restore strategies: // - default: restore latest from current edition // - restore a specific func (store *Store) restoreWithOptions(options *BackupOptions) error { options = store.setupOptions(options) // Check if backup file exist before restoring _, err := os.Stat(options.BackupPath) if os.IsNotExist(err) { backupLog.Error(fmt.Sprintf("Backup file to restore does not exist %s", options.BackupPath), err) return err } err = store.Close() if err != nil { backupLog.Error("Error while closing store before restore", err) return err } backupLog.Info("Restoring db backup") err = store.copyDBFile(options.BackupPath, store.databasePath()) if err != nil { return err } _, err = store.Open() return err } // RemoveWithOptions removes backup database based on supplied options func (store *Store) removeWithOptions(options *BackupOptions) error { backupLog.Info("Removing db backup") options = store.setupOptions(options) _, err := os.Stat(options.BackupPath) if os.IsNotExist(err) { backupLog.Error(fmt.Sprintf("Backup file to remove does not exist %s", options.BackupPath), err) return err } backupLog.Info(fmt.Sprintf("Removing db file at %s", options.BackupPath)) err = os.Remove(options.BackupPath) if err != nil { backupLog.Error("Failed", err) return err } return nil }