1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
using System;
using System.Linq;
using Jellyfin.Database.Implementations;
using Jellyfin.Database.Implementations.Entities;
using MediaBrowser.Controller.Entities;
namespace MediaBrowser.Controller.Persistence;
/// <summary>
/// Provides shared query-building methods used by extracted item services.
/// Implemented by <c>BaseItemRepository</c>.
/// </summary>
public interface IItemQueryHelpers
{
/// <summary>
/// Translates an <see cref="InternalItemsQuery"/> into EF Core filter expressions.
/// </summary>
/// <param name="baseQuery">The base queryable to filter.</param>
/// <param name="context">The database context.</param>
/// <param name="filter">The query filter.</param>
/// <returns>The filtered queryable.</returns>
IQueryable<BaseItemEntity> TranslateQuery(
IQueryable<BaseItemEntity> baseQuery,
JellyfinDbContext context,
InternalItemsQuery filter);
/// <summary>
/// Prepares a base query for items from the context.
/// </summary>
/// <param name="context">The database context.</param>
/// <param name="filter">The query filter.</param>
/// <returns>The prepared queryable.</returns>
IQueryable<BaseItemEntity> PrepareItemQuery(JellyfinDbContext context, InternalItemsQuery filter);
/// <summary>
/// Applies user access filtering (library access, parental controls, tags) to a query.
/// </summary>
/// <param name="context">The database context.</param>
/// <param name="baseQuery">The base queryable to filter.</param>
/// <param name="filter">The query filter containing access settings.</param>
/// <returns>The access-filtered queryable.</returns>
IQueryable<BaseItemEntity> ApplyAccessFiltering(
JellyfinDbContext context,
IQueryable<BaseItemEntity> baseQuery,
InternalItemsQuery filter);
/// <summary>
/// Applies navigation property includes to a query based on filter options.
/// </summary>
/// <param name="dbQuery">The queryable to apply navigations to.</param>
/// <param name="filter">The query filter.</param>
/// <returns>The queryable with navigation includes.</returns>
IQueryable<BaseItemEntity> ApplyNavigations(
IQueryable<BaseItemEntity> dbQuery,
InternalItemsQuery filter);
/// <summary>
/// Applies ordering to a query based on filter options.
/// </summary>
/// <param name="query">The queryable to order.</param>
/// <param name="filter">The query filter.</param>
/// <param name="context">The database context.</param>
/// <returns>The ordered queryable.</returns>
IQueryable<BaseItemEntity> ApplyOrder(
IQueryable<BaseItemEntity> query,
InternalItemsQuery filter,
JellyfinDbContext context);
/// <summary>
/// Builds a query for descendants of an ancestor with user access filtering applied.
/// </summary>
/// <param name="context">The database context.</param>
/// <param name="filter">The query filter.</param>
/// <param name="ancestorId">The ancestor item ID.</param>
/// <returns>The filtered descendant queryable.</returns>
IQueryable<BaseItemEntity> BuildAccessFilteredDescendantsQuery(
JellyfinDbContext context,
InternalItemsQuery filter,
Guid ancestorId);
/// <summary>
/// Builds an <see cref="IQueryable{Guid}"/> of folder IDs whose descendants are all played
/// for the given user. Composable into outer queries to avoid an extra DB roundtrip.
/// </summary>
/// <param name="context">The database context the resulting query is bound to.</param>
/// <param name="folderIds">A query yielding candidate folder IDs.</param>
/// <param name="user">The user for access filtering and played status.</param>
/// <returns>An <see cref="IQueryable{Guid}"/> of fully-played folder IDs.</returns>
IQueryable<Guid> GetFullyPlayedFolderIdsQuery(
JellyfinDbContext context,
IQueryable<Guid> folderIds,
User user);
/// <summary>
/// Deserializes a <see cref="BaseItemEntity"/> into a <see cref="BaseItem"/>.
/// </summary>
/// <param name="entity">The database entity.</param>
/// <param name="skipDeserialization">Whether to skip JSON deserialization.</param>
/// <returns>The deserialized item, or null.</returns>
BaseItem? DeserializeBaseItem(BaseItemEntity entity, bool skipDeserialization = false);
/// <summary>
/// Prepares a filter query by adjusting limits and virtual item settings.
/// </summary>
/// <param name="query">The query to prepare.</param>
void PrepareFilterQuery(InternalItemsQuery query);
}
|
