Changeset 29 for trunk

Timestamp:

02/28/08 18:02:45 (17 years ago)

Author:

gkronber

Message:

• refactored pluginInfrastructure
• fixed #8

Location:

trunk/sources

Files:

• HeuristicLab.PluginInfrastructure.GUI/ManagerForm.cs (modified) (6 diffs)
• HeuristicLab.PluginInfrastructure.GUI/PluginTag.cs (modified) (2 diffs)
• HeuristicLab.PluginInfrastructure/DiscoveryService.cs (modified) (1 diff)
• HeuristicLab.PluginInfrastructure/Loader.cs (modified) (18 diffs)
• HeuristicLab.PluginInfrastructure/PluginInfo.cs (modified) (1 diff)
• HeuristicLab.PluginInfrastructure/PluginManager.cs (modified) (5 diffs)
• HeuristicLab.PluginInfrastructure/Runner.cs (modified) (2 diffs)

trunk/sources/HeuristicLab.PluginInfrastructure.GUI/ManagerForm.cs

@@ -37 +37 @@
     private TreeNode availablePlugins;
     private TreeNode allPlugins;
+    private TreeNode disabledPlugins;
     private List<PluginTag> allTags = new List<PluginTag>();
     private Dictionary<PluginTag, PluginAction> actions = new Dictionary<PluginTag, PluginAction>();
@@ -75 +76 @@
       allPlugins.ImageIndex = 1;
       allPlugins.SelectedImageIndex = 1;
+      disabledPlugins = new TreeNode("Disabled plugins");
+      disabledPlugins.ImageIndex = 1;
+      disabledPlugins.SelectedImageIndex = 1;
 
       pluginTreeView.Nodes.Add(installedPlugins);
       pluginTreeView.Nodes.Add(availablePlugins);
+      pluginTreeView.Nodes.Add(disabledPlugins);
       pluginTreeView.Nodes.Add(allPlugins);
 
-      foreach(PluginInfo pluginInfo in PluginManager.Manager.InstalledPlugins) {
+      foreach(PluginInfo pluginInfo in PluginManager.Manager.ActivePlugins) {
         // create a new PluginAction tag for the plugin
         PluginTag tag = new PluginTag(allTags, pluginInfo, PluginState.Installed);
@@ -91 +96 @@
         installedPlugins.Nodes.Add(installedPluginsNode);
 
+        // add to all "plugins node"
+        TreeNode allPluginsNode = new TreeNode(pluginInfo.Name);
+        allPluginsNode.ContextMenuStrip = pluginContextMenuStrip;
+        allPluginsNode.Tag = tag;
+        allPluginsNode.ImageIndex = 0;
+        allPlugins.Nodes.Add(allPluginsNode);
+      }
+      foreach(PluginInfo pluginInfo in PluginManager.Manager.DisabledPlugins) {
+        PluginTag tag = new PluginTag(allTags, pluginInfo, PluginState.Disabled);
+        allTags.Add(tag);
+        TreeNode disabledPluginsNode = new TreeNode(pluginInfo.Name);
+        disabledPluginsNode.ContextMenuStrip = pluginContextMenuStrip;
+        disabledPluginsNode.Tag = tag;
+        disabledPluginsNode.ImageIndex = 0;
+        disabledPlugins.Nodes.Add(disabledPluginsNode);
         // add to all "plugins node"
         TreeNode allPluginsNode = new TreeNode(pluginInfo.Name);
@@ -290 +310 @@
       allAvailablePlugins.ForEach(delegate(PluginDescription availablePlugin) {
         List<PluginTag> oldPlugins = allTags.FindAll(delegate(PluginTag currentPlugin) {
-          return currentPlugin.PluginName == availablePlugin.Name && currentPlugin.State == PluginState.Installed;
+          return currentPlugin.PluginName == availablePlugin.Name && currentPlugin.State == (PluginState.Installed | PluginState.Disabled);
         });
 
@@ -567 +587 @@
       publishButton.Enabled = (tag.State & PluginState.Installed) == PluginState.Installed;
       installButton.Enabled = (tag.State & PluginState.Available) == PluginState.Available;
-      deleteButton.Enabled = (tag.State & (PluginState.Installed | PluginState.Upgradeable)) != 0;
+      deleteButton.Enabled = (tag.State & (PluginState.Installed | PluginState.Upgradeable | PluginState.Disabled)) != 0;
 
       installButton.Checked = GetAction(tag) == ManagerAction.Install;
@@ -605 +625 @@
     private List<TreeNode> FindPluginNodes(PluginTag pluginTag) {
       List<TreeNode> nodes = new List<TreeNode>();
-      foreach(TreeNode rootNode in new TreeNode[] { installedPlugins, availablePlugins, allPlugins }) {
+      foreach(TreeNode rootNode in new TreeNode[] { installedPlugins, availablePlugins, allPlugins, disabledPlugins }) {
         foreach(TreeNode node in rootNode.Nodes) {
           if(pluginTag.Equals(node.Tag)) {

trunk/sources/HeuristicLab.PluginInfrastructure.GUI/PluginTag.cs

@@ -31 +31 @@
     Available = 2,
     Upgradeable = 4,
+    Disabled = 8,
   };
 
@@ -218 +219 @@
 
     public override int GetHashCode() {
-      return pluginName.GetHashCode() + pluginVersion.GetHashCode();
+      if(pluginVersion != null) {
+        return pluginName.GetHashCode() + pluginVersion.GetHashCode();
+      } else return pluginName.GetHashCode();
     }
   }

trunk/sources/HeuristicLab.PluginInfrastructure/DiscoveryService.cs

@@ -33 +33 @@
     public PluginInfo[] Plugins {
       get {
-        return PluginManager.Manager.LoadedPlugins;
+        PluginInfo[] plugins = new PluginInfo[PluginManager.Manager.LoadedPlugins.Count];
+        PluginManager.Manager.LoadedPlugins.CopyTo(plugins, 0);
+        return plugins;
       }
     }

trunk/sources/HeuristicLab.PluginInfrastructure/Loader.cs

@@ -33 +33 @@
     public delegate void PluginLoadFailedEventHandler(string pluginName, string args);
 
-    private Dictionary<PluginInfo, IPlugin> activePlugins = new Dictionary<PluginInfo, IPlugin>();
+    private Dictionary<PluginInfo, List<string>> pluginDependencies = new Dictionary<PluginInfo, List<string>>();
+    private List<PluginInfo> preloadedPluginInfos = new List<PluginInfo>();
+    private Dictionary<IPlugin, PluginInfo> pluginInfos = new Dictionary<IPlugin, PluginInfo>();
     private Dictionary<PluginInfo, IPlugin> allPlugins = new Dictionary<PluginInfo, IPlugin>();
-    private Dictionary<IPlugin, PluginInfo> pluginInfos = new Dictionary<IPlugin, PluginInfo>();
-
-    private Dictionary<string, List<string>> pluginDependencies = new Dictionary<string, List<string>>();
-    private Dictionary<string, List<string>> pluginAssemblies = new Dictionary<string, List<string>>();
-
-    private List<string> loadablePlugins = new List<string>();
+    private List<PluginInfo> disabledPlugins = new List<PluginInfo>();
     private string pluginDir = Application.StartupPath + "/" + HeuristicLab.PluginInfrastructure.Properties.Settings.Default.PluginDir;
 
     internal event PluginLoadFailedEventHandler MissingPluginFile;
-
     internal event PluginManagerActionEventHandler PluginAction;
 
-    internal PluginInfo[] ActivePlugins {
+    internal ICollection<PluginInfo> ActivePlugins {
       get {
-        PluginInfo[] plugins = new PluginInfo[activePlugins.Count];
-        activePlugins.Keys.CopyTo(plugins, 0);
-        return plugins;
-      }
-    }
-
-    internal List<PluginInfo> InstalledPlugins {
+        List<PluginInfo> list = new List<PluginInfo>();
+        foreach(PluginInfo info in allPlugins.Keys) {
+          if(!disabledPlugins.Exists(delegate(PluginInfo disabledInfo) { return info.Name == disabledInfo.Name; })) {
+            list.Add(info);
+          }
+        }
+        return list;
+      }
+    }
+
+    internal ICollection<PluginInfo> InstalledPlugins {
       get {
         return new List<PluginInfo>(allPlugins.Keys);
@@ -61 +61 @@
     }
 
-    private ApplicationInfo[] applications;
-    internal ApplicationInfo[] InstalledApplications {
+    internal ICollection<PluginInfo> DisabledPlugins {
+      get {
+        return disabledPlugins;
+      }
+    }
+
+    private ICollection<ApplicationInfo> applications;
+    internal ICollection<ApplicationInfo> InstalledApplications {
       get {
         return applications;
@@ -69 +75 @@
 
     private IPlugin FindPlugin(PluginInfo plugin) {
-      return activePlugins[plugin];
+      return allPlugins[plugin];
     }
 
@@ -85 +91 @@
     internal void Init() {
       AppDomain.CurrentDomain.ReflectionOnlyAssemblyResolve += delegate(object sender, ResolveEventArgs args) { return Assembly.ReflectionOnlyLoad(args.Name); };
-      activePlugins.Clear();
       allPlugins.Clear();
+      disabledPlugins.Clear();
       pluginInfos.Clear();
       pluginsByName.Clear();
-      loadablePlugins.Clear();
       pluginDependencies.Clear();
-      pluginAssemblies.Clear();
 
       List<Assembly> assemblies = ReflectionOnlyLoadDlls();
       CheckAssemblyDependencies(assemblies);
+      CheckPluginFiles();
+      CheckPluginDependencies();
       LoadPlugins();
-      CheckPluginFiles();
 
       DiscoveryService service = new DiscoveryService();
       IApplication[] apps = service.GetInstances<IApplication>();
-      applications = new ApplicationInfo[apps.Length];
-
-      int i = 0;
+      applications = new List<ApplicationInfo>();
+
       foreach(IApplication application in apps) {
         ApplicationInfo info = new ApplicationInfo();
@@ -111 +115 @@
         info.PluginType = application.GetType().Namespace + "." + application.GetType().Name;
 
-        applications[i++] = info;
+        applications.Add(info);
       }
     }
@@ -129 +133 @@
 
     private void CheckAssemblyDependencies(List<Assembly> assemblies) {
-
       foreach(Assembly assembly in assemblies) {
-
         // GetExportedTypes throws FileNotFoundException when a referenced assembly
         // of the current assembly is missing.
@@ -138 +140 @@
 
           foreach(Type t in exported) {
-            // if the type implements IPlugin
+            // if there is a type that implements IPlugin
             if(Array.Exists<Type>(t.GetInterfaces(), delegate(Type iface) {
               // use AssemblyQualifiedName to compare the types because we can't directly 
@@ -144 +146 @@
               return iface.AssemblyQualifiedName == typeof(IPlugin).AssemblyQualifiedName;
             })) {
+              // fetch the attributes of the IPlugin type
               GetPluginAttributeData(t);
             }
-
           }
         } catch(FileNotFoundException) {
           // when a referenced assembly cannot be loaded then ignore this assembly in the plugin discovery
-          // TASK: add the assembly to some kind of unloadable assemblies list
-          // this list could be displayed to the user for diagnosis          
-        }
-      }
-
-      foreach(string pluginName in this.pluginDependencies.Keys) {
-        allDependencies.Clear();
-        CheckPluginDependencies(pluginName);
+        }
       }
     }
@@ -170 +165 @@
       // get all attributes of that type
       IList<CustomAttributeData> attributes = CustomAttributeData.GetCustomAttributes(t);
-
       List<string> pluginAssemblies = new List<string>();
       List<string> pluginDependencies = new List<string>();
+      List<string> pluginFiles = new List<string>();
       string pluginName = "";
-
-      // extract relevant parameters
       // iterate through all custom attributes and search for named arguments that we are interested in 
       foreach(CustomAttributeData attributeData in attributes) {
         List<CustomAttributeNamedArgument> namedArguments = new List<CustomAttributeNamedArgument>(attributeData.NamedArguments);
-
         // if the current attribute contains a named argument with the name "Name" then extract the plugin name
         CustomAttributeNamedArgument pluginNameArgument = namedArguments.Find(delegate(CustomAttributeNamedArgument arg) {
@@ -187 +179 @@
           pluginName = (string)pluginNameArgument.TypedValue.Value;
         }
-
         // if the current attribute contains a named argument with the name "Dependency" then extract the dependency
         // and store it in the list of all dependencies
@@ -193 +184 @@
           return arg.MemberInfo.Name == "Dependency";
         });
-
         if(dependencyNameArgument.MemberInfo != null) {
           pluginDependencies.Add((string)dependencyNameArgument.TypedValue.Value);
         }
-
         // if the current attribute has a named argument "Filename" then find if the argument "Filetype" is also supplied
         // and if the filetype is Assembly then store the name of the assembly in the list of assemblies
@@ -207 +196 @@
         });
         if(filenameArg.MemberInfo != null && filetypeArg.MemberInfo != null) {
+          pluginFiles.Add(pluginDir + "/" + (string)filenameArg.TypedValue.Value);
           if((PluginFileType)filetypeArg.TypedValue.Value == PluginFileType.Assembly) {
             pluginAssemblies.Add(pluginDir + "/" + (string)filenameArg.TypedValue.Value);
@@ -213 +203 @@
       }
 
-      // make sure that we found reasonable values
+      // minimal sanity check of the attribute values
       if(pluginName != "" && pluginAssemblies.Count > 0) {
-        this.pluginDependencies[pluginName] = pluginDependencies;
-        this.pluginAssemblies[pluginName] = pluginAssemblies;
+        // create a temporary PluginInfo that contains the attribute values
+        PluginInfo info = new PluginInfo();
+        info.Name = pluginName;
+        info.Assemblies = pluginAssemblies;
+        info.Files.AddRange(pluginFiles);
+        info.Assemblies.AddRange(pluginAssemblies);
+        this.pluginDependencies[info] = pluginDependencies;
+        preloadedPluginInfos.Add(info);
       } else {
         throw new InvalidPluginException();
@@ -222 +218 @@
     }
 
-    private List<string> allDependencies = new List<string>();
+    private void CheckPluginDependencies() {
+      foreach(PluginInfo pluginInfo in preloadedPluginInfos) {
+        // don't need to check plugins that are already disabled
+        if(disabledPlugins.Contains(pluginInfo)) {
+          continue;
+        }
+        visitedDependencies.Clear();
+        if(!CheckPluginDependencies(pluginInfo.Name)) {
+          disabledPlugins.Add(pluginInfo);
+        }
+      }
+    }
+
+    private List<string> visitedDependencies = new List<string>();
     private bool CheckPluginDependencies(string pluginName) {
-      // when we already checked the dependencies of this plugin earlier then just return true
-      if(loadablePlugins.Contains(pluginName)) {
-        return true;
-      } else if(!pluginAssemblies.ContainsKey(pluginName) || allDependencies.Contains(pluginName)) {
+      if(!preloadedPluginInfos.Exists(delegate(PluginInfo info) { return pluginName == info.Name; }) ||
+        disabledPlugins.Exists(delegate(PluginInfo info) { return pluginName == info.Name; }) ||
+        visitedDependencies.Contains(pluginName)) {
         // when the plugin is not available return false;
         return false;
@@ -233 +241 @@
         // otherwise check if all dependencies of the plugin are OK 
         // if yes then this plugin is also ok and we store it in the list of loadable plugins
-        allDependencies.Add(pluginName);
-        foreach(string dependency in pluginDependencies[pluginName]) {
+
+        PluginInfo matchingInfo = preloadedPluginInfos.Find(delegate(PluginInfo info) { return info.Name == pluginName; });
+        if(matchingInfo == null) throw new InvalidProgramException(); // shouldn't happen
+        foreach(string dependency in pluginDependencies[matchingInfo]) {
+          visitedDependencies.Add(pluginName);
           if(CheckPluginDependencies(dependency) == false) {
             // if only one dependency is not available that means that the current plugin also is unloadable
             return false;
           }
-        }
-        // all dependencies OK -> add to loadable list and return true
-        loadablePlugins.Add(pluginName);
+          visitedDependencies.Remove(pluginName);
+        }
+        // all dependencies OK
         return true;
       }
@@ -248 +259 @@
 
     private Dictionary<string, IPlugin> pluginsByName = new Dictionary<string, IPlugin>();
-
     private void LoadPlugins() {
       // load all loadable plugins (all dependencies available) into the execution context
-      foreach(string plugin in loadablePlugins) {
-        {
-          foreach(string assembly in pluginAssemblies[plugin]) {
+      foreach(PluginInfo pluginInfo in preloadedPluginInfos) {
+        if(!disabledPlugins.Contains(pluginInfo)) {
+          foreach(string assembly in pluginInfo.Assemblies) {
             Assembly.LoadFrom(assembly);
           }
@@ -266 +276 @@
           continue;
         Type[] availablePluginTypes = service.GetTypes(typeof(IPlugin), assembly);
-
-
         foreach(Type pluginType in availablePluginTypes) {
           if(!pluginType.IsAbstract && !pluginType.IsInterface && !pluginType.HasElementType) {
             IPlugin plugin = (IPlugin)Activator.CreateInstance(pluginType);
             PluginAction(this, new PluginManagerActionEventArgs(plugin.Name, PluginManagerAction.InitializingPlugin));
-
             pluginsByName.Add(plugin.Name, plugin);
-            PluginInfo pluginInfo = GetPluginInfo(plugin);
-
-
-            allPlugins.Add(pluginInfo, plugin);
-            PluginAction(this, new PluginManagerActionEventArgs(plugin.Name, PluginManagerAction.InitializedPlugin));
-          }
-        }
-      }
-    }
-
-
+          }
+        }
+      }
+
+      foreach(IPlugin plugin in pluginsByName.Values) {
+        PluginInfo pluginInfo = GetPluginInfo(plugin);
+        allPlugins.Add(pluginInfo, plugin);
+        PluginAction(this, new PluginManagerActionEventArgs(plugin.Name, PluginManagerAction.InitializedPlugin));
+      }
+    }
     private PluginInfo GetPluginInfo(IPlugin plugin) {
       if(pluginInfos.ContainsKey(plugin)) {
         return pluginInfos[plugin];
       }
-
       // store the data of the plugin in a description file which can be used without loading the plugin assemblies
       PluginInfo pluginInfo = new PluginInfo();
@@ -302 +307 @@
       });
 
-      // each plugin can have multiple assemlies associated
-      // for each assembly of the plugin find the dependencies
-      // and get the pluginDescriptions for all dependencies
-      foreach(string assembly in pluginAssemblies[plugin.Name]) {
+      PluginInfo preloadedInfo = preloadedPluginInfos.Find(delegate(PluginInfo info) { return info.Name == plugin.Name; });
+      foreach(string assembly in preloadedInfo.Assemblies) {
         // always use \ as directory separator (this is necessary for discovery of types in 
         // plugins see DiscoveryService.GetTypes() 
         pluginInfo.Assemblies.Add(assembly.Replace('/', '\\'));
-
-      }
-      foreach(string dependency in pluginDependencies[plugin.Name]) {
+      }
+      foreach(string dependency in pluginDependencies[preloadedInfo]) {
         // accumulate the dependencies of each assembly into the dependencies of the whole plugin
         PluginInfo dependencyInfo = GetPluginInfo(pluginsByName[dependency]);
         pluginInfo.Dependencies.Add(dependencyInfo);
       }
-
       pluginInfos[plugin] = pluginInfo;
-
       return pluginInfo;
     }
 
     private void CheckPluginFiles() {
-      foreach(PluginInfo plugin in allPlugins.Keys) {
-        CheckPluginFiles(plugin);
+      foreach(PluginInfo plugin in preloadedPluginInfos) {
+        if(!CheckPluginFiles(plugin)) {
+          disabledPlugins.Add(plugin);
+        }
       }
     }
 
     private bool CheckPluginFiles(PluginInfo pluginInfo) {
-      if(activePlugins.ContainsKey(pluginInfo)) {
-        return true;
-      }
-      foreach(PluginInfo dependency in pluginInfo.Dependencies) {
-        if(!CheckPluginFiles(dependency)) {
-          return false;
-        }
-      }
       foreach(string filename in pluginInfo.Files) {
         if(!File.Exists(filename)) {
-          MissingPluginFile(pluginInfo.Name, filename);
+          if(MissingPluginFile != null) {
+            MissingPluginFile(pluginInfo.Name, filename);
+          }
           return false;
         }
       }
-
-      activePlugins.Add(pluginInfo, allPlugins[pluginInfo]);
       return true;
     }

trunk/sources/HeuristicLab.PluginInfrastructure/PluginInfo.cs

@@ -83 +83 @@
 
     public override int GetHashCode() {
-      return name.GetHashCode() + version.GetHashCode();
+      if(version != null) {
+        return name.GetHashCode() + version.GetHashCode();
+      } else return name.GetHashCode();
     }
   }

trunk/sources/HeuristicLab.PluginInfrastructure/PluginManager.cs

@@ -53 +53 @@
     }
 
-    public List<PluginInfo> InstalledPlugins {
+    public ICollection<PluginInfo> InstalledPlugins {
       get { return remoteLoader.InstalledPlugins; }
     }
 
-    public ApplicationInfo[] InstalledApplications {
+    public ICollection<PluginInfo> DisabledPlugins {
+      get { return remoteLoader.DisabledPlugins; }
+    }
+
+    public ICollection<PluginInfo> ActivePlugins {
+      get { return remoteLoader.ActivePlugins; }
+    }
+
+    public ICollection<ApplicationInfo> InstalledApplications {
       get { return remoteLoader.InstalledApplications; }
     }
 
-    private PluginInfo[] loadedPlugins;
-    public PluginInfo[] LoadedPlugins {
+    private ICollection<PluginInfo> loadedPlugins;
+    public ICollection<PluginInfo> LoadedPlugins {
       get { return loadedPlugins; }
       internal set { loadedPlugins = value; }
@@ -72 +80 @@
     public void Initialize() {
       NotifyListeners(PluginManagerAction.Initializing, "-");
-
       AppDomainSetup setup = AppDomain.CurrentDomain.SetupInformation;
       setup.PrivateBinPath = pluginDir;
       pluginDomain = AppDomain.CreateDomain("plugin domain", null, setup);
-
       remoteLoader = (Loader)pluginDomain.CreateInstanceAndUnwrap("HeuristicLab.PluginInfraStructure", "HeuristicLab.PluginInfrastructure.Loader");
-
       remoteLoader.PluginAction += delegate(object sender, PluginManagerActionEventArgs args) { if(Action != null) Action(this, args); };
       remoteLoader.Init();
-
       NotifyListeners(PluginManagerAction.Initialized, "-");
     }
@@ -99 +103 @@
       setup.PrivateBinPath = pluginDir;
       AppDomain applicationDomain = AppDomain.CreateDomain(appInfo.Name + " AppDomain", null, setup);
-      
+
       Runner remoteRunner = (Runner)applicationDomain.CreateInstanceAndUnwrap("HeuristicLab.PluginInfrastructure", "HeuristicLab.PluginInfrastructure.Runner");
       NotifyListeners(PluginManagerAction.Initializing, "All plugins");
@@ -116 +120 @@
     public List<PluginInfo> GetDependentPlugins(PluginInfo pluginInfo) {
       List<PluginInfo> mergedList = new List<PluginInfo>();
-      InstalledPlugins.ForEach(delegate(PluginInfo plugin) {
+      foreach(PluginInfo plugin in InstalledPlugins) {
         if(plugin.Dependencies.Contains(pluginInfo)) {
           if(!mergedList.Contains(plugin)) {
@@ -125 +129 @@
           GetDependentPlugins(plugin).ForEach(delegate(PluginInfo dependentPlugin) {
             if(!mergedList.Contains(dependentPlugin)) {
-              mergedList.Add(dependentPlugin);              
+              mergedList.Add(dependentPlugin);
             }
           });
         }
-      });
-      
+      }
       return mergedList;
     }

trunk/sources/HeuristicLab.PluginInfrastructure/Runner.cs

@@ -28 +28 @@
   internal class Runner : MarshalByRefObject {
 
-    public void LoadPlugins(PluginInfo[] plugins) {
+    public void LoadPlugins(ICollection<PluginInfo> plugins) {
       foreach(PluginInfo pluginInfo in plugins) {
         foreach(string assemblyName in pluginInfo.Assemblies) {
@@ -34 +34 @@
         }
       }
-
       PluginManager.Manager.LoadedPlugins = plugins;
     }