< Summary - Jellyfin

Information
Class: Jellyfin.Data.UserEntityExtensions
Assembly: Jellyfin.Data
File(s): /srv/git/jellyfin/Jellyfin.Data/UserEntityExtensions.cs
Line coverage
63%
Covered lines: 46
Uncovered lines: 26
Coverable lines: 72
Total lines: 220
Line coverage: 63.8%
Branch coverage
42%
Covered branches: 12
Total branches: 28
Branch coverage: 42.8%
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
HasPermission(...)50%22100%
SetPermission(...)50%2280%
GetPreference(...)50%44100%
GetPreferenceValues(...)25%41820%
SetPreference(...)0%620%
SetPreference(...)0%620%
IsParentalScheduleAllowed(...)100%22100%
IsFolderGrouped(...)100%210%
AddDefaultPermissions(...)100%11100%
AddDefaultPreferences(...)100%22100%
IsParentalScheduleAllowed(...)50%44100%

File(s)

/srv/git/jellyfin/Jellyfin.Data/UserEntityExtensions.cs

#LineLine coverage
 1using System;
 2using System.ComponentModel;
 3using System.Linq;
 4using Jellyfin.Database.Implementations.Entities;
 5using Jellyfin.Database.Implementations.Enums;
 6using Jellyfin.Database.Implementations.Interfaces;
 7
 8namespace Jellyfin.Data;
 9
 10/// <summary>
 11/// Contains extension methods for manipulation of <see cref="User"/> entities.
 12/// </summary>
 13public static class UserEntityExtensions
 14{
 15    /// <summary>
 16    /// The values being delimited here are Guids, so commas work as they do not appear in Guids.
 17    /// </summary>
 18    private const char Delimiter = ',';
 19
 20    /// <summary>
 21    /// Checks whether the user has the specified permission.
 22    /// </summary>
 23    /// <param name="entity">The entity to update.</param>
 24    /// <param name="kind">The permission kind.</param>
 25    /// <returns><c>True</c> if the user has the specified permission.</returns>
 26    public static bool HasPermission(this IHasPermissions entity, PermissionKind kind)
 27    {
 115228        return entity.Permissions.FirstOrDefault(p => p.Kind == kind)?.Value ?? false;
 29    }
 30
 31    /// <summary>
 32    /// Sets the given permission kind to the provided value.
 33    /// </summary>
 34    /// <param name="entity">The entity to update.</param>
 35    /// <param name="kind">The permission kind.</param>
 36    /// <param name="value">The value to set.</param>
 37    public static void SetPermission(this IHasPermissions entity, PermissionKind kind, bool value)
 38    {
 6939        var currentPermission = entity.Permissions.FirstOrDefault(p => p.Kind == kind);
 6940        if (currentPermission is null)
 41        {
 042            entity.Permissions.Add(new Permission(kind, value));
 43        }
 44        else
 45        {
 6946            currentPermission.Value = value;
 47        }
 6948    }
 49
 50    /// <summary>
 51    /// Gets the user's preferences for the given preference kind.
 52    /// </summary>
 53    /// <param name="entity">The entity to update.</param>
 54    /// <param name="preference">The preference kind.</param>
 55    /// <returns>A string array containing the user's preferences.</returns>
 56    public static string[] GetPreference(this User entity, PreferenceKind preference)
 57    {
 20458        var val = entity.Preferences.FirstOrDefault(p => p.Kind == preference)?.Value;
 59
 20460        return string.IsNullOrEmpty(val) ? Array.Empty<string>() : val.Split(Delimiter);
 61    }
 62
 63    /// <summary>
 64    /// Gets the user's preferences for the given preference kind.
 65    /// </summary>
 66    /// <param name="entity">The entity to update.</param>
 67    /// <param name="preference">The preference kind.</param>
 68    /// <typeparam name="T">Type of preference.</typeparam>
 69    /// <returns>A {T} array containing the user's preference.</returns>
 70    public static T[] GetPreferenceValues<T>(this User entity, PreferenceKind preference)
 71    {
 34472        var val = entity.Preferences.FirstOrDefault(p => p.Kind == preference)?.Value;
 34473        if (string.IsNullOrEmpty(val))
 74        {
 34475            return Array.Empty<T>();
 76        }
 77
 78        // Convert array of {string} to array of {T}
 079        var converter = TypeDescriptor.GetConverter(typeof(T));
 080        var stringValues = val.Split(Delimiter);
 081        var convertedCount = 0;
 082        var parsedValues = new T[stringValues.Length];
 083        for (var i = 0; i < stringValues.Length; i++)
 84        {
 85            try
 86            {
 087                var parsedValue = converter.ConvertFromString(stringValues[i].Trim());
 088                if (parsedValue is not null)
 89                {
 090                    parsedValues[convertedCount++] = (T)parsedValue;
 91                }
 092            }
 093            catch (FormatException)
 94            {
 95                // Unable to convert value
 096            }
 97        }
 98
 099        return parsedValues[..convertedCount];
 100    }
 101
 102    /// <summary>
 103    /// Sets the specified preference to the given value.
 104    /// </summary>
 105    /// <param name="entity">The entity to update.</param>
 106    /// <param name="preference">The preference kind.</param>
 107    /// <param name="values">The values.</param>
 108    public static void SetPreference(this User entity, PreferenceKind preference, string[] values)
 109    {
 0110        var value = string.Join(Delimiter, values);
 0111        var currentPreference = entity.Preferences.FirstOrDefault(p => p.Kind == preference);
 0112        if (currentPreference is null)
 113        {
 0114            entity.Preferences.Add(new Preference(preference, value));
 115        }
 116        else
 117        {
 0118            currentPreference.Value = value;
 119        }
 0120    }
 121
 122    /// <summary>
 123    /// Sets the specified preference to the given value.
 124    /// </summary>
 125    /// <param name="entity">The entity to update.</param>
 126    /// <param name="preference">The preference kind.</param>
 127    /// <param name="values">The values.</param>
 128    /// <typeparam name="T">The type of value.</typeparam>
 129    public static void SetPreference<T>(this User entity, PreferenceKind preference, T[] values)
 130    {
 0131        var value = string.Join(Delimiter, values);
 0132        var currentPreference = entity.Preferences.FirstOrDefault(p => p.Kind == preference);
 0133        if (currentPreference is null)
 134        {
 0135            entity.Preferences.Add(new Preference(preference, value));
 136        }
 137        else
 138        {
 0139            currentPreference.Value = value;
 140        }
 0141    }
 142
 143    /// <summary>
 144    /// Checks whether this user is currently allowed to use the server.
 145    /// </summary>
 146    /// <param name="entity">The entity to update.</param>
 147    /// <returns><c>True</c> if the current time is within an access schedule, or there are no access schedules.</return
 148    public static bool IsParentalScheduleAllowed(this User entity)
 149    {
 18150        return entity.AccessSchedules.Count == 0
 18151               || entity.AccessSchedules.Any(i => IsParentalScheduleAllowed(i, DateTime.UtcNow));
 152    }
 153
 154    /// <summary>
 155    /// Checks whether the provided folder is in this user's grouped folders.
 156    /// </summary>
 157    /// <param name="entity">The entity to update.</param>
 158    /// <param name="id">The Guid of the folder.</param>
 159    /// <returns><c>True</c> if the folder is in the user's grouped folders.</returns>
 160    public static bool IsFolderGrouped(this User entity, Guid id)
 161    {
 0162        return Array.IndexOf(GetPreferenceValues<Guid>(entity, PreferenceKind.GroupedFolders), id) != -1;
 163    }
 164
 165    /// <summary>
 166    /// Initializes the default permissions for a user. Should only be called on user creation.
 167    /// </summary>
 168    /// <param name="entity">The entity to update.</param>
 169    // TODO: make these user configurable?
 170    public static void AddDefaultPermissions(this User entity)
 171    {
 38172        entity.Permissions.Add(new Permission(PermissionKind.IsAdministrator, false));
 38173        entity.Permissions.Add(new Permission(PermissionKind.IsDisabled, false));
 38174        entity.Permissions.Add(new Permission(PermissionKind.IsHidden, true));
 38175        entity.Permissions.Add(new Permission(PermissionKind.EnableAllChannels, true));
 38176        entity.Permissions.Add(new Permission(PermissionKind.EnableAllDevices, true));
 38177        entity.Permissions.Add(new Permission(PermissionKind.EnableAllFolders, true));
 38178        entity.Permissions.Add(new Permission(PermissionKind.EnableContentDeletion, false));
 38179        entity.Permissions.Add(new Permission(PermissionKind.EnableContentDownloading, true));
 38180        entity.Permissions.Add(new Permission(PermissionKind.EnableMediaConversion, true));
 38181        entity.Permissions.Add(new Permission(PermissionKind.EnableMediaPlayback, true));
 38182        entity.Permissions.Add(new Permission(PermissionKind.EnablePlaybackRemuxing, true));
 38183        entity.Permissions.Add(new Permission(PermissionKind.EnablePublicSharing, true));
 38184        entity.Permissions.Add(new Permission(PermissionKind.EnableRemoteAccess, true));
 38185        entity.Permissions.Add(new Permission(PermissionKind.EnableSyncTranscoding, true));
 38186        entity.Permissions.Add(new Permission(PermissionKind.EnableAudioPlaybackTranscoding, true));
 38187        entity.Permissions.Add(new Permission(PermissionKind.EnableLiveTvAccess, true));
 38188        entity.Permissions.Add(new Permission(PermissionKind.EnableLiveTvManagement, true));
 38189        entity.Permissions.Add(new Permission(PermissionKind.EnableSharedDeviceControl, true));
 38190        entity.Permissions.Add(new Permission(PermissionKind.EnableVideoPlaybackTranscoding, true));
 38191        entity.Permissions.Add(new Permission(PermissionKind.ForceRemoteSourceTranscoding, false));
 38192        entity.Permissions.Add(new Permission(PermissionKind.EnableRemoteControlOfOtherUsers, false));
 38193        entity.Permissions.Add(new Permission(PermissionKind.EnableCollectionManagement, false));
 38194        entity.Permissions.Add(new Permission(PermissionKind.EnableSubtitleManagement, false));
 38195        entity.Permissions.Add(new Permission(PermissionKind.EnableLyricManagement, false));
 38196    }
 197
 198    /// <summary>
 199    /// Initializes the default preferences. Should only be called on user creation.
 200    /// </summary>
 201    /// <param name="entity">The entity to update.</param>
 202    public static void AddDefaultPreferences(this User entity)
 203    {
 1064204        foreach (var val in Enum.GetValues<PreferenceKind>())
 205        {
 494206            entity.Preferences.Add(new Preference(val, string.Empty));
 207        }
 38208    }
 209
 210    private static bool IsParentalScheduleAllowed(AccessSchedule schedule, DateTime date)
 211    {
 1212        var localTime = date.ToLocalTime();
 1213        var hour = localTime.TimeOfDay.TotalHours;
 1214        var currentDayOfWeek = localTime.DayOfWeek;
 215
 1216        return schedule.DayOfWeek.Contains(currentDayOfWeek)
 1217               && hour >= schedule.StartHour
 1218               && hour <= schedule.EndHour;
 219    }
 220}
Generated by: ReportGenerator 5.4.5.0
4/3/2025 - 12:11:21 AM
GitHub | reportgenerator.io

Methods/Properties

HasPermission(Jellyfin.Database.Implementations.Interfaces.IHasPermissions,Jellyfin.Database.Implementations.Enums.PermissionKind)
SetPermission(Jellyfin.Database.Implementations.Interfaces.IHasPermissions,Jellyfin.Database.Implementations.Enums.PermissionKind,System.Boolean)
GetPreference(Jellyfin.Database.Implementations.Entities.User,Jellyfin.Database.Implementations.Enums.PreferenceKind)
GetPreferenceValues(Jellyfin.Database.Implementations.Entities.User,Jellyfin.Database.Implementations.Enums.PreferenceKind)
SetPreference(Jellyfin.Database.Implementations.Entities.User,Jellyfin.Database.Implementations.Enums.PreferenceKind,System.String[])
SetPreference(Jellyfin.Database.Implementations.Entities.User,Jellyfin.Database.Implementations.Enums.PreferenceKind,T[])
IsParentalScheduleAllowed(Jellyfin.Database.Implementations.Entities.User)
IsFolderGrouped(Jellyfin.Database.Implementations.Entities.User,System.Guid)
AddDefaultPermissions(Jellyfin.Database.Implementations.Entities.User)
AddDefaultPreferences(Jellyfin.Database.Implementations.Entities.User)
IsParentalScheduleAllowed(Jellyfin.Database.Implementations.Entities.AccessSchedule,System.DateTime)