github-mirrors/jellyfin
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin.git synced 2025-04-24 05:57:20 -04:00
Code Issues Projects Releases Packages Wiki Activity

Suggestions from review

Browse source
This commit is contained in:
Cody Robibero 2021-10-27 19:20:14 -06:00
parent a6357f89ab
commit c534c45033
5 changed files with 59 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

53
Jellyfin.Api/Controllers/ClientLogController.cs
View file

@ -1,7 +1,11 @@
using System.Threading.Tasks;
using System.Net.Mime;
using System.Threading.Tasks;
using Jellyfin.Api.Attributes;
using Jellyfin.Api.Constants;
using Jellyfin.Api.Models.ClientLogDtos;
using MediaBrowser.Controller.ClientEvent;
using MediaBrowser.Controller.Configuration;
using MediaBrowser.Controller.Net;
using MediaBrowser.Model.ClientLog;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
@ -15,15 +19,25 @@ namespace Jellyfin.Api.Controllers
[Authorize(Policy = Policies.DefaultAuthorization)]
public class ClientLogController : BaseJellyfinApiController
{
private const int MaxDocumentSize = 1_000_000;
private readonly IClientEventLogger _clientEventLogger;
private readonly IAuthorizationContext _authorizationContext;
private readonly IServerConfigurationManager _serverConfigurationManager;
/// <summary>
/// Initializes a new instance of the <see cref="ClientLogController"/> class.
/// </summary>
/// <param name="clientEventLogger">Instance of the <see cref="IClientEventLogger"/> interface.</param>
public ClientLogController(IClientEventLogger clientEventLogger)
/// <param name="authorizationContext">Instance of the <see cref="IAuthorizationContext"/> interface.</param>
/// <param name="serverConfigurationManager">Instance of the <see cref="IServerConfigurationManager"/> interface.</param>
public ClientLogController(
IClientEventLogger clientEventLogger,
IAuthorizationContext authorizationContext,
IServerConfigurationManager serverConfigurationManager)
{
_clientEventLogger = clientEventLogger;
_authorizationContext = authorizationContext;
_serverConfigurationManager = serverConfigurationManager;
}
/// <summary>
@ -36,6 +50,11 @@ namespace Jellyfin.Api.Controllers
[ProducesResponseType(StatusCodes.Status204NoContent)]
public ActionResult LogEvent([FromBody] ClientLogEventDto clientLogEventDto)
{
if (!_serverConfigurationManager.Configuration.AllowClientLogUpload)
{
return Forbid();
}
Log(clientLogEventDto);
return NoContent();
}
@ -50,6 +69,11 @@ namespace Jellyfin.Api.Controllers
[ProducesResponseType(StatusCodes.Status204NoContent)]
public ActionResult LogEvents([FromBody] ClientLogEventDto[] clientLogEventDtos)
{
if (!_serverConfigurationManager.Configuration.AllowClientLogUpload)
{
return Forbid();
}
foreach (var dto in clientLogEventDtos)
{
Log(dto);
@ -59,15 +83,30 @@ namespace Jellyfin.Api.Controllers
}
/// <summary>
/// Upload a log file.
/// Upload a document.
/// </summary>
/// <param name="file">The file.</param>
/// <returns>Submission status.</returns>
[HttpPost("File")]
[HttpPost("Document")]
[ProducesResponseType(StatusCodes.Status204NoContent)]
public async Task<ActionResult> LogFile(IFormFile file)
[AcceptsFile(MediaTypeNames.Text.Plain)]
[RequestSizeLimit(MaxDocumentSize)]
public async Task<ActionResult> LogFile()
{
await _clientEventLogger.WriteFileAsync(file.FileName, file.OpenReadStream())
if (!_serverConfigurationManager.Configuration.AllowClientLogUpload)
{
return Forbid();
}
if (Request.ContentLength > MaxDocumentSize)
{
// Manually validate to return proper status code.
return StatusCode(StatusCodes.Status413PayloadTooLarge, $"Payload must be less than {MaxDocumentSize:N0} bytes");
}
var authorizationInfo = await _authorizationContext.GetAuthorizationInfo(Request)
.ConfigureAwait(false);
await _clientEventLogger.WriteDocumentAsync(authorizationInfo, Request.Body)
.ConfigureAwait(false);
return NoContent();
}

6
MediaBrowser.Controller/ClientEvent/ClientEventLogger.cs
View file

@ -1,6 +1,7 @@
using System;
using System.IO;
using System.Threading.Tasks;
using MediaBrowser.Controller.Net;
using MediaBrowser.Model.ClientLog;
using Microsoft.Extensions.Logging;
@ -43,10 +44,9 @@ namespace MediaBrowser.Controller.ClientEvent
}
/// <inheritdoc />
public async Task WriteFileAsync(string fileName, Stream fileContents)
public async Task WriteDocumentAsync(AuthorizationInfo authorizationInfo, Stream fileContents)
{
// Force naming convention: upload_YYYYMMDD_$name
fileName = $"upload_{DateTime.UtcNow:yyyyMMdd}_{fileName}";
var fileName = $"upload_{authorizationInfo.Client}_{authorizationInfo.Version}_{DateTime.UtcNow:yyyyMMddHHmmss}.log";
var logFilePath = Path.Combine(_applicationPaths.LogDirectoryPath, fileName);
await using var fileStream = new FileStream(logFilePath, FileMode.CreateNew, FileAccess.Write, FileShare.None);
await fileContents.CopyToAsync(fileStream).ConfigureAwait(false);

7
MediaBrowser.Controller/ClientEvent/IClientEventLogger.cs
View file

@ -1,5 +1,6 @@
using System.IO;
using System.Threading.Tasks;
using MediaBrowser.Controller.Net;
using MediaBrowser.Model.ClientLog;
namespace MediaBrowser.Controller.ClientEvent
@ -18,9 +19,9 @@ namespace MediaBrowser.Controller.ClientEvent
/// <summary>
/// Writes a file to the log directory.
/// </summary>
/// <param name="fileName">The file name.</param>
/// <param name="fileContents">The file contents.</param>
/// <param name="authorizationInfo">The current authorization info.</param>
/// <param name="fileContents">The file contents to write.</param>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
Task WriteFileAsync(string fileName, Stream fileContents);
Task WriteDocumentAsync(AuthorizationInfo authorizationInfo, Stream fileContents);
}
}

2
MediaBrowser.Model/ClientLog/ClientLogEvent.cs
View file

@ -72,4 +72,4 @@ namespace MediaBrowser.Model.ClientLog
/// </summary>
public string Message { get; }
}
}
}

5
MediaBrowser.Model/Configuration/ServerConfiguration.cs
View file

@ -459,5 +459,10 @@ namespace MediaBrowser.Model.Configuration
/// Gets or sets a value indicating whether older plugins should automatically be deleted from the plugin folder.
/// </summary>
public bool RemoveOldPlugins { get; set; }
/// <summary>
/// Gets or sets a value indicating whether clients should be allowed to upload logs.
/// </summary>
public bool AllowClientLogUpload { get; set; }
}
}