ApplicationHost.cs 55 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493
  1. #pragma warning disable CS1591
  2. using System;
  3. using System.Collections.Concurrent;
  4. using System.Collections.Generic;
  5. using System.Diagnostics;
  6. using System.Globalization;
  7. using System.IO;
  8. using System.Linq;
  9. using System.Net;
  10. using System.Net.Http;
  11. using System.Net.Sockets;
  12. using System.Reflection;
  13. using System.Runtime.InteropServices;
  14. using System.Security.Cryptography.X509Certificates;
  15. using System.Text;
  16. using System.Threading;
  17. using System.Threading.Tasks;
  18. using Emby.Dlna;
  19. using Emby.Dlna.Main;
  20. using Emby.Dlna.Ssdp;
  21. using Emby.Drawing;
  22. using Emby.Notifications;
  23. using Emby.Photos;
  24. using Emby.Server.Implementations.Archiving;
  25. using Emby.Server.Implementations.Channels;
  26. using Emby.Server.Implementations.Collections;
  27. using Emby.Server.Implementations.Configuration;
  28. using Emby.Server.Implementations.Cryptography;
  29. using Emby.Server.Implementations.Data;
  30. using Emby.Server.Implementations.Devices;
  31. using Emby.Server.Implementations.Dto;
  32. using Emby.Server.Implementations.HttpServer;
  33. using Emby.Server.Implementations.HttpServer.Security;
  34. using Emby.Server.Implementations.IO;
  35. using Emby.Server.Implementations.Library;
  36. using Emby.Server.Implementations.LiveTv;
  37. using Emby.Server.Implementations.Localization;
  38. using Emby.Server.Implementations.Net;
  39. using Emby.Server.Implementations.Playlists;
  40. using Emby.Server.Implementations.ScheduledTasks;
  41. using Emby.Server.Implementations.Security;
  42. using Emby.Server.Implementations.Serialization;
  43. using Emby.Server.Implementations.Services;
  44. using Emby.Server.Implementations.Session;
  45. using Emby.Server.Implementations.TV;
  46. using Emby.Server.Implementations.Updates;
  47. using MediaBrowser.Api;
  48. using MediaBrowser.Common;
  49. using MediaBrowser.Common.Configuration;
  50. using MediaBrowser.Common.Events;
  51. using MediaBrowser.Common.Net;
  52. using MediaBrowser.Common.Plugins;
  53. using MediaBrowser.Common.Updates;
  54. using MediaBrowser.Controller;
  55. using MediaBrowser.Controller.Authentication;
  56. using MediaBrowser.Controller.Channels;
  57. using MediaBrowser.Controller.Chapters;
  58. using MediaBrowser.Controller.Collections;
  59. using MediaBrowser.Controller.Configuration;
  60. using MediaBrowser.Controller.Devices;
  61. using MediaBrowser.Controller.Dlna;
  62. using MediaBrowser.Controller.Drawing;
  63. using MediaBrowser.Controller.Dto;
  64. using MediaBrowser.Controller.Entities;
  65. using MediaBrowser.Controller.Library;
  66. using MediaBrowser.Controller.LiveTv;
  67. using MediaBrowser.Controller.MediaEncoding;
  68. using MediaBrowser.Controller.Net;
  69. using MediaBrowser.Controller.Notifications;
  70. using MediaBrowser.Controller.Persistence;
  71. using MediaBrowser.Controller.Playlists;
  72. using MediaBrowser.Controller.Plugins;
  73. using MediaBrowser.Controller.Providers;
  74. using MediaBrowser.Controller.Resolvers;
  75. using MediaBrowser.Controller.Security;
  76. using MediaBrowser.Controller.Session;
  77. using MediaBrowser.Controller.Sorting;
  78. using MediaBrowser.Controller.Subtitles;
  79. using MediaBrowser.Controller.TV;
  80. using MediaBrowser.LocalMetadata.Savers;
  81. using MediaBrowser.MediaEncoding.BdInfo;
  82. using MediaBrowser.Model.Configuration;
  83. using MediaBrowser.Model.Cryptography;
  84. using MediaBrowser.Model.Dlna;
  85. using MediaBrowser.Model.Globalization;
  86. using MediaBrowser.Model.IO;
  87. using MediaBrowser.Model.MediaInfo;
  88. using MediaBrowser.Model.Net;
  89. using MediaBrowser.Model.Serialization;
  90. using MediaBrowser.Model.Services;
  91. using MediaBrowser.Model.System;
  92. using MediaBrowser.Model.Tasks;
  93. using MediaBrowser.Providers.Chapters;
  94. using MediaBrowser.Providers.Manager;
  95. using MediaBrowser.Providers.Plugins.TheTvdb;
  96. using MediaBrowser.Providers.Subtitles;
  97. using MediaBrowser.WebDashboard.Api;
  98. using MediaBrowser.XbmcMetadata.Providers;
  99. using Microsoft.AspNetCore.Http;
  100. using Microsoft.Extensions.DependencyInjection;
  101. using Microsoft.Extensions.Logging;
  102. using Prometheus.DotNetRuntime;
  103. using OperatingSystem = MediaBrowser.Common.System.OperatingSystem;
  104. namespace Emby.Server.Implementations
  105. {
  106. /// <summary>
  107. /// Class CompositionRoot.
  108. /// </summary>
  109. public abstract class ApplicationHost : IServerApplicationHost, IDisposable
  110. {
  111. /// <summary>
  112. /// The environment variable prefixes to log at server startup.
  113. /// </summary>
  114. private static readonly string[] _relevantEnvVarPrefixes = { "JELLYFIN_", "DOTNET_", "ASPNETCORE_" };
  115. private readonly IFileSystem _fileSystemManager;
  116. private readonly INetworkManager _networkManager;
  117. private readonly IXmlSerializer _xmlSerializer;
  118. private readonly IStartupOptions _startupOptions;
  119. private IMediaEncoder _mediaEncoder;
  120. private ISessionManager _sessionManager;
  121. private IHttpServer _httpServer;
  122. private IHttpClient _httpClient;
  123. /// <summary>
  124. /// Gets a value indicating whether this instance can self restart.
  125. /// </summary>
  126. public bool CanSelfRestart => _startupOptions.RestartPath != null;
  127. public virtual bool CanLaunchWebBrowser
  128. {
  129. get
  130. {
  131. if (!Environment.UserInteractive)
  132. {
  133. return false;
  134. }
  135. if (_startupOptions.IsService)
  136. {
  137. return false;
  138. }
  139. if (OperatingSystem.Id == OperatingSystemId.Windows
  140. || OperatingSystem.Id == OperatingSystemId.Darwin)
  141. {
  142. return true;
  143. }
  144. return false;
  145. }
  146. }
  147. /// <summary>
  148. /// Occurs when [has pending restart changed].
  149. /// </summary>
  150. public event EventHandler HasPendingRestartChanged;
  151. /// <summary>
  152. /// Gets a value indicating whether this instance has changes that require the entire application to restart.
  153. /// </summary>
  154. /// <value><c>true</c> if this instance has pending application restart; otherwise, <c>false</c>.</value>
  155. public bool HasPendingRestart { get; private set; }
  156. /// <inheritdoc />
  157. public bool IsShuttingDown { get; private set; }
  158. /// <summary>
  159. /// Gets the logger.
  160. /// </summary>
  161. protected ILogger Logger { get; }
  162. private IPlugin[] _plugins;
  163. /// <summary>
  164. /// Gets the plugins.
  165. /// </summary>
  166. /// <value>The plugins.</value>
  167. public IReadOnlyList<IPlugin> Plugins => _plugins;
  168. /// <summary>
  169. /// Gets the logger factory.
  170. /// </summary>
  171. protected ILoggerFactory LoggerFactory { get; }
  172. /// <summary>
  173. /// Gets or sets the application paths.
  174. /// </summary>
  175. /// <value>The application paths.</value>
  176. protected ServerApplicationPaths ApplicationPaths { get; set; }
  177. /// <summary>
  178. /// Gets or sets all concrete types.
  179. /// </summary>
  180. /// <value>All concrete types.</value>
  181. private Type[] _allConcreteTypes;
  182. /// <summary>
  183. /// The disposable parts.
  184. /// </summary>
  185. private readonly List<IDisposable> _disposableParts = new List<IDisposable>();
  186. /// <summary>
  187. /// Gets the configuration manager.
  188. /// </summary>
  189. /// <value>The configuration manager.</value>
  190. protected IConfigurationManager ConfigurationManager { get; set; }
  191. /// <summary>
  192. /// Gets or sets the service provider.
  193. /// </summary>
  194. public IServiceProvider ServiceProvider { get; set; }
  195. /// <summary>
  196. /// Gets the http port for the webhost.
  197. /// </summary>
  198. public int HttpPort { get; private set; }
  199. /// <summary>
  200. /// Gets the https port for the webhost.
  201. /// </summary>
  202. public int HttpsPort { get; private set; }
  203. /// <summary>
  204. /// Gets the server configuration manager.
  205. /// </summary>
  206. /// <value>The server configuration manager.</value>
  207. public IServerConfigurationManager ServerConfigurationManager => (IServerConfigurationManager)ConfigurationManager;
  208. /// <summary>
  209. /// Initializes a new instance of the <see cref="ApplicationHost" /> class.
  210. /// </summary>
  211. public ApplicationHost(
  212. ServerApplicationPaths applicationPaths,
  213. ILoggerFactory loggerFactory,
  214. IStartupOptions options,
  215. IFileSystem fileSystem,
  216. INetworkManager networkManager)
  217. {
  218. _xmlSerializer = new MyXmlSerializer();
  219. _networkManager = networkManager;
  220. networkManager.LocalSubnetsFn = GetConfiguredLocalSubnets;
  221. ApplicationPaths = applicationPaths;
  222. LoggerFactory = loggerFactory;
  223. _fileSystemManager = fileSystem;
  224. ConfigurationManager = new ServerConfigurationManager(ApplicationPaths, LoggerFactory, _xmlSerializer, _fileSystemManager);
  225. Logger = LoggerFactory.CreateLogger<ApplicationHost>();
  226. _startupOptions = options;
  227. // Initialize runtime stat collection
  228. if (ServerConfigurationManager.Configuration.EnableMetrics)
  229. {
  230. DotNetRuntimeStatsBuilder.Default().StartCollecting();
  231. }
  232. fileSystem.AddShortcutHandler(new MbLinkShortcutHandler(fileSystem));
  233. _networkManager.NetworkChanged += OnNetworkChanged;
  234. CertificateInfo = new CertificateInfo
  235. {
  236. Path = ServerConfigurationManager.Configuration.CertificatePath,
  237. Password = ServerConfigurationManager.Configuration.CertificatePassword
  238. };
  239. Certificate = GetCertificate(CertificateInfo);
  240. }
  241. public string ExpandVirtualPath(string path)
  242. {
  243. var appPaths = ApplicationPaths;
  244. return path.Replace(appPaths.VirtualDataPath, appPaths.DataPath, StringComparison.OrdinalIgnoreCase)
  245. .Replace(appPaths.VirtualInternalMetadataPath, appPaths.InternalMetadataPath, StringComparison.OrdinalIgnoreCase);
  246. }
  247. public string ReverseVirtualPath(string path)
  248. {
  249. var appPaths = ApplicationPaths;
  250. return path.Replace(appPaths.DataPath, appPaths.VirtualDataPath, StringComparison.OrdinalIgnoreCase)
  251. .Replace(appPaths.InternalMetadataPath, appPaths.VirtualInternalMetadataPath, StringComparison.OrdinalIgnoreCase);
  252. }
  253. private string[] GetConfiguredLocalSubnets()
  254. {
  255. return ServerConfigurationManager.Configuration.LocalNetworkSubnets;
  256. }
  257. private void OnNetworkChanged(object sender, EventArgs e)
  258. {
  259. _validAddressResults.Clear();
  260. }
  261. /// <inheritdoc />
  262. public Version ApplicationVersion { get; } = typeof(ApplicationHost).Assembly.GetName().Version;
  263. /// <inheritdoc />
  264. public string ApplicationVersionString { get; } = typeof(ApplicationHost).Assembly.GetName().Version.ToString(3);
  265. /// <summary>
  266. /// Gets the current application user agent.
  267. /// </summary>
  268. /// <value>The application user agent.</value>
  269. public string ApplicationUserAgent => Name.Replace(' ', '-') + "/" + ApplicationVersionString;
  270. /// <summary>
  271. /// Gets the email address for use within a comment section of a user agent field.
  272. /// Presently used to provide contact information to MusicBrainz service.
  273. /// </summary>
  274. public string ApplicationUserAgentAddress { get; } = "team@jellyfin.org";
  275. /// <summary>
  276. /// Gets the current application name.
  277. /// </summary>
  278. /// <value>The application name.</value>
  279. public string ApplicationProductName { get; } = FileVersionInfo.GetVersionInfo(Assembly.GetEntryAssembly().Location).ProductName;
  280. private DeviceId _deviceId;
  281. public string SystemId
  282. {
  283. get
  284. {
  285. if (_deviceId == null)
  286. {
  287. _deviceId = new DeviceId(ApplicationPaths, LoggerFactory);
  288. }
  289. return _deviceId.Value;
  290. }
  291. }
  292. /// <inheritdoc/>
  293. public string Name => ApplicationProductName;
  294. /// <summary>
  295. /// Creates an instance of type and resolves all constructor dependencies.
  296. /// </summary>
  297. /// <param name="type">The type.</param>
  298. /// <returns>System.Object.</returns>
  299. public object CreateInstance(Type type)
  300. => ActivatorUtilities.CreateInstance(ServiceProvider, type);
  301. /// <summary>
  302. /// Creates an instance of type and resolves all constructor dependencies.
  303. /// </summary>
  304. /// /// <typeparam name="T">The type.</typeparam>
  305. /// <returns>T.</returns>
  306. public T CreateInstance<T>()
  307. => ActivatorUtilities.CreateInstance<T>(ServiceProvider);
  308. /// <summary>
  309. /// Creates the instance safe.
  310. /// </summary>
  311. /// <param name="type">The type.</param>
  312. /// <returns>System.Object.</returns>
  313. protected object CreateInstanceSafe(Type type)
  314. {
  315. try
  316. {
  317. Logger.LogDebug("Creating instance of {Type}", type);
  318. return ActivatorUtilities.CreateInstance(ServiceProvider, type);
  319. }
  320. catch (Exception ex)
  321. {
  322. Logger.LogError(ex, "Error creating {Type}", type);
  323. return null;
  324. }
  325. }
  326. /// <summary>
  327. /// Resolves this instance.
  328. /// </summary>
  329. /// <typeparam name="T">The type</typeparam>
  330. /// <returns>``0.</returns>
  331. public T Resolve<T>() => ServiceProvider.GetService<T>();
  332. /// <summary>
  333. /// Gets the export types.
  334. /// </summary>
  335. /// <typeparam name="T">The type.</typeparam>
  336. /// <returns>IEnumerable{Type}.</returns>
  337. public IEnumerable<Type> GetExportTypes<T>()
  338. {
  339. var currentType = typeof(T);
  340. return _allConcreteTypes.Where(i => currentType.IsAssignableFrom(i));
  341. }
  342. /// <inheritdoc />
  343. public IReadOnlyCollection<T> GetExports<T>(bool manageLifetime = true)
  344. {
  345. // Convert to list so this isn't executed for each iteration
  346. var parts = GetExportTypes<T>()
  347. .Select(CreateInstanceSafe)
  348. .Where(i => i != null)
  349. .Cast<T>()
  350. .ToList();
  351. if (manageLifetime)
  352. {
  353. lock (_disposableParts)
  354. {
  355. _disposableParts.AddRange(parts.OfType<IDisposable>());
  356. }
  357. }
  358. return parts;
  359. }
  360. /// <summary>
  361. /// Runs the startup tasks.
  362. /// </summary>
  363. /// <returns><see cref="Task" />.</returns>
  364. public async Task RunStartupTasksAsync()
  365. {
  366. Logger.LogInformation("Running startup tasks");
  367. Resolve<ITaskManager>().AddTasks(GetExports<IScheduledTask>(false));
  368. ConfigurationManager.ConfigurationUpdated += OnConfigurationUpdated;
  369. _mediaEncoder.SetFFmpegPath();
  370. Logger.LogInformation("ServerId: {0}", SystemId);
  371. var entryPoints = GetExports<IServerEntryPoint>();
  372. var stopWatch = new Stopwatch();
  373. stopWatch.Start();
  374. await Task.WhenAll(StartEntryPoints(entryPoints, true)).ConfigureAwait(false);
  375. Logger.LogInformation("Executed all pre-startup entry points in {Elapsed:g}", stopWatch.Elapsed);
  376. Logger.LogInformation("Core startup complete");
  377. _httpServer.GlobalResponse = null;
  378. stopWatch.Restart();
  379. await Task.WhenAll(StartEntryPoints(entryPoints, false)).ConfigureAwait(false);
  380. Logger.LogInformation("Executed all post-startup entry points in {Elapsed:g}", stopWatch.Elapsed);
  381. stopWatch.Stop();
  382. }
  383. private IEnumerable<Task> StartEntryPoints(IEnumerable<IServerEntryPoint> entryPoints, bool isBeforeStartup)
  384. {
  385. foreach (var entryPoint in entryPoints)
  386. {
  387. if (isBeforeStartup != (entryPoint is IRunBeforeStartup))
  388. {
  389. continue;
  390. }
  391. Logger.LogDebug("Starting entry point {Type}", entryPoint.GetType());
  392. yield return entryPoint.RunAsync();
  393. }
  394. }
  395. /// <inheritdoc/>
  396. public void Init(IServiceCollection serviceCollection)
  397. {
  398. HttpPort = ServerConfigurationManager.Configuration.HttpServerPortNumber;
  399. HttpsPort = ServerConfigurationManager.Configuration.HttpsPortNumber;
  400. // Safeguard against invalid configuration
  401. if (HttpPort == HttpsPort)
  402. {
  403. HttpPort = ServerConfiguration.DefaultHttpPort;
  404. HttpsPort = ServerConfiguration.DefaultHttpsPort;
  405. }
  406. if (Plugins != null)
  407. {
  408. var pluginBuilder = new StringBuilder();
  409. foreach (var plugin in Plugins)
  410. {
  411. pluginBuilder.AppendLine(
  412. string.Format(
  413. CultureInfo.InvariantCulture,
  414. "{0} {1}",
  415. plugin.Name,
  416. plugin.Version));
  417. }
  418. Logger.LogInformation("Plugins: {Plugins}", pluginBuilder.ToString());
  419. }
  420. DiscoverTypes();
  421. RegisterServices(serviceCollection);
  422. }
  423. public Task ExecuteHttpHandlerAsync(HttpContext context, Func<Task> next)
  424. => _httpServer.RequestHandler(context);
  425. /// <summary>
  426. /// Registers services/resources with the service collection that will be available via DI.
  427. /// </summary>
  428. protected virtual void RegisterServices(IServiceCollection serviceCollection)
  429. {
  430. serviceCollection.AddSingleton(_startupOptions);
  431. serviceCollection.AddMemoryCache();
  432. serviceCollection.AddSingleton(ConfigurationManager);
  433. serviceCollection.AddSingleton<IApplicationHost>(this);
  434. serviceCollection.AddSingleton<IApplicationPaths>(ApplicationPaths);
  435. serviceCollection.AddSingleton<IJsonSerializer, JsonSerializer>();
  436. serviceCollection.AddSingleton(_fileSystemManager);
  437. serviceCollection.AddSingleton<TvdbClientManager>();
  438. serviceCollection.AddSingleton<IHttpClient, HttpClientManager.HttpClientManager>();
  439. serviceCollection.AddSingleton(_networkManager);
  440. serviceCollection.AddSingleton<IIsoManager, IsoManager>();
  441. serviceCollection.AddSingleton<ITaskManager, TaskManager>();
  442. serviceCollection.AddSingleton(_xmlSerializer);
  443. serviceCollection.AddSingleton<IStreamHelper, StreamHelper>();
  444. serviceCollection.AddSingleton<ICryptoProvider, CryptographyProvider>();
  445. serviceCollection.AddSingleton<ISocketFactory, SocketFactory>();
  446. serviceCollection.AddSingleton<IInstallationManager, InstallationManager>();
  447. serviceCollection.AddSingleton<IZipClient, ZipClient>();
  448. serviceCollection.AddSingleton<IHttpResultFactory, HttpResultFactory>();
  449. serviceCollection.AddSingleton<IServerApplicationHost>(this);
  450. serviceCollection.AddSingleton<IServerApplicationPaths>(ApplicationPaths);
  451. serviceCollection.AddSingleton(ServerConfigurationManager);
  452. serviceCollection.AddSingleton<ILocalizationManager, LocalizationManager>();
  453. serviceCollection.AddSingleton<IBlurayExaminer, BdInfoExaminer>();
  454. serviceCollection.AddSingleton<IUserDataRepository, SqliteUserDataRepository>();
  455. serviceCollection.AddSingleton<IUserDataManager, UserDataManager>();
  456. serviceCollection.AddSingleton<IDisplayPreferencesRepository, SqliteDisplayPreferencesRepository>();
  457. serviceCollection.AddSingleton<IItemRepository, SqliteItemRepository>();
  458. serviceCollection.AddSingleton<IAuthenticationRepository, AuthenticationRepository>();
  459. serviceCollection.AddSingleton<IUserRepository, SqliteUserRepository>();
  460. // TODO: Refactor to eliminate the circular dependency here so that Lazy<T> isn't required
  461. serviceCollection.AddTransient(provider => new Lazy<IDtoService>(provider.GetRequiredService<IDtoService>));
  462. serviceCollection.AddSingleton<IUserManager, UserManager>();
  463. // TODO: Refactor to eliminate the circular dependency here so that Lazy<T> isn't required
  464. // TODO: Add StartupOptions.FFmpegPath to IConfiguration and remove this custom activation
  465. serviceCollection.AddTransient(provider => new Lazy<EncodingHelper>(provider.GetRequiredService<EncodingHelper>));
  466. serviceCollection.AddSingleton<IMediaEncoder>(provider =>
  467. ActivatorUtilities.CreateInstance<MediaBrowser.MediaEncoding.Encoder.MediaEncoder>(provider, _startupOptions.FFmpegPath ?? string.Empty));
  468. // TODO: Refactor to eliminate the circular dependencies here so that Lazy<T> isn't required
  469. serviceCollection.AddTransient(provider => new Lazy<ILibraryMonitor>(provider.GetRequiredService<ILibraryMonitor>));
  470. serviceCollection.AddTransient(provider => new Lazy<IProviderManager>(provider.GetRequiredService<IProviderManager>));
  471. serviceCollection.AddTransient(provider => new Lazy<IUserViewManager>(provider.GetRequiredService<IUserViewManager>));
  472. serviceCollection.AddSingleton<ILibraryManager, LibraryManager>();
  473. serviceCollection.AddSingleton<IMusicManager, MusicManager>();
  474. serviceCollection.AddSingleton<ILibraryMonitor, LibraryMonitor>();
  475. serviceCollection.AddSingleton<ISearchEngine, SearchEngine>();
  476. serviceCollection.AddSingleton<ServiceController>();
  477. serviceCollection.AddSingleton<IHttpServer, HttpListenerHost>();
  478. serviceCollection.AddSingleton<IImageProcessor, ImageProcessor>();
  479. serviceCollection.AddSingleton<ITVSeriesManager, TVSeriesManager>();
  480. serviceCollection.AddSingleton<IDeviceManager, DeviceManager>();
  481. serviceCollection.AddSingleton<IMediaSourceManager, MediaSourceManager>();
  482. serviceCollection.AddSingleton<ISubtitleManager, SubtitleManager>();
  483. serviceCollection.AddSingleton<IProviderManager, ProviderManager>();
  484. // TODO: Refactor to eliminate the circular dependency here so that Lazy<T> isn't required
  485. serviceCollection.AddTransient(provider => new Lazy<ILiveTvManager>(provider.GetRequiredService<ILiveTvManager>));
  486. serviceCollection.AddSingleton<IDtoService, DtoService>();
  487. serviceCollection.AddSingleton<IChannelManager, ChannelManager>();
  488. serviceCollection.AddSingleton<ISessionManager, SessionManager>();
  489. serviceCollection.AddSingleton<IDlnaManager, DlnaManager>();
  490. serviceCollection.AddSingleton<ICollectionManager, CollectionManager>();
  491. serviceCollection.AddSingleton<IPlaylistManager, PlaylistManager>();
  492. serviceCollection.AddSingleton<LiveTvDtoService>();
  493. serviceCollection.AddSingleton<ILiveTvManager, LiveTvManager>();
  494. serviceCollection.AddSingleton<IUserViewManager, UserViewManager>();
  495. serviceCollection.AddSingleton<INotificationManager, NotificationManager>();
  496. serviceCollection.AddSingleton<IDeviceDiscovery, DeviceDiscovery>();
  497. serviceCollection.AddSingleton<IChapterManager, ChapterManager>();
  498. serviceCollection.AddSingleton<IEncodingManager, MediaEncoder.EncodingManager>();
  499. serviceCollection.AddSingleton<IAuthorizationContext, AuthorizationContext>();
  500. serviceCollection.AddSingleton<ISessionContext, SessionContext>();
  501. serviceCollection.AddSingleton<IAuthService, AuthService>();
  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. ((SqliteUserRepository)Resolve<IUserRepository>()).Initialize();
  522. SetStaticProperties();
  523. var userManager = (UserManager)Resolve<IUserManager>();
  524. userManager.Initialize();
  525. var userDataRepo = (SqliteUserDataRepository)Resolve<IUserDataRepository>();
  526. ((SqliteItemRepository)Resolve<IItemRepository>()).Initialize(userDataRepo, userManager);
  527. FindParts();
  528. }
  529. public static void LogEnvironmentInfo(ILogger logger, IApplicationPaths appPaths)
  530. {
  531. // Distinct these to prevent users from reporting problems that aren't actually problems
  532. var commandLineArgs = Environment
  533. .GetCommandLineArgs()
  534. .Distinct();
  535. // Get all relevant environment variables
  536. var allEnvVars = Environment.GetEnvironmentVariables();
  537. var relevantEnvVars = new Dictionary<object, object>();
  538. foreach (var key in allEnvVars.Keys)
  539. {
  540. if (_relevantEnvVarPrefixes.Any(prefix => key.ToString().StartsWith(prefix, StringComparison.OrdinalIgnoreCase)))
  541. {
  542. relevantEnvVars.Add(key, allEnvVars[key]);
  543. }
  544. }
  545. logger.LogInformation("Environment Variables: {EnvVars}", relevantEnvVars);
  546. logger.LogInformation("Arguments: {Args}", commandLineArgs);
  547. logger.LogInformation("Operating system: {OS}", OperatingSystem.Name);
  548. logger.LogInformation("Architecture: {Architecture}", RuntimeInformation.OSArchitecture);
  549. logger.LogInformation("64-Bit Process: {Is64Bit}", Environment.Is64BitProcess);
  550. logger.LogInformation("User Interactive: {IsUserInteractive}", Environment.UserInteractive);
  551. logger.LogInformation("Processor count: {ProcessorCount}", Environment.ProcessorCount);
  552. logger.LogInformation("Program data path: {ProgramDataPath}", appPaths.ProgramDataPath);
  553. logger.LogInformation("Web resources path: {WebPath}", appPaths.WebPath);
  554. logger.LogInformation("Application directory: {ApplicationPath}", appPaths.ProgramSystemPath);
  555. }
  556. private X509Certificate2 GetCertificate(CertificateInfo info)
  557. {
  558. var certificateLocation = info?.Path;
  559. if (string.IsNullOrWhiteSpace(certificateLocation))
  560. {
  561. return null;
  562. }
  563. try
  564. {
  565. if (!File.Exists(certificateLocation))
  566. {
  567. return null;
  568. }
  569. // Don't use an empty string password
  570. var password = string.IsNullOrWhiteSpace(info.Password) ? null : info.Password;
  571. var localCert = new X509Certificate2(certificateLocation, password);
  572. // localCert.PrivateKey = PrivateKey.CreateFromFile(pvk_file).RSA;
  573. if (!localCert.HasPrivateKey)
  574. {
  575. Logger.LogError("No private key included in SSL cert {CertificateLocation}.", certificateLocation);
  576. return null;
  577. }
  578. return localCert;
  579. }
  580. catch (Exception ex)
  581. {
  582. Logger.LogError(ex, "Error loading cert from {CertificateLocation}", certificateLocation);
  583. return null;
  584. }
  585. }
  586. /// <summary>
  587. /// Dirty hacks.
  588. /// </summary>
  589. private void SetStaticProperties()
  590. {
  591. // For now there's no real way to inject these properly
  592. BaseItem.Logger = Resolve<ILogger<BaseItem>>();
  593. BaseItem.ConfigurationManager = ServerConfigurationManager;
  594. BaseItem.LibraryManager = Resolve<ILibraryManager>();
  595. BaseItem.ProviderManager = Resolve<IProviderManager>();
  596. BaseItem.LocalizationManager = Resolve<ILocalizationManager>();
  597. BaseItem.ItemRepository = Resolve<IItemRepository>();
  598. User.UserManager = Resolve<IUserManager>();
  599. BaseItem.FileSystem = _fileSystemManager;
  600. BaseItem.UserDataManager = Resolve<IUserDataManager>();
  601. BaseItem.ChannelManager = Resolve<IChannelManager>();
  602. Video.LiveTvManager = Resolve<ILiveTvManager>();
  603. Folder.UserViewManager = Resolve<IUserViewManager>();
  604. UserView.TVSeriesManager = Resolve<ITVSeriesManager>();
  605. UserView.CollectionManager = Resolve<ICollectionManager>();
  606. BaseItem.MediaSourceManager = Resolve<IMediaSourceManager>();
  607. CollectionFolder.XmlSerializer = _xmlSerializer;
  608. CollectionFolder.JsonSerializer = Resolve<IJsonSerializer>();
  609. CollectionFolder.ApplicationHost = this;
  610. AuthenticatedAttribute.AuthService = Resolve<IAuthService>();
  611. }
  612. /// <summary>
  613. /// Finds plugin components and register them with the appropriate services.
  614. /// </summary>
  615. private void FindParts()
  616. {
  617. if (!ServerConfigurationManager.Configuration.IsPortAuthorized)
  618. {
  619. ServerConfigurationManager.Configuration.IsPortAuthorized = true;
  620. ConfigurationManager.SaveConfiguration();
  621. }
  622. ConfigurationManager.AddParts(GetExports<IConfigurationFactory>());
  623. _plugins = GetExports<IPlugin>()
  624. .Select(LoadPlugin)
  625. .Where(i => i != null)
  626. .ToArray();
  627. _httpServer.Init(GetExportTypes<IService>(), GetExports<IWebSocketListener>(), GetUrlPrefixes());
  628. Resolve<ILibraryManager>().AddParts(
  629. GetExports<IResolverIgnoreRule>(),
  630. GetExports<IItemResolver>(),
  631. GetExports<IIntroProvider>(),
  632. GetExports<IBaseItemComparer>(),
  633. GetExports<ILibraryPostScanTask>());
  634. Resolve<IProviderManager>().AddParts(
  635. GetExports<IImageProvider>(),
  636. GetExports<IMetadataService>(),
  637. GetExports<IMetadataProvider>(),
  638. GetExports<IMetadataSaver>(),
  639. GetExports<IExternalId>());
  640. Resolve<ILiveTvManager>().AddParts(GetExports<ILiveTvService>(), GetExports<ITunerHost>(), GetExports<IListingsProvider>());
  641. Resolve<ISubtitleManager>().AddParts(GetExports<ISubtitleProvider>());
  642. Resolve<IChannelManager>().AddParts(GetExports<IChannel>());
  643. Resolve<IMediaSourceManager>().AddParts(GetExports<IMediaSourceProvider>());
  644. Resolve<INotificationManager>().AddParts(GetExports<INotificationService>(), GetExports<INotificationTypeFactory>());
  645. Resolve<IUserManager>().AddParts(GetExports<IAuthenticationProvider>(), GetExports<IPasswordResetProvider>());
  646. Resolve<IIsoManager>().AddParts(GetExports<IIsoMounter>());
  647. }
  648. private IPlugin LoadPlugin(IPlugin plugin)
  649. {
  650. try
  651. {
  652. if (plugin is IPluginAssembly assemblyPlugin)
  653. {
  654. var assembly = plugin.GetType().Assembly;
  655. var assemblyName = assembly.GetName();
  656. var assemblyFilePath = assembly.Location;
  657. var dataFolderPath = Path.Combine(ApplicationPaths.PluginsPath, Path.GetFileNameWithoutExtension(assemblyFilePath));
  658. assemblyPlugin.SetAttributes(assemblyFilePath, dataFolderPath, assemblyName.Version);
  659. try
  660. {
  661. var idAttributes = assembly.GetCustomAttributes(typeof(GuidAttribute), true);
  662. if (idAttributes.Length > 0)
  663. {
  664. var attribute = (GuidAttribute)idAttributes[0];
  665. var assemblyId = new Guid(attribute.Value);
  666. assemblyPlugin.SetId(assemblyId);
  667. }
  668. }
  669. catch (Exception ex)
  670. {
  671. Logger.LogError(ex, "Error getting plugin Id from {PluginName}.", plugin.GetType().FullName);
  672. }
  673. }
  674. if (plugin is IHasPluginConfiguration hasPluginConfiguration)
  675. {
  676. hasPluginConfiguration.SetStartupInfo(s => Directory.CreateDirectory(s));
  677. }
  678. }
  679. catch (Exception ex)
  680. {
  681. Logger.LogError(ex, "Error loading plugin {PluginName}", plugin.GetType().FullName);
  682. return null;
  683. }
  684. return plugin;
  685. }
  686. /// <summary>
  687. /// Discovers the types.
  688. /// </summary>
  689. protected void DiscoverTypes()
  690. {
  691. Logger.LogInformation("Loading assemblies");
  692. _allConcreteTypes = GetTypes(GetComposablePartAssemblies()).ToArray();
  693. }
  694. private IEnumerable<Type> GetTypes(IEnumerable<Assembly> assemblies)
  695. {
  696. foreach (var ass in assemblies)
  697. {
  698. Type[] exportedTypes;
  699. try
  700. {
  701. exportedTypes = ass.GetExportedTypes();
  702. }
  703. catch (FileNotFoundException ex)
  704. {
  705. Logger.LogError(ex, "Error getting exported 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.First());
  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(NormalizeConfiguredLocalAddress)
  1003. .Where(i => i != null)
  1004. .ToList();
  1005. if (addresses.Count == 0)
  1006. {
  1007. addresses.AddRange(_networkManager.GetLocalIpAddresses(ServerConfigurationManager.Configuration.IgnoreVirtualInterfaces));
  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. var valid = await IsLocalIpAddressValidAsync(address, cancellationToken).ConfigureAwait(false);
  1020. if (valid)
  1021. {
  1022. resultList.Add(address);
  1023. if (limit > 0 && resultList.Count >= limit)
  1024. {
  1025. return resultList;
  1026. }
  1027. }
  1028. }
  1029. return resultList;
  1030. }
  1031. public IPAddress NormalizeConfiguredLocalAddress(string address)
  1032. {
  1033. var index = address.Trim('/').IndexOf('/');
  1034. if (index != -1)
  1035. {
  1036. address = address.Substring(index + 1);
  1037. }
  1038. if (IPAddress.TryParse(address.Trim('/'), out IPAddress result))
  1039. {
  1040. return result;
  1041. }
  1042. return null;
  1043. }
  1044. private readonly ConcurrentDictionary<string, bool> _validAddressResults = new ConcurrentDictionary<string, bool>(StringComparer.OrdinalIgnoreCase);
  1045. private async Task<bool> IsLocalIpAddressValidAsync(IPAddress address, CancellationToken cancellationToken)
  1046. {
  1047. if (address.Equals(IPAddress.Loopback)
  1048. || address.Equals(IPAddress.IPv6Loopback))
  1049. {
  1050. return true;
  1051. }
  1052. var apiUrl = GetLocalApiUrl(address) + "/system/ping";
  1053. if (_validAddressResults.TryGetValue(apiUrl, out var cachedResult))
  1054. {
  1055. return cachedResult;
  1056. }
  1057. try
  1058. {
  1059. using (var response = await _httpClient.SendAsync(
  1060. new HttpRequestOptions
  1061. {
  1062. Url = apiUrl,
  1063. LogErrorResponseBody = false,
  1064. BufferContent = false,
  1065. CancellationToken = cancellationToken
  1066. }, HttpMethod.Post).ConfigureAwait(false))
  1067. {
  1068. using (var reader = new StreamReader(response.Content))
  1069. {
  1070. var result = await reader.ReadToEndAsync().ConfigureAwait(false);
  1071. var valid = string.Equals(Name, result, StringComparison.OrdinalIgnoreCase);
  1072. _validAddressResults.AddOrUpdate(apiUrl, valid, (k, v) => valid);
  1073. Logger.LogDebug("Ping test result to {0}. Success: {1}", apiUrl, valid);
  1074. return valid;
  1075. }
  1076. }
  1077. }
  1078. catch (OperationCanceledException)
  1079. {
  1080. Logger.LogDebug("Ping test result to {0}. Success: {1}", apiUrl, "Cancelled");
  1081. throw;
  1082. }
  1083. catch (Exception ex)
  1084. {
  1085. Logger.LogDebug(ex, "Ping test result to {0}. Success: {1}", apiUrl, false);
  1086. _validAddressResults.AddOrUpdate(apiUrl, false, (k, v) => false);
  1087. return false;
  1088. }
  1089. }
  1090. public string FriendlyName =>
  1091. string.IsNullOrEmpty(ServerConfigurationManager.Configuration.ServerName)
  1092. ? Environment.MachineName
  1093. : ServerConfigurationManager.Configuration.ServerName;
  1094. /// <summary>
  1095. /// Shuts down.
  1096. /// </summary>
  1097. public async Task Shutdown()
  1098. {
  1099. if (IsShuttingDown)
  1100. {
  1101. return;
  1102. }
  1103. IsShuttingDown = true;
  1104. try
  1105. {
  1106. await _sessionManager.SendServerShutdownNotification(CancellationToken.None).ConfigureAwait(false);
  1107. }
  1108. catch (Exception ex)
  1109. {
  1110. Logger.LogError(ex, "Error sending server shutdown notification");
  1111. }
  1112. ShutdownInternal();
  1113. }
  1114. protected abstract void ShutdownInternal();
  1115. public event EventHandler HasUpdateAvailableChanged;
  1116. private bool _hasUpdateAvailable;
  1117. public bool HasUpdateAvailable
  1118. {
  1119. get => _hasUpdateAvailable;
  1120. set
  1121. {
  1122. var fireEvent = value && !_hasUpdateAvailable;
  1123. _hasUpdateAvailable = value;
  1124. if (fireEvent)
  1125. {
  1126. HasUpdateAvailableChanged?.Invoke(this, EventArgs.Empty);
  1127. }
  1128. }
  1129. }
  1130. /// <summary>
  1131. /// Removes the plugin.
  1132. /// </summary>
  1133. /// <param name="plugin">The plugin.</param>
  1134. public void RemovePlugin(IPlugin plugin)
  1135. {
  1136. var list = _plugins.ToList();
  1137. list.Remove(plugin);
  1138. _plugins = list.ToArray();
  1139. }
  1140. public virtual void LaunchUrl(string url)
  1141. {
  1142. if (!CanLaunchWebBrowser)
  1143. {
  1144. throw new NotSupportedException();
  1145. }
  1146. var process = new Process
  1147. {
  1148. StartInfo = new ProcessStartInfo
  1149. {
  1150. FileName = url,
  1151. UseShellExecute = true,
  1152. ErrorDialog = false
  1153. },
  1154. EnableRaisingEvents = true
  1155. };
  1156. process.Exited += (sender, args) => ((Process)sender).Dispose();
  1157. try
  1158. {
  1159. process.Start();
  1160. }
  1161. catch (Exception ex)
  1162. {
  1163. Logger.LogError(ex, "Error launching url: {url}", url);
  1164. throw;
  1165. }
  1166. }
  1167. public virtual void EnableLoopback(string appName)
  1168. {
  1169. }
  1170. private bool _disposed = false;
  1171. /// <summary>
  1172. /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
  1173. /// </summary>
  1174. public void Dispose()
  1175. {
  1176. Dispose(true);
  1177. GC.SuppressFinalize(this);
  1178. }
  1179. /// <summary>
  1180. /// Releases unmanaged and - optionally - managed resources.
  1181. /// </summary>
  1182. /// <param name="dispose"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
  1183. protected virtual void Dispose(bool dispose)
  1184. {
  1185. if (_disposed)
  1186. {
  1187. return;
  1188. }
  1189. if (dispose)
  1190. {
  1191. var type = GetType();
  1192. Logger.LogInformation("Disposing {Type}", type.Name);
  1193. var parts = _disposableParts.Distinct().Where(i => i.GetType() != type).ToList();
  1194. _disposableParts.Clear();
  1195. foreach (var part in parts)
  1196. {
  1197. Logger.LogInformation("Disposing {Type}", part.GetType().Name);
  1198. try
  1199. {
  1200. part.Dispose();
  1201. }
  1202. catch (Exception ex)
  1203. {
  1204. Logger.LogError(ex, "Error disposing {Type}", part.GetType().Name);
  1205. }
  1206. }
  1207. }
  1208. _disposed = true;
  1209. }
  1210. }
  1211. internal class CertificateInfo
  1212. {
  1213. public string Path { get; set; }
  1214. public string Password { get; set; }
  1215. }
  1216. }