diff options
| author | LukePulverenti Luke Pulverenti luke pulverenti <LukePulverenti Luke Pulverenti luke.pulverenti@gmail.com> | 2012-07-29 11:19:25 -0400 |
|---|---|---|
| committer | LukePulverenti Luke Pulverenti luke pulverenti <LukePulverenti Luke Pulverenti luke.pulverenti@gmail.com> | 2012-07-29 11:19:25 -0400 |
| commit | 5d88dc857513344a4ecd1b337c1529250e5e2dfa (patch) | |
| tree | 33142d3b022ab64df737eed584a0a3a723bda6d5 /MediaBrowser.Common/Plugins/BasePlugin.cs | |
| parent | 77e81432f7ff49fed71677c4f7b0cb8b4acc92e3 (diff) | |
Configuration and serialization improvements
Diffstat (limited to 'MediaBrowser.Common/Plugins/BasePlugin.cs')
| -rw-r--r-- | MediaBrowser.Common/Plugins/BasePlugin.cs | 61 |
1 files changed, 46 insertions, 15 deletions
diff --git a/MediaBrowser.Common/Plugins/BasePlugin.cs b/MediaBrowser.Common/Plugins/BasePlugin.cs index 3e10c4c9c..61ecffc75 100644 --- a/MediaBrowser.Common/Plugins/BasePlugin.cs +++ b/MediaBrowser.Common/Plugins/BasePlugin.cs @@ -2,6 +2,7 @@ using System.IO;
using MediaBrowser.Common.Json;
using MediaBrowser.Model.Plugins;
+using MediaBrowser.Common.Kernel;
namespace MediaBrowser.Common.Plugins
{
@@ -23,31 +24,45 @@ namespace MediaBrowser.Common.Plugins }
}
- public override void ReloadConfiguration()
+ protected override Type ConfigurationType
{
- if (!File.Exists(ConfigurationPath))
- {
- Configuration = new TConfigurationType();
- }
- else
- {
- Configuration = JsonSerializer.DeserializeFromFile<TConfigurationType>(ConfigurationPath);
- Configuration.DateLastModified = File.GetLastWriteTime(ConfigurationPath);
- }
+ get { return typeof(TConfigurationType); }
}
}
/// <summary>
/// Provides a common base class for all plugins
/// </summary>
- public abstract class BasePlugin
+ public abstract class BasePlugin : IDisposable
{
+ /// <summary>
+ /// Gets or sets the plugin's current context
+ /// </summary>
+ public KernelContext Context { get; set; }
+
+ /// <summary>
+ /// Gets the name of the plugin
+ /// </summary>
public abstract string Name { get; }
+ /// <summary>
+ /// Gets the type of configuration this plugin uses
+ /// </summary>
+ protected abstract Type ConfigurationType { get; }
+
+ /// <summary>
+ /// Gets or sets the path to the plugin's folder
+ /// </summary>
public string Path { get; set; }
+ /// <summary>
+ /// Gets or sets the plugin version
+ /// </summary>
public Version Version { get; set; }
+ /// <summary>
+ /// Gets or sets the current plugin configuration
+ /// </summary>
public BasePluginConfiguration Configuration { get; protected set; }
protected string ConfigurationPath
@@ -85,15 +100,31 @@ namespace MediaBrowser.Common.Plugins }
}
- public abstract void ReloadConfiguration();
-
- public virtual void InitInServer()
+ public void ReloadConfiguration()
{
+ if (!File.Exists(ConfigurationPath))
+ {
+ Configuration = Activator.CreateInstance(ConfigurationType) as BasePluginConfiguration;
+ }
+ else
+ {
+ Configuration = JsonSerializer.DeserializeFromFile(ConfigurationType, ConfigurationPath) as BasePluginConfiguration;
+ Configuration.DateLastModified = File.GetLastWriteTime(ConfigurationPath);
+ }
}
- public virtual void InitInUI()
+ /// <summary>
+ /// Starts the plugin.
+ /// </summary>
+ public virtual void Init()
{
}
+ /// <summary>
+ /// Disposes the plugins. Undos all actions performed during Init.
+ /// </summary>
+ public virtual void Dispose()
+ {
+ }
}
}
|