ApplicationHost.cs 65 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769
  1. #pragma warning disable CS1591
  2. using System;
  3. using System.Collections.Concurrent;
  4. using System.Collections.Generic;
  5. using System.Diagnostics;
  6. using System.Globalization;
  7. using System.IO;
  8. using System.Linq;
  9. using System.Net;
  10. using System.Net.Http;
  11. using System.Net.Sockets;
  12. using System.Reflection;
  13. using System.Runtime.InteropServices;
  14. using System.Security.Cryptography.X509Certificates;
  15. using System.Text;
  16. using System.Threading;
  17. using System.Threading.Tasks;
  18. using Emby.Dlna;
  19. using Emby.Dlna.Main;
  20. using Emby.Dlna.Ssdp;
  21. using Emby.Drawing;
  22. using Emby.Notifications;
  23. using Emby.Photos;
  24. using Emby.Server.Implementations.Activity;
  25. using Emby.Server.Implementations.Archiving;
  26. using Emby.Server.Implementations.Channels;
  27. using Emby.Server.Implementations.Collections;
  28. using Emby.Server.Implementations.Configuration;
  29. using Emby.Server.Implementations.Cryptography;
  30. using Emby.Server.Implementations.Data;
  31. using Emby.Server.Implementations.Devices;
  32. using Emby.Server.Implementations.Diagnostics;
  33. using Emby.Server.Implementations.Dto;
  34. using Emby.Server.Implementations.HttpServer;
  35. using Emby.Server.Implementations.HttpServer.Security;
  36. using Emby.Server.Implementations.IO;
  37. using Emby.Server.Implementations.Library;
  38. using Emby.Server.Implementations.LiveTv;
  39. using Emby.Server.Implementations.Localization;
  40. using Emby.Server.Implementations.Net;
  41. using Emby.Server.Implementations.Playlists;
  42. using Emby.Server.Implementations.ScheduledTasks;
  43. using Emby.Server.Implementations.Security;
  44. using Emby.Server.Implementations.Serialization;
  45. using Emby.Server.Implementations.Services;
  46. using Emby.Server.Implementations.Session;
  47. using Emby.Server.Implementations.SocketSharp;
  48. using Emby.Server.Implementations.TV;
  49. using Emby.Server.Implementations.Updates;
  50. using MediaBrowser.Api;
  51. using MediaBrowser.Common;
  52. using MediaBrowser.Common.Configuration;
  53. using MediaBrowser.Common.Events;
  54. using MediaBrowser.Common.Net;
  55. using MediaBrowser.Common.Plugins;
  56. using MediaBrowser.Common.Updates;
  57. using MediaBrowser.Controller;
  58. using MediaBrowser.Controller.Authentication;
  59. using MediaBrowser.Controller.Channels;
  60. using MediaBrowser.Controller.Chapters;
  61. using MediaBrowser.Controller.Collections;
  62. using MediaBrowser.Controller.Configuration;
  63. using MediaBrowser.Controller.Devices;
  64. using MediaBrowser.Controller.Dlna;
  65. using MediaBrowser.Controller.Drawing;
  66. using MediaBrowser.Controller.Dto;
  67. using MediaBrowser.Controller.Entities;
  68. using MediaBrowser.Controller.Library;
  69. using MediaBrowser.Controller.LiveTv;
  70. using MediaBrowser.Controller.MediaEncoding;
  71. using MediaBrowser.Controller.Net;
  72. using MediaBrowser.Controller.Notifications;
  73. using MediaBrowser.Controller.Persistence;
  74. using MediaBrowser.Controller.Playlists;
  75. using MediaBrowser.Controller.Plugins;
  76. using MediaBrowser.Controller.Providers;
  77. using MediaBrowser.Controller.Resolvers;
  78. using MediaBrowser.Controller.Security;
  79. using MediaBrowser.Controller.Session;
  80. using MediaBrowser.Controller.Sorting;
  81. using MediaBrowser.Controller.Subtitles;
  82. using MediaBrowser.Controller.TV;
  83. using MediaBrowser.LocalMetadata.Savers;
  84. using MediaBrowser.MediaEncoding.BdInfo;
  85. using MediaBrowser.Model.Activity;
  86. using MediaBrowser.Model.Configuration;
  87. using MediaBrowser.Model.Cryptography;
  88. using MediaBrowser.Model.Diagnostics;
  89. using MediaBrowser.Model.Dlna;
  90. using MediaBrowser.Model.Events;
  91. using MediaBrowser.Model.Globalization;
  92. using MediaBrowser.Model.IO;
  93. using MediaBrowser.Model.MediaInfo;
  94. using MediaBrowser.Model.Net;
  95. using MediaBrowser.Model.Serialization;
  96. using MediaBrowser.Model.Services;
  97. using MediaBrowser.Model.System;
  98. using MediaBrowser.Model.Tasks;
  99. using MediaBrowser.Model.Updates;
  100. using MediaBrowser.Providers.Chapters;
  101. using MediaBrowser.Providers.Manager;
  102. using MediaBrowser.Providers.Plugins.TheTvdb;
  103. using MediaBrowser.Providers.Subtitles;
  104. using MediaBrowser.WebDashboard.Api;
  105. using MediaBrowser.XbmcMetadata.Providers;
  106. using Microsoft.AspNetCore.Http;
  107. using Microsoft.AspNetCore.Http.Extensions;
  108. using Microsoft.Extensions.Configuration;
  109. using Microsoft.Extensions.DependencyInjection;
  110. using Microsoft.Extensions.Logging;
  111. using OperatingSystem = MediaBrowser.Common.System.OperatingSystem;
  112. namespace Emby.Server.Implementations
  113. {
  114. /// <summary>
  115. /// Class CompositionRoot.
  116. /// </summary>
  117. public abstract class ApplicationHost : IServerApplicationHost, IDisposable
  118. {
  119. private SqliteUserRepository _userRepository;
  120. private SqliteDisplayPreferencesRepository _displayPreferencesRepository;
  121. /// <summary>
  122. /// Gets a value indicating whether this instance can self restart.
  123. /// </summary>
  124. /// <value><c>true</c> if this instance can self restart; otherwise, <c>false</c>.</value>
  125. public abstract bool CanSelfRestart { get; }
  126. public virtual bool CanLaunchWebBrowser
  127. {
  128. get
  129. {
  130. if (!Environment.UserInteractive)
  131. {
  132. return false;
  133. }
  134. if (StartupOptions.IsService)
  135. {
  136. return false;
  137. }
  138. if (OperatingSystem.Id == OperatingSystemId.Windows
  139. || OperatingSystem.Id == OperatingSystemId.Darwin)
  140. {
  141. return true;
  142. }
  143. return false;
  144. }
  145. }
  146. /// <summary>
  147. /// Occurs when [has pending restart changed].
  148. /// </summary>
  149. public event EventHandler HasPendingRestartChanged;
  150. /// <summary>
  151. /// Gets a value indicating whether this instance has changes that require the entire application to restart.
  152. /// </summary>
  153. /// <value><c>true</c> if this instance has pending application restart; otherwise, <c>false</c>.</value>
  154. public bool HasPendingRestart { get; private set; }
  155. /// <inheritdoc />
  156. public bool IsShuttingDown { get; private set; }
  157. /// <summary>
  158. /// Gets the logger.
  159. /// </summary>
  160. protected ILogger Logger { get; }
  161. private IPlugin[] _plugins;
  162. /// <summary>
  163. /// Gets the plugins.
  164. /// </summary>
  165. /// <value>The plugins.</value>
  166. public IReadOnlyList<IPlugin> Plugins => _plugins;
  167. /// <summary>
  168. /// Gets the logger factory.
  169. /// </summary>
  170. protected ILoggerFactory LoggerFactory { get; }
  171. /// <summary>
  172. /// Gets or sets the application paths.
  173. /// </summary>
  174. /// <value>The application paths.</value>
  175. protected ServerApplicationPaths ApplicationPaths { get; set; }
  176. /// <summary>
  177. /// Gets or sets all concrete types.
  178. /// </summary>
  179. /// <value>All concrete types.</value>
  180. private Type[] _allConcreteTypes;
  181. /// <summary>
  182. /// The disposable parts.
  183. /// </summary>
  184. private readonly List<IDisposable> _disposableParts = new List<IDisposable>();
  185. /// <summary>
  186. /// Gets the configuration manager.
  187. /// </summary>
  188. /// <value>The configuration manager.</value>
  189. protected IConfigurationManager ConfigurationManager { get; set; }
  190. public IFileSystem FileSystemManager { get; set; }
  191. /// <inheritdoc />
  192. public PackageVersionClass SystemUpdateLevel
  193. {
  194. get
  195. {
  196. #if BETA
  197. return PackageVersionClass.Beta;
  198. #else
  199. return PackageVersionClass.Release;
  200. #endif
  201. }
  202. }
  203. /// <summary>
  204. /// Gets or sets the service provider.
  205. /// </summary>
  206. public IServiceProvider ServiceProvider { get; set; }
  207. /// <summary>
  208. /// Gets the http port for the webhost.
  209. /// </summary>
  210. public int HttpPort { get; private set; }
  211. /// <summary>
  212. /// Gets the https port for the webhost.
  213. /// </summary>
  214. public int HttpsPort { get; private set; }
  215. /// <summary>
  216. /// Gets the server configuration manager.
  217. /// </summary>
  218. /// <value>The server configuration manager.</value>
  219. public IServerConfigurationManager ServerConfigurationManager => (IServerConfigurationManager)ConfigurationManager;
  220. /// <summary>
  221. /// Gets or sets the user manager.
  222. /// </summary>
  223. /// <value>The user manager.</value>
  224. public IUserManager UserManager { get; set; }
  225. /// <summary>
  226. /// Gets or sets the library manager.
  227. /// </summary>
  228. /// <value>The library manager.</value>
  229. internal ILibraryManager LibraryManager { get; set; }
  230. /// <summary>
  231. /// Gets or sets the directory watchers.
  232. /// </summary>
  233. /// <value>The directory watchers.</value>
  234. private ILibraryMonitor LibraryMonitor { get; set; }
  235. /// <summary>
  236. /// Gets or sets the provider manager.
  237. /// </summary>
  238. /// <value>The provider manager.</value>
  239. private IProviderManager ProviderManager { get; set; }
  240. /// <summary>
  241. /// Gets or sets the HTTP server.
  242. /// </summary>
  243. /// <value>The HTTP server.</value>
  244. private IHttpServer HttpServer { get; set; }
  245. private IDtoService DtoService { get; set; }
  246. public IImageProcessor ImageProcessor { get; set; }
  247. /// <summary>
  248. /// Gets or sets the media encoder.
  249. /// </summary>
  250. /// <value>The media encoder.</value>
  251. private IMediaEncoder MediaEncoder { get; set; }
  252. private ISessionManager SessionManager { get; set; }
  253. private ILiveTvManager LiveTvManager { get; set; }
  254. public LocalizationManager LocalizationManager { get; set; }
  255. private IChannelManager ChannelManager { get; set; }
  256. /// <summary>
  257. /// Gets or sets the user data repository.
  258. /// </summary>
  259. /// <value>The user data repository.</value>
  260. private IUserDataManager UserDataManager { get; set; }
  261. internal SqliteItemRepository ItemRepository { get; set; }
  262. private INotificationManager NotificationManager { get; set; }
  263. private ISubtitleManager SubtitleManager { get; set; }
  264. private IDeviceManager DeviceManager { get; set; }
  265. internal IUserViewManager UserViewManager { get; set; }
  266. private IAuthenticationRepository AuthenticationRepository { get; set; }
  267. private ITVSeriesManager TVSeriesManager { get; set; }
  268. private ICollectionManager CollectionManager { get; set; }
  269. private IMediaSourceManager MediaSourceManager { get; set; }
  270. /// <summary>
  271. /// Gets the installation manager.
  272. /// </summary>
  273. /// <value>The installation manager.</value>
  274. protected IInstallationManager InstallationManager { get; private set; }
  275. public IStartupOptions StartupOptions { get; }
  276. internal IImageEncoder ImageEncoder { get; private set; }
  277. protected IProcessFactory ProcessFactory { get; private set; }
  278. protected readonly IXmlSerializer XmlSerializer;
  279. protected ISocketFactory SocketFactory { get; private set; }
  280. protected ITaskManager TaskManager { get; private set; }
  281. public IHttpClient HttpClient { get; private set; }
  282. protected INetworkManager NetworkManager { get; set; }
  283. public IJsonSerializer JsonSerializer { get; private set; }
  284. protected IIsoManager IsoManager { get; private set; }
  285. /// <summary>
  286. /// Initializes a new instance of the <see cref="ApplicationHost" /> class.
  287. /// </summary>
  288. public ApplicationHost(
  289. ServerApplicationPaths applicationPaths,
  290. ILoggerFactory loggerFactory,
  291. IStartupOptions options,
  292. IFileSystem fileSystem,
  293. IImageEncoder imageEncoder,
  294. INetworkManager networkManager)
  295. {
  296. XmlSerializer = new MyXmlSerializer();
  297. NetworkManager = networkManager;
  298. networkManager.LocalSubnetsFn = GetConfiguredLocalSubnets;
  299. ApplicationPaths = applicationPaths;
  300. LoggerFactory = loggerFactory;
  301. FileSystemManager = fileSystem;
  302. ConfigurationManager = new ServerConfigurationManager(ApplicationPaths, LoggerFactory, XmlSerializer, FileSystemManager);
  303. Logger = LoggerFactory.CreateLogger("App");
  304. StartupOptions = options;
  305. ImageEncoder = imageEncoder;
  306. fileSystem.AddShortcutHandler(new MbLinkShortcutHandler(fileSystem));
  307. NetworkManager.NetworkChanged += OnNetworkChanged;
  308. }
  309. public string ExpandVirtualPath(string path)
  310. {
  311. var appPaths = ApplicationPaths;
  312. return path.Replace(appPaths.VirtualDataPath, appPaths.DataPath, StringComparison.OrdinalIgnoreCase)
  313. .Replace(appPaths.VirtualInternalMetadataPath, appPaths.InternalMetadataPath, StringComparison.OrdinalIgnoreCase);
  314. }
  315. public string ReverseVirtualPath(string path)
  316. {
  317. var appPaths = ApplicationPaths;
  318. return path.Replace(appPaths.DataPath, appPaths.VirtualDataPath, StringComparison.OrdinalIgnoreCase)
  319. .Replace(appPaths.InternalMetadataPath, appPaths.VirtualInternalMetadataPath, StringComparison.OrdinalIgnoreCase);
  320. }
  321. private string[] GetConfiguredLocalSubnets()
  322. {
  323. return ServerConfigurationManager.Configuration.LocalNetworkSubnets;
  324. }
  325. private void OnNetworkChanged(object sender, EventArgs e)
  326. {
  327. _validAddressResults.Clear();
  328. }
  329. /// <inheritdoc />
  330. public Version ApplicationVersion { get; } = typeof(ApplicationHost).Assembly.GetName().Version;
  331. /// <inheritdoc />
  332. public string ApplicationVersionString { get; } = typeof(ApplicationHost).Assembly.GetName().Version.ToString(3);
  333. /// <summary>
  334. /// Gets the current application user agent.
  335. /// </summary>
  336. /// <value>The application user agent.</value>
  337. public string ApplicationUserAgent => Name.Replace(' ', '-') + "/" + ApplicationVersionString;
  338. /// <summary>
  339. /// Gets the email address for use within a comment section of a user agent field.
  340. /// Presently used to provide contact information to MusicBrainz service.
  341. /// </summary>
  342. public string ApplicationUserAgentAddress { get; } = "team@jellyfin.org";
  343. /// <summary>
  344. /// Gets the current application name.
  345. /// </summary>
  346. /// <value>The application name.</value>
  347. public string ApplicationProductName { get; } = FileVersionInfo.GetVersionInfo(Assembly.GetEntryAssembly().Location).ProductName;
  348. private DeviceId _deviceId;
  349. public string SystemId
  350. {
  351. get
  352. {
  353. if (_deviceId == null)
  354. {
  355. _deviceId = new DeviceId(ApplicationPaths, LoggerFactory);
  356. }
  357. return _deviceId.Value;
  358. }
  359. }
  360. /// <summary>
  361. /// Gets the name.
  362. /// </summary>
  363. /// <value>The name.</value>
  364. public string Name => ApplicationProductName;
  365. /// <summary>
  366. /// Creates an instance of type and resolves all constructor dependencies.
  367. /// </summary>
  368. /// <param name="type">The type.</param>
  369. /// <returns>System.Object.</returns>
  370. public object CreateInstance(Type type)
  371. => ActivatorUtilities.CreateInstance(ServiceProvider, type);
  372. /// <summary>
  373. /// Creates an instance of type and resolves all constructor dependencies.
  374. /// </summary>
  375. /// /// <typeparam name="T">The type.</typeparam>
  376. /// <returns>T.</returns>
  377. public T CreateInstance<T>()
  378. => ActivatorUtilities.CreateInstance<T>(ServiceProvider);
  379. /// <summary>
  380. /// Creates the instance safe.
  381. /// </summary>
  382. /// <param name="type">The type.</param>
  383. /// <returns>System.Object.</returns>
  384. protected object CreateInstanceSafe(Type type)
  385. {
  386. try
  387. {
  388. Logger.LogDebug("Creating instance of {Type}", type);
  389. return ActivatorUtilities.CreateInstance(ServiceProvider, type);
  390. }
  391. catch (Exception ex)
  392. {
  393. Logger.LogError(ex, "Error creating {Type}", type);
  394. return null;
  395. }
  396. }
  397. /// <summary>
  398. /// Resolves this instance.
  399. /// </summary>
  400. /// <typeparam name="T">The type</typeparam>
  401. /// <returns>``0.</returns>
  402. public T Resolve<T>() => ServiceProvider.GetService<T>();
  403. /// <summary>
  404. /// Gets the export types.
  405. /// </summary>
  406. /// <typeparam name="T">The type.</typeparam>
  407. /// <returns>IEnumerable{Type}.</returns>
  408. public IEnumerable<Type> GetExportTypes<T>()
  409. {
  410. var currentType = typeof(T);
  411. return _allConcreteTypes.Where(i => currentType.IsAssignableFrom(i));
  412. }
  413. /// <inheritdoc />
  414. public IReadOnlyCollection<T> GetExports<T>(bool manageLifetime = true)
  415. {
  416. // Convert to list so this isn't executed for each iteration
  417. var parts = GetExportTypes<T>()
  418. .Select(CreateInstanceSafe)
  419. .Where(i => i != null)
  420. .Cast<T>()
  421. .ToList();
  422. if (manageLifetime)
  423. {
  424. lock (_disposableParts)
  425. {
  426. _disposableParts.AddRange(parts.OfType<IDisposable>());
  427. }
  428. }
  429. return parts;
  430. }
  431. /// <summary>
  432. /// Runs the startup tasks.
  433. /// </summary>
  434. /// <returns><see cref="Task" />.</returns>
  435. public async Task RunStartupTasksAsync()
  436. {
  437. Logger.LogInformation("Running startup tasks");
  438. Resolve<ITaskManager>().AddTasks(GetExports<IScheduledTask>(false));
  439. ConfigurationManager.ConfigurationUpdated += OnConfigurationUpdated;
  440. MediaEncoder.SetFFmpegPath();
  441. Logger.LogInformation("ServerId: {0}", SystemId);
  442. var entryPoints = GetExports<IServerEntryPoint>();
  443. var stopWatch = new Stopwatch();
  444. stopWatch.Start();
  445. await Task.WhenAll(StartEntryPoints(entryPoints, true)).ConfigureAwait(false);
  446. Logger.LogInformation("Executed all pre-startup entry points in {Elapsed:g}", stopWatch.Elapsed);
  447. Logger.LogInformation("Core startup complete");
  448. HttpServer.GlobalResponse = null;
  449. stopWatch.Restart();
  450. await Task.WhenAll(StartEntryPoints(entryPoints, false)).ConfigureAwait(false);
  451. Logger.LogInformation("Executed all post-startup entry points in {Elapsed:g}", stopWatch.Elapsed);
  452. stopWatch.Stop();
  453. }
  454. private IEnumerable<Task> StartEntryPoints(IEnumerable<IServerEntryPoint> entryPoints, bool isBeforeStartup)
  455. {
  456. foreach (var entryPoint in entryPoints)
  457. {
  458. if (isBeforeStartup != (entryPoint is IRunBeforeStartup))
  459. {
  460. continue;
  461. }
  462. Logger.LogDebug("Starting entry point {Type}", entryPoint.GetType());
  463. yield return entryPoint.RunAsync();
  464. }
  465. }
  466. /// <inheritdoc/>
  467. public async Task InitAsync(IServiceCollection serviceCollection, IConfiguration startupConfig)
  468. {
  469. HttpPort = ServerConfigurationManager.Configuration.HttpServerPortNumber;
  470. HttpsPort = ServerConfigurationManager.Configuration.HttpsPortNumber;
  471. // Safeguard against invalid configuration
  472. if (HttpPort == HttpsPort)
  473. {
  474. HttpPort = ServerConfiguration.DefaultHttpPort;
  475. HttpsPort = ServerConfiguration.DefaultHttpsPort;
  476. }
  477. JsonSerializer = new JsonSerializer();
  478. if (Plugins != null)
  479. {
  480. var pluginBuilder = new StringBuilder();
  481. foreach (var plugin in Plugins)
  482. {
  483. pluginBuilder.AppendLine(
  484. string.Format(
  485. CultureInfo.InvariantCulture,
  486. "{0} {1}",
  487. plugin.Name,
  488. plugin.Version));
  489. }
  490. Logger.LogInformation("Plugins: {Plugins}", pluginBuilder.ToString());
  491. }
  492. DiscoverTypes();
  493. await RegisterServices(serviceCollection, startupConfig).ConfigureAwait(false);
  494. }
  495. public async Task ExecuteWebsocketHandlerAsync(HttpContext context, Func<Task> next)
  496. {
  497. if (!context.WebSockets.IsWebSocketRequest)
  498. {
  499. await next().ConfigureAwait(false);
  500. return;
  501. }
  502. await HttpServer.ProcessWebSocketRequest(context).ConfigureAwait(false);
  503. }
  504. public async Task ExecuteHttpHandlerAsync(HttpContext context, Func<Task> next)
  505. {
  506. if (context.WebSockets.IsWebSocketRequest)
  507. {
  508. await next().ConfigureAwait(false);
  509. return;
  510. }
  511. var request = context.Request;
  512. var response = context.Response;
  513. var localPath = context.Request.Path.ToString();
  514. var req = new WebSocketSharpRequest(request, response, request.Path, LoggerFactory.CreateLogger<WebSocketSharpRequest>());
  515. await HttpServer.RequestHandler(req, request.GetDisplayUrl(), request.Host.ToString(), localPath, context.RequestAborted).ConfigureAwait(false);
  516. }
  517. /// <summary>
  518. /// Registers services/resources with the service collection that will be available via DI.
  519. /// </summary>
  520. protected async Task RegisterServices(IServiceCollection serviceCollection, IConfiguration startupConfig)
  521. {
  522. serviceCollection.AddMemoryCache();
  523. serviceCollection.AddSingleton(ConfigurationManager);
  524. serviceCollection.AddSingleton<IApplicationHost>(this);
  525. serviceCollection.AddSingleton<IApplicationPaths>(ApplicationPaths);
  526. serviceCollection.AddSingleton(JsonSerializer);
  527. // TODO: Support for injecting ILogger should be deprecated in favour of ILogger<T> and this removed
  528. serviceCollection.AddSingleton<ILogger>(Logger);
  529. serviceCollection.AddSingleton(FileSystemManager);
  530. serviceCollection.AddSingleton<TvdbClientManager>();
  531. HttpClient = new HttpClientManager.HttpClientManager(
  532. ApplicationPaths,
  533. LoggerFactory.CreateLogger<HttpClientManager.HttpClientManager>(),
  534. FileSystemManager,
  535. () => ApplicationUserAgent);
  536. serviceCollection.AddSingleton(HttpClient);
  537. serviceCollection.AddSingleton(NetworkManager);
  538. IsoManager = new IsoManager();
  539. serviceCollection.AddSingleton(IsoManager);
  540. TaskManager = new TaskManager(ApplicationPaths, JsonSerializer, LoggerFactory, FileSystemManager);
  541. serviceCollection.AddSingleton(TaskManager);
  542. serviceCollection.AddSingleton(XmlSerializer);
  543. ProcessFactory = new ProcessFactory();
  544. serviceCollection.AddSingleton(ProcessFactory);
  545. serviceCollection.AddSingleton(typeof(IStreamHelper), typeof(StreamHelper));
  546. var cryptoProvider = new CryptographyProvider();
  547. serviceCollection.AddSingleton<ICryptoProvider>(cryptoProvider);
  548. SocketFactory = new SocketFactory();
  549. serviceCollection.AddSingleton(SocketFactory);
  550. serviceCollection.AddSingleton(typeof(IInstallationManager), typeof(InstallationManager));
  551. serviceCollection.AddSingleton(typeof(IZipClient), typeof(ZipClient));
  552. serviceCollection.AddSingleton(typeof(IHttpResultFactory), typeof(HttpResultFactory));
  553. serviceCollection.AddSingleton<IServerApplicationHost>(this);
  554. serviceCollection.AddSingleton<IServerApplicationPaths>(ApplicationPaths);
  555. serviceCollection.AddSingleton(ServerConfigurationManager);
  556. LocalizationManager = new LocalizationManager(ServerConfigurationManager, JsonSerializer, LoggerFactory.CreateLogger<LocalizationManager>());
  557. await LocalizationManager.LoadAll().ConfigureAwait(false);
  558. serviceCollection.AddSingleton<ILocalizationManager>(LocalizationManager);
  559. serviceCollection.AddSingleton<IBlurayExaminer>(new BdInfoExaminer(FileSystemManager));
  560. UserDataManager = new UserDataManager(LoggerFactory, ServerConfigurationManager, () => UserManager);
  561. serviceCollection.AddSingleton(UserDataManager);
  562. _displayPreferencesRepository = new SqliteDisplayPreferencesRepository(
  563. LoggerFactory.CreateLogger<SqliteDisplayPreferencesRepository>(),
  564. ApplicationPaths,
  565. FileSystemManager);
  566. serviceCollection.AddSingleton<IDisplayPreferencesRepository>(_displayPreferencesRepository);
  567. ItemRepository = new SqliteItemRepository(ServerConfigurationManager, this, LoggerFactory.CreateLogger<SqliteItemRepository>(), LocalizationManager);
  568. serviceCollection.AddSingleton<IItemRepository>(ItemRepository);
  569. AuthenticationRepository = GetAuthenticationRepository();
  570. serviceCollection.AddSingleton(AuthenticationRepository);
  571. _userRepository = GetUserRepository();
  572. UserManager = new UserManager(
  573. LoggerFactory.CreateLogger<UserManager>(),
  574. _userRepository,
  575. XmlSerializer,
  576. NetworkManager,
  577. () => ImageProcessor,
  578. () => DtoService,
  579. this,
  580. JsonSerializer,
  581. FileSystemManager,
  582. cryptoProvider);
  583. serviceCollection.AddSingleton(UserManager);
  584. MediaEncoder = new MediaBrowser.MediaEncoding.Encoder.MediaEncoder(
  585. LoggerFactory.CreateLogger<MediaBrowser.MediaEncoding.Encoder.MediaEncoder>(),
  586. ServerConfigurationManager,
  587. FileSystemManager,
  588. ProcessFactory,
  589. LocalizationManager,
  590. ServiceProvider.GetRequiredService<ISubtitleEncoder>,
  591. startupConfig,
  592. StartupOptions.FFmpegPath);
  593. serviceCollection.AddSingleton(MediaEncoder);
  594. LibraryManager = new LibraryManager(this, LoggerFactory, TaskManager, UserManager, ServerConfigurationManager, UserDataManager, () => LibraryMonitor, FileSystemManager, () => ProviderManager, () => UserViewManager, MediaEncoder);
  595. serviceCollection.AddSingleton(LibraryManager);
  596. var musicManager = new MusicManager(LibraryManager);
  597. serviceCollection.AddSingleton<IMusicManager>(musicManager);
  598. LibraryMonitor = new LibraryMonitor(LoggerFactory, LibraryManager, ServerConfigurationManager, FileSystemManager);
  599. serviceCollection.AddSingleton(LibraryMonitor);
  600. serviceCollection.AddSingleton<ISearchEngine>(new SearchEngine(LoggerFactory, LibraryManager, UserManager));
  601. CertificateInfo = GetCertificateInfo(true);
  602. Certificate = GetCertificate(CertificateInfo);
  603. serviceCollection.AddSingleton<ServiceController>();
  604. serviceCollection.AddSingleton<IHttpListener, WebSocketSharpListener>();
  605. serviceCollection.AddSingleton<IHttpServer, HttpListenerHost>();
  606. ImageProcessor = new ImageProcessor(LoggerFactory.CreateLogger<ImageProcessor>(), ServerConfigurationManager.ApplicationPaths, FileSystemManager, ImageEncoder, () => LibraryManager, () => MediaEncoder);
  607. serviceCollection.AddSingleton(ImageProcessor);
  608. TVSeriesManager = new TVSeriesManager(UserManager, UserDataManager, LibraryManager, ServerConfigurationManager);
  609. serviceCollection.AddSingleton(TVSeriesManager);
  610. DeviceManager = new DeviceManager(AuthenticationRepository, JsonSerializer, LibraryManager, LocalizationManager, UserManager, FileSystemManager, LibraryMonitor, ServerConfigurationManager);
  611. serviceCollection.AddSingleton(DeviceManager);
  612. MediaSourceManager = new MediaSourceManager(ItemRepository, ApplicationPaths, LocalizationManager, UserManager, LibraryManager, LoggerFactory, JsonSerializer, FileSystemManager, UserDataManager, () => MediaEncoder);
  613. serviceCollection.AddSingleton(MediaSourceManager);
  614. SubtitleManager = new SubtitleManager(LoggerFactory, FileSystemManager, LibraryMonitor, MediaSourceManager, LocalizationManager);
  615. serviceCollection.AddSingleton(SubtitleManager);
  616. ProviderManager = new ProviderManager(HttpClient, SubtitleManager, ServerConfigurationManager, LibraryMonitor, LoggerFactory, FileSystemManager, ApplicationPaths, () => LibraryManager, JsonSerializer);
  617. serviceCollection.AddSingleton(ProviderManager);
  618. DtoService = new DtoService(LoggerFactory, LibraryManager, UserDataManager, ItemRepository, ImageProcessor, ProviderManager, this, () => MediaSourceManager, () => LiveTvManager);
  619. serviceCollection.AddSingleton(DtoService);
  620. ChannelManager = new ChannelManager(UserManager, DtoService, LibraryManager, LoggerFactory, ServerConfigurationManager, FileSystemManager, UserDataManager, JsonSerializer, ProviderManager);
  621. serviceCollection.AddSingleton(ChannelManager);
  622. SessionManager = new SessionManager(
  623. LoggerFactory.CreateLogger<SessionManager>(),
  624. UserDataManager,
  625. LibraryManager,
  626. UserManager,
  627. musicManager,
  628. DtoService,
  629. ImageProcessor,
  630. this,
  631. AuthenticationRepository,
  632. DeviceManager,
  633. MediaSourceManager);
  634. serviceCollection.AddSingleton(SessionManager);
  635. serviceCollection.AddSingleton<IDlnaManager>(
  636. new DlnaManager(XmlSerializer, FileSystemManager, ApplicationPaths, LoggerFactory, JsonSerializer, this));
  637. CollectionManager = new CollectionManager(LibraryManager, ApplicationPaths, LocalizationManager, FileSystemManager, LibraryMonitor, LoggerFactory, ProviderManager);
  638. serviceCollection.AddSingleton(CollectionManager);
  639. serviceCollection.AddSingleton(typeof(IPlaylistManager), typeof(PlaylistManager));
  640. LiveTvManager = new LiveTvManager(this, ServerConfigurationManager, LoggerFactory, ItemRepository, ImageProcessor, UserDataManager, DtoService, UserManager, LibraryManager, TaskManager, LocalizationManager, JsonSerializer, FileSystemManager, () => ChannelManager);
  641. serviceCollection.AddSingleton(LiveTvManager);
  642. UserViewManager = new UserViewManager(LibraryManager, LocalizationManager, UserManager, ChannelManager, LiveTvManager, ServerConfigurationManager);
  643. serviceCollection.AddSingleton(UserViewManager);
  644. NotificationManager = new NotificationManager(
  645. LoggerFactory.CreateLogger<NotificationManager>(),
  646. UserManager,
  647. ServerConfigurationManager);
  648. serviceCollection.AddSingleton(NotificationManager);
  649. serviceCollection.AddSingleton<IDeviceDiscovery, DeviceDiscovery>();
  650. serviceCollection.AddSingleton<IChapterManager, ChapterManager>();
  651. serviceCollection.AddSingleton<IEncodingManager, MediaEncoder.EncodingManager>();
  652. serviceCollection.AddSingleton<IActivityRepository, ActivityRepository>();
  653. serviceCollection.AddSingleton<IActivityManager, ActivityManager>();
  654. serviceCollection.AddSingleton<IAuthorizationContext, AuthorizationContext>();
  655. serviceCollection.AddSingleton<ISessionContext, SessionContext>();
  656. serviceCollection.AddSingleton<IAuthService, AuthService>();
  657. serviceCollection.AddSingleton<ISubtitleEncoder, MediaBrowser.MediaEncoding.Subtitles.SubtitleEncoder>();
  658. serviceCollection.AddSingleton<IResourceFileManager, ResourceFileManager>();
  659. serviceCollection.AddSingleton<EncodingHelper>();
  660. serviceCollection.AddSingleton<IAttachmentExtractor, MediaBrowser.MediaEncoding.Attachments.AttachmentExtractor>();
  661. }
  662. /// <summary>
  663. /// Create services registered with the service container that need to be initialized at application startup.
  664. /// </summary>
  665. public void InitializeServices()
  666. {
  667. HttpServer = Resolve<IHttpServer>();
  668. ((ActivityRepository)Resolve<IActivityRepository>()).Initialize();
  669. _displayPreferencesRepository.Initialize();
  670. var userDataRepo = new SqliteUserDataRepository(LoggerFactory.CreateLogger<SqliteUserDataRepository>(), ApplicationPaths);
  671. SetStaticProperties();
  672. ((UserManager)UserManager).Initialize();
  673. ((UserDataManager)UserDataManager).Repository = userDataRepo;
  674. ItemRepository.Initialize(userDataRepo, UserManager);
  675. ((LibraryManager)LibraryManager).ItemRepository = ItemRepository;
  676. }
  677. public static void LogEnvironmentInfo(ILogger logger, IApplicationPaths appPaths)
  678. {
  679. // Distinct these to prevent users from reporting problems that aren't actually problems
  680. var commandLineArgs = Environment
  681. .GetCommandLineArgs()
  682. .Distinct();
  683. // Get all 'JELLYFIN_' prefixed environment variables
  684. var allEnvVars = Environment.GetEnvironmentVariables();
  685. var jellyfinEnvVars = new Dictionary<object, object>();
  686. foreach (var key in allEnvVars.Keys)
  687. {
  688. if (key.ToString().StartsWith("JELLYFIN_", StringComparison.OrdinalIgnoreCase))
  689. {
  690. jellyfinEnvVars.Add(key, allEnvVars[key]);
  691. }
  692. }
  693. logger.LogInformation("Environment Variables: {EnvVars}", jellyfinEnvVars);
  694. logger.LogInformation("Arguments: {Args}", commandLineArgs);
  695. logger.LogInformation("Operating system: {OS}", OperatingSystem.Name);
  696. logger.LogInformation("Architecture: {Architecture}", RuntimeInformation.OSArchitecture);
  697. logger.LogInformation("64-Bit Process: {Is64Bit}", Environment.Is64BitProcess);
  698. logger.LogInformation("User Interactive: {IsUserInteractive}", Environment.UserInteractive);
  699. logger.LogInformation("Processor count: {ProcessorCount}", Environment.ProcessorCount);
  700. logger.LogInformation("Program data path: {ProgramDataPath}", appPaths.ProgramDataPath);
  701. logger.LogInformation("Web resources path: {WebPath}", appPaths.WebPath);
  702. logger.LogInformation("Application directory: {ApplicationPath}", appPaths.ProgramSystemPath);
  703. }
  704. private X509Certificate2 GetCertificate(CertificateInfo info)
  705. {
  706. var certificateLocation = info?.Path;
  707. if (string.IsNullOrWhiteSpace(certificateLocation))
  708. {
  709. return null;
  710. }
  711. try
  712. {
  713. if (!File.Exists(certificateLocation))
  714. {
  715. return null;
  716. }
  717. // Don't use an empty string password
  718. var password = string.IsNullOrWhiteSpace(info.Password) ? null : info.Password;
  719. var localCert = new X509Certificate2(certificateLocation, password);
  720. // localCert.PrivateKey = PrivateKey.CreateFromFile(pvk_file).RSA;
  721. if (!localCert.HasPrivateKey)
  722. {
  723. Logger.LogError("No private key included in SSL cert {CertificateLocation}.", certificateLocation);
  724. return null;
  725. }
  726. return localCert;
  727. }
  728. catch (Exception ex)
  729. {
  730. Logger.LogError(ex, "Error loading cert from {CertificateLocation}", certificateLocation);
  731. return null;
  732. }
  733. }
  734. /// <summary>
  735. /// Gets the user repository.
  736. /// </summary>
  737. /// <returns><see cref="Task{SqliteUserRepository}" />.</returns>
  738. private SqliteUserRepository GetUserRepository()
  739. {
  740. var repo = new SqliteUserRepository(
  741. LoggerFactory.CreateLogger<SqliteUserRepository>(),
  742. ApplicationPaths);
  743. repo.Initialize();
  744. return repo;
  745. }
  746. private IAuthenticationRepository GetAuthenticationRepository()
  747. {
  748. var repo = new AuthenticationRepository(LoggerFactory, ServerConfigurationManager);
  749. repo.Initialize();
  750. return repo;
  751. }
  752. /// <summary>
  753. /// Dirty hacks.
  754. /// </summary>
  755. private void SetStaticProperties()
  756. {
  757. ItemRepository.ImageProcessor = ImageProcessor;
  758. // For now there's no real way to inject these properly
  759. BaseItem.Logger = LoggerFactory.CreateLogger("BaseItem");
  760. BaseItem.ConfigurationManager = ServerConfigurationManager;
  761. BaseItem.LibraryManager = LibraryManager;
  762. BaseItem.ProviderManager = ProviderManager;
  763. BaseItem.LocalizationManager = LocalizationManager;
  764. BaseItem.ItemRepository = ItemRepository;
  765. User.UserManager = UserManager;
  766. BaseItem.FileSystem = FileSystemManager;
  767. BaseItem.UserDataManager = UserDataManager;
  768. BaseItem.ChannelManager = ChannelManager;
  769. Video.LiveTvManager = LiveTvManager;
  770. Folder.UserViewManager = UserViewManager;
  771. UserView.TVSeriesManager = TVSeriesManager;
  772. UserView.CollectionManager = CollectionManager;
  773. BaseItem.MediaSourceManager = MediaSourceManager;
  774. CollectionFolder.XmlSerializer = XmlSerializer;
  775. CollectionFolder.JsonSerializer = JsonSerializer;
  776. CollectionFolder.ApplicationHost = this;
  777. AuthenticatedAttribute.AuthService = ServiceProvider.GetRequiredService<IAuthService>();
  778. }
  779. private async void PluginInstalled(object sender, GenericEventArgs<PackageVersionInfo> args)
  780. {
  781. string dir = Path.Combine(ApplicationPaths.PluginsPath, args.Argument.name);
  782. var types = Directory.EnumerateFiles(dir, "*.dll", SearchOption.AllDirectories)
  783. .Select(Assembly.LoadFrom)
  784. .SelectMany(x => x.ExportedTypes)
  785. .Where(x => x.IsClass && !x.IsAbstract && !x.IsInterface && !x.IsGenericType)
  786. .ToArray();
  787. int oldLen = _allConcreteTypes.Length;
  788. Array.Resize(ref _allConcreteTypes, oldLen + types.Length);
  789. types.CopyTo(_allConcreteTypes, oldLen);
  790. var plugins = types.Where(x => x.IsAssignableFrom(typeof(IPlugin)))
  791. .Select(CreateInstanceSafe)
  792. .Where(x => x != null)
  793. .Cast<IPlugin>()
  794. .Select(LoadPlugin)
  795. .Where(x => x != null)
  796. .ToArray();
  797. oldLen = _plugins.Length;
  798. Array.Resize(ref _plugins, oldLen + plugins.Length);
  799. plugins.CopyTo(_plugins, oldLen);
  800. var entries = types.Where(x => x.IsAssignableFrom(typeof(IServerEntryPoint)))
  801. .Select(CreateInstanceSafe)
  802. .Where(x => x != null)
  803. .Cast<IServerEntryPoint>()
  804. .ToList();
  805. await Task.WhenAll(StartEntryPoints(entries, true)).ConfigureAwait(false);
  806. await Task.WhenAll(StartEntryPoints(entries, false)).ConfigureAwait(false);
  807. }
  808. /// <summary>
  809. /// Finds the parts.
  810. /// </summary>
  811. public void FindParts()
  812. {
  813. InstallationManager = ServiceProvider.GetService<IInstallationManager>();
  814. InstallationManager.PluginInstalled += PluginInstalled;
  815. if (!ServerConfigurationManager.Configuration.IsPortAuthorized)
  816. {
  817. ServerConfigurationManager.Configuration.IsPortAuthorized = true;
  818. ConfigurationManager.SaveConfiguration();
  819. }
  820. ConfigurationManager.AddParts(GetExports<IConfigurationFactory>());
  821. _plugins = GetExports<IPlugin>()
  822. .Select(LoadPlugin)
  823. .Where(i => i != null)
  824. .ToArray();
  825. HttpServer.Init(GetExportTypes<IService>(), GetExports<IWebSocketListener>(), GetUrlPrefixes());
  826. LibraryManager.AddParts(
  827. GetExports<IResolverIgnoreRule>(),
  828. GetExports<IItemResolver>(),
  829. GetExports<IIntroProvider>(),
  830. GetExports<IBaseItemComparer>(),
  831. GetExports<ILibraryPostScanTask>());
  832. ProviderManager.AddParts(
  833. GetExports<IImageProvider>(),
  834. GetExports<IMetadataService>(),
  835. GetExports<IMetadataProvider>(),
  836. GetExports<IMetadataSaver>(),
  837. GetExports<IExternalId>());
  838. LiveTvManager.AddParts(GetExports<ILiveTvService>(), GetExports<ITunerHost>(), GetExports<IListingsProvider>());
  839. SubtitleManager.AddParts(GetExports<ISubtitleProvider>());
  840. ChannelManager.AddParts(GetExports<IChannel>());
  841. MediaSourceManager.AddParts(GetExports<IMediaSourceProvider>());
  842. NotificationManager.AddParts(GetExports<INotificationService>(), GetExports<INotificationTypeFactory>());
  843. UserManager.AddParts(GetExports<IAuthenticationProvider>(), GetExports<IPasswordResetProvider>());
  844. IsoManager.AddParts(GetExports<IIsoMounter>());
  845. }
  846. private IPlugin LoadPlugin(IPlugin plugin)
  847. {
  848. try
  849. {
  850. if (plugin is IPluginAssembly assemblyPlugin)
  851. {
  852. var assembly = plugin.GetType().Assembly;
  853. var assemblyName = assembly.GetName();
  854. var assemblyFilePath = assembly.Location;
  855. var dataFolderPath = Path.Combine(ApplicationPaths.PluginsPath, Path.GetFileNameWithoutExtension(assemblyFilePath));
  856. assemblyPlugin.SetAttributes(assemblyFilePath, dataFolderPath, assemblyName.Version);
  857. try
  858. {
  859. var idAttributes = assembly.GetCustomAttributes(typeof(GuidAttribute), true);
  860. if (idAttributes.Length > 0)
  861. {
  862. var attribute = (GuidAttribute)idAttributes[0];
  863. var assemblyId = new Guid(attribute.Value);
  864. assemblyPlugin.SetId(assemblyId);
  865. }
  866. }
  867. catch (Exception ex)
  868. {
  869. Logger.LogError(ex, "Error getting plugin Id from {PluginName}.", plugin.GetType().FullName);
  870. }
  871. }
  872. if (plugin is IHasPluginConfiguration hasPluginConfiguration)
  873. {
  874. hasPluginConfiguration.SetStartupInfo(s => Directory.CreateDirectory(s));
  875. }
  876. }
  877. catch (Exception ex)
  878. {
  879. Logger.LogError(ex, "Error loading plugin {PluginName}", plugin.GetType().FullName);
  880. return null;
  881. }
  882. return plugin;
  883. }
  884. /// <summary>
  885. /// Discovers the types.
  886. /// </summary>
  887. protected void DiscoverTypes()
  888. {
  889. Logger.LogInformation("Loading assemblies");
  890. _allConcreteTypes = GetTypes(GetComposablePartAssemblies()).ToArray();
  891. }
  892. private IEnumerable<Type> GetTypes(IEnumerable<Assembly> assemblies)
  893. {
  894. foreach (var ass in assemblies)
  895. {
  896. Type[] exportedTypes;
  897. try
  898. {
  899. exportedTypes = ass.GetExportedTypes();
  900. }
  901. catch (FileNotFoundException ex)
  902. {
  903. Logger.LogError(ex, "Error getting exported types from {Assembly}", ass.FullName);
  904. continue;
  905. }
  906. foreach (Type type in exportedTypes)
  907. {
  908. if (type.IsClass && !type.IsAbstract && !type.IsInterface && !type.IsGenericType)
  909. {
  910. yield return type;
  911. }
  912. }
  913. }
  914. }
  915. private CertificateInfo CertificateInfo { get; set; }
  916. public X509Certificate2 Certificate { get; private set; }
  917. private IEnumerable<string> GetUrlPrefixes()
  918. {
  919. var hosts = new[] { "+" };
  920. return hosts.SelectMany(i =>
  921. {
  922. var prefixes = new List<string>
  923. {
  924. "http://" + i + ":" + HttpPort + "/"
  925. };
  926. if (CertificateInfo != null)
  927. {
  928. prefixes.Add("https://" + i + ":" + HttpsPort + "/");
  929. }
  930. return prefixes;
  931. });
  932. }
  933. private CertificateInfo GetCertificateInfo(bool generateCertificate)
  934. {
  935. // Custom cert
  936. return new CertificateInfo
  937. {
  938. Path = ServerConfigurationManager.Configuration.CertificatePath,
  939. Password = ServerConfigurationManager.Configuration.CertificatePassword
  940. };
  941. }
  942. /// <summary>
  943. /// Called when [configuration updated].
  944. /// </summary>
  945. /// <param name="sender">The sender.</param>
  946. /// <param name="e">The <see cref="EventArgs"/> instance containing the event data.</param>
  947. protected void OnConfigurationUpdated(object sender, EventArgs e)
  948. {
  949. var requiresRestart = false;
  950. // Don't do anything if these haven't been set yet
  951. if (HttpPort != 0 && HttpsPort != 0)
  952. {
  953. // Need to restart if ports have changed
  954. if (ServerConfigurationManager.Configuration.HttpServerPortNumber != HttpPort ||
  955. ServerConfigurationManager.Configuration.HttpsPortNumber != HttpsPort)
  956. {
  957. if (ServerConfigurationManager.Configuration.IsPortAuthorized)
  958. {
  959. ServerConfigurationManager.Configuration.IsPortAuthorized = false;
  960. ServerConfigurationManager.SaveConfiguration();
  961. requiresRestart = true;
  962. }
  963. }
  964. }
  965. if (!HttpServer.UrlPrefixes.SequenceEqual(GetUrlPrefixes(), StringComparer.OrdinalIgnoreCase))
  966. {
  967. requiresRestart = true;
  968. }
  969. var currentCertPath = CertificateInfo?.Path;
  970. var newCertInfo = GetCertificateInfo(false);
  971. var newCertPath = newCertInfo?.Path;
  972. if (!string.Equals(currentCertPath, newCertPath, StringComparison.OrdinalIgnoreCase))
  973. {
  974. requiresRestart = true;
  975. }
  976. if (requiresRestart)
  977. {
  978. Logger.LogInformation("App needs to be restarted due to configuration change.");
  979. NotifyPendingRestart();
  980. }
  981. }
  982. /// <summary>
  983. /// Notifies that the kernel that a change has been made that requires a restart
  984. /// </summary>
  985. public void NotifyPendingRestart()
  986. {
  987. Logger.LogInformation("App needs to be restarted.");
  988. var changed = !HasPendingRestart;
  989. HasPendingRestart = true;
  990. if (changed)
  991. {
  992. EventHelper.QueueEventIfNotNull(HasPendingRestartChanged, this, EventArgs.Empty, Logger);
  993. }
  994. }
  995. /// <summary>
  996. /// Restarts this instance.
  997. /// </summary>
  998. public void Restart()
  999. {
  1000. if (!CanSelfRestart)
  1001. {
  1002. throw new PlatformNotSupportedException("The server is unable to self-restart. Please restart manually.");
  1003. }
  1004. if (IsShuttingDown)
  1005. {
  1006. return;
  1007. }
  1008. IsShuttingDown = true;
  1009. Task.Run(async () =>
  1010. {
  1011. try
  1012. {
  1013. await SessionManager.SendServerRestartNotification(CancellationToken.None).ConfigureAwait(false);
  1014. }
  1015. catch (Exception ex)
  1016. {
  1017. Logger.LogError(ex, "Error sending server restart notification");
  1018. }
  1019. Logger.LogInformation("Calling RestartInternal");
  1020. RestartInternal();
  1021. });
  1022. }
  1023. protected abstract void RestartInternal();
  1024. /// <summary>
  1025. /// Gets the composable part assemblies.
  1026. /// </summary>
  1027. /// <returns>IEnumerable{Assembly}.</returns>
  1028. protected IEnumerable<Assembly> GetComposablePartAssemblies()
  1029. {
  1030. if (Directory.Exists(ApplicationPaths.PluginsPath))
  1031. {
  1032. foreach (var file in Directory.EnumerateFiles(ApplicationPaths.PluginsPath, "*.dll", SearchOption.AllDirectories))
  1033. {
  1034. Assembly plugAss;
  1035. try
  1036. {
  1037. plugAss = Assembly.LoadFrom(file);
  1038. }
  1039. catch (FileLoadException ex)
  1040. {
  1041. Logger.LogError(ex, "Failed to load assembly {Path}", file);
  1042. continue;
  1043. }
  1044. Logger.LogInformation("Loaded assembly {Assembly} from {Path}", plugAss.FullName, file);
  1045. yield return plugAss;
  1046. }
  1047. }
  1048. // Include composable parts in the Api assembly
  1049. yield return typeof(ApiEntryPoint).Assembly;
  1050. // Include composable parts in the Dashboard assembly
  1051. yield return typeof(DashboardService).Assembly;
  1052. // Include composable parts in the Model assembly
  1053. yield return typeof(SystemInfo).Assembly;
  1054. // Include composable parts in the Common assembly
  1055. yield return typeof(IApplicationHost).Assembly;
  1056. // Include composable parts in the Controller assembly
  1057. yield return typeof(IServerApplicationHost).Assembly;
  1058. // Include composable parts in the Providers assembly
  1059. yield return typeof(ProviderUtils).Assembly;
  1060. // Include composable parts in the Photos assembly
  1061. yield return typeof(PhotoProvider).Assembly;
  1062. // Emby.Server implementations
  1063. yield return typeof(InstallationManager).Assembly;
  1064. // MediaEncoding
  1065. yield return typeof(MediaBrowser.MediaEncoding.Encoder.MediaEncoder).Assembly;
  1066. // Dlna
  1067. yield return typeof(DlnaEntryPoint).Assembly;
  1068. // Local metadata
  1069. yield return typeof(BoxSetXmlSaver).Assembly;
  1070. // Notifications
  1071. yield return typeof(NotificationManager).Assembly;
  1072. // Xbmc
  1073. yield return typeof(ArtistNfoProvider).Assembly;
  1074. foreach (var i in GetAssembliesWithPartsInternal())
  1075. {
  1076. yield return i;
  1077. }
  1078. }
  1079. protected abstract IEnumerable<Assembly> GetAssembliesWithPartsInternal();
  1080. /// <summary>
  1081. /// Gets the system status.
  1082. /// </summary>
  1083. /// <param name="cancellationToken">The cancellation token.</param>
  1084. /// <returns>SystemInfo.</returns>
  1085. public async Task<SystemInfo> GetSystemInfo(CancellationToken cancellationToken)
  1086. {
  1087. var localAddress = await GetLocalApiUrl(cancellationToken).ConfigureAwait(false);
  1088. var transcodingTempPath = ConfigurationManager.GetTranscodePath();
  1089. return new SystemInfo
  1090. {
  1091. HasPendingRestart = HasPendingRestart,
  1092. IsShuttingDown = IsShuttingDown,
  1093. Version = ApplicationVersionString,
  1094. WebSocketPortNumber = HttpPort,
  1095. CompletedInstallations = InstallationManager.CompletedInstallations.ToArray(),
  1096. Id = SystemId,
  1097. ProgramDataPath = ApplicationPaths.ProgramDataPath,
  1098. WebPath = ApplicationPaths.WebPath,
  1099. LogPath = ApplicationPaths.LogDirectoryPath,
  1100. ItemsByNamePath = ApplicationPaths.InternalMetadataPath,
  1101. InternalMetadataPath = ApplicationPaths.InternalMetadataPath,
  1102. CachePath = ApplicationPaths.CachePath,
  1103. HttpServerPortNumber = HttpPort,
  1104. SupportsHttps = SupportsHttps,
  1105. HttpsPortNumber = HttpsPort,
  1106. OperatingSystem = OperatingSystem.Id.ToString(),
  1107. OperatingSystemDisplayName = OperatingSystem.Name,
  1108. CanSelfRestart = CanSelfRestart,
  1109. CanLaunchWebBrowser = CanLaunchWebBrowser,
  1110. HasUpdateAvailable = HasUpdateAvailable,
  1111. TranscodingTempPath = transcodingTempPath,
  1112. ServerName = FriendlyName,
  1113. LocalAddress = localAddress,
  1114. SupportsLibraryMonitor = true,
  1115. EncoderLocation = MediaEncoder.EncoderLocation,
  1116. SystemArchitecture = RuntimeInformation.OSArchitecture,
  1117. SystemUpdateLevel = SystemUpdateLevel,
  1118. PackageName = StartupOptions.PackageName
  1119. };
  1120. }
  1121. public IEnumerable<WakeOnLanInfo> GetWakeOnLanInfo()
  1122. => NetworkManager.GetMacAddresses()
  1123. .Select(i => new WakeOnLanInfo(i))
  1124. .ToList();
  1125. public async Task<PublicSystemInfo> GetPublicSystemInfo(CancellationToken cancellationToken)
  1126. {
  1127. var localAddress = await GetLocalApiUrl(cancellationToken).ConfigureAwait(false);
  1128. return new PublicSystemInfo
  1129. {
  1130. Version = ApplicationVersionString,
  1131. ProductName = ApplicationProductName,
  1132. Id = SystemId,
  1133. OperatingSystem = OperatingSystem.Id.ToString(),
  1134. ServerName = FriendlyName,
  1135. LocalAddress = localAddress
  1136. };
  1137. }
  1138. public bool EnableHttps => SupportsHttps && ServerConfigurationManager.Configuration.EnableHttps;
  1139. public bool SupportsHttps => Certificate != null || ServerConfigurationManager.Configuration.IsBehindProxy;
  1140. public async Task<string> GetLocalApiUrl(CancellationToken cancellationToken)
  1141. {
  1142. try
  1143. {
  1144. // Return the first matched address, if found, or the first known local address
  1145. var addresses = await GetLocalIpAddressesInternal(false, 1, cancellationToken).ConfigureAwait(false);
  1146. foreach (var address in addresses)
  1147. {
  1148. return GetLocalApiUrl(address);
  1149. }
  1150. return null;
  1151. }
  1152. catch (Exception ex)
  1153. {
  1154. Logger.LogError(ex, "Error getting local Ip address information");
  1155. }
  1156. return null;
  1157. }
  1158. /// <summary>
  1159. /// Removes the scope id from IPv6 addresses.
  1160. /// </summary>
  1161. /// <param name="address">The IPv6 address.</param>
  1162. /// <returns>The IPv6 address without the scope id.</returns>
  1163. private ReadOnlySpan<char> RemoveScopeId(ReadOnlySpan<char> address)
  1164. {
  1165. var index = address.IndexOf('%');
  1166. if (index == -1)
  1167. {
  1168. return address;
  1169. }
  1170. return address.Slice(0, index);
  1171. }
  1172. /// <inheritdoc />
  1173. public string GetLocalApiUrl(IPAddress ipAddress)
  1174. {
  1175. if (ipAddress.AddressFamily == AddressFamily.InterNetworkV6)
  1176. {
  1177. var str = RemoveScopeId(ipAddress.ToString());
  1178. Span<char> span = new char[str.Length + 2];
  1179. span[0] = '[';
  1180. str.CopyTo(span.Slice(1));
  1181. span[^1] = ']';
  1182. return GetLocalApiUrl(span);
  1183. }
  1184. return GetLocalApiUrl(ipAddress.ToString());
  1185. }
  1186. /// <inheritdoc />
  1187. public string GetLocalApiUrl(ReadOnlySpan<char> host)
  1188. {
  1189. var url = new StringBuilder(64);
  1190. url.Append(EnableHttps ? "https://" : "http://")
  1191. .Append(host)
  1192. .Append(':')
  1193. .Append(EnableHttps ? HttpsPort : HttpPort);
  1194. string baseUrl = ServerConfigurationManager.Configuration.BaseUrl;
  1195. if (baseUrl.Length != 0)
  1196. {
  1197. url.Append(baseUrl);
  1198. }
  1199. return url.ToString();
  1200. }
  1201. public Task<List<IPAddress>> GetLocalIpAddresses(CancellationToken cancellationToken)
  1202. {
  1203. return GetLocalIpAddressesInternal(true, 0, cancellationToken);
  1204. }
  1205. private async Task<List<IPAddress>> GetLocalIpAddressesInternal(bool allowLoopback, int limit, CancellationToken cancellationToken)
  1206. {
  1207. var addresses = ServerConfigurationManager
  1208. .Configuration
  1209. .LocalNetworkAddresses
  1210. .Select(NormalizeConfiguredLocalAddress)
  1211. .Where(i => i != null)
  1212. .ToList();
  1213. if (addresses.Count == 0)
  1214. {
  1215. addresses.AddRange(NetworkManager.GetLocalIpAddresses(ServerConfigurationManager.Configuration.IgnoreVirtualInterfaces));
  1216. }
  1217. var resultList = new List<IPAddress>();
  1218. foreach (var address in addresses)
  1219. {
  1220. if (!allowLoopback)
  1221. {
  1222. if (address.Equals(IPAddress.Loopback) || address.Equals(IPAddress.IPv6Loopback))
  1223. {
  1224. continue;
  1225. }
  1226. }
  1227. var valid = await IsIpAddressValidAsync(address, cancellationToken).ConfigureAwait(false);
  1228. if (valid)
  1229. {
  1230. resultList.Add(address);
  1231. if (limit > 0 && resultList.Count >= limit)
  1232. {
  1233. return resultList;
  1234. }
  1235. }
  1236. }
  1237. return resultList;
  1238. }
  1239. public IPAddress NormalizeConfiguredLocalAddress(string address)
  1240. {
  1241. var index = address.Trim('/').IndexOf('/');
  1242. if (index != -1)
  1243. {
  1244. address = address.Substring(index + 1);
  1245. }
  1246. if (IPAddress.TryParse(address.Trim('/'), out IPAddress result))
  1247. {
  1248. return result;
  1249. }
  1250. return null;
  1251. }
  1252. private readonly ConcurrentDictionary<string, bool> _validAddressResults = new ConcurrentDictionary<string, bool>(StringComparer.OrdinalIgnoreCase);
  1253. private async Task<bool> IsIpAddressValidAsync(IPAddress address, CancellationToken cancellationToken)
  1254. {
  1255. if (address.Equals(IPAddress.Loopback)
  1256. || address.Equals(IPAddress.IPv6Loopback))
  1257. {
  1258. return true;
  1259. }
  1260. var apiUrl = GetLocalApiUrl(address);
  1261. apiUrl += "/system/ping";
  1262. if (_validAddressResults.TryGetValue(apiUrl, out var cachedResult))
  1263. {
  1264. return cachedResult;
  1265. }
  1266. try
  1267. {
  1268. using (var response = await HttpClient.SendAsync(
  1269. new HttpRequestOptions
  1270. {
  1271. Url = apiUrl,
  1272. LogErrorResponseBody = false,
  1273. BufferContent = false,
  1274. CancellationToken = cancellationToken
  1275. }, HttpMethod.Post).ConfigureAwait(false))
  1276. {
  1277. using (var reader = new StreamReader(response.Content))
  1278. {
  1279. var result = await reader.ReadToEndAsync().ConfigureAwait(false);
  1280. var valid = string.Equals(Name, result, StringComparison.OrdinalIgnoreCase);
  1281. _validAddressResults.AddOrUpdate(apiUrl, valid, (k, v) => valid);
  1282. Logger.LogDebug("Ping test result to {0}. Success: {1}", apiUrl, valid);
  1283. return valid;
  1284. }
  1285. }
  1286. }
  1287. catch (OperationCanceledException)
  1288. {
  1289. Logger.LogDebug("Ping test result to {0}. Success: {1}", apiUrl, "Cancelled");
  1290. throw;
  1291. }
  1292. catch (Exception ex)
  1293. {
  1294. Logger.LogDebug(ex, "Ping test result to {0}. Success: {1}", apiUrl, false);
  1295. _validAddressResults.AddOrUpdate(apiUrl, false, (k, v) => false);
  1296. return false;
  1297. }
  1298. }
  1299. public string FriendlyName =>
  1300. string.IsNullOrEmpty(ServerConfigurationManager.Configuration.ServerName)
  1301. ? Environment.MachineName
  1302. : ServerConfigurationManager.Configuration.ServerName;
  1303. /// <summary>
  1304. /// Shuts down.
  1305. /// </summary>
  1306. public async Task Shutdown()
  1307. {
  1308. if (IsShuttingDown)
  1309. {
  1310. return;
  1311. }
  1312. IsShuttingDown = true;
  1313. try
  1314. {
  1315. await SessionManager.SendServerShutdownNotification(CancellationToken.None).ConfigureAwait(false);
  1316. }
  1317. catch (Exception ex)
  1318. {
  1319. Logger.LogError(ex, "Error sending server shutdown notification");
  1320. }
  1321. ShutdownInternal();
  1322. }
  1323. protected abstract void ShutdownInternal();
  1324. public event EventHandler HasUpdateAvailableChanged;
  1325. private bool _hasUpdateAvailable;
  1326. public bool HasUpdateAvailable
  1327. {
  1328. get => _hasUpdateAvailable;
  1329. set
  1330. {
  1331. var fireEvent = value && !_hasUpdateAvailable;
  1332. _hasUpdateAvailable = value;
  1333. if (fireEvent)
  1334. {
  1335. HasUpdateAvailableChanged?.Invoke(this, EventArgs.Empty);
  1336. }
  1337. }
  1338. }
  1339. /// <summary>
  1340. /// Removes the plugin.
  1341. /// </summary>
  1342. /// <param name="plugin">The plugin.</param>
  1343. public void RemovePlugin(IPlugin plugin)
  1344. {
  1345. var list = _plugins.ToList();
  1346. list.Remove(plugin);
  1347. _plugins = list.ToArray();
  1348. }
  1349. public virtual void LaunchUrl(string url)
  1350. {
  1351. if (!CanLaunchWebBrowser)
  1352. {
  1353. throw new NotSupportedException();
  1354. }
  1355. var process = ProcessFactory.Create(new ProcessOptions
  1356. {
  1357. FileName = url,
  1358. EnableRaisingEvents = true,
  1359. UseShellExecute = true,
  1360. ErrorDialog = false
  1361. });
  1362. process.Exited += ProcessExited;
  1363. try
  1364. {
  1365. process.Start();
  1366. }
  1367. catch (Exception ex)
  1368. {
  1369. Logger.LogError(ex, "Error launching url: {url}", url);
  1370. throw;
  1371. }
  1372. }
  1373. private static void ProcessExited(object sender, EventArgs e)
  1374. {
  1375. ((IProcess)sender).Dispose();
  1376. }
  1377. public virtual void EnableLoopback(string appName)
  1378. {
  1379. }
  1380. private bool _disposed = false;
  1381. /// <summary>
  1382. /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
  1383. /// </summary>
  1384. public void Dispose()
  1385. {
  1386. Dispose(true);
  1387. GC.SuppressFinalize(this);
  1388. }
  1389. /// <summary>
  1390. /// Releases unmanaged and - optionally - managed resources.
  1391. /// </summary>
  1392. /// <param name="dispose"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
  1393. protected virtual void Dispose(bool dispose)
  1394. {
  1395. if (_disposed)
  1396. {
  1397. return;
  1398. }
  1399. if (dispose)
  1400. {
  1401. var type = GetType();
  1402. Logger.LogInformation("Disposing {Type}", type.Name);
  1403. var parts = _disposableParts.Distinct().Where(i => i.GetType() != type).ToList();
  1404. _disposableParts.Clear();
  1405. foreach (var part in parts)
  1406. {
  1407. Logger.LogInformation("Disposing {Type}", part.GetType().Name);
  1408. try
  1409. {
  1410. part.Dispose();
  1411. }
  1412. catch (Exception ex)
  1413. {
  1414. Logger.LogError(ex, "Error disposing {Type}", part.GetType().Name);
  1415. }
  1416. }
  1417. _userRepository?.Dispose();
  1418. _displayPreferencesRepository?.Dispose();
  1419. }
  1420. _userRepository = null;
  1421. _displayPreferencesRepository = null;
  1422. _disposed = true;
  1423. }
  1424. }
  1425. internal class CertificateInfo
  1426. {
  1427. public string Path { get; set; }
  1428. public string Password { get; set; }
  1429. }
  1430. }