< Summary - Jellyfin

Information
Class: MediaBrowser.Common.Plugins.BasePlugin<T>
Assembly: MediaBrowser.Common
File(s): /srv/git/jellyfin/MediaBrowser.Common/Plugins/BasePluginOfT.cs
Line coverage
73%
Covered lines: 38
Uncovered lines: 14
Coverable lines: 52
Total lines: 203
Line coverage: 73%
Branch coverage
56%
Covered branches: 9
Total branches: 16
Branch coverage: 56.2%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)37.5%9876.47%
get_ConfigurationType()100%210%
get_AssemblyFileName()100%11100%
get_Configuration()100%44100%
set_Configuration(...)100%210%
get_ConfigurationFileName()100%11100%
get_ConfigurationFilePath()100%11100%
MediaBrowser.Common.Plugins.IHasPluginConfiguration.get_Configuration()100%210%
SaveConfiguration(...)100%22100%
SaveConfiguration()100%210%
UpdateConfiguration(...)0%620%
GetPluginInfo()100%11100%
LoadConfiguration()100%11100%

File(s)

/srv/git/jellyfin/MediaBrowser.Common/Plugins/BasePluginOfT.cs

#LineLine coverage
 1#nullable disable
 2#pragma warning disable SA1649 // File name should match first type name
 3
 4using System;
 5using System.IO;
 6using System.Runtime.InteropServices;
 7using System.Threading;
 8using MediaBrowser.Common.Configuration;
 9using MediaBrowser.Model.Plugins;
 10using MediaBrowser.Model.Serialization;
 11
 12namespace MediaBrowser.Common.Plugins
 13{
 14    /// <summary>
 15    /// Provides a common base class for all plugins.
 16    /// </summary>
 17    /// <typeparam name="TConfigurationType">The type of the T configuration type.</typeparam>
 18    public abstract class BasePlugin<TConfigurationType> : BasePlugin, IHasPluginConfiguration
 19        where TConfigurationType : BasePluginConfiguration
 20    {
 21        /// <summary>
 22        /// The configuration sync lock.
 23        /// </summary>
 14724        private readonly Lock _configurationSyncLock = new();
 25
 26        /// <summary>
 27        /// The configuration save lock.
 28        /// </summary>
 14729        private readonly Lock _configurationSaveLock = new();
 30
 31        /// <summary>
 32        /// The configuration.
 33        /// </summary>
 34        private TConfigurationType _configuration;
 35
 36        /// <summary>
 37        /// Initializes a new instance of the <see cref="BasePlugin{TConfigurationType}" /> class.
 38        /// </summary>
 39        /// <param name="applicationPaths">The application paths.</param>
 40        /// <param name="xmlSerializer">The XML serializer.</param>
 14741        protected BasePlugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer)
 42        {
 14743            ApplicationPaths = applicationPaths;
 14744            XmlSerializer = xmlSerializer;
 45
 46            var assembly = GetType().Assembly;
 14747            var assemblyName = assembly.GetName();
 14748            var assemblyFilePath = assembly.Location;
 49
 14750            var dataFolderPath = Path.Combine(ApplicationPaths.PluginsPath, Path.GetFileNameWithoutExtension(assemblyFil
 14751            if (Version is not null && !Directory.Exists(dataFolderPath))
 52            {
 53                // Try again with the version number appended to the folder name.
 054                dataFolderPath += "_" + Version;
 55            }
 56
 14757            SetAttributes(assemblyFilePath, dataFolderPath, assemblyName.Version);
 58
 14759            var idAttributes = assembly.GetCustomAttributes(typeof(GuidAttribute), true);
 14760            if (idAttributes.Length > 0)
 61            {
 062                var attribute = (GuidAttribute)idAttributes[0];
 063                var assemblyId = new Guid(attribute.Value);
 64
 065                SetId(assemblyId);
 66            }
 14767        }
 68
 69        /// <summary>
 70        /// Gets the application paths.
 71        /// </summary>
 72        /// <value>The application paths.</value>
 73        protected IApplicationPaths ApplicationPaths { get; private set; }
 74
 75        /// <summary>
 76        /// Gets the XML serializer.
 77        /// </summary>
 78        /// <value>The XML serializer.</value>
 79        protected IXmlSerializer XmlSerializer { get; private set; }
 80
 81        /// <summary>
 82        /// Gets the type of configuration this plugin uses.
 83        /// </summary>
 84        /// <value>The type of the configuration.</value>
 085        public Type ConfigurationType => typeof(TConfigurationType);
 86
 87        /// <summary>
 88        /// Gets or sets the event handler that is triggered when this configuration changes.
 89        /// </summary>
 90        public EventHandler<BasePluginConfiguration> ConfigurationChanged { get; set; }
 91
 92        /// <summary>
 93        /// Gets the name the assembly file.
 94        /// </summary>
 95        /// <value>The name of the assembly file.</value>
 296        protected string AssemblyFileName => Path.GetFileName(AssemblyFilePath);
 97
 98        /// <summary>
 99        /// Gets or sets the plugin configuration.
 100        /// </summary>
 101        /// <value>The configuration.</value>
 102        public TConfigurationType Configuration
 103        {
 104            get
 105            {
 106                // Lazy load
 105107                if (_configuration is null)
 42108                {
 109                    lock (_configurationSyncLock)
 110                    {
 42111                        _configuration ??= LoadConfiguration();
 42112                    }
 113                }
 114
 105115                return _configuration;
 116            }
 117
 0118            protected set => _configuration = value;
 119        }
 120
 121        /// <summary>
 122        /// Gets the name of the configuration file. Subclasses should override.
 123        /// </summary>
 124        /// <value>The name of the configuration file.</value>
 2125        public virtual string ConfigurationFileName => Path.ChangeExtension(AssemblyFileName, ".xml");
 126
 127        /// <summary>
 128        /// Gets the full path to the configuration file.
 129        /// </summary>
 130        /// <value>The configuration file path.</value>
 126131        public string ConfigurationFilePath => Path.Combine(ApplicationPaths.PluginConfigurationsPath, ConfigurationFile
 132
 133        /// <summary>
 134        /// Gets the plugin configuration.
 135        /// </summary>
 136        /// <value>The configuration.</value>
 0137        BasePluginConfiguration IHasPluginConfiguration.Configuration => Configuration;
 138
 139        /// <summary>
 140        /// Saves the current configuration to the file system.
 141        /// </summary>
 142        /// <param name="config">Configuration to save.</param>
 143        public virtual void SaveConfiguration(TConfigurationType config)
 42144        {
 145            lock (_configurationSaveLock)
 146            {
 42147                var folder = Path.GetDirectoryName(ConfigurationFilePath);
 42148                if (!Directory.Exists(folder))
 149                {
 21150                    Directory.CreateDirectory(folder);
 151                }
 152
 42153                XmlSerializer.SerializeToFile(config, ConfigurationFilePath);
 42154            }
 42155        }
 156
 157        /// <summary>
 158        /// Saves the current configuration to the file system.
 159        /// </summary>
 160        public virtual void SaveConfiguration()
 161        {
 0162            SaveConfiguration(Configuration);
 0163        }
 164
 165        /// <inheritdoc />
 166        public virtual void UpdateConfiguration(BasePluginConfiguration configuration)
 167        {
 0168            ArgumentNullException.ThrowIfNull(configuration);
 169
 0170            Configuration = (TConfigurationType)configuration;
 171
 0172            SaveConfiguration(Configuration);
 173
 0174            ConfigurationChanged?.Invoke(this, configuration);
 0175        }
 176
 177        /// <inheritdoc />
 178        public override PluginInfo GetPluginInfo()
 179        {
 7180            var info = base.GetPluginInfo();
 181
 7182            info.ConfigurationFileName = ConfigurationFileName;
 183
 7184            return info;
 185        }
 186
 187        private TConfigurationType LoadConfiguration()
 188        {
 42189            var path = ConfigurationFilePath;
 190
 191            try
 192            {
 42193                return (TConfigurationType)XmlSerializer.DeserializeFromFile(typeof(TConfigurationType), path);
 194            }
 42195            catch
 196            {
 42197                var config = Activator.CreateInstance<TConfigurationType>();
 42198                SaveConfiguration(config);
 42199                return config;
 200            }
 42201        }
 202    }
 203}
Generated by: ReportGenerator 5.4.5.0
4/3/2025 - 12:11:21 AM
GitHub | reportgenerator.io

Methods/Properties

.ctor(MediaBrowser.Common.Configuration.IApplicationPaths,MediaBrowser.Model.Serialization.IXmlSerializer)
get_ConfigurationType()
get_AssemblyFileName()
get_Configuration()
set_Configuration(TConfigurationType)
get_ConfigurationFileName()
get_ConfigurationFilePath()
MediaBrowser.Common.Plugins.IHasPluginConfiguration.get_Configuration()
SaveConfiguration(TConfigurationType)
SaveConfiguration()
UpdateConfiguration(MediaBrowser.Model.Plugins.BasePluginConfiguration)
GetPluginInfo()
LoadConfiguration()