| | | 1 | | using System; |
| | | 2 | | using System.Collections.Generic; |
| | | 3 | | using System.ComponentModel.DataAnnotations; |
| | | 4 | | using System.IO; |
| | | 5 | | using System.Linq; |
| | | 6 | | using System.Text.Json; |
| | | 7 | | using System.Threading.Tasks; |
| | | 8 | | using Jellyfin.Api.Attributes; |
| | | 9 | | using Jellyfin.Extensions; |
| | | 10 | | using Jellyfin.Extensions.Json; |
| | | 11 | | using MediaBrowser.Common.Api; |
| | | 12 | | using MediaBrowser.Common.Plugins; |
| | | 13 | | using MediaBrowser.Common.Updates; |
| | | 14 | | using MediaBrowser.Model.Net; |
| | | 15 | | using MediaBrowser.Model.Plugins; |
| | | 16 | | using Microsoft.AspNetCore.Authorization; |
| | | 17 | | using Microsoft.AspNetCore.Http; |
| | | 18 | | using Microsoft.AspNetCore.Mvc; |
| | | 19 | | |
| | | 20 | | namespace Jellyfin.Api.Controllers; |
| | | 21 | | |
| | | 22 | | /// <summary> |
| | | 23 | | /// Plugins controller. |
| | | 24 | | /// </summary> |
| | | 25 | | [Authorize(Policy = Policies.RequiresElevation)] |
| | | 26 | | [Tags("Plugin")] |
| | | 27 | | public class PluginsController : BaseJellyfinApiController |
| | | 28 | | { |
| | | 29 | | private readonly IInstallationManager _installationManager; |
| | | 30 | | private readonly IPluginManager _pluginManager; |
| | | 31 | | private readonly JsonSerializerOptions _serializerOptions; |
| | | 32 | | |
| | | 33 | | /// <summary> |
| | | 34 | | /// Initializes a new instance of the <see cref="PluginsController"/> class. |
| | | 35 | | /// </summary> |
| | | 36 | | /// <param name="installationManager">Instance of the <see cref="IInstallationManager"/> interface.</param> |
| | | 37 | | /// <param name="pluginManager">Instance of the <see cref="IPluginManager"/> interface.</param> |
| | 11 | 38 | | public PluginsController( |
| | 11 | 39 | | IInstallationManager installationManager, |
| | 11 | 40 | | IPluginManager pluginManager) |
| | | 41 | | { |
| | 11 | 42 | | _installationManager = installationManager; |
| | 11 | 43 | | _pluginManager = pluginManager; |
| | 11 | 44 | | _serializerOptions = JsonDefaults.Options; |
| | 11 | 45 | | } |
| | | 46 | | |
| | | 47 | | /// <summary> |
| | | 48 | | /// Gets a list of currently installed plugins. |
| | | 49 | | /// </summary> |
| | | 50 | | /// <response code="200">Installed plugins returned.</response> |
| | | 51 | | /// <returns>List of currently installed plugins.</returns> |
| | | 52 | | [HttpGet] |
| | | 53 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 54 | | public ActionResult<IEnumerable<PluginInfo>> GetPlugins() |
| | | 55 | | { |
| | 1 | 56 | | return Ok(_pluginManager.Plugins |
| | 1 | 57 | | .OrderBy(p => p.Name) |
| | 1 | 58 | | .Select(p => p.GetPluginInfo())); |
| | | 59 | | } |
| | | 60 | | |
| | | 61 | | /// <summary> |
| | | 62 | | /// Enables a disabled plugin. |
| | | 63 | | /// </summary> |
| | | 64 | | /// <param name="pluginId">Plugin id.</param> |
| | | 65 | | /// <param name="version">Plugin version.</param> |
| | | 66 | | /// <response code="204">Plugin enabled.</response> |
| | | 67 | | /// <response code="404">Plugin not found.</response> |
| | | 68 | | /// <returns>An <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if the plugin could not |
| | | 69 | | [HttpPost("{pluginId}/{version}/Enable")] |
| | | 70 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 71 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 72 | | public ActionResult EnablePlugin([FromRoute, Required] Guid pluginId, [FromRoute, Required] Version version) |
| | | 73 | | { |
| | 0 | 74 | | var plugin = _pluginManager.GetPlugin(pluginId, version); |
| | 0 | 75 | | if (plugin is null) |
| | | 76 | | { |
| | 0 | 77 | | return NotFound(); |
| | | 78 | | } |
| | | 79 | | |
| | 0 | 80 | | _pluginManager.EnablePlugin(plugin); |
| | 0 | 81 | | return NoContent(); |
| | | 82 | | } |
| | | 83 | | |
| | | 84 | | /// <summary> |
| | | 85 | | /// Disable a plugin. |
| | | 86 | | /// </summary> |
| | | 87 | | /// <param name="pluginId">Plugin id.</param> |
| | | 88 | | /// <param name="version">Plugin version.</param> |
| | | 89 | | /// <response code="204">Plugin disabled.</response> |
| | | 90 | | /// <response code="404">Plugin not found.</response> |
| | | 91 | | /// <returns>An <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if the plugin could not |
| | | 92 | | [HttpPost("{pluginId}/{version}/Disable")] |
| | | 93 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 94 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 95 | | public ActionResult DisablePlugin([FromRoute, Required] Guid pluginId, [FromRoute, Required] Version version) |
| | | 96 | | { |
| | 0 | 97 | | var plugin = _pluginManager.GetPlugin(pluginId, version); |
| | 0 | 98 | | if (plugin is null) |
| | | 99 | | { |
| | 0 | 100 | | return NotFound(); |
| | | 101 | | } |
| | | 102 | | |
| | 0 | 103 | | _pluginManager.DisablePlugin(plugin); |
| | 0 | 104 | | return NoContent(); |
| | | 105 | | } |
| | | 106 | | |
| | | 107 | | /// <summary> |
| | | 108 | | /// Uninstalls a plugin by version. |
| | | 109 | | /// </summary> |
| | | 110 | | /// <param name="pluginId">Plugin id.</param> |
| | | 111 | | /// <param name="version">Plugin version.</param> |
| | | 112 | | /// <response code="204">Plugin uninstalled.</response> |
| | | 113 | | /// <response code="404">Plugin not found.</response> |
| | | 114 | | /// <returns>An <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if the plugin could not |
| | | 115 | | [HttpDelete("{pluginId}/{version}")] |
| | | 116 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 117 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 118 | | public ActionResult UninstallPluginByVersion([FromRoute, Required] Guid pluginId, [FromRoute, Required] Version vers |
| | | 119 | | { |
| | 0 | 120 | | var plugin = _pluginManager.GetPlugin(pluginId, version); |
| | 0 | 121 | | if (plugin is null) |
| | | 122 | | { |
| | 0 | 123 | | return NotFound(); |
| | | 124 | | } |
| | | 125 | | |
| | 0 | 126 | | _installationManager.UninstallPlugin(plugin); |
| | 0 | 127 | | return NoContent(); |
| | | 128 | | } |
| | | 129 | | |
| | | 130 | | /// <summary> |
| | | 131 | | /// Uninstalls a plugin. |
| | | 132 | | /// </summary> |
| | | 133 | | /// <param name="pluginId">Plugin id.</param> |
| | | 134 | | /// <response code="204">Plugin uninstalled.</response> |
| | | 135 | | /// <response code="404">Plugin not found.</response> |
| | | 136 | | /// <returns>An <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if the plugin could not |
| | | 137 | | [HttpDelete("{pluginId}")] |
| | | 138 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 139 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 140 | | public ActionResult UninstallPlugin([FromRoute, Required] Guid pluginId) |
| | | 141 | | { |
| | | 142 | | // If no version is given, return the current instance. |
| | 0 | 143 | | var plugins = _pluginManager.Plugins.Where(p => p.Id.Equals(pluginId)).ToList(); |
| | | 144 | | |
| | | 145 | | // Select the un-instanced one first. |
| | 0 | 146 | | var plugin = plugins.FirstOrDefault(p => p.Instance is null) ?? plugins.MinBy(p => p.Manifest.Status); |
| | | 147 | | |
| | 0 | 148 | | if (plugin is not null) |
| | | 149 | | { |
| | 0 | 150 | | _installationManager.UninstallPlugin(plugin); |
| | 0 | 151 | | return NoContent(); |
| | | 152 | | } |
| | | 153 | | |
| | 0 | 154 | | return NotFound(); |
| | | 155 | | } |
| | | 156 | | |
| | | 157 | | /// <summary> |
| | | 158 | | /// Gets plugin configuration. |
| | | 159 | | /// </summary> |
| | | 160 | | /// <param name="pluginId">Plugin id.</param> |
| | | 161 | | /// <response code="200">Plugin configuration returned.</response> |
| | | 162 | | /// <response code="404">Plugin not found or plugin configuration not found.</response> |
| | | 163 | | /// <returns>Plugin configuration.</returns> |
| | | 164 | | [HttpGet("{pluginId}/Configuration")] |
| | | 165 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 166 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 167 | | public ActionResult<BasePluginConfiguration> GetPluginConfiguration([FromRoute, Required] Guid pluginId) |
| | | 168 | | { |
| | 0 | 169 | | var plugin = _pluginManager.GetPlugin(pluginId); |
| | 0 | 170 | | if (plugin?.Instance is IHasPluginConfiguration configPlugin) |
| | | 171 | | { |
| | 0 | 172 | | return configPlugin.Configuration; |
| | | 173 | | } |
| | | 174 | | |
| | 0 | 175 | | return NotFound(); |
| | | 176 | | } |
| | | 177 | | |
| | | 178 | | /// <summary> |
| | | 179 | | /// Updates plugin configuration. |
| | | 180 | | /// </summary> |
| | | 181 | | /// <remarks> |
| | | 182 | | /// Accepts plugin configuration as JSON body. |
| | | 183 | | /// </remarks> |
| | | 184 | | /// <param name="pluginId">Plugin id.</param> |
| | | 185 | | /// <response code="204">Plugin configuration updated.</response> |
| | | 186 | | /// <response code="404">Plugin not found or plugin does not have configuration.</response> |
| | | 187 | | /// <returns>An <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if the plugin could not |
| | | 188 | | [HttpPost("{pluginId}/Configuration")] |
| | | 189 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 190 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 191 | | public async Task<ActionResult> UpdatePluginConfiguration([FromRoute, Required] Guid pluginId) |
| | | 192 | | { |
| | 0 | 193 | | var plugin = _pluginManager.GetPlugin(pluginId); |
| | 0 | 194 | | if (plugin?.Instance is not IHasPluginConfiguration configPlugin) |
| | | 195 | | { |
| | 0 | 196 | | return NotFound(); |
| | | 197 | | } |
| | | 198 | | |
| | 0 | 199 | | var configuration = (BasePluginConfiguration?)await JsonSerializer.DeserializeAsync(Request.Body, configPlugin.C |
| | 0 | 200 | | .ConfigureAwait(false); |
| | | 201 | | |
| | 0 | 202 | | if (configuration is not null) |
| | | 203 | | { |
| | 0 | 204 | | configPlugin.UpdateConfiguration(configuration); |
| | | 205 | | } |
| | | 206 | | |
| | 0 | 207 | | return NoContent(); |
| | 0 | 208 | | } |
| | | 209 | | |
| | | 210 | | /// <summary> |
| | | 211 | | /// Gets a plugin's image. |
| | | 212 | | /// </summary> |
| | | 213 | | /// <param name="pluginId">Plugin id.</param> |
| | | 214 | | /// <param name="version">Plugin version.</param> |
| | | 215 | | /// <response code="200">Plugin image returned.</response> |
| | | 216 | | /// <returns>Plugin's image.</returns> |
| | | 217 | | [HttpGet("{pluginId}/{version}/Image")] |
| | | 218 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 219 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 220 | | [ProducesImageFile] |
| | | 221 | | [AllowAnonymous] |
| | | 222 | | public ActionResult GetPluginImage([FromRoute, Required] Guid pluginId, [FromRoute, Required] Version version) |
| | | 223 | | { |
| | 10 | 224 | | var plugin = _pluginManager.GetPlugin(pluginId, version); |
| | 10 | 225 | | if (plugin is null) |
| | | 226 | | { |
| | 1 | 227 | | return NotFound(); |
| | | 228 | | } |
| | | 229 | | |
| | 9 | 230 | | string? imagePath = plugin.Manifest.ImagePath; |
| | 9 | 231 | | if (!string.IsNullOrWhiteSpace(imagePath)) |
| | | 232 | | { |
| | 6 | 233 | | var pluginPath = Path.TrimEndingDirectorySeparator(Path.GetFullPath(plugin.Path)); |
| | 6 | 234 | | imagePath = Path.GetFullPath(imagePath, pluginPath); |
| | | 235 | | // Require a separator after the plugin path so a sibling like "<pluginPath>-evil" can't pass. |
| | 6 | 236 | | if (imagePath.StartsWith(pluginPath + Path.DirectorySeparatorChar, StringComparison.OrdinalIgnoreCase) is fa |
| | | 237 | | { |
| | 5 | 238 | | return NotFound(); |
| | | 239 | | } |
| | | 240 | | |
| | 1 | 241 | | Response.Headers.ContentDisposition = "attachment"; |
| | 1 | 242 | | return PhysicalFile(imagePath, MimeTypes.GetMimeType(imagePath)); |
| | | 243 | | } |
| | | 244 | | |
| | 3 | 245 | | var resourceName = plugin.Manifest.ImageResourceName; |
| | 3 | 246 | | if (!string.IsNullOrEmpty(resourceName) && plugin.Instance is not null) |
| | | 247 | | { |
| | 0 | 248 | | var stream = plugin.Instance.GetType().Assembly.GetManifestResourceStream(resourceName); |
| | 0 | 249 | | if (stream is null) |
| | | 250 | | { |
| | 0 | 251 | | return NotFound(); |
| | | 252 | | } |
| | | 253 | | |
| | 0 | 254 | | Response.Headers.ContentDisposition = "attachment"; |
| | 0 | 255 | | return File(stream, MimeTypes.GetMimeType(resourceName)); |
| | | 256 | | } |
| | | 257 | | |
| | 3 | 258 | | return NotFound(); |
| | | 259 | | } |
| | | 260 | | |
| | | 261 | | /// <summary> |
| | | 262 | | /// Gets a plugin's manifest. |
| | | 263 | | /// </summary> |
| | | 264 | | /// <param name="pluginId">Plugin id.</param> |
| | | 265 | | /// <response code="204">Plugin manifest returned.</response> |
| | | 266 | | /// <response code="404">Plugin not found.</response> |
| | | 267 | | /// <returns>A <see cref="PluginManifest"/> on success, or a <see cref="NotFoundResult"/> if the plugin could not be |
| | | 268 | | [HttpPost("{pluginId}/Manifest")] |
| | | 269 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 270 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 271 | | public ActionResult<PluginManifest> GetPluginManifest([FromRoute, Required] Guid pluginId) |
| | | 272 | | { |
| | 0 | 273 | | var plugin = _pluginManager.GetPlugin(pluginId); |
| | | 274 | | |
| | 0 | 275 | | if (plugin is not null) |
| | | 276 | | { |
| | 0 | 277 | | return plugin.Manifest; |
| | | 278 | | } |
| | | 279 | | |
| | 0 | 280 | | return NotFound(); |
| | | 281 | | } |
| | | 282 | | } |