| | | 1 | | using System; |
| | | 2 | | using System.Collections.Generic; |
| | | 3 | | using System.Threading.Tasks; |
| | | 4 | | using Jellyfin.Data.Enums; |
| | | 5 | | using Jellyfin.Data.Queries; |
| | | 6 | | using Jellyfin.Database.Implementations.Enums; |
| | | 7 | | using MediaBrowser.Common.Api; |
| | | 8 | | using MediaBrowser.Model.Activity; |
| | | 9 | | using MediaBrowser.Model.Querying; |
| | | 10 | | using Microsoft.AspNetCore.Authorization; |
| | | 11 | | using Microsoft.AspNetCore.Http; |
| | | 12 | | using Microsoft.AspNetCore.Mvc; |
| | | 13 | | using Microsoft.Extensions.Logging; |
| | | 14 | | |
| | | 15 | | namespace Jellyfin.Api.Controllers; |
| | | 16 | | |
| | | 17 | | /// <summary> |
| | | 18 | | /// Activity log controller. |
| | | 19 | | /// </summary> |
| | | 20 | | [Route("System/ActivityLog")] |
| | | 21 | | [Authorize(Policy = Policies.RequiresElevation)] |
| | | 22 | | [Tags("System")] |
| | | 23 | | public class ActivityLogController : BaseJellyfinApiController |
| | | 24 | | { |
| | | 25 | | private readonly IActivityManager _activityManager; |
| | | 26 | | |
| | | 27 | | /// <summary> |
| | | 28 | | /// Initializes a new instance of the <see cref="ActivityLogController"/> class. |
| | | 29 | | /// </summary> |
| | | 30 | | /// <param name="activityManager">Instance of <see cref="IActivityManager"/> interface.</param> |
| | 1 | 31 | | public ActivityLogController(IActivityManager activityManager) |
| | | 32 | | { |
| | 1 | 33 | | _activityManager = activityManager; |
| | 1 | 34 | | } |
| | | 35 | | |
| | | 36 | | /// <summary> |
| | | 37 | | /// Gets activity log entries. |
| | | 38 | | /// </summary> |
| | | 39 | | /// <param name="startIndex">The record index to start at. All items with a lower index will be dropped from the res |
| | | 40 | | /// <param name="limit">The maximum number of records to return.</param> |
| | | 41 | | /// <param name="minDate">The minimum date.</param> |
| | | 42 | | /// <param name="maxDate">The maximum date.</param> |
| | | 43 | | /// <param name="hasUserId">Filter log entries if it has user id, or not.</param> |
| | | 44 | | /// <param name="name">Filter by name.</param> |
| | | 45 | | /// <param name="overview">Filter by overview.</param> |
| | | 46 | | /// <param name="shortOverview">Filter by short overview.</param> |
| | | 47 | | /// <param name="type">Filter by type.</param> |
| | | 48 | | /// <param name="itemId">Filter by item id.</param> |
| | | 49 | | /// <param name="username">Filter by username.</param> |
| | | 50 | | /// <param name="severity">Filter by log severity.</param> |
| | | 51 | | /// <param name="sortBy">Specify one or more sort orders. Format: SortBy=Name,Type.</param> |
| | | 52 | | /// <param name="sortOrder">Sort Order..</param> |
| | | 53 | | /// <response code="200">Activity log returned.</response> |
| | | 54 | | /// <returns>A <see cref="QueryResult{ActivityLogEntry}"/> containing the log entries.</returns> |
| | | 55 | | [HttpGet("Entries")] |
| | | 56 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 57 | | public async Task<ActionResult<QueryResult<ActivityLogEntry>>> GetLogEntries( |
| | | 58 | | [FromQuery] int? startIndex, |
| | | 59 | | [FromQuery] int? limit, |
| | | 60 | | [FromQuery] DateTime? minDate, |
| | | 61 | | [FromQuery] DateTime? maxDate, |
| | | 62 | | [FromQuery] bool? hasUserId, |
| | | 63 | | [FromQuery] string? name, |
| | | 64 | | [FromQuery] string? overview, |
| | | 65 | | [FromQuery] string? shortOverview, |
| | | 66 | | [FromQuery] string? type, |
| | | 67 | | [FromQuery] Guid? itemId, |
| | | 68 | | [FromQuery] string? username, |
| | | 69 | | [FromQuery] LogLevel? severity, |
| | | 70 | | [FromQuery] ActivityLogSortBy[]? sortBy, |
| | | 71 | | [FromQuery] SortOrder[]? sortOrder) |
| | | 72 | | { |
| | 1 | 73 | | var query = new ActivityLogQuery |
| | 1 | 74 | | { |
| | 1 | 75 | | Skip = startIndex, |
| | 1 | 76 | | Limit = limit, |
| | 1 | 77 | | MinDate = minDate, |
| | 1 | 78 | | MaxDate = maxDate, |
| | 1 | 79 | | HasUserId = hasUserId, |
| | 1 | 80 | | Name = name, |
| | 1 | 81 | | Overview = overview, |
| | 1 | 82 | | ShortOverview = shortOverview, |
| | 1 | 83 | | Type = type, |
| | 1 | 84 | | ItemId = itemId, |
| | 1 | 85 | | Username = username, |
| | 1 | 86 | | Severity = severity, |
| | 1 | 87 | | OrderBy = GetOrderBy(sortBy ?? [], sortOrder ?? []), |
| | 1 | 88 | | }; |
| | | 89 | | |
| | 1 | 90 | | return await _activityManager.GetPagedResultAsync(query).ConfigureAwait(false); |
| | 1 | 91 | | } |
| | | 92 | | |
| | | 93 | | private static (ActivityLogSortBy SortBy, SortOrder SortOrder)[] GetOrderBy( |
| | | 94 | | IReadOnlyList<ActivityLogSortBy> sortBy, |
| | | 95 | | IReadOnlyList<SortOrder> requestedSortOrder) |
| | | 96 | | { |
| | 1 | 97 | | if (sortBy.Count == 0) |
| | | 98 | | { |
| | 1 | 99 | | return []; |
| | | 100 | | } |
| | | 101 | | |
| | 0 | 102 | | var result = new (ActivityLogSortBy, SortOrder)[sortBy.Count]; |
| | 0 | 103 | | var i = 0; |
| | 0 | 104 | | for (; i < requestedSortOrder.Count; i++) |
| | | 105 | | { |
| | 0 | 106 | | result[i] = (sortBy[i], requestedSortOrder[i]); |
| | | 107 | | } |
| | | 108 | | |
| | | 109 | | // Add remaining elements with the first specified SortOrder |
| | | 110 | | // or the default one if no SortOrders are specified |
| | 0 | 111 | | var order = requestedSortOrder.Count > 0 ? requestedSortOrder[0] : SortOrder.Ascending; |
| | 0 | 112 | | for (; i < sortBy.Count; i++) |
| | | 113 | | { |
| | 0 | 114 | | result[i] = (sortBy[i], order); |
| | | 115 | | } |
| | | 116 | | |
| | 0 | 117 | | return result; |
| | | 118 | | } |
| | | 119 | | } |