using MediaBrowser.Common.Configuration; using MediaBrowser.Model.Plugins; using MediaBrowser.Model.Serialization; using System; using System.IO; namespace MediaBrowser.Common.Plugins { /// /// Provides a common base class for all plugins /// /// The type of the T configuration type. public abstract class BasePlugin : IPlugin, IPluginAssembly where TConfigurationType : BasePluginConfiguration { /// /// 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 name of the plugin /// /// The name. public abstract string Name { get; } /// /// Gets a value indicating whether this instance is first run. /// /// true if this instance is first run; otherwise, false. public bool IsFirstRun { get; private set; } /// /// Gets the description. /// /// The description. public virtual string Description { get { return string.Empty; } } /// /// Gets the type of configuration this plugin uses /// /// The type of the configuration. public Type ConfigurationType { get { return typeof(TConfigurationType); } } public void SetAttributes(string assemblyFilePath, string assemblyFileName, Version assemblyVersion, Guid assemblyId) { AssemblyFilePath = assemblyFilePath; AssemblyFileName = assemblyFileName; Version = assemblyVersion; Id = assemblyId; IsFirstRun = !File.Exists(ConfigurationFilePath); } /// /// Gets the unique id. /// /// The unique id. public Guid Id { get; private set; } /// /// Gets the plugin version /// /// The version. public Version Version { get; private set; } /// /// Gets the name the assembly file /// /// The name of the assembly file. protected string AssemblyFileName { get; private set; } /// /// Gets the last date modified of the configuration /// /// The configuration date last modified. public DateTime ConfigurationDateLastModified { get { // Ensure it's been lazy loaded var config = Configuration; return File.GetLastWriteTimeUtc(ConfigurationFilePath); } } /// /// Gets the path to the assembly file /// /// The assembly file path. public string AssemblyFilePath { get; private set; } /// /// The _configuration sync lock /// private readonly object _configurationSyncLock = new object(); /// /// The _configuration /// private TConfigurationType _configuration; /// /// Gets the plugin's 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; } } 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 { return (TConfigurationType)Activator.CreateInstance(typeof(TConfigurationType)); } } /// /// Gets the name of the configuration file. Subclasses should override /// /// The name of the configuration file. public virtual string ConfigurationFileName { get { return Path.ChangeExtension(AssemblyFileName, ".xml"); } } /// /// Gets the full path to the configuration file /// /// The configuration file path. public string ConfigurationFilePath { get { return Path.Combine(ApplicationPaths.PluginConfigurationsPath, ConfigurationFileName); } } /// /// The _data folder path /// private string _dataFolderPath; /// /// 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 { 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; } } /// /// Initializes a new instance of the class. /// /// The application paths. /// The XML serializer. protected BasePlugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer) { ApplicationPaths = applicationPaths; XmlSerializer = xmlSerializer; } /// /// The _save lock /// private readonly object _configurationSaveLock = new object(); /// /// Saves the current configuration to the file system /// public virtual void SaveConfiguration() { lock (_configurationSaveLock) { Directory.CreateDirectory(Path.GetDirectoryName(ConfigurationFilePath)); XmlSerializer.SerializeToFile(Configuration, ConfigurationFilePath); } } /// /// Completely overwrites the current configuration with a new copy /// Returns true or false indicating success or failure /// /// The configuration. /// configuration public virtual void UpdateConfiguration(BasePluginConfiguration configuration) { if (configuration == null) { throw new ArgumentNullException("configuration"); } Configuration = (TConfigurationType)configuration; SaveConfiguration(); } /// /// Gets the plugin info. /// /// PluginInfo. 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; } /// /// Called when just before the plugin is uninstalled from the server. /// public virtual void OnUninstalling() { } /// /// Gets the plugin's configuration /// /// The configuration. BasePluginConfiguration IPlugin.Configuration { get { return Configuration; } } } public interface IPluginAssembly { void SetAttributes(string assemblyFilePath, string assemblyFileName, Version assemblyVersion, Guid assemblyId); } }