| | | 1 | | using System.Net.Mime; |
| | | 2 | | using System.Threading.Tasks; |
| | | 3 | | using Jellyfin.Api.Attributes; |
| | | 4 | | using Jellyfin.Api.Extensions; |
| | | 5 | | using Jellyfin.Api.Models.ClientLogDtos; |
| | | 6 | | using MediaBrowser.Controller.ClientEvent; |
| | | 7 | | using MediaBrowser.Controller.Configuration; |
| | | 8 | | using Microsoft.AspNetCore.Authorization; |
| | | 9 | | using Microsoft.AspNetCore.Http; |
| | | 10 | | using Microsoft.AspNetCore.Mvc; |
| | | 11 | | |
| | | 12 | | namespace Jellyfin.Api.Controllers; |
| | | 13 | | |
| | | 14 | | /// <summary> |
| | | 15 | | /// Client log controller. |
| | | 16 | | /// </summary> |
| | | 17 | | [Authorize] |
| | | 18 | | [Tags("System")] |
| | | 19 | | public class ClientLogController : BaseJellyfinApiController |
| | | 20 | | { |
| | | 21 | | private const int MaxDocumentSize = 1_000_000; |
| | | 22 | | private readonly IClientEventLogger _clientEventLogger; |
| | | 23 | | private readonly IServerConfigurationManager _serverConfigurationManager; |
| | | 24 | | |
| | | 25 | | /// <summary> |
| | | 26 | | /// Initializes a new instance of the <see cref="ClientLogController"/> class. |
| | | 27 | | /// </summary> |
| | | 28 | | /// <param name="clientEventLogger">Instance of the <see cref="IClientEventLogger"/> interface.</param> |
| | | 29 | | /// <param name="serverConfigurationManager">Instance of the <see cref="IServerConfigurationManager"/> interface.</p |
| | 0 | 30 | | public ClientLogController( |
| | 0 | 31 | | IClientEventLogger clientEventLogger, |
| | 0 | 32 | | IServerConfigurationManager serverConfigurationManager) |
| | | 33 | | { |
| | 0 | 34 | | _clientEventLogger = clientEventLogger; |
| | 0 | 35 | | _serverConfigurationManager = serverConfigurationManager; |
| | 0 | 36 | | } |
| | | 37 | | |
| | | 38 | | /// <summary> |
| | | 39 | | /// Upload a document. |
| | | 40 | | /// </summary> |
| | | 41 | | /// <response code="200">Document saved.</response> |
| | | 42 | | /// <response code="403">Event logging disabled.</response> |
| | | 43 | | /// <response code="413">Upload size too large.</response> |
| | | 44 | | /// <returns>Create response.</returns> |
| | | 45 | | [HttpPost("Document")] |
| | | 46 | | [ProducesResponseType(typeof(ClientLogDocumentResponseDto), StatusCodes.Status200OK)] |
| | | 47 | | [ProducesResponseType(StatusCodes.Status403Forbidden)] |
| | | 48 | | [ProducesResponseType(StatusCodes.Status413PayloadTooLarge)] |
| | | 49 | | [AcceptsFile(MediaTypeNames.Text.Plain)] |
| | | 50 | | [RequestSizeLimit(MaxDocumentSize)] |
| | | 51 | | public async Task<ActionResult<ClientLogDocumentResponseDto>> LogFile() |
| | | 52 | | { |
| | 0 | 53 | | if (!_serverConfigurationManager.Configuration.AllowClientLogUpload) |
| | | 54 | | { |
| | 0 | 55 | | return Forbid(); |
| | | 56 | | } |
| | | 57 | | |
| | 0 | 58 | | if (Request.ContentLength > MaxDocumentSize) |
| | | 59 | | { |
| | | 60 | | // Manually validate to return proper status code. |
| | 0 | 61 | | return StatusCode(StatusCodes.Status413PayloadTooLarge, $"Payload must be less than {MaxDocumentSize:N0} byt |
| | | 62 | | } |
| | | 63 | | |
| | 0 | 64 | | var (clientName, clientVersion) = GetRequestInformation(); |
| | 0 | 65 | | var fileName = await _clientEventLogger.WriteDocumentAsync(clientName, clientVersion, Request.Body) |
| | 0 | 66 | | .ConfigureAwait(false); |
| | 0 | 67 | | return Ok(new ClientLogDocumentResponseDto(fileName)); |
| | 0 | 68 | | } |
| | | 69 | | |
| | | 70 | | private (string ClientName, string ClientVersion) GetRequestInformation() |
| | | 71 | | { |
| | 0 | 72 | | var clientName = HttpContext.User.GetClient() ?? "unknown-client"; |
| | 0 | 73 | | var clientVersion = HttpContext.User.GetIsApiKey() |
| | 0 | 74 | | ? "apikey" |
| | 0 | 75 | | : HttpContext.User.GetVersion() ?? "unknown-version"; |
| | | 76 | | |
| | 0 | 77 | | return (clientName, clientVersion); |
| | | 78 | | } |
| | | 79 | | } |