#pragma warning disable CS1591 #pragma warning disable SA1402 #pragma warning disable SA1649 using System; using System.Collections.Generic; using System.Diagnostics.CodeAnalysis; using System.IO; using System.Linq; using System.Threading.Tasks; using MediaBrowser.Common.Extensions; using MediaBrowser.Common.Plugins; using MediaBrowser.Controller; using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Extensions; using MediaBrowser.Controller.Net; using MediaBrowser.Controller.Plugins; using MediaBrowser.Model.IO; using MediaBrowser.Model.Net; using MediaBrowser.Model.Plugins; using MediaBrowser.Model.Services; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging; namespace MediaBrowser.WebDashboard.Api { /// /// Class GetDashboardConfigurationPages. /// [Route("/web/ConfigurationPages", "GET")] public class GetDashboardConfigurationPages : IReturn> { /// /// Gets or sets the type of the page. /// /// The type of the page. public ConfigurationPageType? PageType { get; set; } public bool? EnableInMainMenu { get; set; } } /// /// Class GetDashboardConfigurationPage. /// [Route("/web/ConfigurationPage", "GET")] public class GetDashboardConfigurationPage { /// /// Gets or sets the name. /// /// The name. public string Name { get; set; } } [Route("/robots.txt", "GET", IsHidden = true)] public class GetRobotsTxt { } /// /// Class GetDashboardResource. /// [Route("/web/{ResourceName*}", "GET", IsHidden = true)] public class GetDashboardResource { /// /// Gets or sets the name. /// /// The name. public string ResourceName { get; set; } /// /// Gets or sets the V. /// /// The V. public string V { get; set; } } [Route("/favicon.ico", "GET", IsHidden = true)] public class GetFavIcon { } /// /// Class DashboardService. /// public class DashboardService : IService, IRequiresRequest { /// /// Gets or sets the logger. /// /// The logger. private readonly ILogger _logger; /// /// Gets or sets the HTTP result factory. /// /// The HTTP result factory. private readonly IHttpResultFactory _resultFactory; private readonly IServerApplicationHost _appHost; private readonly IConfiguration _appConfig; private readonly IServerConfigurationManager _serverConfigurationManager; private readonly IFileSystem _fileSystem; private readonly IResourceFileManager _resourceFileManager; /// /// Initializes a new instance of the class. /// /// The logger. /// The application host. /// The application configuration. /// The resource file manager. /// The server configuration manager. /// The file system. /// The result factory. public DashboardService( ILogger logger, IServerApplicationHost appHost, IConfiguration appConfig, IResourceFileManager resourceFileManager, IServerConfigurationManager serverConfigurationManager, IFileSystem fileSystem, IHttpResultFactory resultFactory) { _logger = logger; _appHost = appHost; _appConfig = appConfig; _resourceFileManager = resourceFileManager; _serverConfigurationManager = serverConfigurationManager; _fileSystem = fileSystem; _resultFactory = resultFactory; } /// /// Gets or sets the request context. /// /// The request context. public IRequest Request { get; set; } /// /// Gets the path of the directory containing the static web interface content, or null if the server is not /// hosting the web client. /// public string DashboardUIPath => GetDashboardUIPath(_appConfig, _serverConfigurationManager); /// /// Gets the path of the directory containing the static web interface content. /// /// The app configuration. /// The server configuration manager. /// The directory path, or null if the server is not hosting the web client. public static string GetDashboardUIPath(IConfiguration appConfig, IServerConfigurationManager serverConfigManager) { if (!appConfig.HostWebClient()) { return null; } if (!string.IsNullOrEmpty(serverConfigManager.Configuration.DashboardSourcePath)) { return serverConfigManager.Configuration.DashboardSourcePath; } return serverConfigManager.ApplicationPaths.WebPath; } [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "request", Justification = "Required for ServiceStack")] public object Get(GetFavIcon request) { return Get(new GetDashboardResource { ResourceName = "favicon.ico" }); } /// /// Gets the specified request. /// /// The request. /// System.Object. [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "request", Justification = "Required for ServiceStack")] public Task Get(GetDashboardConfigurationPage request) { IPlugin plugin = null; Stream stream = null; var isJs = false; var isTemplate = false; var page = ServerEntryPoint.Instance.PluginConfigurationPages.FirstOrDefault(p => string.Equals(p.Name, request.Name, StringComparison.OrdinalIgnoreCase)); if (page != null) { plugin = page.Plugin; stream = page.GetHtmlStream(); } if (plugin == null) { var altPage = GetPluginPages().FirstOrDefault(p => string.Equals(p.Item1.Name, request.Name, StringComparison.OrdinalIgnoreCase)); if (altPage != null) { plugin = altPage.Item2; stream = plugin.GetType().Assembly.GetManifestResourceStream(altPage.Item1.EmbeddedResourcePath); isJs = string.Equals(Path.GetExtension(altPage.Item1.EmbeddedResourcePath), ".js", StringComparison.OrdinalIgnoreCase); isTemplate = altPage.Item1.EmbeddedResourcePath.EndsWith(".template.html", StringComparison.Ordinal); } } if (plugin != null && stream != null) { if (isJs) { return _resultFactory.GetStaticResult(Request, plugin.Version.ToString().GetMD5(), null, null, MimeTypes.GetMimeType("page.js"), () => Task.FromResult(stream)); } if (isTemplate) { return _resultFactory.GetStaticResult(Request, plugin.Version.ToString().GetMD5(), null, null, MimeTypes.GetMimeType("page.html"), () => Task.FromResult(stream)); } return _resultFactory.GetStaticResult(Request, plugin.Version.ToString().GetMD5(), null, null, MimeTypes.GetMimeType("page.html"), () => Task.FromResult(stream)); } throw new ResourceNotFoundException(); } /// /// Gets the specified request. /// /// The request. /// System.Object. public object Get(GetDashboardConfigurationPages request) { const string unavailableMessage = "The server is still loading. Please try again momentarily."; var instance = ServerEntryPoint.Instance; if (instance == null) { throw new InvalidOperationException(unavailableMessage); } var pages = instance.PluginConfigurationPages; if (pages == null) { throw new InvalidOperationException(unavailableMessage); } // Don't allow a failing plugin to fail them all var configPages = pages.Select(p => { try { return new ConfigurationPageInfo(p); } catch (Exception ex) { _logger.LogError(ex, "Error getting plugin information from {Plugin}", p.GetType().Name); return null; } }) .Where(i => i != null) .ToList(); configPages.AddRange(_appHost.Plugins.SelectMany(GetConfigPages)); if (request.PageType.HasValue) { configPages = configPages.Where(p => p.ConfigurationPageType == request.PageType.Value).ToList(); } if (request.EnableInMainMenu.HasValue) { configPages = configPages.Where(p => p.EnableInMainMenu == request.EnableInMainMenu.Value).ToList(); } return configPages; } private IEnumerable> GetPluginPages() { return _appHost.Plugins.SelectMany(GetPluginPages); } private IEnumerable> GetPluginPages(IPlugin plugin) { var hasConfig = plugin as IHasWebPages; if (hasConfig == null) { return new List>(); } return hasConfig.GetPages().Select(i => new Tuple(i, plugin)); } private IEnumerable GetConfigPages(IPlugin plugin) { return GetPluginPages(plugin).Select(i => new ConfigurationPageInfo(plugin, i.Item1)); } [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "request", Justification = "Required for ServiceStack")] public object Get(GetRobotsTxt request) { return Get(new GetDashboardResource { ResourceName = "robots.txt" }); } /// /// Gets the specified request. /// /// The request. /// System.Object. public async Task Get(GetDashboardResource request) { if (!_appConfig.HostWebClient() || DashboardUIPath == null) { throw new ResourceNotFoundException(); } var path = request?.ResourceName; var basePath = DashboardUIPath; // Bounce them to the startup wizard if it hasn't been completed yet if (!_serverConfigurationManager.Configuration.IsStartupWizardCompleted && !Request.RawUrl.Contains("wizard", StringComparison.OrdinalIgnoreCase) && Request.RawUrl.Contains("index", StringComparison.OrdinalIgnoreCase)) { Request.Response.Redirect("index.html?start=wizard#!/wizardstart.html"); return null; } return await _resultFactory.GetStaticFileResult(Request, _resourceFileManager.GetResourcePath(basePath, path)).ConfigureAwait(false); } } }