2019-01-13 15:01:16 -05:00
|
|
|
using System;
|
2018-12-27 18:27:57 -05:00
|
|
|
using System.Collections.Generic;
|
|
|
|
using System.Threading.Tasks;
|
2020-05-12 22:10:35 -04:00
|
|
|
using Jellyfin.Data.Entities;
|
2018-12-27 18:27:57 -05:00
|
|
|
using MediaBrowser.Controller.Authentication;
|
2019-01-13 14:25:32 -05:00
|
|
|
using MediaBrowser.Model.Configuration;
|
|
|
|
using MediaBrowser.Model.Dto;
|
|
|
|
using MediaBrowser.Model.Events;
|
|
|
|
using MediaBrowser.Model.Users;
|
2018-12-27 18:27:57 -05:00
|
|
|
|
|
|
|
namespace MediaBrowser.Controller.Library
|
|
|
|
{
|
|
|
|
/// <summary>
|
|
|
|
/// Interface IUserManager
|
|
|
|
/// </summary>
|
|
|
|
public interface IUserManager
|
|
|
|
{
|
|
|
|
/// <summary>
|
2020-05-12 22:10:35 -04:00
|
|
|
/// Occurs when a user is updated.
|
2018-12-27 18:27:57 -05:00
|
|
|
/// </summary>
|
2020-05-12 22:10:35 -04:00
|
|
|
event EventHandler<GenericEventArgs<User>> OnUserUpdated;
|
2018-12-27 18:27:57 -05:00
|
|
|
|
2019-06-09 16:08:01 -04:00
|
|
|
/// <summary>
|
2020-05-12 22:10:35 -04:00
|
|
|
/// Occurs when a user is created.
|
2019-06-09 16:08:01 -04:00
|
|
|
/// </summary>
|
2020-05-12 22:10:35 -04:00
|
|
|
event EventHandler<GenericEventArgs<User>> OnUserCreated;
|
2019-06-09 16:08:01 -04:00
|
|
|
|
2018-12-27 18:27:57 -05:00
|
|
|
/// <summary>
|
2020-05-12 22:10:35 -04:00
|
|
|
/// Occurs when a user is deleted.
|
2018-12-27 18:27:57 -05:00
|
|
|
/// </summary>
|
2020-05-12 22:10:35 -04:00
|
|
|
event EventHandler<GenericEventArgs<User>> OnUserDeleted;
|
2018-12-27 18:27:57 -05:00
|
|
|
|
|
|
|
/// <summary>
|
2020-05-12 22:10:35 -04:00
|
|
|
/// Occurs when a user's password is changed.
|
2018-12-27 18:27:57 -05:00
|
|
|
/// </summary>
|
2020-05-12 22:10:35 -04:00
|
|
|
event EventHandler<GenericEventArgs<User>> OnUserPasswordChanged;
|
2019-10-20 15:12:03 -04:00
|
|
|
|
2020-05-12 22:10:35 -04:00
|
|
|
/// <summary>
|
|
|
|
/// Occurs when a user is locked out.
|
|
|
|
/// </summary>
|
|
|
|
event EventHandler<GenericEventArgs<User>> OnUserLockedOut;
|
2019-10-20 15:12:03 -04:00
|
|
|
|
2020-05-12 22:10:35 -04:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the users.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The users.</value>
|
|
|
|
IEnumerable<User> Users { get; }
|
2019-10-20 15:12:03 -04:00
|
|
|
|
2020-05-12 22:10:35 -04:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the user ids.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The users ids.</value>
|
|
|
|
IEnumerable<Guid> UsersIds { get; }
|
2018-12-27 18:27:57 -05:00
|
|
|
|
|
|
|
/// <summary>
|
2019-11-17 17:05:39 -05:00
|
|
|
/// Gets a user by Id.
|
2018-12-27 18:27:57 -05:00
|
|
|
/// </summary>
|
|
|
|
/// <param name="id">The id.</param>
|
2019-10-29 12:50:09 -04:00
|
|
|
/// <returns>The user with the specified Id, or <c>null</c> if the user doesn't exist.</returns>
|
2019-10-20 15:12:03 -04:00
|
|
|
/// <exception cref="ArgumentException"><c>id</c> is an empty Guid.</exception>
|
2018-12-27 18:27:57 -05:00
|
|
|
User GetUserById(Guid id);
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Gets the name of the user by.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="name">The name.</param>
|
|
|
|
/// <returns>User.</returns>
|
|
|
|
User GetUserByName(string name);
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Renames the user.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="user">The user.</param>
|
|
|
|
/// <param name="newName">The new name.</param>
|
|
|
|
/// <returns>Task.</returns>
|
2019-01-13 15:37:13 -05:00
|
|
|
/// <exception cref="ArgumentNullException">user</exception>
|
|
|
|
/// <exception cref="ArgumentException"></exception>
|
2018-12-27 18:27:57 -05:00
|
|
|
Task RenameUser(User user, string newName);
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Updates the user.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="user">The user.</param>
|
2019-01-13 15:37:13 -05:00
|
|
|
/// <exception cref="ArgumentNullException">user</exception>
|
|
|
|
/// <exception cref="ArgumentException"></exception>
|
2018-12-27 18:27:57 -05:00
|
|
|
void UpdateUser(User user);
|
|
|
|
|
|
|
|
/// <summary>
|
2020-05-12 22:10:35 -04:00
|
|
|
/// Updates the user.
|
2018-12-27 18:27:57 -05:00
|
|
|
/// </summary>
|
2020-05-12 22:10:35 -04:00
|
|
|
/// <param name="user">The user.</param>
|
|
|
|
/// <exception cref="ArgumentNullException">If user is <c>null</c>.</exception>
|
|
|
|
/// <exception cref="ArgumentException">If the provided user doesn't exist.</exception>
|
|
|
|
/// <returns>A task representing the update of the user.</returns>
|
|
|
|
Task UpdateUserAsync(User user);
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Creates a user with the specified name.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="name">The name of the new user.</param>
|
|
|
|
/// <returns>The created user.</returns>
|
2019-01-13 15:37:13 -05:00
|
|
|
/// <exception cref="ArgumentNullException">name</exception>
|
|
|
|
/// <exception cref="ArgumentException"></exception>
|
2019-06-09 16:08:01 -04:00
|
|
|
User CreateUser(string name);
|
2018-12-27 18:27:57 -05:00
|
|
|
|
|
|
|
/// <summary>
|
2020-05-12 22:10:35 -04:00
|
|
|
/// Deletes the specified user.
|
2018-12-27 18:27:57 -05:00
|
|
|
/// </summary>
|
2020-05-12 22:10:35 -04:00
|
|
|
/// <param name="user">The user to be deleted.</param>
|
2019-06-09 16:08:01 -04:00
|
|
|
void DeleteUser(User user);
|
2018-12-27 18:27:57 -05:00
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Resets the password.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="user">The user.</param>
|
|
|
|
/// <returns>Task.</returns>
|
|
|
|
Task ResetPassword(User user);
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Resets the easy password.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="user">The user.</param>
|
|
|
|
/// <returns>Task.</returns>
|
|
|
|
void ResetEasyPassword(User user);
|
2019-01-07 18:27:46 -05:00
|
|
|
|
2018-12-27 18:27:57 -05:00
|
|
|
/// <summary>
|
|
|
|
/// Changes the password.
|
|
|
|
/// </summary>
|
|
|
|
Task ChangePassword(User user, string newPassword);
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Changes the easy password.
|
|
|
|
/// </summary>
|
|
|
|
void ChangeEasyPassword(User user, string newPassword, string newPasswordSha1);
|
2019-01-07 18:27:46 -05:00
|
|
|
|
2018-12-27 18:27:57 -05:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the user dto.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="user">The user.</param>
|
|
|
|
/// <param name="remoteEndPoint">The remote end point.</param>
|
|
|
|
/// <returns>UserDto.</returns>
|
|
|
|
UserDto GetUserDto(User user, string remoteEndPoint = null);
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Authenticates the user.
|
|
|
|
/// </summary>
|
|
|
|
Task<User> AuthenticateUser(string username, string password, string passwordSha1, string remoteEndPoint, bool isUserSession);
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Starts the forgot password process.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="enteredUsername">The entered username.</param>
|
|
|
|
/// <param name="isInNetwork">if set to <c>true</c> [is in network].</param>
|
|
|
|
/// <returns>ForgotPasswordResult.</returns>
|
|
|
|
Task<ForgotPasswordResult> StartForgotPasswordProcess(string enteredUsername, bool isInNetwork);
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Redeems the password reset pin.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="pin">The pin.</param>
|
|
|
|
/// <returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
|
|
|
|
Task<PinRedeemResult> RedeemPasswordResetPin(string pin);
|
|
|
|
|
2020-05-12 22:10:35 -04:00
|
|
|
void AddParts(IEnumerable<IAuthenticationProvider> authenticationProviders, IEnumerable<IPasswordResetProvider> passwordResetProviders);
|
2018-12-27 18:27:57 -05:00
|
|
|
|
2020-05-12 22:10:35 -04:00
|
|
|
NameIdPair[] GetAuthenticationProviders();
|
2018-12-27 18:27:57 -05:00
|
|
|
|
2020-05-12 22:10:35 -04:00
|
|
|
NameIdPair[] GetPasswordResetProviders();
|
2018-12-27 18:27:57 -05:00
|
|
|
|
|
|
|
/// <summary>
|
2020-05-12 22:10:35 -04:00
|
|
|
/// This method updates the user's configuration.
|
|
|
|
/// This is only included as a stopgap until the new API, using this internally is not recommended.
|
|
|
|
/// Instead, modify the user object directlu, then call <see cref="UpdateUser"/>.
|
2018-12-27 18:27:57 -05:00
|
|
|
/// </summary>
|
2020-05-12 22:10:35 -04:00
|
|
|
/// <param name="userId">The user's Id.</param>
|
|
|
|
/// <param name="config">The request containing the new user configuration.</param>
|
|
|
|
void UpdateConfiguration(Guid userId, UserConfiguration config);
|
2018-12-27 18:27:57 -05:00
|
|
|
|
|
|
|
/// <summary>
|
2020-05-12 22:10:35 -04:00
|
|
|
/// This method updates the user's policy.
|
|
|
|
/// This is only included as a stopgap until the new API, using this internally is not recommended.
|
|
|
|
/// Instead, modify the user object directlu, then call <see cref="UpdateUser"/>.
|
2018-12-27 18:27:57 -05:00
|
|
|
/// </summary>
|
2020-05-12 22:10:35 -04:00
|
|
|
/// <param name="userId">The user's Id.</param>
|
|
|
|
/// <param name="policy">The request containing the new user policy.</param>
|
|
|
|
void UpdatePolicy(Guid userId, UserPolicy policy);
|
2018-12-27 18:27:57 -05:00
|
|
|
}
|
|
|
|
}
|