< Summary - Jellyfin

Information
Class: Jellyfin.Api.Controllers.MusicGenresController
Assembly: Jellyfin.Api
File(s): /srv/git/jellyfin/Jellyfin.Api/Controllers/MusicGenresController.cs
Line coverage
86%
Covered lines: 33
Uncovered lines: 5
Coverable lines: 38
Total lines: 205
Line coverage: 86.8%
Branch coverage
60%
Covered branches: 6
Total branches: 10
Branch coverage: 60%
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%11100%
GetMusicGenre(...)33.33%9654.54%
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]
 28public class MusicGenresController : BaseJellyfinApiController
 29{
 30    private readonly ILibraryManager _libraryManager;
 31    private readonly IDtoService _dtoService;
 32    private readonly IUserManager _userManager;
 33
 34    /// <summary>
 35    /// Initializes a new instance of the <see cref="MusicGenresController"/> class.
 36    /// </summary>
 37    /// <param name="libraryManager">Instance of <see cref="ILibraryManager"/> interface.</param>
 38    /// <param name="userManager">Instance of <see cref="IUserManager"/> interface.</param>
 39    /// <param name="dtoService">Instance of <see cref="IDtoService"/> interface.</param>
 140    public MusicGenresController(
 141        ILibraryManager libraryManager,
 142        IUserManager userManager,
 143        IDtoService dtoService)
 44    {
 145        _libraryManager = libraryManager;
 146        _userManager = userManager;
 147        _dtoService = dtoService;
 148    }
 49
 50    /// <summary>
 51    /// Gets all music 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">Music genres returned.</response>
 72    /// <returns>An <see cref="OkResult"/> containing the queryresult of music genres.</returns>
 73    [HttpGet]
 74    [Obsolete("Use GetGenres instead")]
 75    public ActionResult<QueryResult<BaseItemDto>> GetMusicGenres(
 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    {
 95        userId = RequestHelpers.GetUserId(User, userId);
 96        var dtoOptions = new DtoOptions { Fields = fields }
 97            .AddClientFields(User)
 98            .AddAdditionalDtoOptions(enableImages, false, imageTypeLimit, enableImageTypes);
 99
 100        User? user = userId.IsNullOrEmpty()
 101            ? null
 102            : _userManager.GetUserById(userId.Value);
 103
 104        var parentItem = _libraryManager.GetParentItem(parentId, userId);
 105
 106        var query = new InternalItemsQuery(user)
 107        {
 108            ExcludeItemTypes = excludeItemTypes,
 109            IncludeItemTypes = includeItemTypes,
 110            StartIndex = startIndex,
 111            Limit = limit,
 112            IsFavorite = isFavorite,
 113            NameLessThan = nameLessThan,
 114            NameStartsWith = nameStartsWith,
 115            NameStartsWithOrGreater = nameStartsWithOrGreater,
 116            DtoOptions = dtoOptions,
 117            SearchTerm = searchTerm,
 118            EnableTotalRecordCount = enableTotalRecordCount,
 119            OrderBy = RequestHelpers.GetOrderBy(sortBy, sortOrder)
 120        };
 121
 122        if (parentId.HasValue)
 123        {
 124            if (parentItem is Folder)
 125            {
 126                query.AncestorIds = new[] { parentId.Value };
 127            }
 128            else
 129            {
 130                query.ItemIds = new[] { parentId.Value };
 131            }
 132        }
 133
 134        var result = _libraryManager.GetMusicGenres(query);
 135
 136        var shouldIncludeItemTypes = includeItemTypes.Length != 0;
 137        return RequestHelpers.CreateQueryResult(result, dtoOptions, _dtoService, shouldIncludeItemTypes, user);
 138    }
 139
 140    /// <summary>
 141    /// Gets a music genre, by name.
 142    /// </summary>
 143    /// <param name="genreName">The genre name.</param>
 144    /// <param name="userId">Optional. Filter by user id, and attach user data.</param>
 145    /// <returns>An <see cref="OkResult"/> containing a <see cref="BaseItemDto"/> with the music genre.</returns>
 146    [HttpGet("{genreName}")]
 147    [ProducesResponseType(StatusCodes.Status200OK)]
 148    public ActionResult<BaseItemDto> GetMusicGenre([FromRoute, Required] string genreName, [FromQuery] Guid? userId)
 149    {
 1150        userId = RequestHelpers.GetUserId(User, userId);
 1151        var dtoOptions = new DtoOptions().AddClientFields(User);
 152
 153        MusicGenre? item;
 154
 1155        if (genreName.Contains(BaseItem.SlugChar, StringComparison.OrdinalIgnoreCase))
 156        {
 1157            item = GetItemFromSlugName<MusicGenre>(_libraryManager, genreName, dtoOptions, BaseItemKind.MusicGenre);
 158        }
 159        else
 160        {
 0161            item = _libraryManager.GetMusicGenre(genreName);
 162        }
 163
 1164        if (item is null)
 165        {
 1166            return NotFound();
 167        }
 168
 0169        if (!userId.IsNullOrEmpty())
 170        {
 0171            var user = _userManager.GetUserById(userId.Value);
 172
 0173            return _dtoService.GetBaseItemDto(item, dtoOptions, user);
 174        }
 175
 0176        return _dtoService.GetBaseItemDto(item, dtoOptions);
 177    }
 178
 179    private T? GetItemFromSlugName<T>(ILibraryManager libraryManager, string name, DtoOptions dtoOptions, BaseItemKind b
 180        where T : BaseItem, new()
 181    {
 1182        var result = libraryManager.GetItemList(new InternalItemsQuery
 1183        {
 1184            Name = name.Replace(BaseItem.SlugChar, '&'),
 1185            IncludeItemTypes = new[] { baseItemKind },
 1186            DtoOptions = dtoOptions
 1187        }).OfType<T>().FirstOrDefault();
 188
 1189        result ??= libraryManager.GetItemList(new InternalItemsQuery
 1190        {
 1191            Name = name.Replace(BaseItem.SlugChar, '/'),
 1192            IncludeItemTypes = new[] { baseItemKind },
 1193            DtoOptions = dtoOptions
 1194        }).OfType<T>().FirstOrDefault();
 195
 1196        result ??= libraryManager.GetItemList(new InternalItemsQuery
 1197        {
 1198            Name = name.Replace(BaseItem.SlugChar, '?'),
 1199            IncludeItemTypes = new[] { baseItemKind },
 1200            DtoOptions = dtoOptions
 1201        }).OfType<T>().FirstOrDefault();
 202
 1203        return result;
 204    }
 205}
Generated by: ReportGenerator 5.4.5.0
4/3/2025 - 12:11:21 AM
GitHub | reportgenerator.io

Methods/Properties

.ctor(MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Dto.IDtoService)
GetMusicGenre(System.String,System.Nullable`1<System.Guid>)
GetItemFromSlugName(MediaBrowser.Controller.Library.ILibraryManager,System.String,MediaBrowser.Controller.Dto.DtoOptions,Jellyfin.Data.Enums.BaseItemKind)