UserManager.cs 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406
  1. using MediaBrowser.Common.Events;
  2. using MediaBrowser.Common.Extensions;
  3. using MediaBrowser.Controller.Configuration;
  4. using MediaBrowser.Controller.Entities;
  5. using MediaBrowser.Controller.Library;
  6. using MediaBrowser.Controller.Persistence;
  7. using MediaBrowser.Model.Logging;
  8. using System;
  9. using System.Collections.Generic;
  10. using System.IO;
  11. using System.Linq;
  12. using System.Security.Cryptography;
  13. using System.Text;
  14. using System.Threading;
  15. using System.Threading.Tasks;
  16. namespace MediaBrowser.Server.Implementations.Library
  17. {
  18. /// <summary>
  19. /// Class UserManager
  20. /// </summary>
  21. public class UserManager : IUserManager
  22. {
  23. /// <summary>
  24. /// Gets the users.
  25. /// </summary>
  26. /// <value>The users.</value>
  27. public IEnumerable<User> Users { get; private set; }
  28. /// <summary>
  29. /// The _logger
  30. /// </summary>
  31. private readonly ILogger _logger;
  32. /// <summary>
  33. /// Gets or sets the configuration manager.
  34. /// </summary>
  35. /// <value>The configuration manager.</value>
  36. private IServerConfigurationManager ConfigurationManager { get; set; }
  37. /// <summary>
  38. /// Gets the active user repository
  39. /// </summary>
  40. /// <value>The user repository.</value>
  41. private IUserRepository UserRepository { get; set; }
  42. /// <summary>
  43. /// Initializes a new instance of the <see cref="UserManager" /> class.
  44. /// </summary>
  45. /// <param name="logger">The logger.</param>
  46. /// <param name="configurationManager">The configuration manager.</param>
  47. /// <param name="userRepository">The user repository.</param>
  48. public UserManager(ILogger logger, IServerConfigurationManager configurationManager, IUserRepository userRepository)
  49. {
  50. _logger = logger;
  51. UserRepository = userRepository;
  52. ConfigurationManager = configurationManager;
  53. Users = new List<User>();
  54. }
  55. #region UserUpdated Event
  56. /// <summary>
  57. /// Occurs when [user updated].
  58. /// </summary>
  59. public event EventHandler<GenericEventArgs<User>> UserUpdated;
  60. /// <summary>
  61. /// Called when [user updated].
  62. /// </summary>
  63. /// <param name="user">The user.</param>
  64. private void OnUserUpdated(User user)
  65. {
  66. EventHelper.QueueEventIfNotNull(UserUpdated, this, new GenericEventArgs<User> { Argument = user }, _logger);
  67. }
  68. #endregion
  69. #region UserDeleted Event
  70. /// <summary>
  71. /// Occurs when [user deleted].
  72. /// </summary>
  73. public event EventHandler<GenericEventArgs<User>> UserDeleted;
  74. /// <summary>
  75. /// Called when [user deleted].
  76. /// </summary>
  77. /// <param name="user">The user.</param>
  78. private void OnUserDeleted(User user)
  79. {
  80. EventHelper.QueueEventIfNotNull(UserDeleted, this, new GenericEventArgs<User> { Argument = user }, _logger);
  81. }
  82. #endregion
  83. /// <summary>
  84. /// Gets a User by Id
  85. /// </summary>
  86. /// <param name="id">The id.</param>
  87. /// <returns>User.</returns>
  88. /// <exception cref="System.ArgumentNullException"></exception>
  89. public User GetUserById(Guid id)
  90. {
  91. if (id == Guid.Empty)
  92. {
  93. throw new ArgumentNullException("id");
  94. }
  95. return Users.FirstOrDefault(u => u.Id == id);
  96. }
  97. public async Task Initialize()
  98. {
  99. Users = await LoadUsers().ConfigureAwait(false);
  100. }
  101. /// <summary>
  102. /// Authenticates a User and returns a result indicating whether or not it succeeded
  103. /// </summary>
  104. /// <param name="user">The user.</param>
  105. /// <param name="password">The password.</param>
  106. /// <returns>Task{System.Boolean}.</returns>
  107. /// <exception cref="System.ArgumentNullException">user</exception>
  108. public async Task<bool> AuthenticateUser(User user, string password)
  109. {
  110. if (user == null)
  111. {
  112. throw new ArgumentNullException("user");
  113. }
  114. if (user.Configuration.IsDisabled)
  115. {
  116. throw new UnauthorizedAccessException(string.Format("The {0} account is currently disabled. Please consult with your administrator.", user.Name));
  117. }
  118. var existingPasswordString = string.IsNullOrEmpty(user.Password) ? GetSha1String(string.Empty) : user.Password;
  119. var success = string.Equals(existingPasswordString, password.Replace("-", string.Empty), StringComparison.OrdinalIgnoreCase);
  120. // Update LastActivityDate and LastLoginDate, then save
  121. if (success)
  122. {
  123. user.LastActivityDate = user.LastLoginDate = DateTime.UtcNow;
  124. await UpdateUser(user).ConfigureAwait(false);
  125. }
  126. _logger.Info("Authentication request for {0} {1}.", user.Name, (success ? "has succeeded" : "has been denied"));
  127. return success;
  128. }
  129. /// <summary>
  130. /// Gets the sha1 string.
  131. /// </summary>
  132. /// <param name="str">The STR.</param>
  133. /// <returns>System.String.</returns>
  134. private static string GetSha1String(string str)
  135. {
  136. using (var provider = SHA1.Create())
  137. {
  138. var hash = provider.ComputeHash(Encoding.UTF8.GetBytes(str));
  139. return BitConverter.ToString(hash).Replace("-", string.Empty);
  140. }
  141. }
  142. /// <summary>
  143. /// Loads the users from the repository
  144. /// </summary>
  145. /// <returns>IEnumerable{User}.</returns>
  146. private async Task<IEnumerable<User>> LoadUsers()
  147. {
  148. var users = UserRepository.RetrieveAllUsers().ToList();
  149. // There always has to be at least one user.
  150. if (users.Count == 0)
  151. {
  152. var name = Environment.UserName;
  153. var user = InstantiateNewUser(name);
  154. user.DateLastSaved = DateTime.UtcNow;
  155. await UserRepository.SaveUser(user, CancellationToken.None).ConfigureAwait(false);
  156. users.Add(user);
  157. }
  158. return users;
  159. }
  160. /// <summary>
  161. /// Refreshes metadata for each user
  162. /// </summary>
  163. /// <param name="cancellationToken">The cancellation token.</param>
  164. /// <param name="force">if set to <c>true</c> [force].</param>
  165. /// <returns>Task.</returns>
  166. public Task RefreshUsersMetadata(CancellationToken cancellationToken, bool force = false)
  167. {
  168. var tasks = Users.Select(user => user.RefreshMetadata(cancellationToken, forceRefresh: force)).ToList();
  169. return Task.WhenAll(tasks);
  170. }
  171. /// <summary>
  172. /// Renames the user.
  173. /// </summary>
  174. /// <param name="user">The user.</param>
  175. /// <param name="newName">The new name.</param>
  176. /// <returns>Task.</returns>
  177. /// <exception cref="System.ArgumentNullException">user</exception>
  178. /// <exception cref="System.ArgumentException"></exception>
  179. public async Task RenameUser(User user, string newName)
  180. {
  181. if (user == null)
  182. {
  183. throw new ArgumentNullException("user");
  184. }
  185. if (string.IsNullOrEmpty(newName))
  186. {
  187. throw new ArgumentNullException("newName");
  188. }
  189. if (Users.Any(u => u.Id != user.Id && u.Name.Equals(newName, StringComparison.OrdinalIgnoreCase)))
  190. {
  191. throw new ArgumentException(string.Format("A user with the name '{0}' already exists.", newName));
  192. }
  193. if (user.Name.Equals(newName, StringComparison.Ordinal))
  194. {
  195. throw new ArgumentException("The new and old names must be different.");
  196. }
  197. await user.Rename(newName);
  198. OnUserUpdated(user);
  199. }
  200. /// <summary>
  201. /// Updates the user.
  202. /// </summary>
  203. /// <param name="user">The user.</param>
  204. /// <exception cref="System.ArgumentNullException">user</exception>
  205. /// <exception cref="System.ArgumentException"></exception>
  206. public async Task UpdateUser(User user)
  207. {
  208. if (user == null)
  209. {
  210. throw new ArgumentNullException("user");
  211. }
  212. if (user.Id == Guid.Empty || !Users.Any(u => u.Id.Equals(user.Id)))
  213. {
  214. throw new ArgumentException(string.Format("User with name '{0}' and Id {1} does not exist.", user.Name, user.Id));
  215. }
  216. user.DateModified = DateTime.UtcNow;
  217. user.DateLastSaved = DateTime.UtcNow;
  218. await UserRepository.SaveUser(user, CancellationToken.None).ConfigureAwait(false);
  219. OnUserUpdated(user);
  220. }
  221. public event EventHandler<GenericEventArgs<User>> UserCreated;
  222. /// <summary>
  223. /// Creates the user.
  224. /// </summary>
  225. /// <param name="name">The name.</param>
  226. /// <returns>User.</returns>
  227. /// <exception cref="System.ArgumentNullException">name</exception>
  228. /// <exception cref="System.ArgumentException"></exception>
  229. public async Task<User> CreateUser(string name)
  230. {
  231. if (string.IsNullOrEmpty(name))
  232. {
  233. throw new ArgumentNullException("name");
  234. }
  235. if (Users.Any(u => u.Name.Equals(name, StringComparison.OrdinalIgnoreCase)))
  236. {
  237. throw new ArgumentException(string.Format("A user with the name '{0}' already exists.", name));
  238. }
  239. var user = InstantiateNewUser(name);
  240. var list = Users.ToList();
  241. list.Add(user);
  242. Users = list;
  243. user.DateLastSaved = DateTime.UtcNow;
  244. await UserRepository.SaveUser(user, CancellationToken.None).ConfigureAwait(false);
  245. EventHelper.QueueEventIfNotNull(UserCreated, this, new GenericEventArgs<User> { Argument = user }, _logger);
  246. return user;
  247. }
  248. /// <summary>
  249. /// Deletes the user.
  250. /// </summary>
  251. /// <param name="user">The user.</param>
  252. /// <returns>Task.</returns>
  253. /// <exception cref="System.ArgumentNullException">user</exception>
  254. /// <exception cref="System.ArgumentException"></exception>
  255. public async Task DeleteUser(User user)
  256. {
  257. if (user == null)
  258. {
  259. throw new ArgumentNullException("user");
  260. }
  261. var allUsers = Users.ToList();
  262. if (allUsers.FirstOrDefault(u => u.Id == user.Id) == null)
  263. {
  264. 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));
  265. }
  266. if (allUsers.Count == 1)
  267. {
  268. throw new ArgumentException(string.Format("The user '{0}' cannot be deleted because there must be at least one user in the system.", user.Name));
  269. }
  270. if (user.Configuration.IsAdministrator && allUsers.Count(i => i.Configuration.IsAdministrator) == 1)
  271. {
  272. 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));
  273. }
  274. await UserRepository.DeleteUser(user, CancellationToken.None).ConfigureAwait(false);
  275. if (user.Configuration.UseCustomLibrary)
  276. {
  277. var path = user.RootFolderPath;
  278. try
  279. {
  280. Directory.Delete(path, true);
  281. }
  282. catch (IOException ex)
  283. {
  284. _logger.ErrorException("Error deleting directory {0}", ex, path);
  285. }
  286. path = user.ConfigurationFilePath;
  287. try
  288. {
  289. File.Delete(path);
  290. }
  291. catch (IOException ex)
  292. {
  293. _logger.ErrorException("Error deleting file {0}", ex, path);
  294. }
  295. }
  296. // Force this to be lazy loaded again
  297. Users = await LoadUsers().ConfigureAwait(false);
  298. OnUserDeleted(user);
  299. }
  300. /// <summary>
  301. /// Resets the password by clearing it.
  302. /// </summary>
  303. /// <returns>Task.</returns>
  304. public Task ResetPassword(User user)
  305. {
  306. return ChangePassword(user, string.Empty);
  307. }
  308. /// <summary>
  309. /// Changes the password.
  310. /// </summary>
  311. /// <param name="user">The user.</param>
  312. /// <param name="newPassword">The new password.</param>
  313. /// <returns>Task.</returns>
  314. public Task ChangePassword(User user, string newPassword)
  315. {
  316. if (user == null)
  317. {
  318. throw new ArgumentNullException("user");
  319. }
  320. user.Password = string.IsNullOrEmpty(newPassword) ? string.Empty : GetSha1String(newPassword);
  321. return UpdateUser(user);
  322. }
  323. /// <summary>
  324. /// Instantiates the new user.
  325. /// </summary>
  326. /// <param name="name">The name.</param>
  327. /// <returns>User.</returns>
  328. private User InstantiateNewUser(string name)
  329. {
  330. return new User
  331. {
  332. Name = name,
  333. Id = ("MBUser" + name).GetMD5(),
  334. DateCreated = DateTime.UtcNow,
  335. DateModified = DateTime.UtcNow
  336. };
  337. }
  338. }
  339. }