ApplicationHost.cs 56 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505
  1. #pragma warning disable CS1591
  2. using System;
  3. using System.Collections.Generic;
  4. using System.Diagnostics;
  5. using System.Globalization;
  6. using System.IO;
  7. using System.Linq;
  8. using System.Net;
  9. using System.Reflection;
  10. using System.Runtime.InteropServices;
  11. using System.Security.Cryptography.X509Certificates;
  12. using System.Threading;
  13. using System.Threading.Tasks;
  14. using Emby.Dlna;
  15. using Emby.Dlna.Main;
  16. using Emby.Dlna.Ssdp;
  17. using Emby.Drawing;
  18. using Emby.Notifications;
  19. using Emby.Photos;
  20. using Emby.Server.Implementations.Archiving;
  21. using Emby.Server.Implementations.Channels;
  22. using Emby.Server.Implementations.Collections;
  23. using Emby.Server.Implementations.Configuration;
  24. using Emby.Server.Implementations.Cryptography;
  25. using Emby.Server.Implementations.Data;
  26. using Emby.Server.Implementations.Devices;
  27. using Emby.Server.Implementations.Dto;
  28. using Emby.Server.Implementations.HttpServer.Security;
  29. using Emby.Server.Implementations.IO;
  30. using Emby.Server.Implementations.Library;
  31. using Emby.Server.Implementations.LiveTv;
  32. using Emby.Server.Implementations.Localization;
  33. using Emby.Server.Implementations.Net;
  34. using Emby.Server.Implementations.Playlists;
  35. using Emby.Server.Implementations.Plugins;
  36. using Emby.Server.Implementations.QuickConnect;
  37. using Emby.Server.Implementations.ScheduledTasks;
  38. using Emby.Server.Implementations.Security;
  39. using Emby.Server.Implementations.Serialization;
  40. using Emby.Server.Implementations.Session;
  41. using Emby.Server.Implementations.SyncPlay;
  42. using Emby.Server.Implementations.TV;
  43. using Emby.Server.Implementations.Updates;
  44. using Jellyfin.Api.Helpers;
  45. using Jellyfin.Networking.Configuration;
  46. using Jellyfin.Networking.Manager;
  47. using MediaBrowser.Common;
  48. using MediaBrowser.Common.Configuration;
  49. using MediaBrowser.Common.Events;
  50. using MediaBrowser.Common.Json;
  51. using MediaBrowser.Common.Net;
  52. using MediaBrowser.Common.Plugins;
  53. using MediaBrowser.Common.Updates;
  54. using MediaBrowser.Controller;
  55. using MediaBrowser.Controller.Channels;
  56. using MediaBrowser.Controller.Chapters;
  57. using MediaBrowser.Controller.Collections;
  58. using MediaBrowser.Controller.Configuration;
  59. using MediaBrowser.Controller.Devices;
  60. using MediaBrowser.Controller.Dlna;
  61. using MediaBrowser.Controller.Drawing;
  62. using MediaBrowser.Controller.Dto;
  63. using MediaBrowser.Controller.Entities;
  64. using MediaBrowser.Controller.Library;
  65. using MediaBrowser.Controller.LiveTv;
  66. using MediaBrowser.Controller.MediaEncoding;
  67. using MediaBrowser.Controller.Net;
  68. using MediaBrowser.Controller.Notifications;
  69. using MediaBrowser.Controller.Persistence;
  70. using MediaBrowser.Controller.Playlists;
  71. using MediaBrowser.Controller.Plugins;
  72. using MediaBrowser.Controller.Providers;
  73. using MediaBrowser.Controller.QuickConnect;
  74. using MediaBrowser.Controller.Resolvers;
  75. using MediaBrowser.Controller.Security;
  76. using MediaBrowser.Controller.Session;
  77. using MediaBrowser.Controller.Sorting;
  78. using MediaBrowser.Controller.Subtitles;
  79. using MediaBrowser.Controller.SyncPlay;
  80. using MediaBrowser.Controller.TV;
  81. using MediaBrowser.LocalMetadata.Savers;
  82. using MediaBrowser.MediaEncoding.BdInfo;
  83. using MediaBrowser.Model.Cryptography;
  84. using MediaBrowser.Model.Dlna;
  85. using MediaBrowser.Model.Globalization;
  86. using MediaBrowser.Model.IO;
  87. using MediaBrowser.Model.MediaInfo;
  88. using MediaBrowser.Model.Net;
  89. using MediaBrowser.Model.Serialization;
  90. using MediaBrowser.Model.System;
  91. using MediaBrowser.Model.Tasks;
  92. using MediaBrowser.Providers.Chapters;
  93. using MediaBrowser.Providers.Manager;
  94. using MediaBrowser.Providers.Plugins.Tmdb;
  95. using MediaBrowser.Providers.Subtitles;
  96. using MediaBrowser.XbmcMetadata.Providers;
  97. using Microsoft.AspNetCore.Http;
  98. using Microsoft.AspNetCore.Mvc;
  99. using Microsoft.Extensions.DependencyInjection;
  100. using Microsoft.Extensions.Logging;
  101. using Prometheus.DotNetRuntime;
  102. using JsonSerializer = System.Text.Json.JsonSerializer;
  103. using OperatingSystem = MediaBrowser.Common.System.OperatingSystem;
  104. using WebSocketManager = Emby.Server.Implementations.HttpServer.WebSocketManager;
  105. namespace Emby.Server.Implementations
  106. {
  107. /// <summary>
  108. /// Class CompositionRoot.
  109. /// </summary>
  110. public abstract class ApplicationHost : IServerApplicationHost, IDisposable
  111. {
  112. /// <summary>
  113. /// The environment variable prefixes to log at server startup.
  114. /// </summary>
  115. private static readonly string[] _relevantEnvVarPrefixes = { "JELLYFIN_", "DOTNET_", "ASPNETCORE_" };
  116. private readonly IFileSystem _fileSystemManager;
  117. private readonly IXmlSerializer _xmlSerializer;
  118. private readonly IStartupOptions _startupOptions;
  119. private IMediaEncoder _mediaEncoder;
  120. private ISessionManager _sessionManager;
  121. private string[] _urlPrefixes;
  122. /// <summary>
  123. /// Gets a value indicating whether this instance can self restart.
  124. /// </summary>
  125. public bool CanSelfRestart => _startupOptions.RestartPath != null;
  126. public bool CoreStartupHasCompleted { get; private set; }
  127. public virtual bool CanLaunchWebBrowser
  128. {
  129. get
  130. {
  131. if (!Environment.UserInteractive)
  132. {
  133. return false;
  134. }
  135. if (_startupOptions.IsService)
  136. {
  137. return false;
  138. }
  139. if (OperatingSystem.Id == OperatingSystemId.Windows
  140. || OperatingSystem.Id == OperatingSystemId.Darwin)
  141. {
  142. return true;
  143. }
  144. return false;
  145. }
  146. }
  147. /// <summary>
  148. /// Gets the <see cref="INetworkManager"/> singleton instance.
  149. /// </summary>
  150. public INetworkManager NetManager { get; internal set; }
  151. /// <summary>
  152. /// Occurs when [has pending restart changed].
  153. /// </summary>
  154. public event EventHandler HasPendingRestartChanged;
  155. /// <summary>
  156. /// Gets a value indicating whether this instance has changes that require the entire application to restart.
  157. /// </summary>
  158. /// <value><c>true</c> if this instance has pending application restart; otherwise, <c>false</c>.</value>
  159. public bool HasPendingRestart { get; private set; }
  160. /// <inheritdoc />
  161. public bool IsShuttingDown { get; private set; }
  162. /// <summary>
  163. /// Gets the logger.
  164. /// </summary>
  165. protected ILogger<ApplicationHost> Logger { get; }
  166. protected IServiceCollection ServiceCollection { get; }
  167. private IPlugin[] _plugins;
  168. private IReadOnlyList<LocalPlugin> _pluginsManifests;
  169. /// <summary>
  170. /// Gets the plugins.
  171. /// </summary>
  172. /// <value>The plugins.</value>
  173. public IReadOnlyList<IPlugin> Plugins => _plugins;
  174. /// <summary>
  175. /// Gets the logger factory.
  176. /// </summary>
  177. protected ILoggerFactory LoggerFactory { get; }
  178. /// <summary>
  179. /// Gets or sets the application paths.
  180. /// </summary>
  181. /// <value>The application paths.</value>
  182. protected IServerApplicationPaths ApplicationPaths { get; set; }
  183. /// <summary>
  184. /// Gets or sets all concrete types.
  185. /// </summary>
  186. /// <value>All concrete types.</value>
  187. private Type[] _allConcreteTypes;
  188. /// <summary>
  189. /// The disposable parts.
  190. /// </summary>
  191. private readonly List<IDisposable> _disposableParts = new List<IDisposable>();
  192. /// <summary>
  193. /// Gets or sets the configuration manager.
  194. /// </summary>
  195. /// <value>The configuration manager.</value>
  196. protected IConfigurationManager ConfigurationManager { get; set; }
  197. /// <summary>
  198. /// Gets or sets the service provider.
  199. /// </summary>
  200. public IServiceProvider ServiceProvider { get; set; }
  201. /// <summary>
  202. /// Gets the http port for the webhost.
  203. /// </summary>
  204. public int HttpPort { get; private set; }
  205. /// <summary>
  206. /// Gets the https port for the webhost.
  207. /// </summary>
  208. public int HttpsPort { get; private set; }
  209. /// <summary>
  210. /// Gets the server configuration manager.
  211. /// </summary>
  212. /// <value>The server configuration manager.</value>
  213. public IServerConfigurationManager ServerConfigurationManager => (IServerConfigurationManager)ConfigurationManager;
  214. /// <summary>
  215. /// Initializes a new instance of the <see cref="ApplicationHost"/> class.
  216. /// </summary>
  217. /// <param name="applicationPaths">Instance of the <see cref="IServerApplicationPaths"/> interface.</param>
  218. /// <param name="loggerFactory">Instance of the <see cref="ILoggerFactory"/> interface.</param>
  219. /// <param name="options">Instance of the <see cref="IStartupOptions"/> interface.</param>
  220. /// <param name="fileSystem">Instance of the <see cref="IFileSystem"/> interface.</param>
  221. /// <param name="serviceCollection">Instance of the <see cref="IServiceCollection"/> interface.</param>
  222. public ApplicationHost(
  223. IServerApplicationPaths applicationPaths,
  224. ILoggerFactory loggerFactory,
  225. IStartupOptions options,
  226. IFileSystem fileSystem,
  227. IServiceCollection serviceCollection)
  228. {
  229. _xmlSerializer = new MyXmlSerializer();
  230. ServiceCollection = serviceCollection;
  231. ApplicationPaths = applicationPaths;
  232. LoggerFactory = loggerFactory;
  233. _fileSystemManager = fileSystem;
  234. ConfigurationManager = new ServerConfigurationManager(ApplicationPaths, LoggerFactory, _xmlSerializer, _fileSystemManager);
  235. // Have to migrate settings here as migration subsystem not yet initialised.
  236. MigrateNetworkConfiguration();
  237. // Have to pre-register the NetworkConfigurationFactory, as the configuration sub-system is not yet initialised.
  238. ConfigurationManager.RegisterConfiguration<NetworkConfigurationFactory>();
  239. NetManager = new NetworkManager((IServerConfigurationManager)ConfigurationManager, LoggerFactory.CreateLogger<NetworkManager>());
  240. Logger = LoggerFactory.CreateLogger<ApplicationHost>();
  241. _startupOptions = options;
  242. // Initialize runtime stat collection
  243. if (ServerConfigurationManager.Configuration.EnableMetrics)
  244. {
  245. DotNetRuntimeStatsBuilder.Default().StartCollecting();
  246. }
  247. fileSystem.AddShortcutHandler(new MbLinkShortcutHandler(fileSystem));
  248. ApplicationVersion = typeof(ApplicationHost).Assembly.GetName().Version;
  249. ApplicationVersionString = ApplicationVersion.ToString(3);
  250. ApplicationUserAgent = Name.Replace(' ', '-') + "/" + ApplicationVersionString;
  251. }
  252. /// <summary>
  253. /// Temporary function to migration network settings out of system.xml and into network.xml.
  254. /// TODO: remove at the point when a fixed migration path has been decided upon.
  255. /// </summary>
  256. private void MigrateNetworkConfiguration()
  257. {
  258. string path = Path.Combine(ConfigurationManager.CommonApplicationPaths.ConfigurationDirectoryPath, "network.xml");
  259. if (!File.Exists(path))
  260. {
  261. var networkSettings = new NetworkConfiguration();
  262. ClassMigrationHelper.CopyProperties(ServerConfigurationManager.Configuration, networkSettings);
  263. _xmlSerializer.SerializeToFile(networkSettings, path);
  264. Logger?.LogDebug("Successfully migrated network settings.");
  265. }
  266. }
  267. public string ExpandVirtualPath(string path)
  268. {
  269. var appPaths = ApplicationPaths;
  270. return path.Replace(appPaths.VirtualDataPath, appPaths.DataPath, StringComparison.OrdinalIgnoreCase)
  271. .Replace(appPaths.VirtualInternalMetadataPath, appPaths.InternalMetadataPath, StringComparison.OrdinalIgnoreCase);
  272. }
  273. public string ReverseVirtualPath(string path)
  274. {
  275. var appPaths = ApplicationPaths;
  276. return path.Replace(appPaths.DataPath, appPaths.VirtualDataPath, StringComparison.OrdinalIgnoreCase)
  277. .Replace(appPaths.InternalMetadataPath, appPaths.VirtualInternalMetadataPath, StringComparison.OrdinalIgnoreCase);
  278. }
  279. /// <inheritdoc />
  280. public Version ApplicationVersion { get; }
  281. /// <inheritdoc />
  282. public string ApplicationVersionString { get; }
  283. /// <summary>
  284. /// Gets the current application user agent.
  285. /// </summary>
  286. /// <value>The application user agent.</value>
  287. public string ApplicationUserAgent { get; }
  288. /// <summary>
  289. /// Gets the email address for use within a comment section of a user agent field.
  290. /// Presently used to provide contact information to MusicBrainz service.
  291. /// </summary>
  292. public string ApplicationUserAgentAddress => "team@jellyfin.org";
  293. /// <summary>
  294. /// Gets the current application name.
  295. /// </summary>
  296. /// <value>The application name.</value>
  297. public string ApplicationProductName { get; } = FileVersionInfo.GetVersionInfo(Assembly.GetEntryAssembly().Location).ProductName;
  298. private DeviceId _deviceId;
  299. public string SystemId
  300. {
  301. get
  302. {
  303. if (_deviceId == null)
  304. {
  305. _deviceId = new DeviceId(ApplicationPaths, LoggerFactory);
  306. }
  307. return _deviceId.Value;
  308. }
  309. }
  310. /// <inheritdoc/>
  311. public string Name => ApplicationProductName;
  312. /// <summary>
  313. /// Creates an instance of type and resolves all constructor dependencies.
  314. /// </summary>
  315. /// <param name="type">The type.</param>
  316. /// <returns>System.Object.</returns>
  317. public object CreateInstance(Type type)
  318. => ActivatorUtilities.CreateInstance(ServiceProvider, type);
  319. /// <summary>
  320. /// Creates an instance of type and resolves all constructor dependencies.
  321. /// </summary>
  322. /// /// <typeparam name="T">The type.</typeparam>
  323. /// <returns>T.</returns>
  324. public T CreateInstance<T>()
  325. => ActivatorUtilities.CreateInstance<T>(ServiceProvider);
  326. /// <summary>
  327. /// Creates the instance safe.
  328. /// </summary>
  329. /// <param name="type">The type.</param>
  330. /// <returns>System.Object.</returns>
  331. protected object CreateInstanceSafe(Type type)
  332. {
  333. try
  334. {
  335. Logger.LogDebug("Creating instance of {Type}", type);
  336. return ActivatorUtilities.CreateInstance(ServiceProvider, type);
  337. }
  338. catch (Exception ex)
  339. {
  340. Logger.LogError(ex, "Error creating {Type}", type);
  341. return null;
  342. }
  343. }
  344. /// <summary>
  345. /// Resolves this instance.
  346. /// </summary>
  347. /// <typeparam name="T">The type.</typeparam>
  348. /// <returns>``0.</returns>
  349. public T Resolve<T>() => ServiceProvider.GetService<T>();
  350. /// <summary>
  351. /// Gets the export types.
  352. /// </summary>
  353. /// <typeparam name="T">The type.</typeparam>
  354. /// <returns>IEnumerable{Type}.</returns>
  355. public IEnumerable<Type> GetExportTypes<T>()
  356. {
  357. var currentType = typeof(T);
  358. return _allConcreteTypes.Where(i => currentType.IsAssignableFrom(i));
  359. }
  360. /// <inheritdoc />
  361. public IReadOnlyCollection<T> GetExports<T>(bool manageLifetime = true)
  362. {
  363. // Convert to list so this isn't executed for each iteration
  364. var parts = GetExportTypes<T>()
  365. .Select(CreateInstanceSafe)
  366. .Where(i => i != null)
  367. .Cast<T>()
  368. .ToList();
  369. if (manageLifetime)
  370. {
  371. lock (_disposableParts)
  372. {
  373. _disposableParts.AddRange(parts.OfType<IDisposable>());
  374. }
  375. }
  376. return parts;
  377. }
  378. /// <summary>
  379. /// Runs the startup tasks.
  380. /// </summary>
  381. /// <returns><see cref="Task" />.</returns>
  382. public async Task RunStartupTasksAsync()
  383. {
  384. Logger.LogInformation("Running startup tasks");
  385. Resolve<ITaskManager>().AddTasks(GetExports<IScheduledTask>(false));
  386. ConfigurationManager.ConfigurationUpdated += OnConfigurationUpdated;
  387. ConfigurationManager.NamedConfigurationUpdated += OnConfigurationUpdated;
  388. _mediaEncoder.SetFFmpegPath();
  389. Logger.LogInformation("ServerId: {0}", SystemId);
  390. var entryPoints = GetExports<IServerEntryPoint>();
  391. var stopWatch = new Stopwatch();
  392. stopWatch.Start();
  393. await Task.WhenAll(StartEntryPoints(entryPoints, true)).ConfigureAwait(false);
  394. Logger.LogInformation("Executed all pre-startup entry points in {Elapsed:g}", stopWatch.Elapsed);
  395. Logger.LogInformation("Core startup complete");
  396. CoreStartupHasCompleted = true;
  397. stopWatch.Restart();
  398. await Task.WhenAll(StartEntryPoints(entryPoints, false)).ConfigureAwait(false);
  399. Logger.LogInformation("Executed all post-startup entry points in {Elapsed:g}", stopWatch.Elapsed);
  400. stopWatch.Stop();
  401. }
  402. private IEnumerable<Task> StartEntryPoints(IEnumerable<IServerEntryPoint> entryPoints, bool isBeforeStartup)
  403. {
  404. foreach (var entryPoint in entryPoints)
  405. {
  406. if (isBeforeStartup != (entryPoint is IRunBeforeStartup))
  407. {
  408. continue;
  409. }
  410. Logger.LogDebug("Starting entry point {Type}", entryPoint.GetType());
  411. yield return entryPoint.RunAsync();
  412. }
  413. }
  414. /// <inheritdoc/>
  415. public void Init()
  416. {
  417. var networkConfiguration = ServerConfigurationManager.GetNetworkConfiguration();
  418. HttpPort = networkConfiguration.HttpServerPortNumber;
  419. HttpsPort = networkConfiguration.HttpsPortNumber;
  420. // Safeguard against invalid configuration
  421. if (HttpPort == HttpsPort)
  422. {
  423. HttpPort = NetworkConfiguration.DefaultHttpPort;
  424. HttpsPort = NetworkConfiguration.DefaultHttpsPort;
  425. }
  426. CertificateInfo = new CertificateInfo
  427. {
  428. Path = networkConfiguration.CertificatePath,
  429. Password = networkConfiguration.CertificatePassword
  430. };
  431. Certificate = GetCertificate(CertificateInfo);
  432. DiscoverTypes();
  433. RegisterServices();
  434. RegisterPluginServices();
  435. }
  436. /// <summary>
  437. /// Registers services/resources with the service collection that will be available via DI.
  438. /// </summary>
  439. protected virtual void RegisterServices()
  440. {
  441. ServiceCollection.AddSingleton(_startupOptions);
  442. ServiceCollection.AddMemoryCache();
  443. ServiceCollection.AddSingleton(ConfigurationManager);
  444. ServiceCollection.AddSingleton<IApplicationHost>(this);
  445. ServiceCollection.AddSingleton<IApplicationPaths>(ApplicationPaths);
  446. ServiceCollection.AddSingleton(_fileSystemManager);
  447. ServiceCollection.AddSingleton<TmdbClientManager>();
  448. ServiceCollection.AddSingleton(NetManager);
  449. ServiceCollection.AddSingleton<ITaskManager, TaskManager>();
  450. ServiceCollection.AddSingleton(_xmlSerializer);
  451. ServiceCollection.AddSingleton<IStreamHelper, StreamHelper>();
  452. ServiceCollection.AddSingleton<ICryptoProvider, CryptographyProvider>();
  453. ServiceCollection.AddSingleton<ISocketFactory, SocketFactory>();
  454. ServiceCollection.AddSingleton<IInstallationManager, InstallationManager>();
  455. ServiceCollection.AddSingleton<IZipClient, ZipClient>();
  456. ServiceCollection.AddSingleton<IServerApplicationHost>(this);
  457. ServiceCollection.AddSingleton<IServerApplicationPaths>(ApplicationPaths);
  458. ServiceCollection.AddSingleton(ServerConfigurationManager);
  459. ServiceCollection.AddSingleton<ILocalizationManager, LocalizationManager>();
  460. ServiceCollection.AddSingleton<IBlurayExaminer, BdInfoExaminer>();
  461. ServiceCollection.AddSingleton<IUserDataRepository, SqliteUserDataRepository>();
  462. ServiceCollection.AddSingleton<IUserDataManager, UserDataManager>();
  463. ServiceCollection.AddSingleton<IItemRepository, SqliteItemRepository>();
  464. ServiceCollection.AddSingleton<IAuthenticationRepository, AuthenticationRepository>();
  465. // TODO: Refactor to eliminate the circular dependency here so that Lazy<T> isn't required
  466. ServiceCollection.AddTransient(provider => new Lazy<IDtoService>(provider.GetRequiredService<IDtoService>));
  467. // TODO: Refactor to eliminate the circular dependency here so that Lazy<T> isn't required
  468. ServiceCollection.AddTransient(provider => new Lazy<EncodingHelper>(provider.GetRequiredService<EncodingHelper>));
  469. ServiceCollection.AddSingleton<IMediaEncoder, MediaBrowser.MediaEncoding.Encoder.MediaEncoder>();
  470. // TODO: Refactor to eliminate the circular dependencies here so that Lazy<T> isn't required
  471. ServiceCollection.AddTransient(provider => new Lazy<ILibraryMonitor>(provider.GetRequiredService<ILibraryMonitor>));
  472. ServiceCollection.AddTransient(provider => new Lazy<IProviderManager>(provider.GetRequiredService<IProviderManager>));
  473. ServiceCollection.AddTransient(provider => new Lazy<IUserViewManager>(provider.GetRequiredService<IUserViewManager>));
  474. ServiceCollection.AddSingleton<ILibraryManager, LibraryManager>();
  475. ServiceCollection.AddSingleton<IMusicManager, MusicManager>();
  476. ServiceCollection.AddSingleton<ILibraryMonitor, LibraryMonitor>();
  477. ServiceCollection.AddSingleton<ISearchEngine, SearchEngine>();
  478. ServiceCollection.AddSingleton<IWebSocketManager, WebSocketManager>();
  479. ServiceCollection.AddSingleton<IImageProcessor, ImageProcessor>();
  480. ServiceCollection.AddSingleton<ITVSeriesManager, TVSeriesManager>();
  481. ServiceCollection.AddSingleton<IDeviceManager, DeviceManager>();
  482. ServiceCollection.AddSingleton<IMediaSourceManager, MediaSourceManager>();
  483. ServiceCollection.AddSingleton<ISubtitleManager, SubtitleManager>();
  484. ServiceCollection.AddSingleton<IProviderManager, ProviderManager>();
  485. // TODO: Refactor to eliminate the circular dependency here so that Lazy<T> isn't required
  486. ServiceCollection.AddTransient(provider => new Lazy<ILiveTvManager>(provider.GetRequiredService<ILiveTvManager>));
  487. ServiceCollection.AddSingleton<IDtoService, DtoService>();
  488. ServiceCollection.AddSingleton<IChannelManager, ChannelManager>();
  489. ServiceCollection.AddSingleton<ISessionManager, SessionManager>();
  490. ServiceCollection.AddSingleton<IDlnaManager, DlnaManager>();
  491. ServiceCollection.AddSingleton<ICollectionManager, CollectionManager>();
  492. ServiceCollection.AddSingleton<IPlaylistManager, PlaylistManager>();
  493. ServiceCollection.AddSingleton<ISyncPlayManager, SyncPlayManager>();
  494. ServiceCollection.AddSingleton<LiveTvDtoService>();
  495. ServiceCollection.AddSingleton<ILiveTvManager, LiveTvManager>();
  496. ServiceCollection.AddSingleton<IUserViewManager, UserViewManager>();
  497. ServiceCollection.AddSingleton<INotificationManager, NotificationManager>();
  498. ServiceCollection.AddSingleton<IDeviceDiscovery, DeviceDiscovery>();
  499. ServiceCollection.AddSingleton<IChapterManager, ChapterManager>();
  500. ServiceCollection.AddSingleton<IEncodingManager, MediaEncoder.EncodingManager>();
  501. ServiceCollection.AddSingleton<IAuthorizationContext, AuthorizationContext>();
  502. ServiceCollection.AddSingleton<ISessionContext, SessionContext>();
  503. ServiceCollection.AddSingleton<IAuthService, AuthService>();
  504. ServiceCollection.AddSingleton<IQuickConnect, QuickConnectManager>();
  505. ServiceCollection.AddSingleton<ISubtitleEncoder, MediaBrowser.MediaEncoding.Subtitles.SubtitleEncoder>();
  506. ServiceCollection.AddSingleton<EncodingHelper>();
  507. ServiceCollection.AddSingleton<IAttachmentExtractor, MediaBrowser.MediaEncoding.Attachments.AttachmentExtractor>();
  508. ServiceCollection.AddSingleton<TranscodingJobHelper>();
  509. ServiceCollection.AddScoped<MediaInfoHelper>();
  510. ServiceCollection.AddScoped<AudioHelper>();
  511. ServiceCollection.AddScoped<DynamicHlsHelper>();
  512. }
  513. /// <summary>
  514. /// Create services registered with the service container that need to be initialized at application startup.
  515. /// </summary>
  516. /// <returns>A task representing the service initialization operation.</returns>
  517. public async Task InitializeServices()
  518. {
  519. var localizationManager = (LocalizationManager)Resolve<ILocalizationManager>();
  520. await localizationManager.LoadAll().ConfigureAwait(false);
  521. _mediaEncoder = Resolve<IMediaEncoder>();
  522. _sessionManager = Resolve<ISessionManager>();
  523. ((AuthenticationRepository)Resolve<IAuthenticationRepository>()).Initialize();
  524. SetStaticProperties();
  525. var userDataRepo = (SqliteUserDataRepository)Resolve<IUserDataRepository>();
  526. ((SqliteItemRepository)Resolve<IItemRepository>()).Initialize(userDataRepo, Resolve<IUserManager>());
  527. FindParts();
  528. }
  529. public static void LogEnvironmentInfo(ILogger logger, IApplicationPaths appPaths)
  530. {
  531. // Distinct these to prevent users from reporting problems that aren't actually problems
  532. var commandLineArgs = Environment
  533. .GetCommandLineArgs()
  534. .Distinct();
  535. // Get all relevant environment variables
  536. var allEnvVars = Environment.GetEnvironmentVariables();
  537. var relevantEnvVars = new Dictionary<object, object>();
  538. foreach (var key in allEnvVars.Keys)
  539. {
  540. if (_relevantEnvVarPrefixes.Any(prefix => key.ToString().StartsWith(prefix, StringComparison.OrdinalIgnoreCase)))
  541. {
  542. relevantEnvVars.Add(key, allEnvVars[key]);
  543. }
  544. }
  545. logger.LogInformation("Environment Variables: {EnvVars}", relevantEnvVars);
  546. logger.LogInformation("Arguments: {Args}", commandLineArgs);
  547. logger.LogInformation("Operating system: {OS}", OperatingSystem.Name);
  548. logger.LogInformation("Architecture: {Architecture}", RuntimeInformation.OSArchitecture);
  549. logger.LogInformation("64-Bit Process: {Is64Bit}", Environment.Is64BitProcess);
  550. logger.LogInformation("User Interactive: {IsUserInteractive}", Environment.UserInteractive);
  551. logger.LogInformation("Processor count: {ProcessorCount}", Environment.ProcessorCount);
  552. logger.LogInformation("Program data path: {ProgramDataPath}", appPaths.ProgramDataPath);
  553. logger.LogInformation("Web resources path: {WebPath}", appPaths.WebPath);
  554. logger.LogInformation("Application directory: {ApplicationPath}", appPaths.ProgramSystemPath);
  555. }
  556. private X509Certificate2 GetCertificate(CertificateInfo info)
  557. {
  558. var certificateLocation = info?.Path;
  559. if (string.IsNullOrWhiteSpace(certificateLocation))
  560. {
  561. return null;
  562. }
  563. try
  564. {
  565. if (!File.Exists(certificateLocation))
  566. {
  567. return null;
  568. }
  569. // Don't use an empty string password
  570. var password = string.IsNullOrWhiteSpace(info.Password) ? null : info.Password;
  571. var localCert = new X509Certificate2(certificateLocation, password, X509KeyStorageFlags.UserKeySet);
  572. // localCert.PrivateKey = PrivateKey.CreateFromFile(pvk_file).RSA;
  573. if (!localCert.HasPrivateKey)
  574. {
  575. Logger.LogError("No private key included in SSL cert {CertificateLocation}.", certificateLocation);
  576. return null;
  577. }
  578. return localCert;
  579. }
  580. catch (Exception ex)
  581. {
  582. Logger.LogError(ex, "Error loading cert from {CertificateLocation}", certificateLocation);
  583. return null;
  584. }
  585. }
  586. /// <summary>
  587. /// Dirty hacks.
  588. /// </summary>
  589. private void SetStaticProperties()
  590. {
  591. // For now there's no real way to inject these properly
  592. BaseItem.Logger = Resolve<ILogger<BaseItem>>();
  593. BaseItem.ConfigurationManager = ServerConfigurationManager;
  594. BaseItem.LibraryManager = Resolve<ILibraryManager>();
  595. BaseItem.ProviderManager = Resolve<IProviderManager>();
  596. BaseItem.LocalizationManager = Resolve<ILocalizationManager>();
  597. BaseItem.ItemRepository = Resolve<IItemRepository>();
  598. BaseItem.FileSystem = _fileSystemManager;
  599. BaseItem.UserDataManager = Resolve<IUserDataManager>();
  600. BaseItem.ChannelManager = Resolve<IChannelManager>();
  601. Video.LiveTvManager = Resolve<ILiveTvManager>();
  602. Folder.UserViewManager = Resolve<IUserViewManager>();
  603. UserView.TVSeriesManager = Resolve<ITVSeriesManager>();
  604. UserView.CollectionManager = Resolve<ICollectionManager>();
  605. BaseItem.MediaSourceManager = Resolve<IMediaSourceManager>();
  606. CollectionFolder.XmlSerializer = _xmlSerializer;
  607. CollectionFolder.ApplicationHost = this;
  608. }
  609. /// <summary>
  610. /// Finds plugin components and register them with the appropriate services.
  611. /// </summary>
  612. private void FindParts()
  613. {
  614. if (!ServerConfigurationManager.Configuration.IsPortAuthorized)
  615. {
  616. ServerConfigurationManager.Configuration.IsPortAuthorized = true;
  617. ConfigurationManager.SaveConfiguration();
  618. }
  619. ConfigurationManager.AddParts(GetExports<IConfigurationFactory>());
  620. _plugins = GetExports<IPlugin>()
  621. .Where(i => i != null)
  622. .ToArray();
  623. if (Plugins != null)
  624. {
  625. foreach (var plugin in Plugins)
  626. {
  627. if (_pluginsManifests != null && plugin is IPluginAssembly assemblyPlugin)
  628. {
  629. // Ensure the version number matches the Plugin Manifest information.
  630. foreach (var item in _pluginsManifests)
  631. {
  632. if (Path.GetDirectoryName(plugin.AssemblyFilePath).Equals(item.Path, StringComparison.OrdinalIgnoreCase))
  633. {
  634. // Update version number to that of the manifest.
  635. assemblyPlugin.SetAttributes(
  636. plugin.AssemblyFilePath,
  637. Path.Combine(ApplicationPaths.PluginsPath, Path.GetFileNameWithoutExtension(plugin.AssemblyFilePath)),
  638. item.Version);
  639. break;
  640. }
  641. }
  642. }
  643. Logger.LogInformation("Loaded plugin: {PluginName} {PluginVersion}", plugin.Name, plugin.Version);
  644. }
  645. }
  646. _urlPrefixes = GetUrlPrefixes().ToArray();
  647. Resolve<ILibraryManager>().AddParts(
  648. GetExports<IResolverIgnoreRule>(),
  649. GetExports<IItemResolver>(),
  650. GetExports<IIntroProvider>(),
  651. GetExports<IBaseItemComparer>(),
  652. GetExports<ILibraryPostScanTask>());
  653. Resolve<IProviderManager>().AddParts(
  654. GetExports<IImageProvider>(),
  655. GetExports<IMetadataService>(),
  656. GetExports<IMetadataProvider>(),
  657. GetExports<IMetadataSaver>(),
  658. GetExports<IExternalId>());
  659. Resolve<ILiveTvManager>().AddParts(GetExports<ILiveTvService>(), GetExports<ITunerHost>(), GetExports<IListingsProvider>());
  660. Resolve<ISubtitleManager>().AddParts(GetExports<ISubtitleProvider>());
  661. Resolve<IChannelManager>().AddParts(GetExports<IChannel>());
  662. Resolve<IMediaSourceManager>().AddParts(GetExports<IMediaSourceProvider>());
  663. Resolve<INotificationManager>().AddParts(GetExports<INotificationService>(), GetExports<INotificationTypeFactory>());
  664. }
  665. /// <summary>
  666. /// Discovers the types.
  667. /// </summary>
  668. protected void DiscoverTypes()
  669. {
  670. Logger.LogInformation("Loading assemblies");
  671. _allConcreteTypes = GetTypes(GetComposablePartAssemblies()).ToArray();
  672. }
  673. private void RegisterPluginServices()
  674. {
  675. foreach (var pluginServiceRegistrator in GetExportTypes<IPluginServiceRegistrator>())
  676. {
  677. try
  678. {
  679. var instance = (IPluginServiceRegistrator)Activator.CreateInstance(pluginServiceRegistrator);
  680. instance.RegisterServices(ServiceCollection);
  681. }
  682. catch (Exception ex)
  683. {
  684. Logger.LogError(ex, "Error registering plugin services from {Assembly}.", pluginServiceRegistrator.Assembly);
  685. }
  686. }
  687. }
  688. private IEnumerable<Type> GetTypes(IEnumerable<Assembly> assemblies)
  689. {
  690. foreach (var ass in assemblies)
  691. {
  692. Type[] exportedTypes;
  693. try
  694. {
  695. exportedTypes = ass.GetExportedTypes();
  696. }
  697. catch (FileNotFoundException ex)
  698. {
  699. Logger.LogError(ex, "Error getting exported types from {Assembly}", ass.FullName);
  700. continue;
  701. }
  702. catch (TypeLoadException ex)
  703. {
  704. Logger.LogError(ex, "Error loading types from {Assembly}.", ass.FullName);
  705. continue;
  706. }
  707. foreach (Type type in exportedTypes)
  708. {
  709. if (type.IsClass && !type.IsAbstract && !type.IsInterface && !type.IsGenericType)
  710. {
  711. yield return type;
  712. }
  713. }
  714. }
  715. }
  716. private CertificateInfo CertificateInfo { get; set; }
  717. public X509Certificate2 Certificate { get; private set; }
  718. private IEnumerable<string> GetUrlPrefixes()
  719. {
  720. var hosts = new[] { "+" };
  721. return hosts.SelectMany(i =>
  722. {
  723. var prefixes = new List<string>
  724. {
  725. "http://" + i + ":" + HttpPort + "/"
  726. };
  727. if (CertificateInfo != null)
  728. {
  729. prefixes.Add("https://" + i + ":" + HttpsPort + "/");
  730. }
  731. return prefixes;
  732. });
  733. }
  734. /// <summary>
  735. /// Called when [configuration updated].
  736. /// </summary>
  737. /// <param name="sender">The sender.</param>
  738. /// <param name="e">The <see cref="EventArgs"/> instance containing the event data.</param>
  739. protected void OnConfigurationUpdated(object sender, EventArgs e)
  740. {
  741. var requiresRestart = false;
  742. var networkConfiguration = ServerConfigurationManager.GetNetworkConfiguration();
  743. // Don't do anything if these haven't been set yet
  744. if (HttpPort != 0 && HttpsPort != 0)
  745. {
  746. // Need to restart if ports have changed
  747. if (networkConfiguration.HttpServerPortNumber != HttpPort ||
  748. networkConfiguration.HttpsPortNumber != HttpsPort)
  749. {
  750. if (ServerConfigurationManager.Configuration.IsPortAuthorized)
  751. {
  752. ServerConfigurationManager.Configuration.IsPortAuthorized = false;
  753. ServerConfigurationManager.SaveConfiguration();
  754. requiresRestart = true;
  755. }
  756. }
  757. }
  758. if (!_urlPrefixes.SequenceEqual(GetUrlPrefixes(), StringComparer.OrdinalIgnoreCase))
  759. {
  760. requiresRestart = true;
  761. }
  762. if (ValidateSslCertificate(networkConfiguration))
  763. {
  764. requiresRestart = true;
  765. }
  766. if (requiresRestart)
  767. {
  768. Logger.LogInformation("App needs to be restarted due to configuration change.");
  769. NotifyPendingRestart();
  770. }
  771. }
  772. /// <summary>
  773. /// Validates the SSL certificate.
  774. /// </summary>
  775. /// <param name="networkConfig">The new configuration.</param>
  776. /// <exception cref="FileNotFoundException">The certificate path doesn't exist.</exception>
  777. private bool ValidateSslCertificate(NetworkConfiguration networkConfig)
  778. {
  779. var newPath = networkConfig.CertificatePath;
  780. if (!string.IsNullOrWhiteSpace(newPath)
  781. && !string.Equals(CertificateInfo?.Path, newPath, StringComparison.Ordinal))
  782. {
  783. if (File.Exists(newPath))
  784. {
  785. return true;
  786. }
  787. throw new FileNotFoundException(
  788. string.Format(
  789. CultureInfo.InvariantCulture,
  790. "Certificate file '{0}' does not exist.",
  791. newPath));
  792. }
  793. return false;
  794. }
  795. /// <summary>
  796. /// Notifies that the kernel that a change has been made that requires a restart.
  797. /// </summary>
  798. public void NotifyPendingRestart()
  799. {
  800. Logger.LogInformation("App needs to be restarted.");
  801. var changed = !HasPendingRestart;
  802. HasPendingRestart = true;
  803. if (changed)
  804. {
  805. EventHelper.QueueEventIfNotNull(HasPendingRestartChanged, this, EventArgs.Empty, Logger);
  806. }
  807. }
  808. /// <summary>
  809. /// Restarts this instance.
  810. /// </summary>
  811. public void Restart()
  812. {
  813. if (!CanSelfRestart)
  814. {
  815. throw new PlatformNotSupportedException("The server is unable to self-restart. Please restart manually.");
  816. }
  817. if (IsShuttingDown)
  818. {
  819. return;
  820. }
  821. IsShuttingDown = true;
  822. Task.Run(async () =>
  823. {
  824. try
  825. {
  826. await _sessionManager.SendServerRestartNotification(CancellationToken.None).ConfigureAwait(false);
  827. }
  828. catch (Exception ex)
  829. {
  830. Logger.LogError(ex, "Error sending server restart notification");
  831. }
  832. Logger.LogInformation("Calling RestartInternal");
  833. RestartInternal();
  834. });
  835. }
  836. protected abstract void RestartInternal();
  837. /// <inheritdoc/>
  838. public IEnumerable<LocalPlugin> GetLocalPlugins(string path, bool cleanup = true)
  839. {
  840. var minimumVersion = new Version(0, 0, 0, 1);
  841. var versions = new List<LocalPlugin>();
  842. if (!Directory.Exists(path))
  843. {
  844. // Plugin path doesn't exist, don't try to enumerate subfolders.
  845. return Enumerable.Empty<LocalPlugin>();
  846. }
  847. var directories = Directory.EnumerateDirectories(path, "*.*", SearchOption.TopDirectoryOnly);
  848. foreach (var dir in directories)
  849. {
  850. try
  851. {
  852. var metafile = Path.Combine(dir, "meta.json");
  853. if (File.Exists(metafile))
  854. {
  855. var jsonString = File.ReadAllText(metafile);
  856. var manifest = JsonSerializer.Deserialize<PluginManifest>(jsonString, JsonDefaults.GetOptions());
  857. if (!Version.TryParse(manifest.TargetAbi, out var targetAbi))
  858. {
  859. targetAbi = minimumVersion;
  860. }
  861. if (!Version.TryParse(manifest.Version, out var version))
  862. {
  863. version = minimumVersion;
  864. }
  865. if (ApplicationVersion >= targetAbi)
  866. {
  867. // Only load Plugins if the plugin is built for this version or below.
  868. versions.Add(new LocalPlugin(manifest.Guid, manifest.Name, version, dir));
  869. }
  870. }
  871. else
  872. {
  873. // No metafile, so lets see if the folder is versioned.
  874. metafile = dir.Split(Path.DirectorySeparatorChar, StringSplitOptions.RemoveEmptyEntries)[^1];
  875. int versionIndex = dir.LastIndexOf('_');
  876. if (versionIndex != -1 && Version.TryParse(dir.AsSpan()[(versionIndex + 1)..], out Version parsedVersion))
  877. {
  878. // Versioned folder.
  879. versions.Add(new LocalPlugin(Guid.Empty, metafile, parsedVersion, dir));
  880. }
  881. else
  882. {
  883. // Un-versioned folder - Add it under the path name and version 0.0.0.1.
  884. versions.Add(new LocalPlugin(Guid.Empty, metafile, minimumVersion, dir));
  885. }
  886. }
  887. }
  888. catch
  889. {
  890. continue;
  891. }
  892. }
  893. string lastName = string.Empty;
  894. versions.Sort(LocalPlugin.Compare);
  895. // Traverse backwards through the list.
  896. // The first item will be the latest version.
  897. for (int x = versions.Count - 1; x >= 0; x--)
  898. {
  899. if (!string.Equals(lastName, versions[x].Name, StringComparison.OrdinalIgnoreCase))
  900. {
  901. versions[x].DllFiles.AddRange(Directory.EnumerateFiles(versions[x].Path, "*.dll", SearchOption.AllDirectories));
  902. lastName = versions[x].Name;
  903. continue;
  904. }
  905. if (!string.IsNullOrEmpty(lastName) && cleanup)
  906. {
  907. // Attempt a cleanup of old folders.
  908. try
  909. {
  910. Logger.LogDebug("Deleting {Path}", versions[x].Path);
  911. Directory.Delete(versions[x].Path, true);
  912. }
  913. catch (Exception e)
  914. {
  915. Logger.LogWarning(e, "Unable to delete {Path}", versions[x].Path);
  916. }
  917. versions.RemoveAt(x);
  918. }
  919. }
  920. return versions;
  921. }
  922. /// <summary>
  923. /// Gets the composable part assemblies.
  924. /// </summary>
  925. /// <returns>IEnumerable{Assembly}.</returns>
  926. protected IEnumerable<Assembly> GetComposablePartAssemblies()
  927. {
  928. if (Directory.Exists(ApplicationPaths.PluginsPath))
  929. {
  930. _pluginsManifests = GetLocalPlugins(ApplicationPaths.PluginsPath).ToList();
  931. foreach (var plugin in _pluginsManifests)
  932. {
  933. foreach (var file in plugin.DllFiles)
  934. {
  935. Assembly plugAss;
  936. try
  937. {
  938. plugAss = Assembly.LoadFrom(file);
  939. }
  940. catch (FileLoadException ex)
  941. {
  942. Logger.LogError(ex, "Failed to load assembly {Path}", file);
  943. continue;
  944. }
  945. Logger.LogInformation("Loaded assembly {Assembly} from {Path}", plugAss.FullName, file);
  946. yield return plugAss;
  947. }
  948. }
  949. }
  950. // Include composable parts in the Model assembly
  951. yield return typeof(SystemInfo).Assembly;
  952. // Include composable parts in the Common assembly
  953. yield return typeof(IApplicationHost).Assembly;
  954. // Include composable parts in the Controller assembly
  955. yield return typeof(IServerApplicationHost).Assembly;
  956. // Include composable parts in the Providers assembly
  957. yield return typeof(ProviderUtils).Assembly;
  958. // Include composable parts in the Photos assembly
  959. yield return typeof(PhotoProvider).Assembly;
  960. // Emby.Server implementations
  961. yield return typeof(InstallationManager).Assembly;
  962. // MediaEncoding
  963. yield return typeof(MediaBrowser.MediaEncoding.Encoder.MediaEncoder).Assembly;
  964. // Dlna
  965. yield return typeof(DlnaEntryPoint).Assembly;
  966. // Local metadata
  967. yield return typeof(BoxSetXmlSaver).Assembly;
  968. // Notifications
  969. yield return typeof(NotificationManager).Assembly;
  970. // Xbmc
  971. yield return typeof(ArtistNfoProvider).Assembly;
  972. // Network
  973. yield return typeof(NetworkManager).Assembly;
  974. foreach (var i in GetAssembliesWithPartsInternal())
  975. {
  976. yield return i;
  977. }
  978. }
  979. protected abstract IEnumerable<Assembly> GetAssembliesWithPartsInternal();
  980. /// <summary>
  981. /// Gets the system status.
  982. /// </summary>
  983. /// <param name="source">Where this request originated.</param>
  984. /// <returns>SystemInfo.</returns>
  985. public SystemInfo GetSystemInfo(IPAddress source)
  986. {
  987. return new SystemInfo
  988. {
  989. HasPendingRestart = HasPendingRestart,
  990. IsShuttingDown = IsShuttingDown,
  991. Version = ApplicationVersionString,
  992. WebSocketPortNumber = HttpPort,
  993. CompletedInstallations = Resolve<IInstallationManager>().CompletedInstallations.ToArray(),
  994. Id = SystemId,
  995. ProgramDataPath = ApplicationPaths.ProgramDataPath,
  996. WebPath = ApplicationPaths.WebPath,
  997. LogPath = ApplicationPaths.LogDirectoryPath,
  998. ItemsByNamePath = ApplicationPaths.InternalMetadataPath,
  999. InternalMetadataPath = ApplicationPaths.InternalMetadataPath,
  1000. CachePath = ApplicationPaths.CachePath,
  1001. OperatingSystem = OperatingSystem.Id.ToString(),
  1002. OperatingSystemDisplayName = OperatingSystem.Name,
  1003. CanSelfRestart = CanSelfRestart,
  1004. CanLaunchWebBrowser = CanLaunchWebBrowser,
  1005. HasUpdateAvailable = HasUpdateAvailable,
  1006. TranscodingTempPath = ConfigurationManager.GetTranscodePath(),
  1007. ServerName = FriendlyName,
  1008. LocalAddress = GetSmartApiUrl(source),
  1009. SupportsLibraryMonitor = true,
  1010. EncoderLocation = _mediaEncoder.EncoderLocation,
  1011. SystemArchitecture = RuntimeInformation.OSArchitecture,
  1012. PackageName = _startupOptions.PackageName
  1013. };
  1014. }
  1015. public IEnumerable<WakeOnLanInfo> GetWakeOnLanInfo()
  1016. => NetManager.GetMacAddresses()
  1017. .Select(i => new WakeOnLanInfo(i))
  1018. .ToList();
  1019. public PublicSystemInfo GetPublicSystemInfo(IPAddress source)
  1020. {
  1021. return new PublicSystemInfo
  1022. {
  1023. Version = ApplicationVersionString,
  1024. ProductName = ApplicationProductName,
  1025. Id = SystemId,
  1026. OperatingSystem = OperatingSystem.Id.ToString(),
  1027. ServerName = FriendlyName,
  1028. LocalAddress = GetSmartApiUrl(source),
  1029. StartupWizardCompleted = ConfigurationManager.CommonConfiguration.IsStartupWizardCompleted
  1030. };
  1031. }
  1032. /// <inheritdoc/>
  1033. public bool ListenWithHttps => Certificate != null && ServerConfigurationManager.GetNetworkConfiguration().EnableHttps;
  1034. /// <inheritdoc/>
  1035. public string GetSmartApiUrl(IPAddress ipAddress, int? port = null)
  1036. {
  1037. // Published server ends with a /
  1038. if (_startupOptions.PublishedServerUrl != null)
  1039. {
  1040. // Published server ends with a '/', so we need to remove it.
  1041. return _startupOptions.PublishedServerUrl.ToString().Trim('/');
  1042. }
  1043. string smart = NetManager.GetBindInterface(ipAddress, out port);
  1044. // If the smartAPI doesn't start with http then treat it as a host or ip.
  1045. if (smart.StartsWith("http", StringComparison.OrdinalIgnoreCase))
  1046. {
  1047. return smart.Trim('/');
  1048. }
  1049. return GetLocalApiUrl(smart.Trim('/'), null, port);
  1050. }
  1051. /// <inheritdoc/>
  1052. public string GetSmartApiUrl(HttpRequest request, int? port = null)
  1053. {
  1054. // Published server ends with a /
  1055. if (_startupOptions.PublishedServerUrl != null)
  1056. {
  1057. // Published server ends with a '/', so we need to remove it.
  1058. return _startupOptions.PublishedServerUrl.ToString().Trim('/');
  1059. }
  1060. string smart = NetManager.GetBindInterface(request, out port);
  1061. // If the smartAPI doesn't start with http then treat it as a host or ip.
  1062. if (smart.StartsWith("http", StringComparison.OrdinalIgnoreCase))
  1063. {
  1064. return smart.Trim('/');
  1065. }
  1066. return GetLocalApiUrl(smart.Trim('/'), request.Scheme, port);
  1067. }
  1068. /// <inheritdoc/>
  1069. public string GetSmartApiUrl(string hostname, int? port = null)
  1070. {
  1071. // Published server ends with a /
  1072. if (_startupOptions.PublishedServerUrl != null)
  1073. {
  1074. // Published server ends with a '/', so we need to remove it.
  1075. return _startupOptions.PublishedServerUrl.ToString().Trim('/');
  1076. }
  1077. string smart = NetManager.GetBindInterface(hostname, out port);
  1078. // If the smartAPI doesn't start with http then treat it as a host or ip.
  1079. if (smart.StartsWith("http", StringComparison.OrdinalIgnoreCase))
  1080. {
  1081. return smart.Trim('/');
  1082. }
  1083. return GetLocalApiUrl(smart.Trim('/'), null, port);
  1084. }
  1085. /// <inheritdoc/>
  1086. public string GetLoopbackHttpApiUrl()
  1087. {
  1088. if (NetManager.IsIP6Enabled)
  1089. {
  1090. return GetLocalApiUrl("::1", Uri.UriSchemeHttp, HttpPort);
  1091. }
  1092. return GetLocalApiUrl("127.0.0.1", Uri.UriSchemeHttp, HttpPort);
  1093. }
  1094. /// <inheritdoc/>
  1095. public string GetLocalApiUrl(string host, string scheme = null, int? port = null)
  1096. {
  1097. // NOTE: If no BaseUrl is set then UriBuilder appends a trailing slash, but if there is no BaseUrl it does
  1098. // not. For consistency, always trim the trailing slash.
  1099. return new UriBuilder
  1100. {
  1101. Scheme = scheme ?? (ListenWithHttps ? Uri.UriSchemeHttps : Uri.UriSchemeHttp),
  1102. Host = host,
  1103. Port = port ?? (ListenWithHttps ? HttpsPort : HttpPort),
  1104. Path = ServerConfigurationManager.GetNetworkConfiguration().BaseUrl
  1105. }.ToString().TrimEnd('/');
  1106. }
  1107. public string FriendlyName =>
  1108. string.IsNullOrEmpty(ServerConfigurationManager.Configuration.ServerName)
  1109. ? Environment.MachineName
  1110. : ServerConfigurationManager.Configuration.ServerName;
  1111. /// <summary>
  1112. /// Shuts down.
  1113. /// </summary>
  1114. public async Task Shutdown()
  1115. {
  1116. if (IsShuttingDown)
  1117. {
  1118. return;
  1119. }
  1120. IsShuttingDown = true;
  1121. try
  1122. {
  1123. await _sessionManager.SendServerShutdownNotification(CancellationToken.None).ConfigureAwait(false);
  1124. }
  1125. catch (Exception ex)
  1126. {
  1127. Logger.LogError(ex, "Error sending server shutdown notification");
  1128. }
  1129. ShutdownInternal();
  1130. }
  1131. protected abstract void ShutdownInternal();
  1132. public event EventHandler HasUpdateAvailableChanged;
  1133. private bool _hasUpdateAvailable;
  1134. public bool HasUpdateAvailable
  1135. {
  1136. get => _hasUpdateAvailable;
  1137. set
  1138. {
  1139. var fireEvent = value && !_hasUpdateAvailable;
  1140. _hasUpdateAvailable = value;
  1141. if (fireEvent)
  1142. {
  1143. HasUpdateAvailableChanged?.Invoke(this, EventArgs.Empty);
  1144. }
  1145. }
  1146. }
  1147. /// <summary>
  1148. /// Removes the plugin.
  1149. /// </summary>
  1150. /// <param name="plugin">The plugin.</param>
  1151. public void RemovePlugin(IPlugin plugin)
  1152. {
  1153. var list = _plugins.ToList();
  1154. list.Remove(plugin);
  1155. _plugins = list.ToArray();
  1156. }
  1157. public IEnumerable<Assembly> GetApiPluginAssemblies()
  1158. {
  1159. var assemblies = _allConcreteTypes
  1160. .Where(i => typeof(ControllerBase).IsAssignableFrom(i))
  1161. .Select(i => i.Assembly)
  1162. .Distinct();
  1163. foreach (var assembly in assemblies)
  1164. {
  1165. Logger.LogDebug("Found API endpoints in plugin {Name}", assembly.FullName);
  1166. yield return assembly;
  1167. }
  1168. }
  1169. public virtual void LaunchUrl(string url)
  1170. {
  1171. if (!CanLaunchWebBrowser)
  1172. {
  1173. throw new NotSupportedException();
  1174. }
  1175. var process = new Process
  1176. {
  1177. StartInfo = new ProcessStartInfo
  1178. {
  1179. FileName = url,
  1180. UseShellExecute = true,
  1181. ErrorDialog = false
  1182. },
  1183. EnableRaisingEvents = true
  1184. };
  1185. process.Exited += (sender, args) => ((Process)sender).Dispose();
  1186. try
  1187. {
  1188. process.Start();
  1189. }
  1190. catch (Exception ex)
  1191. {
  1192. Logger.LogError(ex, "Error launching url: {url}", url);
  1193. throw;
  1194. }
  1195. }
  1196. private bool _disposed = false;
  1197. /// <summary>
  1198. /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
  1199. /// </summary>
  1200. public void Dispose()
  1201. {
  1202. Dispose(true);
  1203. GC.SuppressFinalize(this);
  1204. }
  1205. /// <summary>
  1206. /// Releases unmanaged and - optionally - managed resources.
  1207. /// </summary>
  1208. /// <param name="dispose"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
  1209. protected virtual void Dispose(bool dispose)
  1210. {
  1211. if (_disposed)
  1212. {
  1213. return;
  1214. }
  1215. if (dispose)
  1216. {
  1217. var type = GetType();
  1218. Logger.LogInformation("Disposing {Type}", type.Name);
  1219. var parts = _disposableParts.Distinct().Where(i => i.GetType() != type).ToList();
  1220. _disposableParts.Clear();
  1221. foreach (var part in parts)
  1222. {
  1223. Logger.LogInformation("Disposing {Type}", part.GetType().Name);
  1224. try
  1225. {
  1226. part.Dispose();
  1227. }
  1228. catch (Exception ex)
  1229. {
  1230. Logger.LogError(ex, "Error disposing {Type}", part.GetType().Name);
  1231. }
  1232. }
  1233. }
  1234. _disposed = true;
  1235. }
  1236. }
  1237. internal class CertificateInfo
  1238. {
  1239. public string Path { get; set; }
  1240. public string Password { get; set; }
  1241. }
  1242. }