Serialize Profiles

All writings now done through new serializer

Vocaluxe/Base/CConfig.cs

@@ -21,10 +21,8 @@ using System.Collections.ObjectModel;
 using System.ComponentModel;
 using System.IO;
 using System.Linq;
-using System.Text;
 using System.Text.RegularExpressions;
 using System.Windows.Forms;
-using System.Xml;
 using System.Xml.Serialization;
 using Vocaluxe.Lib.Sound.Record;
 using Vocaluxe.Lib.Webcam;
@@ -36,16 +34,6 @@ namespace Vocaluxe.Base
 {
     static class CConfig
     {
-        /// <summary>
-        ///     Uniform settings for writing XML files. ALWAYS use this!
-        /// </summary>
-        public static readonly XmlWriterSettings XMLSettings = new XmlWriterSettings
-            {
-                Indent = true,
-                Encoding = Encoding.UTF8,
-                ConformanceLevel = ConformanceLevel.Document
-            };
-
         private static bool _Initialized;
 
         // Base file and folder names (formerly from CSettings but they can be changed)

Vocaluxe/Base/CMain.cs

@@ -152,11 +152,6 @@ namespace Vocaluxe.Base
             return CConfig.GetMaxNumMics();
         }
 
-        public XmlWriterSettings GetXMLSettings()
-        {
-            return CConfig.XMLSettings;
-        }
-
         public bool GetLoadOldThemeFiles()
         {
             return CConfig.LoadOldThemeFiles;

VocaluxeLib/IBasic.cs

@@ -58,11 +58,6 @@ namespace VocaluxeLib
         bool IsMicConfigured(int playerNr);
         int GetMaxNumMics();
 
-        /// <summary>
-        ///     Get the uniform settings for writing XML files. ALWAYS use this!
-        /// </summary>
-        XmlWriterSettings GetXMLSettings();
-
         bool GetLoadOldThemeFiles();
     }
 

VocaluxeLib/Profile/CProfile.cs

@@ -16,6 +16,7 @@
 #endregion
 
 using System;
+using System.ComponentModel;
 using System.IO;
 using System.Xml;
 using System.Xml.Serialization;
@@ -35,20 +36,42 @@ namespace VocaluxeLib.Profile
 
     public class CProfile
     {
+        private struct SOldXmlProfile
+        {
+#pragma warning disable 649
+            public CProfile Info;
+#pragma warning restore 649
+        }
+
         [XmlIgnore] public int ID;
 
         public string PlayerName;
-        public string FilePath;
+        [XmlIgnore] public string FilePath;
-        public byte[] PasswordHash;
+        [DefaultValue(null)] public byte[] PasswordHash;
-        public byte[] PasswordSalt;
+        [DefaultValue(null)] public byte[] PasswordSalt;
 
         public EGameDifficulty Difficulty;
 
+        [XmlIgnore]
         public CAvatar Avatar { get; set; }
 
         public EUserRole UserRole;
         public EOffOn Active;
 
+        [XmlElement("Avatar")]
+        // ReSharper disable UnusedMember.Global
+        public string AvatarFileName
+            // ReSharper restore UnusedMember.Global
+        {
+            get { return Path.GetFileName(Avatar.FileName); }
+            set
+            {
+                Avatar = CBase.Profiles.GetAvatarByFilename(value);
+                if (Avatar == null)
+                    throw new Exception("Avatar '" + value + "' not found");
+            }
+        }
+
         public CProfile()
         {
             PlayerName = String.Empty;
@@ -66,34 +89,37 @@ namespace VocaluxeLib.Profile
 
         public bool LoadProfile()
         {
-            CXMLReader xmlReader = CXMLReader.OpenFile(FilePath);
+            var xml = new CXmlSerializer();
-            if (xmlReader == null)
+            try
-                return false;
-
-            string value = String.Empty;
-            if (xmlReader.GetValue("//root/Info/PlayerName", out value, value))
             {
-                PlayerName = value;
+                xml.Deserialize(FilePath, this);
-                string avatarFileName;
-                bool ok = xmlReader.TryGetEnumValue("//root/Info/Difficulty", ref Difficulty);
-                ok &= xmlReader.GetValue("//root/Info/Avatar", out avatarFileName);
-                Avatar = CBase.Profiles.GetAvatarByFilename(avatarFileName);
-                ok &= Avatar != null;
-                ok &= xmlReader.TryGetEnumValue("//root/Info/UserRole", ref UserRole);
-                ok &= xmlReader.TryGetEnumValue("//root/Info/Active", ref Active);
-                string passwordHash;
-                xmlReader.GetValue("//root/Info/PasswordHash", out passwordHash);
-                PasswordHash = !string.IsNullOrEmpty(passwordHash) ? Convert.FromBase64String(passwordHash) : null;
-                string passwordSalt;
-                xmlReader.GetValue("//root/Info/PasswordSalt", out passwordSalt);
-                PasswordSalt = !string.IsNullOrEmpty(passwordSalt) ? Convert.FromBase64String(passwordSalt) : null;
-                if (!ok)
-                    CBase.Log.LogError("Error loading profile file: " + FilePath);
-                return ok;
             }
+            catch (Exception e)
+            {
+                if (_ConvertProfile(ref e))
+                    return true;
+                CBase.Log.LogError("Error loading profile file " + Path.GetFileName(FilePath) + ": " + e.Message);
+                return false;
+            }
+            return true;
+        }
 
-            CBase.Log.LogError("Can't find PlayerName in Profile File: " + FilePath);
+        private bool _ConvertProfile(ref Exception e)
-            return false;
+        {
+            var xml = new CXmlSerializer();
+            try
+            {
+                var old = xml.Deserialize<SOldXmlProfile>(FilePath);
+                string newXml = xml.Serialize(old.Info);
+                xml.DeserializeString(newXml, this);
+            }
+            catch (Exception e2)
+            {
+                if (!(e2 is XmlException))
+                    e = e2;
+                return false;
+            }
+            return true;
         }
 
         public void SaveProfile()
@@ -115,42 +141,8 @@ namespace VocaluxeLib.Profile
                 FilePath = Path.Combine(CBase.Settings.GetDataPath(), CBase.Settings.GetFolderProfiles(), CHelper.GetUniqueFileName(FilePath, filename + ".xml", false));
             }
 
-            XmlWriter writer;
+            var xml = new CXmlSerializer();
-            try
+            xml.Serialize(FilePath, this);
-            {
-                writer = XmlWriter.Create(FilePath, CBase.Config.GetXMLSettings());
-            }
-            catch (Exception e)
-            {
-                CBase.Log.LogError("Error creating/opening Profile File " + FilePath + ": " + e.Message);
-                return;
-            }
-            try
-            {
-                writer.WriteStartDocument();
-                writer.WriteStartElement("root");
-
-                writer.WriteStartElement("Info");
-                writer.WriteElementString("PlayerName", PlayerName);
-                writer.WriteElementString("Difficulty", Enum.GetName(typeof(EGameDifficulty), Difficulty));
-                writer.WriteElementString("Avatar", Path.GetFileName(Avatar.FileName));
-                writer.WriteElementString("UserRole", Enum.GetName(typeof(EUserRole), UserRole));
-                writer.WriteElementString("Active", Enum.GetName(typeof(EOffOn), Active));
-                if (PasswordHash != null)
-                    writer.WriteElementString("PasswordHash", Convert.ToBase64String(PasswordHash));
-                if (PasswordSalt != null)
-                    writer.WriteElementString("PasswordSalt", Convert.ToBase64String(PasswordSalt));
-                writer.WriteEndElement();
-
-                writer.WriteEndElement(); //end of root
-                writer.WriteEndDocument();
-
-                writer.Flush();
-            }
-            finally
-            {
-                writer.Close();
-            }
         }
     }
 }