| | | 1 | | #pragma warning disable RS0030 // Do not use banned APIs |
| | | 2 | | #pragma warning disable CA1304 // Specify CultureInfo |
| | | 3 | | #pragma warning disable CA1311 // Specify a culture or use an invariant version |
| | | 4 | | #pragma warning disable CA1862 // Use the 'StringComparison' method overloads to perform case-insensitive string compari |
| | | 5 | | |
| | | 6 | | using System; |
| | | 7 | | using System.Linq; |
| | | 8 | | using System.Linq.Expressions; |
| | | 9 | | using Jellyfin.Data.Enums; |
| | | 10 | | using Jellyfin.Database.Implementations; |
| | | 11 | | using Jellyfin.Database.Implementations.Entities; |
| | | 12 | | using Jellyfin.Extensions; |
| | | 13 | | using MediaBrowser.Controller.Entities; |
| | | 14 | | using Microsoft.EntityFrameworkCore; |
| | | 15 | | |
| | | 16 | | namespace Jellyfin.Server.Implementations.Item; |
| | | 17 | | |
| | | 18 | | /// <summary> |
| | | 19 | | /// Static class for methods which maps types of ordering to their respecting ordering functions. |
| | | 20 | | /// </summary> |
| | | 21 | | public static class OrderMapper |
| | | 22 | | { |
| | | 23 | | /// <summary> |
| | | 24 | | /// Creates Func to be executed later with a given BaseItemEntity input for sorting items on query. |
| | | 25 | | /// </summary> |
| | | 26 | | /// <param name="sortBy">Item property to sort by.</param> |
| | | 27 | | /// <param name="query">Context Query.</param> |
| | | 28 | | /// <param name="jellyfinDbContext">Context.</param> |
| | | 29 | | /// <returns>Func to be executed later for sorting query.</returns> |
| | | 30 | | public static Expression<Func<BaseItemEntity, object?>> MapOrderByField(ItemSortBy sortBy, InternalItemsQuery query, |
| | | 31 | | { |
| | 167 | 32 | | if (sortBy == ItemSortBy.DatePlayed) |
| | | 33 | | { |
| | | 34 | | // An item's played date is the newest of its own progress and that of its alternate versions, |
| | | 35 | | // which track progress under their own ids. Matching both in one predicate ORs them together, |
| | | 36 | | // which no index can serve: the user's whole UserData table gets scanned per sorted row. |
| | | 37 | | // Two indexed lookups combined by MAX cost a seek each instead. |
| | 1 | 38 | | var userData = query.User is null |
| | 1 | 39 | | ? jellyfinDbContext.UserData |
| | 1 | 40 | | : jellyfinDbContext.UserData.Where(w => w.UserId == query.User.Id); |
| | | 41 | | |
| | 1 | 42 | | return e => userData |
| | 1 | 43 | | .Where(w => w.ItemId == e.Id) |
| | 1 | 44 | | .Select(w => w.LastPlayedDate) |
| | 1 | 45 | | .Concat(userData |
| | 1 | 46 | | .Where(w => w.Item!.PrimaryVersionId == e.Id) |
| | 1 | 47 | | .Select(w => w.LastPlayedDate)) |
| | 1 | 48 | | .Max(); |
| | | 49 | | } |
| | | 50 | | |
| | 166 | 51 | | return (sortBy, query.User) switch |
| | 166 | 52 | | { |
| | 0 | 53 | | (ItemSortBy.AirTime, _) => e => e.SortName, |
| | 0 | 54 | | (ItemSortBy.Runtime, _) => e => e.RunTimeTicks, |
| | 71 | 55 | | (ItemSortBy.Random, _) => e => EF.Functions.Random(), |
| | 0 | 56 | | (ItemSortBy.PlayCount, _) => e => e.UserData!.Where(f => f.UserId.Equals(query.User!.Id)).OrderBy(f => f.Cus |
| | 0 | 57 | | (ItemSortBy.IsFavoriteOrLiked, _) => e => e.UserData!.Where(f => f.UserId.Equals(query.User!.Id)).OrderBy(f |
| | 44 | 58 | | (ItemSortBy.IsFolder, _) => e => e.IsFolder, |
| | 0 | 59 | | (ItemSortBy.IsPlayed, _) => e => e.UserData!.Where(f => f.UserId.Equals(query.User!.Id)).OrderBy(f => f.Cust |
| | 0 | 60 | | (ItemSortBy.IsUnplayed, _) => e => !e.UserData!.Where(f => f.UserId.Equals(query.User!.Id)).OrderBy(f => f.C |
| | 0 | 61 | | (ItemSortBy.DateLastContentAdded, _) => e => e.DateLastMediaAdded, |
| | 0 | 62 | | (ItemSortBy.Artist, _) => e => e.ItemValues!.Where(f => f.ItemValue.Type == ItemValueType.Artist).OrderBy(f |
| | 0 | 63 | | (ItemSortBy.AlbumArtist, _) => e => e.ItemValues!.Where(f => f.ItemValue.Type == ItemValueType.AlbumArtist). |
| | 0 | 64 | | (ItemSortBy.Studio, _) => e => e.ItemValues!.Where(f => f.ItemValue.Type == ItemValueType.Studios).OrderBy(f |
| | 0 | 65 | | (ItemSortBy.OfficialRating, _) => e => e.InheritedParentalRatingValue, |
| | 0 | 66 | | (ItemSortBy.SeriesSortName, _) => e => e.SeriesName, |
| | 0 | 67 | | (ItemSortBy.Album, _) => e => e.Album, |
| | 0 | 68 | | (ItemSortBy.DateCreated, _) => e => e.DateCreated, |
| | 1 | 69 | | (ItemSortBy.PremiereDate, _) => e => e.PremiereDate ?? (e.ProductionYear.HasValue ? DateTime.MinValue.AddYea |
| | 0 | 70 | | (ItemSortBy.StartDate, _) => e => e.StartDate, |
| | 0 | 71 | | (ItemSortBy.Name, _) => e => e.CleanName, |
| | 0 | 72 | | (ItemSortBy.CommunityRating, _) => e => e.CommunityRating, |
| | 0 | 73 | | (ItemSortBy.ProductionYear, _) => e => e.ProductionYear, |
| | 0 | 74 | | (ItemSortBy.CriticRating, _) => e => e.CriticRating, |
| | 0 | 75 | | (ItemSortBy.VideoBitRate, _) => e => e.TotalBitrate, |
| | 0 | 76 | | (ItemSortBy.ParentIndexNumber, _) => e => e.ParentIndexNumber, |
| | 0 | 77 | | (ItemSortBy.IndexNumber, _) => e => e.IndexNumber, |
| | 166 | 78 | | // SeriesDatePlayed is normally handled via pre-aggregated join in ApplySeriesDatePlayedOrder. |
| | 166 | 79 | | // This correlated subquery fallback is only reached when combined with search. |
| | 0 | 80 | | (ItemSortBy.SeriesDatePlayed, not null) => e => |
| | 0 | 81 | | jellyfinDbContext.UserData |
| | 0 | 82 | | .Where(w => w.UserId == query.User.Id && w.Played && w.Item!.SeriesPresentationUniqueKey == e.Presen |
| | 0 | 83 | | .Max(f => f.LastPlayedDate), |
| | 0 | 84 | | (ItemSortBy.SeriesDatePlayed, null) => e => |
| | 0 | 85 | | jellyfinDbContext.UserData |
| | 0 | 86 | | .Where(w => w.Played && w.Item!.SeriesPresentationUniqueKey == e.PresentationUniqueKey) |
| | 0 | 87 | | .Max(f => f.LastPlayedDate), |
| | 50 | 88 | | _ => e => e.SortName |
| | 166 | 89 | | }; |
| | | 90 | | } |
| | | 91 | | |
| | | 92 | | /// <summary> |
| | | 93 | | /// Creates an expression to order search results by match quality. |
| | | 94 | | /// Prioritizes: exact match (0) > prefix match with word boundary (1) > prefix match (2) > contains (3). |
| | | 95 | | /// Considers both CleanName and OriginalTitle for matching. |
| | | 96 | | /// </summary> |
| | | 97 | | /// <param name="searchTerm">The search term to match against.</param> |
| | | 98 | | /// <returns>An expression that returns an integer representing match quality (lower is better).</returns> |
| | | 99 | | public static Expression<Func<BaseItemEntity, int>> MapSearchRelevanceOrder(string searchTerm) |
| | | 100 | | { |
| | 0 | 101 | | var cleanSearchTerm = GetCleanValue(searchTerm); |
| | 0 | 102 | | var searchPrefix = cleanSearchTerm + " "; |
| | 0 | 103 | | var originalSearchLower = searchTerm.ToLowerInvariant(); |
| | 0 | 104 | | var originalSearchPrefix = originalSearchLower + " "; |
| | 0 | 105 | | return e => |
| | 0 | 106 | | // Exact match on CleanName or OriginalTitle |
| | 0 | 107 | | (e.CleanName == cleanSearchTerm || (e.OriginalTitle != null && e.OriginalTitle.ToLower() == originalSearchLo |
| | 0 | 108 | | // Prefix match with word boundary |
| | 0 | 109 | | (e.CleanName!.StartsWith(searchPrefix) || (e.OriginalTitle != null && e.OriginalTitle.ToLower().StartsWith(o |
| | 0 | 110 | | // Prefix match |
| | 0 | 111 | | (e.CleanName!.StartsWith(cleanSearchTerm) || (e.OriginalTitle != null && e.OriginalTitle.ToLower().StartsWit |
| | | 112 | | } |
| | | 113 | | |
| | | 114 | | private static string GetCleanValue(string value) |
| | | 115 | | { |
| | 0 | 116 | | if (string.IsNullOrWhiteSpace(value)) |
| | | 117 | | { |
| | 0 | 118 | | return value; |
| | | 119 | | } |
| | | 120 | | |
| | 0 | 121 | | return value.RemoveDiacritics().ToLowerInvariant(); |
| | | 122 | | } |
| | | 123 | | } |