diff options
| -rw-r--r-- | Emby.Server.Implementations/Devices/DeviceManager.cs | 9 | ||||
| -rw-r--r-- | Jellyfin.Data/Entities/User.cs | 219 | ||||
| -rw-r--r-- | Jellyfin.Server.Implementations/Users/UserManager.cs | 6 |
3 files changed, 194 insertions, 40 deletions
diff --git a/Emby.Server.Implementations/Devices/DeviceManager.cs b/Emby.Server.Implementations/Devices/DeviceManager.cs index 2d44a7c28..a3c53035f 100644 --- a/Emby.Server.Implementations/Devices/DeviceManager.cs +++ b/Emby.Server.Implementations/Devices/DeviceManager.cs @@ -5,13 +5,11 @@ using System.Collections.Generic; using System.Globalization; using System.IO; using System.Linq; -using System.Threading.Tasks; using Jellyfin.Data.Enums; using Jellyfin.Data.Entities; using MediaBrowser.Common.Extensions; using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Devices; -using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Library; using MediaBrowser.Controller.Security; using MediaBrowser.Model.Devices; @@ -19,7 +17,6 @@ using MediaBrowser.Model.Events; using MediaBrowser.Model.Querying; using MediaBrowser.Model.Serialization; using MediaBrowser.Model.Session; -using MediaBrowser.Model.Users; namespace Emby.Server.Implementations.Devices { @@ -30,11 +27,10 @@ namespace Emby.Server.Implementations.Devices private readonly IServerConfigurationManager _config; private readonly IAuthenticationRepository _authRepo; private readonly Dictionary<string, ClientCapabilities> _capabilitiesCache; + private readonly object _capabilitiesSyncLock = new object(); public event EventHandler<GenericEventArgs<Tuple<string, DeviceOptions>>> DeviceOptionsUpdated; - private readonly object _capabilitiesSyncLock = new object(); - public DeviceManager( IAuthenticationRepository authRepo, IJsonSerializer json, @@ -184,8 +180,7 @@ namespace Emby.Server.Implementations.Devices throw new ArgumentNullException(nameof(deviceId)); } - if (user.HasPermission(PermissionKind.EnableAllDevices) - || user.HasPermission(PermissionKind.IsAdministrator)) + if (user.HasPermission(PermissionKind.EnableAllDevices) || user.HasPermission(PermissionKind.IsAdministrator)) { return true; } diff --git a/Jellyfin.Data/Entities/User.cs b/Jellyfin.Data/Entities/User.cs index dd1dcfc6f..afda6169c 100644 --- a/Jellyfin.Data/Entities/User.cs +++ b/Jellyfin.Data/Entities/User.cs @@ -24,7 +24,8 @@ namespace Jellyfin.Data.Entities /// Public constructor with required data. /// </summary> /// <param name="username">The username for the new user.</param> - /// <param name="authenticationProviderId">The authentication provider's Id</param> + /// <param name="authenticationProviderId">The Id of the user's authentication provider.</param> + /// <param name="passwordResetProviderId">The Id of the user's password reset provider.</param> public User(string username, string authenticationProviderId, string passwordResetProviderId) { if (string.IsNullOrEmpty(username)) @@ -81,139 +82,234 @@ namespace Jellyfin.Data.Entities Init(); } - /// <summary> - /// Static create function (for use in LINQ queries, etc.) - /// </summary> - /// <param name="username">The username for the created user.</param> - /// <param name="authenticationProviderId">The Id of the user's authentication provider.</param> - /// <param name="passwordResetProviderId">The Id of the user's password reset provider.</param> - /// <returns>The created instance.</returns> - public static User Create(string username, string authenticationProviderId, string passwordResetProviderId) - { - return new User(username, authenticationProviderId, passwordResetProviderId); - } - /************************************************************************* * Properties *************************************************************************/ /// <summary> - /// Identity, Indexed, Required + /// Gets or sets the Id of the user. /// </summary> + /// <remarks> + /// Identity, Indexed, Required. + /// </remarks> [Key] [Required] [JsonIgnore] public Guid Id { get; set; } /// <summary> - /// Required, Max length = 255 + /// Gets or sets the user's name. /// </summary> + /// <remarks> + /// Required, Max length = 255. + /// </remarks> [Required] [MaxLength(255)] [StringLength(255)] public string Username { get; set; } /// <summary> - /// Max length = 65535 + /// Gets or sets the user's password, or <c>null</c> if none is set. /// </summary> + /// <remarks> + /// Max length = 65535. + /// </remarks> [MaxLength(65535)] [StringLength(65535)] public string Password { get; set; } /// <summary> - /// Max length = 65535. + /// Gets or sets the user's easy password, or <c>null</c> if none is set. /// </summary> + /// <remarks> + /// Max length = 65535. + /// </remarks> [MaxLength(65535)] [StringLength(65535)] public string EasyPassword { get; set; } /// <summary> - /// Required + /// Gets or sets a value indicating whether the user must update their password. /// </summary> + /// <remarks> + /// Required. + /// </remarks> [Required] public bool MustUpdatePassword { get; set; } /// <summary> - /// Max length = 255. + /// Gets or sets the audio language preference. /// </summary> + /// <remarks> + /// Max length = 255. + /// </remarks> [MaxLength(255)] [StringLength(255)] public string AudioLanguagePreference { get; set; } /// <summary> - /// Required, Max length = 255 + /// Gets or sets the authentication provider id. /// </summary> + /// <remarks> + /// Required, Max length = 255. + /// </remarks> [Required] [MaxLength(255)] [StringLength(255)] public string AuthenticationProviderId { get; set; } + /// <summary> + /// Gets or sets the password reset provider id. + /// </summary> + /// <remarks> + /// Required, Max length = 255. + /// </remarks> [Required] [MaxLength(255)] [StringLength(255)] public string PasswordResetProviderId { get; set; } /// <summary> - /// Required + /// Gets or sets the invalid login attempt count. /// </summary> + /// <remarks> + /// Required. + /// </remarks> [Required] public int InvalidLoginAttemptCount { get; set; } + /// <summary> + /// Gets or sets the last activity date. + /// </summary> public DateTime LastActivityDate { get; set; } + /// <summary> + /// Gets or sets the last login date. + /// </summary> public DateTime LastLoginDate { get; set; } + /// <summary> + /// Gets or sets the number of login attempts the user can make before they are locked out. + /// </summary> public int? LoginAttemptsBeforeLockout { get; set; } /// <summary> - /// Required. + /// Gets or sets the subtitle mode. /// </summary> + /// <remarks> + /// Required. + /// </remarks> [Required] public SubtitlePlaybackMode SubtitleMode { get; set; } /// <summary> - /// Required + /// Gets or sets a value indicating whether the default audio track should be played. /// </summary> + /// <remarks> + /// Required. + /// </remarks> [Required] public bool PlayDefaultAudioTrack { get; set; } /// <summary> /// Gets or sets the subtitle language preference. - /// Max length = 255 /// </summary> + /// <remarks> + /// Max length = 255. + /// </remarks> [MaxLength(255)] [StringLength(255)] public string SubtitleLanguagePreference { get; set; } + /// <summary> + /// Gets or sets a value indicating whether missing episodes should be displayed. + /// </summary> + /// <remarks> + /// Required. + /// </remarks> [Required] public bool DisplayMissingEpisodes { get; set; } + /// <summary> + /// Gets or sets a value indicating whether to display the collections view. + /// </summary> + /// <remarks> + /// Required. + /// </remarks> [Required] public bool DisplayCollectionsView { get; set; } + /// <summary> + /// Gets or sets a value indicating whether the user has a local password. + /// </summary> + /// <remarks> + /// Required. + /// </remarks> [Required] public bool EnableLocalPassword { get; set; } + /// <summary> + /// Gets or sets a value indicating whether the server should hide played content in "Latest". + /// </summary> + /// <remarks> + /// Required. + /// </remarks> [Required] public bool HidePlayedInLatest { get; set; } + /// <summary> + /// Gets or sets a value indicating whether to remember audio selections on played content. + /// </summary> + /// <remarks> + /// Required. + /// </remarks> [Required] public bool RememberAudioSelections { get; set; } + /// <summary> + /// Gets or sets a value indicating whether to remember subtitle selections on played content. + /// </summary> + /// <remarks> + /// Required. + /// </remarks> [Required] public bool RememberSubtitleSelections { get; set; } + /// <summary> + /// Gets or sets a value indicating whether to enable auto-play for the next episode. + /// </summary> + /// <remarks> + /// Required. + /// </remarks> [Required] public bool EnableNextEpisodeAutoPlay { get; set; } + /// <summary> + /// Gets or sets a value indicating whether the user should auto-login. + /// </summary> + /// <remarks> + /// Required. + /// </remarks> [Required] public bool EnableAutoLogin { get; set; } + /// <summary> + /// Gets or sets a value indicating whether the user can change their preferences. + /// </summary> + /// <remarks> + /// Required. + /// </remarks> [Required] public bool EnableUserPreferenceAccess { get; set; } + /// <summary> + /// Gets or sets the maximum parental age rating. + /// </summary> public int? MaxParentalAgeRating { get; set; } + /// <summary> + /// Gets or sets the remote client bitrate limit. + /// </summary> public int? RemoteClientBitrateLimit { get; set; } /// <summary> @@ -224,51 +320,100 @@ namespace Jellyfin.Data.Entities [Required] public long InternalId { get; set; } + /// <summary> + /// Gets or sets the user's profile image. Can be <c>null</c>. + /// </summary> public virtual ImageInfo ProfileImage { get; set; } /// <summary> /// Gets or sets the row version. - /// Required, ConcurrenyToken. /// </summary> + /// <remarks> + /// Required, Concurrency Token. + /// </remarks> [ConcurrencyCheck] [Required] public uint RowVersion { get; set; } - public void OnSavingChanges() - { - RowVersion++; - } - /************************************************************************* * Navigation properties *************************************************************************/ + + /// <summary> + /// Gets or sets the list of groups this user is a member of. + /// </summary> [ForeignKey("Group_Groups_Guid")] public virtual ICollection<Group> Groups { get; protected set; } + /// <summary> + /// Gets or sets the list of permissions this user has. + /// </summary> [ForeignKey("Permission_Permissions_Guid")] public virtual ICollection<Permission> Permissions { get; protected set; } + /// <summary> + /// Gets or sets the list of provider mappings this user has. + /// </summary> [ForeignKey("ProviderMapping_ProviderMappings_Id")] public virtual ICollection<ProviderMapping> ProviderMappings { get; protected set; } + /// <summary> + /// Gets or sets the list of preferences this user has. + /// </summary> [ForeignKey("Preference_Preferences_Guid")] public virtual ICollection<Preference> Preferences { get; protected set; } + /// <summary> + /// Gets or sets the list of access schedules this user has. + /// </summary> public virtual ICollection<AccessSchedule> AccessSchedules { get; protected set; } + /// <summary> + /// Static create function (for use in LINQ queries, etc.) + /// </summary> + /// <param name="username">The username for the created user.</param> + /// <param name="authenticationProviderId">The Id of the user's authentication provider.</param> + /// <param name="passwordResetProviderId">The Id of the user's password reset provider.</param> + /// <returns>The created instance.</returns> + public static User Create(string username, string authenticationProviderId, string passwordResetProviderId) + { + return new User(username, authenticationProviderId, passwordResetProviderId); + } + + /// <inheritdoc/> + public void OnSavingChanges() + { + RowVersion++; + } + partial void Init(); + /// <summary> + /// Checks whether the user has the specified permission. + /// </summary> + /// <param name="permission">The permission kind.</param> + /// <returns><c>True</c> if the user has the specified permission.</returns> public bool HasPermission(PermissionKind permission) { return Permissions.First(p => p.Kind == permission).Value; } + /// <summary> + /// Sets the given permission kind to the provided value. + /// </summary> + /// <param name="kind">The permission kind.</param> + /// <param name="value">The value to set.</param> public void SetPermission(PermissionKind kind, bool value) { var permissionObj = Permissions.First(p => p.Kind == kind); permissionObj.Value = value; } + /// <summary> + /// Gets the user's preferences for the given preference kind. + /// </summary> + /// <param name="preference">The preference kind.</param> + /// <returns>A string array containing the user's preferences.</returns> public string[] GetPreference(PreferenceKind preference) { var val = Preferences @@ -279,18 +424,32 @@ namespace Jellyfin.Data.Entities return Equals(val, string.Empty) ? Array.Empty<string>() : val.Split(Delimiter); } + /// <summary> + /// Sets the specified preference to the given value. + /// </summary> + /// <param name="preference">The preference kind.</param> + /// <param name="values">The values.</param> public void SetPreference(PreferenceKind preference, string[] values) { Preferences.First(p => p.Kind == preference).Value = string.Join(Delimiter.ToString(CultureInfo.InvariantCulture), values); } + /// <summary> + /// Checks whether this user is currently allowed to use the server. + /// </summary> + /// <returns><c>True</c> if the current time is within an access schedule, or there are no access schedules.</returns> public bool IsParentalScheduleAllowed() { return AccessSchedules.Count == 0 || AccessSchedules.Any(i => IsParentalScheduleAllowed(i, DateTime.UtcNow)); } + /// <summary> + /// Checks whether the provided folder is in this user's grouped folders. + /// </summary> + /// <param name="id">The Guid of the folder.</param> + /// <returns><c>True</c> if the folder is in the user's grouped folders.</returns> public bool IsFolderGrouped(Guid id) { return GetPreference(PreferenceKind.GroupedFolders).Any(i => new Guid(i) == id); diff --git a/Jellyfin.Server.Implementations/Users/UserManager.cs b/Jellyfin.Server.Implementations/Users/UserManager.cs index 599efe583..e16b1fb7b 100644 --- a/Jellyfin.Server.Implementations/Users/UserManager.cs +++ b/Jellyfin.Server.Implementations/Users/UserManager.cs @@ -35,7 +35,7 @@ namespace Jellyfin.Server.Implementations.Users private readonly INetworkManager _networkManager; private readonly IApplicationHost _appHost; private readonly IImageProcessor _imageProcessor; - private readonly ILogger<IUserManager> _logger; + private readonly ILogger<UserManager> _logger; private IAuthenticationProvider[] _authenticationProviders; private DefaultAuthenticationProvider _defaultAuthenticationProvider; @@ -58,7 +58,7 @@ namespace Jellyfin.Server.Implementations.Users INetworkManager networkManager, IApplicationHost appHost, IImageProcessor imageProcessor, - ILogger<IUserManager> logger) + ILogger<UserManager> logger) { _dbProvider = dbProvider; _cryptoProvider = cryptoProvider; @@ -190,7 +190,7 @@ namespace Jellyfin.Server.Implementations.Users var dbContext = _dbProvider.CreateContext(); - // Temporary measure until user item data is migrated. + // TODO: Remove after user item data is migrated. var max = dbContext.Users.Select(u => u.InternalId).Max(); var newUser = new User( |