-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add backup and restore functionality and enhance chat format
This commit introduces an automatic backup and restoration feature which will help in preserving user's data. It also modifies the chat format to improve readability and user experience. Additionally, minor changes have been made to improve code structure and maintainability.
- Loading branch information
1 parent
760eaeb
commit fa307d4
Showing
9 changed files
with
325 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,235 @@ | ||
| package setting | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
| "github.com/google/uuid" | ||
| cp "github.com/otiai10/copy" | ||
| "os" | ||
| "path" | ||
| "slices" | ||
| "strings" | ||
| "time" | ||
| "wox/util" | ||
| ) | ||
|
|
||
| type BackupType string | ||
|
|
||
| const ( | ||
| BackupTypeAuto BackupType = "auto" | ||
| BackupTypeManual BackupType = "manual" | ||
| BackupTypeUpdate BackupType = "update" // backup before update Wox | ||
| ) | ||
|
|
||
| type Backup struct { | ||
| Id string | ||
| Name string // backup folder name | ||
| Timestamp int64 | ||
| Type BackupType | ||
| } | ||
|
|
||
| func (m *Manager) StartAutoBackup(ctx context.Context) { | ||
| util.Go(ctx, "backup", func() { | ||
| for range time.NewTimer(24 * time.Hour).C { | ||
| backupErr := m.Backup(ctx, BackupTypeAuto) | ||
| if backupErr != nil { | ||
| logger.Error(ctx, fmt.Sprintf("failed to backup data: %s", backupErr.Error())) | ||
| } | ||
| } | ||
| }) | ||
| } | ||
|
|
||
| func (m *Manager) Backup(ctx context.Context, backupType BackupType) error { | ||
| logger.Info(ctx, fmt.Sprintf("backing up data: %s", backupType)) | ||
|
|
||
| ts := util.GetSystemTimestamp() | ||
| backupName := fmt.Sprintf("%d", ts) | ||
| backupPath := path.Join(util.GetLocation().GetBackupDirectory(), backupName) | ||
| logger.Info(ctx, fmt.Sprintf("backup path: %s", backupPath)) | ||
|
|
||
| err := cp.Copy(util.GetLocation().GetUserDataDirectory(), backupPath) | ||
| if err != nil { | ||
| logger.Error(ctx, fmt.Sprintf("failed to backup data: %s", err.Error())) | ||
| return err | ||
| } | ||
|
|
||
| backup := Backup{ | ||
| Id: uuid.New().String(), | ||
| Name: backupName, | ||
| Timestamp: ts, | ||
| Type: backupType, | ||
| } | ||
| marshal, marshalErr := json.Marshal(backup) | ||
| if marshalErr != nil { | ||
| logger.Error(ctx, fmt.Sprintf("failed to marshal backup data: %s", marshalErr.Error())) | ||
| // remove backup data | ||
| rmErr := os.RemoveAll(backupPath) | ||
| if rmErr != nil { | ||
| logger.Error(ctx, fmt.Sprintf("failed to remove backup data: %s", rmErr.Error())) | ||
| } | ||
| return marshalErr | ||
| } | ||
|
|
||
| backupInfoPath := path.Join(backupPath, "backup.json") | ||
| writeErr := os.WriteFile(backupInfoPath, marshal, 0644) | ||
| if writeErr != nil { | ||
| logger.Error(ctx, fmt.Sprintf("failed to write backup info: %s", writeErr.Error())) | ||
| // remove backup data | ||
| rmErr := os.RemoveAll(backupPath) | ||
| if rmErr != nil { | ||
| logger.Error(ctx, fmt.Sprintf("failed to remove backup data: %s", rmErr.Error())) | ||
| } | ||
| return writeErr | ||
| } | ||
|
|
||
| logger.Info(ctx, "backup data saved successfully") | ||
|
|
||
| util.Go(ctx, "clean backups", func() { | ||
| m.cleanBackups(ctx) | ||
| }) | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (m *Manager) Restore(ctx context.Context, backupId string) error { | ||
| logger.Info(ctx, fmt.Sprintf("restoring backup data: %s", backupId)) | ||
| backups, getErr := m.FindAllBackups(ctx) | ||
| if getErr != nil { | ||
| logger.Error(ctx, fmt.Sprintf("failed to get all backups: %s", getErr.Error())) | ||
| return getErr | ||
| } | ||
|
|
||
| var backupName string | ||
| for _, backup := range backups { | ||
| if backup.Id == backupId { | ||
| backupName = backup.Name | ||
| break | ||
| } | ||
| } | ||
| if backupName == "" { | ||
| logger.Error(ctx, fmt.Sprintf("backup not found: %s", backupId)) | ||
| return fmt.Errorf("backup not found: %s", backupId) | ||
| } | ||
|
|
||
| // backup current data to temp directory | ||
| tempBackupName := fmt.Sprintf("temp_%d", util.GetSystemTimestamp()) | ||
| tempBackupPath := path.Join(util.GetLocation().GetWoxDataDirectory(), tempBackupName) | ||
| cpErr := cp.Copy(util.GetLocation().GetUserDataDirectory(), tempBackupPath) | ||
| if cpErr != nil { | ||
| logger.Error(ctx, fmt.Sprintf("failed to backup current data to temp directory: %s", cpErr.Error())) | ||
| return cpErr | ||
| } | ||
|
|
||
| // first remove current data | ||
| rmErr := os.Remove(util.GetLocation().GetUserDataDirectory()) | ||
| if rmErr != nil { | ||
| logger.Error(ctx, fmt.Sprintf("failed to remove user data directory: %s", rmErr.Error())) | ||
| return rmErr | ||
| } | ||
|
|
||
| backupPath := path.Join(util.GetLocation().GetBackupDirectory(), backupName) | ||
| cpErr = cp.Copy(backupPath, util.GetLocation().GetUserDataDirectory()) | ||
| if cpErr != nil { | ||
| logger.Error(ctx, fmt.Sprintf("failed to restore backup data to user data directory: %s", cpErr.Error())) | ||
| return cpErr | ||
| } | ||
|
|
||
| // remove backup info if exists | ||
| backupInfoPath := path.Join(backupPath, "backup.json") | ||
| if _, statErr := os.Stat(backupInfoPath); !os.IsNotExist(statErr) { | ||
| rmErr = os.Remove(backupInfoPath) | ||
| if rmErr != nil { | ||
| logger.Error(ctx, fmt.Sprintf("failed to remove backup info: %s", rmErr.Error())) | ||
| return rmErr | ||
| } | ||
| } | ||
|
|
||
| // remove temp backup data | ||
| rmErr = os.RemoveAll(tempBackupPath) | ||
| if rmErr != nil { | ||
| logger.Error(ctx, fmt.Sprintf("failed to remove temp backup data: %s", rmErr.Error())) | ||
| return rmErr | ||
| } | ||
|
|
||
| logger.Info(ctx, "backup data restored successfully") | ||
|
|
||
| //TODO: reload data / plugins | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (m *Manager) FindAllBackups(ctx context.Context) ([]Backup, error) { | ||
| var backupList []Backup | ||
|
|
||
| backupDir := util.GetLocation().GetBackupDirectory() | ||
| backupDirEntries, readDirErr := os.ReadDir(backupDir) | ||
| if readDirErr != nil { | ||
| logger.Error(ctx, fmt.Sprintf("failed to read backup directory: %s", readDirErr.Error())) | ||
| return nil, readDirErr | ||
| } | ||
|
|
||
| for _, entry := range backupDirEntries { | ||
| if strings.HasPrefix(entry.Name(), "temp_") { | ||
| continue | ||
| } | ||
|
|
||
| // read backup info file | ||
| backupInfoPath := path.Join(backupDir, entry.Name(), "backup.json") | ||
| file, readErr := os.ReadFile(backupInfoPath) | ||
| if readErr != nil { | ||
| logger.Error(ctx, fmt.Sprintf("failed to read backup info file: %s", readErr.Error())) | ||
| continue | ||
| } | ||
|
|
||
| var backupInfo Backup | ||
| decodeErr := json.Unmarshal(file, &backupInfo) | ||
| if decodeErr != nil { | ||
| logger.Error(ctx, fmt.Sprintf("failed to unmarshal backup info: %s", decodeErr.Error())) | ||
| continue | ||
| } | ||
|
|
||
| backupList = append(backupList, backupInfo) | ||
| } | ||
|
|
||
| return backupList, nil | ||
| } | ||
|
|
||
| func (m *Manager) cleanBackups(ctx context.Context) error { | ||
| logger.Info(ctx, "cleaning backups") | ||
| maxBackups := 5 | ||
|
|
||
| backups, getErr := m.FindAllBackups(ctx) | ||
| if getErr != nil { | ||
| logger.Error(ctx, fmt.Sprintf("failed to get all backups: %s", getErr.Error())) | ||
| return getErr | ||
| } | ||
|
|
||
| // keep 5 backups | ||
| if len(backups) <= maxBackups { | ||
| return nil | ||
| } | ||
|
|
||
| // sort backups by timestamp | ||
| slices.SortFunc(backups, func(i, j Backup) int { | ||
| return int(i.Timestamp - j.Timestamp) | ||
| }) | ||
|
|
||
| // remove old backups | ||
| removedCount := 0 | ||
| for i := 0; i < len(backups)-maxBackups; i++ { | ||
| backup := backups[i] | ||
| backupPath := path.Join(util.GetLocation().GetBackupDirectory(), backup.Name) | ||
| rmErr := os.RemoveAll(backupPath) | ||
| if rmErr != nil { | ||
| logger.Error(ctx, fmt.Sprintf("failed to remove backup: %s", rmErr.Error())) | ||
| continue | ||
| } else { | ||
| removedCount++ | ||
| logger.Info(ctx, fmt.Sprintf("backup removed: %s, date: %s", backup.Id, util.FormatTimestamp(backup.Timestamp))) | ||
| } | ||
| } | ||
|
|
||
| logger.Info(ctx, fmt.Sprintf("backups cleaned successfully, removed count: %d", removedCount)) | ||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.