Feature: Migrate xml to json

Author: BornToBeRoot

Source/NETworkManager.Profiles/ProfileManager.cs

@@ -1,5 +1,4 @@
 using log4net;
-using NETworkManager.Models.Network;
 using NETworkManager.Settings;
 using NETworkManager.Utilities;
 using System;
@@ -135,6 +134,36 @@ private static void LoadedProfileFileChanged(ProfileFileInfo profileFileInfo, bo
         OnLoadedProfileFileChangedEvent?.Invoke(null, new ProfileFileInfoArgs(profileFileInfo, profileFileUpdating));
     }
 
+    /// <summary>
+    /// Occurs when the profile migration process begins.
+    /// </summary>    
+    [Obsolete("Will be removed after some time, as profile migration from legacy XML files is a one-time process.")]
+    public static event EventHandler OnProfileMigrationStarted;
+
+    /// <summary>
+    /// Raises the event indicating that the profile migration process from legacy XML files has started.
+    /// </summary>    
+    [Obsolete("Will be removed after some time, as profile migration from legacy XML files is a one-time process.")]
+    private static void ProfileMigrationStarted()
+    {
+        OnProfileMigrationStarted?.Invoke(null, EventArgs.Empty);
+    }
+
+    /// <summary>
+    /// Occurs when the profile migration from legacy XML files has completed.
+    /// </summary>    
+    [Obsolete("Will be removed after some time, as profile migration from legacy XML files is a one-time process.")]
+    public static event EventHandler OnProfileMigrationCompleted;
+
+    /// <summary>
+    /// Raises the event indicating that the profile migration from legacy XML files has completed.
+    /// </summary>    
+    [Obsolete("Will be removed after some time, as profile migration from legacy XML files is a one-time process.")]
+    private static void ProfileMigrationCompleted()
+    {
+        OnProfileMigrationCompleted?.Invoke(null, EventArgs.Empty);
+    }
+
     /// <summary>
     ///     Event is fired if the profiles have changed.
     /// </summary>
@@ -507,7 +536,30 @@ private static void Load(ProfileFileInfo profileFileInfo)
 
                 if (IsXmlContent(decryptedBytes))
                 {
-                    groups = new List<GroupInfo>(); // ToDo
+                    //
+                    // MIGRATION FROM LEGACY XML PROFILE FILE
+                    //
+
+                    Log.Info($"Legacy XML profile file detected inside encrypted profile: {profileFileInfo.Path}. Migration in progress...");
+
+                    // Load from legacy XML byte array
+                    groups = DeserializeFromXmlByteArray(decryptedBytes);
+
+                    // Create a backup of the legacy XML file
+                    Backup(profileFileInfo.Path,
+                        GetSettingsBackupFolderLocation(),
+                        TimestampHelper.GetTimestampFilename(Path.GetFileName(profileFileInfo.Path)));
+
+                    // Save encrypted profile file with new JSON format
+                    var newDecryptedBytes = SerializeToByteArray([.. groups]);
+                    var newEncryptedBytes = CryptoHelper.Encrypt(newDecryptedBytes,
+                        SecureStringHelper.ConvertToString(profileFileInfo.Password),
+                        GlobalStaticConfiguration.Profile_EncryptionKeySize,
+                        GlobalStaticConfiguration.Profile_EncryptionIterations);
+
+                    File.WriteAllBytes(profileFileInfo.Path, newEncryptedBytes);
+
+                    Log.Info($"Legacy XML profile file migration completed inside encrypted profile: {profileFileInfo.Path}.");
                 }
                 else
                 {
@@ -528,6 +580,9 @@ private static void Load(ProfileFileInfo profileFileInfo)
 
                 if (Path.GetExtension(profileFileInfo.Path) == LegacyProfileFileExtension)
                 {
+                    //
+                    // MIGRATION FROM LEGACY XML PROFILE FILE
+                    //
                     Log.Info($"Legacy XML profile file detected: {profileFileInfo.Path}. Migration in progress...");
 
                     // Load from legacy XML file
@@ -537,22 +592,23 @@ private static void Load(ProfileFileInfo profileFileInfo)
 
                     LoadedProfileFile = profileFileInfo;
 
+                    // Create a backup of the legacy XML file and delete the original
+                    Backup(profileFileInfo.Path,
+                        GetSettingsBackupFolderLocation(),
+                        TimestampHelper.GetTimestampFilename(Path.GetFileName(profileFileInfo.Path)));
+
                     // Create new profile file info with JSON extension
                     var newProfileFileInfo = new ProfileFileInfo(profileFileInfo.Name,
                         Path.ChangeExtension(profileFileInfo.Path, ProfileFileExtension));
 
                     // Save new JSON file
                     SerializeToFile(newProfileFileInfo.Path, groups);
 
-                    // Create a backup of the legacy XML file and delete the original
-                    Backup(profileFileInfo.Path,
-                        GetSettingsBackupFolderLocation(),
-                        TimestampHelper.GetTimestampFilename(Path.GetFileName(profileFileInfo.Path)));
-                                                            
+                    // Notify migration started
+                    ProfileMigrationStarted();
+
                     // Add the new profile
-                    Log.Info("Adding migrated profile file to the profile files list.");
                     ProfileFiles.Add(newProfileFileInfo);
-                    Log.Info("Migrated profile file added to the profile files list.");
 
                     // Switch profile
                     Log.Info($"Switching to migrated profile file: {newProfileFileInfo.Path}.");
@@ -563,6 +619,9 @@ private static void Load(ProfileFileInfo profileFileInfo)
                     File.Delete(profileFileInfo.Path);
                     ProfileFiles.Remove(profileFileInfo);
 
+                    // Notify migration completed
+                    ProfileMigrationCompleted();
+
                     Log.Info($"Legacy XML profile file migration completed: {profileFileInfo.Path}.");
                     return;
                 }

Source/NETworkManager/MainWindow.xaml.cs

@@ -33,7 +33,6 @@
 using System.Windows.Interop;
 using System.Windows.Markup;
 using System.Windows.Threading;
-using static System.Runtime.InteropServices.JavaScript.JSType;
 using Application = System.Windows.Application;
 using ContextMenu = System.Windows.Controls.ContextMenu;
 using MouseEventArgs = System.Windows.Forms.MouseEventArgs;
@@ -1376,6 +1375,8 @@ private void LoadProfiles()
         _isProfileFilesLoading = false;
 
         ProfileManager.OnLoadedProfileFileChangedEvent += ProfileManager_OnLoadedProfileFileChangedEvent;
+        ProfileManager.OnProfileMigrationStarted += ProfileManager_OnProfileMigrationStarted;
+        ProfileManager.OnProfileMigrationCompleted += ProfileManager_OnProfileMigrationCompleted;
 
         SelectedProfileFile = ProfileFiles.SourceCollection.Cast<ProfileFileInfo>()
             .FirstOrDefault(x => x.Name == SettingsManager.Current.Profiles_LastSelected);
@@ -1472,7 +1473,7 @@ private void OnProfilesLoaded(ApplicationName name)
     /// <param name="sender"></param>
     /// <param name="e"></param>
     private void ProfileManager_OnLoadedProfileFileChangedEvent(object sender, ProfileFileInfoArgs e)
-    {        
+    {
         _isProfileFileUpdating = e.ProfileFileUpdating;
 
         SelectedProfileFile = ProfileFiles.SourceCollection.Cast<ProfileFileInfo>()
@@ -1481,6 +1482,16 @@ private void ProfileManager_OnLoadedProfileFileChangedEvent(object sender, Profi
         _isProfileFileUpdating = false;
     }
 
+    private void ProfileManager_OnProfileMigrationCompleted(object sender, EventArgs e)
+    {
+        _isProfileFileUpdating = false;
+    }
+
+    private void ProfileManager_OnProfileMigrationStarted(object sender, EventArgs e)
+    {
+        _isProfileFileUpdating = true;
+    }
+
     #endregion
 
     #region Update check