UserManager.cs 15 KB

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