2012-07-24 16:54:34 +02:00
|
|
|
|
using System;
|
|
|
|
|
using System.IO;
|
2012-07-12 08:55:27 +02:00
|
|
|
|
using MediaBrowser.Common.Json;
|
2012-07-24 16:54:34 +02:00
|
|
|
|
using MediaBrowser.Model.Plugins;
|
2012-07-29 17:19:25 +02:00
|
|
|
|
using MediaBrowser.Common.Kernel;
|
2012-07-12 08:55:27 +02:00
|
|
|
|
|
|
|
|
|
namespace MediaBrowser.Common.Plugins
|
|
|
|
|
{
|
2012-07-24 16:54:34 +02:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Provides a BasePlugin with generics, allowing for strongly typed configuration access.
|
|
|
|
|
/// </summary>
|
|
|
|
|
public abstract class BaseGenericPlugin<TConfigurationType> : BasePlugin
|
2012-07-12 08:55:27 +02:00
|
|
|
|
where TConfigurationType : BasePluginConfiguration, new()
|
|
|
|
|
{
|
2012-07-24 16:54:34 +02:00
|
|
|
|
public new TConfigurationType Configuration
|
|
|
|
|
{
|
|
|
|
|
get
|
|
|
|
|
{
|
|
|
|
|
return base.Configuration as TConfigurationType;
|
|
|
|
|
}
|
|
|
|
|
set
|
|
|
|
|
{
|
|
|
|
|
base.Configuration = value;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2012-07-29 17:19:25 +02:00
|
|
|
|
protected override Type ConfigurationType
|
2012-07-24 16:54:34 +02:00
|
|
|
|
{
|
2012-07-29 17:19:25 +02:00
|
|
|
|
get { return typeof(TConfigurationType); }
|
2012-07-24 16:54:34 +02:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Provides a common base class for all plugins
|
|
|
|
|
/// </summary>
|
2012-07-29 17:19:25 +02:00
|
|
|
|
public abstract class BasePlugin : IDisposable
|
2012-07-24 16:54:34 +02:00
|
|
|
|
{
|
2012-07-29 17:19:25 +02:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets or sets the plugin's current context
|
|
|
|
|
/// </summary>
|
|
|
|
|
public KernelContext Context { get; set; }
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the name of the plugin
|
|
|
|
|
/// </summary>
|
2012-07-24 16:54:34 +02:00
|
|
|
|
public abstract string Name { get; }
|
2012-07-26 04:33:11 +02:00
|
|
|
|
|
2012-07-29 17:19:25 +02:00
|
|
|
|
/// <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>
|
2012-07-26 19:00:53 +02:00
|
|
|
|
public string Path { get; set; }
|
2012-07-26 04:33:11 +02:00
|
|
|
|
|
2012-07-29 17:19:25 +02:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets or sets the plugin version
|
|
|
|
|
/// </summary>
|
2012-07-26 19:00:53 +02:00
|
|
|
|
public Version Version { get; set; }
|
2012-07-12 08:55:27 +02:00
|
|
|
|
|
2012-07-29 17:19:25 +02:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets or sets the current plugin configuration
|
|
|
|
|
/// </summary>
|
2012-07-24 16:54:34 +02:00
|
|
|
|
public BasePluginConfiguration Configuration { get; protected set; }
|
|
|
|
|
|
|
|
|
|
protected string ConfigurationPath
|
2012-07-12 08:55:27 +02:00
|
|
|
|
{
|
|
|
|
|
get
|
|
|
|
|
{
|
|
|
|
|
return System.IO.Path.Combine(Path, "config.js");
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2012-07-24 16:54:34 +02:00
|
|
|
|
public bool Enabled
|
|
|
|
|
{
|
|
|
|
|
get
|
2012-07-12 08:55:27 +02:00
|
|
|
|
{
|
2012-07-24 16:54:34 +02:00
|
|
|
|
return Configuration.Enabled;
|
2012-07-12 08:55:27 +02:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2012-07-24 16:54:34 +02:00
|
|
|
|
public DateTime ConfigurationDateLastModified
|
|
|
|
|
{
|
|
|
|
|
get
|
|
|
|
|
{
|
|
|
|
|
return Configuration.DateLastModified;
|
|
|
|
|
}
|
|
|
|
|
}
|
2012-07-12 08:55:27 +02:00
|
|
|
|
|
2012-07-24 16:54:34 +02:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Returns true or false indicating if the plugin should be downloaded and run within the UI.
|
|
|
|
|
/// </summary>
|
|
|
|
|
public virtual bool DownloadToUI
|
2012-07-12 08:55:27 +02:00
|
|
|
|
{
|
2012-07-24 16:54:34 +02:00
|
|
|
|
get
|
2012-07-12 08:55:27 +02:00
|
|
|
|
{
|
2012-07-24 16:54:34 +02:00
|
|
|
|
return false;
|
2012-07-12 08:55:27 +02:00
|
|
|
|
}
|
2012-07-24 16:54:34 +02:00
|
|
|
|
}
|
2012-07-12 08:55:27 +02:00
|
|
|
|
|
2012-07-29 17:19:25 +02:00
|
|
|
|
public void ReloadConfiguration()
|
2012-07-24 16:54:34 +02:00
|
|
|
|
{
|
2012-07-29 17:19:25 +02:00
|
|
|
|
if (!File.Exists(ConfigurationPath))
|
|
|
|
|
{
|
|
|
|
|
Configuration = Activator.CreateInstance(ConfigurationType) as BasePluginConfiguration;
|
|
|
|
|
}
|
|
|
|
|
else
|
|
|
|
|
{
|
|
|
|
|
Configuration = JsonSerializer.DeserializeFromFile(ConfigurationType, ConfigurationPath) as BasePluginConfiguration;
|
|
|
|
|
Configuration.DateLastModified = File.GetLastWriteTime(ConfigurationPath);
|
|
|
|
|
}
|
2012-07-12 08:55:27 +02:00
|
|
|
|
}
|
|
|
|
|
|
2012-07-29 17:19:25 +02:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Starts the plugin.
|
|
|
|
|
/// </summary>
|
|
|
|
|
public virtual void Init()
|
2012-07-24 16:54:34 +02:00
|
|
|
|
{
|
|
|
|
|
}
|
2012-07-12 08:55:27 +02:00
|
|
|
|
|
2012-07-29 17:19:25 +02:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Disposes the plugins. Undos all actions performed during Init.
|
|
|
|
|
/// </summary>
|
|
|
|
|
public virtual void Dispose()
|
|
|
|
|
{
|
|
|
|
|
}
|
2012-07-12 08:55:27 +02:00
|
|
|
|
}
|
|
|
|
|
}
|