mirror of
https://github.com/jellyfin/jellyfin.git
synced 2024-11-15 09:59:06 -07:00
Move DashboardController to Jellyfin.Api
This commit is contained in:
parent
e26f487fc8
commit
64fb173dad
@ -97,7 +97,6 @@ using MediaBrowser.Providers.Chapters;
|
||||
using MediaBrowser.Providers.Manager;
|
||||
using MediaBrowser.Providers.Plugins.TheTvdb;
|
||||
using MediaBrowser.Providers.Subtitles;
|
||||
using MediaBrowser.WebDashboard.Api;
|
||||
using MediaBrowser.XbmcMetadata.Providers;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
@ -1037,9 +1036,6 @@ namespace Emby.Server.Implementations
|
||||
// Include composable parts in the Api assembly
|
||||
yield return typeof(ApiEntryPoint).Assembly;
|
||||
|
||||
// Include composable parts in the Dashboard assembly
|
||||
yield return typeof(DashboardService).Assembly;
|
||||
|
||||
// Include composable parts in the Model assembly
|
||||
yield return typeof(SystemInfo).Assembly;
|
||||
|
||||
|
@ -13,7 +13,6 @@
|
||||
<ProjectReference Include="..\MediaBrowser.Common\MediaBrowser.Common.csproj" />
|
||||
<ProjectReference Include="..\MediaBrowser.Controller\MediaBrowser.Controller.csproj" />
|
||||
<ProjectReference Include="..\MediaBrowser.Providers\MediaBrowser.Providers.csproj" />
|
||||
<ProjectReference Include="..\MediaBrowser.WebDashboard\MediaBrowser.WebDashboard.csproj" />
|
||||
<ProjectReference Include="..\MediaBrowser.XbmcMetadata\MediaBrowser.XbmcMetadata.csproj" />
|
||||
<ProjectReference Include="..\Emby.Dlna\Emby.Dlna.csproj" />
|
||||
<ProjectReference Include="..\MediaBrowser.Api\MediaBrowser.Api.csproj" />
|
||||
|
264
Jellyfin.Api/Controllers/DashboardController.cs
Normal file
264
Jellyfin.Api/Controllers/DashboardController.cs
Normal file
@ -0,0 +1,264 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using Jellyfin.Api.Models;
|
||||
using MediaBrowser.Common.Plugins;
|
||||
using MediaBrowser.Controller;
|
||||
using MediaBrowser.Controller.Configuration;
|
||||
using MediaBrowser.Controller.Extensions;
|
||||
using MediaBrowser.Controller.Plugins;
|
||||
using MediaBrowser.Model.Net;
|
||||
using MediaBrowser.Model.Plugins;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using Microsoft.Extensions.Configuration;
|
||||
|
||||
namespace Jellyfin.Api.Controllers
|
||||
{
|
||||
/// <summary>
|
||||
/// The dashboard controller.
|
||||
/// </summary>
|
||||
public class DashboardController : BaseJellyfinApiController
|
||||
{
|
||||
private readonly IServerApplicationHost _appHost;
|
||||
private readonly IConfiguration _appConfig;
|
||||
private readonly IServerConfigurationManager _serverConfigurationManager;
|
||||
private readonly IResourceFileManager _resourceFileManager;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="DashboardController"/> class.
|
||||
/// </summary>
|
||||
/// <param name="appHost">Instance of <see cref="IServerApplicationHost"/> interface.</param>
|
||||
/// <param name="appConfig">Instance of <see cref="IConfiguration"/> interface.</param>
|
||||
/// <param name="resourceFileManager">Instance of <see cref="IResourceFileManager"/> interface.</param>
|
||||
/// <param name="serverConfigurationManager">Instance of <see cref="IServerConfigurationManager"/> interface.</param>
|
||||
public DashboardController(
|
||||
IServerApplicationHost appHost,
|
||||
IConfiguration appConfig,
|
||||
IResourceFileManager resourceFileManager,
|
||||
IServerConfigurationManager serverConfigurationManager)
|
||||
{
|
||||
_appHost = appHost;
|
||||
_appConfig = appConfig;
|
||||
_resourceFileManager = resourceFileManager;
|
||||
_serverConfigurationManager = serverConfigurationManager;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the path of the directory containing the static web interface content, or null if the server is not
|
||||
/// hosting the web client.
|
||||
/// </summary>
|
||||
private string? WebClientUiPath => GetWebClientUiPath(_appConfig, _serverConfigurationManager);
|
||||
|
||||
/// <summary>
|
||||
/// Gets the configuration pages.
|
||||
/// </summary>
|
||||
/// <param name="enableInMainMenu">Whether to enable in the main menu.</param>
|
||||
/// <param name="pageType">The <see cref="ConfigurationPageInfo"/>.</param>
|
||||
/// <response code="200">ConfigurationPages returned.</response>
|
||||
/// <response code="404">Server still loading.</response>
|
||||
/// <returns>An <see cref="IEnumerable{ConfigurationPageInfo}"/> with infos about the plugins.</returns>
|
||||
[HttpGet("/web/ConfigurationPages")]
|
||||
[ProducesResponseType(StatusCodes.Status200OK)]
|
||||
[ProducesResponseType(StatusCodes.Status404NotFound)]
|
||||
public ActionResult<IEnumerable<ConfigurationPageInfo>> GetConfigurationPages(
|
||||
[FromQuery] bool? enableInMainMenu,
|
||||
[FromQuery] ConfigurationPageType? pageType)
|
||||
{
|
||||
const string unavailableMessage = "The server is still loading. Please try again momentarily.";
|
||||
|
||||
var pages = _appHost.GetExports<IPluginConfigurationPage>().ToList();
|
||||
|
||||
if (pages == null)
|
||||
{
|
||||
return NotFound(unavailableMessage);
|
||||
}
|
||||
|
||||
// Don't allow a failing plugin to fail them all
|
||||
var configPages = pages.Select(p =>
|
||||
{
|
||||
return new ConfigurationPageInfo(p);
|
||||
})
|
||||
.Where(i => i != null)
|
||||
.ToList();
|
||||
|
||||
configPages.AddRange(_appHost.Plugins.SelectMany(GetConfigPages));
|
||||
|
||||
if (pageType != null)
|
||||
{
|
||||
configPages = configPages.Where(p => p.ConfigurationPageType == pageType).ToList();
|
||||
}
|
||||
|
||||
if (enableInMainMenu.HasValue)
|
||||
{
|
||||
configPages = configPages.Where(p => p.EnableInMainMenu == enableInMainMenu.Value).ToList();
|
||||
}
|
||||
|
||||
return configPages;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets a dashboard configuration page.
|
||||
/// </summary>
|
||||
/// <param name="name">The name of the page.</param>
|
||||
/// <response code="200">ConfigurationPage returned.</response>
|
||||
/// <response code="404">Plugin configuration page not found.</response>
|
||||
/// <returns>The configuration page.</returns>
|
||||
[HttpGet("/web/ConfigurationPage")]
|
||||
[ProducesResponseType(StatusCodes.Status200OK)]
|
||||
[ProducesResponseType(StatusCodes.Status404NotFound)]
|
||||
public ActionResult GetDashboardConfigurationPage([FromQuery] string name)
|
||||
{
|
||||
IPlugin? plugin = null;
|
||||
Stream? stream = null;
|
||||
|
||||
var isJs = false;
|
||||
var isTemplate = false;
|
||||
|
||||
var page = _appHost.GetExports<IPluginConfigurationPage>().FirstOrDefault(p => string.Equals(p.Name, 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, 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 File(stream, MimeTypes.GetMimeType("page.js"));
|
||||
}
|
||||
|
||||
if (isTemplate)
|
||||
{
|
||||
return File(stream, MimeTypes.GetMimeType("page.html"));
|
||||
}
|
||||
|
||||
return File(stream, MimeTypes.GetMimeType("page.html"));
|
||||
}
|
||||
|
||||
return NotFound();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the robots.txt.
|
||||
/// </summary>
|
||||
/// <response code="200">Robots.txt returned.</response>
|
||||
/// <returns>The robots.txt.</returns>
|
||||
[HttpGet("/robots.txt")]
|
||||
[ProducesResponseType(StatusCodes.Status200OK)]
|
||||
[ApiExplorerSettings(IgnoreApi = true)]
|
||||
public ActionResult GetRobotsTxt()
|
||||
{
|
||||
return GetWebClientResource("robots.txt", string.Empty);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets a resource from the web client.
|
||||
/// </summary>
|
||||
/// <param name="resourceName">The resource name.</param>
|
||||
/// <param name="v">The v.</param>
|
||||
/// <response code="200">Web client returned.</response>
|
||||
/// <response code="404">Server does not host a web client.</response>
|
||||
/// <returns>The resource.</returns>
|
||||
[HttpGet("/web/{*resourceName}")]
|
||||
[ApiExplorerSettings(IgnoreApi = true)]
|
||||
[ProducesResponseType(StatusCodes.Status200OK)]
|
||||
[ProducesResponseType(StatusCodes.Status404NotFound)]
|
||||
[SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "v", Justification = "Imported from ServiceStack")]
|
||||
public ActionResult GetWebClientResource(
|
||||
[FromRoute] string resourceName,
|
||||
[FromQuery] string? v)
|
||||
{
|
||||
if (!_appConfig.HostWebClient() || WebClientUiPath == null)
|
||||
{
|
||||
return NotFound("Server does not host a web client.");
|
||||
}
|
||||
|
||||
var path = resourceName;
|
||||
var basePath = WebClientUiPath;
|
||||
|
||||
// Bounce them to the startup wizard if it hasn't been completed yet
|
||||
if (!_serverConfigurationManager.Configuration.IsStartupWizardCompleted
|
||||
&& !Request.Path.Value.Contains("wizard", StringComparison.OrdinalIgnoreCase)
|
||||
&& Request.Path.Value.Contains("index", StringComparison.OrdinalIgnoreCase))
|
||||
{
|
||||
return Redirect("index.html?start=wizard#!/wizardstart.html");
|
||||
}
|
||||
|
||||
var stream = new FileStream(_resourceFileManager.GetResourcePath(basePath, path), FileMode.Open, FileAccess.Read);
|
||||
return File(stream, MimeTypes.GetMimeType(path));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the favicon.
|
||||
/// </summary>
|
||||
/// <response code="200">Favicon.ico returned.</response>
|
||||
/// <returns>The favicon.</returns>
|
||||
[HttpGet("/favicon.ico")]
|
||||
[ProducesResponseType(StatusCodes.Status200OK)]
|
||||
[ApiExplorerSettings(IgnoreApi = true)]
|
||||
public ActionResult GetFavIcon()
|
||||
{
|
||||
return GetWebClientResource("favicon.ico", string.Empty);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the path of the directory containing the static web interface content.
|
||||
/// </summary>
|
||||
/// <param name="appConfig">The app configuration.</param>
|
||||
/// <param name="serverConfigManager">The server configuration manager.</param>
|
||||
/// <returns>The directory path, or null if the server is not hosting the web client.</returns>
|
||||
public static string? GetWebClientUiPath(IConfiguration appConfig, IServerConfigurationManager serverConfigManager)
|
||||
{
|
||||
if (!appConfig.HostWebClient())
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
if (!string.IsNullOrEmpty(serverConfigManager.Configuration.DashboardSourcePath))
|
||||
{
|
||||
return serverConfigManager.Configuration.DashboardSourcePath;
|
||||
}
|
||||
|
||||
return serverConfigManager.ApplicationPaths.WebPath;
|
||||
}
|
||||
|
||||
private IEnumerable<ConfigurationPageInfo> GetConfigPages(IPlugin plugin)
|
||||
{
|
||||
return GetPluginPages(plugin).Select(i => new ConfigurationPageInfo(plugin, i.Item1));
|
||||
}
|
||||
|
||||
private IEnumerable<Tuple<PluginPageInfo, IPlugin>> GetPluginPages(IPlugin plugin)
|
||||
{
|
||||
var hasConfig = plugin as IHasWebPages;
|
||||
|
||||
if (hasConfig == null)
|
||||
{
|
||||
return new List<Tuple<PluginPageInfo, IPlugin>>();
|
||||
}
|
||||
|
||||
return hasConfig.GetPages().Select(i => new Tuple<PluginPageInfo, IPlugin>(i, plugin));
|
||||
}
|
||||
|
||||
private IEnumerable<Tuple<PluginPageInfo, IPlugin>> GetPluginPages()
|
||||
{
|
||||
return _appHost.Plugins.SelectMany(GetPluginPages);
|
||||
}
|
||||
}
|
||||
}
|
@ -1,13 +1,18 @@
|
||||
#pragma warning disable CS1591
|
||||
|
||||
using MediaBrowser.Common.Plugins;
|
||||
using MediaBrowser.Common.Plugins;
|
||||
using MediaBrowser.Controller.Plugins;
|
||||
using MediaBrowser.Model.Plugins;
|
||||
|
||||
namespace MediaBrowser.WebDashboard.Api
|
||||
namespace Jellyfin.Api.Models
|
||||
{
|
||||
/// <summary>
|
||||
/// The configuration page info.
|
||||
/// </summary>
|
||||
public class ConfigurationPageInfo
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="ConfigurationPageInfo"/> class.
|
||||
/// </summary>
|
||||
/// <param name="page">Instance of <see cref="IPluginConfigurationPage"/> interface.</param>
|
||||
public ConfigurationPageInfo(IPluginConfigurationPage page)
|
||||
{
|
||||
Name = page.Name;
|
||||
@ -22,6 +27,11 @@ namespace MediaBrowser.WebDashboard.Api
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="ConfigurationPageInfo"/> class.
|
||||
/// </summary>
|
||||
/// <param name="plugin">Instance of <see cref="IPlugin"/> interface.</param>
|
||||
/// <param name="page">Instance of <see cref="PluginPageInfo"/> interface.</param>
|
||||
public ConfigurationPageInfo(IPlugin plugin, PluginPageInfo page)
|
||||
{
|
||||
Name = page.Name;
|
||||
@ -40,13 +50,25 @@ namespace MediaBrowser.WebDashboard.Api
|
||||
/// <value>The name.</value>
|
||||
public string Name { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets a value indicating whether the configurations page is enabled in the main menu.
|
||||
/// </summary>
|
||||
public bool EnableInMainMenu { get; set; }
|
||||
|
||||
public string MenuSection { get; set; }
|
||||
/// <summary>
|
||||
/// Gets or sets the menu section.
|
||||
/// </summary>
|
||||
public string? MenuSection { get; set; }
|
||||
|
||||
public string MenuIcon { get; set; }
|
||||
/// <summary>
|
||||
/// Gets or sets the menu icon.
|
||||
/// </summary>
|
||||
public string? MenuIcon { get; set; }
|
||||
|
||||
public string DisplayName { get; set; }
|
||||
/// <summary>
|
||||
/// Gets or sets the display name.
|
||||
/// </summary>
|
||||
public string? DisplayName { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the type of the configuration page.
|
||||
@ -58,6 +80,6 @@ namespace MediaBrowser.WebDashboard.Api
|
||||
/// Gets or sets the plugin id.
|
||||
/// </summary>
|
||||
/// <value>The plugin id.</value>
|
||||
public string PluginId { get; set; }
|
||||
public string? PluginId { get; set; }
|
||||
}
|
||||
}
|
@ -14,9 +14,9 @@ using Emby.Server.Implementations;
|
||||
using Emby.Server.Implementations.HttpServer;
|
||||
using Emby.Server.Implementations.IO;
|
||||
using Emby.Server.Implementations.Networking;
|
||||
using Jellyfin.Api.Controllers;
|
||||
using MediaBrowser.Common.Configuration;
|
||||
using MediaBrowser.Controller.Extensions;
|
||||
using MediaBrowser.WebDashboard.Api;
|
||||
using Microsoft.AspNetCore.Hosting;
|
||||
using Microsoft.AspNetCore.Server.Kestrel.Core;
|
||||
using Microsoft.Extensions.Configuration;
|
||||
@ -172,7 +172,7 @@ namespace Jellyfin.Server
|
||||
// If hosting the web client, validate the client content path
|
||||
if (startupConfig.HostWebClient())
|
||||
{
|
||||
string webContentPath = DashboardService.GetDashboardUIPath(startupConfig, appHost.ServerConfigurationManager);
|
||||
string? webContentPath = DashboardController.GetWebClientUiPath(startupConfig, appHost.ServerConfigurationManager);
|
||||
if (!Directory.Exists(webContentPath) || Directory.GetFiles(webContentPath).Length == 0)
|
||||
{
|
||||
throw new InvalidOperationException(
|
||||
|
@ -1,340 +0,0 @@
|
||||
#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
|
||||
{
|
||||
/// <summary>
|
||||
/// Class GetDashboardConfigurationPages.
|
||||
/// </summary>
|
||||
[Route("/web/ConfigurationPages", "GET")]
|
||||
public class GetDashboardConfigurationPages : IReturn<List<ConfigurationPageInfo>>
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the type of the page.
|
||||
/// </summary>
|
||||
/// <value>The type of the page.</value>
|
||||
public ConfigurationPageType? PageType { get; set; }
|
||||
|
||||
public bool? EnableInMainMenu { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Class GetDashboardConfigurationPage.
|
||||
/// </summary>
|
||||
[Route("/web/ConfigurationPage", "GET")]
|
||||
public class GetDashboardConfigurationPage
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the name.
|
||||
/// </summary>
|
||||
/// <value>The name.</value>
|
||||
public string Name { get; set; }
|
||||
}
|
||||
|
||||
[Route("/robots.txt", "GET", IsHidden = true)]
|
||||
public class GetRobotsTxt
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Class GetDashboardResource.
|
||||
/// </summary>
|
||||
[Route("/web/{ResourceName*}", "GET", IsHidden = true)]
|
||||
public class GetDashboardResource
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the name.
|
||||
/// </summary>
|
||||
/// <value>The name.</value>
|
||||
public string ResourceName { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the V.
|
||||
/// </summary>
|
||||
/// <value>The V.</value>
|
||||
public string V { get; set; }
|
||||
}
|
||||
|
||||
[Route("/favicon.ico", "GET", IsHidden = true)]
|
||||
public class GetFavIcon
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Class DashboardService.
|
||||
/// </summary>
|
||||
public class DashboardService : IService, IRequiresRequest
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the logger.
|
||||
/// </summary>
|
||||
/// <value>The logger.</value>
|
||||
private readonly ILogger<DashboardService> _logger;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the HTTP result factory.
|
||||
/// </summary>
|
||||
/// <value>The HTTP result factory.</value>
|
||||
private readonly IHttpResultFactory _resultFactory;
|
||||
private readonly IServerApplicationHost _appHost;
|
||||
private readonly IConfiguration _appConfig;
|
||||
private readonly IServerConfigurationManager _serverConfigurationManager;
|
||||
private readonly IFileSystem _fileSystem;
|
||||
private readonly IResourceFileManager _resourceFileManager;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="DashboardService" /> class.
|
||||
/// </summary>
|
||||
/// <param name="logger">The logger.</param>
|
||||
/// <param name="appHost">The application host.</param>
|
||||
/// <param name="appConfig">The application configuration.</param>
|
||||
/// <param name="resourceFileManager">The resource file manager.</param>
|
||||
/// <param name="serverConfigurationManager">The server configuration manager.</param>
|
||||
/// <param name="fileSystem">The file system.</param>
|
||||
/// <param name="resultFactory">The result factory.</param>
|
||||
public DashboardService(
|
||||
ILogger<DashboardService> 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;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the request context.
|
||||
/// </summary>
|
||||
/// <value>The request context.</value>
|
||||
public IRequest Request { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the path of the directory containing the static web interface content, or null if the server is not
|
||||
/// hosting the web client.
|
||||
/// </summary>
|
||||
public string DashboardUIPath => GetDashboardUIPath(_appConfig, _serverConfigurationManager);
|
||||
|
||||
/// <summary>
|
||||
/// Gets the path of the directory containing the static web interface content.
|
||||
/// </summary>
|
||||
/// <param name="appConfig">The app configuration.</param>
|
||||
/// <param name="serverConfigManager">The server configuration manager.</param>
|
||||
/// <returns>The directory path, or null if the server is not hosting the web client.</returns>
|
||||
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"
|
||||
});
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the specified request.
|
||||
/// </summary>
|
||||
/// <param name="request">The request.</param>
|
||||
/// <returns>System.Object.</returns>
|
||||
[SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "request", Justification = "Required for ServiceStack")]
|
||||
public Task<object> 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();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the specified request.
|
||||
/// </summary>
|
||||
/// <param name="request">The request.</param>
|
||||
/// <returns>System.Object.</returns>
|
||||
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<Tuple<PluginPageInfo, IPlugin>> GetPluginPages()
|
||||
{
|
||||
return _appHost.Plugins.SelectMany(GetPluginPages);
|
||||
}
|
||||
|
||||
private IEnumerable<Tuple<PluginPageInfo, IPlugin>> GetPluginPages(IPlugin plugin)
|
||||
{
|
||||
var hasConfig = plugin as IHasWebPages;
|
||||
|
||||
if (hasConfig == null)
|
||||
{
|
||||
return new List<Tuple<PluginPageInfo, IPlugin>>();
|
||||
}
|
||||
|
||||
return hasConfig.GetPages().Select(i => new Tuple<PluginPageInfo, IPlugin>(i, plugin));
|
||||
}
|
||||
|
||||
private IEnumerable<ConfigurationPageInfo> 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"
|
||||
});
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the specified request.
|
||||
/// </summary>
|
||||
/// <param name="request">The request.</param>
|
||||
/// <returns>System.Object.</returns>
|
||||
public async Task<object> 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);
|
||||
}
|
||||
}
|
||||
}
|
@ -1,42 +0,0 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
|
||||
<!-- ProjectGuid is only included as a requirement for SonarQube analysis -->
|
||||
<PropertyGroup>
|
||||
<ProjectGuid>{5624B7B5-B5A7-41D8-9F10-CC5611109619}</ProjectGuid>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<ProjectReference Include="..\MediaBrowser.Controller\MediaBrowser.Controller.csproj" />
|
||||
<ProjectReference Include="..\MediaBrowser.Common\MediaBrowser.Common.csproj" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<Compile Include="..\SharedVersion.cs" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<None Include="jellyfin-web\**\*.*">
|
||||
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
|
||||
</None>
|
||||
</ItemGroup>
|
||||
|
||||
<PropertyGroup>
|
||||
<TargetFramework>netstandard2.1</TargetFramework>
|
||||
<GenerateAssemblyInfo>false</GenerateAssemblyInfo>
|
||||
<GenerateDocumentationFile>true</GenerateDocumentationFile>
|
||||
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
|
||||
</PropertyGroup>
|
||||
|
||||
<!-- Code Analyzers-->
|
||||
<ItemGroup Condition=" '$(Configuration)' == 'Debug' ">
|
||||
<PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.9.8" PrivateAssets="All" />
|
||||
<PackageReference Include="SerilogAnalyzer" Version="0.15.0" PrivateAssets="All" />
|
||||
<PackageReference Include="StyleCop.Analyzers" Version="1.1.118" PrivateAssets="All" />
|
||||
<PackageReference Include="SmartAnalyzers.MultithreadingAnalyzer" Version="1.1.31" PrivateAssets="All" />
|
||||
</ItemGroup>
|
||||
|
||||
<PropertyGroup Condition=" '$(Configuration)' == 'Debug' ">
|
||||
<CodeAnalysisRuleSet>../jellyfin.ruleset</CodeAnalysisRuleSet>
|
||||
</PropertyGroup>
|
||||
|
||||
</Project>
|
@ -1,21 +0,0 @@
|
||||
using System.Reflection;
|
||||
using System.Resources;
|
||||
using System.Runtime.InteropServices;
|
||||
|
||||
// General Information about an assembly is controlled through the following
|
||||
// set of attributes. Change these attribute values to modify the information
|
||||
// associated with an assembly.
|
||||
[assembly: AssemblyTitle("MediaBrowser.WebDashboard")]
|
||||
[assembly: AssemblyDescription("")]
|
||||
[assembly: AssemblyConfiguration("")]
|
||||
[assembly: AssemblyCompany("Jellyfin Project")]
|
||||
[assembly: AssemblyProduct("Jellyfin Server")]
|
||||
[assembly: AssemblyCopyright("Copyright © 2019 Jellyfin Contributors. Code released under the GNU General Public License")]
|
||||
[assembly: AssemblyTrademark("")]
|
||||
[assembly: AssemblyCulture("")]
|
||||
[assembly: NeutralResourcesLanguage("en")]
|
||||
|
||||
// Setting ComVisible to false makes the types in this assembly not visible
|
||||
// to COM components. If you need to access a type in this assembly from
|
||||
// COM, set the ComVisible attribute to true on that type.
|
||||
[assembly: ComVisible(false)]
|
@ -1,42 +0,0 @@
|
||||
#pragma warning disable CS1591
|
||||
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Threading.Tasks;
|
||||
using MediaBrowser.Common;
|
||||
using MediaBrowser.Controller.Plugins;
|
||||
|
||||
namespace MediaBrowser.WebDashboard
|
||||
{
|
||||
public sealed class ServerEntryPoint : IServerEntryPoint
|
||||
{
|
||||
private readonly IApplicationHost _appHost;
|
||||
|
||||
public ServerEntryPoint(IApplicationHost appHost)
|
||||
{
|
||||
_appHost = appHost;
|
||||
Instance = this;
|
||||
}
|
||||
|
||||
public static ServerEntryPoint Instance { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the list of plugin configuration pages.
|
||||
/// </summary>
|
||||
/// <value>The configuration pages.</value>
|
||||
public List<IPluginConfigurationPage> PluginConfigurationPages { get; private set; }
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task RunAsync()
|
||||
{
|
||||
PluginConfigurationPages = _appHost.GetExports<IPluginConfigurationPage>().ToList();
|
||||
|
||||
return Task.CompletedTask;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public void Dispose()
|
||||
{
|
||||
}
|
||||
}
|
||||
}
|
@ -12,8 +12,6 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MediaBrowser.Common", "Medi
|
||||
EndProject
|
||||
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MediaBrowser.Model", "MediaBrowser.Model\MediaBrowser.Model.csproj", "{7EEEB4BB-F3E8-48FC-B4C5-70F0FFF8329B}"
|
||||
EndProject
|
||||
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MediaBrowser.WebDashboard", "MediaBrowser.WebDashboard\MediaBrowser.WebDashboard.csproj", "{5624B7B5-B5A7-41D8-9F10-CC5611109619}"
|
||||
EndProject
|
||||
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MediaBrowser.Providers", "MediaBrowser.Providers\MediaBrowser.Providers.csproj", "{442B5058-DCAF-4263-BB6A-F21E31120A1B}"
|
||||
EndProject
|
||||
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MediaBrowser.XbmcMetadata", "MediaBrowser.XbmcMetadata\MediaBrowser.XbmcMetadata.csproj", "{23499896-B135-4527-8574-C26E926EA99E}"
|
||||
@ -94,10 +92,6 @@ Global
|
||||
{7EEEB4BB-F3E8-48FC-B4C5-70F0FFF8329B}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
||||
{7EEEB4BB-F3E8-48FC-B4C5-70F0FFF8329B}.Release|Any CPU.ActiveCfg = Release|Any CPU
|
||||
{7EEEB4BB-F3E8-48FC-B4C5-70F0FFF8329B}.Release|Any CPU.Build.0 = Release|Any CPU
|
||||
{5624B7B5-B5A7-41D8-9F10-CC5611109619}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
|
||||
{5624B7B5-B5A7-41D8-9F10-CC5611109619}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
||||
{5624B7B5-B5A7-41D8-9F10-CC5611109619}.Release|Any CPU.ActiveCfg = Release|Any CPU
|
||||
{5624B7B5-B5A7-41D8-9F10-CC5611109619}.Release|Any CPU.Build.0 = Release|Any CPU
|
||||
{442B5058-DCAF-4263-BB6A-F21E31120A1B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
|
||||
{442B5058-DCAF-4263-BB6A-F21E31120A1B}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
||||
{442B5058-DCAF-4263-BB6A-F21E31120A1B}.Release|Any CPU.ActiveCfg = Release|Any CPU
|
||||
|
Loading…
Reference in New Issue
Block a user