Feature: Migrate settings to json

Author: BornToBeRoot

Source/NETworkManager.Settings/SettingsManager.cs

@@ -25,6 +25,11 @@ public static class SettingsManager
     /// </summary>
     private static string SettingsFolderName => "Settings";
 
+    /// <summary>
+    ///     Settings backups directory name.
+    /// </summary>
+    private static string BackupFolderName => "Backups";
+
     /// <summary>
     ///     Settings file name.
     /// </summary>
@@ -38,6 +43,7 @@ public static class SettingsManager
     /// <summary>
     ///     Legacy XML settings file extension.
     /// </summary>
+    [Obsolete("Legacy XML settings are no longer used, but the extension is kept for migration purposes.")]
     private static string LegacySettingsFileExtension => ".xml";
 
     /// <summary>
@@ -77,6 +83,15 @@ public static string GetSettingsFolderLocation()
                 AssemblyManager.Current.Name, SettingsFolderName);
     }
 
+    /// <summary>
+    ///     Method to get the path of the settings backup folder.
+    /// </summary>
+    /// <returns>Path to the settings backup folder.</returns>
+    public static string GetSettingsBackupFolderLocation()
+    {
+        return Path.Combine(GetSettingsFolderLocation(), BackupFolderName);
+    }
+
     /// <summary>
     ///     Method to get the settings file name.
     /// </summary>
@@ -86,6 +101,16 @@ public static string GetSettingsFileName()
         return $"{SettingsFileName}{SettingsFileExtension}";
     }
 
+    /// <summary>
+    ///     Method to get the legacy settings file name.
+    /// </summary>
+    /// <returns>Legacy settings file name.</returns>
+    [Obsolete("Legacy XML settings are no longer used, but the method is kept for migration purposes.")]
+    public static string GetLegacySettingsFileName()
+    {
+        return $"{SettingsFileName}{LegacySettingsFileExtension}";
+    }
+
     /// <summary>
     ///     Method to get the settings file path.
     /// </summary>
@@ -99,9 +124,10 @@ public static string GetSettingsFilePath()
     ///     Method to get the legacy XML settings file path.
     /// </summary>
     /// <returns>Legacy XML settings file path.</returns>
+    [Obsolete("Legacy XML settings are no longer used, but the method is kept for migration purposes.")]
     private static string GetLegacySettingsFilePath()
     {
-        return Path.Combine(GetSettingsFolderLocation(), $"{SettingsFileName}{LegacySettingsFileExtension}");
+        return Path.Combine(GetSettingsFolderLocation(), GetLegacySettingsFileName());
     }
 
     #endregion
@@ -151,16 +177,17 @@ public static void Load()
             // Save in new JSON format
             Save();
 
-            // Backup the old XML file with timestamp to avoid overwriting existing backups
-            // If a backup with the same timestamp exists (unlikely), it will be overwritten
-            // since it represents the same migration attempt
-            var backupFilePath = Path.Combine(GetSettingsFolderLocation(), 
-                $"{SettingsFileName}_{TimestampHelper.GetTimestamp()}{LegacySettingsFileExtension}.backup");
+            // Create a backup of the legacy XML file and delete the original
+            Directory.CreateDirectory(GetSettingsBackupFolderLocation());
+
+            var backupFilePath = Path.Combine(GetSettingsBackupFolderLocation(),
+                $"{TimestampHelper.GetTimestamp()}_{GetLegacySettingsFileName()}");
+
             File.Copy(legacyFilePath, backupFilePath, true);
-            Log.Info($"Legacy XML settings file backed up to: {backupFilePath}");
 
-            // Note: The original XML file is intentionally not deleted to allow users to revert if needed.
-            // Users can manually delete Settings.xml after verifying the migration was successful.
+            File.Delete(legacyFilePath);
+
+            Log.Info($"Legacy XML settings file backed up to: {backupFilePath}");
 
             Log.Info("Settings migration from XML to JSON completed successfully.");
 
@@ -182,11 +209,6 @@ private static SettingsInfo DeserializeFromFile(string filePath)
 
         var settingsInfo = JsonSerializer.Deserialize<SettingsInfo>(jsonString, JsonOptions);
 
-        if (settingsInfo == null)
-        {
-            throw new InvalidOperationException("Failed to deserialize settings from JSON file. The result was null.");
-        }
-
         return settingsInfo;
     }
 
@@ -195,6 +217,7 @@ private static SettingsInfo DeserializeFromFile(string filePath)
     /// </summary>
     /// <param name="filePath">Path to the XML settings file.</param>
     /// <returns>Settings as <see cref="SettingsInfo" />.</returns>
+    [Obsolete("Legacy XML settings are no longer used, but the method is kept for migration purposes.")]
     private static SettingsInfo DeserializeFromXmlFile(string filePath)
     {
         var xmlSerializer = new XmlSerializer(typeof(SettingsInfo));
@@ -203,11 +226,6 @@ private static SettingsInfo DeserializeFromXmlFile(string filePath)
 
         var settingsInfo = xmlSerializer.Deserialize(fileStream) as SettingsInfo;
 
-        if (settingsInfo == null)
-        {
-            throw new InvalidOperationException("Failed to deserialize settings from XML file. The result was null.");
-        }
-
         return settingsInfo;
     }
 
@@ -239,6 +257,19 @@ private static void SerializeToFile(string filePath)
 
     #endregion
 
+    #region Backup
+    /*
+    private static void Backup()
+    {
+        Log.Info("Creating settings backup...");
+
+        // Create the backup directory if it does not exist
+        Directory.CreateDirectory(GetSettingsBackupFolderLocation());
+    }
+    */
+
+    #endregion
+
     #region Upgrade
 
     /// <summary>

Source/NETworkManager/App.xaml.cs

@@ -93,15 +93,13 @@ by BornToBeRoot
         }
         catch (InvalidOperationException ex)
         {
-            Log.Error("Could not load application settings!");
-            Log.Error(ex.Message + "-" + ex.StackTrace);
-
+            Log.Error("Could not load application settings!", ex);
+            
             HandleCorruptedSettingsFile();
         }
         catch (JsonException ex)
         {
-            Log.Error("Could not load application settings! JSON file is corrupted or invalid.");
-            Log.Error(ex.Message + "-" + ex.StackTrace);
+            Log.Error("Could not load application settings! JSON file is corrupted or invalid.", ex);
 
             HandleCorruptedSettingsFile();
         }
@@ -225,8 +223,10 @@ private void HandleCorruptedSettingsFile()
         // Create backup of corrupted file
         var destinationFile =
             $"{TimestampHelper.GetTimestamp()}_corrupted_" + SettingsManager.GetSettingsFileName();
+
         File.Copy(SettingsManager.GetSettingsFilePath(),
             Path.Combine(SettingsManager.GetSettingsFolderLocation(), destinationFile));
+
         Log.Info($"A backup of the corrupted settings file has been saved under {destinationFile}");
 
         // Initialize default application settings
@@ -283,4 +283,4 @@ private void Save()
             ProfileManager.Save();
         }
     }
-}
+}