Changeset 2288

Timestamp:

1/4/2011 5:23:07 AM (2 years ago)

Author:

lowjoel

Message:

First compilable version.

• Whether plugins are allowed to be loaded is now a callback function which must be set by the initialising class, otherwise all plugins found are loaded
• Split the PluginLoadedEventArgs? class to its own file

Location:

branches/eraser6/pluginsRewrite

Files:

• Eraser.Manager/ManagerLibrary.cs (modified) (4 diffs)
• Eraser.Manager/Settings.cs (modified) (2 diffs)
• Eraser.Plugins/Eraser.Plugins.csproj (modified) (2 diffs)
• Eraser.Plugins/PluginLoadEventArgs.cs (added)
• Eraser.Plugins/PluginLoadedEventArgs.cs (added)
• Eraser.Plugins/Plugins.cs (modified) (6 diffs)
• Eraser.Plugins/Properties/AssemblyInfo.cs (modified) (1 diff)

branches/eraser6/pluginsRewrite/Eraser.Manager/ManagerLibrary.cs

@@ -24 +24 @@
 using System.Text;
 using System.Runtime.Serialization;
+
+using Eraser.Plugins;
+using Eraser.Util;
 
 namespace Eraser.Manager
@@ -62 +65 @@
             {
                 EntropySourceRegistrar.Poller.Abort();
-                Host.Dispose();
+                Host.Instance.Dispose();
                 SettingsManager.Save();
             }
@@ -74 +77 @@
             Dispose(true);
             GC.SuppressFinalize(this);
+        }
+
+        private void OnPluginLoad(object sender, PluginLoadEventArgs e)
+        {
+            //If the plugin does not have an approval or denial, check for the presence of
+            //a valid signature.
+            IDictionary<Guid, bool> approvals = ManagerLibrary.Settings.PluginApprovals;
+            if (!approvals.ContainsKey(e.Plugin.AssemblyInfo.Guid) &&
+                (e.Plugin.Assembly.GetName().GetPublicKey().Length == 0 ||
+                !Security.VerifyStrongName(e.Plugin.Assembly.Location) ||
+                e.Plugin.AssemblyAuthenticode == null))
+            {
+                e.Load = false;
+            }
+
+            //Is there an approval or denial?
+            else if (approvals.ContainsKey(e.Plugin.AssemblyInfo.Guid))
+                e.Load = approvals[e.Plugin.AssemblyInfo.Guid];
+
+            //There's no approval or denial, what is the specified loading policy?
+            else
+                e.Load = e.Plugin.LoadingPolicy != LoadingPolicy.DefaultOff;
         }
 
@@ -129 +154 @@
         /// </summary>
         private static ManagerSettings settingsInstance;
-
-        /// <summary>
-        /// The global instance of the Plugin host.
-        /// </summary>
-        internal Plugin.DefaultHost Host;
     }
 }

branches/eraser6/pluginsRewrite/Eraser.Manager/Settings.cs

@@ -25 +25 @@
 using System.Reflection;
 using System.Runtime.InteropServices;
+using System.Globalization;
+
 using Eraser.Util;
-using System.Globalization;
+using Eraser.Plugins;
 
 namespace Eraser.Manager
@@ -374 +376 @@
 
             //We have not computed the value. Compute the default.
-            Plugin.Host pluginHost = ManagerLibrary.Instance.Host;
-            IList<Plugin.PluginInstance> plugins = pluginHost.Plugins;
+            Host pluginHost = Host.Instance;
+            IList<PluginInstance> plugins = pluginHost.Plugins;
             SortedList<int, Guid> priorities = new SortedList<int, Guid>();
 
-            foreach (Plugin.PluginInstance plugin in plugins)
+            foreach (PluginInstance plugin in plugins)
             {
                 //Check whether the plugin is signed by us.

branches/eraser6/pluginsRewrite/Eraser.Plugins/Eraser.Plugins.csproj

@@ -13 +13 @@
     <TargetFrameworkVersion>v3.5</TargetFrameworkVersion>
     <FileAlignment>512</FileAlignment>
+    <SignAssembly>true</SignAssembly>
+    <AssemblyOriginatorKeyFile>..\Strong Name.snk</AssemblyOriginatorKeyFile>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
@@ -49 +51 @@
     <Compile Include="IConfigurer.cs" />
     <Compile Include="IRegistrar.cs" />
+    <Compile Include="PluginLoadedEventArgs.cs" />
+    <Compile Include="PluginLoadEventArgs.cs" />
     <Compile Include="Plugins.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />

branches/eraser6/pluginsRewrite/Eraser.Plugins/Plugins.cs

@@ -32 +32 @@
 
 using Eraser.Util;
-
-namespace Eraser.Manager.Plugin
+using Eraser.Util.ExtensionMethods;
+using Path = System.IO.Path;
+
+namespace Eraser.Plugins
 {
     /// <summary>
@@ -94 +96 @@
 
         /// <summary>
+        /// The plugin load event, allowing clients to decide whether to load
+        /// the given plugin.
+        /// </summary>
+        public EventHandler<PluginLoadEventArgs> PluginLoad { get; set; }
+
+        /// <summary>
         /// The plugin loaded event.
         /// </summary>
@@ -116 +124 @@
         /// and return True.</remarks>
         public abstract bool LoadPlugin(string filePath);
-    }
-
-    /// <summary>
-    /// Event argument for the plugin loaded event.
-    /// </summary>
-    public class PluginLoadedEventArgs : EventArgs
-    {
-        /// <summary>
-        /// Constructor.
-        /// </summary>
-        /// <param name="instance">The plugin instance of the recently loaded plugin.</param>
-        public PluginLoadedEventArgs(PluginInstance instance)
-        {
-            Instance = instance;
-        }
-
-        /// <summary>
-        /// The <see cref="PluginInstance"/> object representing the newly loaded plugin.
-        /// </summary>
-        public PluginInstance Instance { get; private set; }
     }
 
@@ -308 +296 @@
                 plugins.Add(instance);
 
-            //If the plugin does not have an approval or denial, check for the presence of
-            //a valid signature.
-            IDictionary<Guid, bool> approvals = ManagerLibrary.Settings.PluginApprovals;
-            if (!approvals.ContainsKey(instance.AssemblyInfo.Guid) &&
-                (reflectAssembly.GetName().GetPublicKey().Length == 0 ||
-                !Security.VerifyStrongName(filePath) ||
-                instance.AssemblyAuthenticode == null))
-            {
-                return false;
-            }
-
-            //Preliminary checks to verify whether the plugin can be loaded (safely) passes,
-            //Load the assembly fully, and then initialise it.
-            instance.Assembly = Assembly.Load(reflectAssembly.GetName());
-            
-            //The plugin either is explicitly allowed or disallowed to load, or
-            //it has an Authenticode Signature as well as a Strong Name. Get the
-            //loading policy of the plugin.
-            {
-                
-            }
-
-            bool initialisePlugin = false;
-
-            //Is there an approval or denial?
-            if (approvals.ContainsKey(instance.AssemblyInfo.Guid))
-                initialisePlugin = approvals[instance.AssemblyInfo.Guid];
-
-            //There's no approval or denial, what is the specified loading policy?
-            else
-                initialisePlugin = instance.LoadingPolicy != LoadingPolicy.DefaultOff;
-
-            if (initialisePlugin)
+            PluginLoadEventArgs e = new PluginLoadEventArgs(instance);
+            PluginLoad(this, e);
+            if (PluginLoad == null || e.Load)
             {
                 InitialisePlugin(instance);
@@ -353 +311 @@
         /// </summary>
         /// <param name="instance">The <see cref="PluginInstance"/> structure to fill.</param>
+        /// <exception cref="System.IO.FileLoadException" />
         private void InitialisePlugin(PluginInstance instance)
         {
@@ -373 +332 @@
             catch (System.Security.SecurityException e)
             {
-                MessageBox.Show(S._("Could not load the plugin {0}.\n\nThe error returned was: {1}",
-                    instance.Assembly.Location, e.Message), S._("Eraser"), MessageBoxButtons.OK,
-                    MessageBoxIcon.Error, MessageBoxDefaultButton.Button1,
-                    Localisation.IsRightToLeft(null) ?
-                        MessageBoxOptions.RtlReading | MessageBoxOptions.RightAlign : 0);
+                throw new FileLoadException(S._("Could not load the plugin."),
+                    instance.Assembly.Location, e);
             }
         }

branches/eraser6/pluginsRewrite/Eraser.Plugins/Properties/AssemblyInfo.cs

@@ -22 +22 @@
 // The following GUID is for the ID of the typelib if this project is exposed to COM
 [assembly: Guid("1c4e0bd3-4272-4cc8-9fb6-d0e0703b2013")]
-
-// Version information for an assembly consists of the following four values:
-//
-//      Major Version
-//      Minor Version 
-//      Build Number
-//      Revision
-//
-// You can specify all the values or you can default the Build and Revision Numbers 
-// by using the '*' as shown below:
-// [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.0.0.0")]
-[assembly: AssemblyFileVersion("1.0.0.0")]