jellyfin-server/MediaBrowser.Common/Plugins/BasePlugin.cs

252 lines
7.8 KiB
C#
Raw Normal View History

2019-12-10 23:13:57 +00:00
#pragma warning disable SA1402
using System;
using System.IO;
using MediaBrowser.Common.Configuration;
2018-12-27 23:27:57 +00:00
using MediaBrowser.Model.Plugins;
using MediaBrowser.Model.Serialization;
namespace MediaBrowser.Common.Plugins
{
2019-12-10 23:13:57 +00:00
/// <summary>
/// Provides a common base class for all plugins.
/// </summary>
2018-12-27 23:27:57 +00:00
public abstract class BasePlugin : IPlugin, IPluginAssembly
{
/// <summary>
2019-12-10 23:13:57 +00:00
/// Gets the name of the plugin.
2018-12-27 23:27:57 +00:00
/// </summary>
/// <value>The name.</value>
public abstract string Name { get; }
/// <summary>
/// Gets the description.
/// </summary>
/// <value>The description.</value>
public virtual string Description => string.Empty;
2018-12-27 23:27:57 +00:00
/// <summary>
/// Gets the unique id.
/// </summary>
/// <value>The unique id.</value>
public virtual Guid Id { get; private set; }
/// <summary>
2019-12-10 23:13:57 +00:00
/// Gets the plugin version.
2018-12-27 23:27:57 +00:00
/// </summary>
/// <value>The version.</value>
public Version Version { get; private set; }
/// <summary>
2019-12-10 23:13:57 +00:00
/// Gets the path to the assembly file.
2018-12-27 23:27:57 +00:00
/// </summary>
/// <value>The assembly file path.</value>
public string AssemblyFilePath { get; private set; }
2019-12-10 23:13:57 +00:00
/// <summary>
/// Gets the full path to the data folder, where the plugin can store any miscellaneous files needed.
/// </summary>
/// <value>The data folder path.</value>
public string DataFolderPath { get; private set; }
2018-12-27 23:27:57 +00:00
/// <summary>
/// Gets the plugin info.
/// </summary>
/// <returns>PluginInfo.</returns>
public virtual PluginInfo GetPluginInfo()
{
var info = new PluginInfo
{
Name = Name,
Version = Version.ToString(),
Description = Description,
Id = Id.ToString()
};
return info;
}
/// <summary>
/// Called just before the plugin is uninstalled from the server.
2018-12-27 23:27:57 +00:00
/// </summary>
public virtual void OnUninstalling()
{
}
2019-12-10 23:13:57 +00:00
/// <inheritdoc />
2018-12-27 23:27:57 +00:00
public void SetAttributes(string assemblyFilePath, string dataFolderPath, Version assemblyVersion)
{
AssemblyFilePath = assemblyFilePath;
DataFolderPath = dataFolderPath;
Version = assemblyVersion;
}
2019-12-10 23:13:57 +00:00
/// <inheritdoc />
2018-12-27 23:27:57 +00:00
public void SetId(Guid assemblyId)
{
Id = assemblyId;
}
}
/// <summary>
2019-12-10 23:13:57 +00:00
/// Provides a common base class for all plugins.
2018-12-27 23:27:57 +00:00
/// </summary>
/// <typeparam name="TConfigurationType">The type of the T configuration type.</typeparam>
public abstract class BasePlugin<TConfigurationType> : BasePlugin, IHasPluginConfiguration
where TConfigurationType : BasePluginConfiguration
{
2019-12-10 23:13:57 +00:00
/// <summary>
/// The configuration sync lock.
2019-12-10 23:13:57 +00:00
/// </summary>
private readonly object _configurationSyncLock = new object();
/// <summary>
/// The configuration save lock.
2019-12-10 23:13:57 +00:00
/// </summary>
private readonly object _configurationSaveLock = new object();
private Action<string> _directoryCreateFn;
/// <summary>
/// The configuration.
2019-12-10 23:13:57 +00:00
/// </summary>
private TConfigurationType _configuration;
/// <summary>
/// Initializes a new instance of the <see cref="BasePlugin{TConfigurationType}" /> class.
/// </summary>
/// <param name="applicationPaths">The application paths.</param>
/// <param name="xmlSerializer">The XML serializer.</param>
protected BasePlugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer)
{
ApplicationPaths = applicationPaths;
XmlSerializer = xmlSerializer;
}
2018-12-27 23:27:57 +00:00
/// <summary>
/// Gets the application paths.
/// </summary>
/// <value>The application paths.</value>
protected IApplicationPaths ApplicationPaths { get; private set; }
/// <summary>
/// Gets the XML serializer.
/// </summary>
/// <value>The XML serializer.</value>
protected IXmlSerializer XmlSerializer { get; private set; }
/// <summary>
2019-12-10 23:13:57 +00:00
/// Gets the type of configuration this plugin uses.
2018-12-27 23:27:57 +00:00
/// </summary>
/// <value>The type of the configuration.</value>
public Type ConfigurationType => typeof(TConfigurationType);
2018-12-27 23:27:57 +00:00
/// <summary>
2019-12-10 23:13:57 +00:00
/// Gets the name the assembly file.
2018-12-27 23:27:57 +00:00
/// </summary>
/// <value>The name of the assembly file.</value>
protected string AssemblyFileName => Path.GetFileName(AssemblyFilePath);
2018-12-27 23:27:57 +00:00
/// <summary>
/// Gets or sets the plugin configuration.
2018-12-27 23:27:57 +00:00
/// </summary>
/// <value>The configuration.</value>
public TConfigurationType Configuration
{
get
{
// Lazy load
if (_configuration == null)
{
lock (_configurationSyncLock)
{
if (_configuration == null)
{
_configuration = LoadConfiguration();
}
}
}
2019-12-10 23:13:57 +00:00
2018-12-27 23:27:57 +00:00
return _configuration;
}
2019-12-10 23:13:57 +00:00
protected set => _configuration = value;
2018-12-27 23:27:57 +00:00
}
/// <summary>
2019-12-10 23:13:57 +00:00
/// Gets the name of the configuration file. Subclasses should override.
2018-12-27 23:27:57 +00:00
/// </summary>
/// <value>The name of the configuration file.</value>
public virtual string ConfigurationFileName => Path.ChangeExtension(AssemblyFileName, ".xml");
2018-12-27 23:27:57 +00:00
/// <summary>
2019-12-10 23:13:57 +00:00
/// Gets the full path to the configuration file.
2018-12-27 23:27:57 +00:00
/// </summary>
/// <value>The configuration file path.</value>
public string ConfigurationFilePath => Path.Combine(ApplicationPaths.PluginConfigurationsPath, ConfigurationFileName);
2018-12-27 23:27:57 +00:00
/// <summary>
/// Gets the plugin configuration.
2018-12-27 23:27:57 +00:00
/// </summary>
2019-12-10 23:13:57 +00:00
/// <value>The configuration.</value>
BasePluginConfiguration IHasPluginConfiguration.Configuration => Configuration;
/// <inheritdoc />
public void SetStartupInfo(Action<string> directoryCreateFn)
2018-12-27 23:27:57 +00:00
{
2019-12-10 23:13:57 +00:00
// hack alert, until the .net core transition is complete
_directoryCreateFn = directoryCreateFn;
2018-12-27 23:27:57 +00:00
}
2019-12-10 23:13:57 +00:00
private TConfigurationType LoadConfiguration()
{
var path = ConfigurationFilePath;
try
{
return (TConfigurationType)XmlSerializer.DeserializeFromFile(typeof(TConfigurationType), path);
}
catch
{
return (TConfigurationType)Activator.CreateInstance(typeof(TConfigurationType));
}
}
2018-12-27 23:27:57 +00:00
/// <summary>
2019-12-10 23:13:57 +00:00
/// Saves the current configuration to the file system.
2018-12-27 23:27:57 +00:00
/// </summary>
public virtual void SaveConfiguration()
{
lock (_configurationSaveLock)
{
_directoryCreateFn(Path.GetDirectoryName(ConfigurationFilePath));
XmlSerializer.SerializeToFile(Configuration, ConfigurationFilePath);
}
}
2019-12-10 23:13:57 +00:00
/// <inheritdoc />
2018-12-27 23:27:57 +00:00
public virtual void UpdateConfiguration(BasePluginConfiguration configuration)
{
if (configuration == null)
{
throw new ArgumentNullException(nameof(configuration));
2018-12-27 23:27:57 +00:00
}
Configuration = (TConfigurationType)configuration;
SaveConfiguration();
}
2019-12-10 23:13:57 +00:00
/// <inheritdoc />
2018-12-27 23:27:57 +00:00
public override PluginInfo GetPluginInfo()
{
var info = base.GetPluginInfo();
info.ConfigurationFileName = ConfigurationFileName;
return info;
}
}
}