< Summary - Jellyfin

Information
Class: Jellyfin.Api.Controllers.FilterController
Assembly: Jellyfin.Api
File(s): /srv/git/jellyfin/Jellyfin.Api/Controllers/FilterController.cs
Line coverage
0%
Covered lines: 0
Uncovered lines: 77
Coverable lines: 77
Total lines: 188
Line coverage: 0%
Branch coverage
0%
Covered branches: 0
Total branches: 40
Branch coverage: 0%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100 1/23/2026 - 12:11:06 AM Line coverage: 0% (0/107) Branch coverage: 0% (0/48) Total lines: 2185/4/2026 - 12:15:16 AM Line coverage: 0% (0/77) Branch coverage: 0% (0/40) Total lines: 188 1/23/2026 - 12:11:06 AM Line coverage: 0% (0/107) Branch coverage: 0% (0/48) Total lines: 2185/4/2026 - 12:15:16 AM Line coverage: 0% (0/77) Branch coverage: 0% (0/40) Total lines: 188

Coverage delta

Coverage delta 1 -1

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%210%
GetQueryFiltersLegacy(...)0%156120%
GetQueryFilters(...)0%812280%

File(s)

/srv/git/jellyfin/Jellyfin.Api/Controllers/FilterController.cs

#LineLine coverage
 1using System;
 2using System.Linq;
 3using Jellyfin.Api.Helpers;
 4using Jellyfin.Api.ModelBinders;
 5using Jellyfin.Data.Enums;
 6using Jellyfin.Extensions;
 7using MediaBrowser.Controller.Dto;
 8using MediaBrowser.Controller.Entities;
 9using MediaBrowser.Controller.Library;
 10using MediaBrowser.Model.Dto;
 11using MediaBrowser.Model.Querying;
 12using Microsoft.AspNetCore.Authorization;
 13using Microsoft.AspNetCore.Http;
 14using Microsoft.AspNetCore.Mvc;
 15
 16namespace Jellyfin.Api.Controllers;
 17
 18/// <summary>
 19/// Filters controller.
 20/// </summary>
 21[Route("")]
 22[Authorize]
 23public class FilterController : BaseJellyfinApiController
 24{
 25    private readonly ILibraryManager _libraryManager;
 26    private readonly IUserManager _userManager;
 27
 28    /// <summary>
 29    /// Initializes a new instance of the <see cref="FilterController"/> class.
 30    /// </summary>
 31    /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
 32    /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
 033    public FilterController(ILibraryManager libraryManager, IUserManager userManager)
 34    {
 035        _libraryManager = libraryManager;
 036        _userManager = userManager;
 037    }
 38
 39    /// <summary>
 40    /// Gets legacy query filters.
 41    /// </summary>
 42    /// <param name="userId">Optional. User id.</param>
 43    /// <param name="parentId">Optional. Parent id.</param>
 44    /// <param name="includeItemTypes">Optional. If specified, results will be filtered based on item type. This allows 
 45    /// <param name="mediaTypes">Optional. Filter by MediaType. Allows multiple, comma delimited.</param>
 46    /// <response code="200">Legacy filters retrieved.</response>
 47    /// <returns>Legacy query filters.</returns>
 48    [HttpGet("Items/Filters")]
 49    [ProducesResponseType(StatusCodes.Status200OK)]
 50    public ActionResult<QueryFiltersLegacy> GetQueryFiltersLegacy(
 51        [FromQuery] Guid? userId,
 52        [FromQuery] Guid? parentId,
 53        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] includeItemTypes,
 54        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] MediaType[] mediaTypes)
 55    {
 056        userId = RequestHelpers.GetUserId(User, userId);
 057        var user = userId.IsNullOrEmpty()
 058            ? null
 059            : _userManager.GetUserById(userId.Value);
 60
 061        BaseItem? item = null;
 062        if (includeItemTypes.Length != 1
 063            || !(includeItemTypes[0] == BaseItemKind.Trailer
 064                 || includeItemTypes[0] == BaseItemKind.Program))
 65        {
 066            item = _libraryManager.GetParentItem(parentId, user?.Id);
 67        }
 68
 069        if (item is not Folder folder)
 70        {
 071            return new QueryFiltersLegacy();
 72        }
 73
 074        var query = new InternalItemsQuery(user)
 075        {
 076            MediaTypes = mediaTypes,
 077            IncludeItemTypes = includeItemTypes,
 078            Recursive = true,
 079            EnableTotalRecordCount = false,
 080            AncestorIds = [folder.Id],
 081            DtoOptions = new DtoOptions
 082            {
 083                Fields = [],
 084                EnableImages = false,
 085                EnableUserData = false
 086            }
 087        };
 88
 089        return _libraryManager.GetQueryFiltersLegacy(query);
 90    }
 91
 92    /// <summary>
 93    /// Gets query filters.
 94    /// </summary>
 95    /// <param name="userId">Optional. User id.</param>
 96    /// <param name="parentId">Optional. Specify this to localize the search to a specific item or folder. Omit to use t
 97    /// <param name="includeItemTypes">Optional. If specified, results will be filtered based on item type. This allows 
 98    /// <param name="isAiring">Optional. Is item airing.</param>
 99    /// <param name="isMovie">Optional. Is item movie.</param>
 100    /// <param name="isSports">Optional. Is item sports.</param>
 101    /// <param name="isKids">Optional. Is item kids.</param>
 102    /// <param name="isNews">Optional. Is item news.</param>
 103    /// <param name="isSeries">Optional. Is item series.</param>
 104    /// <param name="recursive">Optional. Search recursive.</param>
 105    /// <response code="200">Filters retrieved.</response>
 106    /// <returns>Query filters.</returns>
 107    [HttpGet("Items/Filters2")]
 108    [ProducesResponseType(StatusCodes.Status200OK)]
 109    public ActionResult<QueryFilters> GetQueryFilters(
 110        [FromQuery] Guid? userId,
 111        [FromQuery] Guid? parentId,
 112        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] includeItemTypes,
 113        [FromQuery] bool? isAiring,
 114        [FromQuery] bool? isMovie,
 115        [FromQuery] bool? isSports,
 116        [FromQuery] bool? isKids,
 117        [FromQuery] bool? isNews,
 118        [FromQuery] bool? isSeries,
 119        [FromQuery] bool? recursive)
 120    {
 0121        userId = RequestHelpers.GetUserId(User, userId);
 0122        var user = userId.IsNullOrEmpty()
 0123            ? null
 0124            : _userManager.GetUserById(userId.Value);
 125
 0126        BaseItem? parentItem = null;
 0127        if (includeItemTypes.Length == 1
 0128            && (includeItemTypes[0] == BaseItemKind.Trailer
 0129                || includeItemTypes[0] == BaseItemKind.Program))
 130        {
 0131            parentItem = null;
 132        }
 0133        else if (parentId.HasValue)
 134        {
 0135            parentItem = _libraryManager.GetItemById<BaseItem>(parentId.Value);
 136        }
 137
 0138        var filters = new QueryFilters();
 0139        var genreQuery = new InternalItemsQuery(user)
 0140        {
 0141            IncludeItemTypes = includeItemTypes,
 0142            DtoOptions = new DtoOptions
 0143            {
 0144                Fields = Array.Empty<ItemFields>(),
 0145                EnableImages = false,
 0146                EnableUserData = false
 0147            },
 0148            IsAiring = isAiring,
 0149            IsMovie = isMovie,
 0150            IsSports = isSports,
 0151            IsKids = isKids,
 0152            IsNews = isNews,
 0153            IsSeries = isSeries
 0154        };
 155
 0156        if ((recursive ?? true) || parentItem is UserView || parentItem is ICollectionFolder)
 157        {
 0158            genreQuery.AncestorIds = parentItem is null ? Array.Empty<Guid>() : new[] { parentItem.Id };
 159        }
 160        else
 161        {
 0162            genreQuery.Parent = parentItem;
 163        }
 164
 0165        if (includeItemTypes.Length == 1
 0166            && (includeItemTypes[0] == BaseItemKind.MusicAlbum
 0167                || includeItemTypes[0] == BaseItemKind.MusicVideo
 0168                || includeItemTypes[0] == BaseItemKind.MusicArtist
 0169                || includeItemTypes[0] == BaseItemKind.Audio))
 170        {
 0171            filters.Genres = _libraryManager.GetMusicGenres(genreQuery).Items.Select(i => new NameGuidPair
 0172            {
 0173                Name = i.Item.Name,
 0174                Id = i.Item.Id
 0175            }).ToArray();
 176        }
 177        else
 178        {
 0179            filters.Genres = _libraryManager.GetGenres(genreQuery).Items.Select(i => new NameGuidPair
 0180            {
 0181                Name = i.Item.Name,
 0182                Id = i.Item.Id
 0183            }).ToArray();
 184        }
 185
 0186        return filters;
 187    }
 188}
Generated by: ReportGenerator 5.5.7.0
5/6/2026 - 12:15:24 AM
GitHub | reportgenerator.io

Methods/Properties

.ctor(MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Library.IUserManager)
GetQueryFiltersLegacy(System.Nullable`1<System.Guid>,System.Nullable`1<System.Guid>,Jellyfin.Data.Enums.BaseItemKind[],Jellyfin.Data.Enums.MediaType[])
GetQueryFilters(System.Nullable`1<System.Guid>,System.Nullable`1<System.Guid>,Jellyfin.Data.Enums.BaseItemKind[],System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>)