ApplicationHost.cs 51 KB

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