ApplicationHost.cs 54 KB

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