aboutsummaryrefslogtreecommitdiff
path: root/Jellyfin.Api/Controllers/DashboardController.cs
blob: 8cb93cc80bad58834199618c2c5eb2443c084120 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Net.Mime;
using Jellyfin.Api.Attributes;
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.Http.Extensions;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Logging;
using Microsoft.Net.Http.Headers;

namespace Jellyfin.Api.Controllers
{
    /// <summary>
    /// The dashboard controller.
    /// </summary>
    [Route("")]
    public class DashboardController : BaseJellyfinApiController
    {
        private readonly ILogger<DashboardController> _logger;
        private readonly IServerApplicationHost _appHost;
        private readonly IPluginManager _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="appHost">Instance of <see cref="IServerApplicationHost"/> interface.</param>
        /// <param name="pluginManager">Instance of <see cref="IPluginManager"/> interface.</param>
        public DashboardController(
            ILogger<DashboardController> logger,
            IServerApplicationHost appHost,
            IPluginManager pluginManager)
        {
            _logger = logger;
            _appHost = appHost;
            _pluginManager = pluginManager;
        }

        /// <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)
        {
            var configPages = _pluginManager.Plugins.SelectMany(GetConfigPages).ToList();

            if (pageType.HasValue)
            {
                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)]
        [ProducesFile(MediaTypeNames.Text.Html, "application/x-javascript")]
        public ActionResult GetDashboardConfigurationPage([FromQuery] string? name)
        {
            IPlugin? plugin = null;
            Stream? stream = null;

            var isJs = false;
            var isTemplate = false;

            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();
        }

        private IEnumerable<ConfigurationPageInfo> GetConfigPages(LocalPlugin plugin)
        {
            return GetPluginPages(plugin).Select(i => new ConfigurationPageInfo(plugin.Instance, i.Item1));
        }

        private IEnumerable<Tuple<PluginPageInfo, IPlugin>> GetPluginPages(LocalPlugin? plugin)
        {
            if (plugin?.Instance is not IHasWebPages hasWebPages)
            {
                return new List<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);
        }
    }
}