UserManager.cs 15 KB

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