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

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]
 29public class UserViewsController : BaseJellyfinApiController
 30{
 31    private readonly IUserManager _userManager;
 32    private readonly IUserViewManager _userViewManager;
 33    private readonly IDtoService _dtoService;
 34    private readonly ILibraryManager _libraryManager;
 35
 36    /// <summary>
 37    /// Initializes a new instance of the <see cref="UserViewsController"/> class.
 38    /// </summary>
 39    /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
 40    /// <param name="userViewManager">Instance of the <see cref="IUserViewManager"/> interface.</param>
 41    /// <param name="dtoService">Instance of the <see cref="IDtoService"/> interface.</param>
 42    /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
 043    public UserViewsController(
 044        IUserManager userManager,
 045        IUserViewManager userViewManager,
 046        IDtoService dtoService,
 047        ILibraryManager libraryManager)
 48    {
 049        _userManager = userManager;
 050        _userViewManager = userViewManager;
 051        _dtoService = dtoService;
 052        _libraryManager = libraryManager;
 053    }
 54
 55    /// <summary>
 56    /// Get user views.
 57    /// </summary>
 58    /// <param name="userId">User id.</param>
 59    /// <param name="includeExternalContent">Whether or not to include external views such as channels or live tv.</para
 60    /// <param name="presetViews">Preset views.</param>
 61    /// <param name="includeHidden">Whether or not to include hidden content.</param>
 62    /// <response code="200">User views returned.</response>
 63    /// <returns>An <see cref="OkResult"/> containing the user views.</returns>
 64    [HttpGet("UserViews")]
 65    [ProducesResponseType(StatusCodes.Status200OK)]
 66    public QueryResult<BaseItemDto> GetUserViews(
 67        [FromQuery] Guid? userId,
 68        [FromQuery] bool? includeExternalContent,
 69        [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] CollectionType?[] presetViews,
 70        [FromQuery] bool includeHidden = false)
 71    {
 072        userId = RequestHelpers.GetUserId(User, userId);
 073        var user = _userManager.GetUserById(userId.Value) ?? throw new ResourceNotFoundException();
 74
 075        var query = new UserViewQuery { User = user, IncludeHidden = includeHidden };
 76
 077        if (includeExternalContent.HasValue)
 78        {
 079            query.IncludeExternalContent = includeExternalContent.Value;
 80        }
 81
 082        if (presetViews.Length != 0)
 83        {
 084            query.PresetViews = presetViews;
 85        }
 86
 087        var folders = _userViewManager.GetUserViews(query);
 88
 089        var dtoOptions = new DtoOptions().AddClientFields(User);
 090        dtoOptions.Fields = [..dtoOptions.Fields, ItemFields.PrimaryImageAspectRatio, ItemFields.DisplayPreferencesId];
 91
 092        var dtos = Array.ConvertAll(folders, i => _dtoService.GetBaseItemDto(i, dtoOptions, user));
 93
 094        return new QueryResult<BaseItemDto>(dtos);
 95    }
 96
 97    /// <summary>
 98    /// Get user views.
 99    /// </summary>
 100    /// <param name="userId">User id.</param>
 101    /// <param name="includeExternalContent">Whether or not to include external views such as channels or live tv.</para
 102    /// <param name="presetViews">Preset views.</param>
 103    /// <param name="includeHidden">Whether or not to include hidden content.</param>
 104    /// <response code="200">User views returned.</response>
 105    /// <returns>An <see cref="OkResult"/> containing the user views.</returns>
 106    [HttpGet("Users/{userId}/Views")]
 107    [ProducesResponseType(StatusCodes.Status200OK)]
 108    [Obsolete("Kept for backwards compatibility")]
 109    [ApiExplorerSettings(IgnoreApi = true)]
 110    public QueryResult<BaseItemDto> GetUserViewsLegacy(
 111        [FromRoute, Required] Guid userId,
 112        [FromQuery] bool? includeExternalContent,
 113        [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] CollectionType?[] presetViews,
 114        [FromQuery] bool includeHidden = false)
 115        => GetUserViews(userId, includeExternalContent, presetViews, includeHidden);
 116
 117    /// <summary>
 118    /// Get user view grouping options.
 119    /// </summary>
 120    /// <param name="userId">User id.</param>
 121    /// <response code="200">User view grouping options returned.</response>
 122    /// <response code="404">User not found.</response>
 123    /// <returns>
 124    /// An <see cref="OkResult"/> containing the user view grouping options
 125    /// or a <see cref="NotFoundResult"/> if user not found.
 126    /// </returns>
 127    [HttpGet("UserViews/GroupingOptions")]
 128    [ProducesResponseType(StatusCodes.Status200OK)]
 129    [ProducesResponseType(StatusCodes.Status404NotFound)]
 130    public ActionResult<IEnumerable<SpecialViewOptionDto>> GetGroupingOptions([FromQuery] Guid? userId)
 131    {
 0132        userId = RequestHelpers.GetUserId(User, userId);
 0133        var user = _userManager.GetUserById(userId.Value);
 0134        if (user is null)
 135        {
 0136            return NotFound();
 137        }
 138
 0139        return Ok(_libraryManager.GetUserRootFolder()
 0140            .GetChildren(user, true)
 0141            .OfType<Folder>()
 0142            .Where(UserView.IsEligibleForGrouping)
 0143            .Select(i => new SpecialViewOptionDto
 0144            {
 0145                Name = i.Name,
 0146                Id = i.Id.ToString("N", CultureInfo.InvariantCulture)
 0147            })
 0148            .OrderBy(i => i.Name)
 0149            .AsEnumerable());
 150    }
 151
 152    /// <summary>
 153    /// Get user view grouping options.
 154    /// </summary>
 155    /// <param name="userId">User id.</param>
 156    /// <response code="200">User view grouping options returned.</response>
 157    /// <response code="404">User not found.</response>
 158    /// <returns>
 159    /// An <see cref="OkResult"/> containing the user view grouping options
 160    /// or a <see cref="NotFoundResult"/> if user not found.
 161    /// </returns>
 162    [HttpGet("Users/{userId}/GroupingOptions")]
 163    [ProducesResponseType(StatusCodes.Status200OK)]
 164    [ProducesResponseType(StatusCodes.Status404NotFound)]
 165    [Obsolete("Kept for backwards compatibility")]
 166    [ApiExplorerSettings(IgnoreApi = true)]
 167    public ActionResult<IEnumerable<SpecialViewOptionDto>> GetGroupingOptionsLegacy(
 168        [FromRoute, Required] Guid userId)
 169        => GetGroupingOptions(userId);
 170}
Generated by: ReportGenerator 5.3.8.0
9/19/2024 - 12:16:36 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>)