< Summary - Jellyfin

Information
Class: Jellyfin.Api.Controllers.GenresController
Assembly: Jellyfin.Api
File(s): /srv/git/jellyfin/Jellyfin.Api/Controllers/GenresController.cs
Line coverage
0%
Covered lines: 0
Uncovered lines: 72
Coverable lines: 72
Total lines: 210
Line coverage: 0%
Branch coverage
0%
Covered branches: 0
Total branches: 22
Branch coverage: 0%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%210%
GetGenres(...)0%156120%
GetGenre(...)0%4260%
GetItemFromSlugName(...)0%2040%

File(s)

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

#LineLine coverage
 1using System;
 2using System.ComponentModel.DataAnnotations;
 3using System.Linq;
 4using Jellyfin.Api.Extensions;
 5using Jellyfin.Api.Helpers;
 6using Jellyfin.Api.ModelBinders;
 7using Jellyfin.Data.Enums;
 8using Jellyfin.Database.Implementations.Entities;
 9using Jellyfin.Database.Implementations.Enums;
 10using Jellyfin.Extensions;
 11using MediaBrowser.Controller.Dto;
 12using MediaBrowser.Controller.Entities;
 13using MediaBrowser.Controller.Library;
 14using MediaBrowser.Model.Dto;
 15using MediaBrowser.Model.Entities;
 16using MediaBrowser.Model.Querying;
 17using Microsoft.AspNetCore.Authorization;
 18using Microsoft.AspNetCore.Http;
 19using Microsoft.AspNetCore.Mvc;
 20using Genre = MediaBrowser.Controller.Entities.Genre;
 21
 22namespace Jellyfin.Api.Controllers;
 23
 24/// <summary>
 25/// The genres controller.
 26/// </summary>
 27[Authorize]
 28public class GenresController : BaseJellyfinApiController
 29{
 30    private readonly IUserManager _userManager;
 31    private readonly ILibraryManager _libraryManager;
 32    private readonly IDtoService _dtoService;
 33
 34    /// <summary>
 35    /// Initializes a new instance of the <see cref="GenresController"/> class.
 36    /// </summary>
 37    /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
 38    /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
 39    /// <param name="dtoService">Instance of the <see cref="IDtoService"/> interface.</param>
 040    public GenresController(
 041        IUserManager userManager,
 042        ILibraryManager libraryManager,
 043        IDtoService dtoService)
 44    {
 045        _userManager = userManager;
 046        _libraryManager = libraryManager;
 047        _dtoService = dtoService;
 048    }
 49
 50    /// <summary>
 51    /// Gets all genres from a given item, folder, or the entire library.
 52    /// </summary>
 53    /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped fr
 54    /// <param name="limit">Optional. The maximum number of records to return.</param>
 55    /// <param name="searchTerm">The search term.</param>
 56    /// <param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</
 57    /// <param name="fields">Optional. Specify additional fields of information to return in the output.</param>
 58    /// <param name="excludeItemTypes">Optional. If specified, results will be filtered out based on item type. This all
 59    /// <param name="includeItemTypes">Optional. If specified, results will be filtered in based on item type. This allo
 60    /// <param name="isFavorite">Optional filter by items that are marked as favorite, or not.</param>
 61    /// <param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param>
 62    /// <param name="enableImageTypes">Optional. The image types to include in the output.</param>
 63    /// <param name="userId">User id.</param>
 64    /// <param name="nameStartsWithOrGreater">Optional filter by items whose name is sorted equally or greater than a gi
 65    /// <param name="nameStartsWith">Optional filter by items whose name is sorted equally than a given input string.</p
 66    /// <param name="nameLessThan">Optional filter by items whose name is equally or lesser than a given input string.</
 67    /// <param name="sortBy">Optional. Specify one or more sort orders, comma delimited.</param>
 68    /// <param name="sortOrder">Sort Order - Ascending,Descending.</param>
 69    /// <param name="enableImages">Optional, include image information in output.</param>
 70    /// <param name="enableTotalRecordCount">Optional. Include total record count.</param>
 71    /// <response code="200">Genres returned.</response>
 72    /// <returns>An <see cref="OkResult"/> containing the queryresult of genres.</returns>
 73    [HttpGet]
 74    [ProducesResponseType(StatusCodes.Status200OK)]
 75    public ActionResult<QueryResult<BaseItemDto>> GetGenres(
 76        [FromQuery] int? startIndex,
 77        [FromQuery] int? limit,
 78        [FromQuery] string? searchTerm,
 79        [FromQuery] Guid? parentId,
 80        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemFields[] fields,
 81        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] excludeItemTypes,
 82        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] includeItemTypes,
 83        [FromQuery] bool? isFavorite,
 84        [FromQuery] int? imageTypeLimit,
 85        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ImageType[] enableImageTypes,
 86        [FromQuery] Guid? userId,
 87        [FromQuery] string? nameStartsWithOrGreater,
 88        [FromQuery] string? nameStartsWith,
 89        [FromQuery] string? nameLessThan,
 90        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemSortBy[] sortBy,
 91        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] SortOrder[] sortOrder,
 92        [FromQuery] bool? enableImages = true,
 93        [FromQuery] bool enableTotalRecordCount = true)
 94    {
 095        userId = RequestHelpers.GetUserId(User, userId);
 096        var dtoOptions = new DtoOptions { Fields = fields }
 097            .AddClientFields(User)
 098            .AddAdditionalDtoOptions(enableImages, false, imageTypeLimit, enableImageTypes);
 99
 0100        User? user = userId.IsNullOrEmpty()
 0101            ? null
 0102            : _userManager.GetUserById(userId.Value);
 103
 0104        var parentItem = _libraryManager.GetParentItem(parentId, userId);
 105
 0106        var query = new InternalItemsQuery(user)
 0107        {
 0108            ExcludeItemTypes = excludeItemTypes,
 0109            IncludeItemTypes = includeItemTypes,
 0110            StartIndex = startIndex,
 0111            Limit = limit,
 0112            IsFavorite = isFavorite,
 0113            NameLessThan = nameLessThan,
 0114            NameStartsWith = nameStartsWith,
 0115            NameStartsWithOrGreater = nameStartsWithOrGreater,
 0116            DtoOptions = dtoOptions,
 0117            SearchTerm = searchTerm,
 0118            EnableTotalRecordCount = enableTotalRecordCount,
 0119            OrderBy = RequestHelpers.GetOrderBy(sortBy, sortOrder)
 0120        };
 121
 0122        if (parentId.HasValue)
 123        {
 0124            if (parentItem is Folder)
 125            {
 0126                query.AncestorIds = new[] { parentId.Value };
 127            }
 128            else
 129            {
 0130                query.ItemIds = new[] { parentId.Value };
 131            }
 132        }
 133
 134        QueryResult<(BaseItem, ItemCounts)> result;
 0135        if (parentItem is ICollectionFolder parentCollectionFolder
 0136            && (parentCollectionFolder.CollectionType == CollectionType.music
 0137                || parentCollectionFolder.CollectionType == CollectionType.musicvideos))
 138        {
 0139            result = _libraryManager.GetMusicGenres(query);
 140        }
 141        else
 142        {
 0143            result = _libraryManager.GetGenres(query);
 144        }
 145
 0146        var shouldIncludeItemTypes = includeItemTypes.Length != 0;
 0147        return RequestHelpers.CreateQueryResult(result, dtoOptions, _dtoService, shouldIncludeItemTypes, user);
 148    }
 149
 150    /// <summary>
 151    /// Gets a genre, by name.
 152    /// </summary>
 153    /// <param name="genreName">The genre name.</param>
 154    /// <param name="userId">The user id.</param>
 155    /// <response code="200">Genres returned.</response>
 156    /// <returns>An <see cref="OkResult"/> containing the genre.</returns>
 157    [HttpGet("{genreName}")]
 158    [ProducesResponseType(StatusCodes.Status200OK)]
 159    public ActionResult<BaseItemDto> GetGenre([FromRoute, Required] string genreName, [FromQuery] Guid? userId)
 160    {
 0161        userId = RequestHelpers.GetUserId(User, userId);
 0162        var dtoOptions = new DtoOptions()
 0163            .AddClientFields(User);
 164
 165        Genre? item;
 0166        if (genreName.Contains(BaseItem.SlugChar, StringComparison.OrdinalIgnoreCase))
 167        {
 0168            item = GetItemFromSlugName<Genre>(_libraryManager, genreName, dtoOptions, BaseItemKind.Genre);
 169        }
 170        else
 171        {
 0172            item = _libraryManager.GetGenre(genreName);
 173        }
 174
 0175        item ??= new Genre();
 176
 0177        var user = userId.IsNullOrEmpty()
 0178            ? null
 0179            : _userManager.GetUserById(userId.Value);
 180
 0181        return _dtoService.GetBaseItemDto(item, dtoOptions, user);
 182    }
 183
 184    private T? GetItemFromSlugName<T>(ILibraryManager libraryManager, string name, DtoOptions dtoOptions, BaseItemKind b
 185        where T : BaseItem, new()
 186    {
 0187        var result = libraryManager.GetItemList(new InternalItemsQuery
 0188        {
 0189            Name = name.Replace(BaseItem.SlugChar, '&'),
 0190            IncludeItemTypes = new[] { baseItemKind },
 0191            DtoOptions = dtoOptions
 0192        }).OfType<T>().FirstOrDefault();
 193
 0194        result ??= libraryManager.GetItemList(new InternalItemsQuery
 0195        {
 0196            Name = name.Replace(BaseItem.SlugChar, '/'),
 0197            IncludeItemTypes = new[] { baseItemKind },
 0198            DtoOptions = dtoOptions
 0199        }).OfType<T>().FirstOrDefault();
 200
 0201        result ??= libraryManager.GetItemList(new InternalItemsQuery
 0202        {
 0203            Name = name.Replace(BaseItem.SlugChar, '?'),
 0204            IncludeItemTypes = new[] { baseItemKind },
 0205            DtoOptions = dtoOptions
 0206        }).OfType<T>().FirstOrDefault();
 207
 0208        return result;
 209    }
 210}
Generated by: ReportGenerator 5.4.5.0
4/26/2025 - 12:10:58 AM
GitHub | reportgenerator.io

Methods/Properties

.ctor(MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Dto.IDtoService)
GetGenres(System.Nullable`1<System.Int32>,System.Nullable`1<System.Int32>,System.String,System.Nullable`1<System.Guid>,MediaBrowser.Model.Querying.ItemFields[],Jellyfin.Data.Enums.BaseItemKind[],Jellyfin.Data.Enums.BaseItemKind[],System.Nullable`1<System.Boolean>,System.Nullable`1<System.Int32>,MediaBrowser.Model.Entities.ImageType[],System.Nullable`1<System.Guid>,System.String,System.String,System.String,Jellyfin.Data.Enums.ItemSortBy[],Jellyfin.Database.Implementations.Enums.SortOrder[],System.Nullable`1<System.Boolean>,System.Boolean)
GetGenre(System.String,System.Nullable`1<System.Guid>)
GetItemFromSlugName(MediaBrowser.Controller.Library.ILibraryManager,System.String,MediaBrowser.Controller.Dto.DtoOptions,Jellyfin.Data.Enums.BaseItemKind)