UserManager.cs 15 KB

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