ConfigurationController.cs 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  1. using System.ComponentModel.DataAnnotations;
  2. using System.Text.Json;
  3. using System.Threading.Tasks;
  4. using Jellyfin.Api.Constants;
  5. using Jellyfin.Api.Models.ConfigurationDtos;
  6. using MediaBrowser.Common.Json;
  7. using MediaBrowser.Controller.Configuration;
  8. using MediaBrowser.Controller.MediaEncoding;
  9. using MediaBrowser.Model.Configuration;
  10. using Microsoft.AspNetCore.Authorization;
  11. using Microsoft.AspNetCore.Http;
  12. using Microsoft.AspNetCore.Mvc;
  13. namespace Jellyfin.Api.Controllers
  14. {
  15. /// <summary>
  16. /// Configuration Controller.
  17. /// </summary>
  18. [Route("System")]
  19. [Authorize(Policy = Policies.DefaultAuthorization)]
  20. public class ConfigurationController : BaseJellyfinApiController
  21. {
  22. private readonly IServerConfigurationManager _configurationManager;
  23. private readonly IMediaEncoder _mediaEncoder;
  24. private readonly JsonSerializerOptions _serializerOptions = JsonDefaults.GetOptions();
  25. /// <summary>
  26. /// Initializes a new instance of the <see cref="ConfigurationController"/> class.
  27. /// </summary>
  28. /// <param name="configurationManager">Instance of the <see cref="IServerConfigurationManager"/> interface.</param>
  29. /// <param name="mediaEncoder">Instance of the <see cref="IMediaEncoder"/> interface.</param>
  30. public ConfigurationController(
  31. IServerConfigurationManager configurationManager,
  32. IMediaEncoder mediaEncoder)
  33. {
  34. _configurationManager = configurationManager;
  35. _mediaEncoder = mediaEncoder;
  36. }
  37. /// <summary>
  38. /// Gets application configuration.
  39. /// </summary>
  40. /// <response code="200">Application configuration returned.</response>
  41. /// <returns>Application configuration.</returns>
  42. [HttpGet("Configuration")]
  43. [ProducesResponseType(StatusCodes.Status200OK)]
  44. public ActionResult<ServerConfiguration> GetConfiguration()
  45. {
  46. return _configurationManager.Configuration;
  47. }
  48. /// <summary>
  49. /// Updates application configuration.
  50. /// </summary>
  51. /// <param name="configuration">Configuration.</param>
  52. /// <response code="204">Configuration updated.</response>
  53. /// <returns>Update status.</returns>
  54. [HttpPost("Configuration")]
  55. [Authorize(Policy = Policies.RequiresElevation)]
  56. [ProducesResponseType(StatusCodes.Status204NoContent)]
  57. public ActionResult UpdateConfiguration([FromBody, Required] ServerConfiguration configuration)
  58. {
  59. _configurationManager.ReplaceConfiguration(configuration);
  60. return NoContent();
  61. }
  62. /// <summary>
  63. /// Gets a named configuration.
  64. /// </summary>
  65. /// <param name="key">Configuration key.</param>
  66. /// <response code="200">Configuration returned.</response>
  67. /// <returns>Configuration.</returns>
  68. [HttpGet("Configuration/{key}")]
  69. [ProducesResponseType(StatusCodes.Status200OK)]
  70. public ActionResult<object> GetNamedConfiguration([FromRoute] string? key)
  71. {
  72. return _configurationManager.GetConfiguration(key);
  73. }
  74. /// <summary>
  75. /// Updates named configuration.
  76. /// </summary>
  77. /// <param name="key">Configuration key.</param>
  78. /// <response code="204">Named configuration updated.</response>
  79. /// <returns>Update status.</returns>
  80. [HttpPost("Configuration/{key}")]
  81. [Authorize(Policy = Policies.RequiresElevation)]
  82. [ProducesResponseType(StatusCodes.Status204NoContent)]
  83. public async Task<ActionResult> UpdateNamedConfiguration([FromRoute] string? key)
  84. {
  85. var configurationType = _configurationManager.GetConfigurationType(key);
  86. var configuration = await JsonSerializer.DeserializeAsync(Request.Body, configurationType, _serializerOptions).ConfigureAwait(false);
  87. _configurationManager.SaveConfiguration(key, configuration);
  88. return NoContent();
  89. }
  90. /// <summary>
  91. /// Gets a default MetadataOptions object.
  92. /// </summary>
  93. /// <response code="200">Metadata options returned.</response>
  94. /// <returns>Default MetadataOptions.</returns>
  95. [HttpGet("Configuration/MetadataOptions/Default")]
  96. [Authorize(Policy = Policies.RequiresElevation)]
  97. [ProducesResponseType(StatusCodes.Status200OK)]
  98. public ActionResult<MetadataOptions> GetDefaultMetadataOptions()
  99. {
  100. return new MetadataOptions();
  101. }
  102. /// <summary>
  103. /// Updates the path to the media encoder.
  104. /// </summary>
  105. /// <param name="mediaEncoderPath">Media encoder path form body.</param>
  106. /// <response code="204">Media encoder path updated.</response>
  107. /// <returns>Status.</returns>
  108. [HttpPost("MediaEncoder/Path")]
  109. [Authorize(Policy = Policies.FirstTimeSetupOrElevated)]
  110. [ProducesResponseType(StatusCodes.Status204NoContent)]
  111. public ActionResult UpdateMediaEncoderPath([FromBody, Required] MediaEncoderPathDto mediaEncoderPath)
  112. {
  113. _mediaEncoder.UpdateEncoderPath(mediaEncoderPath.Path, mediaEncoderPath.PathType);
  114. return NoContent();
  115. }
  116. }
  117. }