< Summary - Jellyfin

Information
Class: Jellyfin.Api.Controllers.YearsController
Assembly: Jellyfin.Api
File(s): /srv/git/jellyfin/Jellyfin.Api/Controllers/YearsController.cs
Line coverage
0%
Covered lines: 0
Uncovered lines: 68
Coverable lines: 68
Total lines: 228
Line coverage: 0%
Branch coverage
0%
Covered branches: 0
Total branches: 34
Branch coverage: 0%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

0255075100

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%210%
GetYears(...)0%342180%
GetYear(...)0%2040%
FilterItem(...)0%156120%
GetAllItems(...)100%210%

File(s)

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

#LineLine coverage
 1using System;
 2using System.Collections.Generic;
 3using System.Collections.Immutable;
 4using System.ComponentModel.DataAnnotations;
 5using System.Linq;
 6using Jellyfin.Api.Extensions;
 7using Jellyfin.Api.Helpers;
 8using Jellyfin.Api.ModelBinders;
 9using Jellyfin.Data.Enums;
 10using Jellyfin.Database.Implementations.Entities;
 11using Jellyfin.Database.Implementations.Enums;
 12using Jellyfin.Extensions;
 13using MediaBrowser.Controller.Dto;
 14using MediaBrowser.Controller.Entities;
 15using MediaBrowser.Controller.Library;
 16using MediaBrowser.Model.Dto;
 17using MediaBrowser.Model.Entities;
 18using MediaBrowser.Model.Querying;
 19using Microsoft.AspNetCore.Authorization;
 20using Microsoft.AspNetCore.Http;
 21using Microsoft.AspNetCore.Mvc;
 22
 23namespace Jellyfin.Api.Controllers;
 24
 25/// <summary>
 26/// Years controller.
 27/// </summary>
 28[Authorize]
 29public class YearsController : BaseJellyfinApiController
 30{
 31    private readonly ILibraryManager _libraryManager;
 32    private readonly IUserManager _userManager;
 33    private readonly IDtoService _dtoService;
 34
 35    /// <summary>
 36    /// Initializes a new instance of the <see cref="YearsController"/> class.
 37    /// </summary>
 38    /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
 39    /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
 40    /// <param name="dtoService">Instance of the <see cref="IDtoService"/> interface.</param>
 041    public YearsController(
 042        ILibraryManager libraryManager,
 043        IUserManager userManager,
 044        IDtoService dtoService)
 45    {
 046        _libraryManager = libraryManager;
 047        _userManager = userManager;
 048        _dtoService = dtoService;
 049    }
 50
 51    /// <summary>
 52    /// Get years.
 53    /// </summary>
 54    /// <param name="startIndex">Skips over a given number of items within the results. Use for paging.</param>
 55    /// <param name="limit">Optional. The maximum number of records to return.</param>
 56    /// <param name="sortOrder">Sort Order - Ascending,Descending.</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 excluded based on item type. This allows 
 60    /// <param name="includeItemTypes">Optional. If specified, results will be included based on item type. This allows 
 61    /// <param name="mediaTypes">Optional. Filter by MediaType. Allows multiple, comma delimited.</param>
 62    /// <param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Ar
 63    /// <param name="enableUserData">Optional. Include user data.</param>
 64    /// <param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
 65    /// <param name="enableImageTypes">Optional. The image types to include in the output.</param>
 66    /// <param name="userId">User Id.</param>
 67    /// <param name="recursive">Search recursively.</param>
 68    /// <param name="enableImages">Optional. Include image information in output.</param>
 69    /// <response code="200">Year query returned.</response>
 70    /// <returns> A <see cref="QueryResult{BaseItemDto}"/> containing the year result.</returns>
 71    [HttpGet]
 72    [ProducesResponseType(StatusCodes.Status200OK)]
 73    public ActionResult<QueryResult<BaseItemDto>> GetYears(
 74        [FromQuery] int? startIndex,
 75        [FromQuery] int? limit,
 76        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] SortOrder[] sortOrder,
 77        [FromQuery] Guid? parentId,
 78        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemFields[] fields,
 79        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] excludeItemTypes,
 80        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] includeItemTypes,
 81        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] MediaType[] mediaTypes,
 82        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemSortBy[] sortBy,
 83        [FromQuery] bool? enableUserData,
 84        [FromQuery] int? imageTypeLimit,
 85        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ImageType[] enableImageTypes,
 86        [FromQuery] Guid? userId,
 87        [FromQuery] bool recursive = true,
 88        [FromQuery] bool? enableImages = true)
 89    {
 090        userId = RequestHelpers.GetUserId(User, userId);
 091        var dtoOptions = new DtoOptions { Fields = fields }
 092            .AddClientFields(User)
 093            .AddAdditionalDtoOptions(enableImages, enableUserData, imageTypeLimit, enableImageTypes);
 94
 095        User? user = userId.IsNullOrEmpty()
 096            ? null
 097            : _userManager.GetUserById(userId.Value);
 098        BaseItem parentItem = _libraryManager.GetParentItem(parentId, userId);
 99
 0100        var query = new InternalItemsQuery(user)
 0101        {
 0102            ExcludeItemTypes = excludeItemTypes,
 0103            IncludeItemTypes = includeItemTypes,
 0104            MediaTypes = mediaTypes,
 0105            DtoOptions = dtoOptions
 0106        };
 107
 108        bool Filter(BaseItem i) => FilterItem(i, excludeItemTypes, includeItemTypes, mediaTypes);
 109
 110        IReadOnlyList<BaseItem> items;
 0111        if (parentItem.IsFolder)
 112        {
 0113            var folder = (Folder)parentItem;
 114
 0115            if (userId.IsNullOrEmpty())
 116            {
 0117                items = recursive ? folder.GetRecursiveChildren(Filter) : folder.Children.Where(Filter).ToArray();
 118            }
 119            else
 120            {
 0121                items = recursive ? folder.GetRecursiveChildren(user, query) : folder.GetChildren(user, true).Where(Filt
 122            }
 123        }
 124        else
 125        {
 0126            items = new[] { parentItem }.Where(Filter).ToList();
 127        }
 128
 0129        var extractedItems = GetAllItems(items);
 130
 0131        var filteredItems = _libraryManager.Sort(extractedItems, user, RequestHelpers.GetOrderBy(sortBy, sortOrder));
 132
 0133        var ibnItemsArray = filteredItems.ToList();
 134
 0135        IEnumerable<BaseItem> ibnItems = ibnItemsArray;
 136
 0137        if (startIndex.HasValue || limit.HasValue)
 138        {
 0139            if (startIndex.HasValue)
 140            {
 0141                ibnItems = ibnItems.Skip(startIndex.Value);
 142            }
 143
 0144            if (limit.HasValue)
 145            {
 0146                ibnItems = ibnItems.Take(limit.Value);
 147            }
 148        }
 149
 0150        var tuples = ibnItems.Select(i => new Tuple<BaseItem, List<BaseItem>>(i, new List<BaseItem>()));
 151
 0152        var dtos = tuples.Select(i => _dtoService.GetItemByNameDto(i.Item1, dtoOptions, i.Item2, user));
 153
 0154        var result = new QueryResult<BaseItemDto>(
 0155            startIndex,
 0156            ibnItemsArray.Count,
 0157            dtos.Where(i => i is not null).ToArray());
 0158        return result;
 159    }
 160
 161    /// <summary>
 162    /// Gets a year.
 163    /// </summary>
 164    /// <param name="year">The year.</param>
 165    /// <param name="userId">Optional. Filter by user id, and attach user data.</param>
 166    /// <response code="200">Year returned.</response>
 167    /// <response code="404">Year not found.</response>
 168    /// <returns>
 169    /// An <see cref="OkResult"/> containing the year,
 170    /// or a <see cref="NotFoundResult"/> if year not found.
 171    /// </returns>
 172    [HttpGet("{year}")]
 173    [ProducesResponseType(StatusCodes.Status200OK)]
 174    [ProducesResponseType(StatusCodes.Status404NotFound)]
 175    public ActionResult<BaseItemDto> GetYear([FromRoute, Required] int year, [FromQuery] Guid? userId)
 176    {
 0177        userId = RequestHelpers.GetUserId(User, userId);
 0178        var item = _libraryManager.GetYear(year);
 0179        if (item is null)
 180        {
 0181            return NotFound();
 182        }
 183
 0184        var dtoOptions = new DtoOptions()
 0185            .AddClientFields(User);
 186
 0187        if (!userId.IsNullOrEmpty())
 188        {
 0189            var user = _userManager.GetUserById(userId.Value);
 0190            return _dtoService.GetBaseItemDto(item, dtoOptions, user);
 191        }
 192
 0193        return _dtoService.GetBaseItemDto(item, dtoOptions);
 194    }
 195
 196    private bool FilterItem(BaseItem f, IReadOnlyCollection<BaseItemKind> excludeItemTypes, IReadOnlyCollection<BaseItem
 197    {
 0198        var baseItemKind = f.GetBaseItemKind();
 199        // Exclude item types
 0200        if (excludeItemTypes.Count > 0 && excludeItemTypes.Contains(baseItemKind))
 201        {
 0202            return false;
 203        }
 204
 205        // Include item types
 0206        if (includeItemTypes.Count > 0 && !includeItemTypes.Contains(baseItemKind))
 207        {
 0208            return false;
 209        }
 210
 211        // Include MediaTypes
 0212        if (mediaTypes.Count > 0 && !mediaTypes.Contains(f.MediaType))
 213        {
 0214            return false;
 215        }
 216
 0217        return true;
 218    }
 219
 220    private IEnumerable<BaseItem> GetAllItems(IEnumerable<BaseItem> items)
 221    {
 0222        return items
 0223            .Select(i => i.ProductionYear ?? 0)
 0224            .Where(i => i > 0)
 0225            .Distinct()
 0226            .Select(year => _libraryManager.GetYear(year));
 227    }
 228}
Generated by: ReportGenerator 5.4.5.0
4/7/2025 - 12:11:27 AM
GitHub | reportgenerator.io

Methods/Properties

.ctor(MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Dto.IDtoService)
GetYears(System.Nullable`1<System.Int32>,System.Nullable`1<System.Int32>,Jellyfin.Database.Implementations.Enums.SortOrder[],System.Nullable`1<System.Guid>,MediaBrowser.Model.Querying.ItemFields[],Jellyfin.Data.Enums.BaseItemKind[],Jellyfin.Data.Enums.BaseItemKind[],Jellyfin.Data.Enums.MediaType[],Jellyfin.Data.Enums.ItemSortBy[],System.Nullable`1<System.Boolean>,System.Nullable`1<System.Int32>,MediaBrowser.Model.Entities.ImageType[],System.Nullable`1<System.Guid>,System.Boolean,System.Nullable`1<System.Boolean>)
GetYear(System.Int32,System.Nullable`1<System.Guid>)
FilterItem(MediaBrowser.Controller.Entities.BaseItem,System.Collections.Generic.IReadOnlyCollection`1<Jellyfin.Data.Enums.BaseItemKind>,System.Collections.Generic.IReadOnlyCollection`1<Jellyfin.Data.Enums.BaseItemKind>,System.Collections.Generic.IReadOnlyCollection`1<Jellyfin.Data.Enums.MediaType>)
GetAllItems(System.Collections.Generic.IEnumerable`1<MediaBrowser.Controller.Entities.BaseItem>)