< Summary - Jellyfin

Information
Class: Jellyfin.Api.Controllers.MusicGenresController
Assembly: Jellyfin.Api
File(s): /srv/git/jellyfin/Jellyfin.Api/Controllers/MusicGenresController.cs
Line coverage
100%
Covered lines: 27
Uncovered lines: 0
Coverable lines: 27
Total lines: 207
Line coverage: 100%
Branch coverage
100%
Covered branches: 4
Total branches: 4
Branch coverage: 100%
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: 86.8% (33/38) Branch coverage: 60% (6/10) Total lines: 2044/27/2026 - 12:15:04 AM Line coverage: 86.8% (33/38) Branch coverage: 60% (6/10) Total lines: 2054/30/2026 - 12:14:58 AM Line coverage: 100% (27/27) Branch coverage: 100% (4/4) Total lines: 207 1/23/2026 - 12:11:06 AM Line coverage: 86.8% (33/38) Branch coverage: 60% (6/10) Total lines: 2044/27/2026 - 12:15:04 AM Line coverage: 86.8% (33/38) Branch coverage: 60% (6/10) Total lines: 2054/30/2026 - 12:14:58 AM Line coverage: 100% (27/27) Branch coverage: 100% (4/4) Total lines: 207

Coverage delta

Coverage delta 40 -40

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%11100%
GetItemFromSlugName(...)100%44100%

File(s)

/srv/git/jellyfin/Jellyfin.Api/Controllers/MusicGenresController.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.Entities.Audio;
 14using MediaBrowser.Controller.Library;
 15using MediaBrowser.Model.Dto;
 16using MediaBrowser.Model.Entities;
 17using MediaBrowser.Model.Querying;
 18using Microsoft.AspNetCore.Authorization;
 19using Microsoft.AspNetCore.Http;
 20using Microsoft.AspNetCore.Mvc;
 21
 22namespace Jellyfin.Api.Controllers;
 23
 24/// <summary>
 25/// The music genres controller.
 26/// </summary>
 27[Authorize]
 28[Tags("MusicGenre")]
 29public class MusicGenresController : BaseJellyfinApiController
 30{
 31    private readonly ILibraryManager _libraryManager;
 32    private readonly IDtoService _dtoService;
 33    private readonly IUserManager _userManager;
 34
 35    /// <summary>
 36    /// Initializes a new instance of the <see cref="MusicGenresController"/> class.
 37    /// </summary>
 38    /// <param name="libraryManager">Instance of <see cref="ILibraryManager"/> interface.</param>
 39    /// <param name="userManager">Instance of <see cref="IUserManager"/> interface.</param>
 40    /// <param name="dtoService">Instance of <see cref="IDtoService"/> interface.</param>
 141    public MusicGenresController(
 142        ILibraryManager libraryManager,
 143        IUserManager userManager,
 144        IDtoService dtoService)
 45    {
 146        _libraryManager = libraryManager;
 147        _userManager = userManager;
 148        _dtoService = dtoService;
 149    }
 50
 51    /// <summary>
 52    /// Gets all music genres from a given item, folder, or the entire library.
 53    /// </summary>
 54    /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped fr
 55    /// <param name="limit">Optional. The maximum number of records to return.</param>
 56    /// <param name="searchTerm">The search term.</param>
 57    /// <param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</
 58    /// <param name="fields">Optional. Specify additional fields of information to return in the output.</param>
 59    /// <param name="excludeItemTypes">Optional. If specified, results will be filtered out based on item type. This all
 60    /// <param name="includeItemTypes">Optional. If specified, results will be filtered in based on item type. This allo
 61    /// <param name="isFavorite">Optional filter by items that are marked as favorite, or not.</param>
 62    /// <param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param>
 63    /// <param name="enableImageTypes">Optional. The image types to include in the output.</param>
 64    /// <param name="userId">User id.</param>
 65    /// <param name="nameStartsWithOrGreater">Optional filter by items whose name is sorted equally or greater than a gi
 66    /// <param name="nameStartsWith">Optional filter by items whose name is sorted equally than a given input string.</p
 67    /// <param name="nameLessThan">Optional filter by items whose name is equally or lesser than a given input string.</
 68    /// <param name="sortBy">Optional. Specify one or more sort orders, comma delimited.</param>
 69    /// <param name="sortOrder">Sort Order - Ascending,Descending.</param>
 70    /// <param name="enableImages">Optional, include image information in output.</param>
 71    /// <param name="enableTotalRecordCount">Optional. Include total record count.</param>
 72    /// <response code="200">Music genres returned.</response>
 73    /// <returns>An <see cref="OkResult"/> containing the queryresult of music genres.</returns>
 74    [HttpGet]
 75    [Obsolete("Use GetGenres instead")]
 76    [ApiExplorerSettings(IgnoreApi = true)]
 77    public ActionResult<QueryResult<BaseItemDto>> GetMusicGenres(
 78        [FromQuery] int? startIndex,
 79        [FromQuery] int? limit,
 80        [FromQuery] string? searchTerm,
 81        [FromQuery] Guid? parentId,
 82        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemFields[] fields,
 83        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] excludeItemTypes,
 84        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] includeItemTypes,
 85        [FromQuery] bool? isFavorite,
 86        [FromQuery] int? imageTypeLimit,
 87        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ImageType[] enableImageTypes,
 88        [FromQuery] Guid? userId,
 89        [FromQuery] string? nameStartsWithOrGreater,
 90        [FromQuery] string? nameStartsWith,
 91        [FromQuery] string? nameLessThan,
 92        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemSortBy[] sortBy,
 93        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] SortOrder[] sortOrder,
 94        [FromQuery] bool? enableImages = true,
 95        [FromQuery] bool enableTotalRecordCount = true)
 96    {
 97        userId = RequestHelpers.GetUserId(User, userId);
 98        var dtoOptions = new DtoOptions { Fields = fields }
 99            .AddAdditionalDtoOptions(enableImages, false, imageTypeLimit, enableImageTypes);
 100
 101        User? user = userId.IsNullOrEmpty()
 102            ? null
 103            : _userManager.GetUserById(userId.Value);
 104
 105        var parentItem = _libraryManager.GetParentItem(parentId, userId);
 106
 107        var query = new InternalItemsQuery(user)
 108        {
 109            ExcludeItemTypes = excludeItemTypes,
 110            IncludeItemTypes = includeItemTypes,
 111            StartIndex = startIndex,
 112            Limit = limit,
 113            IsFavorite = isFavorite,
 114            NameLessThan = nameLessThan,
 115            NameStartsWith = nameStartsWith,
 116            NameStartsWithOrGreater = nameStartsWithOrGreater,
 117            DtoOptions = dtoOptions,
 118            SearchTerm = searchTerm,
 119            EnableTotalRecordCount = enableTotalRecordCount,
 120            OrderBy = RequestHelpers.GetOrderBy(sortBy, sortOrder)
 121        };
 122
 123        if (parentId.HasValue)
 124        {
 125            if (parentItem is Folder)
 126            {
 127                query.AncestorIds = new[] { parentId.Value };
 128            }
 129            else
 130            {
 131                query.ItemIds = new[] { parentId.Value };
 132            }
 133        }
 134
 135        var result = _libraryManager.GetMusicGenres(query);
 136
 137        var shouldIncludeItemTypes = includeItemTypes.Length != 0;
 138        return RequestHelpers.CreateQueryResult(result, dtoOptions, _dtoService, shouldIncludeItemTypes, user);
 139    }
 140
 141    /// <summary>
 142    /// Gets a music genre, by name.
 143    /// </summary>
 144    /// <param name="genreName">The genre name.</param>
 145    /// <param name="userId">Optional. Filter by user id, and attach user data.</param>
 146    /// <returns>An <see cref="OkResult"/> containing a <see cref="BaseItemDto"/> with the music genre.</returns>
 147    [HttpGet("{genreName}")]
 148    [ProducesResponseType(StatusCodes.Status200OK)]
 149    [Obsolete("Use GetGenre instead")]
 150    public ActionResult<BaseItemDto> GetMusicGenre([FromRoute, Required] string genreName, [FromQuery] Guid? userId)
 151    {
 152        userId = RequestHelpers.GetUserId(User, userId);
 153        var dtoOptions = new DtoOptions();
 154
 155        MusicGenre? item;
 156
 157        if (genreName.Contains(BaseItem.SlugChar, StringComparison.OrdinalIgnoreCase))
 158        {
 159            item = GetItemFromSlugName<MusicGenre>(_libraryManager, genreName, dtoOptions, BaseItemKind.MusicGenre);
 160        }
 161        else
 162        {
 163            item = _libraryManager.GetMusicGenre(genreName);
 164        }
 165
 166        if (item is null)
 167        {
 168            return NotFound();
 169        }
 170
 171        if (!userId.IsNullOrEmpty())
 172        {
 173            var user = _userManager.GetUserById(userId.Value);
 174
 175            return _dtoService.GetBaseItemDto(item, dtoOptions, user);
 176        }
 177
 178        return _dtoService.GetBaseItemDto(item, dtoOptions);
 179    }
 180
 181    private T? GetItemFromSlugName<T>(ILibraryManager libraryManager, string name, DtoOptions dtoOptions, BaseItemKind b
 182        where T : BaseItem, new()
 183    {
 1184        var result = libraryManager.GetItemList(new InternalItemsQuery
 1185        {
 1186            Name = name.Replace(BaseItem.SlugChar, '&'),
 1187            IncludeItemTypes = new[] { baseItemKind },
 1188            DtoOptions = dtoOptions
 1189        }).OfType<T>().FirstOrDefault();
 190
 1191        result ??= libraryManager.GetItemList(new InternalItemsQuery
 1192        {
 1193            Name = name.Replace(BaseItem.SlugChar, '/'),
 1194            IncludeItemTypes = new[] { baseItemKind },
 1195            DtoOptions = dtoOptions
 1196        }).OfType<T>().FirstOrDefault();
 197
 1198        result ??= libraryManager.GetItemList(new InternalItemsQuery
 1199        {
 1200            Name = name.Replace(BaseItem.SlugChar, '?'),
 1201            IncludeItemTypes = new[] { baseItemKind },
 1202            DtoOptions = dtoOptions
 1203        }).OfType<T>().FirstOrDefault();
 204
 1205        return result;
 206    }
 207}
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,MediaBrowser.Controller.Dto.IDtoService)
GetItemFromSlugName(MediaBrowser.Controller.Library.ILibraryManager,System.String,MediaBrowser.Controller.Dto.DtoOptions,Jellyfin.Data.Enums.BaseItemKind)