< 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: 226
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

Coverage history 0 25 50 75 100

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.ComponentModel.DataAnnotations;
 4using System.Linq;
 5using Jellyfin.Api.Extensions;
 6using Jellyfin.Api.Helpers;
 7using Jellyfin.Api.ModelBinders;
 8using Jellyfin.Data.Entities;
 9using Jellyfin.Data.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;
 20
 21namespace Jellyfin.Api.Controllers;
 22
 23/// <summary>
 24/// Years controller.
 25/// </summary>
 26[Authorize]
 27public class YearsController : BaseJellyfinApiController
 28{
 29    private readonly ILibraryManager _libraryManager;
 30    private readonly IUserManager _userManager;
 31    private readonly IDtoService _dtoService;
 32
 33    /// <summary>
 34    /// Initializes a new instance of the <see cref="YearsController"/> class.
 35    /// </summary>
 36    /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
 37    /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
 38    /// <param name="dtoService">Instance of the <see cref="IDtoService"/> interface.</param>
 039    public YearsController(
 040        ILibraryManager libraryManager,
 041        IUserManager userManager,
 042        IDtoService dtoService)
 43    {
 044        _libraryManager = libraryManager;
 045        _userManager = userManager;
 046        _dtoService = dtoService;
 047    }
 48
 49    /// <summary>
 50    /// Get years.
 51    /// </summary>
 52    /// <param name="startIndex">Skips over a given number of items within the results. Use for paging.</param>
 53    /// <param name="limit">Optional. The maximum number of records to return.</param>
 54    /// <param name="sortOrder">Sort Order - Ascending,Descending.</param>
 55    /// <param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</
 56    /// <param name="fields">Optional. Specify additional fields of information to return in the output.</param>
 57    /// <param name="excludeItemTypes">Optional. If specified, results will be excluded based on item type. This allows 
 58    /// <param name="includeItemTypes">Optional. If specified, results will be included based on item type. This allows 
 59    /// <param name="mediaTypes">Optional. Filter by MediaType. Allows multiple, comma delimited.</param>
 60    /// <param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Ar
 61    /// <param name="enableUserData">Optional. Include user data.</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="recursive">Search recursively.</param>
 66    /// <param name="enableImages">Optional. Include image information in output.</param>
 67    /// <response code="200">Year query returned.</response>
 68    /// <returns> A <see cref="QueryResult{BaseItemDto}"/> containing the year result.</returns>
 69    [HttpGet]
 70    [ProducesResponseType(StatusCodes.Status200OK)]
 71    public ActionResult<QueryResult<BaseItemDto>> GetYears(
 72        [FromQuery] int? startIndex,
 73        [FromQuery] int? limit,
 74        [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] SortOrder[] sortOrder,
 75        [FromQuery] Guid? parentId,
 76        [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ItemFields[] fields,
 77        [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] BaseItemKind[] excludeItemTypes,
 78        [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] BaseItemKind[] includeItemTypes,
 79        [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] MediaType[] mediaTypes,
 80        [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ItemSortBy[] sortBy,
 81        [FromQuery] bool? enableUserData,
 82        [FromQuery] int? imageTypeLimit,
 83        [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ImageType[] enableImageTypes,
 84        [FromQuery] Guid? userId,
 85        [FromQuery] bool recursive = true,
 86        [FromQuery] bool? enableImages = true)
 87    {
 088        userId = RequestHelpers.GetUserId(User, userId);
 089        var dtoOptions = new DtoOptions { Fields = fields }
 090            .AddClientFields(User)
 091            .AddAdditionalDtoOptions(enableImages, enableUserData, imageTypeLimit, enableImageTypes);
 92
 093        User? user = userId.IsNullOrEmpty()
 094            ? null
 095            : _userManager.GetUserById(userId.Value);
 096        BaseItem parentItem = _libraryManager.GetParentItem(parentId, userId);
 97
 098        var query = new InternalItemsQuery(user)
 099        {
 0100            ExcludeItemTypes = excludeItemTypes,
 0101            IncludeItemTypes = includeItemTypes,
 0102            MediaTypes = mediaTypes,
 0103            DtoOptions = dtoOptions
 0104        };
 105
 106        bool Filter(BaseItem i) => FilterItem(i, excludeItemTypes, includeItemTypes, mediaTypes);
 107
 108        IList<BaseItem> items;
 0109        if (parentItem.IsFolder)
 110        {
 0111            var folder = (Folder)parentItem;
 112
 0113            if (userId.IsNullOrEmpty())
 114            {
 0115                items = recursive ? folder.GetRecursiveChildren(Filter) : folder.Children.Where(Filter).ToList();
 116            }
 117            else
 118            {
 0119                items = recursive ? folder.GetRecursiveChildren(user, query).ToList() : folder.GetChildren(user, true).W
 120            }
 121        }
 122        else
 123        {
 0124            items = new[] { parentItem }.Where(Filter).ToList();
 125        }
 126
 0127        var extractedItems = GetAllItems(items);
 128
 0129        var filteredItems = _libraryManager.Sort(extractedItems, user, RequestHelpers.GetOrderBy(sortBy, sortOrder));
 130
 0131        var ibnItemsArray = filteredItems.ToList();
 132
 0133        IEnumerable<BaseItem> ibnItems = ibnItemsArray;
 134
 0135        if (startIndex.HasValue || limit.HasValue)
 136        {
 0137            if (startIndex.HasValue)
 138            {
 0139                ibnItems = ibnItems.Skip(startIndex.Value);
 140            }
 141
 0142            if (limit.HasValue)
 143            {
 0144                ibnItems = ibnItems.Take(limit.Value);
 145            }
 146        }
 147
 0148        var tuples = ibnItems.Select(i => new Tuple<BaseItem, List<BaseItem>>(i, new List<BaseItem>()));
 149
 0150        var dtos = tuples.Select(i => _dtoService.GetItemByNameDto(i.Item1, dtoOptions, i.Item2, user));
 151
 0152        var result = new QueryResult<BaseItemDto>(
 0153            startIndex,
 0154            ibnItemsArray.Count,
 0155            dtos.Where(i => i is not null).ToArray());
 0156        return result;
 157    }
 158
 159    /// <summary>
 160    /// Gets a year.
 161    /// </summary>
 162    /// <param name="year">The year.</param>
 163    /// <param name="userId">Optional. Filter by user id, and attach user data.</param>
 164    /// <response code="200">Year returned.</response>
 165    /// <response code="404">Year not found.</response>
 166    /// <returns>
 167    /// An <see cref="OkResult"/> containing the year,
 168    /// or a <see cref="NotFoundResult"/> if year not found.
 169    /// </returns>
 170    [HttpGet("{year}")]
 171    [ProducesResponseType(StatusCodes.Status200OK)]
 172    [ProducesResponseType(StatusCodes.Status404NotFound)]
 173    public ActionResult<BaseItemDto> GetYear([FromRoute, Required] int year, [FromQuery] Guid? userId)
 174    {
 0175        userId = RequestHelpers.GetUserId(User, userId);
 0176        var item = _libraryManager.GetYear(year);
 0177        if (item is null)
 178        {
 0179            return NotFound();
 180        }
 181
 0182        var dtoOptions = new DtoOptions()
 0183            .AddClientFields(User);
 184
 0185        if (!userId.IsNullOrEmpty())
 186        {
 0187            var user = _userManager.GetUserById(userId.Value);
 0188            return _dtoService.GetBaseItemDto(item, dtoOptions, user);
 189        }
 190
 0191        return _dtoService.GetBaseItemDto(item, dtoOptions);
 192    }
 193
 194    private bool FilterItem(BaseItem f, IReadOnlyCollection<BaseItemKind> excludeItemTypes, IReadOnlyCollection<BaseItem
 195    {
 0196        var baseItemKind = f.GetBaseItemKind();
 197        // Exclude item types
 0198        if (excludeItemTypes.Count > 0 && excludeItemTypes.Contains(baseItemKind))
 199        {
 0200            return false;
 201        }
 202
 203        // Include item types
 0204        if (includeItemTypes.Count > 0 && !includeItemTypes.Contains(baseItemKind))
 205        {
 0206            return false;
 207        }
 208
 209        // Include MediaTypes
 0210        if (mediaTypes.Count > 0 && !mediaTypes.Contains(f.MediaType))
 211        {
 0212            return false;
 213        }
 214
 0215        return true;
 216    }
 217
 218    private IEnumerable<BaseItem> GetAllItems(IEnumerable<BaseItem> items)
 219    {
 0220        return items
 0221            .Select(i => i.ProductionYear ?? 0)
 0222            .Where(i => i > 0)
 0223            .Distinct()
 0224            .Select(year => _libraryManager.GetYear(year));
 225    }
 226}
Generated by: ReportGenerator 5.3.8.0
9/19/2024 - 12:16:36 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.Data.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>)