ApplicationHost.cs 54 KB

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