< Summary - Jellyfin

Information
Class: Jellyfin.Api.Controllers.ConfigurationController
Assembly: Jellyfin.Api
File(s): /srv/git/jellyfin/Jellyfin.Api/Controllers/ConfigurationController.cs
Line coverage
0%
Covered lines: 0
Uncovered lines: 24
Coverable lines: 24
Total lines: 144
Line coverage: 0%
Branch coverage
0%
Covered branches: 0
Total branches: 2
Branch coverage: 0%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100 10/25/2025 - 12:09:58 AM Line coverage: 0% (0/24) Branch coverage: 0% (0/2) Total lines: 1641/29/2026 - 12:13:32 AM Line coverage: 0% (0/24) Branch coverage: 0% (0/2) Total lines: 144 10/25/2025 - 12:09:58 AM Line coverage: 0% (0/24) Branch coverage: 0% (0/2) Total lines: 1641/29/2026 - 12:13:32 AM Line coverage: 0% (0/24) Branch coverage: 0% (0/2) Total lines: 144

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%210%
GetConfiguration()100%210%
UpdateConfiguration(...)100%210%
GetNamedConfiguration(...)100%210%
UpdateNamedConfiguration(...)0%620%
GetDefaultMetadataOptions()100%210%
UpdateBrandingConfiguration(...)100%210%

File(s)

/srv/git/jellyfin/Jellyfin.Api/Controllers/ConfigurationController.cs

#LineLine coverage
 1using System;
 2using System.ComponentModel.DataAnnotations;
 3using System.Net.Mime;
 4using System.Text.Json;
 5using Jellyfin.Api.Attributes;
 6using Jellyfin.Extensions.Json;
 7using MediaBrowser.Common.Api;
 8using MediaBrowser.Controller.Configuration;
 9using MediaBrowser.Controller.MediaEncoding;
 10using MediaBrowser.Model.Branding;
 11using MediaBrowser.Model.Configuration;
 12using Microsoft.AspNetCore.Authorization;
 13using Microsoft.AspNetCore.Http;
 14using Microsoft.AspNetCore.Mvc;
 15
 16namespace Jellyfin.Api.Controllers;
 17
 18/// <summary>
 19/// Configuration Controller.
 20/// </summary>
 21[Route("System")]
 22[Authorize]
 23public class ConfigurationController : BaseJellyfinApiController
 24{
 25    private readonly IServerConfigurationManager _configurationManager;
 26    private readonly IMediaEncoder _mediaEncoder;
 27
 028    private readonly JsonSerializerOptions _serializerOptions = JsonDefaults.Options;
 29
 30    /// <summary>
 31    /// Initializes a new instance of the <see cref="ConfigurationController"/> class.
 32    /// </summary>
 33    /// <param name="configurationManager">Instance of the <see cref="IServerConfigurationManager"/> interface.</param>
 34    /// <param name="mediaEncoder">Instance of the <see cref="IMediaEncoder"/> interface.</param>
 035    public ConfigurationController(
 036        IServerConfigurationManager configurationManager,
 037        IMediaEncoder mediaEncoder)
 38    {
 039        _configurationManager = configurationManager;
 040        _mediaEncoder = mediaEncoder;
 041    }
 42
 43    /// <summary>
 44    /// Gets application configuration.
 45    /// </summary>
 46    /// <response code="200">Application configuration returned.</response>
 47    /// <returns>Application configuration.</returns>
 48    [HttpGet("Configuration")]
 49    [ProducesResponseType(StatusCodes.Status200OK)]
 50    public ActionResult<ServerConfiguration> GetConfiguration()
 51    {
 052        return _configurationManager.Configuration;
 53    }
 54
 55    /// <summary>
 56    /// Updates application configuration.
 57    /// </summary>
 58    /// <param name="configuration">Configuration.</param>
 59    /// <response code="204">Configuration updated.</response>
 60    /// <returns>Update status.</returns>
 61    [HttpPost("Configuration")]
 62    [Authorize(Policy = Policies.RequiresElevation)]
 63    [ProducesResponseType(StatusCodes.Status204NoContent)]
 64    public ActionResult UpdateConfiguration([FromBody, Required] ServerConfiguration configuration)
 65    {
 066        _configurationManager.ReplaceConfiguration(configuration);
 067        return NoContent();
 68    }
 69
 70    /// <summary>
 71    /// Gets a named configuration.
 72    /// </summary>
 73    /// <param name="key">Configuration key.</param>
 74    /// <response code="200">Configuration returned.</response>
 75    /// <returns>Configuration.</returns>
 76    [HttpGet("Configuration/{key}")]
 77    [ProducesResponseType(StatusCodes.Status200OK)]
 78    [ProducesFile(MediaTypeNames.Application.Json)]
 79    public ActionResult<object> GetNamedConfiguration([FromRoute, Required] string key)
 80    {
 081        return _configurationManager.GetConfiguration(key);
 82    }
 83
 84    /// <summary>
 85    /// Updates named configuration.
 86    /// </summary>
 87    /// <param name="key">Configuration key.</param>
 88    /// <param name="configuration">Configuration.</param>
 89    /// <response code="204">Named configuration updated.</response>
 90    /// <returns>Update status.</returns>
 91    [HttpPost("Configuration/{key}")]
 92    [Authorize(Policy = Policies.RequiresElevation)]
 93    [ProducesResponseType(StatusCodes.Status204NoContent)]
 94    public ActionResult UpdateNamedConfiguration([FromRoute, Required] string key, [FromBody, Required] JsonDocument con
 95    {
 096        var configurationType = _configurationManager.GetConfigurationType(key);
 097        var deserializedConfiguration = configuration.Deserialize(configurationType, _serializerOptions);
 98
 099        if (deserializedConfiguration is null)
 100        {
 0101            throw new ArgumentException("Body doesn't contain a valid configuration");
 102        }
 103
 0104        _configurationManager.SaveConfiguration(key, deserializedConfiguration);
 0105        return NoContent();
 106    }
 107
 108    /// <summary>
 109    /// Gets a default MetadataOptions object.
 110    /// </summary>
 111    /// <response code="200">Metadata options returned.</response>
 112    /// <returns>Default MetadataOptions.</returns>
 113    [HttpGet("Configuration/MetadataOptions/Default")]
 114    [Authorize(Policy = Policies.RequiresElevation)]
 115    [ProducesResponseType(StatusCodes.Status200OK)]
 116    public ActionResult<MetadataOptions> GetDefaultMetadataOptions()
 117    {
 0118        return new MetadataOptions();
 119    }
 120
 121    /// <summary>
 122    /// Updates branding configuration.
 123    /// </summary>
 124    /// <param name="configuration">Branding configuration.</param>
 125    /// <response code="204">Branding configuration updated.</response>
 126    /// <returns>Update status.</returns>
 127    [HttpPost("Configuration/Branding")]
 128    [Authorize(Policy = Policies.RequiresElevation)]
 129    [ProducesResponseType(StatusCodes.Status204NoContent)]
 130    public ActionResult UpdateBrandingConfiguration([FromBody, Required] BrandingOptionsDto configuration)
 131    {
 132        // Get the current branding configuration to preserve SplashscreenLocation
 0133        var currentBranding = (BrandingOptions)_configurationManager.GetConfiguration("branding");
 134
 135        // Update only the properties from BrandingOptionsDto
 0136        currentBranding.LoginDisclaimer = configuration.LoginDisclaimer;
 0137        currentBranding.CustomCss = configuration.CustomCss;
 0138        currentBranding.SplashscreenEnabled = configuration.SplashscreenEnabled;
 139
 0140        _configurationManager.SaveConfiguration("branding", currentBranding);
 141
 0142        return NoContent();
 143    }
 144}