< Summary - Jellyfin

Information
Class: Emby.Server.Implementations.ApplicationHost
Assembly: Emby.Server.Implementations
File(s): /srv/git/jellyfin/Emby.Server.Implementations/ApplicationHost.cs
Line coverage
71%
Covered lines: 218
Uncovered lines: 87
Coverable lines: 305
Total lines: 1016
Line coverage: 71.4%
Branch coverage
39%
Covered branches: 41
Total branches: 104
Branch coverage: 39.4%
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(...)100%11100%
get_PublishedServerUrl()100%210%
get_ApplicationUserAgentAddress()100%11100%
get_SystemId()100%11100%
get_Name()100%11100%
get_ListenWithHttps()0%620%
get_FriendlyName()0%620%
ExpandVirtualPath(...)50%2280%
ReverseVirtualPath(...)100%11100%
CreateInstanceSafe(...)62.5%15852.63%
Resolve()100%11100%
GetExports(...)100%66100%
GetExports(...)83.33%6688.88%
RunStartupTasksAsync()50%2290.9%
Init(...)50%4481.25%
RegisterServices(...)100%11100%
GetCertificate(...)12.5%48814.28%
SetStaticProperties()100%11100%
FindParts()100%22100%
DiscoverTypes()100%11100%
OnConfigurationUpdated(...)64.28%341453.33%
ValidateSslCertificate(...)33.33%15636.36%
NotifyPendingRestart()0%620%
GetSmartApiUrl(...)0%620%
GetSmartApiUrl(...)0%210140%
GetSmartApiUrl(...)0%620%
GetApiUrlForLocalAccess(...)0%2040%
GetLocalApiUrl(...)0%110100%
Dispose()100%11100%
Dispose(...)87.5%9876.47%

File(s)

/srv/git/jellyfin/Emby.Server.Implementations/ApplicationHost.cs

#LineLine coverage
 1#nullable disable
 2
 3#pragma warning disable CS1591
 4
 5using System;
 6using System.Collections.Concurrent;
 7using System.Collections.Generic;
 8using System.Diagnostics;
 9using System.Globalization;
 10using System.IO;
 11using System.Linq;
 12using System.Net;
 13using System.Reflection;
 14using System.Security.Cryptography.X509Certificates;
 15using System.Threading.Tasks;
 16using Emby.Naming.Common;
 17using Emby.Photos;
 18using Emby.Server.Implementations.Collections;
 19using Emby.Server.Implementations.Configuration;
 20using Emby.Server.Implementations.Cryptography;
 21using Emby.Server.Implementations.Data;
 22using Emby.Server.Implementations.Devices;
 23using Emby.Server.Implementations.Dto;
 24using Emby.Server.Implementations.HttpServer.Security;
 25using Emby.Server.Implementations.IO;
 26using Emby.Server.Implementations.Library;
 27using Emby.Server.Implementations.Localization;
 28using Emby.Server.Implementations.Playlists;
 29using Emby.Server.Implementations.Plugins;
 30using Emby.Server.Implementations.QuickConnect;
 31using Emby.Server.Implementations.ScheduledTasks;
 32using Emby.Server.Implementations.Serialization;
 33using Emby.Server.Implementations.Session;
 34using Emby.Server.Implementations.SyncPlay;
 35using Emby.Server.Implementations.TV;
 36using Emby.Server.Implementations.Updates;
 37using Jellyfin.Api.Helpers;
 38using Jellyfin.Database.Implementations;
 39using Jellyfin.Drawing;
 40using Jellyfin.MediaEncoding.Hls.Playlist;
 41using Jellyfin.Networking.Manager;
 42using Jellyfin.Networking.Udp;
 43using Jellyfin.Server.Implementations.Item;
 44using Jellyfin.Server.Implementations.MediaSegments;
 45using MediaBrowser.Common;
 46using MediaBrowser.Common.Configuration;
 47using MediaBrowser.Common.Events;
 48using MediaBrowser.Common.Net;
 49using MediaBrowser.Common.Plugins;
 50using MediaBrowser.Common.Updates;
 51using MediaBrowser.Controller;
 52using MediaBrowser.Controller.Channels;
 53using MediaBrowser.Controller.Chapters;
 54using MediaBrowser.Controller.ClientEvent;
 55using MediaBrowser.Controller.Collections;
 56using MediaBrowser.Controller.Configuration;
 57using MediaBrowser.Controller.Drawing;
 58using MediaBrowser.Controller.Dto;
 59using MediaBrowser.Controller.Entities;
 60using MediaBrowser.Controller.IO;
 61using MediaBrowser.Controller.Library;
 62using MediaBrowser.Controller.LiveTv;
 63using MediaBrowser.Controller.Lyrics;
 64using MediaBrowser.Controller.MediaEncoding;
 65using MediaBrowser.Controller.Net;
 66using MediaBrowser.Controller.Persistence;
 67using MediaBrowser.Controller.Playlists;
 68using MediaBrowser.Controller.Providers;
 69using MediaBrowser.Controller.QuickConnect;
 70using MediaBrowser.Controller.Resolvers;
 71using MediaBrowser.Controller.Session;
 72using MediaBrowser.Controller.Sorting;
 73using MediaBrowser.Controller.Subtitles;
 74using MediaBrowser.Controller.SyncPlay;
 75using MediaBrowser.Controller.TV;
 76using MediaBrowser.LocalMetadata.Savers;
 77using MediaBrowser.MediaEncoding.BdInfo;
 78using MediaBrowser.MediaEncoding.Subtitles;
 79using MediaBrowser.MediaEncoding.Transcoding;
 80using MediaBrowser.Model.Cryptography;
 81using MediaBrowser.Model.Globalization;
 82using MediaBrowser.Model.IO;
 83using MediaBrowser.Model.MediaInfo;
 84using MediaBrowser.Model.Net;
 85using MediaBrowser.Model.Serialization;
 86using MediaBrowser.Model.System;
 87using MediaBrowser.Model.Tasks;
 88using MediaBrowser.Providers.Lyric;
 89using MediaBrowser.Providers.Manager;
 90using MediaBrowser.Providers.Plugins.Tmdb;
 91using MediaBrowser.Providers.Subtitles;
 92using MediaBrowser.XbmcMetadata.Providers;
 93using Microsoft.AspNetCore.Http;
 94using Microsoft.AspNetCore.Mvc;
 95using Microsoft.EntityFrameworkCore;
 96using Microsoft.Extensions.Configuration;
 97using Microsoft.Extensions.DependencyInjection;
 98using Microsoft.Extensions.Logging;
 99using Prometheus.DotNetRuntime;
 100using static MediaBrowser.Controller.Extensions.ConfigurationExtensions;
 101using IConfigurationManager = MediaBrowser.Common.Configuration.IConfigurationManager;
 102using WebSocketManager = Emby.Server.Implementations.HttpServer.WebSocketManager;
 103
 104namespace Emby.Server.Implementations
 105{
 106    /// <summary>
 107    /// Class CompositionRoot.
 108    /// </summary>
 109    public abstract class ApplicationHost : IServerApplicationHost, IDisposable
 110    {
 111        /// <summary>
 112        /// The disposable parts.
 113        /// </summary>
 21114        private readonly ConcurrentBag<IDisposable> _disposableParts = new();
 115        private readonly DeviceId _deviceId;
 116
 117        private readonly IConfiguration _startupConfig;
 118        private readonly IXmlSerializer _xmlSerializer;
 119        private readonly IStartupOptions _startupOptions;
 120        private readonly PluginManager _pluginManager;
 121
 122        private List<Type> _creatingInstances;
 123
 124        /// <summary>
 125        /// Gets or sets all concrete types.
 126        /// </summary>
 127        /// <value>All concrete types.</value>
 128        private Type[] _allConcreteTypes;
 129
 130        private bool _disposed;
 131
 132        /// <summary>
 133        /// Initializes a new instance of the <see cref="ApplicationHost"/> class.
 134        /// </summary>
 135        /// <param name="applicationPaths">Instance of the <see cref="IServerApplicationPaths"/> interface.</param>
 136        /// <param name="loggerFactory">Instance of the <see cref="ILoggerFactory"/> interface.</param>
 137        /// <param name="options">Instance of the <see cref="IStartupOptions"/> interface.</param>
 138        /// <param name="startupConfig">The <see cref="IConfiguration" /> interface.</param>
 139        protected ApplicationHost(
 140            IServerApplicationPaths applicationPaths,
 141            ILoggerFactory loggerFactory,
 142            IStartupOptions options,
 143            IConfiguration startupConfig)
 144        {
 145            ApplicationPaths = applicationPaths;
 146            LoggerFactory = loggerFactory;
 21147            _startupOptions = options;
 21148            _startupConfig = startupConfig;
 149
 21150            Logger = LoggerFactory.CreateLogger<ApplicationHost>();
 21151            _deviceId = new DeviceId(ApplicationPaths, LoggerFactory.CreateLogger<DeviceId>());
 152
 21153            ApplicationVersion = typeof(ApplicationHost).Assembly.GetName().Version;
 21154            ApplicationVersionString = ApplicationVersion.ToString(3);
 21155            ApplicationUserAgent = Name.Replace(' ', '-') + "/" + ApplicationVersionString;
 156
 21157            _xmlSerializer = new MyXmlSerializer();
 21158            ConfigurationManager = new ServerConfigurationManager(ApplicationPaths, LoggerFactory, _xmlSerializer);
 21159            _pluginManager = new PluginManager(
 21160                LoggerFactory.CreateLogger<PluginManager>(),
 21161                this,
 21162                ConfigurationManager.Configuration,
 21163                ApplicationPaths.PluginsPath,
 21164                ApplicationVersion);
 165
 21166            _disposableParts.Add(_pluginManager);
 21167        }
 168
 169        /// <summary>
 170        /// Occurs when [has pending restart changed].
 171        /// </summary>
 172        public event EventHandler HasPendingRestartChanged;
 173
 174        /// <summary>
 175        /// Gets the value of the PublishedServerUrl setting.
 176        /// </summary>
 0177        private string PublishedServerUrl => _startupConfig[AddressOverrideKey];
 178
 179        public bool CoreStartupHasCompleted { get; private set; }
 180
 181        /// <summary>
 182        /// Gets the <see cref="INetworkManager"/> singleton instance.
 183        /// </summary>
 184        public INetworkManager NetManager { get; private set; }
 185
 186        /// <inheritdoc />
 187        public bool HasPendingRestart { get; private set; }
 188
 189        /// <inheritdoc />
 190        public bool ShouldRestart { get; set; }
 191
 192        /// <summary>
 193        /// Gets the logger.
 194        /// </summary>
 195        protected ILogger<ApplicationHost> Logger { get; }
 196
 197        /// <summary>
 198        /// Gets the logger factory.
 199        /// </summary>
 200        protected ILoggerFactory LoggerFactory { get; }
 201
 202        /// <summary>
 203        /// Gets the application paths.
 204        /// </summary>
 205        /// <value>The application paths.</value>
 206        protected IServerApplicationPaths ApplicationPaths { get; }
 207
 208        /// <summary>
 209        /// Gets the configuration manager.
 210        /// </summary>
 211        /// <value>The configuration manager.</value>
 212        public ServerConfigurationManager ConfigurationManager { get; }
 213
 214        /// <summary>
 215        /// Gets or sets the service provider.
 216        /// </summary>
 217        public IServiceProvider ServiceProvider { get; set; }
 218
 219        /// <summary>
 220        /// Gets the http port for the webhost.
 221        /// </summary>
 222        public int HttpPort { get; private set; }
 223
 224        /// <summary>
 225        /// Gets the https port for the webhost.
 226        /// </summary>
 227        public int HttpsPort { get; private set; }
 228
 229        /// <inheritdoc />
 230        public Version ApplicationVersion { get; }
 231
 232        /// <inheritdoc />
 233        public string ApplicationVersionString { get; }
 234
 235        /// <summary>
 236        /// Gets the current application user agent.
 237        /// </summary>
 238        /// <value>The application user agent.</value>
 239        public string ApplicationUserAgent { get; }
 240
 241        /// <summary>
 242        /// Gets the email address for use within a comment section of a user agent field.
 243        /// Presently used to provide contact information to MusicBrainz service.
 244        /// </summary>
 21245        public string ApplicationUserAgentAddress => "team@jellyfin.org";
 246
 247        /// <summary>
 248        /// Gets the current application name.
 249        /// </summary>
 250        /// <value>The application name.</value>
 21251        public string ApplicationProductName { get; } = FileVersionInfo.GetVersionInfo(Assembly.GetEntryAssembly().Locat
 252
 98253        public string SystemId => _deviceId.Value;
 254
 255        /// <inheritdoc/>
 63256        public string Name => ApplicationProductName;
 257
 258        private string CertificatePath { get; set; }
 259
 260        public X509Certificate2 Certificate { get; private set; }
 261
 262        /// <inheritdoc/>
 0263        public bool ListenWithHttps => Certificate is not null && ConfigurationManager.GetNetworkConfiguration().EnableH
 264
 265        public string FriendlyName =>
 0266            string.IsNullOrEmpty(ConfigurationManager.Configuration.ServerName)
 0267                ? Environment.MachineName
 0268                : ConfigurationManager.Configuration.ServerName;
 269
 270        public string ExpandVirtualPath(string path)
 271        {
 91272            if (path is null)
 273            {
 0274                return null;
 275            }
 276
 91277            var appPaths = ApplicationPaths;
 278
 91279            return path.Replace(appPaths.VirtualDataPath, appPaths.DataPath, StringComparison.OrdinalIgnoreCase)
 91280                .Replace(appPaths.VirtualInternalMetadataPath, appPaths.InternalMetadataPath, StringComparison.OrdinalIg
 281        }
 282
 283        public string ReverseVirtualPath(string path)
 284        {
 80285            var appPaths = ApplicationPaths;
 286
 80287            return path.Replace(appPaths.DataPath, appPaths.VirtualDataPath, StringComparison.OrdinalIgnoreCase)
 80288                .Replace(appPaths.InternalMetadataPath, appPaths.VirtualInternalMetadataPath, StringComparison.OrdinalIg
 289        }
 290
 291        /// <summary>
 292        /// Creates the instance safe.
 293        /// </summary>
 294        /// <param name="type">The type.</param>
 295        /// <returns>System.Object.</returns>
 296        protected object CreateInstanceSafe(Type type)
 297        {
 4116298            _creatingInstances ??= new List<Type>();
 299
 4116300            if (_creatingInstances.Contains(type))
 301            {
 0302                Logger.LogError("DI Loop detected in the attempted creation of {Type}", type.FullName);
 0303                foreach (var entry in _creatingInstances)
 304                {
 0305                    Logger.LogError("Called from: {TypeName}", entry.FullName);
 306                }
 307
 0308                _pluginManager.FailPlugin(type.Assembly);
 309
 0310                throw new TypeLoadException("DI Loop detected");
 311            }
 312
 313            try
 314            {
 4116315                _creatingInstances.Add(type);
 4116316                Logger.LogDebug("Creating instance of {Type}", type);
 4116317                return ServiceProvider is null
 4116318                    ? Activator.CreateInstance(type)
 4116319                    : ActivatorUtilities.CreateInstance(ServiceProvider, type);
 320            }
 0321            catch (Exception ex)
 322            {
 0323                Logger.LogError(ex, "Error creating {Type}", type);
 324                // If this is a plugin fail it.
 0325                _pluginManager.FailPlugin(type.Assembly);
 0326                return null;
 327            }
 328            finally
 329            {
 4116330                _creatingInstances.Remove(type);
 4116331            }
 4116332        }
 333
 334        /// <summary>
 335        /// Resolves this instance.
 336        /// </summary>
 337        /// <typeparam name="T">The type.</typeparam>
 338        /// <returns>``0.</returns>
 483339        public T Resolve<T>() => ServiceProvider.GetService<T>();
 340
 341        /// <inheritdoc/>
 342        public IEnumerable<Type> GetExportTypes<T>()
 343        {
 344            var currentType = typeof(T);
 345            var numberOfConcreteTypes = _allConcreteTypes.Length;
 346            for (var i = 0; i < numberOfConcreteTypes; i++)
 347            {
 348                var type = _allConcreteTypes[i];
 349                if (currentType.IsAssignableFrom(type))
 350                {
 351                    yield return type;
 352                }
 353            }
 354        }
 355
 356        /// <inheritdoc />
 357        public IReadOnlyCollection<T> GetExports<T>(bool manageLifetime = true)
 358        {
 359            // Convert to list so this isn't executed for each iteration
 294360            var parts = GetExportTypes<T>()
 294361                .Select(CreateInstanceSafe)
 294362                .Where(i => i is not null)
 294363                .Cast<T>()
 294364                .ToList();
 365
 294366            if (manageLifetime)
 367            {
 630368                foreach (var part in parts.OfType<IDisposable>())
 369                {
 42370                    _disposableParts.Add(part);
 371                }
 372            }
 373
 294374            return parts;
 375        }
 376
 377        /// <inheritdoc />
 378        public IReadOnlyCollection<T> GetExports<T>(CreationDelegateFactory defaultFunc, bool manageLifetime = true)
 379        {
 380            // Convert to list so this isn't executed for each iteration
 21381            var parts = GetExportTypes<T>()
 21382                .Select(i => defaultFunc(i))
 21383                .Where(i => i is not null)
 21384                .Cast<T>()
 21385                .ToList();
 386
 21387            if (manageLifetime)
 388            {
 42389                foreach (var part in parts.OfType<IDisposable>())
 390                {
 0391                    _disposableParts.Add(part);
 392                }
 393            }
 394
 21395            return parts;
 396        }
 397
 398        /// <summary>
 399        /// Runs the startup tasks.
 400        /// </summary>
 401        /// <returns><see cref="Task" />.</returns>
 402        public Task RunStartupTasksAsync()
 403        {
 21404            Logger.LogInformation("Running startup tasks");
 405
 21406            Resolve<ITaskManager>().AddTasks(GetExports<IScheduledTask>(false));
 407
 21408            ConfigurationManager.ConfigurationUpdated += OnConfigurationUpdated;
 21409            ConfigurationManager.NamedConfigurationUpdated += OnConfigurationUpdated;
 410
 21411            var ffmpegValid = Resolve<IMediaEncoder>().SetFFmpegPath();
 412
 21413            if (!ffmpegValid)
 414            {
 0415                throw new FfmpegException("Failed to find valid ffmpeg");
 416            }
 417
 21418            Logger.LogInformation("ServerId: {ServerId}", SystemId);
 21419            Logger.LogInformation("Core startup complete");
 21420            CoreStartupHasCompleted = true;
 421
 21422            return Task.CompletedTask;
 423        }
 424
 425        /// <inheritdoc/>
 426        public void Init(IServiceCollection serviceCollection)
 427        {
 21428            DiscoverTypes();
 429
 21430            ConfigurationManager.AddParts(GetExports<IConfigurationFactory>());
 431
 21432            NetManager = new NetworkManager(ConfigurationManager, _startupConfig, LoggerFactory.CreateLogger<NetworkMana
 433
 434            // Initialize runtime stat collection
 21435            if (ConfigurationManager.Configuration.EnableMetrics)
 436            {
 0437                _disposableParts.Add(DotNetRuntimeStatsBuilder.Default().StartCollecting());
 438            }
 439
 21440            var networkConfiguration = ConfigurationManager.GetNetworkConfiguration();
 21441            HttpPort = networkConfiguration.InternalHttpPort;
 21442            HttpsPort = networkConfiguration.InternalHttpsPort;
 443
 444            // Safeguard against invalid configuration
 21445            if (HttpPort == HttpsPort)
 446            {
 0447                HttpPort = NetworkConfiguration.DefaultHttpPort;
 0448                HttpsPort = NetworkConfiguration.DefaultHttpsPort;
 449            }
 450
 21451            CertificatePath = networkConfiguration.CertificatePath;
 21452            Certificate = GetCertificate(CertificatePath, networkConfiguration.CertificatePassword);
 453
 21454            RegisterServices(serviceCollection);
 455
 21456            _pluginManager.RegisterServices(serviceCollection);
 21457        }
 458
 459        /// <summary>
 460        /// Registers services/resources with the service collection that will be available via DI.
 461        /// </summary>
 462        /// <param name="serviceCollection">Instance of the <see cref="IServiceCollection"/> interface.</param>
 463        protected virtual void RegisterServices(IServiceCollection serviceCollection)
 464        {
 21465            serviceCollection.AddSingleton(_startupOptions);
 466
 21467            serviceCollection.AddMemoryCache();
 468
 21469            serviceCollection.AddSingleton<IServerConfigurationManager>(ConfigurationManager);
 21470            serviceCollection.AddSingleton<IConfigurationManager>(ConfigurationManager);
 21471            serviceCollection.AddSingleton<IApplicationHost>(this);
 21472            serviceCollection.AddSingleton<IPluginManager>(_pluginManager);
 21473            serviceCollection.AddSingleton<IApplicationPaths>(ApplicationPaths);
 474
 21475            serviceCollection.AddSingleton<IFileSystem, ManagedFileSystem>();
 21476            serviceCollection.AddSingleton<IShortcutHandler, MbLinkShortcutHandler>();
 477
 21478            serviceCollection.AddScoped<ISystemManager, SystemManager>();
 479
 21480            serviceCollection.AddSingleton<TmdbClientManager>();
 481
 21482            serviceCollection.AddSingleton(NetManager);
 483
 21484            serviceCollection.AddSingleton<ITaskManager, TaskManager>();
 485
 21486            serviceCollection.AddSingleton(_xmlSerializer);
 487
 21488            serviceCollection.AddSingleton<ICryptoProvider, CryptographyProvider>();
 489
 21490            serviceCollection.AddSingleton<ISocketFactory, SocketFactory>();
 491
 21492            serviceCollection.AddSingleton<IInstallationManager, InstallationManager>();
 493
 21494            serviceCollection.AddSingleton<IServerApplicationHost>(this);
 21495            serviceCollection.AddSingleton(ApplicationPaths);
 496
 21497            serviceCollection.AddSingleton<ILocalizationManager, LocalizationManager>();
 498
 21499            serviceCollection.AddSingleton<IBlurayExaminer, BdInfoExaminer>();
 500
 21501            serviceCollection.AddSingleton<IUserDataManager, UserDataManager>();
 502
 21503            serviceCollection.AddSingleton<IItemRepository, BaseItemRepository>();
 21504            serviceCollection.AddSingleton<IPeopleRepository, PeopleRepository>();
 21505            serviceCollection.AddSingleton<IChapterRepository, ChapterRepository>();
 21506            serviceCollection.AddSingleton<IMediaAttachmentRepository, MediaAttachmentRepository>();
 21507            serviceCollection.AddSingleton<IMediaStreamRepository, MediaStreamRepository>();
 21508            serviceCollection.AddSingleton<IItemTypeLookup, ItemTypeLookup>();
 509
 21510            serviceCollection.AddSingleton<IMediaEncoder, MediaBrowser.MediaEncoding.Encoder.MediaEncoder>();
 21511            serviceCollection.AddSingleton<EncodingHelper>();
 21512            serviceCollection.AddSingleton<IPathManager, PathManager>();
 513
 514            // TODO: Refactor to eliminate the circular dependencies here so that Lazy<T> isn't required
 21515            serviceCollection.AddTransient(provider => new Lazy<ILibraryMonitor>(provider.GetRequiredService<ILibraryMon
 21516            serviceCollection.AddTransient(provider => new Lazy<IProviderManager>(provider.GetRequiredService<IProviderM
 21517            serviceCollection.AddTransient(provider => new Lazy<IUserViewManager>(provider.GetRequiredService<IUserViewM
 21518            serviceCollection.AddSingleton<ILibraryManager, LibraryManager>();
 21519            serviceCollection.AddSingleton<NamingOptions>();
 520
 21521            serviceCollection.AddSingleton<IMusicManager, MusicManager>();
 522
 21523            serviceCollection.AddSingleton<ILibraryMonitor, LibraryMonitor>();
 524
 21525            serviceCollection.AddSingleton<ISearchEngine, SearchEngine>();
 526
 21527            serviceCollection.AddSingleton<IWebSocketManager, WebSocketManager>();
 528
 21529            serviceCollection.AddSingleton<IImageProcessor, ImageProcessor>();
 530
 21531            serviceCollection.AddSingleton<ITVSeriesManager, TVSeriesManager>();
 532
 21533            serviceCollection.AddSingleton<IMediaSourceManager, MediaSourceManager>();
 534
 21535            serviceCollection.AddSingleton<ISubtitleManager, SubtitleManager>();
 21536            serviceCollection.AddSingleton<ILyricManager, LyricManager>();
 537
 21538            serviceCollection.AddSingleton<IProviderManager, ProviderManager>();
 539
 540            // TODO: Refactor to eliminate the circular dependency here so that Lazy<T> isn't required
 21541            serviceCollection.AddTransient(provider => new Lazy<ILiveTvManager>(provider.GetRequiredService<ILiveTvManag
 21542            serviceCollection.AddSingleton<IDtoService, DtoService>();
 543
 21544            serviceCollection.AddSingleton<ISessionManager, SessionManager>();
 545
 21546            serviceCollection.AddSingleton<ICollectionManager, CollectionManager>();
 547
 21548            serviceCollection.AddSingleton<IPlaylistManager, PlaylistManager>();
 549
 21550            serviceCollection.AddSingleton<ISyncPlayManager, SyncPlayManager>();
 551
 21552            serviceCollection.AddSingleton<IUserViewManager, UserViewManager>();
 553
 21554            serviceCollection.AddSingleton<IEncodingManager, MediaEncoder.EncodingManager>();
 555
 21556            serviceCollection.AddSingleton<IAuthService, AuthService>();
 21557            serviceCollection.AddSingleton<IQuickConnect, QuickConnectManager>();
 558
 21559            serviceCollection.AddSingleton<ISubtitleParser, SubtitleEditParser>();
 21560            serviceCollection.AddSingleton<ISubtitleEncoder, SubtitleEncoder>();
 561
 21562            serviceCollection.AddSingleton<IAttachmentExtractor, MediaBrowser.MediaEncoding.Attachments.AttachmentExtrac
 563
 21564            serviceCollection.AddSingleton<ITranscodeManager, TranscodeManager>();
 21565            serviceCollection.AddScoped<MediaInfoHelper>();
 21566            serviceCollection.AddScoped<AudioHelper>();
 21567            serviceCollection.AddScoped<DynamicHlsHelper>();
 21568            serviceCollection.AddScoped<IClientEventLogger, ClientEventLogger>();
 21569            serviceCollection.AddSingleton<IDirectoryService, DirectoryService>();
 570
 21571            serviceCollection.AddSingleton<IMediaSegmentManager, MediaSegmentManager>();
 21572        }
 573
 574        /// <summary>
 575        /// Create services registered with the service container that need to be initialized at application startup.
 576        /// </summary>
 577        /// <param name="startupConfig">The configuration used to initialise the application.</param>
 578        /// <returns>A task representing the service initialization operation.</returns>
 579        public async Task InitializeServices(IConfiguration startupConfig)
 580        {
 581            var factory = Resolve<IDbContextFactory<JellyfinDbContext>>();
 582            var provider = Resolve<IJellyfinDatabaseProvider>();
 583            provider.DbContextFactory = factory;
 584
 585            var jellyfinDb = await factory.CreateDbContextAsync().ConfigureAwait(false);
 586            await using (jellyfinDb.ConfigureAwait(false))
 587            {
 588                if ((await jellyfinDb.Database.GetPendingMigrationsAsync().ConfigureAwait(false)).Any())
 589                {
 590                    Logger.LogInformation("There are pending EFCore migrations in the database. Applying... (This may ta
 591                    await jellyfinDb.Database.MigrateAsync().ConfigureAwait(false);
 592                    Logger.LogInformation("EFCore migrations applied successfully");
 593                }
 594            }
 595
 596            var localizationManager = (LocalizationManager)Resolve<ILocalizationManager>();
 597            await localizationManager.LoadAll().ConfigureAwait(false);
 598
 599            SetStaticProperties();
 600
 601            FindParts();
 602        }
 603
 604        private X509Certificate2 GetCertificate(string path, string password)
 605        {
 21606            if (string.IsNullOrWhiteSpace(path))
 607            {
 21608                return null;
 609            }
 610
 611            try
 612            {
 0613                if (!File.Exists(path))
 614                {
 0615                    return null;
 616                }
 617
 618                // Don't use an empty string password
 0619                password = string.IsNullOrWhiteSpace(password) ? null : password;
 620
 0621                var localCert = X509CertificateLoader.LoadPkcs12FromFile(path, password, X509KeyStorageFlags.UserKeySet)
 0622                if (!localCert.HasPrivateKey)
 623                {
 0624                    Logger.LogError("No private key included in SSL cert {CertificateLocation}.", path);
 0625                    return null;
 626                }
 627
 0628                return localCert;
 629            }
 0630            catch (Exception ex)
 631            {
 0632                Logger.LogError(ex, "Error loading cert from {CertificateLocation}", path);
 0633                return null;
 634            }
 0635        }
 636
 637        /// <summary>
 638        /// Dirty hacks.
 639        /// </summary>
 640        private void SetStaticProperties()
 641        {
 642            // For now there's no real way to inject these properly
 21643            BaseItem.Logger = Resolve<ILogger<BaseItem>>();
 21644            BaseItem.ConfigurationManager = ConfigurationManager;
 21645            BaseItem.LibraryManager = Resolve<ILibraryManager>();
 21646            BaseItem.ProviderManager = Resolve<IProviderManager>();
 21647            BaseItem.LocalizationManager = Resolve<ILocalizationManager>();
 21648            BaseItem.ItemRepository = Resolve<IItemRepository>();
 21649            BaseItem.ChapterRepository = Resolve<IChapterRepository>();
 21650            BaseItem.FileSystem = Resolve<IFileSystem>();
 21651            BaseItem.UserDataManager = Resolve<IUserDataManager>();
 21652            BaseItem.ChannelManager = Resolve<IChannelManager>();
 21653            Video.RecordingsManager = Resolve<IRecordingsManager>();
 21654            Folder.UserViewManager = Resolve<IUserViewManager>();
 21655            UserView.TVSeriesManager = Resolve<ITVSeriesManager>();
 21656            UserView.CollectionManager = Resolve<ICollectionManager>();
 21657            BaseItem.MediaSourceManager = Resolve<IMediaSourceManager>();
 21658            BaseItem.MediaSegmentManager = Resolve<IMediaSegmentManager>();
 21659            CollectionFolder.XmlSerializer = _xmlSerializer;
 21660            CollectionFolder.ApplicationHost = this;
 21661        }
 662
 663        /// <summary>
 664        /// Finds plugin components and register them with the appropriate services.
 665        /// </summary>
 666        private void FindParts()
 667        {
 21668            if (!ConfigurationManager.Configuration.IsPortAuthorized)
 669            {
 21670                ConfigurationManager.Configuration.IsPortAuthorized = true;
 21671                ConfigurationManager.SaveConfiguration();
 672            }
 673
 21674            _pluginManager.CreatePlugins();
 675
 21676            Resolve<ILibraryManager>().AddParts(
 21677                GetExports<IResolverIgnoreRule>(),
 21678                GetExports<IItemResolver>(),
 21679                GetExports<IIntroProvider>(),
 21680                GetExports<IBaseItemComparer>(),
 21681                GetExports<ILibraryPostScanTask>());
 682
 21683            Resolve<IProviderManager>().AddParts(
 21684                GetExports<IImageProvider>(),
 21685                GetExports<IMetadataService>(),
 21686                GetExports<IMetadataProvider>(),
 21687                GetExports<IMetadataSaver>(),
 21688                GetExports<IExternalId>(),
 21689                GetExports<IExternalUrlProvider>());
 690
 21691            Resolve<IMediaSourceManager>().AddParts(GetExports<IMediaSourceProvider>());
 21692        }
 693
 694        /// <summary>
 695        /// Discovers the types.
 696        /// </summary>
 697        protected void DiscoverTypes()
 698        {
 21699            Logger.LogInformation("Loading assemblies");
 700
 21701            _allConcreteTypes = GetTypes(GetComposablePartAssemblies()).ToArray();
 21702        }
 703
 704        private IEnumerable<Type> GetTypes(IEnumerable<Assembly> assemblies)
 705        {
 706            foreach (var ass in assemblies)
 707            {
 708                Type[] exportedTypes;
 709                try
 710                {
 711                    exportedTypes = ass.GetExportedTypes();
 712                }
 713                catch (FileNotFoundException ex)
 714                {
 715                    Logger.LogError(ex, "Error getting exported types from {Assembly}", ass.FullName);
 716                    _pluginManager.FailPlugin(ass);
 717                    continue;
 718                }
 719                catch (TypeLoadException ex)
 720                {
 721                    Logger.LogError(ex, "Error loading types from {Assembly}.", ass.FullName);
 722                    _pluginManager.FailPlugin(ass);
 723                    continue;
 724                }
 725
 726                foreach (Type type in exportedTypes)
 727                {
 728                    if (type.IsClass && !type.IsAbstract && !type.IsInterface && !type.IsGenericType)
 729                    {
 730                        yield return type;
 731                    }
 732                }
 733            }
 734        }
 735
 736        /// <summary>
 737        /// Called when [configuration updated].
 738        /// </summary>
 739        /// <param name="sender">The sender.</param>
 740        /// <param name="e">The <see cref="EventArgs"/> instance containing the event data.</param>
 741        private void OnConfigurationUpdated(object sender, EventArgs e)
 742        {
 18743            var requiresRestart = false;
 18744            var networkConfiguration = ConfigurationManager.GetNetworkConfiguration();
 745
 746            // Don't do anything if these haven't been set yet
 18747            if (HttpPort != 0 && HttpsPort != 0)
 748            {
 749                // Need to restart if ports have changed
 18750                if (networkConfiguration.InternalHttpPort != HttpPort
 18751                    || networkConfiguration.InternalHttpsPort != HttpsPort)
 752                {
 0753                    if (ConfigurationManager.Configuration.IsPortAuthorized)
 754                    {
 0755                        ConfigurationManager.Configuration.IsPortAuthorized = false;
 0756                        ConfigurationManager.SaveConfiguration();
 757
 0758                        requiresRestart = true;
 759                    }
 760                }
 761            }
 762
 18763            if (ValidateSslCertificate(networkConfiguration))
 764            {
 0765                requiresRestart = true;
 766            }
 767
 18768            if (requiresRestart)
 769            {
 0770                Logger.LogInformation("App needs to be restarted due to configuration change.");
 771
 0772                NotifyPendingRestart();
 773            }
 18774        }
 775
 776        /// <summary>
 777        /// Validates the SSL certificate.
 778        /// </summary>
 779        /// <param name="networkConfig">The new configuration.</param>
 780        /// <exception cref="FileNotFoundException">The certificate path doesn't exist.</exception>
 781        private bool ValidateSslCertificate(NetworkConfiguration networkConfig)
 782        {
 18783            var newPath = networkConfig.CertificatePath;
 784
 18785            if (!string.IsNullOrWhiteSpace(newPath)
 18786                && !string.Equals(CertificatePath, newPath, StringComparison.Ordinal))
 787            {
 0788                if (File.Exists(newPath))
 789                {
 0790                    return true;
 791                }
 792
 0793                throw new FileNotFoundException(
 0794                    string.Format(
 0795                        CultureInfo.InvariantCulture,
 0796                        "Certificate file '{0}' does not exist.",
 0797                        newPath));
 798            }
 799
 18800            return false;
 801        }
 802
 803        /// <summary>
 804        /// Notifies the kernel that a change has been made that requires a restart.
 805        /// </summary>
 806        public void NotifyPendingRestart()
 807        {
 0808            Logger.LogInformation("App needs to be restarted.");
 809
 0810            var changed = !HasPendingRestart;
 811
 0812            HasPendingRestart = true;
 813
 0814            if (changed)
 815            {
 0816                EventHelper.QueueEventIfNotNull(HasPendingRestartChanged, this, EventArgs.Empty, Logger);
 817            }
 0818        }
 819
 820        /// <summary>
 821        /// Gets the composable part assemblies.
 822        /// </summary>
 823        /// <returns>IEnumerable{Assembly}.</returns>
 824        protected IEnumerable<Assembly> GetComposablePartAssemblies()
 825        {
 826            foreach (var p in _pluginManager.LoadAssemblies())
 827            {
 828                yield return p;
 829            }
 830
 831            // Include composable parts in the Model assembly
 832            yield return typeof(SystemInfo).Assembly;
 833
 834            // Include composable parts in the Common assembly
 835            yield return typeof(IApplicationHost).Assembly;
 836
 837            // Include composable parts in the Controller assembly
 838            yield return typeof(IServerApplicationHost).Assembly;
 839
 840            // Include composable parts in the Providers assembly
 841            yield return typeof(ProviderManager).Assembly;
 842
 843            // Include composable parts in the Photos assembly
 844            yield return typeof(PhotoProvider).Assembly;
 845
 846            // Emby.Server implementations
 847            yield return typeof(InstallationManager).Assembly;
 848
 849            // MediaEncoding
 850            yield return typeof(MediaBrowser.MediaEncoding.Encoder.MediaEncoder).Assembly;
 851
 852            // Local metadata
 853            yield return typeof(BoxSetXmlSaver).Assembly;
 854
 855            // Xbmc
 856            yield return typeof(ArtistNfoProvider).Assembly;
 857
 858            // Network
 859            yield return typeof(NetworkManager).Assembly;
 860
 861            // Hls
 862            yield return typeof(DynamicHlsPlaylistGenerator).Assembly;
 863
 864            foreach (var i in GetAssembliesWithPartsInternal())
 865            {
 866                yield return i;
 867            }
 868        }
 869
 870        protected abstract IEnumerable<Assembly> GetAssembliesWithPartsInternal();
 871
 872        /// <inheritdoc/>
 873        public string GetSmartApiUrl(IPAddress remoteAddr)
 874        {
 875            // Published server ends with a /
 0876            if (!string.IsNullOrEmpty(PublishedServerUrl))
 877            {
 878                // Published server ends with a '/', so we need to remove it.
 0879                return PublishedServerUrl.Trim('/');
 880            }
 881
 0882            string smart = NetManager.GetBindAddress(remoteAddr, out var port);
 0883            return GetLocalApiUrl(smart.Trim('/'), null, port);
 884        }
 885
 886        /// <inheritdoc/>
 887        public string GetSmartApiUrl(HttpRequest request)
 888        {
 889            // Return the host in the HTTP request as the API URL if not configured otherwise
 0890            if (ConfigurationManager.GetNetworkConfiguration().EnablePublishedServerUriByRequest)
 891            {
 0892                int? requestPort = request.Host.Port;
 0893                if (requestPort is null
 0894                    || (requestPort == 80 && string.Equals(request.Scheme, "http", StringComparison.OrdinalIgnoreCase))
 0895                    || (requestPort == 443 && string.Equals(request.Scheme, "https", StringComparison.OrdinalIgnoreCase)
 896                {
 0897                    requestPort = -1;
 898                }
 899
 0900                return GetLocalApiUrl(request.Host.Host, request.Scheme, requestPort);
 901            }
 902
 0903            return GetSmartApiUrl(request.HttpContext.Connection.RemoteIpAddress ?? IPAddress.Loopback);
 904        }
 905
 906        /// <inheritdoc/>
 907        public string GetSmartApiUrl(string hostname)
 908        {
 909            // Published server ends with a /
 0910            if (!string.IsNullOrEmpty(PublishedServerUrl))
 911            {
 912                // Published server ends with a '/', so we need to remove it.
 0913                return PublishedServerUrl.Trim('/');
 914            }
 915
 0916            string smart = NetManager.GetBindAddress(hostname, out var port);
 0917            return GetLocalApiUrl(smart.Trim('/'), null, port);
 918        }
 919
 920        /// <inheritdoc/>
 921        public string GetApiUrlForLocalAccess(IPAddress ipAddress = null, bool allowHttps = true)
 922        {
 923            // With an empty source, the port will be null
 0924            var smart = NetManager.GetBindAddress(ipAddress, out _, false);
 0925            var scheme = !allowHttps ? Uri.UriSchemeHttp : null;
 0926            int? port = !allowHttps ? HttpPort : null;
 0927            return GetLocalApiUrl(smart, scheme, port);
 928        }
 929
 930        /// <inheritdoc/>
 931        public string GetLocalApiUrl(string hostname, string scheme = null, int? port = null)
 932        {
 933            // If the smartAPI doesn't start with http then treat it as a host or ip.
 0934            if (hostname.StartsWith("http", StringComparison.OrdinalIgnoreCase))
 935            {
 0936                return hostname.TrimEnd('/');
 937            }
 938
 939            // NOTE: If no BaseUrl is set then UriBuilder appends a trailing slash, but if there is no BaseUrl it does
 940            // not. For consistency, always trim the trailing slash.
 0941            scheme ??= ListenWithHttps ? Uri.UriSchemeHttps : Uri.UriSchemeHttp;
 0942            var isHttps = string.Equals(scheme, Uri.UriSchemeHttps, StringComparison.OrdinalIgnoreCase);
 0943            return new UriBuilder
 0944            {
 0945                Scheme = scheme,
 0946                Host = hostname,
 0947                Port = port ?? (isHttps ? HttpsPort : HttpPort),
 0948                Path = ConfigurationManager.GetNetworkConfiguration().BaseUrl
 0949            }.ToString().TrimEnd('/');
 950        }
 951
 952        public IEnumerable<Assembly> GetApiPluginAssemblies()
 953        {
 954            var assemblies = _allConcreteTypes
 955                .Where(i => typeof(ControllerBase).IsAssignableFrom(i))
 956                .Select(i => i.Assembly)
 957                .Distinct();
 958
 959            foreach (var assembly in assemblies)
 960            {
 961                Logger.LogDebug("Found API endpoints in plugin {Name}", assembly.FullName);
 962                yield return assembly;
 963            }
 964        }
 965
 966        /// <inheritdoc />
 967        public void Dispose()
 968        {
 21969            Dispose(true);
 21970            GC.SuppressFinalize(this);
 21971        }
 972
 973        /// <summary>
 974        /// Releases unmanaged and - optionally - managed resources.
 975        /// </summary>
 976        /// <param name="dispose"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release o
 977        protected virtual void Dispose(bool dispose)
 978        {
 21979            if (_disposed)
 980            {
 0981                return;
 982            }
 983
 21984            if (dispose)
 985            {
 21986                var type = GetType();
 987
 21988                Logger.LogInformation("Disposing {Type}", type.Name);
 989
 168990                foreach (var part in _disposableParts.ToArray())
 991                {
 63992                    var partType = part.GetType();
 63993                    if (partType == type)
 994                    {
 995                        continue;
 996                    }
 997
 63998                    Logger.LogInformation("Disposing {Type}", partType.Name);
 999
 1000                    try
 1001                    {
 631002                        part.Dispose();
 631003                    }
 01004                    catch (Exception ex)
 1005                    {
 01006                        Logger.LogError(ex, "Error disposing {Type}", partType.Name);
 01007                    }
 1008                }
 1009
 211010                _disposableParts.Clear();
 1011            }
 1012
 211013            _disposed = true;
 211014        }
 1015    }
 1016}
Generated by: ReportGenerator 5.4.5.0
4/3/2025 - 12:11:20 AM
GitHub | reportgenerator.io

Methods/Properties

.ctor(MediaBrowser.Controller.IServerApplicationPaths,Microsoft.Extensions.Logging.ILoggerFactory,Emby.Server.Implementations.IStartupOptions,Microsoft.Extensions.Configuration.IConfiguration)
get_PublishedServerUrl()
get_ApplicationUserAgentAddress()
get_SystemId()
get_Name()
get_ListenWithHttps()
get_FriendlyName()
ExpandVirtualPath(System.String)
ReverseVirtualPath(System.String)
CreateInstanceSafe(System.Type)
Resolve()
GetExports(System.Boolean)
GetExports(MediaBrowser.Common.CreationDelegateFactory,System.Boolean)
RunStartupTasksAsync()
Init(Microsoft.Extensions.DependencyInjection.IServiceCollection)
RegisterServices(Microsoft.Extensions.DependencyInjection.IServiceCollection)
GetCertificate(System.String,System.String)
SetStaticProperties()
FindParts()
DiscoverTypes()
OnConfigurationUpdated(System.Object,System.EventArgs)
ValidateSslCertificate(MediaBrowser.Common.Net.NetworkConfiguration)
NotifyPendingRestart()
GetSmartApiUrl(System.Net.IPAddress)
GetSmartApiUrl(Microsoft.AspNetCore.Http.HttpRequest)
GetSmartApiUrl(System.String)
GetApiUrlForLocalAccess(System.Net.IPAddress,System.Boolean)
GetLocalApiUrl(System.String,System.String,System.Nullable`1<System.Int32>)
Dispose()
Dispose(System.Boolean)