QuickConnectController.cs 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  1. using System.ComponentModel.DataAnnotations;
  2. using System.Threading.Tasks;
  3. using Jellyfin.Api.Constants;
  4. using Jellyfin.Api.Helpers;
  5. using MediaBrowser.Common.Extensions;
  6. using MediaBrowser.Controller.Authentication;
  7. using MediaBrowser.Controller.Net;
  8. using MediaBrowser.Controller.QuickConnect;
  9. using MediaBrowser.Model.QuickConnect;
  10. using Microsoft.AspNetCore.Authorization;
  11. using Microsoft.AspNetCore.Http;
  12. using Microsoft.AspNetCore.Mvc;
  13. namespace Jellyfin.Api.Controllers
  14. {
  15. /// <summary>
  16. /// Quick connect controller.
  17. /// </summary>
  18. public class QuickConnectController : BaseJellyfinApiController
  19. {
  20. private readonly IQuickConnect _quickConnect;
  21. private readonly IAuthorizationContext _authContext;
  22. /// <summary>
  23. /// Initializes a new instance of the <see cref="QuickConnectController"/> class.
  24. /// </summary>
  25. /// <param name="quickConnect">Instance of the <see cref="IQuickConnect"/> interface.</param>
  26. /// <param name="authContext">Instance of the <see cref="IAuthorizationContext"/> interface.</param>
  27. public QuickConnectController(IQuickConnect quickConnect, IAuthorizationContext authContext)
  28. {
  29. _quickConnect = quickConnect;
  30. _authContext = authContext;
  31. }
  32. /// <summary>
  33. /// Gets the current quick connect state.
  34. /// </summary>
  35. /// <response code="200">Quick connect state returned.</response>
  36. /// <returns>Whether Quick Connect is enabled on the server or not.</returns>
  37. [HttpGet("Enabled")]
  38. [ProducesResponseType(StatusCodes.Status200OK)]
  39. public ActionResult<bool> GetEnabled()
  40. {
  41. return _quickConnect.IsEnabled;
  42. }
  43. /// <summary>
  44. /// Initiate a new quick connect request.
  45. /// </summary>
  46. /// <response code="200">Quick connect request successfully created.</response>
  47. /// <response code="401">Quick connect is not active on this server.</response>
  48. /// <returns>A <see cref="QuickConnectResult"/> with a secret and code for future use or an error message.</returns>
  49. [HttpGet("Initiate")]
  50. [ProducesResponseType(StatusCodes.Status200OK)]
  51. public async Task<ActionResult<QuickConnectResult>> Initiate()
  52. {
  53. try
  54. {
  55. var auth = await _authContext.GetAuthorizationInfo(Request).ConfigureAwait(false);
  56. return _quickConnect.TryConnect(auth);
  57. }
  58. catch (AuthenticationException)
  59. {
  60. return Unauthorized("Quick connect is disabled");
  61. }
  62. }
  63. /// <summary>
  64. /// Attempts to retrieve authentication information.
  65. /// </summary>
  66. /// <param name="secret">Secret previously returned from the Initiate endpoint.</param>
  67. /// <response code="200">Quick connect result returned.</response>
  68. /// <response code="404">Unknown quick connect secret.</response>
  69. /// <returns>An updated <see cref="QuickConnectResult"/>.</returns>
  70. [HttpGet("Connect")]
  71. [ProducesResponseType(StatusCodes.Status200OK)]
  72. [ProducesResponseType(StatusCodes.Status404NotFound)]
  73. public ActionResult<QuickConnectResult> Connect([FromQuery, Required] string secret)
  74. {
  75. try
  76. {
  77. return _quickConnect.CheckRequestStatus(secret);
  78. }
  79. catch (ResourceNotFoundException)
  80. {
  81. return NotFound("Unknown secret");
  82. }
  83. catch (AuthenticationException)
  84. {
  85. return Unauthorized("Quick connect is disabled");
  86. }
  87. }
  88. /// <summary>
  89. /// Authorizes a pending quick connect request.
  90. /// </summary>
  91. /// <param name="code">Quick connect code to authorize.</param>
  92. /// <response code="200">Quick connect result authorized successfully.</response>
  93. /// <response code="403">Unknown user id.</response>
  94. /// <returns>Boolean indicating if the authorization was successful.</returns>
  95. [HttpPost("Authorize")]
  96. [Authorize(Policy = Policies.DefaultAuthorization)]
  97. [ProducesResponseType(StatusCodes.Status200OK)]
  98. [ProducesResponseType(StatusCodes.Status403Forbidden)]
  99. public async Task<ActionResult<bool>> Authorize([FromQuery, Required] string code)
  100. {
  101. var userId = ClaimHelpers.GetUserId(Request.HttpContext.User);
  102. if (!userId.HasValue)
  103. {
  104. return StatusCode(StatusCodes.Status403Forbidden, "Unknown user id");
  105. }
  106. try
  107. {
  108. return await _quickConnect.AuthorizeRequest(userId.Value, code).ConfigureAwait(false);
  109. }
  110. catch (AuthenticationException)
  111. {
  112. return Unauthorized("Quick connect is disabled");
  113. }
  114. }
  115. }
  116. }