diff --git a/Jellyfin.Api/Controllers/ActivityLogController.cs b/Jellyfin.Api/Controllers/ActivityLogController.cs
index a19a203b51..d5f2627739 100644
--- a/Jellyfin.Api/Controllers/ActivityLogController.cs
+++ b/Jellyfin.Api/Controllers/ActivityLogController.cs
@@ -1,13 +1,16 @@
using System;
+using System.Collections.Generic;
using System.Threading.Tasks;
-using Jellyfin.Api.Constants;
+using Jellyfin.Data.Enums;
using Jellyfin.Data.Queries;
+using Jellyfin.Database.Implementations.Enums;
using MediaBrowser.Common.Api;
using MediaBrowser.Model.Activity;
using MediaBrowser.Model.Querying;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Logging;
namespace Jellyfin.Api.Controllers;
@@ -32,10 +35,19 @@ public class ActivityLogController : BaseJellyfinApiController
///
/// Gets activity log entries.
///
- /// Optional. The record index to start at. All items with a lower index will be dropped from the results.
- /// Optional. The maximum number of records to return.
- /// Optional. The minimum date. Format = ISO.
- /// Optional. Filter log entries if it has user id, or not.
+ /// The record index to start at. All items with a lower index will be dropped from the results.
+ /// The maximum number of records to return.
+ /// The minimum date.
+ /// Filter log entries if it has user id, or not.
+ /// Filter by name.
+ /// Filter by overview.
+ /// Filter by short overview.
+ /// Filter by type.
+ /// Filter by item id.
+ /// Filter by username.
+ /// Filter by log severity.
+ /// Specify one or more sort orders. Format: SortBy=Name,Type.
+ /// Sort Order..
/// Activity log returned.
/// A containing the log entries.
[HttpGet("Entries")]
@@ -44,14 +56,60 @@ public class ActivityLogController : BaseJellyfinApiController
[FromQuery] int? startIndex,
[FromQuery] int? limit,
[FromQuery] DateTime? minDate,
- [FromQuery] bool? hasUserId)
+ [FromQuery] bool? hasUserId,
+ [FromQuery] string? name,
+ [FromQuery] string? overview,
+ [FromQuery] string? shortOverview,
+ [FromQuery] string? type,
+ [FromQuery] Guid? itemId,
+ [FromQuery] string? username,
+ [FromQuery] LogLevel? severity,
+ [FromQuery] ActivityLogSortBy[]? sortBy,
+ [FromQuery] SortOrder[]? sortOrder)
{
- return await _activityManager.GetPagedResultAsync(new ActivityLogQuery
+ var query = new ActivityLogQuery
{
Skip = startIndex,
Limit = limit,
MinDate = minDate,
- HasUserId = hasUserId
- }).ConfigureAwait(false);
+ HasUserId = hasUserId,
+ Name = name,
+ Overview = overview,
+ ShortOverview = shortOverview,
+ Type = type,
+ ItemId = itemId,
+ Username = username,
+ Severity = severity,
+ OrderBy = GetOrderBy(sortBy ?? [], sortOrder ?? []),
+ };
+
+ return await _activityManager.GetPagedResultAsync(query).ConfigureAwait(false);
+ }
+
+ private static (ActivityLogSortBy SortBy, SortOrder SortOrder)[] GetOrderBy(
+ IReadOnlyList sortBy,
+ IReadOnlyList requestedSortOrder)
+ {
+ if (sortBy.Count == 0)
+ {
+ return [];
+ }
+
+ var result = new (ActivityLogSortBy, SortOrder)[sortBy.Count];
+ var i = 0;
+ for (; i < requestedSortOrder.Count; i++)
+ {
+ result[i] = (sortBy[i], requestedSortOrder[i]);
+ }
+
+ // Add remaining elements with the first specified SortOrder
+ // or the default one if no SortOrders are specified
+ var order = requestedSortOrder.Count > 0 ? requestedSortOrder[0] : SortOrder.Ascending;
+ for (; i < sortBy.Count; i++)
+ {
+ result[i] = (sortBy[i], order);
+ }
+
+ return result;
}
}
diff --git a/Jellyfin.Data/Enums/ActivityLogSortBy.cs b/Jellyfin.Data/Enums/ActivityLogSortBy.cs
new file mode 100644
index 0000000000..d6d44e8c07
--- /dev/null
+++ b/Jellyfin.Data/Enums/ActivityLogSortBy.cs
@@ -0,0 +1,49 @@
+namespace Jellyfin.Data.Enums;
+
+///
+/// Activity log sorting options.
+///
+public enum ActivityLogSortBy
+{
+ ///
+ /// Sort by name.
+ ///
+ Name = 0,
+
+ ///
+ /// Sort by overview.
+ ///
+ Overiew = 1,
+
+ ///
+ /// Sort by short overview.
+ ///
+ ShortOverview = 2,
+
+ ///
+ /// Sort by type.
+ ///
+ Type = 3,
+
+ /*
+ ///
+ /// Sort by item name.
+ ///
+ Item = 4,
+ */
+
+ ///
+ /// Sort by date.
+ ///
+ DateCreated = 5,
+
+ ///
+ /// Sort by username.
+ ///
+ Username = 6,
+
+ ///
+ /// Sort by severity.
+ ///
+ LogSeverity = 7
+}
diff --git a/Jellyfin.Data/Queries/ActivityLogQuery.cs b/Jellyfin.Data/Queries/ActivityLogQuery.cs
index f1af099d3c..95c52f8705 100644
--- a/Jellyfin.Data/Queries/ActivityLogQuery.cs
+++ b/Jellyfin.Data/Queries/ActivityLogQuery.cs
@@ -1,20 +1,63 @@
using System;
+using System.Collections.Generic;
+using Jellyfin.Data.Enums;
+using Jellyfin.Database.Implementations.Enums;
+using Microsoft.Extensions.Logging;
-namespace Jellyfin.Data.Queries
+namespace Jellyfin.Data.Queries;
+
+///
+/// A class representing a query to the activity logs.
+///
+public class ActivityLogQuery : PaginatedQuery
{
///
- /// A class representing a query to the activity logs.
+ /// Gets or sets a value indicating whether to take entries with a user id.
///
- public class ActivityLogQuery : PaginatedQuery
- {
- ///
- /// Gets or sets a value indicating whether to take entries with a user id.
- ///
- public bool? HasUserId { get; set; }
+ public bool? HasUserId { get; set; }
- ///
- /// Gets or sets the minimum date to query for.
- ///
- public DateTime? MinDate { get; set; }
- }
+ ///
+ /// Gets or sets the minimum date to query for.
+ ///
+ public DateTime? MinDate { get; set; }
+
+ ///
+ /// Gets or sets the name filter.
+ ///
+ public string? Name { get; set; }
+
+ ///
+ /// Gets or sets the overview filter.
+ ///
+ public string? Overview { get; set; }
+
+ ///
+ /// Gets or sets the short overview filter.
+ ///
+ public string? ShortOverview { get; set; }
+
+ ///
+ /// Gets or sets the type filter.
+ ///
+ public string? Type { get; set; }
+
+ ///
+ /// Gets or sets the item filter.
+ ///
+ public Guid? ItemId { get; set; }
+
+ ///
+ /// Gets or sets the username filter.
+ ///
+ public string? Username { get; set; }
+
+ ///
+ /// Gets or sets the log level filter.
+ ///
+ public LogLevel? Severity { get; set; }
+
+ ///
+ /// Gets or sets the result ordering.
+ ///
+ public IReadOnlyCollection<(ActivityLogSortBy, SortOrder)>? OrderBy { get; set; }
}
diff --git a/Jellyfin.Server.Implementations/Activity/ActivityManager.cs b/Jellyfin.Server.Implementations/Activity/ActivityManager.cs
index 8d492f7cd7..7ee573f538 100644
--- a/Jellyfin.Server.Implementations/Activity/ActivityManager.cs
+++ b/Jellyfin.Server.Implementations/Activity/ActivityManager.cs
@@ -1,103 +1,198 @@
using System;
+using System.Collections.Generic;
using System.Linq;
+using System.Linq.Expressions;
using System.Threading.Tasks;
+using Jellyfin.Data.Enums;
using Jellyfin.Data.Events;
using Jellyfin.Data.Queries;
using Jellyfin.Database.Implementations;
using Jellyfin.Database.Implementations.Entities;
+using Jellyfin.Database.Implementations.Enums;
+using Jellyfin.Extensions;
using MediaBrowser.Model.Activity;
using MediaBrowser.Model.Querying;
using Microsoft.EntityFrameworkCore;
-namespace Jellyfin.Server.Implementations.Activity
+namespace Jellyfin.Server.Implementations.Activity;
+
+///
+/// Manages the storage and retrieval of instances.
+///
+public class ActivityManager : IActivityManager
{
+ private readonly IDbContextFactory _provider;
+
///
- /// Manages the storage and retrieval of instances.
+ /// Initializes a new instance of the class.
///
- public class ActivityManager : IActivityManager
+ /// The Jellyfin database provider.
+ public ActivityManager(IDbContextFactory provider)
{
- private readonly IDbContextFactory _provider;
+ _provider = provider;
+ }
- ///
- /// Initializes a new instance of the class.
- ///
- /// The Jellyfin database provider.
- public ActivityManager(IDbContextFactory provider)
+ ///
+ public event EventHandler>? EntryCreated;
+
+ ///
+ public async Task CreateAsync(ActivityLog entry)
+ {
+ var dbContext = await _provider.CreateDbContextAsync().ConfigureAwait(false);
+ await using (dbContext.ConfigureAwait(false))
{
- _provider = provider;
+ dbContext.ActivityLogs.Add(entry);
+ await dbContext.SaveChangesAsync().ConfigureAwait(false);
}
- ///
- public event EventHandler>? EntryCreated;
+ EntryCreated?.Invoke(this, new GenericEventArgs(ConvertToOldModel(entry)));
+ }
- ///
- public async Task CreateAsync(ActivityLog entry)
+ ///
+ public async Task> GetPagedResultAsync(ActivityLogQuery query)
+ {
+ // TODO allow sorting and filtering by item id. Currently not possible because ActivityLog stores the item id as a string.
+
+ var dbContext = await _provider.CreateDbContextAsync().ConfigureAwait(false);
+ await using (dbContext.ConfigureAwait(false))
{
- var dbContext = await _provider.CreateDbContextAsync().ConfigureAwait(false);
- await using (dbContext.ConfigureAwait(false))
+ // TODO switch to LeftJoin in .NET 10.
+ var entries = from a in dbContext.ActivityLogs
+ join u in dbContext.Users on a.UserId equals u.Id into ugj
+ from u in ugj.DefaultIfEmpty()
+ select new ExpandedActivityLog { ActivityLog = a, Username = u.Username };
+
+ if (query.HasUserId is not null)
{
- dbContext.ActivityLogs.Add(entry);
- await dbContext.SaveChangesAsync().ConfigureAwait(false);
+ entries = entries.Where(e => e.ActivityLog.UserId.Equals(default) != query.HasUserId.Value);
}
- EntryCreated?.Invoke(this, new GenericEventArgs(ConvertToOldModel(entry)));
- }
-
- ///
- public async Task> GetPagedResultAsync(ActivityLogQuery query)
- {
- var dbContext = await _provider.CreateDbContextAsync().ConfigureAwait(false);
- await using (dbContext.ConfigureAwait(false))
+ if (query.MinDate is not null)
{
- var entries = dbContext.ActivityLogs
- .OrderByDescending(entry => entry.DateCreated)
- .Where(entry => query.MinDate == null || entry.DateCreated >= query.MinDate)
- .Where(entry => !query.HasUserId.HasValue || entry.UserId.Equals(default) != query.HasUserId.Value);
-
- return new QueryResult(
- query.Skip,
- await entries.CountAsync().ConfigureAwait(false),
- await entries
- .Skip(query.Skip ?? 0)
- .Take(query.Limit ?? 100)
- .Select(entity => new ActivityLogEntry(entity.Name, entity.Type, entity.UserId)
- {
- Id = entity.Id,
- Overview = entity.Overview,
- ShortOverview = entity.ShortOverview,
- ItemId = entity.ItemId,
- Date = entity.DateCreated,
- Severity = entity.LogSeverity
- })
- .ToListAsync()
- .ConfigureAwait(false));
+ entries = entries.Where(e => e.ActivityLog.DateCreated >= query.MinDate.Value);
}
- }
- ///
- public async Task CleanAsync(DateTime startDate)
- {
- var dbContext = await _provider.CreateDbContextAsync().ConfigureAwait(false);
- await using (dbContext.ConfigureAwait(false))
+ if (!string.IsNullOrEmpty(query.Name))
{
- await dbContext.ActivityLogs
- .Where(entry => entry.DateCreated <= startDate)
- .ExecuteDeleteAsync()
- .ConfigureAwait(false);
+ entries = entries.Where(e => EF.Functions.Like(e.ActivityLog.Name, $"%{query.Name}%"));
}
- }
- private static ActivityLogEntry ConvertToOldModel(ActivityLog entry)
- {
- return new ActivityLogEntry(entry.Name, entry.Type, entry.UserId)
+ if (!string.IsNullOrEmpty(query.Overview))
{
- Id = entry.Id,
- Overview = entry.Overview,
- ShortOverview = entry.ShortOverview,
- ItemId = entry.ItemId,
- Date = entry.DateCreated,
- Severity = entry.LogSeverity
- };
+ entries = entries.Where(e => EF.Functions.Like(e.ActivityLog.Overview, $"%{query.Overview}%"));
+ }
+
+ if (!string.IsNullOrEmpty(query.ShortOverview))
+ {
+ entries = entries.Where(e => EF.Functions.Like(e.ActivityLog.ShortOverview, $"%{query.ShortOverview}%"));
+ }
+
+ if (!string.IsNullOrEmpty(query.Type))
+ {
+ entries = entries.Where(e => EF.Functions.Like(e.ActivityLog.Type, $"%{query.Type}%"));
+ }
+
+ if (!query.ItemId.IsNullOrEmpty())
+ {
+ var itemId = query.ItemId.Value.ToString("N");
+ entries = entries.Where(e => e.ActivityLog.ItemId == itemId);
+ }
+
+ if (!string.IsNullOrEmpty(query.Username))
+ {
+ entries = entries.Where(e => EF.Functions.Like(e.Username, $"%{query.Username}%"));
+ }
+
+ if (query.Severity is not null)
+ {
+ entries = entries.Where(e => e.ActivityLog.LogSeverity == query.Severity);
+ }
+
+ return new QueryResult(
+ query.Skip,
+ await entries.CountAsync().ConfigureAwait(false),
+ await ApplyOrdering(entries, query.OrderBy)
+ .Skip(query.Skip ?? 0)
+ .Take(query.Limit ?? 100)
+ .Select(entity => new ActivityLogEntry(entity.ActivityLog.Name, entity.ActivityLog.Type, entity.ActivityLog.UserId)
+ {
+ Id = entity.ActivityLog.Id,
+ Overview = entity.ActivityLog.Overview,
+ ShortOverview = entity.ActivityLog.ShortOverview,
+ ItemId = entity.ActivityLog.ItemId,
+ Date = entity.ActivityLog.DateCreated,
+ Severity = entity.ActivityLog.LogSeverity
+ })
+ .ToListAsync()
+ .ConfigureAwait(false));
}
}
+
+ ///
+ public async Task CleanAsync(DateTime startDate)
+ {
+ var dbContext = await _provider.CreateDbContextAsync().ConfigureAwait(false);
+ await using (dbContext.ConfigureAwait(false))
+ {
+ await dbContext.ActivityLogs
+ .Where(entry => entry.DateCreated <= startDate)
+ .ExecuteDeleteAsync()
+ .ConfigureAwait(false);
+ }
+ }
+
+ private static ActivityLogEntry ConvertToOldModel(ActivityLog entry)
+ {
+ return new ActivityLogEntry(entry.Name, entry.Type, entry.UserId)
+ {
+ Id = entry.Id,
+ Overview = entry.Overview,
+ ShortOverview = entry.ShortOverview,
+ ItemId = entry.ItemId,
+ Date = entry.DateCreated,
+ Severity = entry.LogSeverity
+ };
+ }
+
+ private IOrderedQueryable ApplyOrdering(IQueryable query, IReadOnlyCollection<(ActivityLogSortBy, SortOrder)>? sorting)
+ {
+ if (sorting is null || sorting.Count == 0)
+ {
+ return query.OrderByDescending(e => e.ActivityLog.DateCreated);
+ }
+
+ IOrderedQueryable ordered = null!;
+
+ foreach (var (sortBy, sortOrder) in sorting)
+ {
+ var orderBy = MapOrderBy(sortBy);
+ ordered = sortOrder == SortOrder.Ascending
+ ? (ordered ?? query).OrderBy(orderBy)
+ : (ordered ?? query).OrderByDescending(orderBy);
+ }
+
+ return ordered;
+ }
+
+ private Expression> MapOrderBy(ActivityLogSortBy sortBy)
+ {
+ return sortBy switch
+ {
+ ActivityLogSortBy.Name => e => e.ActivityLog.Name,
+ ActivityLogSortBy.Overiew => e => e.ActivityLog.Overview,
+ ActivityLogSortBy.ShortOverview => e => e.ActivityLog.ShortOverview,
+ ActivityLogSortBy.Type => e => e.ActivityLog.Type,
+ ActivityLogSortBy.DateCreated => e => e.ActivityLog.DateCreated,
+ ActivityLogSortBy.Username => e => e.Username,
+ ActivityLogSortBy.LogSeverity => e => e.ActivityLog.LogSeverity,
+ _ => throw new ArgumentOutOfRangeException(nameof(sortBy), sortBy, "Unhandled ActivityLogSortBy")
+ };
+ }
+
+ private class ExpandedActivityLog
+ {
+ public ActivityLog ActivityLog { get; set; } = null!;
+
+ public string? Username { get; set; }
+ }
}
diff --git a/MediaBrowser.Model/Activity/IActivityManager.cs b/MediaBrowser.Model/Activity/IActivityManager.cs
index 95aa567ada..96958e9a73 100644
--- a/MediaBrowser.Model/Activity/IActivityManager.cs
+++ b/MediaBrowser.Model/Activity/IActivityManager.cs
@@ -1,5 +1,3 @@
-#pragma warning disable CS1591
-
using System;
using System.Threading.Tasks;
using Jellyfin.Data.Events;
@@ -7,21 +5,36 @@ using Jellyfin.Data.Queries;
using Jellyfin.Database.Implementations.Entities;
using MediaBrowser.Model.Querying;
-namespace MediaBrowser.Model.Activity
+namespace MediaBrowser.Model.Activity;
+
+///
+/// Interface for the activity manager.
+///
+public interface IActivityManager
{
- public interface IActivityManager
- {
- event EventHandler> EntryCreated;
+ ///
+ /// The event that is triggered when an entity is created.
+ ///
+ event EventHandler> EntryCreated;
- Task CreateAsync(ActivityLog entry);
+ ///
+ /// Create a new activity log entry.
+ ///
+ /// The entry to create.
+ /// A representing the asynchronous operation.
+ Task CreateAsync(ActivityLog entry);
- Task> GetPagedResultAsync(ActivityLogQuery query);
+ ///
+ /// Get a paged list of activity log entries.
+ ///
+ /// The activity log query.
+ /// The page of entries.
+ Task> GetPagedResultAsync(ActivityLogQuery query);
- ///
- /// Remove all activity logs before the specified date.
- ///
- /// Activity log start date.
- /// A representing the asynchronous operation.
- Task CleanAsync(DateTime startDate);
- }
+ ///
+ /// Remove all activity logs before the specified date.
+ ///
+ /// Activity log start date.
+ /// A representing the asynchronous operation.
+ Task CleanAsync(DateTime startDate);
}