aboutsummaryrefslogtreecommitdiff
path: root/Jellyfin.Api/Controllers/StartupController.cs
diff options
context:
space:
mode:
authorShadowghost <Ghost_of_Stone@web.de>2023-02-15 22:40:07 +0100
committerShadowghost <Ghost_of_Stone@web.de>2023-02-15 22:40:07 +0100
commit3a91c37283eb633e7e55df78b8017a5a492923b6 (patch)
tree4e22db9a5234c63370195992a28c64891d7a6cc1 /Jellyfin.Api/Controllers/StartupController.cs
parent4eba16c6726564b159e395e188ec89f69d990e52 (diff)
parent3fe64f69b747f39a6505e4fad1bbd6eaf63cecc4 (diff)
Merge branch 'master' into network-rewrite
Diffstat (limited to 'Jellyfin.Api/Controllers/StartupController.cs')
-rw-r--r--Jellyfin.Api/Controllers/StartupController.cs237
1 files changed, 118 insertions, 119 deletions
diff --git a/Jellyfin.Api/Controllers/StartupController.cs b/Jellyfin.Api/Controllers/StartupController.cs
index eec5779e6..aab390d1f 100644
--- a/Jellyfin.Api/Controllers/StartupController.cs
+++ b/Jellyfin.Api/Controllers/StartupController.cs
@@ -10,141 +10,140 @@ using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
-namespace Jellyfin.Api.Controllers
+namespace Jellyfin.Api.Controllers;
+
+/// <summary>
+/// The startup wizard controller.
+/// </summary>
+[Authorize(Policy = Policies.FirstTimeSetupOrElevated)]
+public class StartupController : BaseJellyfinApiController
{
+ private readonly IServerConfigurationManager _config;
+ private readonly IUserManager _userManager;
+
/// <summary>
- /// The startup wizard controller.
+ /// Initializes a new instance of the <see cref="StartupController" /> class.
/// </summary>
- [Authorize(Policy = Policies.FirstTimeSetupOrElevated)]
- public class StartupController : BaseJellyfinApiController
+ /// <param name="config">The server configuration manager.</param>
+ /// <param name="userManager">The user manager.</param>
+ public StartupController(IServerConfigurationManager config, IUserManager userManager)
{
- private readonly IServerConfigurationManager _config;
- private readonly IUserManager _userManager;
+ _config = config;
+ _userManager = userManager;
+ }
- /// <summary>
- /// Initializes a new instance of the <see cref="StartupController" /> class.
- /// </summary>
- /// <param name="config">The server configuration manager.</param>
- /// <param name="userManager">The user manager.</param>
- public StartupController(IServerConfigurationManager config, IUserManager userManager)
- {
- _config = config;
- _userManager = userManager;
- }
+ /// <summary>
+ /// Completes the startup wizard.
+ /// </summary>
+ /// <response code="204">Startup wizard completed.</response>
+ /// <returns>A <see cref="NoContentResult"/> indicating success.</returns>
+ [HttpPost("Complete")]
+ [ProducesResponseType(StatusCodes.Status204NoContent)]
+ public ActionResult CompleteWizard()
+ {
+ _config.Configuration.IsStartupWizardCompleted = true;
+ _config.SaveConfiguration();
+ return NoContent();
+ }
- /// <summary>
- /// Completes the startup wizard.
- /// </summary>
- /// <response code="204">Startup wizard completed.</response>
- /// <returns>A <see cref="NoContentResult"/> indicating success.</returns>
- [HttpPost("Complete")]
- [ProducesResponseType(StatusCodes.Status204NoContent)]
- public ActionResult CompleteWizard()
+ /// <summary>
+ /// Gets the initial startup wizard configuration.
+ /// </summary>
+ /// <response code="200">Initial startup wizard configuration retrieved.</response>
+ /// <returns>An <see cref="OkResult"/> containing the initial startup wizard configuration.</returns>
+ [HttpGet("Configuration")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ public ActionResult<StartupConfigurationDto> GetStartupConfiguration()
+ {
+ return new StartupConfigurationDto
{
- _config.Configuration.IsStartupWizardCompleted = true;
- _config.SaveConfiguration();
- return NoContent();
- }
+ UICulture = _config.Configuration.UICulture,
+ MetadataCountryCode = _config.Configuration.MetadataCountryCode,
+ PreferredMetadataLanguage = _config.Configuration.PreferredMetadataLanguage
+ };
+ }
- /// <summary>
- /// Gets the initial startup wizard configuration.
- /// </summary>
- /// <response code="200">Initial startup wizard configuration retrieved.</response>
- /// <returns>An <see cref="OkResult"/> containing the initial startup wizard configuration.</returns>
- [HttpGet("Configuration")]
- [ProducesResponseType(StatusCodes.Status200OK)]
- public ActionResult<StartupConfigurationDto> GetStartupConfiguration()
- {
- return new StartupConfigurationDto
- {
- UICulture = _config.Configuration.UICulture,
- MetadataCountryCode = _config.Configuration.MetadataCountryCode,
- PreferredMetadataLanguage = _config.Configuration.PreferredMetadataLanguage
- };
- }
+ /// <summary>
+ /// Sets the initial startup wizard configuration.
+ /// </summary>
+ /// <param name="startupConfiguration">The updated startup configuration.</param>
+ /// <response code="204">Configuration saved.</response>
+ /// <returns>A <see cref="NoContentResult"/> indicating success.</returns>
+ [HttpPost("Configuration")]
+ [ProducesResponseType(StatusCodes.Status204NoContent)]
+ public ActionResult UpdateInitialConfiguration([FromBody, Required] StartupConfigurationDto startupConfiguration)
+ {
+ _config.Configuration.UICulture = startupConfiguration.UICulture ?? string.Empty;
+ _config.Configuration.MetadataCountryCode = startupConfiguration.MetadataCountryCode ?? string.Empty;
+ _config.Configuration.PreferredMetadataLanguage = startupConfiguration.PreferredMetadataLanguage ?? string.Empty;
+ _config.SaveConfiguration();
+ return NoContent();
+ }
- /// <summary>
- /// Sets the initial startup wizard configuration.
- /// </summary>
- /// <param name="startupConfiguration">The updated startup configuration.</param>
- /// <response code="204">Configuration saved.</response>
- /// <returns>A <see cref="NoContentResult"/> indicating success.</returns>
- [HttpPost("Configuration")]
- [ProducesResponseType(StatusCodes.Status204NoContent)]
- public ActionResult UpdateInitialConfiguration([FromBody, Required] StartupConfigurationDto startupConfiguration)
- {
- _config.Configuration.UICulture = startupConfiguration.UICulture ?? string.Empty;
- _config.Configuration.MetadataCountryCode = startupConfiguration.MetadataCountryCode ?? string.Empty;
- _config.Configuration.PreferredMetadataLanguage = startupConfiguration.PreferredMetadataLanguage ?? string.Empty;
- _config.SaveConfiguration();
- return NoContent();
- }
+ /// <summary>
+ /// Sets remote access and UPnP.
+ /// </summary>
+ /// <param name="startupRemoteAccessDto">The startup remote access dto.</param>
+ /// <response code="204">Configuration saved.</response>
+ /// <returns>A <see cref="NoContentResult"/> indicating success.</returns>
+ [HttpPost("RemoteAccess")]
+ [ProducesResponseType(StatusCodes.Status204NoContent)]
+ public ActionResult SetRemoteAccess([FromBody, Required] StartupRemoteAccessDto startupRemoteAccessDto)
+ {
+ NetworkConfiguration settings = _config.GetNetworkConfiguration();
+ settings.EnableRemoteAccess = startupRemoteAccessDto.EnableRemoteAccess;
+ settings.EnableUPnP = startupRemoteAccessDto.EnableAutomaticPortMapping;
+ _config.SaveConfiguration(NetworkConfigurationStore.StoreKey, settings);
+ return NoContent();
+ }
- /// <summary>
- /// Sets remote access and UPnP.
- /// </summary>
- /// <param name="startupRemoteAccessDto">The startup remote access dto.</param>
- /// <response code="204">Configuration saved.</response>
- /// <returns>A <see cref="NoContentResult"/> indicating success.</returns>
- [HttpPost("RemoteAccess")]
- [ProducesResponseType(StatusCodes.Status204NoContent)]
- public ActionResult SetRemoteAccess([FromBody, Required] StartupRemoteAccessDto startupRemoteAccessDto)
+ /// <summary>
+ /// Gets the first user.
+ /// </summary>
+ /// <response code="200">Initial user retrieved.</response>
+ /// <returns>The first user.</returns>
+ [HttpGet("User")]
+ [HttpGet("FirstUser", Name = "GetFirstUser_2")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ public async Task<StartupUserDto> GetFirstUser()
+ {
+ // TODO: Remove this method when startup wizard no longer requires an existing user.
+ await _userManager.InitializeAsync().ConfigureAwait(false);
+ var user = _userManager.Users.First();
+ return new StartupUserDto
{
- NetworkConfiguration settings = _config.GetNetworkConfiguration();
- settings.EnableRemoteAccess = startupRemoteAccessDto.EnableRemoteAccess;
- settings.EnableUPnP = startupRemoteAccessDto.EnableAutomaticPortMapping;
- _config.SaveConfiguration(NetworkConfigurationStore.StoreKey, settings);
- return NoContent();
- }
+ Name = user.Username,
+ Password = user.Password
+ };
+ }
- /// <summary>
- /// Gets the first user.
- /// </summary>
- /// <response code="200">Initial user retrieved.</response>
- /// <returns>The first user.</returns>
- [HttpGet("User")]
- [HttpGet("FirstUser", Name = "GetFirstUser_2")]
- [ProducesResponseType(StatusCodes.Status200OK)]
- public async Task<StartupUserDto> GetFirstUser()
- {
- // TODO: Remove this method when startup wizard no longer requires an existing user.
- await _userManager.InitializeAsync().ConfigureAwait(false);
- var user = _userManager.Users.First();
- return new StartupUserDto
- {
- Name = user.Username,
- Password = user.Password
- };
- }
+ /// <summary>
+ /// Sets the user name and password.
+ /// </summary>
+ /// <param name="startupUserDto">The DTO containing username and password.</param>
+ /// <response code="204">Updated user name and password.</response>
+ /// <returns>
+ /// A <see cref="Task" /> that represents the asynchronous update operation.
+ /// The task result contains a <see cref="NoContentResult"/> indicating success.
+ /// </returns>
+ [HttpPost("User")]
+ [ProducesResponseType(StatusCodes.Status204NoContent)]
+ public async Task<ActionResult> UpdateStartupUser([FromBody] StartupUserDto startupUserDto)
+ {
+ var user = _userManager.Users.First();
- /// <summary>
- /// Sets the user name and password.
- /// </summary>
- /// <param name="startupUserDto">The DTO containing username and password.</param>
- /// <response code="204">Updated user name and password.</response>
- /// <returns>
- /// A <see cref="Task" /> that represents the asynchronous update operation.
- /// The task result contains a <see cref="NoContentResult"/> indicating success.
- /// </returns>
- [HttpPost("User")]
- [ProducesResponseType(StatusCodes.Status204NoContent)]
- public async Task<ActionResult> UpdateStartupUser([FromBody] StartupUserDto startupUserDto)
+ if (startupUserDto.Name is not null)
{
- var user = _userManager.Users.First();
-
- if (startupUserDto.Name is not null)
- {
- user.Username = startupUserDto.Name;
- }
-
- await _userManager.UpdateUserAsync(user).ConfigureAwait(false);
+ user.Username = startupUserDto.Name;
+ }
- if (!string.IsNullOrEmpty(startupUserDto.Password))
- {
- await _userManager.ChangePassword(user, startupUserDto.Password).ConfigureAwait(false);
- }
+ await _userManager.UpdateUserAsync(user).ConfigureAwait(false);
- return NoContent();
+ if (!string.IsNullOrEmpty(startupUserDto.Password))
+ {
+ await _userManager.ChangePassword(user, startupUserDto.Password).ConfigureAwait(false);
}
+
+ return NoContent();
}
}