Merge branch 'jellyfin:master' into master

1 files changed, 30 insertions, 185 deletions

diff --git a/MediaBrowser.Common/Plugins/BasePlugin.cs b/MediaBrowser.Common/Plugins/BasePlugin.cs
index 1ff2e98ef..8972089a8 100644
--- a/MediaBrowser.Common/Plugins/BasePlugin.cs
+++ b/MediaBrowser.Common/Plugins/BasePlugin.cs
@@ -1,15 +1,19 @@
+#nullable disable
+
 using System;
 using System.IO;
-using MediaBrowser.Common.Configuration;
+using System.Reflection;
 using MediaBrowser.Model.Plugins;
-using MediaBrowser.Model.Serialization;
 
 namespace MediaBrowser.Common.Plugins
 {
+    /// <summary>
+    /// Provides a common base class for all plugins.
+    /// </summary>
     public abstract class BasePlugin : IPlugin, IPluginAssembly
     {
         /// <summary>
-        /// Gets the name of the plugin
+        /// Gets the name of the plugin.
         /// </summary>
         /// <value>The name.</value>
         public abstract string Name { get; }
@@ -27,42 +31,53 @@ namespace MediaBrowser.Common.Plugins
         public virtual Guid Id { get; private set; }
 
         /// <summary>
-        /// Gets the plugin version
+        /// Gets the plugin version.
         /// </summary>
         /// <value>The version.</value>
         public Version Version { get; private set; }
 
         /// <summary>
-        /// Gets the path to the assembly file
+        /// Gets the path to the assembly file.
         /// </summary>
         /// <value>The assembly file path.</value>
         public string AssemblyFilePath { get; private set; }
 
         /// <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; }
+
+        /// <summary>
+        /// Gets a value indicating whether the plugin can be uninstalled.
+        /// </summary>
+        public bool CanUninstall => !Path.GetDirectoryName(AssemblyFilePath)
+            .Equals(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), StringComparison.Ordinal);
+
+        /// <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()
-            };
+            var info = new PluginInfo(
+                Name,
+                Version,
+                Description,
+                Id,
+                CanUninstall);
 
             return info;
         }
 
         /// <summary>
-        /// Called when just before the plugin is uninstalled from the server.
+        /// Called just before the plugin is uninstalled from the server.
         /// </summary>
         public virtual void OnUninstalling()
         {
-
         }
 
+        /// <inheritdoc />
         public void SetAttributes(string assemblyFilePath, string dataFolderPath, Version assemblyVersion)
         {
             AssemblyFilePath = assemblyFilePath;
@@ -70,180 +85,10 @@ namespace MediaBrowser.Common.Plugins
             Version = assemblyVersion;
         }
 
+        /// <inheritdoc />
         public void SetId(Guid assemblyId)
         {
             Id = assemblyId;
         }
-
-        /// <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; }
-    }
-
-    /// <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> : BasePlugin, IHasPluginConfiguration
-        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 type of configuration this plugin uses
-        /// </summary>
-        /// <value>The type of the configuration.</value>
-        public Type ConfigurationType => typeof(TConfigurationType);
-
-        private Action<string> _directoryCreateFn;
-        public void SetStartupInfo(Action<string> directoryCreateFn)
-        {
-            // hack alert, until the .net core transition is complete
-            _directoryCreateFn = directoryCreateFn;
-        }
-
-        /// <summary>
-        /// Gets the name the assembly file
-        /// </summary>
-        /// <value>The name of the assembly file.</value>
-        protected string AssemblyFileName => Path.GetFileName(AssemblyFilePath);
-
-        /// <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
-            {
-                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 => Path.ChangeExtension(AssemblyFileName, ".xml");
-
-        /// <summary>
-        /// Gets the full path to the configuration file
-        /// </summary>
-        /// <value>The configuration file path.</value>
-        public string ConfigurationFilePath => Path.Combine(ApplicationPaths.PluginConfigurationsPath, ConfigurationFileName);
-
-        /// <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;
-        }
-
-        /// <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)
-            {
-                _directoryCreateFn(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="ArgumentNullException">configuration</exception>
-        public virtual void UpdateConfiguration(BasePluginConfiguration configuration)
-        {
-            if (configuration == null)
-            {
-                throw new ArgumentNullException(nameof(configuration));
-            }
-
-            Configuration = (TConfigurationType)configuration;
-
-            SaveConfiguration();
-        }
-
-        /// <summary>
-        /// Gets the plugin's configuration
-        /// </summary>
-        /// <value>The configuration.</value>
-        BasePluginConfiguration IHasPluginConfiguration.Configuration => Configuration;
-
-        public override PluginInfo GetPluginInfo()
-        {
-            var info = base.GetPluginInfo();
-
-            info.ConfigurationFileName = ConfigurationFileName;
-
-            return info;
-        }
-    }
-
-    public interface IPluginAssembly
-    {
-        void SetAttributes(string assemblyFilePath, string dataFolderPath, Version assemblyVersion);
-        void SetId(Guid assemblyId);
     }
 }