ConfigurationController.cs 5.9 KB

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