ActivityLogController.cs 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. using System;
  2. using System.Threading.Tasks;
  3. using Jellyfin.Api.Constants;
  4. using Jellyfin.Data.Queries;
  5. using MediaBrowser.Common.Api;
  6. using MediaBrowser.Model.Activity;
  7. using MediaBrowser.Model.Querying;
  8. using Microsoft.AspNetCore.Authorization;
  9. using Microsoft.AspNetCore.Http;
  10. using Microsoft.AspNetCore.Mvc;
  11. namespace Jellyfin.Api.Controllers;
  12. /// <summary>
  13. /// Activity log controller.
  14. /// </summary>
  15. [Route("System/ActivityLog")]
  16. [Authorize(Policy = Policies.RequiresElevation)]
  17. public class ActivityLogController : BaseJellyfinApiController
  18. {
  19. private readonly IActivityManager _activityManager;
  20. /// <summary>
  21. /// Initializes a new instance of the <see cref="ActivityLogController"/> class.
  22. /// </summary>
  23. /// <param name="activityManager">Instance of <see cref="IActivityManager"/> interface.</param>
  24. public ActivityLogController(IActivityManager activityManager)
  25. {
  26. _activityManager = activityManager;
  27. }
  28. /// <summary>
  29. /// Gets activity log entries.
  30. /// </summary>
  31. /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
  32. /// <param name="limit">Optional. The maximum number of records to return.</param>
  33. /// <param name="minDate">Optional. The minimum date. Format = ISO.</param>
  34. /// <param name="hasUserId">Optional. Filter log entries if it has user id, or not.</param>
  35. /// <response code="200">Activity log returned.</response>
  36. /// <returns>A <see cref="QueryResult{ActivityLogEntry}"/> containing the log entries.</returns>
  37. [HttpGet("Entries")]
  38. [ProducesResponseType(StatusCodes.Status200OK)]
  39. public async Task<ActionResult<QueryResult<ActivityLogEntry>>> GetLogEntries(
  40. [FromQuery] int? startIndex,
  41. [FromQuery] int? limit,
  42. [FromQuery] DateTime? minDate,
  43. [FromQuery] bool? hasUserId)
  44. {
  45. return await _activityManager.GetPagedResultAsync(new ActivityLogQuery
  46. {
  47. Skip = startIndex,
  48. Limit = limit,
  49. MinDate = minDate,
  50. HasUserId = hasUserId
  51. }).ConfigureAwait(false);
  52. }
  53. }