Changeset 2778 for trunk/sources/HeuristicLab.PluginInfrastructure

Timestamp:

02/11/10 13:04:42 (15 years ago)

Author:

gkronber

Message:

Implemented ContactInformationAttribute. #868 (Attribute to declare contact information details for plugins)

Location:

trunk/sources/HeuristicLab.PluginInfrastructure

Files:

• Advanced/InstallationManager.cs (modified) (1 diff)
• Attributes/ContactInformationAttribute.cs (added)
• HeuristicLab.PluginInfrastructure.csproj (modified) (1 diff)
• Interfaces/IPluginDescription.cs (modified) (1 diff)
• Manager/PluginDescription.cs (modified) (1 diff)
• Manager/PluginValidator.cs (modified) (4 diffs)

trunk/sources/HeuristicLab.PluginInfrastructure/Advanced/InstallationManager.cs

@@ -71 +71 @@
       builder.Append("Version: ").AppendLine(desc.Version.ToString());
       builder.AppendLine("Description:").AppendLine(desc.Description);
+      if (!string.IsNullOrEmpty(desc.ContactName)) {
+        builder.Append("Contact: ").Append(desc.ContactName).Append(", ").AppendLine(desc.ContactEmail);
+      }
       builder.AppendLine("This plugin is " + desc.PluginState.ToString().ToLowerInvariant() + ".");
-      builder.Append("Build date: ").AppendLine(desc.BuildDate.ToString()).AppendLine();
+      // builder.Append("Build date: ").AppendLine(desc.BuildDate.ToString()).AppendLine();
       builder.AppendLine("Files: ");
       foreach (var file in desc.Files) {

trunk/sources/HeuristicLab.PluginInfrastructure/HeuristicLab.PluginInfrastructure.csproj

@@ -102 +102 @@
     <Compile Include="Attributes\ApplicationAttribute.cs" />
     <Compile Include="Attributes\AssemblyBuildDateAttribute.cs" />
+    <Compile Include="Attributes\ContactInformationAttribute.cs" />
     <Compile Include="Attributes\PluginAttribute.cs" />
     <Compile Include="Attributes\PluginDependencyAttribute.cs" />

trunk/sources/HeuristicLab.PluginInfrastructure/Interfaces/IPluginDescription.cs

@@ -39 +39 @@
     /// Gets the build date of the plugin.
     /// </summary>
+    [Obsolete]
     DateTime BuildDate { get; }
     /// <summary>

trunk/sources/HeuristicLab.PluginInfrastructure/Manager/PluginDescription.cs

@@ -69 +69 @@
       get { return buildDate; }
       internal set { buildDate = value; }
+    }
+
+    private string contactName;
+    /// <summary>
+    /// Gets or sets the name of the contact person for this plugin.
+    /// </summary>
+    internal string ContactName {
+      get { return contactName; }
+      set { contactName = value; }
+    }
+
+    private string contactEmail;
+    /// <summary>
+    /// Gets or sets the e-mail address of the contact person for this plugin.
+    /// </summary>
+    internal string ContactEmail {
+      get { return contactEmail; }
+      set { contactEmail = value; }
     }
 

trunk/sources/HeuristicLab.PluginInfrastructure/Manager/PluginValidator.cs

@@ -262 +262 @@
 
       string pluginName, pluginDescription, pluginVersion;
+      string contactName, contactAddress;
       GetPluginMetaData(pluginType, out pluginName, out pluginDescription, out pluginVersion);
+      GetPluginContactMetaData(pluginType, out contactName, out contactAddress);
       var pluginFiles = GetPluginFilesMetaData(pluginType);
       var pluginDependencies = GetPluginDependencyMetaData(pluginType);
@@ -268 +270 @@
       // minimal sanity check of the attribute values
       if (!string.IsNullOrEmpty(pluginName) &&
-          pluginFiles.Count() > 0 &&                                 // at least on file
-          pluginFiles.Any(f => f.Type == PluginFileType.Assembly)) { // at least on assembly
+          pluginFiles.Count() > 0 &&                                 // at least one file
+          pluginFiles.Any(f => f.Type == PluginFileType.Assembly)) { // at least one assembly
         // create a temporary PluginDescription that contains the attribute values
         PluginDescription info = new PluginDescription();
@@ -275 +277 @@
         info.Description = pluginDescription;
         info.Version = new Version(pluginVersion);
+        info.ContactName = contactName;
+        info.ContactEmail = contactAddress;
         info.AddFiles(pluginFiles);
 
@@ -305 +309 @@
         }
         yield return new PluginDependency(name, version);
+      }
+    }
+
+    private static void GetPluginContactMetaData(Type pluginType, out string contactName, out string contactAddress) {
+      // get attribute of type ContactInformation if there is any
+      var contactInfoAttribute = (from attr in CustomAttributeData.GetCustomAttributes(pluginType)
+                                  where IsAttributeDataForType(attr, typeof(ContactInformationAttribute))
+                                  select attr).SingleOrDefault();
+
+      if (contactInfoAttribute != null) {
+        contactName = (string)contactInfoAttribute.ConstructorArguments[0].Value;
+        contactAddress = (string)contactInfoAttribute.ConstructorArguments[1].Value;
+      } else {
+        contactName = string.Empty;
+        contactAddress = string.Empty;
       }
     }