< Summary - Jellyfin

Information
Class: Jellyfin.Api.Helpers.RequestHelpers
Assembly: Jellyfin.Api
File(s): /srv/git/jellyfin/Jellyfin.Api/Helpers/RequestHelpers.cs
Line coverage
45%
Covered lines: 22
Uncovered lines: 26
Coverable lines: 48
Total lines: 179
Line coverage: 45.8%
Branch coverage
90%
Covered branches: 18
Total branches: 20
Branch coverage: 90%
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
GetOrderBy(...)100%88100%
GetUserId(...)100%66100%
AssertCanUpdateUser(...)66.66%7671.42%
CreateQueryResult(...)100%210%

File(s)

/srv/git/jellyfin/Jellyfin.Api/Helpers/RequestHelpers.cs

#LineLine coverage
 1using System;
 2using System.Collections.Generic;
 3using System.Linq;
 4using System.Security.Claims;
 5using System.Threading.Tasks;
 6using Jellyfin.Api.Constants;
 7using Jellyfin.Api.Extensions;
 8using Jellyfin.Data.Enums;
 9using Jellyfin.Database.Implementations.Entities;
 10using Jellyfin.Database.Implementations.Enums;
 11using Jellyfin.Extensions;
 12using MediaBrowser.Common.Extensions;
 13using MediaBrowser.Controller.Dto;
 14using MediaBrowser.Controller.Entities;
 15using MediaBrowser.Controller.Library;
 16using MediaBrowser.Controller.Net;
 17using MediaBrowser.Controller.Session;
 18using MediaBrowser.Model.Dto;
 19using MediaBrowser.Model.Querying;
 20using Microsoft.AspNetCore.Http;
 21
 22namespace Jellyfin.Api.Helpers;
 23
 24/// <summary>
 25/// Request Extensions.
 26/// </summary>
 27public static class RequestHelpers
 28{
 29    /// <summary>
 30    /// Get Order By.
 31    /// </summary>
 32    /// <param name="sortBy">Sort By. Comma delimited string.</param>
 33    /// <param name="requestedSortOrder">Sort Order. Comma delimited string.</param>
 34    /// <returns>Order By.</returns>
 35    public static (ItemSortBy, SortOrder)[] GetOrderBy(IReadOnlyList<ItemSortBy> sortBy, IReadOnlyList<SortOrder> reques
 36    {
 337        if (sortBy.Count == 0)
 38        {
 139            return Array.Empty<(ItemSortBy, SortOrder)>();
 40        }
 41
 242        var result = new (ItemSortBy, SortOrder)[sortBy.Count];
 243        var i = 0;
 44        // Add elements which have a SortOrder specified
 445        for (; i < requestedSortOrder.Count; i++)
 46        {
 147            result[i] = (sortBy[i], requestedSortOrder[i]);
 48        }
 49
 50        // Add remaining elements with the first specified SortOrder
 51        // or the default one if no SortOrders are specified
 252        var order = requestedSortOrder.Count > 0 ? requestedSortOrder[0] : SortOrder.Ascending;
 853        for (; i < sortBy.Count; i++)
 54        {
 355            result[i] = (sortBy[i], order);
 56        }
 57
 258        return result;
 59    }
 60
 61    /// <summary>
 62    /// Checks if the user can access a user.
 63    /// </summary>
 64    /// <param name="claimsPrincipal">The <see cref="ClaimsPrincipal"/> for the current request.</param>
 65    /// <param name="userId">The user id.</param>
 66    /// <returns>A <see cref="bool"/> whether the user can access the user.</returns>
 67    internal static Guid GetUserId(ClaimsPrincipal claimsPrincipal, Guid? userId)
 68    {
 4269        var authenticatedUserId = claimsPrincipal.GetUserId();
 70
 71        // UserId not provided, fall back to authenticated user id.
 4272        if (userId.IsNullOrEmpty())
 73        {
 1674            return authenticatedUserId;
 75        }
 76
 77        // User must be administrator to access another user.
 2678        var isAdministrator = claimsPrincipal.IsInRole(UserRoles.Administrator);
 2679        if (!userId.Value.Equals(authenticatedUserId) && !isAdministrator)
 80        {
 181            throw new SecurityException("Forbidden");
 82        }
 83
 2584        return userId.Value;
 85    }
 86
 87    /// <summary>
 88    /// Checks if the user can update an entry.
 89    /// </summary>
 90    /// <param name="claimsPrincipal">The <see cref="ClaimsPrincipal"/> for the current request.</param>
 91    /// <param name="user">The user id.</param>
 92    /// <param name="restrictUserPreferences">Whether to restrict the user preferences.</param>
 93    /// <returns>A <see cref="bool"/> whether the user can update the entry.</returns>
 94    internal static bool AssertCanUpdateUser(ClaimsPrincipal claimsPrincipal, User user, bool restrictUserPreferences)
 95    {
 296        var authenticatedUserId = claimsPrincipal.GetUserId();
 297        var isAdministrator = claimsPrincipal.IsInRole(UserRoles.Administrator);
 98
 99        // If they're going to update the record of another user, they must be an administrator
 2100        if (!user.Id.Equals(authenticatedUserId) && !isAdministrator)
 101        {
 0102            return false;
 103        }
 104
 105        // TODO the EnableUserPreferenceAccess policy does not seem to be used elsewhere
 2106        if (!restrictUserPreferences || isAdministrator)
 107        {
 2108            return true;
 109        }
 110
 0111        return user.EnableUserPreferenceAccess;
 112    }
 113
 114    internal static async Task<SessionInfo> GetSession(ISessionManager sessionManager, IUserManager userManager, HttpCon
 115    {
 116        userId ??= httpContext.User.GetUserId();
 117        User? user = null;
 118        if (!userId.IsNullOrEmpty())
 119        {
 120            user = userManager.GetUserById(userId.Value);
 121        }
 122
 123        var session = await sessionManager.LogSessionActivity(
 124            httpContext.User.GetClient(),
 125            httpContext.User.GetVersion(),
 126            httpContext.User.GetDeviceId(),
 127            httpContext.User.GetDevice(),
 128            httpContext.GetNormalizedRemoteIP().ToString(),
 129            user).ConfigureAwait(false);
 130
 131        if (session is null)
 132        {
 133            throw new ResourceNotFoundException("Session not found.");
 134        }
 135
 136        return session;
 137    }
 138
 139    internal static async Task<string> GetSessionId(ISessionManager sessionManager, IUserManager userManager, HttpContex
 140    {
 141        var session = await GetSession(sessionManager, userManager, httpContext).ConfigureAwait(false);
 142
 143        return session.Id;
 144    }
 145
 146    internal static QueryResult<BaseItemDto> CreateQueryResult(
 147        QueryResult<(BaseItem Item, ItemCounts ItemCounts)> result,
 148        DtoOptions dtoOptions,
 149        IDtoService dtoService,
 150        bool includeItemTypes,
 151        User? user)
 152    {
 0153        var dtos = result.Items.Select(i =>
 0154        {
 0155            var (baseItem, counts) = i;
 0156            var dto = dtoService.GetItemByNameDto(baseItem, dtoOptions, null, user);
 0157
 0158            if (includeItemTypes)
 0159            {
 0160                dto.ChildCount = counts.ItemCount;
 0161                dto.ProgramCount = counts.ProgramCount;
 0162                dto.SeriesCount = counts.SeriesCount;
 0163                dto.EpisodeCount = counts.EpisodeCount;
 0164                dto.MovieCount = counts.MovieCount;
 0165                dto.TrailerCount = counts.TrailerCount;
 0166                dto.AlbumCount = counts.AlbumCount;
 0167                dto.SongCount = counts.SongCount;
 0168                dto.ArtistCount = counts.ArtistCount;
 0169            }
 0170
 0171            return dto;
 0172        });
 173
 0174        return new QueryResult<BaseItemDto>(
 0175            result.StartIndex,
 0176            result.TotalRecordCount,
 0177            dtos.ToArray());
 178    }
 179}
Generated by: ReportGenerator 5.4.5.0
4/3/2025 - 12:11:21 AM
GitHub | reportgenerator.io

Methods/Properties

GetOrderBy(System.Collections.Generic.IReadOnlyList`1<Jellyfin.Data.Enums.ItemSortBy>,System.Collections.Generic.IReadOnlyList`1<Jellyfin.Database.Implementations.Enums.SortOrder>)
GetUserId(System.Security.Claims.ClaimsPrincipal,System.Nullable`1<System.Guid>)
AssertCanUpdateUser(System.Security.Claims.ClaimsPrincipal,Jellyfin.Database.Implementations.Entities.User,System.Boolean)
CreateQueryResult(MediaBrowser.Model.Querying.QueryResult`1<System.ValueTuple`2<MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Model.Dto.ItemCounts>>,MediaBrowser.Controller.Dto.DtoOptions,MediaBrowser.Controller.Dto.IDtoService,System.Boolean,Jellyfin.Database.Implementations.Entities.User)