ApplicationHost.cs 56 KB

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