simplify methods to import and export settings, to generate backup file contents

marticliment · marticliment · commit e0948db8fe3c · 2025-07-08T16:40:19.000+02:00
diff --git a/src/UniGetUI.Core.Settings/SettingsEngine_ImportExport.cs b/src/UniGetUI.Core.Settings/SettingsEngine_ImportExport.cs
@@ -6,34 +6,37 @@ namespace UniGetUI.Core.SettingsEngine;
 
 public partial class Settings
 {
-    public static void ExportToJSON(string path)
+    public static void ExportToFile_JSON(string path)
     {
-        Dictionary<string, string> settings = [];
-        foreach (string entry in Directory.EnumerateFiles(CoreData.UniGetUIUserConfigurationDirectory))
-        {
-            if(new[] {"OperationHistory", "WinGetAlreadyUpgradedPackages.json", "TelemetryClientToken", "CurrentSessionToken"}.Contains(entry.Split("\\")[^1]))
-                continue;
+        File.WriteAllText(path, ExportToString_JSON());
+    }
 
-            settings.Add(Path.GetFileName(entry), File.ReadAllText(entry));
+    public static void ImportFromFile_JSON(string path)
+    {
+        if (Path.GetDirectoryName(path) == CoreData.UniGetUIUserConfigurationDirectory)
+        {
+            var tempLocation  = Directory.CreateTempSubdirectory();
+            var newPath = Path.Join(tempLocation.FullName, Path.GetFileName(path));
+            File.Copy(path, newPath);
+            path = newPath;
         }
-
-        File.WriteAllText(path, JsonSerializer.Serialize(settings, SerializationOptions));
+        ImportFromString_JSON(path);
     }
 
-    public static async Task<string> ExportSettingsAsStringAsync()
+    public static string ExportToString_JSON()
     {
         Dictionary<string, string> settings = [];
         foreach (string entry in Directory.EnumerateFiles(CoreData.UniGetUIUserConfigurationDirectory))
         {
             if (new[] { "OperationHistory", "WinGetAlreadyUpgradedPackages.json", "TelemetryClientToken", "CurrentSessionToken" }.Contains(Path.GetFileName(entry)))
                 continue;
 
-            settings.Add(Path.GetFileName(entry), await File.ReadAllTextAsync(entry));
+            settings.Add(Path.GetFileName(entry), File.ReadAllText(entry));
         }
         return JsonSerializer.Serialize(settings, SerializationOptions);
     }
 
-    public static async Task ImportSettingsFromStringAsync(string jsonContent)
+    public static void ImportFromString_JSON(string jsonContent)
     {
         ResetSettings();
         Dictionary<string, string> settings = JsonSerializer.Deserialize<Dictionary<string, string>>(jsonContent, SerializationOptions) ?? [];
@@ -42,30 +45,9 @@ public static async Task ImportSettingsFromStringAsync(string jsonContent)
             if (new[] { "OperationHistory", "WinGetAlreadyUpgradedPackages.json", "TelemetryClientToken", "CurrentSessionToken" }.Contains(entry.Key))
                 continue;
 
-            await File.WriteAllTextAsync(Path.Join(CoreData.UniGetUIUserConfigurationDirectory, entry.Key), entry.Value);
-        }
-        Logger.Info("Settings successfully imported from string content.");
-    }
-
-    public static void ImportFromJSON(string path)
-    {
-        if (Path.GetDirectoryName(path) == CoreData.UniGetUIUserConfigurationDirectory)
-        {
-            var tempLocation  = Directory.CreateTempSubdirectory();
-            var newPath = Path.Join(tempLocation.FullName, Path.GetFileName(path));
-            File.Copy(path, newPath);
-            path = newPath;
-        }
-
-        ResetSettings();
-        Dictionary<string, string> settings = JsonSerializer.Deserialize<Dictionary<string, string>>(File.ReadAllText(path), SerializationOptions) ?? [];
-        foreach (KeyValuePair<string, string> entry in settings)
-        {
-            if(new[] {"OperationHistory", "WinGetAlreadyUpgradedPackages.json", "TelemetryClientToken", "CurrentSessionToken"}.Contains(entry.Key))
-                continue;
-
             File.WriteAllText(Path.Join(CoreData.UniGetUIUserConfigurationDirectory, entry.Key), entry.Value);
         }
+        Logger.Info("Settings successfully imported from string content.");
     }
 
     public static void ResetSettings()
diff --git a/src/UniGetUI/CLIHandler.cs b/src/UniGetUI/CLIHandler.cs
@@ -62,7 +62,7 @@ public static int ImportSettings()
 
         try
         {
-            Settings.ImportFromJSON(file);
+            Settings.ImportFromFile_JSON(file);
         }
         catch (Exception ex)
         {
@@ -87,7 +87,7 @@ public static int ExportSettings()
 
         try
         {
-            Settings.ExportToJSON(file);
+            Settings.ExportToFile_JSON(file);
         }
         catch (Exception ex)
         {
diff --git a/src/UniGetUI/Pages/SettingsPages/GeneralPages/Backup.xaml.cs b/src/UniGetUI/Pages/SettingsPages/GeneralPages/Backup.xaml.cs
@@ -114,7 +114,7 @@ private async void RestoreSettingsFromGitHubButton_Click(object sender, EventArg
             var settingsContent = await _backupService.RestoreFileAsync("unigetui.settings.json");
             if (settingsContent != null)
             {
-                await Settings.ImportSettingsFromStringAsync(settingsContent);
+                await Task.Run(() => Settings.ImportFromString_JSON(settingsContent));
                 DialogHelper.HideLoadingDialog();
                 Logger.Info("Successfully restored settings from GitHub Gist.");
                 DialogHelper.ShowDismissableBalloon(
@@ -180,8 +180,8 @@ private async void BackupToGitHubButton_Click(object sender, EventArgs e)
             BackupToGitHubButton.IsEnabled = false;
             DialogHelper.ShowLoadingDialog(CoreTools.Translate("Backing up settings and packages to GitHub Gist..."));
 
-            var settingsContent = await Settings.ExportSettingsAsStringAsync();
-            var packagesContent = await InstalledPackagesPage.BackupPackages(true);
+            var settingsContent = await Task.Run(Settings.ExportToString_JSON);
+            var packagesContent = await InstalledPackagesPage.GenerateBackupContents();
 
             var filesToBackup = new Dictionary<string, string>
             {
@@ -289,4 +289,4 @@ private async void DoBackup_Click(object sender, EventArgs e)
             DialogHelper.HideLoadingDialog();
         }
     }
-}
+}
diff --git a/src/UniGetUI/Pages/SettingsPages/GeneralPages/General.xaml.cs b/src/UniGetUI/Pages/SettingsPages/GeneralPages/General.xaml.cs
@@ -67,7 +67,7 @@ private async void ImportSettings(object sender, EventArgs e)
             if (file != string.Empty)
             {
                 DialogHelper.ShowLoadingDialog(CoreTools.Translate("Please wait..."));
-                await Task.Run(() => Settings.ImportFromJSON(file));
+                await Task.Run(() => Settings.ImportFromFile_JSON(file));
                 DialogHelper.HideLoadingDialog();
                 ShowRestartBanner(this, new());
             }
@@ -83,7 +83,7 @@ private async void ExportSettings(object sender, EventArgs e)
                 if (file != string.Empty)
                 {
                     DialogHelper.ShowLoadingDialog(CoreTools.Translate("Please wait..."));
-                    await Task.Run(() => Settings.ExportToJSON(file));
+                    await Task.Run(() => Settings.ExportToFile_JSON(file));
                     DialogHelper.HideLoadingDialog();
                     CoreTools.ShowFileOnExplorer(file);
                 }
diff --git a/src/UniGetUI/Pages/SoftwarePages/InstalledPackagesPage.cs b/src/UniGetUI/Pages/SoftwarePages/InstalledPackagesPage.cs
@@ -362,25 +362,24 @@ private async void ExportSelection_Click(object sender, RoutedEventArgs e)
 
         }
 
-        public static async Task<string?> BackupPackages(bool returnContents = false)
+        public static Task<string> GenerateBackupContents()
         {
-
-            try
+            Logger.Debug("Starting package backup");
+            List<IPackage> packagesToExport = [];
+            foreach (IPackage package in PEInterface.InstalledPackagesLoader.Packages)
             {
-                Logger.Debug("Starting package backup");
-                List<IPackage> packagesToExport = [];
-                foreach (IPackage package in PEInterface.InstalledPackagesLoader.Packages)
-                {
-                    packagesToExport.Add(package);
-                }
+                packagesToExport.Add(package);
+            }
 
-                string BackupContents = await PackageBundlesPage.CreateBundle(packagesToExport.ToArray(), BundleFormatType.UBUNDLE);
+            return PackageBundlesPage.CreateBundle(packagesToExport.ToArray(), BundleFormatType.UBUNDLE);
+        }
 
-                if(returnContents)
-                {
-                    return BackupContents;
-                }
 
+        public static async Task BackupPackages()
+        {
+            try
+            {
+                string backupContents = await GenerateBackupContents();
                 string dirName = Settings.GetValue(Settings.K.ChangeBackupOutputDirectory);
                 if (dirName == "")
                 {
@@ -406,16 +405,14 @@ private async void ExportSelection_Click(object sender, RoutedEventArgs e)
                 fileName += ".ubundle";
 
                 string filePath = Path.Combine(dirName, fileName);
-                await File.WriteAllTextAsync(filePath, BackupContents);
+                await File.WriteAllTextAsync(filePath, backupContents);
                 HasDoneBackup = true;
                 Logger.ImportantInfo("Backup saved to " + filePath);
-                return null;
             }
             catch (Exception ex)
             {
                 Logger.Error("An error occurred while performing a backup");
                 Logger.Error(ex);
-                return null;
             }
         }
 

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ public static int ImportSettings()`
`62`	`62`
`63`	`63`	`try`
`64`	`64`	`{`
`65`		`- Settings.ImportFromJSON(file);`
	`65`	`+ Settings.ImportFromFile_JSON(file);`
`66`	`66`	`}`
`67`	`67`	`catch (Exception ex)`
`68`	`68`	`{`
`@@ -87,7 +87,7 @@ public static int ExportSettings()`
`87`	`87`
`88`	`88`	`try`
`89`	`89`	`{`
`90`		`- Settings.ExportToJSON(file);`
	`90`	`+ Settings.ExportToFile_JSON(file);`
`91`	`91`	`}`
`92`	`92`	`catch (Exception ex)`
`93`	`93`	`{`
Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ private async void RestoreSettingsFromGitHubButton_Click(object sender, EventArg`
`114`	`114`	`var settingsContent = await _backupService.RestoreFileAsync("unigetui.settings.json");`
`115`	`115`	`if (settingsContent != null)`
`116`	`116`	`{`
`117`		`- await Settings.ImportSettingsFromStringAsync(settingsContent);`
	`117`	`+ await Task.Run(() => Settings.ImportFromString_JSON(settingsContent));`
`118`	`118`	`DialogHelper.HideLoadingDialog();`
`119`	`119`	`Logger.Info("Successfully restored settings from GitHub Gist.");`
`120`	`120`	`DialogHelper.ShowDismissableBalloon(`
`@@ -180,8 +180,8 @@ private async void BackupToGitHubButton_Click(object sender, EventArgs e)`
`180`	`180`	`BackupToGitHubButton.IsEnabled = false;`
`181`	`181`	`DialogHelper.ShowLoadingDialog(CoreTools.Translate("Backing up settings and packages to GitHub Gist..."));`
`182`	`182`
`183`		`- var settingsContent = await Settings.ExportSettingsAsStringAsync();`
`184`		`- var packagesContent = await InstalledPackagesPage.BackupPackages(true);`
	`183`	`+ var settingsContent = await Task.Run(Settings.ExportToString_JSON);`
	`184`	`+ var packagesContent = await InstalledPackagesPage.GenerateBackupContents();`
`185`	`185`
`186`	`186`	`var filesToBackup = new Dictionary<string, string>`
`187`	`187`	`{`
`@@ -289,4 +289,4 @@ private async void DoBackup_Click(object sender, EventArgs e)`
`289`	`289`	`DialogHelper.HideLoadingDialog();`
`290`	`290`	`}`
`291`	`291`	`}`
`292`		`-}`
	`292`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ private async void ImportSettings(object sender, EventArgs e)`
`67`	`67`	`if (file != string.Empty)`
`68`	`68`	`{`
`69`	`69`	`DialogHelper.ShowLoadingDialog(CoreTools.Translate("Please wait..."));`
`70`		`- await Task.Run(() => Settings.ImportFromJSON(file));`
	`70`	`+ await Task.Run(() => Settings.ImportFromFile_JSON(file));`
`71`	`71`	`DialogHelper.HideLoadingDialog();`
`72`	`72`	`ShowRestartBanner(this, new());`
`73`	`73`	`}`
`@@ -83,7 +83,7 @@ private async void ExportSettings(object sender, EventArgs e)`
`83`	`83`	`if (file != string.Empty)`
`84`	`84`	`{`
`85`	`85`	`DialogHelper.ShowLoadingDialog(CoreTools.Translate("Please wait..."));`
`86`		`- await Task.Run(() => Settings.ExportToJSON(file));`
	`86`	`+ await Task.Run(() => Settings.ExportToFile_JSON(file));`
`87`	`87`	`DialogHelper.HideLoadingDialog();`
`88`	`88`	`CoreTools.ShowFileOnExplorer(file);`
`89`	`89`	`}`