Changeset 2497 for branches/PluginInfrastructure Refactoring

Timestamp:

11/16/09 18:30:04 (15 years ago)

Author:

gkronber

Message:

Minor changes in plugin infrastructure. #799

Location:

branches/PluginInfrastructure Refactoring

Files:

• HeuristicLab.PluginInfrastructure.GUI/HeuristicLab.PluginInfrastructure.GUI.csproj (modified) (1 diff)
• HeuristicLab.PluginInfrastructure.Manager/ApplicationDescription.cs (modified) (1 diff)
• HeuristicLab.PluginInfrastructure.Manager/DefaultApplicationManager.cs (moved) (moved from branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure.Manager/ApplicationManager.cs) (3 diffs)
• HeuristicLab.PluginInfrastructure.Manager/HeuristicLab.PluginInfrastructure.Manager.csproj (modified) (1 diff)
• HeuristicLab.PluginInfrastructure.Manager/Loader.cs (modified) (6 diffs)
• HeuristicLab.PluginInfrastructure.Manager/PluginDescription.cs (modified) (2 diffs)
• HeuristicLab.PluginInfrastructure.Manager/PluginInfrastructureEventArgs.cs (modified) (1 diff)
• HeuristicLab.PluginInfrastructure.Manager/PluginManager.cs (modified) (4 diffs)
• HeuristicLab/MainForm.cs (modified) (1 diff)
• HeuristicLab/SplashScreen.cs (modified) (1 diff)

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

@@ -110 +110 @@
     </Compile>
     <Compile Include="PluginAction.cs" />
-    <Compile Include="PluginDescription.cs" />
     <Compile Include="PluginNameTransform.cs" />
     <Compile Include="PluginSource.cs" />

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure.Manager/ApplicationDescription.cs

@@ -84 +84 @@
       set { declaringTypeName = value; }
     }
+
+    public override string ToString() {
+      return Name;
+    }
   }
 }

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

@@ -44 +44 @@
     public IEnumerable<IPluginDescription> Plugins {
       get { return plugins; }
+      internal set { plugins = new List<IPluginDescription>(value); }
     }
 
@@ -82 +83 @@
           foreach (var plugin in GetInstances<IPlugin>(asm)) {
             plugin.OnLoad();
-            FirePluginLoaded(plugin.Name);
           }
         }
+        FirePluginLoaded(desc);
         desc.Load();
       }
-
     }
 
@@ -203 +203 @@
     }
 
-    private void FirePluginLoaded(string name) {
-      if (PluginLoaded != null) PluginLoaded(this, new PluginInfrastructureEventArgs("Plugin loaded", name));
+    private void FirePluginLoaded(IPluginDescription plugin) {
+      if (PluginLoaded != null) PluginLoaded(this, new PluginInfrastructureEventArgs("Plugin loaded", plugin));
     }
 

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

@@ -49 +49 @@
   <ItemGroup>
     <Compile Include="ApplicationDescription.cs" />
-    <Compile Include="ApplicationManager.cs">
-      <SubType>Code</SubType>
-    </Compile>
+    <Compile Include="DefaultApplicationManager.cs" />
     <Compile Include="Loader.cs" />
     <Compile Include="PluginDescription.cs" />

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure.Manager/Loader.cs

@@ -38 +38 @@
     internal IEnumerable<ApplicationDescription> Applications {
       get {
+        if (applications == null) DiscoverAndCheckPlugins();
         return applications;
       }
@@ -45 +46 @@
     internal IEnumerable<PluginDescription> Plugins {
       get {
+        if (plugins == null) DiscoverAndCheckPlugins();
         return plugins;
       }
@@ -52 +54 @@
 
     public Loader() {
-      this.applications = new List<ApplicationDescription>();
-      this.plugins = new List<PluginDescription>();
       this.pluginDependencies = new Dictionary<PluginDescription, List<string>>();
 
+      // ReflectionOnlyAssemblyResolveEvent must be handled because we load assemblies from the plugin path 
+      // (which is not listed in the default assembly lookup locations)
       AppDomain.CurrentDomain.ReflectionOnlyAssemblyResolve += ReflectionOnlyAssemblyResolveEventHandler;
     }
 
     private Assembly ReflectionOnlyAssemblyResolveEventHandler(object sender, ResolveEventArgs args) {
-      //try {
       return Assembly.ReflectionOnlyLoad(args.Name);
-      //}
-      //catch (FileLoadException ex) {
-      //  return null;
-      //}
     }
 
@@ -80 +77 @@
     /// 7. All types implementing IApplication are discovered
     /// </summary>
-    internal void Init() {
+    private void DiscoverAndCheckPlugins() {
       pluginDependencies.Clear();
 
@@ -163 +160 @@
           }
         }
+        // ignore exceptions. Just don't yield a plugin description when an exception is thrown
         catch (FileNotFoundException) {
         }
@@ -310 +308 @@
 
     /// <summary>
-    /// Initializes the life time service with an infinte lease time.
+    /// Initializes the life time service with an infinite lease time.
     /// </summary>
     /// <returns><c>null</c>.</returns>

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure.Manager/PluginDescription.cs

@@ -135 +135 @@
     }
 
-
-    //private string message;
-    ///// <summary>
-    ///// Gets or sets the message.
-    ///// </summary>
-    //public string Message {
-    //  get { return message; }
-    //  set { message = value; }
-    //}
-
     /// <summary>
     /// Gets the string representation of the plugin.
@@ -153 +143 @@
     }
 
-    //// equals and hashcode have to be implemented because we want to compare PluginDescriptions from 
-    //// different AppDomains and serialization destroys reference equality
-    ///// <summary>
-    ///// Checks whether the given object is equal to the current plugin.
-    ///// </summary>
-    ///// <param name="obj">The object to compare.</param>
-    ///// <returns><c>true</c> if it is equal, <c>false</c> otherwise.</returns>
-    //public override bool Equals(object obj) {
-    //  if (!(obj is PluginDescription))
-    //    return false;
-    //  PluginDescription other = (PluginDescription)obj;
+    // equals and hashcode have to be implemented because we want to compare PluginDescriptions from 
+    // different AppDomains and serialization destroys reference equality
+    /// <summary>
+    /// Checks whether the given object is equal to the current plugin.
+    /// </summary>
+    /// <param name="obj">The object to compare.</param>
+    /// <returns><c>true</c> if it is equal, <c>false</c> otherwise.</returns>
+    public override bool Equals(object obj) {
+      if (!(obj is PluginDescription))
+        return false;
+      PluginDescription other = (PluginDescription)obj;
 
-    //  return other.Name == this.Name && other.Version == this.Version;
-    //}
-    ///// <summary>
-    ///// Gets the hash code of the current plugin.
-    ///// </summary>
-    ///// <returns>The hash code of the plugin.</returns>
-    //public override int GetHashCode() {
-    //  if (version != null) {
-    //    return name.GetHashCode() + version.GetHashCode();
-    //  } else return name.GetHashCode();
-    //}
+      return other.Name == this.Name && other.Version == this.Version;
+    }
+    /// <summary>
+    /// Gets the hash code of the current plugin.
+    /// </summary>
+    /// <returns>The hash code of the plugin.</returns>
+    public override int GetHashCode() {
+      if (version != null) {
+        return name.GetHashCode() + version.GetHashCode();
+      } else return name.GetHashCode();
+    }
   }
 }

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

@@ -29 +29 @@
   public class PluginInfrastructureEventArgs : EventArgs {
     public string Action { get; private set; }
-    public string EntityName { get; private set; }
-    public PluginInfrastructureEventArgs(string action, string entityName) {
-      Action = action;
-      EntityName = entityName;
+    public object Entity { get; private set; }
+    public PluginInfrastructureEventArgs(string action, object entity) {
+      this.Action = action;
+      this.Entity = entity;
     }
   }

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

@@ -43 +43 @@
     private string pluginDir;
 
-    // singleton pattern
     public PluginManager(string pluginDir) {
       this.pluginDir = pluginDir;
     }
 
-    ///// <summary>
-    ///// Gets all installed plugins.
-    ///// </summary>
-    ///// <remarks>This information is provided by a <see cref="Loader"/>.</remarks>
-    //public ICollection<PluginInfo> InstalledPlugins {
-    //  get { return remoteLoader.InstalledPlugins; }
-    //}
-
-    ///// <summary>
-    ///// Gets all disabled plugins.
-    ///// </summary>
-    ///// <remarks>This information is provided by a <see cref="Loader"/>.</remarks>
-    //public ICollection<PluginInfo> DisabledPlugins {
-    //  get { return remoteLoader.DisabledPlugins; }
-    //}
-
-    ///// <summary>
-    ///// Gets all active plugins.
-    ///// </summary>
-    ///// <remarks>This information is provided by a <see cref="Loader"/>.</remarks>
-    //public ICollection<PluginInfo> ActivePlugins {
-    //  get { return remoteLoader.ActivePlugins; }
-    //}
-
-    //private ICollection<PluginInfo> loadedPlugins;
-    ///// <summary>
-    ///// Gets or (internally) sets the loaded plugins.
-    ///// </summary>
-    //public ICollection<PluginInfo> LoadedPlugins {
-    //  get { return loadedPlugins; }
-    //  internal set { loadedPlugins = value; }
-    //}
-
     private List<PluginDescription> plugins;
-    //public IEnumerable<PluginDescription> Plugins {
-    //  get { return plugins; }
-    //}
 
     private List<ApplicationDescription> applications;
@@ -97 +60 @@
     /// Determines installed plugins and checks if all plugins are loadable.
     /// </summary>
-    public void Initialize() {
-      NotifyListeners("Initializing", "PluginInfrastructure");
+    public void DiscoverAndCheckPlugins() {
+      FireAction("Initializing", "PluginInfrastructure");
       AppDomainSetup setup = AppDomain.CurrentDomain.SetupInformation;
       setup.PrivateBinPath = pluginDir;
-      AppDomain pluginDomain = AppDomain.CreateDomain("plugin domain", null, setup);
-      Loader remoteLoader = (Loader)pluginDomain.CreateInstanceAndUnwrap("HeuristicLab.PluginInfraStructure.Manager", "HeuristicLab.PluginInfrastructure.Manager.Loader");
-      remoteLoader.PluginDir = pluginDir;
-      remoteLoader.PluginLoaded += delegate(object sender, PluginInfrastructureEventArgs args) { NotifyListeners(args.Action, args.EntityName); }; // forward all events from the remoteLoader to listeners
-      remoteLoader.Init();
-      NotifyListeners("Initialized", "PluginInfrastructure");
-
-      plugins = new List<PluginDescription>(remoteLoader.Plugins);
-      applications = new List<ApplicationDescription>(remoteLoader.Applications);
-
-      // discard the AppDomain that was used for plugin discovery
-      UnloadAppDomain(pluginDomain);
+      AppDomain pluginDomain = null;
+      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");
+      }
+      finally {
+        // discard the AppDomain that was used for plugin discovery
+        UnloadAppDomain(pluginDomain);
+      }
     }
 
-    private void UnloadAppDomain(AppDomain appDomain) {
-      AppDomain.Unload(appDomain);
-
-      // set all loaded plugins back to enabled
-      foreach (var pluginDescription in plugins)
-        pluginDescription.Unload();
-    }
-
-
-    ///// <summary>
-    ///// Creates a new AppDomain with all plugins preloaded.
-    ///// </summary>
-    ///// <param name="friendlyName">Name of the new AppDomain</param>
-    ///// <returns>the new AppDomain with all plugins preloaded.</returns>
-    //public AppDomain CreateAndInitAppDomain(string friendlyName) {
-
-    //  return applicationDomain;
-    //}
 
     /// <summary>
@@ -144 +92 @@
       // and remotely tell it to start the application
 
-      NotifyListeners("Starting application", appInfo.Name);
+      FireAction("Starting application", appInfo.Name);
       AppDomain applicationDomain = null;
       try {
@@ -152 +100 @@
         DefaultApplicationManager applicationManager =
           (DefaultApplicationManager)applicationDomain.CreateInstanceAndUnwrap("HeuristicLab.PluginInfraStructure.Manager", "HeuristicLab.PluginInfrastructure.Manager.DefaultApplicationManager");
-        applicationManager.PluginLoaded += delegate(object sender, PluginInfrastructureEventArgs args) { NotifyListeners(args.Action, args.EntityName); };
+        applicationManager.PluginLoaded += applicationManager_PluginLoaded;
         applicationManager.PrepareApplicationDomain(
           new List<IApplicationDescription>(applications.Cast<IApplicationDescription>()),
           new List<IPluginDescription>(plugins.Cast<IPluginDescription>()));
-        NotifyListeners("Started application", appInfo.Name);
+        FireAction("Started application", appInfo.Name);
         applicationManager.Run(appInfo);
       }
       finally {
         // make sure domain is unloaded in all cases
-        if (applicationDomain != null) AppDomain.Unload(applicationDomain);
+        UnloadAppDomain(applicationDomain);
       }
     }
 
-    ///// <summary>
-    ///// Creates a new AppDomain with all plugins preloaded and Sandboxing capability.
-    ///// </summary>
-    ///// <param name="assembly">Assembly reference</param>
-    ///// <returns>the strongname of the assembly</returns>
-    //private StrongName CreateStrongName(Assembly assembly) {
-    //  if (assembly == null)
-    //    throw new ArgumentNullException("assembly");
+    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();
+      }
+      FireAction(e.Action, e.Entity);
+    }
 
-    //  AssemblyName assemblyName = assembly.GetName();
-    //  Debug.Assert(assemblyName != null, "Could not get assembly name");
+    private void UnloadAppDomain(AppDomain appDomain) {
+      AppDomain.Unload(appDomain);
 
-    //  // get the public key blob
-    //  byte[] publicKey = assemblyName.GetPublicKey();
-    //  if (publicKey == null || publicKey.Length == 0)
-    //    throw new InvalidOperationException("Assembly is not strongly named");
+      // TODO: Update plugin descriptions in all active AppDomains
 
-    //  StrongNamePublicKeyBlob keyBlob = new StrongNamePublicKeyBlob(publicKey);
+      // unload all plugins
+      foreach (var pluginDescription in plugins)
+        pluginDescription.Unload();
+    }
 
-    //  // and create the StrongName
-    //  return new StrongName(keyBlob, assemblyName.Name, assemblyName.Version);
-    //}
-
-    //public AppDomain CreateAndInitAppDomainWithSandbox(string friendlyName, bool sandboxed, Type jobType, ICollection<byte[]> assemblyFiles) {
-    //  PermissionSet pset;
-
-
-
-    //  //DiscoveryService dService = new DiscoveryService();
-    //  //get the declaring plugin of the job
-    //  //PluginInfo jobPlugin = dService.GetDeclaringPlugin(jobType);
-
-    //  //get all the plugins that have dependencies with the jobplugin
-    //  //List<PluginInfo> depPlugins = GetDependentPluginsRec(jobPlugin);
-    //  //insert all jobs into one list
-    //  //depPlugins.Add(jobPlugin);
-
-    //  if (sandboxed) {
-    //    pset = new PermissionSet(PermissionState.None);
-    //    pset.AddPermission(new SecurityPermission(SecurityPermissionFlag.Execution));
-    //    pset.AddPermission(new ReflectionPermission(PermissionState.Unrestricted));
-    //    FileIOPermission fPerm = new FileIOPermission(PermissionState.None);
-
-    //    /*foreach (PluginInfo plugin in depPlugins) {
-    //        foreach(String assemblies in plugin.Assemblies)
-    //          fPerm.AddPathList(FileIOPermissionAccess.AllAccess, assemblies);
-    //    }
-
-    //    pset.AddPermission(fPerm);*/
-
-    //  } else {
-    //    pset = new PermissionSet(PermissionState.Unrestricted);
-    //  }
-    //  AppDomainSetup setup = AppDomain.CurrentDomain.SetupInformation;
-    //  setup.PrivateBinPath = pluginDir;
-    //  setup.ApplicationBase = AppDomain.CurrentDomain.SetupInformation.ApplicationBase;
-    //  AppDomain applicationDomain = AppDomain.CreateDomain(friendlyName, AppDomain.CurrentDomain.Evidence, setup, pset, CreateStrongName(Assembly.GetExecutingAssembly()));
-    //  Runner remoteRunner = (Runner)applicationDomain.CreateInstanceAndUnwrap(typeof(Runner).Assembly.GetName().Name, typeof(Runner).FullName);
-    //  NotifyListeners("Initializing", "All plugins");
-
-    //  if (assemblyFiles != null && assemblyFiles.Count > 0)
-    //    remoteRunner.LoadAssemblies(assemblyFiles);
-
-    //  //if (depPlugins != null && depPlugins.Count > 0) {        
-    //  //remoteRunner.LoadPlugins(ActivePlugins);
-    //  //}
-    //  NotifyListeners("Initialized", "All plugins");
-    //  return applicationDomain;
-    //}
-
-    ///// <summary>
-    ///// Calculates a set of plugins that directly or transitively depend on the plugin given in the argument.
-    ///// </summary>
-    ///// <param name="pluginInfo">The plugin the other depend on.</param>
-    ///// <returns>a list of plugins that are directly of transitively dependent.</returns>
-    //public List<PluginDescription> GetDependentPlugins(PluginDescription pluginInfo) {
-    //  List<PluginDescription> mergedList = new List<PluginDescription>();
-    //  foreach (PluginDescription plugin in Plugins) {
-    //    if (plugin.Dependencies.Contains(pluginInfo)) {
-    //      if (!mergedList.Contains(plugin)) {
-    //        mergedList.Add(plugin);
-    //      }
-    //      // for each of the dependent plugins add the list of transitively dependent plugins
-    //      // make sure that only one entry for each plugin is added to the merged list
-    //      foreach (PluginDescription dependentPlugin in GetDependentPlugins(plugin)) {
-    //        if (!mergedList.Contains(dependentPlugin)) {
-    //          mergedList.Add(dependentPlugin);
-    //        }
-    //      }
-    //    }
-    //  }
-    //  return mergedList;
-    //}
-
-    private void NotifyListeners(string action, string entityName) {
+    private void FireAction(string action, object entity) {
       if (Action != null) {
-        Action(this, new PluginInfrastructureEventArgs(action, entityName));
+        Action(this, new PluginInfrastructureEventArgs(action, entity));
       }
     }

branches/PluginInfrastructure Refactoring/HeuristicLab/MainForm.cs

@@ -54 +54 @@
       this.Enabled = false;
 
-      pluginManager.Initialize();
+      pluginManager.DiscoverAndCheckPlugins();
 
       applicationsListView.Items.Clear();

branches/PluginInfrastructure Refactoring/HeuristicLab/SplashScreen.cs

@@ -89 +89 @@
 
     public void managerActionEventHandler(object sender, PluginInfrastructureEventArgs e) {
-      string info = e.Action + ": " + e.EntityName;
+      string info = e.Action + ": " + e.Entity;
       //if (e.Action == PluginManagerAction.Initializing) info = "Initializing ...";
       //else if (e.Action == PluginManagerAction.PluginLoaded) info = "Loaded plugin " + e.Id + " ...";