jellyfin-server/MediaBrowser.Server.Implementations/Library/UserManager.cs

412 lines
14 KiB
C#
Raw Normal View History

2013-07-08 16:13:21 +00:00
using MediaBrowser.Common.Events;
2013-02-21 01:33:05 +00:00
using MediaBrowser.Common.Extensions;
2013-03-04 05:43:06 +00:00
using MediaBrowser.Controller.Configuration;
2013-02-21 01:33:05 +00:00
using MediaBrowser.Controller.Entities;
using MediaBrowser.Controller.Library;
using MediaBrowser.Controller.Persistence;
using MediaBrowser.Controller.Providers;
using MediaBrowser.Model.Logging;
2013-02-21 01:33:05 +00:00
using System;
using System.Collections.Generic;
2013-07-08 16:13:21 +00:00
using System.IO;
2013-02-21 01:33:05 +00:00
using System.Linq;
using System.Security.Cryptography;
using System.Text;
2013-02-21 01:33:05 +00:00
using System.Threading;
using System.Threading.Tasks;
namespace MediaBrowser.Server.Implementations.Library
2013-02-21 01:33:05 +00:00
{
/// <summary>
/// Class UserManager
/// </summary>
public class UserManager : IUserManager
2013-02-21 01:33:05 +00:00
{
/// <summary>
/// Gets the users.
/// </summary>
/// <value>The users.</value>
2013-12-26 14:20:30 +00:00
public IEnumerable<User> Users { get; private set; }
2013-03-16 05:52:33 +00:00
2013-02-21 21:39:53 +00:00
/// <summary>
/// The _logger
/// </summary>
private readonly ILogger _logger;
2013-03-04 05:43:06 +00:00
/// <summary>
/// Gets or sets the configuration manager.
/// </summary>
/// <value>The configuration manager.</value>
private IServerConfigurationManager ConfigurationManager { get; set; }
/// <summary>
/// Gets the active user repository
/// </summary>
/// <value>The user repository.</value>
private IUserRepository UserRepository { get; set; }
2013-02-21 01:33:05 +00:00
/// <summary>
/// Initializes a new instance of the <see cref="UserManager" /> class.
/// </summary>
2013-02-21 21:39:53 +00:00
/// <param name="logger">The logger.</param>
2013-03-04 05:43:06 +00:00
/// <param name="configurationManager">The configuration manager.</param>
2013-12-26 14:20:30 +00:00
/// <param name="userRepository">The user repository.</param>
public UserManager(ILogger logger, IServerConfigurationManager configurationManager, IUserRepository userRepository)
2013-02-21 01:33:05 +00:00
{
2013-02-21 21:39:53 +00:00
_logger = logger;
UserRepository = userRepository;
2013-03-04 05:43:06 +00:00
ConfigurationManager = configurationManager;
2013-12-26 14:20:30 +00:00
Users = new List<User>();
2013-02-21 01:33:05 +00:00
}
#region UserUpdated Event
/// <summary>
/// Occurs when [user updated].
/// </summary>
public event EventHandler<GenericEventArgs<User>> UserUpdated;
/// <summary>
/// Called when [user updated].
/// </summary>
/// <param name="user">The user.</param>
private void OnUserUpdated(User user)
2013-02-21 01:33:05 +00:00
{
2013-02-21 21:39:53 +00:00
EventHelper.QueueEventIfNotNull(UserUpdated, this, new GenericEventArgs<User> { Argument = user }, _logger);
2013-02-21 01:33:05 +00:00
}
#endregion
#region UserDeleted Event
/// <summary>
/// Occurs when [user deleted].
/// </summary>
public event EventHandler<GenericEventArgs<User>> UserDeleted;
/// <summary>
/// Called when [user deleted].
/// </summary>
/// <param name="user">The user.</param>
private void OnUserDeleted(User user)
2013-02-21 01:33:05 +00:00
{
2013-02-21 21:39:53 +00:00
EventHelper.QueueEventIfNotNull(UserDeleted, this, new GenericEventArgs<User> { Argument = user }, _logger);
2013-02-21 01:33:05 +00:00
}
#endregion
/// <summary>
/// Gets a User by Id
/// </summary>
/// <param name="id">The id.</param>
/// <returns>User.</returns>
/// <exception cref="System.ArgumentNullException"></exception>
public User GetUserById(Guid id)
{
if (id == Guid.Empty)
{
throw new ArgumentNullException("id");
}
return Users.FirstOrDefault(u => u.Id == id);
}
2013-03-16 05:52:33 +00:00
2013-12-26 14:20:30 +00:00
public async Task Initialize()
{
Users = await LoadUsers().ConfigureAwait(false);
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Authenticates a User and returns a result indicating whether or not it succeeded
/// </summary>
/// <param name="user">The user.</param>
/// <param name="password">The password.</param>
/// <returns>Task{System.Boolean}.</returns>
/// <exception cref="System.ArgumentNullException">user</exception>
public async Task<bool> AuthenticateUser(User user, string password)
{
if (user == null)
{
throw new ArgumentNullException("user");
}
2013-07-08 16:13:21 +00:00
if (user.Configuration.IsDisabled)
{
throw new UnauthorizedAccessException(string.Format("The {0} account is currently disabled. Please consult with your administrator.", user.Name));
}
2013-03-13 05:19:03 +00:00
var existingPasswordString = string.IsNullOrEmpty(user.Password) ? GetSha1String(string.Empty) : user.Password;
2013-02-21 01:33:05 +00:00
2013-03-13 05:19:03 +00:00
var success = string.Equals(existingPasswordString, password.Replace("-", string.Empty), StringComparison.OrdinalIgnoreCase);
2013-02-21 01:33:05 +00:00
// Update LastActivityDate and LastLoginDate, then save
if (success)
{
user.LastActivityDate = user.LastLoginDate = DateTime.UtcNow;
await UpdateUser(user).ConfigureAwait(false);
}
2013-02-21 21:39:53 +00:00
_logger.Info("Authentication request for {0} {1}.", user.Name, (success ? "has succeeded" : "has been denied"));
2013-02-21 01:33:05 +00:00
return success;
}
2013-03-13 05:19:03 +00:00
/// <summary>
/// Gets the sha1 string.
/// </summary>
/// <param name="str">The STR.</param>
/// <returns>System.String.</returns>
private static string GetSha1String(string str)
{
using (var provider = SHA1.Create())
{
var hash = provider.ComputeHash(Encoding.UTF8.GetBytes(str));
return BitConverter.ToString(hash).Replace("-", string.Empty);
}
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Loads the users from the repository
/// </summary>
/// <returns>IEnumerable{User}.</returns>
2013-12-26 14:20:30 +00:00
private async Task<IEnumerable<User>> LoadUsers()
2013-02-21 01:33:05 +00:00
{
var users = UserRepository.RetrieveAllUsers().ToList();
2013-02-21 01:33:05 +00:00
// There always has to be at least one user.
if (users.Count == 0)
{
var name = Environment.UserName;
var user = InstantiateNewUser(name);
2013-12-06 20:07:34 +00:00
user.DateLastSaved = DateTime.UtcNow;
2013-12-26 14:20:30 +00:00
await UserRepository.SaveUser(user, CancellationToken.None).ConfigureAwait(false);
2013-02-21 01:33:05 +00:00
users.Add(user);
}
return users;
}
/// <summary>
/// Refreshes metadata for each user
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <param name="force">if set to <c>true</c> [force].</param>
/// <returns>Task.</returns>
public Task RefreshUsersMetadata(CancellationToken cancellationToken, bool force = false)
{
var tasks = Users.Select(user => user.RefreshMetadata(new MetadataRefreshOptions
{
ReplaceAllMetadata = force
}, cancellationToken)).ToList();
2013-02-21 01:33:05 +00:00
return Task.WhenAll(tasks);
}
/// <summary>
/// Renames the user.
/// </summary>
/// <param name="user">The user.</param>
/// <param name="newName">The new name.</param>
/// <returns>Task.</returns>
/// <exception cref="System.ArgumentNullException">user</exception>
/// <exception cref="System.ArgumentException"></exception>
public async Task RenameUser(User user, string newName)
{
if (user == null)
{
throw new ArgumentNullException("user");
}
if (string.IsNullOrEmpty(newName))
{
throw new ArgumentNullException("newName");
}
if (Users.Any(u => u.Id != user.Id && u.Name.Equals(newName, StringComparison.OrdinalIgnoreCase)))
2013-02-21 01:33:05 +00:00
{
throw new ArgumentException(string.Format("A user with the name '{0}' already exists.", newName));
}
if (user.Name.Equals(newName, StringComparison.Ordinal))
{
throw new ArgumentException("The new and old names must be different.");
}
await user.Rename(newName);
OnUserUpdated(user);
}
/// <summary>
/// Updates the user.
/// </summary>
/// <param name="user">The user.</param>
/// <exception cref="System.ArgumentNullException">user</exception>
/// <exception cref="System.ArgumentException"></exception>
public async Task UpdateUser(User user)
{
if (user == null)
{
throw new ArgumentNullException("user");
}
if (user.Id == Guid.Empty || !Users.Any(u => u.Id.Equals(user.Id)))
2013-02-21 01:33:05 +00:00
{
throw new ArgumentException(string.Format("User with name '{0}' and Id {1} does not exist.", user.Name, user.Id));
}
user.DateModified = DateTime.UtcNow;
2013-12-06 20:07:34 +00:00
user.DateLastSaved = DateTime.UtcNow;
2013-02-21 01:33:05 +00:00
await UserRepository.SaveUser(user, CancellationToken.None).ConfigureAwait(false);
2013-02-21 01:33:05 +00:00
OnUserUpdated(user);
}
2013-07-07 02:01:14 +00:00
public event EventHandler<GenericEventArgs<User>> UserCreated;
2013-12-26 14:20:30 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
/// Creates the user.
/// </summary>
/// <param name="name">The name.</param>
/// <returns>User.</returns>
/// <exception cref="System.ArgumentNullException">name</exception>
/// <exception cref="System.ArgumentException"></exception>
public async Task<User> CreateUser(string name)
{
if (string.IsNullOrEmpty(name))
{
throw new ArgumentNullException("name");
}
if (Users.Any(u => u.Name.Equals(name, StringComparison.OrdinalIgnoreCase)))
2013-02-21 01:33:05 +00:00
{
throw new ArgumentException(string.Format("A user with the name '{0}' already exists.", name));
}
var user = InstantiateNewUser(name);
var list = Users.ToList();
2013-02-21 01:33:05 +00:00
list.Add(user);
Users = list;
2013-02-21 01:33:05 +00:00
2013-12-06 20:07:34 +00:00
user.DateLastSaved = DateTime.UtcNow;
2013-12-26 14:20:30 +00:00
await UserRepository.SaveUser(user, CancellationToken.None).ConfigureAwait(false);
2013-02-21 01:33:05 +00:00
2013-07-07 02:01:14 +00:00
EventHelper.QueueEventIfNotNull(UserCreated, this, new GenericEventArgs<User> { Argument = user }, _logger);
2013-12-26 14:20:30 +00:00
2013-02-21 01:33:05 +00:00
return user;
}
/// <summary>
/// Deletes the user.
/// </summary>
/// <param name="user">The user.</param>
/// <returns>Task.</returns>
/// <exception cref="System.ArgumentNullException">user</exception>
/// <exception cref="System.ArgumentException"></exception>
public async Task DeleteUser(User user)
{
if (user == null)
{
throw new ArgumentNullException("user");
}
var allUsers = Users.ToList();
if (allUsers.FirstOrDefault(u => u.Id == user.Id) == null)
2013-02-21 01:33:05 +00:00
{
throw new ArgumentException(string.Format("The user cannot be deleted because there is no user with the Name {0} and Id {1}.", user.Name, user.Id));
}
if (allUsers.Count == 1)
{
throw new ArgumentException(string.Format("The user '{0}' cannot be deleted because there must be at least one user in the system.", user.Name));
}
if (user.Configuration.IsAdministrator && allUsers.Count(i => i.Configuration.IsAdministrator) == 1)
2013-02-21 01:33:05 +00:00
{
throw new ArgumentException(string.Format("The user '{0}' cannot be deleted because there must be at least one admin user in the system.", user.Name));
2013-02-21 01:33:05 +00:00
}
await UserRepository.DeleteUser(user, CancellationToken.None).ConfigureAwait(false);
2013-02-21 01:33:05 +00:00
if (user.Configuration.UseCustomLibrary)
{
var path = user.RootFolderPath;
try
{
Directory.Delete(path, true);
}
catch (IOException ex)
{
_logger.ErrorException("Error deleting directory {0}", ex, path);
}
path = user.ConfigurationFilePath;
try
{
File.Delete(path);
}
catch (IOException ex)
{
_logger.ErrorException("Error deleting file {0}", ex, path);
}
}
2013-02-21 01:33:05 +00:00
// Force this to be lazy loaded again
2013-12-27 05:13:19 +00:00
Users = await LoadUsers().ConfigureAwait(false);
OnUserDeleted(user);
2013-02-21 01:33:05 +00:00
}
2013-03-13 05:19:03 +00:00
/// <summary>
/// Resets the password by clearing it.
/// </summary>
/// <returns>Task.</returns>
public Task ResetPassword(User user)
{
return ChangePassword(user, string.Empty);
}
/// <summary>
/// Changes the password.
/// </summary>
/// <param name="user">The user.</param>
/// <param name="newPassword">The new password.</param>
/// <returns>Task.</returns>
public Task ChangePassword(User user, string newPassword)
{
if (user == null)
{
throw new ArgumentNullException("user");
}
user.Password = string.IsNullOrEmpty(newPassword) ? string.Empty : GetSha1String(newPassword);
return UpdateUser(user);
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Instantiates the new user.
/// </summary>
/// <param name="name">The name.</param>
/// <returns>User.</returns>
private User InstantiateNewUser(string name)
{
return new User
{
Name = name,
Id = ("MBUser" + name).GetMD5(),
DateCreated = DateTime.UtcNow,
DateModified = DateTime.UtcNow
};
}
2013-07-07 02:01:14 +00:00
2013-02-21 01:33:05 +00:00
}
}