Changeset 2815 for trunk/sources/HeuristicLab.PluginInfrastructure

Timestamp:

02/16/10 18:36:45 (15 years ago)

Author:

gkronber

Message:

Added contact info and license text to plugin descriptions. #860

Location:

trunk/sources/HeuristicLab.PluginInfrastructure

Files:

• Interfaces/IPluginDescription.cs (modified) (1 diff)
• Manager/PluginDescription.cs (modified) (2 diffs)
• Manager/PluginValidator.cs (modified) (2 diffs)

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

@@ -49 +49 @@
     /// </summary>
     IEnumerable<IPluginFile> Files { get; }
+    /// <summary>
+    /// Gets the name of the contact person of the plugin.
+    /// </summary>
+    string ContactName { get; }
+    /// <summary>
+    /// Gets the e-mail address of the contact person of the plugin.
+    /// </summary>
+    string ContactEmail { get; }
+    /// <summary>
+    /// Gets the license text of the plugin.
+    /// </summary>
+    string LicenseText { get; }
   }
 }

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

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

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

@@ -286 +286 @@
         info.ContactName = contactName;
         info.ContactEmail = contactAddress;
+        info.LicenseText = ReadLicenseFiles(pluginFiles);
         info.AddFiles(pluginFiles);
 
@@ -293 +294 @@
         throw new InvalidPluginException("Invalid metadata in plugin " + pluginType.ToString());
       }
+    }
+
+    private string ReadLicenseFiles(IEnumerable<PluginFile> pluginFiles) {
+      // combine the contents of all plugin files 
+      var licenseFiles = from file in pluginFiles
+                         where file.Type == PluginFileType.License
+                         select file;
+      if (licenseFiles.Count() == 0) return string.Empty;
+      StringBuilder licenseTextBuilder = new StringBuilder();
+      licenseTextBuilder.AppendLine(File.ReadAllText(licenseFiles.First().Name));
+      foreach (var licenseFile in licenseFiles.Skip(1)) {
+        licenseTextBuilder.AppendLine().AppendLine(); // leave some empty space between multiple license files
+        licenseTextBuilder.AppendLine(File.ReadAllText(licenseFile.Name));
+      }
+      return licenseTextBuilder.ToString();
     }