< Summary - Jellyfin

Information
Class: Jellyfin.Api.Controllers.UserViewsController
Assembly: Jellyfin.Api
File(s): /srv/git/jellyfin/Jellyfin.Api/Controllers/UserViewsController.cs
Line coverage
0%
Covered lines: 0
Uncovered lines: 37
Coverable lines: 37
Total lines: 171
Line coverage: 0%
Branch coverage
0%
Covered branches: 0
Total branches: 10
Branch coverage: 0%
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: 0% (0/37) Branch coverage: 0% (0/10) Total lines: 1704/27/2026 - 12:15:04 AM Line coverage: 0% (0/37) Branch coverage: 0% (0/10) Total lines: 171 1/23/2026 - 12:11:06 AM Line coverage: 0% (0/37) Branch coverage: 0% (0/10) Total lines: 1704/27/2026 - 12:15:04 AM Line coverage: 0% (0/37) Branch coverage: 0% (0/10) Total lines: 171

Coverage delta

Coverage delta 1 -1

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%210%
GetUserViews(...)0%7280%
GetGroupingOptions(...)0%620%

File(s)

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

#LineLine coverage
 1using System;
 2using System.Collections.Generic;
 3using System.ComponentModel.DataAnnotations;
 4using System.Globalization;
 5using System.Linq;
 6using Jellyfin.Api.Extensions;
 7using Jellyfin.Api.Helpers;
 8using Jellyfin.Api.ModelBinders;
 9using Jellyfin.Api.Models.UserViewDtos;
 10using Jellyfin.Data.Enums;
 11using MediaBrowser.Common.Extensions;
 12using MediaBrowser.Controller.Dto;
 13using MediaBrowser.Controller.Entities;
 14using MediaBrowser.Controller.Library;
 15using MediaBrowser.Model.Dto;
 16using MediaBrowser.Model.Library;
 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/// User views controller.
 26/// </summary>
 27[Route("")]
 28[Authorize]
 29[Tags("UserView")]
 30public class UserViewsController : BaseJellyfinApiController
 31{
 32    private readonly IUserManager _userManager;
 33    private readonly IUserViewManager _userViewManager;
 34    private readonly IDtoService _dtoService;
 35    private readonly ILibraryManager _libraryManager;
 36
 37    /// <summary>
 38    /// Initializes a new instance of the <see cref="UserViewsController"/> class.
 39    /// </summary>
 40    /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
 41    /// <param name="userViewManager">Instance of the <see cref="IUserViewManager"/> interface.</param>
 42    /// <param name="dtoService">Instance of the <see cref="IDtoService"/> interface.</param>
 43    /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
 044    public UserViewsController(
 045        IUserManager userManager,
 046        IUserViewManager userViewManager,
 047        IDtoService dtoService,
 048        ILibraryManager libraryManager)
 49    {
 050        _userManager = userManager;
 051        _userViewManager = userViewManager;
 052        _dtoService = dtoService;
 053        _libraryManager = libraryManager;
 054    }
 55
 56    /// <summary>
 57    /// Get user views.
 58    /// </summary>
 59    /// <param name="userId">User id.</param>
 60    /// <param name="includeExternalContent">Whether or not to include external views such as channels or live tv.</para
 61    /// <param name="presetViews">Preset views.</param>
 62    /// <param name="includeHidden">Whether or not to include hidden content.</param>
 63    /// <response code="200">User views returned.</response>
 64    /// <returns>An <see cref="OkResult"/> containing the user views.</returns>
 65    [HttpGet("UserViews")]
 66    [ProducesResponseType(StatusCodes.Status200OK)]
 67    public QueryResult<BaseItemDto> GetUserViews(
 68        [FromQuery] Guid? userId,
 69        [FromQuery] bool? includeExternalContent,
 70        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] CollectionType?[] presetViews,
 71        [FromQuery] bool includeHidden = false)
 72    {
 073        userId = RequestHelpers.GetUserId(User, userId);
 074        var user = _userManager.GetUserById(userId.Value) ?? throw new ResourceNotFoundException();
 75
 076        var query = new UserViewQuery { User = user, IncludeHidden = includeHidden };
 77
 078        if (includeExternalContent.HasValue)
 79        {
 080            query.IncludeExternalContent = includeExternalContent.Value;
 81        }
 82
 083        if (presetViews.Length != 0)
 84        {
 085            query.PresetViews = presetViews;
 86        }
 87
 088        var folders = _userViewManager.GetUserViews(query);
 89
 090        var dtoOptions = new DtoOptions();
 091        dtoOptions.Fields = [..dtoOptions.Fields, ItemFields.PrimaryImageAspectRatio, ItemFields.DisplayPreferencesId];
 92
 093        var dtos = Array.ConvertAll(folders, i => _dtoService.GetBaseItemDto(i, dtoOptions, user));
 94
 095        return new QueryResult<BaseItemDto>(dtos);
 96    }
 97
 98    /// <summary>
 99    /// Get user views.
 100    /// </summary>
 101    /// <param name="userId">User id.</param>
 102    /// <param name="includeExternalContent">Whether or not to include external views such as channels or live tv.</para
 103    /// <param name="presetViews">Preset views.</param>
 104    /// <param name="includeHidden">Whether or not to include hidden content.</param>
 105    /// <response code="200">User views returned.</response>
 106    /// <returns>An <see cref="OkResult"/> containing the user views.</returns>
 107    [HttpGet("Users/{userId}/Views")]
 108    [ProducesResponseType(StatusCodes.Status200OK)]
 109    [Obsolete("Kept for backwards compatibility")]
 110    [ApiExplorerSettings(IgnoreApi = true)]
 111    public QueryResult<BaseItemDto> GetUserViewsLegacy(
 112        [FromRoute, Required] Guid userId,
 113        [FromQuery] bool? includeExternalContent,
 114        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] CollectionType?[] presetViews,
 115        [FromQuery] bool includeHidden = false)
 116        => GetUserViews(userId, includeExternalContent, presetViews, includeHidden);
 117
 118    /// <summary>
 119    /// Get user view grouping options.
 120    /// </summary>
 121    /// <param name="userId">User id.</param>
 122    /// <response code="200">User view grouping options returned.</response>
 123    /// <response code="404">User not found.</response>
 124    /// <returns>
 125    /// An <see cref="OkResult"/> containing the user view grouping options
 126    /// or a <see cref="NotFoundResult"/> if user not found.
 127    /// </returns>
 128    [HttpGet("UserViews/GroupingOptions")]
 129    [ProducesResponseType(StatusCodes.Status200OK)]
 130    [ProducesResponseType(StatusCodes.Status404NotFound)]
 131    public ActionResult<IEnumerable<SpecialViewOptionDto>> GetGroupingOptions([FromQuery] Guid? userId)
 132    {
 0133        userId = RequestHelpers.GetUserId(User, userId);
 0134        var user = _userManager.GetUserById(userId.Value);
 0135        if (user is null)
 136        {
 0137            return NotFound();
 138        }
 139
 0140        return Ok(_libraryManager.GetUserRootFolder()
 0141            .GetChildren(user, true)
 0142            .OfType<Folder>()
 0143            .Where(UserView.IsEligibleForGrouping)
 0144            .Select(i => new SpecialViewOptionDto
 0145            {
 0146                Name = i.Name,
 0147                Id = i.Id.ToString("N", CultureInfo.InvariantCulture)
 0148            })
 0149            .OrderBy(i => i.Name)
 0150            .AsEnumerable());
 151    }
 152
 153    /// <summary>
 154    /// Get user view grouping options.
 155    /// </summary>
 156    /// <param name="userId">User id.</param>
 157    /// <response code="200">User view grouping options returned.</response>
 158    /// <response code="404">User not found.</response>
 159    /// <returns>
 160    /// An <see cref="OkResult"/> containing the user view grouping options
 161    /// or a <see cref="NotFoundResult"/> if user not found.
 162    /// </returns>
 163    [HttpGet("Users/{userId}/GroupingOptions")]
 164    [ProducesResponseType(StatusCodes.Status200OK)]
 165    [ProducesResponseType(StatusCodes.Status404NotFound)]
 166    [Obsolete("Kept for backwards compatibility")]
 167    [ApiExplorerSettings(IgnoreApi = true)]
 168    public ActionResult<IEnumerable<SpecialViewOptionDto>> GetGroupingOptionsLegacy(
 169        [FromRoute, Required] Guid userId)
 170        => GetGroupingOptions(userId);
 171}
Generated by: ReportGenerator 5.5.7.0
5/6/2026 - 12:15:24 AM
GitHub | reportgenerator.io

Methods/Properties

.ctor(MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Library.IUserViewManager,MediaBrowser.Controller.Dto.IDtoService,MediaBrowser.Controller.Library.ILibraryManager)
GetUserViews(System.Nullable`1<System.Guid>,System.Nullable`1<System.Boolean>,System.Nullable`1<Jellyfin.Data.Enums.CollectionType>[],System.Boolean)
GetGroupingOptions(System.Nullable`1<System.Guid>)