Limit how many local backups are kept (#5318)

Author: GabrielDuf

src/Languages/lang_en.json

@@ -984,5 +984,12 @@
   "Run whenever UniGetUI next starts": "Run whenever UniGetUI next starts",
   "Run within {0}": "Run within {0}",
   "Choose the days and hours when updates are checked and installed": "Choose the days and hours when updates are checked and installed",
-  "The last attempt failed on {0}, see the log for details": "The last attempt failed on {0}, see the log for details"
+  "The last attempt failed on {0}, see the log for details": "The last attempt failed on {0}, see the log for details",
+  "Maximum number of local backups to keep": "Maximum number of local backups to keep",
+  "The oldest backups are deleted once this limit is exceeded.": "The oldest backups are deleted once this limit is exceeded.",
+  "Keep a separate file for each backup": "Keep a separate file for each backup",
+  "Backup file names include the date and time each backup was created.": "Backup file names include the date and time each backup was created.",
+  "Keep all backups": "Keep all backups",
+  "Keep the last {0} backups": "Keep the last {0} backups",
+  "Custom maximum number of backups": "Custom maximum number of backups"
 }

src/UniGetUI.Avalonia/Infrastructure/SettingsSearchIndex.cs

@@ -109,7 +109,9 @@ private sealed record Entry(string Title, string[] Keywords, Type PageType, stri
         new("Perform a local backup now", ["local backup now"], typeof(Backup), "BackupNowButton_LOCAL"),
         new("Change backup output directory", ["backup directory", "backup folder"], typeof(Backup), "BackupDirectoryCard"),
         new("Set a custom backup file name", ["backup file name"], typeof(Backup), "BackupFileNameCard"),
-        new("Add a timestamp to the backup file names", ["backup timestamp"], typeof(Backup), "BackupTimestampCard"),
+        new("Keep a separate file for each backup", ["backup timestamp", "timestamped file names", "separate backups"], typeof(Backup), "BackupTimestampCard"),
+        new("Maximum number of local backups to keep", ["backup retention", "backup limit", "delete old backups"], typeof(Backup), "MaxBackupCountCard"),
+        new("Custom maximum number of backups", ["custom backup count"], typeof(Backup), "MaxBackupCountCustomInput"),
         new("Package backup", ["backup"], typeof(Backup), null),
 
         // ── Administrator ────────────────────────────────────────────────────

src/UniGetUI.Avalonia/ViewModels/Pages/SettingsPages/BackupViewModel.cs

@@ -32,9 +32,23 @@ public partial class BackupViewModel : ViewModelBase, IDisposable
     ];
 
     /* ── Local backup ── */
-    [ObservableProperty] private bool _isLocalBackupEnabled;
+    [ObservableProperty, NotifyPropertyChangedFor(nameof(IsBackupRetentionAvailable))] private bool _isLocalBackupEnabled;
+    [ObservableProperty, NotifyPropertyChangedFor(nameof(IsBackupRetentionAvailable))] private bool _isBackupTimestampingEnabled;
+    [ObservableProperty] private bool _isCustomBackupCountSelected;
     [ObservableProperty] private string _backupDirectoryLabel = "";
 
+    public bool IsBackupRetentionAvailable => IsLocalBackupEnabled && IsBackupTimestampingEnabled;
+
+    public IReadOnlyList<(string Name, string Value)> MaxBackupCountItems { get; } =
+    [
+        (CoreTools.Translate("Keep all backups"),              "0"),
+        (CoreTools.Translate("Keep the last {0} backups", 5),  "5"),
+        (CoreTools.Translate("Keep the last {0} backups", 10), "10"),
+        (CoreTools.Translate("Keep the last {0} backups", 25), "25"),
+        (CoreTools.Translate("Keep the last {0} backups", 50), "50"),
+        (CoreTools.Translate("Custom..."),                     "custom"),
+    ];
+
     /* ── Cloud backup ── */
     [ObservableProperty] private bool _isLoggedIn;
     [ObservableProperty] private bool _isLoginButtonEnabled = true;
@@ -55,6 +69,7 @@ public BackupViewModel()
     {
         _lifetimeToken = _lifetimeCancellation.Token;
         _isLocalBackupEnabled = CoreSettings.Get(CoreSettings.K.EnablePackageBackup_LOCAL);
+        _isBackupTimestampingEnabled = CoreSettings.Get(CoreSettings.K.EnableBackupTimestamping);
         RefreshDirectoryLabel();
 
         GitHubAuthService.AuthStatusChanged += OnAuthStatusChanged;
@@ -87,6 +102,13 @@ private void EnableLocalBackupChanged()
         RestartRequired?.Invoke(this, EventArgs.Empty);
     }
 
+    [RelayCommand]
+    private void EnableBackupTimestampingChanged()
+    {
+        if (IsDisposed) return;
+        IsBackupTimestampingEnabled = CoreSettings.Get(CoreSettings.K.EnableBackupTimestamping);
+    }
+
     private void RefreshDirectoryLabel()
     {
         if (IsDisposed) return;
@@ -120,28 +142,9 @@ public static async Task<bool> DoLocalBackupStatic()
                 ?? [];
             string backupContents = await PackageBundlesPage.CreateBundle(packages);
 
-            string dirName = CoreSettings.GetValue(CoreSettings.K.ChangeBackupOutputDirectory);
-            if (string.IsNullOrEmpty(dirName))
-                dirName = CoreData.UniGetUI_DefaultBackupDirectory;
-
-            if (!Directory.Exists(dirName))
-                Directory.CreateDirectory(dirName);
-
-            string fileName = CoreSettings.GetValue(CoreSettings.K.ChangeBackupFileName);
-            if (string.IsNullOrEmpty(fileName))
-                fileName = CoreTools.Translate(
-                    "{pcName} installed packages",
-                    new Dictionary<string, object?> { { "pcName", Environment.MachineName } }
-                );
-
-            if (CoreSettings.Get(CoreSettings.K.EnableBackupTimestamping))
-                fileName += " " + DateTime.Now.ToString("yyyy-MM-dd HH-mm-ss");
-
-            fileName += ".ubundle";
-
-            string filePath = Path.Combine(dirName, fileName);
-            await File.WriteAllTextAsync(filePath, backupContents);
+            string filePath = await LocalBackupManager.SaveBackupAsync(backupContents);
             Logger.ImportantInfo("Local backup saved to " + filePath);
+            await Task.Run(LocalBackupManager.ApplyRetentionLimit);
             return true;
         }
         catch (Exception ex)

src/UniGetUI.Avalonia/Views/Pages/SettingsPages/Backup.axaml

@@ -187,11 +187,31 @@
 
             <settings:CheckboxCard x:Name="BackupTimestampCard"
                                    SettingName="EnableBackupTimestamping"
-                                   Text="{t:Translate Add a timestamp to the backup file names}"
-                                   CornerRadius="0,0,8,8"
+                                   Text="{t:Translate Keep a separate file for each backup}"
+                                   Description="{t:Translate Text='Backup file names include the date and time each backup was created.'}"
+                                   StateChangedCommand="{Binding EnableBackupTimestampingChangedCommand}"
+                                   CornerRadius="0"
                                    BorderThickness="1,0,1,1"
                                    IsEnabled="{Binding IsLocalBackupEnabled}"/>
 
+            <settings:ComboboxCard x:Name="MaxBackupCountCard"
+                                   SettingName="MaxLocalBackupCount"
+                                   Text="{t:Translate Maximum number of local backups to keep}"
+                                   Description="{t:Translate Text='The oldest backups are deleted once this limit is exceeded.'}"
+                                   BorderThickness="1,0,1,1"
+                                   CornerRadius="0,0,8,8"
+                                   IsEnabled="{Binding IsBackupRetentionAvailable}"/>
+
+            <settings:TextboxCard x:Name="MaxBackupCountCustomInput"
+                                  SettingName="MaxLocalBackupCountCustom"
+                                  Text="{t:Translate Custom maximum number of backups}"
+                                  Placeholder="{t:Translate e.g. 10}"
+                                  IsNumericOnly="True"
+                                  IsVisible="{Binding IsCustomBackupCountSelected}"
+                                  BorderThickness="1,0,1,1"
+                                  CornerRadius="0,0,8,8"
+                                  IsEnabled="{Binding IsBackupRetentionAvailable}"/>
+
             <settings:TranslatedTextBlock Text="Related settings"
                                           FontSize="14"
                                           FontWeight="SemiBold"

src/UniGetUI.Avalonia/Views/Pages/SettingsPages/Backup.axaml.cs

@@ -1,6 +1,8 @@
 using Avalonia.Controls;
 using UniGetUI.Avalonia.ViewModels.Pages.SettingsPages;
 using UniGetUI.Core.Tools;
+using CoreSettings = global::UniGetUI.Core.SettingsEngine.Settings;
+using CornerRadius = global::Avalonia.CornerRadius;
 
 namespace UniGetUI.Avalonia.Views.Pages.SettingsPages;
 
@@ -22,6 +24,22 @@ public Backup()
 
         _viewModel.RestartRequired += OnRestartRequired;
         _viewModel.NavigationRequested += OnNavigationRequested;
+
+        foreach (var (name, val) in _viewModel.MaxBackupCountItems)
+            MaxBackupCountCard.AddItem(name, val, false);
+        MaxBackupCountCard.ShowAddedItems();
+
+        MaxBackupCountCard.ValueChanged += (_, _) => RefreshMaxBackupCountLayout();
+        RefreshMaxBackupCountLayout();
+    }
+
+    private void RefreshMaxBackupCountLayout()
+    {
+        bool isCustom = CoreSettings.GetValue(CoreSettings.K.MaxLocalBackupCount) == "custom";
+        _viewModel.IsCustomBackupCountSelected = isCustom;
+        MaxBackupCountCard.CornerRadius = isCustom
+            ? new CornerRadius(0)
+            : new CornerRadius(0, 0, 8, 8);
     }
 
     private void OnRestartRequired(object? sender, EventArgs e) => RestartRequired?.Invoke(sender, e);

src/UniGetUI.Core.Settings/SettingsEngine_ImportExport.cs

@@ -40,6 +40,7 @@ string entry in Directory.EnumerateFiles(CoreData.UniGetUIUserConfigurationDirec
                     "MaintenanceTaskLastRun.json",
                     "MaintenanceTaskLastFailure.json",
                     "MaintenanceSchedules.invalid",
+                    "KnownLocalBackupNames.json",
                     "TelemetryClientToken",
                     "CurrentSessionToken",
                 }.Contains(Path.GetFileName(entry))
@@ -68,6 +69,7 @@ public static void ImportFromString_JSON(string jsonContent)
                     "MaintenanceTaskLastRun.json",
                     "MaintenanceTaskLastFailure.json",
                     "MaintenanceSchedules.invalid",
+                    "KnownLocalBackupNames.json",
                     "TelemetryClientToken",
                     "CurrentSessionToken",
                 }.Contains(entry.Key)

src/UniGetUI.Core.Settings/SettingsEngine_Names.cs

@@ -60,6 +60,9 @@ public enum K
         WindowGeometry,
         IgnoredUpdatesWindowSize,
         ChangeBackupFileName,
+        MaxLocalBackupCount,
+        MaxLocalBackupCountCustom,
+        KnownLocalBackupNames,
         CurrentSessionToken,
         IgnoredPackageUpdates,
         DisabledManagers,
@@ -184,6 +187,9 @@ public static string ResolveKey(K key)
             K.WindowGeometry => "WindowGeometry",
             K.IgnoredUpdatesWindowSize => "IgnoredUpdatesWindowSize",
             K.ChangeBackupFileName => "ChangeBackupFileName",
+            K.MaxLocalBackupCount => "MaxLocalBackupCount",
+            K.MaxLocalBackupCountCustom => "MaxLocalBackupCountCustom",
+            K.KnownLocalBackupNames => "KnownLocalBackupNames",
             K.CurrentSessionToken => "CurrentSessionToken",
             K.IgnoredPackageUpdates => "IgnoredPackageUpdates",
             K.DisabledManagers => "DisabledManagers",