mirror of
https://github.com/jellyfin/jellyfin.git
synced 2024-09-06 19:37:55 +02:00
352 lines
11 KiB
C#
352 lines
11 KiB
C#
using MediaBrowser.Common.Configuration;
|
|
using MediaBrowser.Model.Plugins;
|
|
using MediaBrowser.Model.Serialization;
|
|
using System;
|
|
using System.IO;
|
|
using System.Reflection;
|
|
using System.Runtime.InteropServices;
|
|
|
|
namespace MediaBrowser.Common.Plugins
|
|
{
|
|
/// <summary>
|
|
/// Provides a common base class for all plugins
|
|
/// </summary>
|
|
/// <typeparam name="TConfigurationType">The type of the T configuration type.</typeparam>
|
|
public abstract class BasePlugin<TConfigurationType> : IPlugin
|
|
where TConfigurationType : BasePluginConfiguration
|
|
{
|
|
/// <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>
|
|
/// Gets the name of the plugin
|
|
/// </summary>
|
|
/// <value>The name.</value>
|
|
public abstract string Name { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether this instance is first run.
|
|
/// </summary>
|
|
/// <value><c>true</c> if this instance is first run; otherwise, <c>false</c>.</value>
|
|
public bool IsFirstRun { get; private set; }
|
|
|
|
/// <summary>
|
|
/// Gets the description.
|
|
/// </summary>
|
|
/// <value>The description.</value>
|
|
public virtual string Description
|
|
{
|
|
get { return string.Empty; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the type of configuration this plugin uses
|
|
/// </summary>
|
|
/// <value>The type of the configuration.</value>
|
|
public Type ConfigurationType
|
|
{
|
|
get { return typeof(TConfigurationType); }
|
|
}
|
|
|
|
/// <summary>
|
|
/// The _assembly name
|
|
/// </summary>
|
|
private AssemblyName _assemblyName;
|
|
/// <summary>
|
|
/// Gets the name of the assembly.
|
|
/// </summary>
|
|
/// <value>The name of the assembly.</value>
|
|
protected AssemblyName AssemblyName
|
|
{
|
|
get
|
|
{
|
|
return _assemblyName ?? (_assemblyName = GetType().Assembly.GetName());
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// The _unique id
|
|
/// </summary>
|
|
private Guid? _uniqueId;
|
|
|
|
/// <summary>
|
|
/// Gets the unique id.
|
|
/// </summary>
|
|
/// <value>The unique id.</value>
|
|
public Guid Id
|
|
{
|
|
get
|
|
{
|
|
|
|
if (!_uniqueId.HasValue)
|
|
{
|
|
var attribute = (GuidAttribute)GetType().Assembly.GetCustomAttributes(typeof(GuidAttribute), true)[0];
|
|
_uniqueId = new Guid(attribute.Value);
|
|
}
|
|
|
|
return _uniqueId.Value;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the plugin version
|
|
/// </summary>
|
|
/// <value>The version.</value>
|
|
public Version Version
|
|
{
|
|
get
|
|
{
|
|
return AssemblyName.Version;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the name the assembly file
|
|
/// </summary>
|
|
/// <value>The name of the assembly file.</value>
|
|
public string AssemblyFileName
|
|
{
|
|
get
|
|
{
|
|
return AssemblyName.Name + ".dll";
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the last date modified of the configuration
|
|
/// </summary>
|
|
/// <value>The configuration date last modified.</value>
|
|
public DateTime ConfigurationDateLastModified
|
|
{
|
|
get
|
|
{
|
|
// Ensure it's been lazy loaded
|
|
var config = Configuration;
|
|
|
|
return File.GetLastWriteTimeUtc(ConfigurationFilePath);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the last date modified of the plugin
|
|
/// </summary>
|
|
/// <value>The assembly date last modified.</value>
|
|
public DateTime AssemblyDateLastModified
|
|
{
|
|
get
|
|
{
|
|
return File.GetLastWriteTimeUtc(AssemblyFilePath);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the path to the assembly file
|
|
/// </summary>
|
|
/// <value>The assembly file path.</value>
|
|
public string AssemblyFilePath
|
|
{
|
|
get
|
|
{
|
|
return Path.Combine(ApplicationPaths.PluginsPath, AssemblyFileName);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// The _configuration sync lock
|
|
/// </summary>
|
|
private readonly object _configurationSyncLock = new object();
|
|
/// <summary>
|
|
/// The _configuration
|
|
/// </summary>
|
|
private TConfigurationType _configuration;
|
|
/// <summary>
|
|
/// Gets the plugin's configuration
|
|
/// </summary>
|
|
/// <value>The configuration.</value>
|
|
public TConfigurationType Configuration
|
|
{
|
|
get
|
|
{
|
|
// Lazy load
|
|
if (_configuration == null)
|
|
{
|
|
lock (_configurationSyncLock)
|
|
{
|
|
if (_configuration == null)
|
|
{
|
|
_configuration = LoadConfiguration();
|
|
}
|
|
}
|
|
}
|
|
return _configuration;
|
|
}
|
|
protected set
|
|
{
|
|
_configuration = value;
|
|
}
|
|
}
|
|
|
|
private TConfigurationType LoadConfiguration()
|
|
{
|
|
var path = ConfigurationFilePath;
|
|
|
|
try
|
|
{
|
|
return (TConfigurationType)XmlSerializer.DeserializeFromFile(typeof(TConfigurationType), path);
|
|
}
|
|
catch (DirectoryNotFoundException)
|
|
{
|
|
return (TConfigurationType)Activator.CreateInstance(typeof(TConfigurationType));
|
|
}
|
|
catch (FileNotFoundException)
|
|
{
|
|
return (TConfigurationType)Activator.CreateInstance(typeof(TConfigurationType));
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
return (TConfigurationType)Activator.CreateInstance(typeof(TConfigurationType));
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the name of the configuration file. Subclasses should override
|
|
/// </summary>
|
|
/// <value>The name of the configuration file.</value>
|
|
public virtual string ConfigurationFileName
|
|
{
|
|
get { return Path.ChangeExtension(AssemblyFileName, ".xml"); }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the full path to the configuration file
|
|
/// </summary>
|
|
/// <value>The configuration file path.</value>
|
|
public string ConfigurationFilePath
|
|
{
|
|
get
|
|
{
|
|
return Path.Combine(ApplicationPaths.PluginConfigurationsPath, ConfigurationFileName);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// The _data folder path
|
|
/// </summary>
|
|
private string _dataFolderPath;
|
|
/// <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
|
|
{
|
|
if (_dataFolderPath == null)
|
|
{
|
|
// Give the folder name the same name as the config file name
|
|
// We can always make this configurable if/when needed
|
|
_dataFolderPath = Path.Combine(ApplicationPaths.PluginsPath, Path.GetFileNameWithoutExtension(ConfigurationFileName));
|
|
|
|
Directory.CreateDirectory(_dataFolderPath);
|
|
}
|
|
|
|
return _dataFolderPath;
|
|
}
|
|
}
|
|
|
|
/// <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;
|
|
|
|
IsFirstRun = !File.Exists(ConfigurationFilePath);
|
|
}
|
|
|
|
/// <summary>
|
|
/// The _save lock
|
|
/// </summary>
|
|
private readonly object _configurationSaveLock = new object();
|
|
|
|
/// <summary>
|
|
/// Saves the current configuration to the file system
|
|
/// </summary>
|
|
public virtual void SaveConfiguration()
|
|
{
|
|
lock (_configurationSaveLock)
|
|
{
|
|
Directory.CreateDirectory(Path.GetDirectoryName(ConfigurationFilePath));
|
|
|
|
XmlSerializer.SerializeToFile(Configuration, ConfigurationFilePath);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Completely overwrites the current configuration with a new copy
|
|
/// Returns true or false indicating success or failure
|
|
/// </summary>
|
|
/// <param name="configuration">The configuration.</param>
|
|
/// <exception cref="System.ArgumentNullException">configuration</exception>
|
|
public virtual void UpdateConfiguration(BasePluginConfiguration configuration)
|
|
{
|
|
if (configuration == null)
|
|
{
|
|
throw new ArgumentNullException("configuration");
|
|
}
|
|
|
|
Configuration = (TConfigurationType)configuration;
|
|
|
|
SaveConfiguration();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the plugin info.
|
|
/// </summary>
|
|
/// <returns>PluginInfo.</returns>
|
|
public PluginInfo GetPluginInfo()
|
|
{
|
|
var info = new PluginInfo
|
|
{
|
|
Name = Name,
|
|
Version = Version.ToString(),
|
|
AssemblyFileName = AssemblyFileName,
|
|
ConfigurationDateLastModified = ConfigurationDateLastModified,
|
|
Description = Description,
|
|
Id = Id.ToString(),
|
|
ConfigurationFileName = ConfigurationFileName
|
|
};
|
|
|
|
return info;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Called when just before the plugin is uninstalled from the server.
|
|
/// </summary>
|
|
public virtual void OnUninstalling()
|
|
{
|
|
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the plugin's configuration
|
|
/// </summary>
|
|
/// <value>The configuration.</value>
|
|
BasePluginConfiguration IPlugin.Configuration
|
|
{
|
|
get { return Configuration; }
|
|
}
|
|
}
|
|
}
|