ApplicationHost.cs 54 KB

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