Changeset 412 for branches/eraser6/Eraser/Program.cs

Timestamp:

9/27/2008 9:00:44 AM (5 years ago)

Author:

lowjoel

Message:

Redesigned the Manager.Settings class.
-The plugin settings are no longer kept in a single dictionary; instead, they are distributed to be dealt with by the implementer of the Settings class. The GetSettings? and SetSettings? functions now are overloaded internally such that these values along with the plugins' GUID are sent together to the implementer class. The implementer class then stores it directly. This prevents unnecessary resource utilisation for large plugins and for plugins which are disabled
-This new design also allows for the serialisation and unserialisation of plugin settings which are non-primitive types, since the settings are loaded only on the initialisation of the plugin, not the initialisation of the settings object
-Created a SettingsChanged? event for classes to register callback functions to. This is useful when classes need to know when a setting is changed. Currently unimplemented though.
-Load is now a protected internal function which implementer classes must implement, this allows for the refreshing of settings whenever the program is running.

File:

• branches/eraser6/Eraser/Program.cs (modified) (3 diffs)

branches/eraser6/Eraser/Program.cs

@@ -99 +99 @@
     {
         public Settings()
+        {
+            Load();
+        }
+
+        protected override void Load()
         {
             RegistryKey key = Application.UserAppDataRegistry;
@@ -140 +145 @@
                 }
 
-            //Load the plugin settings.
-            byte[] pluginSettings = (byte[])key.GetValue("PluginSettings", new byte[0]);
-            if (pluginSettings.Length != 0)
-                using (MemoryStream stream = new MemoryStream(pluginSettings))
-                {
-                    try
-                    {
-                        this.pluginSettings = (Dictionary<Guid, Dictionary<string, object>>)
-                            new BinaryFormatter().Deserialize(stream);
-                    }
-                    catch (Exception)
-                    {
-                        key.DeleteValue("PluginSettings");
-                        MessageBox.Show(S._("Could not load plugin settings. All settings " +
-                            "have been lost."), S._("Eraser"), MessageBoxButtons.OK,
-                            MessageBoxIcon.Error);
-                    }
-                }
+            base.Load();
         }
 
@@ -179 +167 @@
             using (MemoryStream stream = new MemoryStream())
             {
-                new BinaryFormatter().Serialize(stream, pluginSettings);
-                key.SetValue("PluginSettings", stream.ToArray(), RegistryValueKind.Binary);
-            }
-
-            using (MemoryStream stream = new MemoryStream())
-            {
                 new BinaryFormatter().Serialize(stream, PlausibleDeniabilityFiles);
                 key.SetValue("PlausibleDeniabilityFiles", stream.ToArray(), RegistryValueKind.Binary);
             }
         }
+
+        protected override Dictionary<string, object> GetSettings(Guid guid)
+        {
+            //Open the registry key containing the settings
+            RegistryKey pluginsKey = Application.UserAppDataRegistry.OpenSubKey(
+                "Plugins\\" + guid.ToString(), true);
+            Dictionary<string, object> result = new Dictionary<string, object>();
+
+            //Load every key/value pair into the dictionary
+            if (pluginsKey != null)
+                foreach (string key in pluginsKey.GetValueNames())
+                {
+                    byte[] currentSetting = (byte[])pluginsKey.GetValue(key, null);
+                    if (currentSetting.Length != 0)
+                        using (MemoryStream stream = new MemoryStream(currentSetting))
+                        {
+                            try
+                            {
+                                result[key] = new BinaryFormatter().Deserialize(stream);
+                            }
+                            catch (Exception)
+                            {
+                                pluginsKey.DeleteValue(key);
+                                MessageBox.Show(string.Format(S._("Could not load the setting {0} for plugin {1}." +
+                                    "The setting has been lost."), key, guid.ToString()),
+                                    S._("Eraser"), MessageBoxButtons.OK, MessageBoxIcon.Error);
+                            }
+                        }
+                    else
+                        result[key] = null;
+                }
+
+            //We're done!
+            return result;
+        }
+
+        protected override void SetSettings(Guid guid, Dictionary<string, object> settings)
+        {
+            //Open the registry key containing the settings
+            RegistryKey pluginKey = Application.UserAppDataRegistry.OpenSubKey(
+                "Plugins\\" + guid.ToString(), true);
+            if (pluginKey == null)
+                pluginKey = Application.UserAppDataRegistry.CreateSubKey("Plugins\\" + guid.ToString());
+
+            foreach (string key in settings.Keys)
+            {
+                using (MemoryStream stream = new MemoryStream())
+                {
+                    new BinaryFormatter().Serialize(stream, settings[key]);
+                    pluginKey.SetValue(key, stream.ToArray(), RegistryValueKind.Binary);
+                }
+            }
+        }
     }
 }