mirror of
https://github.com/jellyfin/jellyfin.git
synced 2026-06-18 21:50:25 +01:00
Split BaseItemRepository and IItemRepository
This commit is contained in:
94
MediaBrowser.Controller/Persistence/IItemQueryHelpers.cs
Normal file
94
MediaBrowser.Controller/Persistence/IItemQueryHelpers.cs
Normal file
@@ -0,0 +1,94 @@
|
||||
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>
|
||||
/// 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);
|
||||
}
|
||||
Reference in New Issue
Block a user