| | | 1 | | using System; |
| | | 2 | | using System.Collections.Generic; |
| | | 3 | | using System.IO; |
| | | 4 | | using System.Linq; |
| | | 5 | | using System.Net.Mime; |
| | | 6 | | using Jellyfin.Api.Attributes; |
| | | 7 | | using Jellyfin.Api.Models; |
| | | 8 | | using MediaBrowser.Common.Api; |
| | | 9 | | using MediaBrowser.Common.Plugins; |
| | | 10 | | using MediaBrowser.Model.Net; |
| | | 11 | | using MediaBrowser.Model.Plugins; |
| | | 12 | | using Microsoft.AspNetCore.Authorization; |
| | | 13 | | using Microsoft.AspNetCore.Http; |
| | | 14 | | using Microsoft.AspNetCore.Mvc; |
| | | 15 | | using Microsoft.Extensions.Logging; |
| | | 16 | | |
| | | 17 | | namespace Jellyfin.Api.Controllers; |
| | | 18 | | |
| | | 19 | | /// <summary> |
| | | 20 | | /// The dashboard controller. |
| | | 21 | | /// </summary> |
| | | 22 | | [Route("")] |
| | | 23 | | [Tags("Plugin")] |
| | | 24 | | public class DashboardController : BaseJellyfinApiController |
| | | 25 | | { |
| | | 26 | | private readonly ILogger<DashboardController> _logger; |
| | | 27 | | private readonly IPluginManager _pluginManager; |
| | | 28 | | |
| | | 29 | | /// <summary> |
| | | 30 | | /// Initializes a new instance of the <see cref="DashboardController"/> class. |
| | | 31 | | /// </summary> |
| | | 32 | | /// <param name="logger">Instance of <see cref="ILogger{DashboardController}"/> interface.</param> |
| | | 33 | | /// <param name="pluginManager">Instance of <see cref="IPluginManager"/> interface.</param> |
| | 5 | 34 | | public DashboardController( |
| | 5 | 35 | | ILogger<DashboardController> logger, |
| | 5 | 36 | | IPluginManager pluginManager) |
| | | 37 | | { |
| | 5 | 38 | | _logger = logger; |
| | 5 | 39 | | _pluginManager = pluginManager; |
| | 5 | 40 | | } |
| | | 41 | | |
| | | 42 | | /// <summary> |
| | | 43 | | /// Gets the configuration pages. |
| | | 44 | | /// </summary> |
| | | 45 | | /// <param name="enableInMainMenu">Whether to enable in the main menu.</param> |
| | | 46 | | /// <response code="200">ConfigurationPages returned.</response> |
| | | 47 | | /// <response code="404">Server still loading.</response> |
| | | 48 | | /// <returns>An <see cref="IEnumerable{ConfigurationPageInfo}"/> with infos about the plugins.</returns> |
| | | 49 | | [HttpGet("web/ConfigurationPages")] |
| | | 50 | | [Authorize(Policy = Policies.RequiresElevation)] |
| | | 51 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 52 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 53 | | public ActionResult<IEnumerable<ConfigurationPageInfo>> GetConfigurationPages( |
| | | 54 | | [FromQuery] bool? enableInMainMenu) |
| | | 55 | | { |
| | 2 | 56 | | var configPages = _pluginManager.Plugins.SelectMany(GetConfigPages).ToList(); |
| | | 57 | | |
| | 2 | 58 | | if (enableInMainMenu.HasValue) |
| | | 59 | | { |
| | 1 | 60 | | configPages = configPages.Where(p => p.EnableInMainMenu == enableInMainMenu.Value).ToList(); |
| | | 61 | | } |
| | | 62 | | |
| | 2 | 63 | | return configPages; |
| | | 64 | | } |
| | | 65 | | |
| | | 66 | | /// <summary> |
| | | 67 | | /// Gets a dashboard configuration page. |
| | | 68 | | /// </summary> |
| | | 69 | | /// <param name="name">The name of the page.</param> |
| | | 70 | | /// <response code="200">ConfigurationPage returned.</response> |
| | | 71 | | /// <response code="404">Plugin configuration page not found.</response> |
| | | 72 | | /// <returns>The configuration page.</returns> |
| | | 73 | | [HttpGet("web/ConfigurationPage")] |
| | | 74 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 75 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 76 | | [ProducesFile(MediaTypeNames.Text.Html, "application/x-javascript")] |
| | | 77 | | public ActionResult GetDashboardConfigurationPage([FromQuery] string? name) |
| | | 78 | | { |
| | 3 | 79 | | var altPage = GetPluginPages().FirstOrDefault(p => string.Equals(p.Item1.Name, name, StringComparison.OrdinalIgn |
| | 3 | 80 | | if (altPage is null) |
| | | 81 | | { |
| | 1 | 82 | | return NotFound(); |
| | | 83 | | } |
| | | 84 | | |
| | 2 | 85 | | IPlugin plugin = altPage.Item2; |
| | 2 | 86 | | string resourcePath = altPage.Item1.EmbeddedResourcePath; |
| | 2 | 87 | | Stream? stream = plugin.GetType().Assembly.GetManifestResourceStream(resourcePath); |
| | 2 | 88 | | if (stream is null) |
| | | 89 | | { |
| | 1 | 90 | | _logger.LogError("Failed to get resource {Resource} from plugin {Plugin}", resourcePath, plugin.Name); |
| | 1 | 91 | | return NotFound(); |
| | | 92 | | } |
| | | 93 | | |
| | 1 | 94 | | return File(stream, MimeTypes.GetMimeType(resourcePath)); |
| | | 95 | | } |
| | | 96 | | |
| | | 97 | | private IEnumerable<ConfigurationPageInfo> GetConfigPages(LocalPlugin plugin) |
| | | 98 | | { |
| | 16 | 99 | | return GetPluginPages(plugin).Select(i => new ConfigurationPageInfo(plugin.Instance, i.Item1)); |
| | | 100 | | } |
| | | 101 | | |
| | | 102 | | private IEnumerable<Tuple<PluginPageInfo, IPlugin>> GetPluginPages(LocalPlugin plugin) |
| | | 103 | | { |
| | 38 | 104 | | if (plugin.Instance is not IHasWebPages hasWebPages) |
| | | 105 | | { |
| | 3 | 106 | | return Enumerable.Empty<Tuple<PluginPageInfo, IPlugin>>(); |
| | | 107 | | } |
| | | 108 | | |
| | 35 | 109 | | return hasWebPages.GetPages().Select(i => new Tuple<PluginPageInfo, IPlugin>(i, plugin.Instance)); |
| | | 110 | | } |
| | | 111 | | |
| | | 112 | | private IEnumerable<Tuple<PluginPageInfo, IPlugin>> GetPluginPages() |
| | | 113 | | { |
| | 3 | 114 | | return _pluginManager.Plugins.SelectMany(GetPluginPages); |
| | | 115 | | } |
| | | 116 | | } |