aboutsummaryrefslogtreecommitdiff
path: root/Jellyfin.Api/Controllers/DashboardController.cs
diff options
context:
space:
mode:
authorDominik <git@secnd.me>2023-06-15 19:38:42 +0200
committerGitHub <noreply@github.com>2023-06-15 19:38:42 +0200
commit17f1e8d19b1fd693893d66d2275ed8ae2476344e (patch)
tree7f48be975faa92042769870957587b3c7864f631 /Jellyfin.Api/Controllers/DashboardController.cs
parente8ae7e5c38e28f13fa8de295e26c930cb46d9b79 (diff)
parent6771b5cabe96b4b3cbd1cd0c998d564f3dd17ed4 (diff)
Merge branch 'master' into segment-deletion
Diffstat (limited to 'Jellyfin.Api/Controllers/DashboardController.cs')
-rw-r--r--Jellyfin.Api/Controllers/DashboardController.cs158
1 files changed, 78 insertions, 80 deletions
diff --git a/Jellyfin.Api/Controllers/DashboardController.cs b/Jellyfin.Api/Controllers/DashboardController.cs
index c8411f44b..076084c7a 100644
--- a/Jellyfin.Api/Controllers/DashboardController.cs
+++ b/Jellyfin.Api/Controllers/DashboardController.cs
@@ -4,7 +4,6 @@ using System.IO;
using System.Linq;
using System.Net.Mime;
using Jellyfin.Api.Attributes;
-using Jellyfin.Api.Constants;
using Jellyfin.Api.Models;
using MediaBrowser.Common.Plugins;
using MediaBrowser.Model.Net;
@@ -14,103 +13,102 @@ using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
-namespace Jellyfin.Api.Controllers
+namespace Jellyfin.Api.Controllers;
+
+/// <summary>
+/// The dashboard controller.
+/// </summary>
+[Route("")]
+public class DashboardController : BaseJellyfinApiController
{
+ private readonly ILogger<DashboardController> _logger;
+ private readonly IPluginManager _pluginManager;
+
/// <summary>
- /// The dashboard controller.
+ /// Initializes a new instance of the <see cref="DashboardController"/> class.
/// </summary>
- [Route("")]
- public class DashboardController : BaseJellyfinApiController
+ /// <param name="logger">Instance of <see cref="ILogger{DashboardController}"/> interface.</param>
+ /// <param name="pluginManager">Instance of <see cref="IPluginManager"/> interface.</param>
+ public DashboardController(
+ ILogger<DashboardController> logger,
+ IPluginManager pluginManager)
{
- private readonly ILogger<DashboardController> _logger;
- private readonly IPluginManager _pluginManager;
+ _logger = logger;
+ _pluginManager = pluginManager;
+ }
- /// <summary>
- /// Initializes a new instance of the <see cref="DashboardController"/> class.
- /// </summary>
- /// <param name="logger">Instance of <see cref="ILogger{DashboardController}"/> interface.</param>
- /// <param name="pluginManager">Instance of <see cref="IPluginManager"/> interface.</param>
- public DashboardController(
- ILogger<DashboardController> logger,
- IPluginManager pluginManager)
- {
- _logger = logger;
- _pluginManager = pluginManager;
- }
+ /// <summary>
+ /// Gets the configuration pages.
+ /// </summary>
+ /// <param name="enableInMainMenu">Whether to enable in the main menu.</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)]
+ [Authorize]
+ public ActionResult<IEnumerable<ConfigurationPageInfo>> GetConfigurationPages(
+ [FromQuery] bool? enableInMainMenu)
+ {
+ var configPages = _pluginManager.Plugins.SelectMany(GetConfigPages).ToList();
- /// <summary>
- /// Gets the configuration pages.
- /// </summary>
- /// <param name="enableInMainMenu">Whether to enable in the main menu.</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)]
- [Authorize(Policy = Policies.DefaultAuthorization)]
- public ActionResult<IEnumerable<ConfigurationPageInfo>> GetConfigurationPages(
- [FromQuery] bool? enableInMainMenu)
+ if (enableInMainMenu.HasValue)
{
- var configPages = _pluginManager.Plugins.SelectMany(GetConfigPages).ToList();
-
- if (enableInMainMenu.HasValue)
- {
- configPages = configPages.Where(p => p.EnableInMainMenu == enableInMainMenu.Value).ToList();
- }
-
- return configPages;
+ configPages = configPages.Where(p => p.EnableInMainMenu == enableInMainMenu.Value).ToList();
}
- /// <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)]
- [ProducesFile(MediaTypeNames.Text.Html, "application/x-javascript")]
- public ActionResult GetDashboardConfigurationPage([FromQuery] string? name)
- {
- var altPage = GetPluginPages().FirstOrDefault(p => string.Equals(p.Item1.Name, name, StringComparison.OrdinalIgnoreCase));
- if (altPage == null)
- {
- return NotFound();
- }
-
- IPlugin plugin = altPage.Item2;
- string resourcePath = altPage.Item1.EmbeddedResourcePath;
- Stream? stream = plugin.GetType().Assembly.GetManifestResourceStream(resourcePath);
- if (stream == null)
- {
- _logger.LogError("Failed to get resource {Resource} from plugin {Plugin}", resourcePath, plugin.Name);
- return NotFound();
- }
+ return configPages;
+ }
- return File(stream, MimeTypes.GetMimeType(resourcePath));
+ /// <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)]
+ [ProducesFile(MediaTypeNames.Text.Html, "application/x-javascript")]
+ public ActionResult GetDashboardConfigurationPage([FromQuery] string? name)
+ {
+ var altPage = GetPluginPages().FirstOrDefault(p => string.Equals(p.Item1.Name, name, StringComparison.OrdinalIgnoreCase));
+ if (altPage is null)
+ {
+ return NotFound();
}
- private IEnumerable<ConfigurationPageInfo> GetConfigPages(LocalPlugin plugin)
+ IPlugin plugin = altPage.Item2;
+ string resourcePath = altPage.Item1.EmbeddedResourcePath;
+ Stream? stream = plugin.GetType().Assembly.GetManifestResourceStream(resourcePath);
+ if (stream is null)
{
- return GetPluginPages(plugin).Select(i => new ConfigurationPageInfo(plugin.Instance, i.Item1));
+ _logger.LogError("Failed to get resource {Resource} from plugin {Plugin}", resourcePath, plugin.Name);
+ return NotFound();
}
- private IEnumerable<Tuple<PluginPageInfo, IPlugin>> GetPluginPages(LocalPlugin plugin)
- {
- if (plugin.Instance is not IHasWebPages hasWebPages)
- {
- return Enumerable.Empty<Tuple<PluginPageInfo, IPlugin>>();
- }
+ return File(stream, MimeTypes.GetMimeType(resourcePath));
+ }
- return hasWebPages.GetPages().Select(i => new Tuple<PluginPageInfo, IPlugin>(i, plugin.Instance));
- }
+ private IEnumerable<ConfigurationPageInfo> GetConfigPages(LocalPlugin plugin)
+ {
+ return GetPluginPages(plugin).Select(i => new ConfigurationPageInfo(plugin.Instance, i.Item1));
+ }
- private IEnumerable<Tuple<PluginPageInfo, IPlugin>> GetPluginPages()
+ private IEnumerable<Tuple<PluginPageInfo, IPlugin>> GetPluginPages(LocalPlugin plugin)
+ {
+ if (plugin.Instance is not IHasWebPages hasWebPages)
{
- return _pluginManager.Plugins.SelectMany(GetPluginPages);
+ return Enumerable.Empty<Tuple<PluginPageInfo, IPlugin>>();
}
+
+ return hasWebPages.GetPages().Select(i => new Tuple<PluginPageInfo, IPlugin>(i, plugin.Instance));
+ }
+
+ private IEnumerable<Tuple<PluginPageInfo, IPlugin>> GetPluginPages()
+ {
+ return _pluginManager.Plugins.SelectMany(GetPluginPages);
}
}