#pragma warning disable SA1402 using System; using System.IO; using System.Reflection; using MediaBrowser.Common.Configuration; using MediaBrowser.Model.Plugins; using MediaBrowser.Model.Serialization; using Microsoft.Extensions.DependencyInjection; namespace MediaBrowser.Common.Plugins { /// /// Provides a common base class for all plugins. /// public abstract class BasePlugin : IPlugin, IPluginAssembly { /// /// Gets the name of the plugin. /// /// The name. public abstract string Name { get; } /// /// Gets the description. /// /// The description. public virtual string Description => string.Empty; /// /// Gets the unique id. /// /// The unique id. public virtual Guid Id { get; private set; } /// /// Gets the plugin version. /// /// The version. public Version Version { get; private set; } /// /// Gets the path to the assembly file. /// /// The assembly file path. public string AssemblyFilePath { get; private set; } /// /// Gets the full path to the data folder, where the plugin can store any miscellaneous files needed. /// /// The data folder path. public string DataFolderPath { get; private set; } /// /// Gets a value indicating whether the plugin can be uninstalled. /// public bool CanUninstall => !Path.GetDirectoryName(AssemblyFilePath) .Equals(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), StringComparison.InvariantCulture); /// /// Gets the plugin info. /// /// PluginInfo. public virtual PluginInfo GetPluginInfo() { var info = new PluginInfo { Name = Name, Version = Version.ToString(), Description = Description, Id = Id.ToString(), CanUninstall = CanUninstall }; return info; } /// /// Called just before the plugin is uninstalled from the server. /// public virtual void OnUninstalling() { } /// public virtual void RegisterServices(IServiceCollection serviceCollection) { } /// public virtual void UnregisterServices(IServiceCollection serviceCollection) { } /// public void SetAttributes(string assemblyFilePath, string dataFolderPath, Version assemblyVersion) { AssemblyFilePath = assemblyFilePath; DataFolderPath = dataFolderPath; Version = assemblyVersion; } /// public void SetId(Guid assemblyId) { Id = assemblyId; } } /// /// Provides a common base class for all plugins. /// /// The type of the T configuration type. public abstract class BasePlugin : BasePlugin, IHasPluginConfiguration where TConfigurationType : BasePluginConfiguration { /// /// The configuration sync lock. /// private readonly object _configurationSyncLock = new object(); /// /// The configuration save lock. /// private readonly object _configurationSaveLock = new object(); private Action _directoryCreateFn; /// /// The configuration. /// private TConfigurationType _configuration; /// /// Initializes a new instance of the class. /// /// The application paths. /// The XML serializer. protected BasePlugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer) { ApplicationPaths = applicationPaths; XmlSerializer = xmlSerializer; if (this is IPluginAssembly assemblyPlugin) { var assembly = GetType().Assembly; var assemblyName = assembly.GetName(); var assemblyFilePath = assembly.Location; var dataFolderPath = Path.Combine(ApplicationPaths.PluginsPath, Path.GetFileNameWithoutExtension(assemblyFilePath)); assemblyPlugin.SetAttributes(assemblyFilePath, dataFolderPath, assemblyName.Version); try { var idAttributes = assembly.GetCustomAttributes(typeof(GuidAttribute), true); if (idAttributes.Length > 0) { var attribute = (GuidAttribute)idAttributes[0]; var assemblyId = new Guid(attribute.Value); assemblyPlugin.SetId(assemblyId); } } catch (Exception ex) { Logger.LogError(ex, "Error getting plugin Id from {PluginName}.", plugin.GetType().FullName); } } if (this is IHasPluginConfiguration hasPluginConfiguration) { hasPluginConfiguration.SetStartupInfo(s => Directory.CreateDirectory(s)); } } /// /// Gets the application paths. /// /// The application paths. protected IApplicationPaths ApplicationPaths { get; private set; } /// /// Gets the XML serializer. /// /// The XML serializer. protected IXmlSerializer XmlSerializer { get; private set; } /// /// Gets the type of configuration this plugin uses. /// /// The type of the configuration. public Type ConfigurationType => typeof(TConfigurationType); /// /// Gets the name the assembly file. /// /// The name of the assembly file. protected string AssemblyFileName => Path.GetFileName(AssemblyFilePath); /// /// Gets or sets the plugin configuration. /// /// The configuration. public TConfigurationType Configuration { get { // Lazy load if (_configuration == null) { lock (_configurationSyncLock) { if (_configuration == null) { _configuration = LoadConfiguration(); } } } return _configuration; } protected set => _configuration = value; } /// /// Gets the name of the configuration file. Subclasses should override. /// /// The name of the configuration file. public virtual string ConfigurationFileName => Path.ChangeExtension(AssemblyFileName, ".xml"); /// /// Gets the full path to the configuration file. /// /// The configuration file path. public string ConfigurationFilePath => Path.Combine(ApplicationPaths.PluginConfigurationsPath, ConfigurationFileName); /// /// Gets the plugin configuration. /// /// The configuration. BasePluginConfiguration IHasPluginConfiguration.Configuration => Configuration; /// public void SetStartupInfo(Action directoryCreateFn) { // hack alert, until the .net core transition is complete _directoryCreateFn = directoryCreateFn; } private TConfigurationType LoadConfiguration() { var path = ConfigurationFilePath; try { return (TConfigurationType)XmlSerializer.DeserializeFromFile(typeof(TConfigurationType), path); } catch { return (TConfigurationType)Activator.CreateInstance(typeof(TConfigurationType)); } } /// /// Saves the current configuration to the file system. /// public virtual void SaveConfiguration() { lock (_configurationSaveLock) { _directoryCreateFn(Path.GetDirectoryName(ConfigurationFilePath)); XmlSerializer.SerializeToFile(Configuration, ConfigurationFilePath); } } /// public virtual void UpdateConfiguration(BasePluginConfiguration configuration) { if (configuration == null) { throw new ArgumentNullException(nameof(configuration)); } Configuration = (TConfigurationType)configuration; SaveConfiguration(); } /// public override PluginInfo GetPluginInfo() { var info = base.GetPluginInfo(); info.ConfigurationFileName = ConfigurationFileName; return info; } } }