ApplicationHost.cs 48 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285
  1. #nullable disable
  2. #pragma warning disable CS1591
  3. using System;
  4. using System.Collections.Concurrent;
  5. using System.Collections.Generic;
  6. using System.Diagnostics;
  7. using System.Globalization;
  8. using System.IO;
  9. using System.Linq;
  10. using System.Net;
  11. using System.Reflection;
  12. using System.Runtime.InteropServices;
  13. using System.Security.Cryptography.X509Certificates;
  14. using System.Threading;
  15. using System.Threading.Tasks;
  16. using Emby.Dlna;
  17. using Emby.Dlna.Main;
  18. using Emby.Dlna.Ssdp;
  19. using Emby.Drawing;
  20. using Emby.Naming.Common;
  21. using Emby.Notifications;
  22. using Emby.Photos;
  23. using Emby.Server.Implementations.Channels;
  24. using Emby.Server.Implementations.Collections;
  25. using Emby.Server.Implementations.Configuration;
  26. using Emby.Server.Implementations.Cryptography;
  27. using Emby.Server.Implementations.Data;
  28. using Emby.Server.Implementations.Devices;
  29. using Emby.Server.Implementations.Dto;
  30. using Emby.Server.Implementations.HttpServer.Security;
  31. using Emby.Server.Implementations.IO;
  32. using Emby.Server.Implementations.Library;
  33. using Emby.Server.Implementations.LiveTv;
  34. using Emby.Server.Implementations.Localization;
  35. using Emby.Server.Implementations.Net;
  36. using Emby.Server.Implementations.Playlists;
  37. using Emby.Server.Implementations.Plugins;
  38. using Emby.Server.Implementations.QuickConnect;
  39. using Emby.Server.Implementations.ScheduledTasks;
  40. using Emby.Server.Implementations.Serialization;
  41. using Emby.Server.Implementations.Session;
  42. using Emby.Server.Implementations.SyncPlay;
  43. using Emby.Server.Implementations.TV;
  44. using Emby.Server.Implementations.Updates;
  45. using Jellyfin.Api.Helpers;
  46. using Jellyfin.MediaEncoding.Hls.Playlist;
  47. using Jellyfin.Networking.Configuration;
  48. using Jellyfin.Networking.Manager;
  49. using Jellyfin.Server.Implementations;
  50. using MediaBrowser.Common;
  51. using MediaBrowser.Common.Configuration;
  52. using MediaBrowser.Common.Events;
  53. using MediaBrowser.Common.Net;
  54. using MediaBrowser.Common.Plugins;
  55. using MediaBrowser.Common.Updates;
  56. using MediaBrowser.Controller;
  57. using MediaBrowser.Controller.Channels;
  58. using MediaBrowser.Controller.Chapters;
  59. using MediaBrowser.Controller.ClientEvent;
  60. using MediaBrowser.Controller.Collections;
  61. using MediaBrowser.Controller.Configuration;
  62. using MediaBrowser.Controller.Dlna;
  63. using MediaBrowser.Controller.Drawing;
  64. using MediaBrowser.Controller.Dto;
  65. using MediaBrowser.Controller.Entities;
  66. using MediaBrowser.Controller.Library;
  67. using MediaBrowser.Controller.LiveTv;
  68. using MediaBrowser.Controller.Lyrics;
  69. using MediaBrowser.Controller.MediaEncoding;
  70. using MediaBrowser.Controller.Net;
  71. using MediaBrowser.Controller.Notifications;
  72. using MediaBrowser.Controller.Persistence;
  73. using MediaBrowser.Controller.Playlists;
  74. using MediaBrowser.Controller.Plugins;
  75. using MediaBrowser.Controller.Providers;
  76. using MediaBrowser.Controller.QuickConnect;
  77. using MediaBrowser.Controller.Resolvers;
  78. using MediaBrowser.Controller.Session;
  79. using MediaBrowser.Controller.Sorting;
  80. using MediaBrowser.Controller.Subtitles;
  81. using MediaBrowser.Controller.SyncPlay;
  82. using MediaBrowser.Controller.TV;
  83. using MediaBrowser.LocalMetadata.Savers;
  84. using MediaBrowser.MediaEncoding.BdInfo;
  85. using MediaBrowser.MediaEncoding.Subtitles;
  86. using MediaBrowser.Model.Cryptography;
  87. using MediaBrowser.Model.Dlna;
  88. using MediaBrowser.Model.Globalization;
  89. using MediaBrowser.Model.IO;
  90. using MediaBrowser.Model.MediaInfo;
  91. using MediaBrowser.Model.Net;
  92. using MediaBrowser.Model.Serialization;
  93. using MediaBrowser.Model.System;
  94. using MediaBrowser.Model.Tasks;
  95. using MediaBrowser.Providers.Chapters;
  96. using MediaBrowser.Providers.Lyric;
  97. using MediaBrowser.Providers.Manager;
  98. using MediaBrowser.Providers.Plugins.Tmdb;
  99. using MediaBrowser.Providers.Subtitles;
  100. using MediaBrowser.XbmcMetadata.Providers;
  101. using Microsoft.AspNetCore.Http;
  102. using Microsoft.AspNetCore.Mvc;
  103. using Microsoft.EntityFrameworkCore;
  104. using Microsoft.Extensions.Configuration;
  105. using Microsoft.Extensions.DependencyInjection;
  106. using Microsoft.Extensions.Logging;
  107. using Prometheus.DotNetRuntime;
  108. using static MediaBrowser.Controller.Extensions.ConfigurationExtensions;
  109. using WebSocketManager = Emby.Server.Implementations.HttpServer.WebSocketManager;
  110. namespace Emby.Server.Implementations
  111. {
  112. /// <summary>
  113. /// Class CompositionRoot.
  114. /// </summary>
  115. public abstract class ApplicationHost : IServerApplicationHost, IAsyncDisposable, IDisposable
  116. {
  117. /// <summary>
  118. /// The environment variable prefixes to log at server startup.
  119. /// </summary>
  120. private static readonly string[] _relevantEnvVarPrefixes = { "JELLYFIN_", "DOTNET_", "ASPNETCORE_" };
  121. /// <summary>
  122. /// The disposable parts.
  123. /// </summary>
  124. private readonly ConcurrentDictionary<IDisposable, byte> _disposableParts = new();
  125. private readonly IFileSystem _fileSystemManager;
  126. private readonly IConfiguration _startupConfig;
  127. private readonly IXmlSerializer _xmlSerializer;
  128. private readonly IStartupOptions _startupOptions;
  129. private readonly IPluginManager _pluginManager;
  130. private List<Type> _creatingInstances;
  131. private IMediaEncoder _mediaEncoder;
  132. private ISessionManager _sessionManager;
  133. /// <summary>
  134. /// Gets or sets all concrete types.
  135. /// </summary>
  136. /// <value>All concrete types.</value>
  137. private Type[] _allConcreteTypes;
  138. private DeviceId _deviceId;
  139. private bool _disposed = false;
  140. /// <summary>
  141. /// Initializes a new instance of the <see cref="ApplicationHost"/> class.
  142. /// </summary>
  143. /// <param name="applicationPaths">Instance of the <see cref="IServerApplicationPaths"/> interface.</param>
  144. /// <param name="loggerFactory">Instance of the <see cref="ILoggerFactory"/> interface.</param>
  145. /// <param name="options">Instance of the <see cref="IStartupOptions"/> interface.</param>
  146. /// <param name="startupConfig">The <see cref="IConfiguration" /> interface.</param>
  147. protected ApplicationHost(
  148. IServerApplicationPaths applicationPaths,
  149. ILoggerFactory loggerFactory,
  150. IStartupOptions options,
  151. IConfiguration startupConfig)
  152. {
  153. ApplicationPaths = applicationPaths;
  154. LoggerFactory = loggerFactory;
  155. _startupOptions = options;
  156. _startupConfig = startupConfig;
  157. _fileSystemManager = new ManagedFileSystem(LoggerFactory.CreateLogger<ManagedFileSystem>(), applicationPaths);
  158. Logger = LoggerFactory.CreateLogger<ApplicationHost>();
  159. _fileSystemManager.AddShortcutHandler(new MbLinkShortcutHandler(_fileSystemManager));
  160. ApplicationVersion = typeof(ApplicationHost).Assembly.GetName().Version;
  161. ApplicationVersionString = ApplicationVersion.ToString(3);
  162. ApplicationUserAgent = Name.Replace(' ', '-') + "/" + ApplicationVersionString;
  163. _xmlSerializer = new MyXmlSerializer();
  164. ConfigurationManager = new ServerConfigurationManager(ApplicationPaths, LoggerFactory, _xmlSerializer, _fileSystemManager);
  165. _pluginManager = new PluginManager(
  166. LoggerFactory.CreateLogger<PluginManager>(),
  167. this,
  168. ConfigurationManager.Configuration,
  169. ApplicationPaths.PluginsPath,
  170. ApplicationVersion);
  171. }
  172. /// <summary>
  173. /// Occurs when [has pending restart changed].
  174. /// </summary>
  175. public event EventHandler HasPendingRestartChanged;
  176. /// <summary>
  177. /// Gets the value of the PublishedServerUrl setting.
  178. /// </summary>
  179. private string PublishedServerUrl => _startupConfig[AddressOverrideKey];
  180. /// <summary>
  181. /// Gets a value indicating whether this instance can self restart.
  182. /// </summary>
  183. public bool CanSelfRestart => _startupOptions.RestartPath is not null;
  184. public bool CoreStartupHasCompleted { get; private set; }
  185. public virtual bool CanLaunchWebBrowser
  186. {
  187. get
  188. {
  189. if (!Environment.UserInteractive)
  190. {
  191. return false;
  192. }
  193. if (_startupOptions.IsService)
  194. {
  195. return false;
  196. }
  197. return OperatingSystem.IsWindows() || OperatingSystem.IsMacOS();
  198. }
  199. }
  200. /// <summary>
  201. /// Gets the <see cref="INetworkManager"/> singleton instance.
  202. /// </summary>
  203. public INetworkManager NetManager { get; private set; }
  204. /// <summary>
  205. /// Gets a value indicating whether this instance has changes that require the entire application to restart.
  206. /// </summary>
  207. /// <value><c>true</c> if this instance has pending application restart; otherwise, <c>false</c>.</value>
  208. public bool HasPendingRestart { get; private set; }
  209. /// <inheritdoc />
  210. public bool IsShuttingDown { get; private set; }
  211. /// <summary>
  212. /// Gets the logger.
  213. /// </summary>
  214. protected ILogger<ApplicationHost> Logger { get; }
  215. /// <summary>
  216. /// Gets the logger factory.
  217. /// </summary>
  218. protected ILoggerFactory LoggerFactory { get; }
  219. /// <summary>
  220. /// Gets the application paths.
  221. /// </summary>
  222. /// <value>The application paths.</value>
  223. protected IServerApplicationPaths ApplicationPaths { get; }
  224. /// <summary>
  225. /// Gets the configuration manager.
  226. /// </summary>
  227. /// <value>The configuration manager.</value>
  228. public ServerConfigurationManager ConfigurationManager { get; }
  229. /// <summary>
  230. /// Gets or sets the service provider.
  231. /// </summary>
  232. public IServiceProvider ServiceProvider { get; set; }
  233. /// <summary>
  234. /// Gets the http port for the webhost.
  235. /// </summary>
  236. public int HttpPort { get; private set; }
  237. /// <summary>
  238. /// Gets the https port for the webhost.
  239. /// </summary>
  240. public int HttpsPort { get; private set; }
  241. /// <inheritdoc />
  242. public Version ApplicationVersion { get; }
  243. /// <inheritdoc />
  244. public string ApplicationVersionString { get; }
  245. /// <summary>
  246. /// Gets the current application user agent.
  247. /// </summary>
  248. /// <value>The application user agent.</value>
  249. public string ApplicationUserAgent { get; }
  250. /// <summary>
  251. /// Gets the email address for use within a comment section of a user agent field.
  252. /// Presently used to provide contact information to MusicBrainz service.
  253. /// </summary>
  254. public string ApplicationUserAgentAddress => "team@jellyfin.org";
  255. /// <summary>
  256. /// Gets the current application name.
  257. /// </summary>
  258. /// <value>The application name.</value>
  259. public string ApplicationProductName { get; } = FileVersionInfo.GetVersionInfo(Assembly.GetEntryAssembly().Location).ProductName;
  260. public string SystemId
  261. {
  262. get
  263. {
  264. _deviceId ??= new DeviceId(ApplicationPaths, LoggerFactory);
  265. return _deviceId.Value;
  266. }
  267. }
  268. /// <inheritdoc/>
  269. public string Name => ApplicationProductName;
  270. private string CertificatePath { get; set; }
  271. public X509Certificate2 Certificate { get; private set; }
  272. /// <inheritdoc/>
  273. public bool ListenWithHttps => Certificate is not null && ConfigurationManager.GetNetworkConfiguration().EnableHttps;
  274. public string FriendlyName =>
  275. string.IsNullOrEmpty(ConfigurationManager.Configuration.ServerName)
  276. ? Environment.MachineName
  277. : ConfigurationManager.Configuration.ServerName;
  278. public string ExpandVirtualPath(string path)
  279. {
  280. var appPaths = ApplicationPaths;
  281. return path.Replace(appPaths.VirtualDataPath, appPaths.DataPath, StringComparison.OrdinalIgnoreCase)
  282. .Replace(appPaths.VirtualInternalMetadataPath, appPaths.InternalMetadataPath, StringComparison.OrdinalIgnoreCase);
  283. }
  284. public string ReverseVirtualPath(string path)
  285. {
  286. var appPaths = ApplicationPaths;
  287. return path.Replace(appPaths.DataPath, appPaths.VirtualDataPath, StringComparison.OrdinalIgnoreCase)
  288. .Replace(appPaths.InternalMetadataPath, appPaths.VirtualInternalMetadataPath, StringComparison.OrdinalIgnoreCase);
  289. }
  290. /// <summary>
  291. /// Creates the instance safe.
  292. /// </summary>
  293. /// <param name="type">The type.</param>
  294. /// <returns>System.Object.</returns>
  295. protected object CreateInstanceSafe(Type type)
  296. {
  297. _creatingInstances ??= new List<Type>();
  298. if (_creatingInstances.Contains(type))
  299. {
  300. Logger.LogError("DI Loop detected in the attempted creation of {Type}", type.FullName);
  301. foreach (var entry in _creatingInstances)
  302. {
  303. Logger.LogError("Called from: {TypeName}", entry.FullName);
  304. }
  305. _pluginManager.FailPlugin(type.Assembly);
  306. throw new TypeLoadException("DI Loop detected");
  307. }
  308. try
  309. {
  310. _creatingInstances.Add(type);
  311. Logger.LogDebug("Creating instance of {Type}", type);
  312. return ActivatorUtilities.CreateInstance(ServiceProvider, type);
  313. }
  314. catch (Exception ex)
  315. {
  316. Logger.LogError(ex, "Error creating {Type}", type);
  317. // If this is a plugin fail it.
  318. _pluginManager.FailPlugin(type.Assembly);
  319. return null;
  320. }
  321. finally
  322. {
  323. _creatingInstances.Remove(type);
  324. }
  325. }
  326. /// <summary>
  327. /// Resolves this instance.
  328. /// </summary>
  329. /// <typeparam name="T">The type.</typeparam>
  330. /// <returns>``0.</returns>
  331. public T Resolve<T>() => ServiceProvider.GetService<T>();
  332. /// <inheritdoc/>
  333. public IEnumerable<Type> GetExportTypes<T>()
  334. {
  335. var currentType = typeof(T);
  336. var numberOfConcreteTypes = _allConcreteTypes.Length;
  337. for (var i = 0; i < numberOfConcreteTypes; i++)
  338. {
  339. var type = _allConcreteTypes[i];
  340. if (currentType.IsAssignableFrom(type))
  341. {
  342. yield return type;
  343. }
  344. }
  345. }
  346. /// <inheritdoc />
  347. public IReadOnlyCollection<T> GetExports<T>(bool manageLifetime = true)
  348. {
  349. // Convert to list so this isn't executed for each iteration
  350. var parts = GetExportTypes<T>()
  351. .Select(CreateInstanceSafe)
  352. .Where(i => i is not null)
  353. .Cast<T>()
  354. .ToList();
  355. if (manageLifetime)
  356. {
  357. foreach (var part in parts.OfType<IDisposable>())
  358. {
  359. _disposableParts.TryAdd(part, byte.MinValue);
  360. }
  361. }
  362. return parts;
  363. }
  364. /// <inheritdoc />
  365. public IReadOnlyCollection<T> GetExports<T>(CreationDelegateFactory defaultFunc, bool manageLifetime = true)
  366. {
  367. // Convert to list so this isn't executed for each iteration
  368. var parts = GetExportTypes<T>()
  369. .Select(i => defaultFunc(i))
  370. .Where(i => i is not null)
  371. .Cast<T>()
  372. .ToList();
  373. if (manageLifetime)
  374. {
  375. foreach (var part in parts.OfType<IDisposable>())
  376. {
  377. _disposableParts.TryAdd(part, byte.MinValue);
  378. }
  379. }
  380. return parts;
  381. }
  382. /// <summary>
  383. /// Runs the startup tasks.
  384. /// </summary>
  385. /// <param name="cancellationToken">The cancellation token.</param>
  386. /// <returns><see cref="Task" />.</returns>
  387. public async Task RunStartupTasksAsync(CancellationToken cancellationToken)
  388. {
  389. cancellationToken.ThrowIfCancellationRequested();
  390. Logger.LogInformation("Running startup tasks");
  391. Resolve<ITaskManager>().AddTasks(GetExports<IScheduledTask>(false));
  392. ConfigurationManager.ConfigurationUpdated += OnConfigurationUpdated;
  393. ConfigurationManager.NamedConfigurationUpdated += OnConfigurationUpdated;
  394. _mediaEncoder.SetFFmpegPath();
  395. Logger.LogInformation("ServerId: {ServerId}", SystemId);
  396. var entryPoints = GetExports<IServerEntryPoint>();
  397. cancellationToken.ThrowIfCancellationRequested();
  398. var stopWatch = new Stopwatch();
  399. stopWatch.Start();
  400. await Task.WhenAll(StartEntryPoints(entryPoints, true)).ConfigureAwait(false);
  401. Logger.LogInformation("Executed all pre-startup entry points in {Elapsed:g}", stopWatch.Elapsed);
  402. Logger.LogInformation("Core startup complete");
  403. CoreStartupHasCompleted = true;
  404. cancellationToken.ThrowIfCancellationRequested();
  405. stopWatch.Restart();
  406. await Task.WhenAll(StartEntryPoints(entryPoints, false)).ConfigureAwait(false);
  407. Logger.LogInformation("Executed all post-startup entry points in {Elapsed:g}", stopWatch.Elapsed);
  408. stopWatch.Stop();
  409. }
  410. private IEnumerable<Task> StartEntryPoints(IEnumerable<IServerEntryPoint> entryPoints, bool isBeforeStartup)
  411. {
  412. foreach (var entryPoint in entryPoints)
  413. {
  414. if (isBeforeStartup != (entryPoint is IRunBeforeStartup))
  415. {
  416. continue;
  417. }
  418. Logger.LogDebug("Starting entry point {Type}", entryPoint.GetType());
  419. yield return entryPoint.RunAsync();
  420. }
  421. }
  422. /// <inheritdoc/>
  423. public void Init(IServiceCollection serviceCollection)
  424. {
  425. DiscoverTypes();
  426. ConfigurationManager.AddParts(GetExports<IConfigurationFactory>());
  427. NetManager = new NetworkManager(ConfigurationManager, LoggerFactory.CreateLogger<NetworkManager>());
  428. // Initialize runtime stat collection
  429. if (ConfigurationManager.Configuration.EnableMetrics)
  430. {
  431. DotNetRuntimeStatsBuilder.Default().StartCollecting();
  432. }
  433. var networkConfiguration = ConfigurationManager.GetNetworkConfiguration();
  434. HttpPort = networkConfiguration.HttpServerPortNumber;
  435. HttpsPort = networkConfiguration.HttpsPortNumber;
  436. // Safeguard against invalid configuration
  437. if (HttpPort == HttpsPort)
  438. {
  439. HttpPort = NetworkConfiguration.DefaultHttpPort;
  440. HttpsPort = NetworkConfiguration.DefaultHttpsPort;
  441. }
  442. CertificatePath = networkConfiguration.CertificatePath;
  443. Certificate = GetCertificate(CertificatePath, networkConfiguration.CertificatePassword);
  444. RegisterServices(serviceCollection);
  445. _pluginManager.RegisterServices(serviceCollection);
  446. }
  447. /// <summary>
  448. /// Registers services/resources with the service collection that will be available via DI.
  449. /// </summary>
  450. /// <param name="serviceCollection">Instance of the <see cref="IServiceCollection"/> interface.</param>
  451. protected virtual void RegisterServices(IServiceCollection serviceCollection)
  452. {
  453. serviceCollection.AddSingleton(_startupOptions);
  454. serviceCollection.AddMemoryCache();
  455. serviceCollection.AddSingleton<IServerConfigurationManager>(ConfigurationManager);
  456. serviceCollection.AddSingleton<IConfigurationManager>(ConfigurationManager);
  457. serviceCollection.AddSingleton<IApplicationHost>(this);
  458. serviceCollection.AddSingleton(_pluginManager);
  459. serviceCollection.AddSingleton<IApplicationPaths>(ApplicationPaths);
  460. serviceCollection.AddSingleton(_fileSystemManager);
  461. serviceCollection.AddSingleton<TmdbClientManager>();
  462. serviceCollection.AddSingleton(NetManager);
  463. serviceCollection.AddSingleton<ITaskManager, TaskManager>();
  464. serviceCollection.AddSingleton(_xmlSerializer);
  465. serviceCollection.AddSingleton<IStreamHelper, StreamHelper>();
  466. serviceCollection.AddSingleton<ICryptoProvider, CryptographyProvider>();
  467. serviceCollection.AddSingleton<ISocketFactory, SocketFactory>();
  468. serviceCollection.AddSingleton<IInstallationManager, InstallationManager>();
  469. serviceCollection.AddSingleton<IServerApplicationHost>(this);
  470. serviceCollection.AddSingleton(ApplicationPaths);
  471. serviceCollection.AddSingleton<ILocalizationManager, LocalizationManager>();
  472. serviceCollection.AddSingleton<IBlurayExaminer, BdInfoExaminer>();
  473. serviceCollection.AddSingleton<IUserDataRepository, SqliteUserDataRepository>();
  474. serviceCollection.AddSingleton<IUserDataManager, UserDataManager>();
  475. serviceCollection.AddSingleton<IItemRepository, SqliteItemRepository>();
  476. serviceCollection.AddSingleton<IMediaEncoder, MediaBrowser.MediaEncoding.Encoder.MediaEncoder>();
  477. serviceCollection.AddSingleton<EncodingHelper>();
  478. // TODO: Refactor to eliminate the circular dependencies here so that Lazy<T> isn't required
  479. serviceCollection.AddTransient(provider => new Lazy<ILibraryMonitor>(provider.GetRequiredService<ILibraryMonitor>));
  480. serviceCollection.AddTransient(provider => new Lazy<IProviderManager>(provider.GetRequiredService<IProviderManager>));
  481. serviceCollection.AddTransient(provider => new Lazy<IUserViewManager>(provider.GetRequiredService<IUserViewManager>));
  482. serviceCollection.AddSingleton<ILibraryManager, LibraryManager>();
  483. serviceCollection.AddSingleton<NamingOptions>();
  484. serviceCollection.AddSingleton<IMusicManager, MusicManager>();
  485. serviceCollection.AddSingleton<ILibraryMonitor, LibraryMonitor>();
  486. serviceCollection.AddSingleton<ISearchEngine, SearchEngine>();
  487. serviceCollection.AddSingleton<IWebSocketManager, WebSocketManager>();
  488. serviceCollection.AddSingleton<IImageProcessor, ImageProcessor>();
  489. serviceCollection.AddSingleton<ITVSeriesManager, TVSeriesManager>();
  490. serviceCollection.AddSingleton<IMediaSourceManager, MediaSourceManager>();
  491. serviceCollection.AddSingleton<ISubtitleManager, SubtitleManager>();
  492. serviceCollection.AddSingleton<ILyricManager, LyricManager>();
  493. serviceCollection.AddSingleton<IProviderManager, ProviderManager>();
  494. // TODO: Refactor to eliminate the circular dependency here so that Lazy<T> isn't required
  495. serviceCollection.AddTransient(provider => new Lazy<ILiveTvManager>(provider.GetRequiredService<ILiveTvManager>));
  496. serviceCollection.AddSingleton<IDtoService, DtoService>();
  497. serviceCollection.AddSingleton<IChannelManager, ChannelManager>();
  498. serviceCollection.AddSingleton<ISessionManager, SessionManager>();
  499. serviceCollection.AddSingleton<IDlnaManager, DlnaManager>();
  500. serviceCollection.AddSingleton<ICollectionManager, CollectionManager>();
  501. serviceCollection.AddSingleton<IPlaylistManager, PlaylistManager>();
  502. serviceCollection.AddSingleton<ISyncPlayManager, SyncPlayManager>();
  503. serviceCollection.AddSingleton<LiveTvDtoService>();
  504. serviceCollection.AddSingleton<ILiveTvManager, LiveTvManager>();
  505. serviceCollection.AddSingleton<IUserViewManager, UserViewManager>();
  506. serviceCollection.AddSingleton<INotificationManager, NotificationManager>();
  507. serviceCollection.AddSingleton<IDeviceDiscovery, DeviceDiscovery>();
  508. serviceCollection.AddSingleton<IChapterManager, ChapterManager>();
  509. serviceCollection.AddSingleton<IEncodingManager, MediaEncoder.EncodingManager>();
  510. serviceCollection.AddSingleton<IAuthService, AuthService>();
  511. serviceCollection.AddSingleton<IQuickConnect, QuickConnectManager>();
  512. serviceCollection.AddSingleton<ISubtitleParser, SubtitleEditParser>();
  513. serviceCollection.AddSingleton<ISubtitleEncoder, SubtitleEncoder>();
  514. serviceCollection.AddSingleton<IAttachmentExtractor, MediaBrowser.MediaEncoding.Attachments.AttachmentExtractor>();
  515. serviceCollection.AddSingleton<TranscodingJobHelper>();
  516. serviceCollection.AddScoped<MediaInfoHelper>();
  517. serviceCollection.AddScoped<AudioHelper>();
  518. serviceCollection.AddScoped<DynamicHlsHelper>();
  519. serviceCollection.AddScoped<IClientEventLogger, ClientEventLogger>();
  520. serviceCollection.AddSingleton<IDirectoryService, DirectoryService>();
  521. }
  522. /// <summary>
  523. /// Create services registered with the service container that need to be initialized at application startup.
  524. /// </summary>
  525. /// <returns>A task representing the service initialization operation.</returns>
  526. public async Task InitializeServices()
  527. {
  528. var jellyfinDb = await Resolve<IDbContextFactory<JellyfinDb>>().CreateDbContextAsync().ConfigureAwait(false);
  529. await using (jellyfinDb.ConfigureAwait(false))
  530. {
  531. if ((await jellyfinDb.Database.GetPendingMigrationsAsync().ConfigureAwait(false)).Any())
  532. {
  533. Logger.LogInformation("There are pending EFCore migrations in the database. Applying... (This may take a while, do not stop Jellyfin)");
  534. await jellyfinDb.Database.MigrateAsync().ConfigureAwait(false);
  535. Logger.LogInformation("EFCore migrations applied successfully");
  536. }
  537. }
  538. var localizationManager = (LocalizationManager)Resolve<ILocalizationManager>();
  539. await localizationManager.LoadAll().ConfigureAwait(false);
  540. _mediaEncoder = Resolve<IMediaEncoder>();
  541. _sessionManager = Resolve<ISessionManager>();
  542. SetStaticProperties();
  543. var userDataRepo = (SqliteUserDataRepository)Resolve<IUserDataRepository>();
  544. ((SqliteItemRepository)Resolve<IItemRepository>()).Initialize(userDataRepo, Resolve<IUserManager>());
  545. FindParts();
  546. }
  547. public static void LogEnvironmentInfo(ILogger logger, IApplicationPaths appPaths)
  548. {
  549. // Distinct these to prevent users from reporting problems that aren't actually problems
  550. var commandLineArgs = Environment
  551. .GetCommandLineArgs()
  552. .Distinct();
  553. // Get all relevant environment variables
  554. var allEnvVars = Environment.GetEnvironmentVariables();
  555. var relevantEnvVars = new Dictionary<object, object>();
  556. foreach (var key in allEnvVars.Keys)
  557. {
  558. if (_relevantEnvVarPrefixes.Any(prefix => key.ToString().StartsWith(prefix, StringComparison.OrdinalIgnoreCase)))
  559. {
  560. relevantEnvVars.Add(key, allEnvVars[key]);
  561. }
  562. }
  563. logger.LogInformation("Environment Variables: {EnvVars}", relevantEnvVars);
  564. logger.LogInformation("Arguments: {Args}", commandLineArgs);
  565. logger.LogInformation("Operating system: {OS}", MediaBrowser.Common.System.OperatingSystem.Name);
  566. logger.LogInformation("Architecture: {Architecture}", RuntimeInformation.OSArchitecture);
  567. logger.LogInformation("64-Bit Process: {Is64Bit}", Environment.Is64BitProcess);
  568. logger.LogInformation("User Interactive: {IsUserInteractive}", Environment.UserInteractive);
  569. logger.LogInformation("Processor count: {ProcessorCount}", Environment.ProcessorCount);
  570. logger.LogInformation("Program data path: {ProgramDataPath}", appPaths.ProgramDataPath);
  571. logger.LogInformation("Web resources path: {WebPath}", appPaths.WebPath);
  572. logger.LogInformation("Application directory: {ApplicationPath}", appPaths.ProgramSystemPath);
  573. }
  574. private X509Certificate2 GetCertificate(string path, string password)
  575. {
  576. if (string.IsNullOrWhiteSpace(path))
  577. {
  578. return null;
  579. }
  580. try
  581. {
  582. if (!File.Exists(path))
  583. {
  584. return null;
  585. }
  586. // Don't use an empty string password
  587. password = string.IsNullOrWhiteSpace(password) ? null : password;
  588. var localCert = new X509Certificate2(path, password, X509KeyStorageFlags.UserKeySet);
  589. if (!localCert.HasPrivateKey)
  590. {
  591. Logger.LogError("No private key included in SSL cert {CertificateLocation}.", path);
  592. return null;
  593. }
  594. return localCert;
  595. }
  596. catch (Exception ex)
  597. {
  598. Logger.LogError(ex, "Error loading cert from {CertificateLocation}", path);
  599. return null;
  600. }
  601. }
  602. /// <summary>
  603. /// Dirty hacks.
  604. /// </summary>
  605. private void SetStaticProperties()
  606. {
  607. // For now there's no real way to inject these properly
  608. BaseItem.Logger = Resolve<ILogger<BaseItem>>();
  609. BaseItem.ConfigurationManager = ConfigurationManager;
  610. BaseItem.LibraryManager = Resolve<ILibraryManager>();
  611. BaseItem.ProviderManager = Resolve<IProviderManager>();
  612. BaseItem.LocalizationManager = Resolve<ILocalizationManager>();
  613. BaseItem.ItemRepository = Resolve<IItemRepository>();
  614. BaseItem.FileSystem = _fileSystemManager;
  615. BaseItem.UserDataManager = Resolve<IUserDataManager>();
  616. BaseItem.ChannelManager = Resolve<IChannelManager>();
  617. Video.LiveTvManager = Resolve<ILiveTvManager>();
  618. Folder.UserViewManager = Resolve<IUserViewManager>();
  619. UserView.TVSeriesManager = Resolve<ITVSeriesManager>();
  620. UserView.CollectionManager = Resolve<ICollectionManager>();
  621. BaseItem.MediaSourceManager = Resolve<IMediaSourceManager>();
  622. CollectionFolder.XmlSerializer = _xmlSerializer;
  623. CollectionFolder.ApplicationHost = this;
  624. }
  625. /// <summary>
  626. /// Finds plugin components and register them with the appropriate services.
  627. /// </summary>
  628. private void FindParts()
  629. {
  630. if (!ConfigurationManager.Configuration.IsPortAuthorized)
  631. {
  632. ConfigurationManager.Configuration.IsPortAuthorized = true;
  633. ConfigurationManager.SaveConfiguration();
  634. }
  635. _pluginManager.CreatePlugins();
  636. Resolve<ILibraryManager>().AddParts(
  637. GetExports<IResolverIgnoreRule>(),
  638. GetExports<IItemResolver>(),
  639. GetExports<IIntroProvider>(),
  640. GetExports<IBaseItemComparer>(),
  641. GetExports<ILibraryPostScanTask>());
  642. Resolve<IProviderManager>().AddParts(
  643. GetExports<IImageProvider>(),
  644. GetExports<IMetadataService>(),
  645. GetExports<IMetadataProvider>(),
  646. GetExports<IMetadataSaver>(),
  647. GetExports<IExternalId>());
  648. Resolve<ILiveTvManager>().AddParts(GetExports<ILiveTvService>(), GetExports<ITunerHost>(), GetExports<IListingsProvider>());
  649. Resolve<ISubtitleManager>().AddParts(GetExports<ISubtitleProvider>());
  650. Resolve<IChannelManager>().AddParts(GetExports<IChannel>());
  651. Resolve<IMediaSourceManager>().AddParts(GetExports<IMediaSourceProvider>());
  652. Resolve<INotificationManager>().AddParts(GetExports<INotificationService>(), GetExports<INotificationTypeFactory>());
  653. }
  654. /// <summary>
  655. /// Discovers the types.
  656. /// </summary>
  657. protected void DiscoverTypes()
  658. {
  659. Logger.LogInformation("Loading assemblies");
  660. _allConcreteTypes = GetTypes(GetComposablePartAssemblies()).ToArray();
  661. }
  662. private IEnumerable<Type> GetTypes(IEnumerable<Assembly> assemblies)
  663. {
  664. foreach (var ass in assemblies)
  665. {
  666. Type[] exportedTypes;
  667. try
  668. {
  669. exportedTypes = ass.GetExportedTypes();
  670. }
  671. catch (FileNotFoundException ex)
  672. {
  673. Logger.LogError(ex, "Error getting exported types from {Assembly}", ass.FullName);
  674. _pluginManager.FailPlugin(ass);
  675. continue;
  676. }
  677. catch (TypeLoadException ex)
  678. {
  679. Logger.LogError(ex, "Error loading types from {Assembly}.", ass.FullName);
  680. _pluginManager.FailPlugin(ass);
  681. continue;
  682. }
  683. foreach (Type type in exportedTypes)
  684. {
  685. if (type.IsClass && !type.IsAbstract && !type.IsInterface && !type.IsGenericType)
  686. {
  687. yield return type;
  688. }
  689. }
  690. }
  691. }
  692. /// <summary>
  693. /// Called when [configuration updated].
  694. /// </summary>
  695. /// <param name="sender">The sender.</param>
  696. /// <param name="e">The <see cref="EventArgs"/> instance containing the event data.</param>
  697. private void OnConfigurationUpdated(object sender, EventArgs e)
  698. {
  699. var requiresRestart = false;
  700. var networkConfiguration = ConfigurationManager.GetNetworkConfiguration();
  701. // Don't do anything if these haven't been set yet
  702. if (HttpPort != 0 && HttpsPort != 0)
  703. {
  704. // Need to restart if ports have changed
  705. if (networkConfiguration.HttpServerPortNumber != HttpPort
  706. || networkConfiguration.HttpsPortNumber != HttpsPort)
  707. {
  708. if (ConfigurationManager.Configuration.IsPortAuthorized)
  709. {
  710. ConfigurationManager.Configuration.IsPortAuthorized = false;
  711. ConfigurationManager.SaveConfiguration();
  712. requiresRestart = true;
  713. }
  714. }
  715. }
  716. if (ValidateSslCertificate(networkConfiguration))
  717. {
  718. requiresRestart = true;
  719. }
  720. if (requiresRestart)
  721. {
  722. Logger.LogInformation("App needs to be restarted due to configuration change.");
  723. NotifyPendingRestart();
  724. }
  725. }
  726. /// <summary>
  727. /// Validates the SSL certificate.
  728. /// </summary>
  729. /// <param name="networkConfig">The new configuration.</param>
  730. /// <exception cref="FileNotFoundException">The certificate path doesn't exist.</exception>
  731. private bool ValidateSslCertificate(NetworkConfiguration networkConfig)
  732. {
  733. var newPath = networkConfig.CertificatePath;
  734. if (!string.IsNullOrWhiteSpace(newPath)
  735. && !string.Equals(CertificatePath, newPath, StringComparison.Ordinal))
  736. {
  737. if (File.Exists(newPath))
  738. {
  739. return true;
  740. }
  741. throw new FileNotFoundException(
  742. string.Format(
  743. CultureInfo.InvariantCulture,
  744. "Certificate file '{0}' does not exist.",
  745. newPath));
  746. }
  747. return false;
  748. }
  749. /// <summary>
  750. /// Notifies the kernel that a change has been made that requires a restart.
  751. /// </summary>
  752. public void NotifyPendingRestart()
  753. {
  754. Logger.LogInformation("App needs to be restarted.");
  755. var changed = !HasPendingRestart;
  756. HasPendingRestart = true;
  757. if (changed)
  758. {
  759. EventHelper.QueueEventIfNotNull(HasPendingRestartChanged, this, EventArgs.Empty, Logger);
  760. }
  761. }
  762. /// <summary>
  763. /// Restarts this instance.
  764. /// </summary>
  765. public void Restart()
  766. {
  767. if (!CanSelfRestart)
  768. {
  769. throw new PlatformNotSupportedException("The server is unable to self-restart. Please restart manually.");
  770. }
  771. if (IsShuttingDown)
  772. {
  773. return;
  774. }
  775. IsShuttingDown = true;
  776. Task.Run(async () =>
  777. {
  778. try
  779. {
  780. await _sessionManager.SendServerRestartNotification(CancellationToken.None).ConfigureAwait(false);
  781. }
  782. catch (Exception ex)
  783. {
  784. Logger.LogError(ex, "Error sending server restart notification");
  785. }
  786. Logger.LogInformation("Calling RestartInternal");
  787. RestartInternal();
  788. });
  789. }
  790. protected abstract void RestartInternal();
  791. /// <summary>
  792. /// Gets the composable part assemblies.
  793. /// </summary>
  794. /// <returns>IEnumerable{Assembly}.</returns>
  795. protected IEnumerable<Assembly> GetComposablePartAssemblies()
  796. {
  797. foreach (var p in _pluginManager.LoadAssemblies())
  798. {
  799. yield return p;
  800. }
  801. // Include composable parts in the Model assembly
  802. yield return typeof(SystemInfo).Assembly;
  803. // Include composable parts in the Common assembly
  804. yield return typeof(IApplicationHost).Assembly;
  805. // Include composable parts in the Controller assembly
  806. yield return typeof(IServerApplicationHost).Assembly;
  807. // Include composable parts in the Providers assembly
  808. yield return typeof(ProviderManager).Assembly;
  809. // Include composable parts in the Photos assembly
  810. yield return typeof(PhotoProvider).Assembly;
  811. // Emby.Server implementations
  812. yield return typeof(InstallationManager).Assembly;
  813. // MediaEncoding
  814. yield return typeof(MediaBrowser.MediaEncoding.Encoder.MediaEncoder).Assembly;
  815. // Dlna
  816. yield return typeof(DlnaEntryPoint).Assembly;
  817. // Local metadata
  818. yield return typeof(BoxSetXmlSaver).Assembly;
  819. // Notifications
  820. yield return typeof(NotificationManager).Assembly;
  821. // Xbmc
  822. yield return typeof(ArtistNfoProvider).Assembly;
  823. // Network
  824. yield return typeof(NetworkManager).Assembly;
  825. // Hls
  826. yield return typeof(DynamicHlsPlaylistGenerator).Assembly;
  827. foreach (var i in GetAssembliesWithPartsInternal())
  828. {
  829. yield return i;
  830. }
  831. }
  832. protected abstract IEnumerable<Assembly> GetAssembliesWithPartsInternal();
  833. /// <summary>
  834. /// Gets the system status.
  835. /// </summary>
  836. /// <param name="request">Where this request originated.</param>
  837. /// <returns>SystemInfo.</returns>
  838. public SystemInfo GetSystemInfo(HttpRequest request)
  839. {
  840. return new SystemInfo
  841. {
  842. HasPendingRestart = HasPendingRestart,
  843. IsShuttingDown = IsShuttingDown,
  844. Version = ApplicationVersionString,
  845. WebSocketPortNumber = HttpPort,
  846. CompletedInstallations = Resolve<IInstallationManager>().CompletedInstallations.ToArray(),
  847. Id = SystemId,
  848. ProgramDataPath = ApplicationPaths.ProgramDataPath,
  849. WebPath = ApplicationPaths.WebPath,
  850. LogPath = ApplicationPaths.LogDirectoryPath,
  851. ItemsByNamePath = ApplicationPaths.InternalMetadataPath,
  852. InternalMetadataPath = ApplicationPaths.InternalMetadataPath,
  853. CachePath = ApplicationPaths.CachePath,
  854. OperatingSystem = MediaBrowser.Common.System.OperatingSystem.Id.ToString(),
  855. OperatingSystemDisplayName = MediaBrowser.Common.System.OperatingSystem.Name,
  856. CanSelfRestart = CanSelfRestart,
  857. CanLaunchWebBrowser = CanLaunchWebBrowser,
  858. TranscodingTempPath = ConfigurationManager.GetTranscodePath(),
  859. ServerName = FriendlyName,
  860. LocalAddress = GetSmartApiUrl(request),
  861. SupportsLibraryMonitor = true,
  862. SystemArchitecture = RuntimeInformation.OSArchitecture,
  863. PackageName = _startupOptions.PackageName
  864. };
  865. }
  866. public PublicSystemInfo GetPublicSystemInfo(HttpRequest request)
  867. {
  868. return new PublicSystemInfo
  869. {
  870. Version = ApplicationVersionString,
  871. ProductName = ApplicationProductName,
  872. Id = SystemId,
  873. OperatingSystem = MediaBrowser.Common.System.OperatingSystem.Id.ToString(),
  874. ServerName = FriendlyName,
  875. LocalAddress = GetSmartApiUrl(request),
  876. StartupWizardCompleted = ConfigurationManager.CommonConfiguration.IsStartupWizardCompleted
  877. };
  878. }
  879. /// <inheritdoc/>
  880. public string GetSmartApiUrl(IPAddress remoteAddr)
  881. {
  882. // Published server ends with a /
  883. if (!string.IsNullOrEmpty(PublishedServerUrl))
  884. {
  885. // Published server ends with a '/', so we need to remove it.
  886. return PublishedServerUrl.Trim('/');
  887. }
  888. string smart = NetManager.GetBindInterface(remoteAddr, out var port);
  889. return GetLocalApiUrl(smart.Trim('/'), null, port);
  890. }
  891. /// <inheritdoc/>
  892. public string GetSmartApiUrl(HttpRequest request)
  893. {
  894. // Return the host in the HTTP request as the API url
  895. if (ConfigurationManager.GetNetworkConfiguration().EnablePublishedServerUriByRequest)
  896. {
  897. int? requestPort = request.Host.Port;
  898. if ((requestPort == 80 && string.Equals(request.Scheme, "http", StringComparison.OrdinalIgnoreCase)) || (requestPort == 443 && string.Equals(request.Scheme, "https", StringComparison.OrdinalIgnoreCase)))
  899. {
  900. requestPort = -1;
  901. }
  902. return GetLocalApiUrl(request.Host.Host, request.Scheme, requestPort);
  903. }
  904. return GetSmartApiUrl(request.HttpContext.Connection.RemoteIpAddress ?? IPAddress.Loopback);
  905. }
  906. /// <inheritdoc/>
  907. public string GetSmartApiUrl(string hostname)
  908. {
  909. // Published server ends with a /
  910. if (!string.IsNullOrEmpty(PublishedServerUrl))
  911. {
  912. // Published server ends with a '/', so we need to remove it.
  913. return PublishedServerUrl.Trim('/');
  914. }
  915. string smart = NetManager.GetBindInterface(hostname, out var port);
  916. return GetLocalApiUrl(smart.Trim('/'), null, port);
  917. }
  918. /// <inheritdoc/>
  919. public string GetApiUrlForLocalAccess(IPObject hostname = null, bool allowHttps = true)
  920. {
  921. // With an empty source, the port will be null
  922. var smart = NetManager.GetBindInterface(hostname ?? IPHost.None, out _);
  923. var scheme = !allowHttps ? Uri.UriSchemeHttp : null;
  924. int? port = !allowHttps ? HttpPort : null;
  925. return GetLocalApiUrl(smart, scheme, port);
  926. }
  927. /// <inheritdoc/>
  928. public string GetLocalApiUrl(string hostname, string scheme = null, int? port = null)
  929. {
  930. // If the smartAPI doesn't start with http then treat it as a host or ip.
  931. if (hostname.StartsWith("http", StringComparison.OrdinalIgnoreCase))
  932. {
  933. return hostname.TrimEnd('/');
  934. }
  935. // NOTE: If no BaseUrl is set then UriBuilder appends a trailing slash, but if there is no BaseUrl it does
  936. // not. For consistency, always trim the trailing slash.
  937. scheme ??= ListenWithHttps ? Uri.UriSchemeHttps : Uri.UriSchemeHttp;
  938. var isHttps = string.Equals(scheme, Uri.UriSchemeHttps, StringComparison.OrdinalIgnoreCase);
  939. return new UriBuilder
  940. {
  941. Scheme = scheme,
  942. Host = hostname,
  943. Port = port ?? (isHttps ? HttpsPort : HttpPort),
  944. Path = ConfigurationManager.GetNetworkConfiguration().BaseUrl
  945. }.ToString().TrimEnd('/');
  946. }
  947. /// <inheritdoc />
  948. public async Task Shutdown()
  949. {
  950. if (IsShuttingDown)
  951. {
  952. return;
  953. }
  954. IsShuttingDown = true;
  955. try
  956. {
  957. await _sessionManager.SendServerShutdownNotification(CancellationToken.None).ConfigureAwait(false);
  958. }
  959. catch (Exception ex)
  960. {
  961. Logger.LogError(ex, "Error sending server shutdown notification");
  962. }
  963. ShutdownInternal();
  964. }
  965. protected abstract void ShutdownInternal();
  966. public IEnumerable<Assembly> GetApiPluginAssemblies()
  967. {
  968. var assemblies = _allConcreteTypes
  969. .Where(i => typeof(ControllerBase).IsAssignableFrom(i))
  970. .Select(i => i.Assembly)
  971. .Distinct();
  972. foreach (var assembly in assemblies)
  973. {
  974. Logger.LogDebug("Found API endpoints in plugin {Name}", assembly.FullName);
  975. yield return assembly;
  976. }
  977. }
  978. /// <inheritdoc />
  979. public void Dispose()
  980. {
  981. Dispose(true);
  982. GC.SuppressFinalize(this);
  983. }
  984. /// <summary>
  985. /// Releases unmanaged and - optionally - managed resources.
  986. /// </summary>
  987. /// <param name="dispose"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
  988. protected virtual void Dispose(bool dispose)
  989. {
  990. if (_disposed)
  991. {
  992. return;
  993. }
  994. if (dispose)
  995. {
  996. var type = GetType();
  997. Logger.LogInformation("Disposing {Type}", type.Name);
  998. foreach (var (part, _) in _disposableParts)
  999. {
  1000. var partType = part.GetType();
  1001. if (partType == type)
  1002. {
  1003. continue;
  1004. }
  1005. Logger.LogInformation("Disposing {Type}", partType.Name);
  1006. try
  1007. {
  1008. part.Dispose();
  1009. }
  1010. catch (Exception ex)
  1011. {
  1012. Logger.LogError(ex, "Error disposing {Type}", partType.Name);
  1013. }
  1014. }
  1015. _disposableParts.Clear();
  1016. }
  1017. _disposed = true;
  1018. }
  1019. public async ValueTask DisposeAsync()
  1020. {
  1021. await DisposeAsyncCore().ConfigureAwait(false);
  1022. Dispose(false);
  1023. GC.SuppressFinalize(this);
  1024. }
  1025. /// <summary>
  1026. /// Used to perform asynchronous cleanup of managed resources or for cascading calls to <see cref="DisposeAsync"/>.
  1027. /// </summary>
  1028. /// <returns>A ValueTask.</returns>
  1029. protected virtual async ValueTask DisposeAsyncCore()
  1030. {
  1031. var type = GetType();
  1032. Logger.LogInformation("Disposing {Type}", type.Name);
  1033. foreach (var (part, _) in _disposableParts)
  1034. {
  1035. var partType = part.GetType();
  1036. if (partType == type)
  1037. {
  1038. continue;
  1039. }
  1040. Logger.LogInformation("Disposing {Type}", partType.Name);
  1041. try
  1042. {
  1043. part.Dispose();
  1044. }
  1045. catch (Exception ex)
  1046. {
  1047. Logger.LogError(ex, "Error disposing {Type}", partType.Name);
  1048. }
  1049. }
  1050. // used for closing websockets
  1051. foreach (var session in _sessionManager.Sessions)
  1052. {
  1053. await session.DisposeAsync().ConfigureAwait(false);
  1054. }
  1055. }
  1056. }
  1057. }