Changeset 2503

Timestamp:

11/17/09 14:03:40 (15 years ago)

Author:

gkronber

Message:

Moved classes from project PluginInfrastructure.Manager to PluginInfrastructure make it easier to declare strict accessibility constraints. #799

Location:

branches/PluginInfrastructure Refactoring

Files:

• HeuristicLab.PluginInfrastructure.Manager/HeuristicLab.PluginInfrastructure.Manager.csproj (modified) (1 diff)
• HeuristicLab.PluginInfrastructure.Manager/Runner.cs (deleted)
• HeuristicLab.PluginInfrastructure/ApplicationDescription.cs (moved) (moved from branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure.Manager/ApplicationDescription.cs)
• HeuristicLab.PluginInfrastructure/ApplicationManager.cs (modified) (1 diff)
• HeuristicLab.PluginInfrastructure/BaseClasses/PluginBase.cs (modified) (2 diffs)
• HeuristicLab.PluginInfrastructure/DefaultApplicationManager.cs (moved) (moved from branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure.Manager/DefaultApplicationManager.cs) (5 diffs)
• HeuristicLab.PluginInfrastructure/HeuristicLab.PluginInfrastructure.csproj (modified) (4 diffs)
• HeuristicLab.PluginInfrastructure/Interfaces/IPlugin.cs (modified) (1 diff)
• HeuristicLab.PluginInfrastructure/Manager (added)
• HeuristicLab.PluginInfrastructure/PluginDescription.cs (moved) (moved from branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure.Manager/PluginDescription.cs)
• HeuristicLab.PluginInfrastructure/PluginInfrastructureEventArgs.cs (moved) (moved from branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure.Manager/PluginInfrastructureEventArgs.cs) (1 diff)
• HeuristicLab.PluginInfrastructure/PluginManager.cs (moved) (moved from branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure.Manager/PluginManager.cs) (6 diffs)
• HeuristicLab.PluginInfrastructure/PluginValidator.cs (moved) (moved from branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure.Manager/Loader.cs) (10 diffs)
• HeuristicLab/HeuristicLab.csproj (modified) (1 diff)

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure.Manager/HeuristicLab.PluginInfrastructure.Manager.csproj

@@ -50 +50 @@
     <Compile Include="ApplicationDescription.cs" />
     <Compile Include="DefaultApplicationManager.cs" />
-    <Compile Include="Loader.cs" />
     <Compile Include="PluginDescription.cs" />
     <Compile Include="PluginInfrastructureEventArgs.cs" />
     <Compile Include="PluginManager.cs" />
+    <Compile Include="PluginValidator.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/ApplicationManager.cs

@@ -31 +31 @@
 namespace HeuristicLab.PluginInfrastructure {
 
+  /// <summary>
+  /// The ApplicationManager has a reference to the application manager singleton.
+  /// The application manager provides
+  /// </summary>
   public static class ApplicationManager {
     private static IApplicationManager appManager;
+    /// <summary>
+    /// Gets the application manager singleton.
+    /// </summary>
     public static IApplicationManager Manager {
       get { return appManager; }
     }
 
-    public static void RegisterApplicationManager(IApplicationManager manager) {
+    /// <summary>
+    /// Registers a new application manager.
+    /// </summary>
+    /// <param name="manager"></param>
+    internal static void RegisterApplicationManager(IApplicationManager manager) {
       if (appManager != null) throw new InvalidOperationException("The application manager has already been set.");
       appManager = manager;

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/BaseClasses/PluginBase.cs

@@ -56 +56 @@
     }
 
-    ///// <inheritdoc />
-    //public Version Version {
-    //  get {
-    //    var pluginAttribute = PluginDescriptionAttribute;
-    //    // if the version is not set in the attribute then the version of the assembly is used as default
-    //    if (string.IsNullOrEmpty(pluginAttribute.Version)) {
-    //      return this.GetType().Assembly.GetName().Version;
-    //    } else {
-    //      return new Version(pluginAttribute.Version);
-    //    }
-    //  }
-    //}
-
-    ///// <inheritdoc />
-    //public string Description {
-    //  get {
-    //    var pluginAttribute = PluginDescriptionAttribute;
-    //    // if the description is not explicitly set in the attribute then the name of the plugin is used as default
-    //    if (string.IsNullOrEmpty(pluginAttribute.Description)) {
-    //      return pluginAttribute.Name;
-    //    } else {
-    //      return pluginAttribute.Description;
-    //    }
-    //  }
-    //}
 
     /// <inheritdoc/>
@@ -94 +69 @@
     /// <inhertitdoc>
     public virtual void OnLoad() { }
+    /// <inhertitdoc>
+    public virtual void OnUnload() { }
     #endregion
 

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/DefaultApplicationManager.cs

@@ -32 +32 @@
 namespace HeuristicLab.PluginInfrastructure.Manager {
 
-  public class DefaultApplicationManager : MarshalByRefObject, IApplicationManager {
+  public sealed class DefaultApplicationManager : MarshalByRefObject, IApplicationManager {
     internal event EventHandler<PluginInfrastructureEventArgs> PluginLoaded;
+    internal event EventHandler<PluginInfrastructureEventArgs> PluginUnloaded;
+
     // cache for the AssemblyResolveEvent 
     // which must be handled when assemblies are loaded dynamically after the application start
     private Dictionary<string, Assembly> loadedAssemblies;
 
+    private List<IPlugin> loadedPlugins;
+
     private List<IPluginDescription> plugins;
     /// <summary>
@@ -55 +59 @@
     }
 
-    public DefaultApplicationManager()
+    internal DefaultApplicationManager()
       : base() {
       loadedAssemblies = new Dictionary<string, Assembly>();
+      loadedPlugins = new List<IPlugin>();
       // needed for the special case when assemblies are loaded dynamically via LoadAssemblies()
       AppDomain.CurrentDomain.AssemblyResolve += (sender, args) => {
@@ -83 +88 @@
           foreach (var plugin in GetInstances<IPlugin>(asm)) {
             plugin.OnLoad();
+            loadedPlugins.Add(plugin);
           }
         }
-        FirePluginLoaded(desc);
+        OnPluginLoaded(new PluginInfrastructureEventArgs("Plugin loaded", desc));
         desc.Load();
       }
@@ -105 +111 @@
           e.ToString()));
       }
+      finally {
+        // unload plugins in reverse order
+        foreach (var plugin in loadedPlugins.Reverse<IPlugin>()) {
+          plugin.OnUnload();
+        }
+        foreach (var desc in PluginDescriptionIterator.IterateInDependencyOrder(plugins.Where(x => x.PluginState != PluginState.Disabled))) {
+          desc.Unload();
+          OnPluginUnloaded(new PluginInfrastructureEventArgs("Plugin unloaded", desc));
+        }
+      }
     }
 
@@ -203 +219 @@
     }
 
-    private void FirePluginLoaded(IPluginDescription plugin) {
-      if (PluginLoaded != null) PluginLoaded(this, new PluginInfrastructureEventArgs("Plugin loaded", plugin));
+    private void OnPluginLoaded(PluginInfrastructureEventArgs e) {
+      if (PluginLoaded != null) PluginLoaded(this, e);
+    }
+
+    private void OnPluginUnloaded(PluginInfrastructureEventArgs e) {
+      if (PluginUnloaded != null) PluginUnloaded(this, e);
     }
 

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/HeuristicLab.PluginInfrastructure.csproj

@@ -86 +86 @@
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="ApplicationDescription.cs" />
     <Compile Include="Attributes\ApplicationAttribute.cs" />
     <Compile Include="Attributes\AssemblyBuildDateAttribute.cs" />
@@ -93 +94 @@
     <Compile Include="BaseClasses\ApplicationBase.cs" />
     <Compile Include="BaseClasses\PluginBase.cs" />
+    <Compile Include="DefaultApplicationManager.cs" />
     <Compile Include="Interfaces\IApplicationManager.cs" />
     <Compile Include="Interfaces\IApplicationDescription.cs" />
@@ -102 +104 @@
     <Compile Include="Interfaces\IPluginDescription.cs" />
     <Compile Include="InvalidPluginException.cs" />
+    <Compile Include="PluginDescription.cs" />
     <Compile Include="PluginDescriptionIterator.cs" />
     <Compile Include="ApplicationManager.cs" />
+    <Compile Include="PluginInfrastructureEventArgs.cs" />
+    <Compile Include="PluginManager.cs" />
     <Compile Include="PluginState.cs" />
+    <Compile Include="PluginValidator.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <EmbeddedResource Include="Properties\Resources.resx">
@@ -129 +135 @@
     </Compile>
   </ItemGroup>
+  <ItemGroup>
+    <Folder Include="Manager\" />
+  </ItemGroup>
   <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/Interfaces/IPlugin.cs

@@ -51 +51 @@
     /// </summary>
     void OnLoad();
+
+    /// <summary>
+    /// Called by the framework whenever the plugin is unloaded.
+    /// Plugins are unloaded when an application exits.
+    /// </summary>
+    void OnUnload();
   }
 }

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/PluginInfrastructureEventArgs.cs

@@ -24 +24 @@
 using System.Text;
 
-namespace HeuristicLab.PluginInfrastructure {
+namespace HeuristicLab.PluginInfrastructure.Manager {
   // to be replaced by GenericEventArgs
   [Serializable]

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/PluginManager.cs

@@ -35 +35 @@
   /// Class to manage different plugins.
   /// </summary>
-  public class PluginManager : MarshalByRefObject {
+  public sealed class PluginManager : MarshalByRefObject {
     /// <summary>
     /// Event handler for actions in the plugin manager.
@@ -42 +42 @@
 
     private string pluginDir;
-
-    public PluginManager(string pluginDir) {
-      this.pluginDir = pluginDir;
-    }
 
     private List<PluginDescription> plugins;
@@ -57 +53 @@
     }
 
+    private object locker = new object();
+    private bool initialized;
+
+    public PluginManager(string pluginDir) {
+      this.pluginDir = pluginDir;
+      plugins = new List<PluginDescription>();
+      applications = new List<ApplicationDescription>();
+      Reset();
+    }
+
+    public void Reset() {
+      initialized = false;
+      if (plugins != null && plugins.Any(x => x.PluginState == PluginState.Loaded)) throw new InvalidOperationException("Reset() is not allowed while applications are active.");
+      plugins.Clear();
+      applications.Clear();
+    }
+
     /// <summary>
     /// Determines installed plugins and checks if all plugins are loadable.
     /// </summary>
     public void DiscoverAndCheckPlugins() {
-      FireAction("Initializing", "PluginInfrastructure");
+      OnAction(new PluginInfrastructureEventArgs("Initializing", "PluginInfrastructure"));
       AppDomainSetup setup = AppDomain.CurrentDomain.SetupInformation;
       setup.PrivateBinPath = pluginDir;
@@ -67 +80 @@
       try {
         pluginDomain = AppDomain.CreateDomain("plugin domain", null, setup);
-        Loader remoteLoader = (Loader)pluginDomain.CreateInstanceAndUnwrap("HeuristicLab.PluginInfraStructure.Manager", "HeuristicLab.PluginInfrastructure.Manager.Loader");
-        remoteLoader.PluginDir = pluginDir;
-        // forward all events from the remoteLoader to listeners
-        remoteLoader.PluginLoaded += delegate(object sender, PluginInfrastructureEventArgs args) { FireAction(args.Action, args.Entity); };
-        this.plugins = new List<PluginDescription>(remoteLoader.Plugins);
-        this.applications = new List<ApplicationDescription>(remoteLoader.Applications);
-        FireAction("Initialized", "PluginInfrastructure");
+        PluginValidator remoteValidator = (PluginValidator)pluginDomain.CreateInstanceAndUnwrap("HeuristicLab.PluginInfraStructure.Manager", "HeuristicLab.PluginInfrastructure.Manager.Loader");
+        remoteValidator.PluginDir = pluginDir;
+        // forward all events from the remoteValidator to listeners
+        remoteValidator.PluginLoaded +=
+          delegate(object sender, PluginInfrastructureEventArgs e) {
+            OnAction(e);
+          };
+        // get list of plugins and applications from the validator
+        plugins.Clear(); applications.Clear();
+        plugins.AddRange(remoteValidator.Plugins);
+        applications.AddRange(remoteValidator.Applications);
+        OnAction(new PluginInfrastructureEventArgs("Initialized", "PluginInfrastructure"));
       }
       finally {
         // discard the AppDomain that was used for plugin discovery
-        UnloadAppDomain(pluginDomain);
+        AppDomain.Unload(pluginDomain);
+        // unload all plugins
+        foreach (var pluginDescription in plugins)
+          pluginDescription.Unload();
+        initialized = true;
       }
     }
@@ -83 +105 @@
 
     /// <summary>
-    /// Creates a separate AppDomain.
-    /// Loads all active plugin assemblies and starts the application in the new AppDomain via a PluginRunner instance activated in the new AppDomain
+    /// Starts and application in a separate AppDomain.
+    /// Loads all enabled plugins and starts the application via a PluginRunner instance activated in the new AppDomain.
     /// </summary>
     /// <param name="appInfo">application to run</param>
     public void Run(ApplicationDescription appInfo) {
+      if (!initialized) throw new InvalidOperationException("PluginManager is not initialized. DiscoverAndCheckPlugins() must be called before Run()");
       // create a separate AppDomain for the application
       // initialize the static ApplicationManager in the AppDomain
       // and remotely tell it to start the application
 
-      FireAction("Starting application", appInfo.Name);
+      OnAction(new PluginInfrastructureEventArgs("Starting application", appInfo));
       AppDomain applicationDomain = null;
       try {
@@ -101 +124 @@
           (DefaultApplicationManager)applicationDomain.CreateInstanceAndUnwrap("HeuristicLab.PluginInfraStructure.Manager", "HeuristicLab.PluginInfrastructure.Manager.DefaultApplicationManager");
         applicationManager.PluginLoaded += applicationManager_PluginLoaded;
+        applicationManager.PluginUnloaded += applicationManager_PluginUnloaded;
         applicationManager.PrepareApplicationDomain(
           new List<IApplicationDescription>(applications.Cast<IApplicationDescription>()),
           new List<IPluginDescription>(plugins.Cast<IPluginDescription>()));
-        FireAction("Started application", appInfo.Name);
+        OnAction(new PluginInfrastructureEventArgs("Started application", appInfo));
         applicationManager.Run(appInfo);
       }
       finally {
         // make sure domain is unloaded in all cases
-        UnloadAppDomain(applicationDomain);
+        AppDomain.Unload(applicationDomain);
       }
     }
 
-    void applicationManager_PluginLoaded(object sender, PluginInfrastructureEventArgs e) {
+    private void applicationManager_PluginUnloaded(object sender, PluginInfrastructureEventArgs e) {
+      // unload the matching plugin description (
+      PluginDescription desc = (PluginDescription)e.Entity;
+
+      // access to plugin descriptions has to be synchronized because multiple applications 
+      // can be started or stopped at the same time
+      lock (locker) {
+        plugins.First(x => x.Equals(desc)).Unload();
+      }
+      OnAction(new PluginInfrastructureEventArgs(e.Action, e.Entity));
+    }
+
+    private void applicationManager_PluginLoaded(object sender, PluginInfrastructureEventArgs e) {
       // load the matching plugin description (
       PluginDescription desc = (PluginDescription)e.Entity;
-      foreach (var myDesc in plugins) {
-        if (myDesc.Equals(desc)) myDesc.Load();
+      // access to plugin descriptions has to be synchronized because multiple applications 
+      // can be started or stopped at the same time
+      lock (locker) {
+        plugins.First(x => x.Equals(desc)).Load();
       }
-      FireAction(e.Action, e.Entity);
+      OnAction(new PluginInfrastructureEventArgs(e.Action, e.Entity));
     }
 
-    private void UnloadAppDomain(AppDomain appDomain) {
-      AppDomain.Unload(appDomain);
-
-      // TODO: Update plugin descriptions in all active AppDomains
-
-      // unload all plugins
-      foreach (var pluginDescription in plugins)
-        pluginDescription.Unload();
-    }
-
-    private void FireAction(string action, object entity) {
+    private void OnAction(PluginInfrastructureEventArgs e) {
       if (Action != null) {
-        Action(this, new PluginInfrastructureEventArgs(action, entity));
+        Action(this, e);
       }
     }

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/PluginValidator.cs

@@ -30 +30 @@
 
 namespace HeuristicLab.PluginInfrastructure.Manager {
-  internal class Loader : MarshalByRefObject {
+  /// <summary>
+  /// Discovers all installed plugins in the plugin directory. Checks correctness of plugin meta-data and if
+  /// all plugin files are available and checks plugin dependencies. 
+  /// </summary>
+  internal sealed class PluginValidator : MarshalByRefObject {
     internal event EventHandler<PluginInfrastructureEventArgs> PluginLoaded;
 
@@ -38 +42 @@
     internal IEnumerable<ApplicationDescription> Applications {
       get {
+        if (string.IsNullOrEmpty(PluginDir)) throw new InvalidOperationException("PluginDir is not set.");
         if (applications == null) DiscoverAndCheckPlugins();
         return applications;
@@ -46 +51 @@
     internal IEnumerable<PluginDescription> Plugins {
       get {
+        if (string.IsNullOrEmpty(PluginDir)) throw new InvalidOperationException("PluginDir is not set.");
         if (plugins == null) DiscoverAndCheckPlugins();
         return plugins;
@@ -53 +59 @@
     public string PluginDir { get; set; }
 
-    public Loader() {
+    public PluginValidator() {
       this.pluginDependencies = new Dictionary<PluginDescription, List<string>>();
 
@@ -69 +75 @@
     /// Init first clears all internal datastructures (including plugin lists)
     /// 1. All assemblies in the plugins directory are loaded into the reflection only context.
-    /// 2. The loader checks if all necessary files for each plugin are available.
-    /// 3. The loaded builds the tree of plugin descriptions (dependencies)
-    /// 4. The loader checks if all dependencies for each plugin are ok.
+    /// 2. The validator checks if all necessary files for each plugin are available.
+    /// 3. The validator builds the tree of plugin descriptions (dependencies)
+    /// 4. The validator checks if all dependencies for each plugin are ok.
     /// 5. All plugins for which there are no dependencies missing are loaded into the execution context.
     /// 6. Each loaded plugin (all assemblies) is searched for a types that implement IPlugin
@@ -77 +83 @@
     /// 7. All types implementing IApplication are discovered
     /// </summary>
-    private void DiscoverAndCheckPlugins() {
+    internal void DiscoverAndCheckPlugins() {
       pluginDependencies.Clear();
 
@@ -135 +141 @@
           assemblies.Add(Assembly.ReflectionOnlyLoadFrom(filename));
         }
-        catch (BadImageFormatException) { } // just ignore the case that the .dll file is not actually a CLR dll
+        catch (BadImageFormatException) { } // just ignore the case that the .dll file is not a CLR assembly (e.g. a native dll)
       }
       return assemblies;
@@ -243 +249 @@
       foreach (PluginDescription pluginDescription in pluginDescriptions.Where(x => x.PluginState != PluginState.Disabled)) {
         if (IsAnyDependencyDisabled(pluginDescription)) {
-          // PluginDescription.Message = "Disabled: missing plugin dependency.";
           pluginDescription.Disable();
         }
@@ -277 +282 @@
             IPlugin plugin = (IPlugin)Activator.CreateInstance(pluginType);
             plugin.OnLoad();
-            FirePluginLoaded(plugin.Name);
+            OnPluginLoaded(new PluginInfrastructureEventArgs("Plugin loaded", plugin.Name));
           }
         }
@@ -302 +307 @@
     }
 
-    private void FirePluginLoaded(string pluginName) {
+    internal void OnPluginLoaded(PluginInfrastructureEventArgs e) {
       if (PluginLoaded != null)
-        PluginLoaded(this, new PluginInfrastructureEventArgs("Plugin loaded", pluginName));
+        PluginLoaded(this, e);
     }
 

branches/PluginInfrastructure Refactoring/HeuristicLab/HeuristicLab.csproj

@@ -127 +127 @@
   </ItemGroup>
   <ItemGroup>
-    <ProjectReference Include="..\HeuristicLab.PluginInfrastructure.Manager\HeuristicLab.PluginInfrastructure.Manager.csproj">
-      <Project>{CA8AAD91-E8E2-41AF-96AD-2BA94BC3EF2D}</Project>
-      <Name>HeuristicLab.PluginInfrastructure.Manager</Name>
-    </ProjectReference>
     <ProjectReference Include="..\HeuristicLab.PluginInfrastructure\HeuristicLab.PluginInfrastructure.csproj">
       <Project>{94186A6A-5176-4402-AE83-886557B53CCA}</Project>