ApplicationHost.cs 54 KB

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