UserManager.cs 15 KB

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