1 | #region License Information
|
---|
2 | /* HeuristicLab
|
---|
3 | * Copyright (C) 2002-2008 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
|
---|
4 | *
|
---|
5 | * This file is part of HeuristicLab.
|
---|
6 | *
|
---|
7 | * HeuristicLab is free software: you can redistribute it and/or modify
|
---|
8 | * it under the terms of the GNU General Public License as published by
|
---|
9 | * the Free Software Foundation, either version 3 of the License, or
|
---|
10 | * (at your option) any later version.
|
---|
11 | *
|
---|
12 | * HeuristicLab is distributed in the hope that it will be useful,
|
---|
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
---|
15 | * GNU General Public License for more details.
|
---|
16 | *
|
---|
17 | * You should have received a copy of the GNU General Public License
|
---|
18 | * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
|
---|
19 | */
|
---|
20 | #endregion
|
---|
21 |
|
---|
22 | using System;
|
---|
23 | using System.Collections.Generic;
|
---|
24 | using System.Text;
|
---|
25 | using System.Reflection;
|
---|
26 | using System.Diagnostics;
|
---|
27 |
|
---|
28 | namespace HeuristicLab.PluginInfrastructure {
|
---|
29 | /// <summary>
|
---|
30 | /// Default implementation of the IPlugin interface.
|
---|
31 | /// </summary>
|
---|
32 | public class PluginBase : IPlugin {
|
---|
33 | private string name;
|
---|
34 | private Version version;
|
---|
35 | private string[] files;
|
---|
36 | private string description;
|
---|
37 |
|
---|
38 | public PluginBase() {
|
---|
39 | ReadAttributes();
|
---|
40 | }
|
---|
41 |
|
---|
42 | private void ReadAttributes() {
|
---|
43 | object[] pluginAttributes = this.GetType().GetCustomAttributes(typeof(ClassInfoAttribute), false);
|
---|
44 |
|
---|
45 | // exactly one attribute of the type ClassInfoAttribute must be given
|
---|
46 | Trace.Assert(pluginAttributes.Length == 1);
|
---|
47 |
|
---|
48 | // after the assertion we are sure that the array access will not fail
|
---|
49 | ClassInfoAttribute pluginAttribute = (ClassInfoAttribute)pluginAttributes[0];
|
---|
50 |
|
---|
51 | // if the plugin name is not explicitly set in the attribute then the default plugin name is the FullName of the type
|
---|
52 | if(pluginAttribute != null && pluginAttribute.Name != null) {
|
---|
53 | this.name = pluginAttribute.Name;
|
---|
54 | } else {
|
---|
55 | this.name = this.GetType().FullName;
|
---|
56 | }
|
---|
57 |
|
---|
58 | // if the version is not explicitly set in the attribute then the version of the assembly is used as default
|
---|
59 | if(pluginAttribute != null && pluginAttribute.Version != null) {
|
---|
60 | this.version = new Version(pluginAttribute.Version);
|
---|
61 | } else {
|
---|
62 | this.version = this.GetType().Assembly.GetName().Version;
|
---|
63 | }
|
---|
64 |
|
---|
65 | // if the description is not explicitly set in the attribute then the name of name of the plugin is used as default
|
---|
66 | if(pluginAttribute != null && pluginAttribute.Description != null) {
|
---|
67 | this.description = pluginAttribute.Description;
|
---|
68 | } else {
|
---|
69 | this.description = name;
|
---|
70 | }
|
---|
71 |
|
---|
72 | // get all attributes of type PluginFileAttribute, multiple usage is possible
|
---|
73 | PluginFileAttribute[] fileAttributes = (PluginFileAttribute[])this.GetType().GetCustomAttributes(typeof(PluginFileAttribute), false);
|
---|
74 |
|
---|
75 | // exctract the file names from the attributes
|
---|
76 | this.files = new string[fileAttributes.Length];
|
---|
77 | int i = 0;
|
---|
78 | foreach(PluginFileAttribute fileAttr in fileAttributes) {
|
---|
79 | files[i++] = fileAttr.Filename;
|
---|
80 | }
|
---|
81 | }
|
---|
82 |
|
---|
83 | #region IPlugin Members
|
---|
84 | public string Name {
|
---|
85 | get {
|
---|
86 | return name;
|
---|
87 | }
|
---|
88 | }
|
---|
89 |
|
---|
90 | public Version Version {
|
---|
91 | get {
|
---|
92 | return version;
|
---|
93 | }
|
---|
94 | }
|
---|
95 |
|
---|
96 | public string Description {
|
---|
97 | get {
|
---|
98 | return description;
|
---|
99 | }
|
---|
100 | }
|
---|
101 |
|
---|
102 | public string[] Files {
|
---|
103 | get {
|
---|
104 | return files;
|
---|
105 | }
|
---|
106 | }
|
---|
107 |
|
---|
108 | public virtual void OnInstall() {
|
---|
109 | }
|
---|
110 |
|
---|
111 | public virtual void OnDelete() {
|
---|
112 | }
|
---|
113 |
|
---|
114 | public virtual void OnPreUpdate() {
|
---|
115 | }
|
---|
116 |
|
---|
117 | public virtual void OnPostUpdate() {
|
---|
118 | }
|
---|
119 |
|
---|
120 | #endregion
|
---|
121 |
|
---|
122 | }
|
---|
123 | }
|
---|