UserManager.cs 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452
  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. private 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, IUserRepository userRepository)
  99. {
  100. _logger = logger;
  101. UserRepository = userRepository;
  102. ConfigurationManager = configurationManager;
  103. }
  104. #region UserUpdated Event
  105. /// <summary>
  106. /// Occurs when [user updated].
  107. /// </summary>
  108. public event EventHandler<GenericEventArgs<User>> UserUpdated;
  109. /// <summary>
  110. /// Called when [user updated].
  111. /// </summary>
  112. /// <param name="user">The user.</param>
  113. private void OnUserUpdated(User user)
  114. {
  115. EventHelper.QueueEventIfNotNull(UserUpdated, this, new GenericEventArgs<User> { Argument = user }, _logger);
  116. }
  117. #endregion
  118. #region UserDeleted Event
  119. /// <summary>
  120. /// Occurs when [user deleted].
  121. /// </summary>
  122. public event EventHandler<GenericEventArgs<User>> UserDeleted;
  123. /// <summary>
  124. /// Called when [user deleted].
  125. /// </summary>
  126. /// <param name="user">The user.</param>
  127. private void OnUserDeleted(User user)
  128. {
  129. EventHelper.QueueEventIfNotNull(UserDeleted, this, new GenericEventArgs<User> { Argument = user }, _logger);
  130. }
  131. #endregion
  132. /// <summary>
  133. /// Gets a User by Id
  134. /// </summary>
  135. /// <param name="id">The id.</param>
  136. /// <returns>User.</returns>
  137. /// <exception cref="System.ArgumentNullException"></exception>
  138. public User GetUserById(Guid id)
  139. {
  140. if (id == Guid.Empty)
  141. {
  142. throw new ArgumentNullException("id");
  143. }
  144. return Users.FirstOrDefault(u => u.Id == id);
  145. }
  146. /// <summary>
  147. /// Authenticates a User and returns a result indicating whether or not it succeeded
  148. /// </summary>
  149. /// <param name="user">The user.</param>
  150. /// <param name="password">The password.</param>
  151. /// <returns>Task{System.Boolean}.</returns>
  152. /// <exception cref="System.ArgumentNullException">user</exception>
  153. public async Task<bool> AuthenticateUser(User user, string password)
  154. {
  155. if (user == null)
  156. {
  157. throw new ArgumentNullException("user");
  158. }
  159. if (user.Configuration.IsDisabled)
  160. {
  161. throw new UnauthorizedAccessException(string.Format("The {0} account is currently disabled. Please consult with your administrator.", user.Name));
  162. }
  163. var existingPasswordString = string.IsNullOrEmpty(user.Password) ? GetSha1String(string.Empty) : user.Password;
  164. var success = string.Equals(existingPasswordString, password.Replace("-", string.Empty), StringComparison.OrdinalIgnoreCase);
  165. // Update LastActivityDate and LastLoginDate, then save
  166. if (success)
  167. {
  168. user.LastActivityDate = user.LastLoginDate = DateTime.UtcNow;
  169. await UpdateUser(user).ConfigureAwait(false);
  170. }
  171. _logger.Info("Authentication request for {0} {1}.", user.Name, (success ? "has succeeded" : "has been denied"));
  172. return success;
  173. }
  174. /// <summary>
  175. /// Gets the sha1 string.
  176. /// </summary>
  177. /// <param name="str">The STR.</param>
  178. /// <returns>System.String.</returns>
  179. private static string GetSha1String(string str)
  180. {
  181. using (var provider = SHA1.Create())
  182. {
  183. var hash = provider.ComputeHash(Encoding.UTF8.GetBytes(str));
  184. return BitConverter.ToString(hash).Replace("-", string.Empty);
  185. }
  186. }
  187. /// <summary>
  188. /// Loads the users from the repository
  189. /// </summary>
  190. /// <returns>IEnumerable{User}.</returns>
  191. private IEnumerable<User> LoadUsers()
  192. {
  193. var users = UserRepository.RetrieveAllUsers().ToList();
  194. // There always has to be at least one user.
  195. if (users.Count == 0)
  196. {
  197. var name = Environment.UserName;
  198. var user = InstantiateNewUser(name);
  199. var task = UserRepository.SaveUser(user, CancellationToken.None);
  200. // Hate having to block threads
  201. Task.WaitAll(task);
  202. users.Add(user);
  203. }
  204. return users;
  205. }
  206. /// <summary>
  207. /// Refreshes metadata for each user
  208. /// </summary>
  209. /// <param name="cancellationToken">The cancellation token.</param>
  210. /// <param name="force">if set to <c>true</c> [force].</param>
  211. /// <returns>Task.</returns>
  212. public Task RefreshUsersMetadata(CancellationToken cancellationToken, bool force = false)
  213. {
  214. var tasks = Users.Select(user => user.RefreshMetadata(cancellationToken, forceRefresh: force)).ToList();
  215. return Task.WhenAll(tasks);
  216. }
  217. /// <summary>
  218. /// Renames the user.
  219. /// </summary>
  220. /// <param name="user">The user.</param>
  221. /// <param name="newName">The new name.</param>
  222. /// <returns>Task.</returns>
  223. /// <exception cref="System.ArgumentNullException">user</exception>
  224. /// <exception cref="System.ArgumentException"></exception>
  225. public async Task RenameUser(User user, string newName)
  226. {
  227. if (user == null)
  228. {
  229. throw new ArgumentNullException("user");
  230. }
  231. if (string.IsNullOrEmpty(newName))
  232. {
  233. throw new ArgumentNullException("newName");
  234. }
  235. if (Users.Any(u => u.Id != user.Id && u.Name.Equals(newName, StringComparison.OrdinalIgnoreCase)))
  236. {
  237. throw new ArgumentException(string.Format("A user with the name '{0}' already exists.", newName));
  238. }
  239. if (user.Name.Equals(newName, StringComparison.Ordinal))
  240. {
  241. throw new ArgumentException("The new and old names must be different.");
  242. }
  243. await user.Rename(newName);
  244. OnUserUpdated(user);
  245. }
  246. /// <summary>
  247. /// Updates the user.
  248. /// </summary>
  249. /// <param name="user">The user.</param>
  250. /// <exception cref="System.ArgumentNullException">user</exception>
  251. /// <exception cref="System.ArgumentException"></exception>
  252. public async Task UpdateUser(User user)
  253. {
  254. if (user == null)
  255. {
  256. throw new ArgumentNullException("user");
  257. }
  258. if (user.Id == Guid.Empty || !Users.Any(u => u.Id.Equals(user.Id)))
  259. {
  260. throw new ArgumentException(string.Format("User with name '{0}' and Id {1} does not exist.", user.Name, user.Id));
  261. }
  262. user.DateModified = DateTime.UtcNow;
  263. await UserRepository.SaveUser(user, CancellationToken.None).ConfigureAwait(false);
  264. OnUserUpdated(user);
  265. }
  266. public event EventHandler<GenericEventArgs<User>> UserCreated;
  267. /// <summary>
  268. /// Creates the user.
  269. /// </summary>
  270. /// <param name="name">The name.</param>
  271. /// <returns>User.</returns>
  272. /// <exception cref="System.ArgumentNullException">name</exception>
  273. /// <exception cref="System.ArgumentException"></exception>
  274. public async Task<User> CreateUser(string name)
  275. {
  276. if (string.IsNullOrEmpty(name))
  277. {
  278. throw new ArgumentNullException("name");
  279. }
  280. if (Users.Any(u => u.Name.Equals(name, StringComparison.OrdinalIgnoreCase)))
  281. {
  282. throw new ArgumentException(string.Format("A user with the name '{0}' already exists.", name));
  283. }
  284. var user = InstantiateNewUser(name);
  285. var list = Users.ToList();
  286. list.Add(user);
  287. Users = list;
  288. await UserRepository.SaveUser(user, CancellationToken.None).ConfigureAwait(false);
  289. EventHelper.QueueEventIfNotNull(UserCreated, this, new GenericEventArgs<User> { Argument = user }, _logger);
  290. return user;
  291. }
  292. /// <summary>
  293. /// Deletes the user.
  294. /// </summary>
  295. /// <param name="user">The user.</param>
  296. /// <returns>Task.</returns>
  297. /// <exception cref="System.ArgumentNullException">user</exception>
  298. /// <exception cref="System.ArgumentException"></exception>
  299. public async Task DeleteUser(User user)
  300. {
  301. if (user == null)
  302. {
  303. throw new ArgumentNullException("user");
  304. }
  305. var allUsers = Users.ToList();
  306. if (allUsers.FirstOrDefault(u => u.Id == user.Id) == null)
  307. {
  308. 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));
  309. }
  310. if (allUsers.Count == 1)
  311. {
  312. throw new ArgumentException(string.Format("The user '{0}' cannot be deleted because there must be at least one user in the system.", user.Name));
  313. }
  314. if (user.Configuration.IsAdministrator && allUsers.Count(i => i.Configuration.IsAdministrator) == 1)
  315. {
  316. 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));
  317. }
  318. await UserRepository.DeleteUser(user, CancellationToken.None).ConfigureAwait(false);
  319. if (user.Configuration.UseCustomLibrary)
  320. {
  321. var path = user.RootFolderPath;
  322. try
  323. {
  324. Directory.Delete(path, true);
  325. }
  326. catch (IOException ex)
  327. {
  328. _logger.ErrorException("Error deleting directory {0}", ex, path);
  329. }
  330. path = user.ConfigurationFilePath;
  331. try
  332. {
  333. File.Delete(path);
  334. }
  335. catch (IOException ex)
  336. {
  337. _logger.ErrorException("Error deleting file {0}", ex, path);
  338. }
  339. }
  340. OnUserDeleted(user);
  341. // Force this to be lazy loaded again
  342. Users = null;
  343. }
  344. /// <summary>
  345. /// Resets the password by clearing it.
  346. /// </summary>
  347. /// <returns>Task.</returns>
  348. public Task ResetPassword(User user)
  349. {
  350. return ChangePassword(user, string.Empty);
  351. }
  352. /// <summary>
  353. /// Changes the password.
  354. /// </summary>
  355. /// <param name="user">The user.</param>
  356. /// <param name="newPassword">The new password.</param>
  357. /// <returns>Task.</returns>
  358. public Task ChangePassword(User user, string newPassword)
  359. {
  360. if (user == null)
  361. {
  362. throw new ArgumentNullException("user");
  363. }
  364. user.Password = string.IsNullOrEmpty(newPassword) ? string.Empty : GetSha1String(newPassword);
  365. return UpdateUser(user);
  366. }
  367. /// <summary>
  368. /// Instantiates the new user.
  369. /// </summary>
  370. /// <param name="name">The name.</param>
  371. /// <returns>User.</returns>
  372. private User InstantiateNewUser(string name)
  373. {
  374. return new User
  375. {
  376. Name = name,
  377. Id = ("MBUser" + name).GetMD5(),
  378. DateCreated = DateTime.UtcNow,
  379. DateModified = DateTime.UtcNow
  380. };
  381. }
  382. }
  383. }