< Summary - Jellyfin

Information
Class: Jellyfin.Database.Implementations.Entities.User
Assembly: Jellyfin.Database.Implementations
File(s): /srv/git/jellyfin/src/Jellyfin.Database/Jellyfin.Database.Implementations/Entities/User.cs
Line coverage
92%
Covered lines: 26
Uncovered lines: 2
Coverable lines: 28
Total lines: 341
Line coverage: 92.8%
Branch coverage
N/A
Covered branches: 0
Total branches: 0
Branch coverage: N/A
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%11100%
OnSavingChanges()100%210%

File(s)

/srv/git/jellyfin/src/Jellyfin.Database/Jellyfin.Database.Implementations/Entities/User.cs

#LineLine coverage
 1using System;
 2using System.Collections.Generic;
 3using System.ComponentModel.DataAnnotations;
 4using System.ComponentModel.DataAnnotations.Schema;
 5using System.Text.Json.Serialization;
 6using Jellyfin.Database.Implementations.Enums;
 7using Jellyfin.Database.Implementations.Interfaces;
 8
 9namespace Jellyfin.Database.Implementations.Entities
 10{
 11    /// <summary>
 12    /// An entity representing a user.
 13    /// </summary>
 14    public class User : IHasPermissions, IHasConcurrencyToken
 15    {
 16        /// <summary>
 17        /// Initializes a new instance of the <see cref="User"/> class.
 18        /// Public constructor with required data.
 19        /// </summary>
 20        /// <param name="username">The username for the new user.</param>
 21        /// <param name="authenticationProviderId">The Id of the user's authentication provider.</param>
 22        /// <param name="passwordResetProviderId">The Id of the user's password reset provider.</param>
 23        public User(string username, string authenticationProviderId, string passwordResetProviderId)
 24        {
 5325            ArgumentException.ThrowIfNullOrEmpty(username);
 5326            ArgumentException.ThrowIfNullOrEmpty(authenticationProviderId);
 5327            ArgumentException.ThrowIfNullOrEmpty(passwordResetProviderId);
 28
 5329            Username = username;
 5330            AuthenticationProviderId = authenticationProviderId;
 5331            PasswordResetProviderId = passwordResetProviderId;
 32
 5333            AccessSchedules = new HashSet<AccessSchedule>();
 5334            DisplayPreferences = new HashSet<DisplayPreferences>();
 5335            ItemDisplayPreferences = new HashSet<ItemDisplayPreferences>();
 36            // Groups = new HashSet<Group>();
 5337            Permissions = new HashSet<Permission>();
 5338            Preferences = new HashSet<Preference>();
 39            // ProviderMappings = new HashSet<ProviderMapping>();
 40
 41            // Set default values
 5342            Id = Guid.NewGuid();
 5343            InvalidLoginAttemptCount = 0;
 5344            EnableUserPreferenceAccess = true;
 5345            MustUpdatePassword = false;
 5346            DisplayMissingEpisodes = false;
 5347            DisplayCollectionsView = false;
 5348            HidePlayedInLatest = true;
 5349            RememberAudioSelections = true;
 5350            RememberSubtitleSelections = true;
 5351            EnableNextEpisodeAutoPlay = true;
 5352            EnableAutoLogin = false;
 5353            PlayDefaultAudioTrack = true;
 5354            SubtitleMode = SubtitlePlaybackMode.Default;
 5355            SyncPlayAccess = SyncPlayUserAccessType.CreateAndJoinGroups;
 5356        }
 57
 58        /// <summary>
 59        /// Gets or sets the Id of the user.
 60        /// </summary>
 61        /// <remarks>
 62        /// Identity, Indexed, Required.
 63        /// </remarks>
 64        [JsonIgnore]
 65        public Guid Id { get; set; }
 66
 67        /// <summary>
 68        /// Gets or sets the user's name.
 69        /// </summary>
 70        /// <remarks>
 71        /// Required, Max length = 255.
 72        /// </remarks>
 73        [MaxLength(255)]
 74        [StringLength(255)]
 75        public string Username { get; set; }
 76
 77        /// <summary>
 78        /// Gets or sets the user's password, or <c>null</c> if none is set.
 79        /// </summary>
 80        /// <remarks>
 81        /// Max length = 65535.
 82        /// </remarks>
 83        [MaxLength(65535)]
 84        [StringLength(65535)]
 85        public string? Password { get; set; }
 86
 87        /// <summary>
 88        /// Gets or sets a value indicating whether the user must update their password.
 89        /// </summary>
 90        /// <remarks>
 91        /// Required.
 92        /// </remarks>
 93        public bool MustUpdatePassword { get; set; }
 94
 95        /// <summary>
 96        /// Gets or sets the audio language preference.
 97        /// </summary>
 98        /// <remarks>
 99        /// Max length = 255.
 100        /// </remarks>
 101        [MaxLength(255)]
 102        [StringLength(255)]
 103        public string? AudioLanguagePreference { get; set; }
 104
 105        /// <summary>
 106        /// Gets or sets the authentication provider id.
 107        /// </summary>
 108        /// <remarks>
 109        /// Required, Max length = 255.
 110        /// </remarks>
 111        [MaxLength(255)]
 112        [StringLength(255)]
 113        public string AuthenticationProviderId { get; set; }
 114
 115        /// <summary>
 116        /// Gets or sets the password reset provider id.
 117        /// </summary>
 118        /// <remarks>
 119        /// Required, Max length = 255.
 120        /// </remarks>
 121        [MaxLength(255)]
 122        [StringLength(255)]
 123        public string PasswordResetProviderId { get; set; }
 124
 125        /// <summary>
 126        /// Gets or sets the invalid login attempt count.
 127        /// </summary>
 128        /// <remarks>
 129        /// Required.
 130        /// </remarks>
 131        public int InvalidLoginAttemptCount { get; set; }
 132
 133        /// <summary>
 134        /// Gets or sets the last activity date.
 135        /// </summary>
 136        public DateTime? LastActivityDate { get; set; }
 137
 138        /// <summary>
 139        /// Gets or sets the last login date.
 140        /// </summary>
 141        public DateTime? LastLoginDate { get; set; }
 142
 143        /// <summary>
 144        /// Gets or sets the number of login attempts the user can make before they are locked out.
 145        /// </summary>
 146        public int? LoginAttemptsBeforeLockout { get; set; }
 147
 148        /// <summary>
 149        /// Gets or sets the maximum number of active sessions the user can have at once.
 150        /// </summary>
 151        public int MaxActiveSessions { get; set; }
 152
 153        /// <summary>
 154        /// Gets or sets the subtitle mode.
 155        /// </summary>
 156        /// <remarks>
 157        /// Required.
 158        /// </remarks>
 159        public SubtitlePlaybackMode SubtitleMode { get; set; }
 160
 161        /// <summary>
 162        /// Gets or sets a value indicating whether the default audio track should be played.
 163        /// </summary>
 164        /// <remarks>
 165        /// Required.
 166        /// </remarks>
 167        public bool PlayDefaultAudioTrack { get; set; }
 168
 169        /// <summary>
 170        /// Gets or sets the subtitle language preference.
 171        /// </summary>
 172        /// <remarks>
 173        /// Max length = 255.
 174        /// </remarks>
 175        [MaxLength(255)]
 176        [StringLength(255)]
 177        public string? SubtitleLanguagePreference { get; set; }
 178
 179        /// <summary>
 180        /// Gets or sets a value indicating whether missing episodes should be displayed.
 181        /// </summary>
 182        /// <remarks>
 183        /// Required.
 184        /// </remarks>
 185        public bool DisplayMissingEpisodes { get; set; }
 186
 187        /// <summary>
 188        /// Gets or sets a value indicating whether to display the collections view.
 189        /// </summary>
 190        /// <remarks>
 191        /// Required.
 192        /// </remarks>
 193        public bool DisplayCollectionsView { get; set; }
 194
 195        /// <summary>
 196        /// Gets or sets a value indicating whether the user has a local password.
 197        /// </summary>
 198        /// <remarks>
 199        /// Required.
 200        /// </remarks>
 201        public bool EnableLocalPassword { get; set; }
 202
 203        /// <summary>
 204        /// Gets or sets a value indicating whether the server should hide played content in "Latest".
 205        /// </summary>
 206        /// <remarks>
 207        /// Required.
 208        /// </remarks>
 209        public bool HidePlayedInLatest { get; set; }
 210
 211        /// <summary>
 212        /// Gets or sets a value indicating whether to remember audio selections on played content.
 213        /// </summary>
 214        /// <remarks>
 215        /// Required.
 216        /// </remarks>
 217        public bool RememberAudioSelections { get; set; }
 218
 219        /// <summary>
 220        /// Gets or sets a value indicating whether to remember subtitle selections on played content.
 221        /// </summary>
 222        /// <remarks>
 223        /// Required.
 224        /// </remarks>
 225        public bool RememberSubtitleSelections { get; set; }
 226
 227        /// <summary>
 228        /// Gets or sets a value indicating whether to enable auto-play for the next episode.
 229        /// </summary>
 230        /// <remarks>
 231        /// Required.
 232        /// </remarks>
 233        public bool EnableNextEpisodeAutoPlay { get; set; }
 234
 235        /// <summary>
 236        /// Gets or sets a value indicating whether the user should auto-login.
 237        /// </summary>
 238        /// <remarks>
 239        /// Required.
 240        /// </remarks>
 241        public bool EnableAutoLogin { get; set; }
 242
 243        /// <summary>
 244        /// Gets or sets a value indicating whether the user can change their preferences.
 245        /// </summary>
 246        /// <remarks>
 247        /// Required.
 248        /// </remarks>
 249        public bool EnableUserPreferenceAccess { get; set; }
 250
 251        /// <summary>
 252        /// Gets or sets the maximum parental rating score.
 253        /// </summary>
 254        public int? MaxParentalRatingScore { get; set; }
 255
 256        /// <summary>
 257        /// Gets or sets the maximum parental rating sub score.
 258        /// </summary>
 259        public int? MaxParentalRatingSubScore { get; set; }
 260
 261        /// <summary>
 262        /// Gets or sets the remote client bitrate limit.
 263        /// </summary>
 264        public int? RemoteClientBitrateLimit { get; set; }
 265
 266        /// <summary>
 267        /// Gets or sets the internal id.
 268        /// This is a temporary stopgap for until the library db is migrated.
 269        /// This corresponds to the value of the index of this user in the library db.
 270        /// </summary>
 271        public long InternalId { get; set; }
 272
 273        /// <summary>
 274        /// Gets or sets the user's profile image. Can be <c>null</c>.
 275        /// </summary>
 276        // [ForeignKey("UserId")]
 277        public virtual ImageInfo? ProfileImage { get; set; }
 278
 279        /// <summary>
 280        /// Gets the user's display preferences.
 281        /// </summary>
 282        public virtual ICollection<DisplayPreferences> DisplayPreferences { get; private set; }
 283
 284        /// <summary>
 285        /// Gets or sets the level of sync play permissions this user has.
 286        /// </summary>
 287        public SyncPlayUserAccessType SyncPlayAccess { get; set; }
 288
 289        /// <summary>
 290        /// Gets or sets the cast receiver id.
 291        /// </summary>
 292        [StringLength(32)]
 293        public string? CastReceiverId { get; set; }
 294
 295        /// <inheritdoc />
 296        [ConcurrencyCheck]
 297        public uint RowVersion { get; private set; }
 298
 299        /// <summary>
 300        /// Gets the list of access schedules this user has.
 301        /// </summary>
 302        public virtual ICollection<AccessSchedule> AccessSchedules { get; private set; }
 303
 304        /// <summary>
 305        /// Gets the list of item display preferences.
 306        /// </summary>
 307        public virtual ICollection<ItemDisplayPreferences> ItemDisplayPreferences { get; private set; }
 308
 309        /*
 310        /// <summary>
 311        /// Gets the list of groups this user is a member of.
 312        /// </summary>
 313        public virtual ICollection<Group> Groups { get; private set; }
 314        */
 315
 316        /// <summary>
 317        /// Gets the list of permissions this user has.
 318        /// </summary>
 319        [ForeignKey("Permission_Permissions_Guid")]
 320        public virtual ICollection<Permission> Permissions { get; private set; }
 321
 322        /*
 323        /// <summary>
 324        /// Gets the list of provider mappings this user has.
 325        /// </summary>
 326        public virtual ICollection<ProviderMapping> ProviderMappings { get; private set; }
 327        */
 328
 329        /// <summary>
 330        /// Gets the list of preferences this user has.
 331        /// </summary>
 332        [ForeignKey("Preference_Preferences_Guid")]
 333        public virtual ICollection<Preference> Preferences { get; private set; }
 334
 335        /// <inheritdoc/>
 336        public void OnSavingChanges()
 337        {
 0338            RowVersion++;
 0339        }
 340    }
 341}
Generated by: ReportGenerator 5.4.5.0
4/26/2025 - 12:10:59 AM
GitHub | reportgenerator.io

Methods/Properties

.ctor(System.String,System.String,System.String)
OnSavingChanges()