jellyfin-server/Jellyfin.Api/Controllers/StartupController.cs

151 lines
6.1 KiB
C#
Raw Normal View History

2019-07-02 10:21:54 +00:00
using System.Linq;
using System.Threading.Tasks;
2019-11-24 18:25:46 +00:00
using Jellyfin.Api.Constants;
using Jellyfin.Api.Models.StartupDtos;
2019-07-02 10:21:54 +00:00
using MediaBrowser.Controller.Configuration;
using MediaBrowser.Controller.Library;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
2019-07-02 10:21:54 +00:00
using Microsoft.AspNetCore.Mvc;
namespace Jellyfin.Api.Controllers
{
2019-11-23 19:31:17 +00:00
/// <summary>
/// The startup wizard controller.
/// </summary>
2019-11-24 18:25:46 +00:00
[Authorize(Policy = Policies.FirstTimeSetupOrElevated)]
public class StartupController : BaseJellyfinApiController
2019-07-02 10:21:54 +00:00
{
private readonly IServerConfigurationManager _config;
private readonly IUserManager _userManager;
2019-11-23 19:31:17 +00:00
/// <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>
2019-07-02 10:21:54 +00:00
public StartupController(IServerConfigurationManager config, IUserManager userManager)
{
_config = config;
_userManager = userManager;
}
2019-11-23 19:31:17 +00:00
/// <summary>
2020-04-29 15:41:12 +00:00
/// Completes the startup wizard.
2019-11-23 19:31:17 +00:00
/// </summary>
/// <response code="204">Startup wizard completed.</response>
/// <returns>A <see cref="NoContentResult"/> indicating success.</returns>
2019-07-02 10:21:54 +00:00
[HttpPost("Complete")]
[ProducesResponseType(StatusCodes.Status204NoContent)]
2020-04-21 20:25:03 +00:00
public ActionResult CompleteWizard()
2019-07-02 10:21:54 +00:00
{
_config.Configuration.IsStartupWizardCompleted = true;
_config.SaveConfiguration();
return NoContent();
2019-07-02 10:21:54 +00:00
}
2019-11-23 19:31:17 +00:00
/// <summary>
2020-04-29 15:41:12 +00:00
/// Gets the initial startup wizard configuration.
2019-11-23 19:31:17 +00:00
/// </summary>
2020-04-29 14:59:34 +00:00
/// <response code="200">Initial startup wizard configuration retrieved.</response>
2020-05-18 01:56:02 +00:00
/// <returns>An <see cref="OkResult"/> containing the initial startup wizard configuration.</returns>
2019-07-02 10:21:54 +00:00
[HttpGet("Configuration")]
2020-04-21 20:25:03 +00:00
[ProducesResponseType(StatusCodes.Status200OK)]
public ActionResult<StartupConfigurationDto> GetStartupConfiguration()
2019-07-02 10:21:54 +00:00
{
2020-07-22 18:57:29 +00:00
return new StartupConfigurationDto
2019-07-02 10:21:54 +00:00
{
UICulture = _config.Configuration.UICulture,
MetadataCountryCode = _config.Configuration.MetadataCountryCode,
PreferredMetadataLanguage = _config.Configuration.PreferredMetadataLanguage
};
}
2019-11-23 19:31:17 +00:00
/// <summary>
2020-04-29 15:41:12 +00:00
/// Sets the initial startup wizard configuration.
2019-11-23 19:31:17 +00:00
/// </summary>
/// <param name="uiCulture">The UI language culture.</param>
/// <param name="metadataCountryCode">The metadata country code.</param>
/// <param name="preferredMetadataLanguage">The preferred language for metadata.</param>
/// <response code="204">Configuration saved.</response>
/// <returns>A <see cref="NoContentResult"/> indicating success.</returns>
2019-07-02 10:21:54 +00:00
[HttpPost("Configuration")]
[ProducesResponseType(StatusCodes.Status204NoContent)]
2020-04-21 20:25:03 +00:00
public ActionResult UpdateInitialConfiguration(
2020-06-27 16:50:44 +00:00
[FromForm] string? uiCulture,
[FromForm] string? metadataCountryCode,
[FromForm] string? preferredMetadataLanguage)
2019-07-02 10:21:54 +00:00
{
_config.Configuration.UICulture = uiCulture;
_config.Configuration.MetadataCountryCode = metadataCountryCode;
_config.Configuration.PreferredMetadataLanguage = preferredMetadataLanguage;
_config.SaveConfiguration();
return NoContent();
2019-07-02 10:21:54 +00:00
}
2019-11-23 19:31:17 +00:00
/// <summary>
2020-04-29 15:41:12 +00:00
/// Sets remote access and UPnP.
2019-11-23 19:31:17 +00:00
/// </summary>
/// <param name="enableRemoteAccess">Enable remote access.</param>
/// <param name="enableAutomaticPortMapping">Enable UPnP.</param>
/// <response code="204">Configuration saved.</response>
/// <returns>A <see cref="NoContentResult"/> indicating success.</returns>
2019-07-02 10:21:54 +00:00
[HttpPost("RemoteAccess")]
[ProducesResponseType(StatusCodes.Status204NoContent)]
2020-04-21 20:25:03 +00:00
public ActionResult SetRemoteAccess([FromForm] bool enableRemoteAccess, [FromForm] bool enableAutomaticPortMapping)
2019-07-02 10:21:54 +00:00
{
_config.Configuration.EnableRemoteAccess = enableRemoteAccess;
_config.Configuration.EnableUPnP = enableAutomaticPortMapping;
_config.SaveConfiguration();
return NoContent();
2019-07-02 10:21:54 +00:00
}
2019-11-23 19:31:17 +00:00
/// <summary>
2020-04-29 15:41:12 +00:00
/// Gets the first user.
2019-11-23 19:31:17 +00:00
/// </summary>
2020-04-29 14:59:34 +00:00
/// <response code="200">Initial user retrieved.</response>
2019-11-23 19:31:17 +00:00
/// <returns>The first user.</returns>
2019-07-02 10:21:54 +00:00
[HttpGet("User")]
2020-06-02 14:28:37 +00:00
[HttpGet("FirstUser")]
2020-04-21 20:25:03 +00:00
[ProducesResponseType(StatusCodes.Status200OK)]
2020-07-22 18:57:29 +00:00
public async Task<StartupUserDto> GetFirstUser()
2019-07-02 10:21:54 +00:00
{
2020-06-09 18:01:21 +00:00
// TODO: Remove this method when startup wizard no longer requires an existing user.
2020-07-22 18:57:29 +00:00
await _userManager.InitializeAsync().ConfigureAwait(false);
2019-07-02 10:21:54 +00:00
var user = _userManager.Users.First();
return new StartupUserDto
2019-07-02 10:21:54 +00:00
{
2020-05-13 02:10:35 +00:00
Name = user.Username,
2019-07-02 10:21:54 +00:00
Password = user.Password
};
}
2019-11-23 19:31:17 +00:00
/// <summary>
2020-04-29 15:41:12 +00:00
/// Sets the user name and password.
2019-11-23 19:31:17 +00:00
/// </summary>
/// <param name="startupUserDto">The DTO containing username and password.</param>
/// <response code="204">Updated user name and password.</response>
2020-05-18 01:56:02 +00:00
/// <returns>
/// A <see cref="Task" /> that represents the asynchronous update operation.
/// The task result contains a <see cref="NoContentResult"/> indicating success.
2020-05-18 01:56:02 +00:00
/// </returns>
2019-07-02 10:21:54 +00:00
[HttpPost("User")]
[ProducesResponseType(StatusCodes.Status204NoContent)]
2020-04-21 20:25:03 +00:00
public async Task<ActionResult> UpdateUser([FromForm] StartupUserDto startupUserDto)
2019-07-02 10:21:54 +00:00
{
var user = _userManager.Users.First();
2020-05-13 02:10:35 +00:00
user.Username = startupUserDto.Name;
2019-07-02 10:21:54 +00:00
2020-06-09 18:01:21 +00:00
await _userManager.UpdateUserAsync(user).ConfigureAwait(false);
2019-07-02 10:21:54 +00:00
if (!string.IsNullOrEmpty(startupUserDto.Password))
2019-07-02 10:21:54 +00:00
{
await _userManager.ChangePassword(user, startupUserDto.Password).ConfigureAwait(false);
2019-07-02 10:21:54 +00:00
}
return NoContent();
2019-07-02 10:21:54 +00:00
}
}
}