#pragma warning disable RS0030 // Do not use banned APIs
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Linq;
using System.Linq.Expressions;
using System.Reflection;
using Jellyfin.Database.Implementations.Entities;
using Microsoft.EntityFrameworkCore;
namespace Jellyfin.Database.Implementations;
///
/// Contains a number of query related extensions.
///
public static class JellyfinQueryHelperExtensions
{
private static readonly MethodInfo _containsMethodGenericCache = typeof(Enumerable).GetMethods(BindingFlags.Public | BindingFlags.Static).First(m => m.Name == nameof(Enumerable.Contains) && m.GetParameters().Length == 2);
private static readonly MethodInfo _efParameterInstruction = typeof(EF).GetMethod(nameof(EF.Parameter), BindingFlags.Public | BindingFlags.Static)!;
private static readonly ConcurrentDictionary _containsQueryCache = new();
///
/// Builds an optimised query checking one property against a list of values while maintaining an optimal query.
///
/// The entity.
/// The property type to compare.
/// The source query.
/// The list of items to check.
/// Property expression.
/// A Query.
public static IQueryable WhereOneOrMany(this IQueryable query, IList oneOf, Expression> property)
{
return query.Where(OneOrManyExpressionBuilder(oneOf, property));
}
///
/// Builds a query that checks referenced ItemValues for a cross BaseItem lookup.
///
/// The source query.
/// The database context.
/// The type of item value to reference.
/// The list of BaseItem ids to check matches.
/// If set an exclusion check is performed instead.
/// A Query.
public static IQueryable WhereReferencedItem(
this IQueryable baseQuery,
JellyfinDbContext context,
ItemValueType itemValueType,
IList referenceIds,
bool invert = false)
{
return baseQuery.Where(ReferencedItemFilterExpressionBuilder(context, itemValueType, referenceIds, invert));
}
///
/// Builds a query that checks referenced ItemValues for a cross BaseItem lookup.
///
/// The source query.
/// The database context.
/// The type of item value to reference.
/// The list of BaseItem ids to check matches.
/// If set an exclusion check is performed instead.
/// A Query.
public static IQueryable WhereReferencedItemMultipleTypes(
this IQueryable baseQuery,
JellyfinDbContext context,
IList itemValueTypes,
IList referenceIds,
bool invert = false)
{
var itemFilter = OneOrManyExpressionBuilder(referenceIds, f => f.Id);
var typeFilter = OneOrManyExpressionBuilder(itemValueTypes, m => m.ItemValue.Type);
// Flat sub-selects + Contains instead of a nested correlated .Any(...Any(...)).
var referencedCleanValues = context.BaseItems
.Where(itemFilter)
.Select(e => e.CleanName);
var matchingItemIds = context.ItemValuesMap
.Where(typeFilter)
.Where(m => referencedCleanValues.Contains(m.ItemValue.CleanValue))
.Select(m => m.ItemId);
if (invert)
{
return baseQuery.Where(e => !matchingItemIds.Contains(e.Id));
}
return baseQuery.Where(e => matchingItemIds.Contains(e.Id));
}
///
/// Builds a query expression that checks referenced ItemValues for a cross BaseItem lookup.
///
/// The database context.
/// The type of item value to reference.
/// The list of BaseItem ids to check matches.
/// If set an exclusion check is performed instead.
/// A Query.
public static Expression> ReferencedItemFilterExpressionBuilder(
this JellyfinDbContext context,
ItemValueType itemValueType,
IList referenceIds,
bool invert = false)
{
// Well genre/artist/album etc items do not actually set the ItemValue of thier specitic types so we cannot match it that way.
/*
"(guid in (select itemid from ItemValues where CleanValue = (select CleanName from TypedBaseItems where guid=@GenreIds and Type=2)))"
*/
var itemFilter = OneOrManyExpressionBuilder(referenceIds, f => f.Id);
// Flat sub-selects + Contains instead of a nested correlated .Any(...Any(...)).
var referencedCleanValues = context.BaseItems
.Where(itemFilter)
.Select(e => e.CleanName);
var matchingItemIds = context.ItemValuesMap
.Where(m => m.ItemValue.Type == itemValueType && referencedCleanValues.Contains(m.ItemValue.CleanValue))
.Select(m => m.ItemId);
if (invert)
{
return item => !matchingItemIds.Contains(item.Id);
}
return item => matchingItemIds.Contains(item.Id);
}
///
/// Filters items that match any of the specified (provider name, value) pairs.
///
/// The source query.
/// Dictionary mapping provider names to arrays of values to match.
/// A filtered query.
public static IQueryable WhereHasAnyProviderIds(
this IQueryable baseQuery,
IReadOnlyDictionary providerIds)
{
var providerKeys = providerIds
.SelectMany(kvp => kvp.Value.Select(v => $"{kvp.Key}:{v}"))
.ToList();
if (providerKeys.Count == 0)
{
return baseQuery;
}
return baseQuery.Where(e => e.Provider!.Any(p => providerKeys.Contains(p.ProviderId + ":" + p.ProviderValue)));
}
///
/// Filters items that have any of the specified providers. Empty/null values match any value for that provider.
///
/// The source query.
/// Dictionary mapping provider names to optional values.
/// A filtered query.
public static IQueryable WhereHasAnyProviderId(
this IQueryable baseQuery,
IReadOnlyDictionary providerIds)
{
var existenceOnly = providerIds
.Where(e => string.IsNullOrEmpty(e.Value))
.Select(e => e.Key)
.ToList();
var specificValues = providerIds
.Where(e => !string.IsNullOrEmpty(e.Value))
.Select(e => $"{e.Key}:{e.Value}")
.ToList();
if (existenceOnly.Count == 0 && specificValues.Count == 0)
{
return baseQuery;
}
if (existenceOnly.Count == 0)
{
return baseQuery.Where(e => e.Provider!.Any(p =>
specificValues.Contains(p.ProviderId + ":" + p.ProviderValue)));
}
if (specificValues.Count == 0)
{
return baseQuery.Where(e => e.Provider!.Any(p => existenceOnly.Contains(p.ProviderId)));
}
// Single EXISTS over Provider with both predicates OR'd, instead of two separate subqueries.
return baseQuery.Where(e => e.Provider!.Any(p =>
existenceOnly.Contains(p.ProviderId) ||
specificValues.Contains(p.ProviderId + ":" + p.ProviderValue)));
}
///
/// Excludes items that match any of the specified (provider name, value) pairs.
///
/// The source query.
/// Dictionary mapping provider names to values to exclude.
/// A filtered query.
public static IQueryable WhereExcludeProviderIds(
this IQueryable baseQuery,
IReadOnlyDictionary providerIds)
{
var excludeKeys = providerIds
.Select(e => $"{e.Key}:{e.Value}")
.ToList();
if (excludeKeys.Count == 0)
{
return baseQuery;
}
return baseQuery.Where(e => e.Provider!.All(p => !excludeKeys.Contains(p.ProviderId + ":" + p.ProviderValue)));
}
///
/// Builds an optimised query expression checking one property against a list of values while maintaining an optimal query.
///
/// The entity.
/// The property type to compare.
/// The list of items to check.
/// Property expression.
/// A Query.
public static Expression> OneOrManyExpressionBuilder(this IList oneOf, Expression> property)
{
var parameter = Expression.Parameter(typeof(TEntity), "item");
property = ParameterReplacer.Replace, Func>(property, property.Parameters[0], parameter);
if (oneOf.Count == 1)
{
var value = oneOf[0];
if (typeof(TProperty).IsValueType)
{
return Expression.Lambda>(Expression.Equal(property.Body, Expression.Constant(value)), parameter);
}
else
{
return Expression.Lambda>(Expression.ReferenceEqual(property.Body, Expression.Constant(value)), parameter);
}
}
var containsMethodInfo = _containsQueryCache.GetOrAdd(typeof(TProperty), static (key) => _containsMethodGenericCache.MakeGenericMethod(key));
// Always wrap the collection in EF.Parameter so EF Core caches a single compiled plan and reuses it across calls.
return Expression.Lambda>(
Expression.Call(
null,
containsMethodInfo,
Expression.Call(null, _efParameterInstruction.MakeGenericMethod(oneOf.GetType()), Expression.Constant(oneOf)),
property.Body),
parameter);
}
internal static class ParameterReplacer
{
// Produces an expression identical to 'expression'
// except with 'source' parameter replaced with 'target' expression.
internal static Expression Replace(
Expression expression,
ParameterExpression source,
ParameterExpression target)
{
return new ParameterReplacerVisitor(source, target)
.VisitAndConvert(expression);
}
private sealed class ParameterReplacerVisitor : ExpressionVisitor
{
private readonly ParameterExpression _source;
private readonly ParameterExpression _target;
public ParameterReplacerVisitor(ParameterExpression source, ParameterExpression target)
{
_source = source;
_target = target;
}
internal Expression VisitAndConvert(Expression root)
{
return (Expression)VisitLambda(root);
}
protected override Expression VisitLambda(Expression node)
{
// Leave all parameters alone except the one we want to replace.
var parameters = node.Parameters.Select(p => p == _source ? _target : p);
return Expression.Lambda(Visit(node.Body), parameters);
}
protected override Expression VisitParameter(ParameterExpression node)
{
// Replace the source with the target, visit other params as usual.
return node == _source ? _target : base.VisitParameter(node);
}
}
}
}