ApplicationHost.cs 55 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497
  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.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.AppendLine(
  414. string.Format(
  415. CultureInfo.InvariantCulture,
  416. "{0} {1}",
  417. plugin.Name,
  418. plugin.Version));
  419. }
  420. Logger.LogInformation("Plugins: {Plugins}", pluginBuilder.ToString());
  421. }
  422. DiscoverTypes();
  423. RegisterServices(serviceCollection);
  424. }
  425. public Task ExecuteHttpHandlerAsync(HttpContext context, Func<Task> next)
  426. => _httpServer.RequestHandler(context);
  427. /// <summary>
  428. /// Registers services/resources with the service collection that will be available via DI.
  429. /// </summary>
  430. protected virtual void RegisterServices(IServiceCollection serviceCollection)
  431. {
  432. serviceCollection.AddSingleton(_startupOptions);
  433. serviceCollection.AddMemoryCache();
  434. serviceCollection.AddSingleton(ConfigurationManager);
  435. serviceCollection.AddSingleton<IApplicationHost>(this);
  436. serviceCollection.AddSingleton<IApplicationPaths>(ApplicationPaths);
  437. serviceCollection.AddSingleton<IJsonSerializer, JsonSerializer>();
  438. serviceCollection.AddSingleton(_fileSystemManager);
  439. serviceCollection.AddSingleton<TvdbClientManager>();
  440. serviceCollection.AddSingleton<IHttpClient, HttpClientManager.HttpClientManager>();
  441. serviceCollection.AddSingleton(_networkManager);
  442. serviceCollection.AddSingleton<IIsoManager, IsoManager>();
  443. serviceCollection.AddSingleton<ITaskManager, TaskManager>();
  444. serviceCollection.AddSingleton(_xmlSerializer);
  445. serviceCollection.AddSingleton<IStreamHelper, StreamHelper>();
  446. serviceCollection.AddSingleton<ICryptoProvider, CryptographyProvider>();
  447. serviceCollection.AddSingleton<ISocketFactory, SocketFactory>();
  448. serviceCollection.AddSingleton<IInstallationManager, InstallationManager>();
  449. serviceCollection.AddSingleton<IZipClient, ZipClient>();
  450. serviceCollection.AddSingleton<IHttpResultFactory, HttpResultFactory>();
  451. serviceCollection.AddSingleton<IServerApplicationHost>(this);
  452. serviceCollection.AddSingleton<IServerApplicationPaths>(ApplicationPaths);
  453. serviceCollection.AddSingleton(ServerConfigurationManager);
  454. serviceCollection.AddSingleton<ILocalizationManager, LocalizationManager>();
  455. serviceCollection.AddSingleton<IBlurayExaminer, BdInfoExaminer>();
  456. serviceCollection.AddSingleton<IUserDataRepository, SqliteUserDataRepository>();
  457. serviceCollection.AddSingleton<IUserDataManager, UserDataManager>();
  458. serviceCollection.AddSingleton<IDisplayPreferencesRepository, SqliteDisplayPreferencesRepository>();
  459. serviceCollection.AddSingleton<IItemRepository, SqliteItemRepository>();
  460. serviceCollection.AddSingleton<IAuthenticationRepository, AuthenticationRepository>();
  461. serviceCollection.AddSingleton<IUserRepository, SqliteUserRepository>();
  462. // TODO: Refactor to eliminate the circular dependency here so that Lazy<T> isn't required
  463. serviceCollection.AddTransient(provider => new Lazy<IDtoService>(provider.GetRequiredService<IDtoService>));
  464. serviceCollection.AddSingleton<IUserManager, UserManager>();
  465. // TODO: Refactor to eliminate the circular dependency here so that Lazy<T> isn't required
  466. // TODO: Add StartupOptions.FFmpegPath to IConfiguration and remove this custom activation
  467. serviceCollection.AddTransient(provider => new Lazy<EncodingHelper>(provider.GetRequiredService<EncodingHelper>));
  468. serviceCollection.AddSingleton<IMediaEncoder>(provider =>
  469. ActivatorUtilities.CreateInstance<MediaBrowser.MediaEncoding.Encoder.MediaEncoder>(provider, _startupOptions.FFmpegPath ?? string.Empty));
  470. // TODO: Refactor to eliminate the circular dependencies here so that Lazy<T> isn't required
  471. serviceCollection.AddTransient(provider => new Lazy<ILibraryMonitor>(provider.GetRequiredService<ILibraryMonitor>));
  472. serviceCollection.AddTransient(provider => new Lazy<IProviderManager>(provider.GetRequiredService<IProviderManager>));
  473. serviceCollection.AddTransient(provider => new Lazy<IUserViewManager>(provider.GetRequiredService<IUserViewManager>));
  474. serviceCollection.AddSingleton<ILibraryManager, LibraryManager>();
  475. serviceCollection.AddSingleton<IMusicManager, MusicManager>();
  476. serviceCollection.AddSingleton<ILibraryMonitor, LibraryMonitor>();
  477. serviceCollection.AddSingleton<ISearchEngine, SearchEngine>();
  478. serviceCollection.AddSingleton<ServiceController>();
  479. serviceCollection.AddSingleton<IHttpServer, HttpListenerHost>();
  480. serviceCollection.AddSingleton<IImageProcessor, ImageProcessor>();
  481. serviceCollection.AddSingleton<ITVSeriesManager, TVSeriesManager>();
  482. serviceCollection.AddSingleton<IDeviceManager, DeviceManager>();
  483. serviceCollection.AddSingleton<IMediaSourceManager, MediaSourceManager>();
  484. serviceCollection.AddSingleton<ISubtitleManager, SubtitleManager>();
  485. serviceCollection.AddSingleton<IProviderManager, ProviderManager>();
  486. // TODO: Refactor to eliminate the circular dependency here so that Lazy<T> isn't required
  487. serviceCollection.AddTransient(provider => new Lazy<ILiveTvManager>(provider.GetRequiredService<ILiveTvManager>));
  488. serviceCollection.AddSingleton<IDtoService, DtoService>();
  489. serviceCollection.AddSingleton<IChannelManager, ChannelManager>();
  490. serviceCollection.AddSingleton<ISessionManager, SessionManager>();
  491. serviceCollection.AddSingleton<IDlnaManager, DlnaManager>();
  492. serviceCollection.AddSingleton<ICollectionManager, CollectionManager>();
  493. serviceCollection.AddSingleton<IPlaylistManager, PlaylistManager>();
  494. serviceCollection.AddSingleton<ISyncPlayManager, SyncPlayManager>();
  495. serviceCollection.AddSingleton<LiveTvDtoService>();
  496. serviceCollection.AddSingleton<ILiveTvManager, LiveTvManager>();
  497. serviceCollection.AddSingleton<IUserViewManager, UserViewManager>();
  498. serviceCollection.AddSingleton<INotificationManager, NotificationManager>();
  499. serviceCollection.AddSingleton<IDeviceDiscovery, DeviceDiscovery>();
  500. serviceCollection.AddSingleton<IChapterManager, ChapterManager>();
  501. serviceCollection.AddSingleton<IEncodingManager, MediaEncoder.EncodingManager>();
  502. serviceCollection.AddSingleton<IAuthorizationContext, AuthorizationContext>();
  503. serviceCollection.AddSingleton<ISessionContext, SessionContext>();
  504. serviceCollection.AddSingleton<IAuthService, AuthService>();
  505. serviceCollection.AddSingleton<ISubtitleEncoder, MediaBrowser.MediaEncoding.Subtitles.SubtitleEncoder>();
  506. serviceCollection.AddSingleton<IResourceFileManager, ResourceFileManager>();
  507. serviceCollection.AddSingleton<EncodingHelper>();
  508. serviceCollection.AddSingleton<IAttachmentExtractor, MediaBrowser.MediaEncoding.Attachments.AttachmentExtractor>();
  509. }
  510. /// <summary>
  511. /// Create services registered with the service container that need to be initialized at application startup.
  512. /// </summary>
  513. /// <returns>A task representing the service initialization operation.</returns>
  514. public async Task InitializeServices()
  515. {
  516. var localizationManager = (LocalizationManager)Resolve<ILocalizationManager>();
  517. await localizationManager.LoadAll().ConfigureAwait(false);
  518. _mediaEncoder = Resolve<IMediaEncoder>();
  519. _sessionManager = Resolve<ISessionManager>();
  520. _httpServer = Resolve<IHttpServer>();
  521. _httpClient = Resolve<IHttpClient>();
  522. ((SqliteDisplayPreferencesRepository)Resolve<IDisplayPreferencesRepository>()).Initialize();
  523. ((AuthenticationRepository)Resolve<IAuthenticationRepository>()).Initialize();
  524. ((SqliteUserRepository)Resolve<IUserRepository>()).Initialize();
  525. SetStaticProperties();
  526. var userManager = (UserManager)Resolve<IUserManager>();
  527. userManager.Initialize();
  528. var userDataRepo = (SqliteUserDataRepository)Resolve<IUserDataRepository>();
  529. ((SqliteItemRepository)Resolve<IItemRepository>()).Initialize(userDataRepo, userManager);
  530. FindParts();
  531. }
  532. public static void LogEnvironmentInfo(ILogger logger, IApplicationPaths appPaths)
  533. {
  534. // Distinct these to prevent users from reporting problems that aren't actually problems
  535. var commandLineArgs = Environment
  536. .GetCommandLineArgs()
  537. .Distinct();
  538. // Get all relevant environment variables
  539. var allEnvVars = Environment.GetEnvironmentVariables();
  540. var relevantEnvVars = new Dictionary<object, object>();
  541. foreach (var key in allEnvVars.Keys)
  542. {
  543. if (_relevantEnvVarPrefixes.Any(prefix => key.ToString().StartsWith(prefix, StringComparison.OrdinalIgnoreCase)))
  544. {
  545. relevantEnvVars.Add(key, allEnvVars[key]);
  546. }
  547. }
  548. logger.LogInformation("Environment Variables: {EnvVars}", relevantEnvVars);
  549. logger.LogInformation("Arguments: {Args}", commandLineArgs);
  550. logger.LogInformation("Operating system: {OS}", OperatingSystem.Name);
  551. logger.LogInformation("Architecture: {Architecture}", RuntimeInformation.OSArchitecture);
  552. logger.LogInformation("64-Bit Process: {Is64Bit}", Environment.Is64BitProcess);
  553. logger.LogInformation("User Interactive: {IsUserInteractive}", Environment.UserInteractive);
  554. logger.LogInformation("Processor count: {ProcessorCount}", Environment.ProcessorCount);
  555. logger.LogInformation("Program data path: {ProgramDataPath}", appPaths.ProgramDataPath);
  556. logger.LogInformation("Web resources path: {WebPath}", appPaths.WebPath);
  557. logger.LogInformation("Application directory: {ApplicationPath}", appPaths.ProgramSystemPath);
  558. }
  559. private X509Certificate2 GetCertificate(CertificateInfo info)
  560. {
  561. var certificateLocation = info?.Path;
  562. if (string.IsNullOrWhiteSpace(certificateLocation))
  563. {
  564. return null;
  565. }
  566. try
  567. {
  568. if (!File.Exists(certificateLocation))
  569. {
  570. return null;
  571. }
  572. // Don't use an empty string password
  573. var password = string.IsNullOrWhiteSpace(info.Password) ? null : info.Password;
  574. var localCert = new X509Certificate2(certificateLocation, password);
  575. // localCert.PrivateKey = PrivateKey.CreateFromFile(pvk_file).RSA;
  576. if (!localCert.HasPrivateKey)
  577. {
  578. Logger.LogError("No private key included in SSL cert {CertificateLocation}.", certificateLocation);
  579. return null;
  580. }
  581. return localCert;
  582. }
  583. catch (Exception ex)
  584. {
  585. Logger.LogError(ex, "Error loading cert from {CertificateLocation}", certificateLocation);
  586. return null;
  587. }
  588. }
  589. /// <summary>
  590. /// Dirty hacks.
  591. /// </summary>
  592. private void SetStaticProperties()
  593. {
  594. // For now there's no real way to inject these properly
  595. BaseItem.Logger = Resolve<ILogger<BaseItem>>();
  596. BaseItem.ConfigurationManager = ServerConfigurationManager;
  597. BaseItem.LibraryManager = Resolve<ILibraryManager>();
  598. BaseItem.ProviderManager = Resolve<IProviderManager>();
  599. BaseItem.LocalizationManager = Resolve<ILocalizationManager>();
  600. BaseItem.ItemRepository = Resolve<IItemRepository>();
  601. User.UserManager = Resolve<IUserManager>();
  602. BaseItem.FileSystem = _fileSystemManager;
  603. BaseItem.UserDataManager = Resolve<IUserDataManager>();
  604. BaseItem.ChannelManager = Resolve<IChannelManager>();
  605. Video.LiveTvManager = Resolve<ILiveTvManager>();
  606. Folder.UserViewManager = Resolve<IUserViewManager>();
  607. UserView.TVSeriesManager = Resolve<ITVSeriesManager>();
  608. UserView.CollectionManager = Resolve<ICollectionManager>();
  609. BaseItem.MediaSourceManager = Resolve<IMediaSourceManager>();
  610. CollectionFolder.XmlSerializer = _xmlSerializer;
  611. CollectionFolder.JsonSerializer = Resolve<IJsonSerializer>();
  612. CollectionFolder.ApplicationHost = this;
  613. AuthenticatedAttribute.AuthService = Resolve<IAuthService>();
  614. }
  615. /// <summary>
  616. /// Finds plugin components and register them with the appropriate services.
  617. /// </summary>
  618. private void FindParts()
  619. {
  620. if (!ServerConfigurationManager.Configuration.IsPortAuthorized)
  621. {
  622. ServerConfigurationManager.Configuration.IsPortAuthorized = true;
  623. ConfigurationManager.SaveConfiguration();
  624. }
  625. ConfigurationManager.AddParts(GetExports<IConfigurationFactory>());
  626. _plugins = GetExports<IPlugin>()
  627. .Select(LoadPlugin)
  628. .Where(i => i != null)
  629. .ToArray();
  630. _httpServer.Init(GetExportTypes<IService>(), GetExports<IWebSocketListener>(), GetUrlPrefixes());
  631. Resolve<ILibraryManager>().AddParts(
  632. GetExports<IResolverIgnoreRule>(),
  633. GetExports<IItemResolver>(),
  634. GetExports<IIntroProvider>(),
  635. GetExports<IBaseItemComparer>(),
  636. GetExports<ILibraryPostScanTask>());
  637. Resolve<IProviderManager>().AddParts(
  638. GetExports<IImageProvider>(),
  639. GetExports<IMetadataService>(),
  640. GetExports<IMetadataProvider>(),
  641. GetExports<IMetadataSaver>(),
  642. GetExports<IExternalId>());
  643. Resolve<ILiveTvManager>().AddParts(GetExports<ILiveTvService>(), GetExports<ITunerHost>(), GetExports<IListingsProvider>());
  644. Resolve<ISubtitleManager>().AddParts(GetExports<ISubtitleProvider>());
  645. Resolve<IChannelManager>().AddParts(GetExports<IChannel>());
  646. Resolve<IMediaSourceManager>().AddParts(GetExports<IMediaSourceProvider>());
  647. Resolve<INotificationManager>().AddParts(GetExports<INotificationService>(), GetExports<INotificationTypeFactory>());
  648. Resolve<IUserManager>().AddParts(GetExports<IAuthenticationProvider>(), GetExports<IPasswordResetProvider>());
  649. Resolve<IIsoManager>().AddParts(GetExports<IIsoMounter>());
  650. }
  651. private IPlugin LoadPlugin(IPlugin plugin)
  652. {
  653. try
  654. {
  655. if (plugin is IPluginAssembly assemblyPlugin)
  656. {
  657. var assembly = plugin.GetType().Assembly;
  658. var assemblyName = assembly.GetName();
  659. var assemblyFilePath = assembly.Location;
  660. var dataFolderPath = Path.Combine(ApplicationPaths.PluginsPath, Path.GetFileNameWithoutExtension(assemblyFilePath));
  661. assemblyPlugin.SetAttributes(assemblyFilePath, dataFolderPath, assemblyName.Version);
  662. try
  663. {
  664. var idAttributes = assembly.GetCustomAttributes(typeof(GuidAttribute), true);
  665. if (idAttributes.Length > 0)
  666. {
  667. var attribute = (GuidAttribute)idAttributes[0];
  668. var assemblyId = new Guid(attribute.Value);
  669. assemblyPlugin.SetId(assemblyId);
  670. }
  671. }
  672. catch (Exception ex)
  673. {
  674. Logger.LogError(ex, "Error getting plugin Id from {PluginName}.", plugin.GetType().FullName);
  675. }
  676. }
  677. if (plugin is IHasPluginConfiguration hasPluginConfiguration)
  678. {
  679. hasPluginConfiguration.SetStartupInfo(s => Directory.CreateDirectory(s));
  680. }
  681. }
  682. catch (Exception ex)
  683. {
  684. Logger.LogError(ex, "Error loading plugin {PluginName}", plugin.GetType().FullName);
  685. return null;
  686. }
  687. return plugin;
  688. }
  689. /// <summary>
  690. /// Discovers the types.
  691. /// </summary>
  692. protected void DiscoverTypes()
  693. {
  694. Logger.LogInformation("Loading assemblies");
  695. _allConcreteTypes = GetTypes(GetComposablePartAssemblies()).ToArray();
  696. }
  697. private IEnumerable<Type> GetTypes(IEnumerable<Assembly> assemblies)
  698. {
  699. foreach (var ass in assemblies)
  700. {
  701. Type[] exportedTypes;
  702. try
  703. {
  704. exportedTypes = ass.GetExportedTypes();
  705. }
  706. catch (FileNotFoundException ex)
  707. {
  708. Logger.LogError(ex, "Error getting exported types from {Assembly}", ass.FullName);
  709. continue;
  710. }
  711. foreach (Type type in exportedTypes)
  712. {
  713. if (type.IsClass && !type.IsAbstract && !type.IsInterface && !type.IsGenericType)
  714. {
  715. yield return type;
  716. }
  717. }
  718. }
  719. }
  720. private CertificateInfo CertificateInfo { get; set; }
  721. public X509Certificate2 Certificate { get; private set; }
  722. private IEnumerable<string> GetUrlPrefixes()
  723. {
  724. var hosts = new[] { "+" };
  725. return hosts.SelectMany(i =>
  726. {
  727. var prefixes = new List<string>
  728. {
  729. "http://" + i + ":" + HttpPort + "/"
  730. };
  731. if (CertificateInfo != null)
  732. {
  733. prefixes.Add("https://" + i + ":" + HttpsPort + "/");
  734. }
  735. return prefixes;
  736. });
  737. }
  738. /// <summary>
  739. /// Called when [configuration updated].
  740. /// </summary>
  741. /// <param name="sender">The sender.</param>
  742. /// <param name="e">The <see cref="EventArgs"/> instance containing the event data.</param>
  743. protected void OnConfigurationUpdated(object sender, EventArgs e)
  744. {
  745. var requiresRestart = false;
  746. // Don't do anything if these haven't been set yet
  747. if (HttpPort != 0 && HttpsPort != 0)
  748. {
  749. // Need to restart if ports have changed
  750. if (ServerConfigurationManager.Configuration.HttpServerPortNumber != HttpPort ||
  751. ServerConfigurationManager.Configuration.HttpsPortNumber != HttpsPort)
  752. {
  753. if (ServerConfigurationManager.Configuration.IsPortAuthorized)
  754. {
  755. ServerConfigurationManager.Configuration.IsPortAuthorized = false;
  756. ServerConfigurationManager.SaveConfiguration();
  757. requiresRestart = true;
  758. }
  759. }
  760. }
  761. if (!_httpServer.UrlPrefixes.SequenceEqual(GetUrlPrefixes(), StringComparer.OrdinalIgnoreCase))
  762. {
  763. requiresRestart = true;
  764. }
  765. var currentCertPath = CertificateInfo?.Path;
  766. var newCertPath = ServerConfigurationManager.Configuration.CertificatePath;
  767. if (!string.Equals(currentCertPath, newCertPath, StringComparison.OrdinalIgnoreCase))
  768. {
  769. requiresRestart = true;
  770. }
  771. if (requiresRestart)
  772. {
  773. Logger.LogInformation("App needs to be restarted due to configuration change.");
  774. NotifyPendingRestart();
  775. }
  776. }
  777. /// <summary>
  778. /// Notifies that the kernel that a change has been made that requires a restart
  779. /// </summary>
  780. public void NotifyPendingRestart()
  781. {
  782. Logger.LogInformation("App needs to be restarted.");
  783. var changed = !HasPendingRestart;
  784. HasPendingRestart = true;
  785. if (changed)
  786. {
  787. EventHelper.QueueEventIfNotNull(HasPendingRestartChanged, this, EventArgs.Empty, Logger);
  788. }
  789. }
  790. /// <summary>
  791. /// Restarts this instance.
  792. /// </summary>
  793. public void Restart()
  794. {
  795. if (!CanSelfRestart)
  796. {
  797. throw new PlatformNotSupportedException("The server is unable to self-restart. Please restart manually.");
  798. }
  799. if (IsShuttingDown)
  800. {
  801. return;
  802. }
  803. IsShuttingDown = true;
  804. Task.Run(async () =>
  805. {
  806. try
  807. {
  808. await _sessionManager.SendServerRestartNotification(CancellationToken.None).ConfigureAwait(false);
  809. }
  810. catch (Exception ex)
  811. {
  812. Logger.LogError(ex, "Error sending server restart notification");
  813. }
  814. Logger.LogInformation("Calling RestartInternal");
  815. RestartInternal();
  816. });
  817. }
  818. protected abstract void RestartInternal();
  819. /// <summary>
  820. /// Gets the composable part assemblies.
  821. /// </summary>
  822. /// <returns>IEnumerable{Assembly}.</returns>
  823. protected IEnumerable<Assembly> GetComposablePartAssemblies()
  824. {
  825. if (Directory.Exists(ApplicationPaths.PluginsPath))
  826. {
  827. foreach (var file in Directory.EnumerateFiles(ApplicationPaths.PluginsPath, "*.dll", SearchOption.AllDirectories))
  828. {
  829. Assembly plugAss;
  830. try
  831. {
  832. plugAss = Assembly.LoadFrom(file);
  833. }
  834. catch (FileLoadException ex)
  835. {
  836. Logger.LogError(ex, "Failed to load assembly {Path}", file);
  837. continue;
  838. }
  839. Logger.LogInformation("Loaded assembly {Assembly} from {Path}", plugAss.FullName, file);
  840. yield return plugAss;
  841. }
  842. }
  843. // Include composable parts in the Api assembly
  844. yield return typeof(ApiEntryPoint).Assembly;
  845. // Include composable parts in the Dashboard assembly
  846. yield return typeof(DashboardService).Assembly;
  847. // Include composable parts in the Model assembly
  848. yield return typeof(SystemInfo).Assembly;
  849. // Include composable parts in the Common assembly
  850. yield return typeof(IApplicationHost).Assembly;
  851. // Include composable parts in the Controller assembly
  852. yield return typeof(IServerApplicationHost).Assembly;
  853. // Include composable parts in the Providers assembly
  854. yield return typeof(ProviderUtils).Assembly;
  855. // Include composable parts in the Photos assembly
  856. yield return typeof(PhotoProvider).Assembly;
  857. // Emby.Server implementations
  858. yield return typeof(InstallationManager).Assembly;
  859. // MediaEncoding
  860. yield return typeof(MediaBrowser.MediaEncoding.Encoder.MediaEncoder).Assembly;
  861. // Dlna
  862. yield return typeof(DlnaEntryPoint).Assembly;
  863. // Local metadata
  864. yield return typeof(BoxSetXmlSaver).Assembly;
  865. // Notifications
  866. yield return typeof(NotificationManager).Assembly;
  867. // Xbmc
  868. yield return typeof(ArtistNfoProvider).Assembly;
  869. foreach (var i in GetAssembliesWithPartsInternal())
  870. {
  871. yield return i;
  872. }
  873. }
  874. protected abstract IEnumerable<Assembly> GetAssembliesWithPartsInternal();
  875. /// <summary>
  876. /// Gets the system status.
  877. /// </summary>
  878. /// <param name="cancellationToken">The cancellation token.</param>
  879. /// <returns>SystemInfo.</returns>
  880. public async Task<SystemInfo> GetSystemInfo(CancellationToken cancellationToken)
  881. {
  882. var localAddress = await GetLocalApiUrl(cancellationToken).ConfigureAwait(false);
  883. var transcodingTempPath = ConfigurationManager.GetTranscodePath();
  884. return new SystemInfo
  885. {
  886. HasPendingRestart = HasPendingRestart,
  887. IsShuttingDown = IsShuttingDown,
  888. Version = ApplicationVersionString,
  889. WebSocketPortNumber = HttpPort,
  890. CompletedInstallations = Resolve<IInstallationManager>().CompletedInstallations.ToArray(),
  891. Id = SystemId,
  892. ProgramDataPath = ApplicationPaths.ProgramDataPath,
  893. WebPath = ApplicationPaths.WebPath,
  894. LogPath = ApplicationPaths.LogDirectoryPath,
  895. ItemsByNamePath = ApplicationPaths.InternalMetadataPath,
  896. InternalMetadataPath = ApplicationPaths.InternalMetadataPath,
  897. CachePath = ApplicationPaths.CachePath,
  898. OperatingSystem = OperatingSystem.Id.ToString(),
  899. OperatingSystemDisplayName = OperatingSystem.Name,
  900. CanSelfRestart = CanSelfRestart,
  901. CanLaunchWebBrowser = CanLaunchWebBrowser,
  902. HasUpdateAvailable = HasUpdateAvailable,
  903. TranscodingTempPath = transcodingTempPath,
  904. ServerName = FriendlyName,
  905. LocalAddress = localAddress,
  906. SupportsLibraryMonitor = true,
  907. EncoderLocation = _mediaEncoder.EncoderLocation,
  908. SystemArchitecture = RuntimeInformation.OSArchitecture,
  909. PackageName = _startupOptions.PackageName
  910. };
  911. }
  912. public IEnumerable<WakeOnLanInfo> GetWakeOnLanInfo()
  913. => _networkManager.GetMacAddresses()
  914. .Select(i => new WakeOnLanInfo(i))
  915. .ToList();
  916. public async Task<PublicSystemInfo> GetPublicSystemInfo(CancellationToken cancellationToken)
  917. {
  918. var localAddress = await GetLocalApiUrl(cancellationToken).ConfigureAwait(false);
  919. return new PublicSystemInfo
  920. {
  921. Version = ApplicationVersionString,
  922. ProductName = ApplicationProductName,
  923. Id = SystemId,
  924. OperatingSystem = OperatingSystem.Id.ToString(),
  925. ServerName = FriendlyName,
  926. LocalAddress = localAddress
  927. };
  928. }
  929. /// <inheritdoc/>
  930. public bool ListenWithHttps => Certificate != null && ServerConfigurationManager.Configuration.EnableHttps;
  931. /// <inheritdoc/>
  932. public async Task<string> GetLocalApiUrl(CancellationToken cancellationToken)
  933. {
  934. try
  935. {
  936. // Return the first matched address, if found, or the first known local address
  937. var addresses = await GetLocalIpAddressesInternal(false, 1, cancellationToken).ConfigureAwait(false);
  938. if (addresses.Count == 0)
  939. {
  940. return null;
  941. }
  942. return GetLocalApiUrl(addresses.First());
  943. }
  944. catch (Exception ex)
  945. {
  946. Logger.LogError(ex, "Error getting local Ip address information");
  947. }
  948. return null;
  949. }
  950. /// <summary>
  951. /// Removes the scope id from IPv6 addresses.
  952. /// </summary>
  953. /// <param name="address">The IPv6 address.</param>
  954. /// <returns>The IPv6 address without the scope id.</returns>
  955. private ReadOnlySpan<char> RemoveScopeId(ReadOnlySpan<char> address)
  956. {
  957. var index = address.IndexOf('%');
  958. if (index == -1)
  959. {
  960. return address;
  961. }
  962. return address.Slice(0, index);
  963. }
  964. /// <inheritdoc />
  965. public string GetLocalApiUrl(IPAddress ipAddress)
  966. {
  967. if (ipAddress.AddressFamily == AddressFamily.InterNetworkV6)
  968. {
  969. var str = RemoveScopeId(ipAddress.ToString());
  970. Span<char> span = new char[str.Length + 2];
  971. span[0] = '[';
  972. str.CopyTo(span.Slice(1));
  973. span[^1] = ']';
  974. return GetLocalApiUrl(span);
  975. }
  976. return GetLocalApiUrl(ipAddress.ToString());
  977. }
  978. /// <inheritdoc/>
  979. public string GetLoopbackHttpApiUrl()
  980. {
  981. return GetLocalApiUrl("127.0.0.1", Uri.UriSchemeHttp, HttpPort);
  982. }
  983. /// <inheritdoc/>
  984. public string GetLocalApiUrl(ReadOnlySpan<char> host, string scheme = null, int? port = null)
  985. {
  986. // NOTE: If no BaseUrl is set then UriBuilder appends a trailing slash, but if there is no BaseUrl it does
  987. // not. For consistency, always trim the trailing slash.
  988. return new UriBuilder
  989. {
  990. Scheme = scheme ?? (ListenWithHttps ? Uri.UriSchemeHttps : Uri.UriSchemeHttp),
  991. Host = host.ToString(),
  992. Port = port ?? (ListenWithHttps ? HttpsPort : HttpPort),
  993. Path = ServerConfigurationManager.Configuration.BaseUrl
  994. }.ToString().TrimEnd('/');
  995. }
  996. public Task<List<IPAddress>> GetLocalIpAddresses(CancellationToken cancellationToken)
  997. {
  998. return GetLocalIpAddressesInternal(true, 0, cancellationToken);
  999. }
  1000. private async Task<List<IPAddress>> GetLocalIpAddressesInternal(bool allowLoopback, int limit, CancellationToken cancellationToken)
  1001. {
  1002. var addresses = ServerConfigurationManager
  1003. .Configuration
  1004. .LocalNetworkAddresses
  1005. .Select(NormalizeConfiguredLocalAddress)
  1006. .Where(i => i != null)
  1007. .ToList();
  1008. if (addresses.Count == 0)
  1009. {
  1010. addresses.AddRange(_networkManager.GetLocalIpAddresses(ServerConfigurationManager.Configuration.IgnoreVirtualInterfaces));
  1011. }
  1012. var resultList = new List<IPAddress>();
  1013. foreach (var address in addresses)
  1014. {
  1015. if (!allowLoopback)
  1016. {
  1017. if (address.Equals(IPAddress.Loopback) || address.Equals(IPAddress.IPv6Loopback))
  1018. {
  1019. continue;
  1020. }
  1021. }
  1022. var valid = await IsLocalIpAddressValidAsync(address, cancellationToken).ConfigureAwait(false);
  1023. if (valid)
  1024. {
  1025. resultList.Add(address);
  1026. if (limit > 0 && resultList.Count >= limit)
  1027. {
  1028. return resultList;
  1029. }
  1030. }
  1031. }
  1032. return resultList;
  1033. }
  1034. public IPAddress NormalizeConfiguredLocalAddress(string address)
  1035. {
  1036. var index = address.Trim('/').IndexOf('/');
  1037. if (index != -1)
  1038. {
  1039. address = address.Substring(index + 1);
  1040. }
  1041. if (IPAddress.TryParse(address.Trim('/'), out IPAddress result))
  1042. {
  1043. return result;
  1044. }
  1045. return null;
  1046. }
  1047. private readonly ConcurrentDictionary<string, bool> _validAddressResults = new ConcurrentDictionary<string, bool>(StringComparer.OrdinalIgnoreCase);
  1048. private async Task<bool> IsLocalIpAddressValidAsync(IPAddress address, CancellationToken cancellationToken)
  1049. {
  1050. if (address.Equals(IPAddress.Loopback)
  1051. || address.Equals(IPAddress.IPv6Loopback))
  1052. {
  1053. return true;
  1054. }
  1055. var apiUrl = GetLocalApiUrl(address) + "/system/ping";
  1056. if (_validAddressResults.TryGetValue(apiUrl, out var cachedResult))
  1057. {
  1058. return cachedResult;
  1059. }
  1060. try
  1061. {
  1062. using (var response = await _httpClient.SendAsync(
  1063. new HttpRequestOptions
  1064. {
  1065. Url = apiUrl,
  1066. LogErrorResponseBody = false,
  1067. BufferContent = false,
  1068. CancellationToken = cancellationToken
  1069. }, HttpMethod.Post).ConfigureAwait(false))
  1070. {
  1071. using (var reader = new StreamReader(response.Content))
  1072. {
  1073. var result = await reader.ReadToEndAsync().ConfigureAwait(false);
  1074. var valid = string.Equals(Name, result, StringComparison.OrdinalIgnoreCase);
  1075. _validAddressResults.AddOrUpdate(apiUrl, valid, (k, v) => valid);
  1076. Logger.LogDebug("Ping test result to {0}. Success: {1}", apiUrl, valid);
  1077. return valid;
  1078. }
  1079. }
  1080. }
  1081. catch (OperationCanceledException)
  1082. {
  1083. Logger.LogDebug("Ping test result to {0}. Success: {1}", apiUrl, "Cancelled");
  1084. throw;
  1085. }
  1086. catch (Exception ex)
  1087. {
  1088. Logger.LogDebug(ex, "Ping test result to {0}. Success: {1}", apiUrl, false);
  1089. _validAddressResults.AddOrUpdate(apiUrl, false, (k, v) => false);
  1090. return false;
  1091. }
  1092. }
  1093. public string FriendlyName =>
  1094. string.IsNullOrEmpty(ServerConfigurationManager.Configuration.ServerName)
  1095. ? Environment.MachineName
  1096. : ServerConfigurationManager.Configuration.ServerName;
  1097. /// <summary>
  1098. /// Shuts down.
  1099. /// </summary>
  1100. public async Task Shutdown()
  1101. {
  1102. if (IsShuttingDown)
  1103. {
  1104. return;
  1105. }
  1106. IsShuttingDown = true;
  1107. try
  1108. {
  1109. await _sessionManager.SendServerShutdownNotification(CancellationToken.None).ConfigureAwait(false);
  1110. }
  1111. catch (Exception ex)
  1112. {
  1113. Logger.LogError(ex, "Error sending server shutdown notification");
  1114. }
  1115. ShutdownInternal();
  1116. }
  1117. protected abstract void ShutdownInternal();
  1118. public event EventHandler HasUpdateAvailableChanged;
  1119. private bool _hasUpdateAvailable;
  1120. public bool HasUpdateAvailable
  1121. {
  1122. get => _hasUpdateAvailable;
  1123. set
  1124. {
  1125. var fireEvent = value && !_hasUpdateAvailable;
  1126. _hasUpdateAvailable = value;
  1127. if (fireEvent)
  1128. {
  1129. HasUpdateAvailableChanged?.Invoke(this, EventArgs.Empty);
  1130. }
  1131. }
  1132. }
  1133. /// <summary>
  1134. /// Removes the plugin.
  1135. /// </summary>
  1136. /// <param name="plugin">The plugin.</param>
  1137. public void RemovePlugin(IPlugin plugin)
  1138. {
  1139. var list = _plugins.ToList();
  1140. list.Remove(plugin);
  1141. _plugins = list.ToArray();
  1142. }
  1143. public virtual void LaunchUrl(string url)
  1144. {
  1145. if (!CanLaunchWebBrowser)
  1146. {
  1147. throw new NotSupportedException();
  1148. }
  1149. var process = new Process
  1150. {
  1151. StartInfo = new ProcessStartInfo
  1152. {
  1153. FileName = url,
  1154. UseShellExecute = true,
  1155. ErrorDialog = false
  1156. },
  1157. EnableRaisingEvents = true
  1158. };
  1159. process.Exited += (sender, args) => ((Process)sender).Dispose();
  1160. try
  1161. {
  1162. process.Start();
  1163. }
  1164. catch (Exception ex)
  1165. {
  1166. Logger.LogError(ex, "Error launching url: {url}", url);
  1167. throw;
  1168. }
  1169. }
  1170. public virtual void EnableLoopback(string appName)
  1171. {
  1172. }
  1173. private bool _disposed = false;
  1174. /// <summary>
  1175. /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
  1176. /// </summary>
  1177. public void Dispose()
  1178. {
  1179. Dispose(true);
  1180. GC.SuppressFinalize(this);
  1181. }
  1182. /// <summary>
  1183. /// Releases unmanaged and - optionally - managed resources.
  1184. /// </summary>
  1185. /// <param name="dispose"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
  1186. protected virtual void Dispose(bool dispose)
  1187. {
  1188. if (_disposed)
  1189. {
  1190. return;
  1191. }
  1192. if (dispose)
  1193. {
  1194. var type = GetType();
  1195. Logger.LogInformation("Disposing {Type}", type.Name);
  1196. var parts = _disposableParts.Distinct().Where(i => i.GetType() != type).ToList();
  1197. _disposableParts.Clear();
  1198. foreach (var part in parts)
  1199. {
  1200. Logger.LogInformation("Disposing {Type}", part.GetType().Name);
  1201. try
  1202. {
  1203. part.Dispose();
  1204. }
  1205. catch (Exception ex)
  1206. {
  1207. Logger.LogError(ex, "Error disposing {Type}", part.GetType().Name);
  1208. }
  1209. }
  1210. }
  1211. _disposed = true;
  1212. }
  1213. }
  1214. internal class CertificateInfo
  1215. {
  1216. public string Path { get; set; }
  1217. public string Password { get; set; }
  1218. }
  1219. }