< Summary - Jellyfin

Information
Class: Jellyfin.Api.Controllers.SuggestionsController
Assembly: Jellyfin.Api
File(s): /srv/git/jellyfin/Jellyfin.Api/Controllers/SuggestionsController.cs
Line coverage
0%
Covered lines: 0
Uncovered lines: 30
Coverable lines: 30
Total lines: 124
Line coverage: 0%
Branch coverage
0%
Covered branches: 0
Total branches: 2
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%
GetSuggestions(...)0%620%

File(s)

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

#LineLine coverage
 1using System;
 2using System.ComponentModel.DataAnnotations;
 3using Jellyfin.Api.Extensions;
 4using Jellyfin.Api.Helpers;
 5using Jellyfin.Api.ModelBinders;
 6using Jellyfin.Data.Entities;
 7using Jellyfin.Data.Enums;
 8using Jellyfin.Extensions;
 9using MediaBrowser.Controller.Dto;
 10using MediaBrowser.Controller.Entities;
 11using MediaBrowser.Controller.Library;
 12using MediaBrowser.Model.Dto;
 13using MediaBrowser.Model.Querying;
 14using Microsoft.AspNetCore.Authorization;
 15using Microsoft.AspNetCore.Http;
 16using Microsoft.AspNetCore.Mvc;
 17
 18namespace Jellyfin.Api.Controllers;
 19
 20/// <summary>
 21/// The suggestions controller.
 22/// </summary>
 23[Route("")]
 24[Authorize]
 25public class SuggestionsController : BaseJellyfinApiController
 26{
 27    private readonly IDtoService _dtoService;
 28    private readonly IUserManager _userManager;
 29    private readonly ILibraryManager _libraryManager;
 30
 31    /// <summary>
 32    /// Initializes a new instance of the <see cref="SuggestionsController"/> class.
 33    /// </summary>
 34    /// <param name="dtoService">Instance of the <see cref="IDtoService"/> interface.</param>
 35    /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
 36    /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
 037    public SuggestionsController(
 038        IDtoService dtoService,
 039        IUserManager userManager,
 040        ILibraryManager libraryManager)
 41    {
 042        _dtoService = dtoService;
 043        _userManager = userManager;
 044        _libraryManager = libraryManager;
 045    }
 46
 47    /// <summary>
 48    /// Gets suggestions.
 49    /// </summary>
 50    /// <param name="userId">The user id.</param>
 51    /// <param name="mediaType">The media types.</param>
 52    /// <param name="type">The type.</param>
 53    /// <param name="startIndex">Optional. The start index.</param>
 54    /// <param name="limit">Optional. The limit.</param>
 55    /// <param name="enableTotalRecordCount">Whether to enable the total record count.</param>
 56    /// <response code="200">Suggestions returned.</response>
 57    /// <returns>A <see cref="QueryResult{BaseItemDto}"/> with the suggestions.</returns>
 58    [HttpGet("Items/Suggestions")]
 59    [ProducesResponseType(StatusCodes.Status200OK)]
 60    public ActionResult<QueryResult<BaseItemDto>> GetSuggestions(
 61        [FromQuery] Guid? userId,
 62        [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] MediaType[] mediaType,
 63        [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] BaseItemKind[] type,
 64        [FromQuery] int? startIndex,
 65        [FromQuery] int? limit,
 66        [FromQuery] bool enableTotalRecordCount = false)
 67    {
 68        User? user;
 069        if (userId.IsNullOrEmpty())
 70        {
 071            user = null;
 72        }
 73        else
 74        {
 075            var requestUserId = RequestHelpers.GetUserId(User, userId);
 076            user = _userManager.GetUserById(requestUserId);
 77        }
 78
 079        var dtoOptions = new DtoOptions().AddClientFields(User);
 080        var result = _libraryManager.GetItemsResult(new InternalItemsQuery(user)
 081        {
 082            OrderBy = new[] { (ItemSortBy.Random, SortOrder.Descending) },
 083            MediaTypes = mediaType,
 084            IncludeItemTypes = type,
 085            IsVirtualItem = false,
 086            StartIndex = startIndex,
 087            Limit = limit,
 088            DtoOptions = dtoOptions,
 089            EnableTotalRecordCount = enableTotalRecordCount,
 090            Recursive = true
 091        });
 92
 093        var dtoList = _dtoService.GetBaseItemDtos(result.Items, dtoOptions, user);
 94
 095        return new QueryResult<BaseItemDto>(
 096            startIndex,
 097            result.TotalRecordCount,
 098            dtoList);
 99    }
 100
 101    /// <summary>
 102    /// Gets suggestions.
 103    /// </summary>
 104    /// <param name="userId">The user id.</param>
 105    /// <param name="mediaType">The media types.</param>
 106    /// <param name="type">The type.</param>
 107    /// <param name="startIndex">Optional. The start index.</param>
 108    /// <param name="limit">Optional. The limit.</param>
 109    /// <param name="enableTotalRecordCount">Whether to enable the total record count.</param>
 110    /// <response code="200">Suggestions returned.</response>
 111    /// <returns>A <see cref="QueryResult{BaseItemDto}"/> with the suggestions.</returns>
 112    [HttpGet("Users/{userId}/Suggestions")]
 113    [ProducesResponseType(StatusCodes.Status200OK)]
 114    [Obsolete("Kept for backwards compatibility")]
 115    [ApiExplorerSettings(IgnoreApi = true)]
 116    public ActionResult<QueryResult<BaseItemDto>> GetSuggestionsLegacy(
 117        [FromRoute, Required] Guid userId,
 118        [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] MediaType[] mediaType,
 119        [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] BaseItemKind[] type,
 120        [FromQuery] int? startIndex,
 121        [FromQuery] int? limit,
 122        [FromQuery] bool enableTotalRecordCount = false)
 123        => GetSuggestions(userId, mediaType, type, startIndex, limit, enableTotalRecordCount);
 124}
Generated by: ReportGenerator 5.3.8.0
9/19/2024 - 12:16:35 AM
GitHub | reportgenerator.io

Methods/Properties

.ctor(MediaBrowser.Controller.Dto.IDtoService,MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Library.ILibraryManager)
GetSuggestions(System.Nullable`1<System.Guid>,Jellyfin.Data.Enums.MediaType[],Jellyfin.Data.Enums.BaseItemKind[],System.Nullable`1<System.Int32>,System.Nullable`1<System.Int32>,System.Boolean)