SessionManager.cs 69 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930
  1. using MediaBrowser.Common.Events;
  2. using MediaBrowser.Common.Extensions;
  3. using MediaBrowser.Common.Net;
  4. using MediaBrowser.Controller;
  5. using MediaBrowser.Controller.Devices;
  6. using MediaBrowser.Controller.Drawing;
  7. using MediaBrowser.Controller.Dto;
  8. using MediaBrowser.Controller.Entities;
  9. using MediaBrowser.Controller.Entities.Audio;
  10. using MediaBrowser.Controller.Entities.TV;
  11. using MediaBrowser.Controller.Library;
  12. using MediaBrowser.Controller.LiveTv;
  13. using MediaBrowser.Controller.Persistence;
  14. using MediaBrowser.Controller.Security;
  15. using MediaBrowser.Controller.Session;
  16. using MediaBrowser.Model.Devices;
  17. using MediaBrowser.Model.Dto;
  18. using MediaBrowser.Model.Entities;
  19. using MediaBrowser.Model.Events;
  20. using MediaBrowser.Model.Library;
  21. using MediaBrowser.Model.Logging;
  22. using MediaBrowser.Model.Serialization;
  23. using MediaBrowser.Model.Session;
  24. using MediaBrowser.Model.Users;
  25. using System;
  26. using System.Collections.Concurrent;
  27. using System.Collections.Generic;
  28. using System.Globalization;
  29. using System.Linq;
  30. using System.Threading;
  31. using System.Threading.Tasks;
  32. using MediaBrowser.Controller.Net;
  33. namespace MediaBrowser.Server.Implementations.Session
  34. {
  35. /// <summary>
  36. /// Class SessionManager
  37. /// </summary>
  38. public class SessionManager : ISessionManager
  39. {
  40. /// <summary>
  41. /// The _user data repository
  42. /// </summary>
  43. private readonly IUserDataManager _userDataRepository;
  44. /// <summary>
  45. /// The _user repository
  46. /// </summary>
  47. private readonly IUserRepository _userRepository;
  48. /// <summary>
  49. /// The _logger
  50. /// </summary>
  51. private readonly ILogger _logger;
  52. private readonly ILibraryManager _libraryManager;
  53. private readonly IUserManager _userManager;
  54. private readonly IMusicManager _musicManager;
  55. private readonly IDtoService _dtoService;
  56. private readonly IImageProcessor _imageProcessor;
  57. private readonly IMediaSourceManager _mediaSourceManager;
  58. private readonly IHttpClient _httpClient;
  59. private readonly IJsonSerializer _jsonSerializer;
  60. private readonly IServerApplicationHost _appHost;
  61. private readonly IAuthenticationRepository _authRepo;
  62. private readonly IDeviceManager _deviceManager;
  63. /// <summary>
  64. /// The _active connections
  65. /// </summary>
  66. private readonly ConcurrentDictionary<string, SessionInfo> _activeConnections =
  67. new ConcurrentDictionary<string, SessionInfo>(StringComparer.OrdinalIgnoreCase);
  68. public event EventHandler<GenericEventArgs<AuthenticationRequest>> AuthenticationFailed;
  69. public event EventHandler<GenericEventArgs<AuthenticationRequest>> AuthenticationSucceeded;
  70. /// <summary>
  71. /// Occurs when [playback start].
  72. /// </summary>
  73. public event EventHandler<PlaybackProgressEventArgs> PlaybackStart;
  74. /// <summary>
  75. /// Occurs when [playback progress].
  76. /// </summary>
  77. public event EventHandler<PlaybackProgressEventArgs> PlaybackProgress;
  78. /// <summary>
  79. /// Occurs when [playback stopped].
  80. /// </summary>
  81. public event EventHandler<PlaybackStopEventArgs> PlaybackStopped;
  82. public event EventHandler<SessionEventArgs> SessionStarted;
  83. public event EventHandler<SessionEventArgs> CapabilitiesChanged;
  84. public event EventHandler<SessionEventArgs> SessionEnded;
  85. public event EventHandler<SessionEventArgs> SessionActivity;
  86. private IEnumerable<ISessionControllerFactory> _sessionFactories = new List<ISessionControllerFactory>();
  87. private readonly SemaphoreSlim _sessionLock = new SemaphoreSlim(1, 1);
  88. public SessionManager(IUserDataManager userDataRepository, ILogger logger, IUserRepository userRepository, ILibraryManager libraryManager, IUserManager userManager, IMusicManager musicManager, IDtoService dtoService, IImageProcessor imageProcessor, IJsonSerializer jsonSerializer, IServerApplicationHost appHost, IHttpClient httpClient, IAuthenticationRepository authRepo, IDeviceManager deviceManager, IMediaSourceManager mediaSourceManager)
  89. {
  90. _userDataRepository = userDataRepository;
  91. _logger = logger;
  92. _userRepository = userRepository;
  93. _libraryManager = libraryManager;
  94. _userManager = userManager;
  95. _musicManager = musicManager;
  96. _dtoService = dtoService;
  97. _imageProcessor = imageProcessor;
  98. _jsonSerializer = jsonSerializer;
  99. _appHost = appHost;
  100. _httpClient = httpClient;
  101. _authRepo = authRepo;
  102. _deviceManager = deviceManager;
  103. _mediaSourceManager = mediaSourceManager;
  104. _deviceManager.DeviceOptionsUpdated += _deviceManager_DeviceOptionsUpdated;
  105. }
  106. void _deviceManager_DeviceOptionsUpdated(object sender, GenericEventArgs<DeviceInfo> e)
  107. {
  108. foreach (var session in Sessions)
  109. {
  110. if (string.Equals(session.DeviceId, e.Argument.Id))
  111. {
  112. session.DeviceName = e.Argument.Name;
  113. }
  114. }
  115. }
  116. /// <summary>
  117. /// Adds the parts.
  118. /// </summary>
  119. /// <param name="sessionFactories">The session factories.</param>
  120. public void AddParts(IEnumerable<ISessionControllerFactory> sessionFactories)
  121. {
  122. _sessionFactories = sessionFactories.ToList();
  123. }
  124. /// <summary>
  125. /// Gets all connections.
  126. /// </summary>
  127. /// <value>All connections.</value>
  128. public IEnumerable<SessionInfo> Sessions
  129. {
  130. get { return _activeConnections.Values.OrderByDescending(c => c.LastActivityDate).ToList(); }
  131. }
  132. private void OnSessionStarted(SessionInfo info)
  133. {
  134. EventHelper.QueueEventIfNotNull(SessionStarted, this, new SessionEventArgs
  135. {
  136. SessionInfo = info
  137. }, _logger);
  138. if (!string.IsNullOrWhiteSpace(info.DeviceId))
  139. {
  140. var capabilities = GetSavedCapabilities(info.DeviceId);
  141. if (capabilities != null)
  142. {
  143. info.AppIconUrl = capabilities.IconUrl;
  144. ReportCapabilities(info, capabilities, false);
  145. }
  146. }
  147. }
  148. private async void OnSessionEnded(SessionInfo info)
  149. {
  150. try
  151. {
  152. await SendSessionEndedNotification(info, CancellationToken.None).ConfigureAwait(false);
  153. }
  154. catch (Exception ex)
  155. {
  156. _logger.ErrorException("Error in SendSessionEndedNotification", ex);
  157. }
  158. EventHelper.QueueEventIfNotNull(SessionEnded, this, new SessionEventArgs
  159. {
  160. SessionInfo = info
  161. }, _logger);
  162. var disposable = info.SessionController as IDisposable;
  163. if (disposable != null)
  164. {
  165. _logger.Debug("Disposing session controller {0}", disposable.GetType().Name);
  166. try
  167. {
  168. disposable.Dispose();
  169. }
  170. catch (Exception ex)
  171. {
  172. _logger.ErrorException("Error disposing session controller", ex);
  173. }
  174. }
  175. }
  176. /// <summary>
  177. /// Logs the user activity.
  178. /// </summary>
  179. /// <param name="appName">Type of the client.</param>
  180. /// <param name="appVersion">The app version.</param>
  181. /// <param name="deviceId">The device id.</param>
  182. /// <param name="deviceName">Name of the device.</param>
  183. /// <param name="remoteEndPoint">The remote end point.</param>
  184. /// <param name="user">The user.</param>
  185. /// <returns>Task.</returns>
  186. /// <exception cref="System.ArgumentNullException">user</exception>
  187. /// <exception cref="System.UnauthorizedAccessException"></exception>
  188. public async Task<SessionInfo> LogSessionActivity(string appName,
  189. string appVersion,
  190. string deviceId,
  191. string deviceName,
  192. string remoteEndPoint,
  193. User user)
  194. {
  195. if (string.IsNullOrEmpty(appName))
  196. {
  197. throw new ArgumentNullException("appName");
  198. }
  199. if (string.IsNullOrEmpty(appVersion))
  200. {
  201. throw new ArgumentNullException("appVersion");
  202. }
  203. if (string.IsNullOrEmpty(deviceId))
  204. {
  205. throw new ArgumentNullException("deviceId");
  206. }
  207. if (string.IsNullOrEmpty(deviceName))
  208. {
  209. throw new ArgumentNullException("deviceName");
  210. }
  211. var activityDate = DateTime.UtcNow;
  212. var session = await GetSessionInfo(appName, appVersion, deviceId, deviceName, remoteEndPoint, user).ConfigureAwait(false);
  213. var lastActivityDate = session.LastActivityDate;
  214. session.LastActivityDate = activityDate;
  215. if (user != null)
  216. {
  217. var userLastActivityDate = user.LastActivityDate ?? DateTime.MinValue;
  218. user.LastActivityDate = activityDate;
  219. // Don't log in the db anymore frequently than 10 seconds
  220. if ((activityDate - userLastActivityDate).TotalSeconds > 10)
  221. {
  222. try
  223. {
  224. // Save this directly. No need to fire off all the events for this.
  225. await _userRepository.SaveUser(user, CancellationToken.None).ConfigureAwait(false);
  226. }
  227. catch (Exception ex)
  228. {
  229. _logger.ErrorException("Error updating user", ex);
  230. }
  231. }
  232. }
  233. if ((activityDate - lastActivityDate).TotalSeconds > 10)
  234. {
  235. EventHelper.FireEventIfNotNull(SessionActivity, this, new SessionEventArgs
  236. {
  237. SessionInfo = session
  238. }, _logger);
  239. }
  240. var controller = session.SessionController;
  241. if (controller != null)
  242. {
  243. controller.OnActivity();
  244. }
  245. return session;
  246. }
  247. public async void ReportSessionEnded(string sessionId)
  248. {
  249. await _sessionLock.WaitAsync(CancellationToken.None).ConfigureAwait(false);
  250. try
  251. {
  252. var session = GetSession(sessionId, false);
  253. if (session != null)
  254. {
  255. var key = GetSessionKey(session.Client, session.DeviceId);
  256. SessionInfo removed;
  257. _activeConnections.TryRemove(key, out removed);
  258. OnSessionEnded(session);
  259. }
  260. }
  261. finally
  262. {
  263. _sessionLock.Release();
  264. }
  265. }
  266. private Task<MediaSourceInfo> GetMediaSource(IHasMediaSources item, string mediaSourceId, string liveStreamId)
  267. {
  268. return _mediaSourceManager.GetMediaSource(item, mediaSourceId, liveStreamId, false, CancellationToken.None);
  269. }
  270. /// <summary>
  271. /// Updates the now playing item id.
  272. /// </summary>
  273. /// <param name="session">The session.</param>
  274. /// <param name="info">The information.</param>
  275. /// <param name="libraryItem">The library item.</param>
  276. private async Task UpdateNowPlayingItem(SessionInfo session, PlaybackProgressInfo info, BaseItem libraryItem)
  277. {
  278. if (string.IsNullOrWhiteSpace(info.MediaSourceId))
  279. {
  280. info.MediaSourceId = info.ItemId;
  281. }
  282. if (!string.IsNullOrWhiteSpace(info.ItemId) && info.Item == null && libraryItem != null)
  283. {
  284. var current = session.NowPlayingItem;
  285. if (current == null || !string.Equals(current.Id, info.ItemId, StringComparison.OrdinalIgnoreCase))
  286. {
  287. var runtimeTicks = libraryItem.RunTimeTicks;
  288. MediaSourceInfo mediaSource = null;
  289. var hasMediaSources = libraryItem as IHasMediaSources;
  290. if (hasMediaSources != null)
  291. {
  292. mediaSource = await GetMediaSource(hasMediaSources, info.MediaSourceId, info.LiveStreamId).ConfigureAwait(false);
  293. if (mediaSource != null)
  294. {
  295. runtimeTicks = mediaSource.RunTimeTicks;
  296. }
  297. }
  298. info.Item = GetItemInfo(libraryItem, libraryItem, mediaSource);
  299. info.Item.RunTimeTicks = runtimeTicks;
  300. }
  301. else
  302. {
  303. info.Item = current;
  304. }
  305. }
  306. session.NowPlayingItem = info.Item;
  307. session.LastActivityDate = DateTime.UtcNow;
  308. session.LastPlaybackCheckIn = DateTime.UtcNow;
  309. session.PlayState.IsPaused = info.IsPaused;
  310. session.PlayState.PositionTicks = info.PositionTicks;
  311. session.PlayState.MediaSourceId = info.MediaSourceId;
  312. session.PlayState.CanSeek = info.CanSeek;
  313. session.PlayState.IsMuted = info.IsMuted;
  314. session.PlayState.VolumeLevel = info.VolumeLevel;
  315. session.PlayState.AudioStreamIndex = info.AudioStreamIndex;
  316. session.PlayState.SubtitleStreamIndex = info.SubtitleStreamIndex;
  317. session.PlayState.PlayMethod = info.PlayMethod;
  318. session.PlayState.RepeatMode = info.RepeatMode;
  319. }
  320. /// <summary>
  321. /// Removes the now playing item id.
  322. /// </summary>
  323. /// <param name="session">The session.</param>
  324. /// <exception cref="System.ArgumentNullException">item</exception>
  325. private void RemoveNowPlayingItem(SessionInfo session)
  326. {
  327. session.NowPlayingItem = null;
  328. session.PlayState = new PlayerStateInfo();
  329. if (!string.IsNullOrEmpty(session.DeviceId))
  330. {
  331. ClearTranscodingInfo(session.DeviceId);
  332. }
  333. }
  334. private string GetSessionKey(string appName, string deviceId)
  335. {
  336. return appName + deviceId;
  337. }
  338. /// <summary>
  339. /// Gets the connection.
  340. /// </summary>
  341. /// <param name="appName">Type of the client.</param>
  342. /// <param name="appVersion">The app version.</param>
  343. /// <param name="deviceId">The device id.</param>
  344. /// <param name="deviceName">Name of the device.</param>
  345. /// <param name="remoteEndPoint">The remote end point.</param>
  346. /// <param name="user">The user.</param>
  347. /// <returns>SessionInfo.</returns>
  348. private async Task<SessionInfo> GetSessionInfo(string appName, string appVersion, string deviceId, string deviceName, string remoteEndPoint, User user)
  349. {
  350. if (string.IsNullOrWhiteSpace(deviceId))
  351. {
  352. throw new ArgumentNullException("deviceId");
  353. }
  354. var key = GetSessionKey(appName, deviceId);
  355. await _sessionLock.WaitAsync(CancellationToken.None).ConfigureAwait(false);
  356. var userId = user == null ? (Guid?)null : user.Id;
  357. var username = user == null ? null : user.Name;
  358. try
  359. {
  360. SessionInfo sessionInfo;
  361. DeviceInfo device = null;
  362. if (!_activeConnections.TryGetValue(key, out sessionInfo))
  363. {
  364. sessionInfo = new SessionInfo
  365. {
  366. Client = appName,
  367. DeviceId = deviceId,
  368. ApplicationVersion = appVersion,
  369. Id = key.GetMD5().ToString("N")
  370. };
  371. sessionInfo.DeviceName = deviceName;
  372. sessionInfo.UserId = userId;
  373. sessionInfo.UserName = username;
  374. sessionInfo.RemoteEndPoint = remoteEndPoint;
  375. OnSessionStarted(sessionInfo);
  376. _activeConnections.TryAdd(key, sessionInfo);
  377. if (!string.IsNullOrEmpty(deviceId))
  378. {
  379. var userIdString = userId.HasValue ? userId.Value.ToString("N") : null;
  380. device = await _deviceManager.RegisterDevice(deviceId, deviceName, appName, appVersion, userIdString).ConfigureAwait(false);
  381. }
  382. }
  383. device = device ?? _deviceManager.GetDevice(deviceId);
  384. if (device == null)
  385. {
  386. var userIdString = userId.HasValue ? userId.Value.ToString("N") : null;
  387. device = await _deviceManager.RegisterDevice(deviceId, deviceName, appName, appVersion, userIdString).ConfigureAwait(false);
  388. }
  389. if (device != null)
  390. {
  391. if (!string.IsNullOrEmpty(device.CustomName))
  392. {
  393. deviceName = device.CustomName;
  394. }
  395. }
  396. sessionInfo.DeviceName = deviceName;
  397. sessionInfo.UserId = userId;
  398. sessionInfo.UserName = username;
  399. sessionInfo.RemoteEndPoint = remoteEndPoint;
  400. sessionInfo.ApplicationVersion = appVersion;
  401. if (!userId.HasValue)
  402. {
  403. sessionInfo.AdditionalUsers.Clear();
  404. }
  405. if (sessionInfo.SessionController == null)
  406. {
  407. sessionInfo.SessionController = _sessionFactories
  408. .Select(i => i.GetSessionController(sessionInfo))
  409. .FirstOrDefault(i => i != null);
  410. }
  411. return sessionInfo;
  412. }
  413. finally
  414. {
  415. _sessionLock.Release();
  416. }
  417. }
  418. private List<User> GetUsers(SessionInfo session)
  419. {
  420. var users = new List<User>();
  421. if (session.UserId.HasValue)
  422. {
  423. var user = _userManager.GetUserById(session.UserId.Value);
  424. if (user == null)
  425. {
  426. throw new InvalidOperationException("User not found");
  427. }
  428. users.Add(user);
  429. var additionalUsers = session.AdditionalUsers
  430. .Select(i => _userManager.GetUserById(i.UserId))
  431. .Where(i => i != null);
  432. users.AddRange(additionalUsers);
  433. }
  434. return users;
  435. }
  436. private Timer _idleTimer;
  437. private void StartIdleCheckTimer()
  438. {
  439. if (_idleTimer == null)
  440. {
  441. _idleTimer = new Timer(CheckForIdlePlayback, null, TimeSpan.FromMinutes(5), TimeSpan.FromMinutes(5));
  442. }
  443. }
  444. private void StopIdleCheckTimer()
  445. {
  446. if (_idleTimer != null)
  447. {
  448. _idleTimer.Dispose();
  449. _idleTimer = null;
  450. }
  451. }
  452. private async void CheckForIdlePlayback(object state)
  453. {
  454. var playingSessions = Sessions.Where(i => i.NowPlayingItem != null)
  455. .ToList();
  456. if (playingSessions.Count > 0)
  457. {
  458. var idle = playingSessions
  459. .Where(i => (DateTime.UtcNow - i.LastPlaybackCheckIn).TotalMinutes > 5)
  460. .ToList();
  461. foreach (var session in idle)
  462. {
  463. _logger.Debug("Session {0} has gone idle while playing", session.Id);
  464. try
  465. {
  466. await OnPlaybackStopped(new PlaybackStopInfo
  467. {
  468. Item = session.NowPlayingItem,
  469. ItemId = session.NowPlayingItem == null ? null : session.NowPlayingItem.Id,
  470. SessionId = session.Id,
  471. MediaSourceId = session.PlayState == null ? null : session.PlayState.MediaSourceId,
  472. PositionTicks = session.PlayState == null ? null : session.PlayState.PositionTicks
  473. });
  474. }
  475. catch (Exception ex)
  476. {
  477. _logger.Debug("Error calling OnPlaybackStopped", ex);
  478. }
  479. }
  480. playingSessions = Sessions.Where(i => i.NowPlayingItem != null)
  481. .ToList();
  482. }
  483. if (playingSessions.Count == 0)
  484. {
  485. StopIdleCheckTimer();
  486. }
  487. }
  488. /// <summary>
  489. /// Used to report that playback has started for an item
  490. /// </summary>
  491. /// <param name="info">The info.</param>
  492. /// <returns>Task.</returns>
  493. /// <exception cref="System.ArgumentNullException">info</exception>
  494. public async Task OnPlaybackStart(PlaybackStartInfo info)
  495. {
  496. if (info == null)
  497. {
  498. throw new ArgumentNullException("info");
  499. }
  500. var session = GetSession(info.SessionId);
  501. var libraryItem = string.IsNullOrWhiteSpace(info.ItemId)
  502. ? null
  503. : _libraryManager.GetItemById(new Guid(info.ItemId));
  504. await UpdateNowPlayingItem(session, info, libraryItem).ConfigureAwait(false);
  505. if (!string.IsNullOrEmpty(session.DeviceId) && info.PlayMethod != PlayMethod.Transcode)
  506. {
  507. ClearTranscodingInfo(session.DeviceId);
  508. }
  509. session.QueueableMediaTypes = info.QueueableMediaTypes;
  510. var users = GetUsers(session);
  511. if (libraryItem != null)
  512. {
  513. foreach (var user in users)
  514. {
  515. await OnPlaybackStart(user.Id, libraryItem).ConfigureAwait(false);
  516. }
  517. }
  518. // Nothing to save here
  519. // Fire events to inform plugins
  520. EventHelper.QueueEventIfNotNull(PlaybackStart, this, new PlaybackProgressEventArgs
  521. {
  522. Item = libraryItem,
  523. Users = users,
  524. MediaSourceId = info.MediaSourceId,
  525. MediaInfo = info.Item,
  526. DeviceName = session.DeviceName,
  527. ClientName = session.Client,
  528. DeviceId = session.DeviceId
  529. }, _logger);
  530. await SendPlaybackStartNotification(session, CancellationToken.None).ConfigureAwait(false);
  531. StartIdleCheckTimer();
  532. }
  533. /// <summary>
  534. /// Called when [playback start].
  535. /// </summary>
  536. /// <param name="userId">The user identifier.</param>
  537. /// <param name="item">The item.</param>
  538. /// <returns>Task.</returns>
  539. private async Task OnPlaybackStart(Guid userId, IHasUserData item)
  540. {
  541. var data = _userDataRepository.GetUserData(userId, item);
  542. data.PlayCount++;
  543. data.LastPlayedDate = DateTime.UtcNow;
  544. if (!(item is Video))
  545. {
  546. data.Played = true;
  547. }
  548. await _userDataRepository.SaveUserData(userId, item, data, UserDataSaveReason.PlaybackStart, CancellationToken.None).ConfigureAwait(false);
  549. }
  550. /// <summary>
  551. /// Used to report playback progress for an item
  552. /// </summary>
  553. /// <param name="info">The info.</param>
  554. /// <returns>Task.</returns>
  555. /// <exception cref="System.ArgumentNullException"></exception>
  556. /// <exception cref="System.ArgumentOutOfRangeException">positionTicks</exception>
  557. public async Task OnPlaybackProgress(PlaybackProgressInfo info)
  558. {
  559. if (info == null)
  560. {
  561. throw new ArgumentNullException("info");
  562. }
  563. var session = GetSession(info.SessionId);
  564. var libraryItem = string.IsNullOrWhiteSpace(info.ItemId)
  565. ? null
  566. : _libraryManager.GetItemById(new Guid(info.ItemId));
  567. await UpdateNowPlayingItem(session, info, libraryItem).ConfigureAwait(false);
  568. var users = GetUsers(session);
  569. if (libraryItem != null)
  570. {
  571. foreach (var user in users)
  572. {
  573. await OnPlaybackProgress(user, libraryItem, info).ConfigureAwait(false);
  574. }
  575. }
  576. if (!string.IsNullOrWhiteSpace(info.LiveStreamId))
  577. {
  578. try
  579. {
  580. await _mediaSourceManager.PingLiveStream(info.LiveStreamId, CancellationToken.None).ConfigureAwait(false);
  581. }
  582. catch (Exception ex)
  583. {
  584. _logger.ErrorException("Error closing live stream", ex);
  585. }
  586. }
  587. EventHelper.FireEventIfNotNull(PlaybackProgress, this, new PlaybackProgressEventArgs
  588. {
  589. Item = libraryItem,
  590. Users = users,
  591. PlaybackPositionTicks = session.PlayState.PositionTicks,
  592. MediaSourceId = session.PlayState.MediaSourceId,
  593. MediaInfo = info.Item,
  594. DeviceName = session.DeviceName,
  595. ClientName = session.Client,
  596. DeviceId = session.DeviceId,
  597. IsPaused = info.IsPaused,
  598. PlaySessionId = info.PlaySessionId
  599. }, _logger);
  600. StartIdleCheckTimer();
  601. }
  602. private async Task OnPlaybackProgress(User user, BaseItem item, PlaybackProgressInfo info)
  603. {
  604. var data = _userDataRepository.GetUserData(user.Id, item);
  605. var positionTicks = info.PositionTicks;
  606. if (positionTicks.HasValue)
  607. {
  608. _userDataRepository.UpdatePlayState(item, data, positionTicks.Value);
  609. UpdatePlaybackSettings(user, info, data);
  610. await _userDataRepository.SaveUserData(user.Id, item, data, UserDataSaveReason.PlaybackProgress, CancellationToken.None).ConfigureAwait(false);
  611. }
  612. }
  613. private void UpdatePlaybackSettings(User user, PlaybackProgressInfo info, UserItemData data)
  614. {
  615. if (user.Configuration.RememberAudioSelections)
  616. {
  617. data.AudioStreamIndex = info.AudioStreamIndex;
  618. }
  619. else
  620. {
  621. data.AudioStreamIndex = null;
  622. }
  623. if (user.Configuration.RememberSubtitleSelections)
  624. {
  625. data.SubtitleStreamIndex = info.SubtitleStreamIndex;
  626. }
  627. else
  628. {
  629. data.SubtitleStreamIndex = null;
  630. }
  631. }
  632. /// <summary>
  633. /// Used to report that playback has ended for an item
  634. /// </summary>
  635. /// <param name="info">The info.</param>
  636. /// <returns>Task.</returns>
  637. /// <exception cref="System.ArgumentNullException">info</exception>
  638. /// <exception cref="System.ArgumentOutOfRangeException">positionTicks</exception>
  639. public async Task OnPlaybackStopped(PlaybackStopInfo info)
  640. {
  641. if (info == null)
  642. {
  643. throw new ArgumentNullException("info");
  644. }
  645. if (info.PositionTicks.HasValue && info.PositionTicks.Value < 0)
  646. {
  647. throw new ArgumentOutOfRangeException("positionTicks");
  648. }
  649. var session = GetSession(info.SessionId);
  650. var libraryItem = string.IsNullOrWhiteSpace(info.ItemId)
  651. ? null
  652. : _libraryManager.GetItemById(new Guid(info.ItemId));
  653. // Normalize
  654. if (string.IsNullOrWhiteSpace(info.MediaSourceId))
  655. {
  656. info.MediaSourceId = info.ItemId;
  657. }
  658. if (!string.IsNullOrWhiteSpace(info.ItemId) && info.Item == null && libraryItem != null)
  659. {
  660. var current = session.NowPlayingItem;
  661. if (current == null || !string.Equals(current.Id, info.ItemId, StringComparison.OrdinalIgnoreCase))
  662. {
  663. MediaSourceInfo mediaSource = null;
  664. var hasMediaSources = libraryItem as IHasMediaSources;
  665. if (hasMediaSources != null)
  666. {
  667. mediaSource = await GetMediaSource(hasMediaSources, info.MediaSourceId, info.LiveStreamId).ConfigureAwait(false);
  668. }
  669. info.Item = GetItemInfo(libraryItem, libraryItem, mediaSource);
  670. }
  671. else
  672. {
  673. info.Item = current;
  674. }
  675. }
  676. RemoveNowPlayingItem(session);
  677. var users = GetUsers(session);
  678. var playedToCompletion = false;
  679. if (libraryItem != null)
  680. {
  681. foreach (var user in users)
  682. {
  683. playedToCompletion = await OnPlaybackStopped(user.Id, libraryItem, info.PositionTicks, info.Failed).ConfigureAwait(false);
  684. }
  685. }
  686. if (!string.IsNullOrWhiteSpace(info.LiveStreamId))
  687. {
  688. try
  689. {
  690. await _mediaSourceManager.CloseLiveStream(info.LiveStreamId, CancellationToken.None).ConfigureAwait(false);
  691. }
  692. catch (Exception ex)
  693. {
  694. _logger.ErrorException("Error closing live stream", ex);
  695. }
  696. }
  697. EventHelper.QueueEventIfNotNull(PlaybackStopped, this, new PlaybackStopEventArgs
  698. {
  699. Item = libraryItem,
  700. Users = users,
  701. PlaybackPositionTicks = info.PositionTicks,
  702. PlayedToCompletion = playedToCompletion,
  703. MediaSourceId = info.MediaSourceId,
  704. MediaInfo = info.Item,
  705. DeviceName = session.DeviceName,
  706. ClientName = session.Client,
  707. DeviceId = session.DeviceId
  708. }, _logger);
  709. await SendPlaybackStoppedNotification(session, CancellationToken.None).ConfigureAwait(false);
  710. }
  711. private async Task<bool> OnPlaybackStopped(Guid userId, BaseItem item, long? positionTicks, bool playbackFailed)
  712. {
  713. bool playedToCompletion = false;
  714. if (!playbackFailed)
  715. {
  716. var data = _userDataRepository.GetUserData(userId, item);
  717. if (positionTicks.HasValue)
  718. {
  719. playedToCompletion = _userDataRepository.UpdatePlayState(item, data, positionTicks.Value);
  720. }
  721. else
  722. {
  723. // If the client isn't able to report this, then we'll just have to make an assumption
  724. data.PlayCount++;
  725. data.Played = true;
  726. data.PlaybackPositionTicks = 0;
  727. playedToCompletion = true;
  728. }
  729. await _userDataRepository.SaveUserData(userId, item, data, UserDataSaveReason.PlaybackFinished, CancellationToken.None).ConfigureAwait(false);
  730. }
  731. return playedToCompletion;
  732. }
  733. /// <summary>
  734. /// Gets the session.
  735. /// </summary>
  736. /// <param name="sessionId">The session identifier.</param>
  737. /// <param name="throwOnMissing">if set to <c>true</c> [throw on missing].</param>
  738. /// <returns>SessionInfo.</returns>
  739. /// <exception cref="ResourceNotFoundException"></exception>
  740. private SessionInfo GetSession(string sessionId, bool throwOnMissing = true)
  741. {
  742. var session = Sessions.FirstOrDefault(i => string.Equals(i.Id, sessionId));
  743. if (session == null && throwOnMissing)
  744. {
  745. throw new ResourceNotFoundException(string.Format("Session {0} not found.", sessionId));
  746. }
  747. return session;
  748. }
  749. private SessionInfo GetSessionToRemoteControl(string sessionId)
  750. {
  751. // Accept either device id or session id
  752. var session = Sessions.FirstOrDefault(i => string.Equals(i.Id, sessionId));
  753. if (session == null)
  754. {
  755. throw new ResourceNotFoundException(string.Format("Session {0} not found.", sessionId));
  756. }
  757. return session;
  758. }
  759. public Task SendMessageCommand(string controllingSessionId, string sessionId, MessageCommand command, CancellationToken cancellationToken)
  760. {
  761. var generalCommand = new GeneralCommand
  762. {
  763. Name = GeneralCommandType.DisplayMessage.ToString()
  764. };
  765. generalCommand.Arguments["Header"] = command.Header;
  766. generalCommand.Arguments["Text"] = command.Text;
  767. if (command.TimeoutMs.HasValue)
  768. {
  769. generalCommand.Arguments["TimeoutMs"] = command.TimeoutMs.Value.ToString(CultureInfo.InvariantCulture);
  770. }
  771. return SendGeneralCommand(controllingSessionId, sessionId, generalCommand, cancellationToken);
  772. }
  773. public Task SendGeneralCommand(string controllingSessionId, string sessionId, GeneralCommand command, CancellationToken cancellationToken)
  774. {
  775. var session = GetSessionToRemoteControl(sessionId);
  776. var controllingSession = GetSession(controllingSessionId);
  777. AssertCanControl(session, controllingSession);
  778. return session.SessionController.SendGeneralCommand(command, cancellationToken);
  779. }
  780. public async Task SendPlayCommand(string controllingSessionId, string sessionId, PlayRequest command, CancellationToken cancellationToken)
  781. {
  782. var session = GetSessionToRemoteControl(sessionId);
  783. var user = session.UserId.HasValue ? _userManager.GetUserById(session.UserId.Value) : null;
  784. List<BaseItem> items;
  785. if (command.PlayCommand == PlayCommand.PlayInstantMix)
  786. {
  787. items = command.ItemIds.SelectMany(i => TranslateItemForInstantMix(i, user))
  788. .Where(i => i.LocationType != LocationType.Virtual)
  789. .ToList();
  790. command.PlayCommand = PlayCommand.PlayNow;
  791. }
  792. else
  793. {
  794. var list = new List<BaseItem>();
  795. foreach (var itemId in command.ItemIds)
  796. {
  797. var subItems = await TranslateItemForPlayback(itemId, user).ConfigureAwait(false);
  798. list.AddRange(subItems);
  799. }
  800. items = list
  801. .Where(i => i.LocationType != LocationType.Virtual)
  802. .ToList();
  803. }
  804. if (command.PlayCommand == PlayCommand.PlayShuffle)
  805. {
  806. items = items.OrderBy(i => Guid.NewGuid()).ToList();
  807. command.PlayCommand = PlayCommand.PlayNow;
  808. }
  809. command.ItemIds = items.Select(i => i.Id.ToString("N")).ToArray();
  810. if (user != null)
  811. {
  812. if (items.Any(i => i.GetPlayAccess(user) != PlayAccess.Full))
  813. {
  814. throw new ArgumentException(string.Format("{0} is not allowed to play media.", user.Name));
  815. }
  816. }
  817. if (command.PlayCommand != PlayCommand.PlayNow)
  818. {
  819. if (items.Any(i => !session.QueueableMediaTypes.Contains(i.MediaType, StringComparer.OrdinalIgnoreCase)))
  820. {
  821. throw new ArgumentException(string.Format("{0} is unable to queue the requested media type.", session.DeviceName ?? session.Id));
  822. }
  823. }
  824. else
  825. {
  826. if (items.Any(i => !session.PlayableMediaTypes.Contains(i.MediaType, StringComparer.OrdinalIgnoreCase)))
  827. {
  828. throw new ArgumentException(string.Format("{0} is unable to play the requested media type.", session.DeviceName ?? session.Id));
  829. }
  830. }
  831. if (user != null && command.ItemIds.Length == 1 && user.Configuration.EnableNextEpisodeAutoPlay)
  832. {
  833. var episode = _libraryManager.GetItemById(command.ItemIds[0]) as Episode;
  834. if (episode != null)
  835. {
  836. var series = episode.Series;
  837. if (series != null)
  838. {
  839. var episodes = series.GetEpisodes(user)
  840. .Where(i => !i.IsVirtualItem)
  841. .SkipWhile(i => i.Id != episode.Id)
  842. .ToList();
  843. if (episodes.Count > 0)
  844. {
  845. command.ItemIds = episodes.Select(i => i.Id.ToString("N")).ToArray();
  846. }
  847. }
  848. }
  849. }
  850. var controllingSession = GetSession(controllingSessionId);
  851. AssertCanControl(session, controllingSession);
  852. if (controllingSession.UserId.HasValue)
  853. {
  854. command.ControllingUserId = controllingSession.UserId.Value.ToString("N");
  855. }
  856. await session.SessionController.SendPlayCommand(command, cancellationToken).ConfigureAwait(false);
  857. }
  858. private async Task<List<BaseItem>> TranslateItemForPlayback(string id, User user)
  859. {
  860. var item = _libraryManager.GetItemById(id);
  861. if (item == null)
  862. {
  863. _logger.Error("A non-existant item Id {0} was passed into TranslateItemForPlayback", id);
  864. return new List<BaseItem>();
  865. }
  866. var byName = item as IItemByName;
  867. if (byName != null)
  868. {
  869. var items = byName.GetTaggedItems(new InternalItemsQuery(user)
  870. {
  871. IsFolder = false,
  872. Recursive = true
  873. });
  874. return FilterToSingleMediaType(items)
  875. .OrderBy(i => i.SortName)
  876. .ToList();
  877. }
  878. if (item.IsFolder)
  879. {
  880. var folder = (Folder)item;
  881. var itemsResult = await folder.GetItems(new InternalItemsQuery(user)
  882. {
  883. Recursive = true,
  884. IsFolder = false
  885. }).ConfigureAwait(false);
  886. return FilterToSingleMediaType(itemsResult.Items)
  887. .OrderBy(i => i.SortName)
  888. .ToList();
  889. }
  890. return new List<BaseItem> { item };
  891. }
  892. private IEnumerable<BaseItem> FilterToSingleMediaType(IEnumerable<BaseItem> items)
  893. {
  894. return items
  895. .Where(i => !string.IsNullOrWhiteSpace(i.MediaType))
  896. .ToLookup(i => i.MediaType, StringComparer.OrdinalIgnoreCase)
  897. .OrderByDescending(i => i.Count())
  898. .FirstOrDefault();
  899. }
  900. private IEnumerable<BaseItem> TranslateItemForInstantMix(string id, User user)
  901. {
  902. var item = _libraryManager.GetItemById(id);
  903. if (item == null)
  904. {
  905. _logger.Error("A non-existant item Id {0} was passed into TranslateItemForInstantMix", id);
  906. return new List<BaseItem>();
  907. }
  908. return _musicManager.GetInstantMixFromItem(item, user);
  909. }
  910. public Task SendBrowseCommand(string controllingSessionId, string sessionId, BrowseRequest command, CancellationToken cancellationToken)
  911. {
  912. var generalCommand = new GeneralCommand
  913. {
  914. Name = GeneralCommandType.DisplayContent.ToString()
  915. };
  916. generalCommand.Arguments["ItemId"] = command.ItemId;
  917. generalCommand.Arguments["ItemName"] = command.ItemName;
  918. generalCommand.Arguments["ItemType"] = command.ItemType;
  919. return SendGeneralCommand(controllingSessionId, sessionId, generalCommand, cancellationToken);
  920. }
  921. public Task SendPlaystateCommand(string controllingSessionId, string sessionId, PlaystateRequest command, CancellationToken cancellationToken)
  922. {
  923. var session = GetSessionToRemoteControl(sessionId);
  924. var controllingSession = GetSession(controllingSessionId);
  925. AssertCanControl(session, controllingSession);
  926. if (controllingSession.UserId.HasValue)
  927. {
  928. command.ControllingUserId = controllingSession.UserId.Value.ToString("N");
  929. }
  930. return session.SessionController.SendPlaystateCommand(command, cancellationToken);
  931. }
  932. private void AssertCanControl(SessionInfo session, SessionInfo controllingSession)
  933. {
  934. if (session == null)
  935. {
  936. throw new ArgumentNullException("session");
  937. }
  938. if (controllingSession == null)
  939. {
  940. throw new ArgumentNullException("controllingSession");
  941. }
  942. }
  943. /// <summary>
  944. /// Sends the restart required message.
  945. /// </summary>
  946. /// <param name="cancellationToken">The cancellation token.</param>
  947. /// <returns>Task.</returns>
  948. public async Task SendRestartRequiredNotification(CancellationToken cancellationToken)
  949. {
  950. var sessions = Sessions.Where(i => i.IsActive && i.SessionController != null).ToList();
  951. var info = await _appHost.GetSystemInfo().ConfigureAwait(false);
  952. var tasks = sessions.Select(session => Task.Run(async () =>
  953. {
  954. try
  955. {
  956. await session.SessionController.SendRestartRequiredNotification(info, cancellationToken).ConfigureAwait(false);
  957. }
  958. catch (Exception ex)
  959. {
  960. _logger.ErrorException("Error in SendRestartRequiredNotification.", ex);
  961. }
  962. }, cancellationToken));
  963. await Task.WhenAll(tasks).ConfigureAwait(false);
  964. }
  965. /// <summary>
  966. /// Sends the server shutdown notification.
  967. /// </summary>
  968. /// <param name="cancellationToken">The cancellation token.</param>
  969. /// <returns>Task.</returns>
  970. public Task SendServerShutdownNotification(CancellationToken cancellationToken)
  971. {
  972. var sessions = Sessions.Where(i => i.IsActive && i.SessionController != null).ToList();
  973. var tasks = sessions.Select(session => Task.Run(async () =>
  974. {
  975. try
  976. {
  977. await session.SessionController.SendServerShutdownNotification(cancellationToken).ConfigureAwait(false);
  978. }
  979. catch (Exception ex)
  980. {
  981. _logger.ErrorException("Error in SendServerShutdownNotification.", ex);
  982. }
  983. }, cancellationToken));
  984. return Task.WhenAll(tasks);
  985. }
  986. /// <summary>
  987. /// Sends the server restart notification.
  988. /// </summary>
  989. /// <param name="cancellationToken">The cancellation token.</param>
  990. /// <returns>Task.</returns>
  991. public Task SendServerRestartNotification(CancellationToken cancellationToken)
  992. {
  993. _logger.Debug("Beginning SendServerRestartNotification");
  994. var sessions = Sessions.Where(i => i.IsActive && i.SessionController != null).ToList();
  995. var tasks = sessions.Select(session => Task.Run(async () =>
  996. {
  997. try
  998. {
  999. await session.SessionController.SendServerRestartNotification(cancellationToken).ConfigureAwait(false);
  1000. }
  1001. catch (Exception ex)
  1002. {
  1003. _logger.ErrorException("Error in SendServerRestartNotification.", ex);
  1004. }
  1005. }, cancellationToken));
  1006. return Task.WhenAll(tasks);
  1007. }
  1008. public Task SendSessionEndedNotification(SessionInfo sessionInfo, CancellationToken cancellationToken)
  1009. {
  1010. var sessions = Sessions.Where(i => i.IsActive && i.SessionController != null).ToList();
  1011. var dto = GetSessionInfoDto(sessionInfo);
  1012. var tasks = sessions.Select(session => Task.Run(async () =>
  1013. {
  1014. try
  1015. {
  1016. await session.SessionController.SendSessionEndedNotification(dto, cancellationToken).ConfigureAwait(false);
  1017. }
  1018. catch (Exception ex)
  1019. {
  1020. _logger.ErrorException("Error in SendSessionEndedNotification.", ex);
  1021. }
  1022. }, cancellationToken));
  1023. return Task.WhenAll(tasks);
  1024. }
  1025. public Task SendPlaybackStartNotification(SessionInfo sessionInfo, CancellationToken cancellationToken)
  1026. {
  1027. var sessions = Sessions.Where(i => i.IsActive && i.SessionController != null).ToList();
  1028. var dto = GetSessionInfoDto(sessionInfo);
  1029. var tasks = sessions.Select(session => Task.Run(async () =>
  1030. {
  1031. try
  1032. {
  1033. await session.SessionController.SendPlaybackStartNotification(dto, cancellationToken).ConfigureAwait(false);
  1034. }
  1035. catch (Exception ex)
  1036. {
  1037. _logger.ErrorException("Error in SendPlaybackStartNotification.", ex);
  1038. }
  1039. }, cancellationToken));
  1040. return Task.WhenAll(tasks);
  1041. }
  1042. public Task SendPlaybackStoppedNotification(SessionInfo sessionInfo, CancellationToken cancellationToken)
  1043. {
  1044. var sessions = Sessions.Where(i => i.IsActive && i.SessionController != null).ToList();
  1045. var dto = GetSessionInfoDto(sessionInfo);
  1046. var tasks = sessions.Select(session => Task.Run(async () =>
  1047. {
  1048. try
  1049. {
  1050. await session.SessionController.SendPlaybackStoppedNotification(dto, cancellationToken).ConfigureAwait(false);
  1051. }
  1052. catch (Exception ex)
  1053. {
  1054. _logger.ErrorException("Error in SendPlaybackStoppedNotification.", ex);
  1055. }
  1056. }, cancellationToken));
  1057. return Task.WhenAll(tasks);
  1058. }
  1059. /// <summary>
  1060. /// Adds the additional user.
  1061. /// </summary>
  1062. /// <param name="sessionId">The session identifier.</param>
  1063. /// <param name="userId">The user identifier.</param>
  1064. /// <exception cref="System.UnauthorizedAccessException">Cannot modify additional users without authenticating first.</exception>
  1065. /// <exception cref="System.ArgumentException">The requested user is already the primary user of the session.</exception>
  1066. public void AddAdditionalUser(string sessionId, string userId)
  1067. {
  1068. var session = GetSession(sessionId);
  1069. if (session.UserId.HasValue && session.UserId.Value == new Guid(userId))
  1070. {
  1071. throw new ArgumentException("The requested user is already the primary user of the session.");
  1072. }
  1073. if (session.AdditionalUsers.All(i => new Guid(i.UserId) != new Guid(userId)))
  1074. {
  1075. var user = _userManager.GetUserById(userId);
  1076. session.AdditionalUsers.Add(new SessionUserInfo
  1077. {
  1078. UserId = userId,
  1079. UserName = user.Name
  1080. });
  1081. }
  1082. }
  1083. /// <summary>
  1084. /// Removes the additional user.
  1085. /// </summary>
  1086. /// <param name="sessionId">The session identifier.</param>
  1087. /// <param name="userId">The user identifier.</param>
  1088. /// <exception cref="System.UnauthorizedAccessException">Cannot modify additional users without authenticating first.</exception>
  1089. /// <exception cref="System.ArgumentException">The requested user is already the primary user of the session.</exception>
  1090. public void RemoveAdditionalUser(string sessionId, string userId)
  1091. {
  1092. var session = GetSession(sessionId);
  1093. if (session.UserId.HasValue && session.UserId.Value == new Guid(userId))
  1094. {
  1095. throw new ArgumentException("The requested user is already the primary user of the session.");
  1096. }
  1097. var user = session.AdditionalUsers.FirstOrDefault(i => new Guid(i.UserId) == new Guid(userId));
  1098. if (user != null)
  1099. {
  1100. session.AdditionalUsers.Remove(user);
  1101. }
  1102. }
  1103. /// <summary>
  1104. /// Authenticates the new session.
  1105. /// </summary>
  1106. /// <param name="request">The request.</param>
  1107. /// <returns>Task{SessionInfo}.</returns>
  1108. public Task<AuthenticationResult> AuthenticateNewSession(AuthenticationRequest request)
  1109. {
  1110. return AuthenticateNewSessionInternal(request, true);
  1111. }
  1112. public Task<AuthenticationResult> CreateNewSession(AuthenticationRequest request)
  1113. {
  1114. return AuthenticateNewSessionInternal(request, false);
  1115. }
  1116. private async Task<AuthenticationResult> AuthenticateNewSessionInternal(AuthenticationRequest request, bool enforcePassword)
  1117. {
  1118. User user = null;
  1119. if (!string.IsNullOrWhiteSpace(request.UserId))
  1120. {
  1121. var idGuid = new Guid(request.UserId);
  1122. user = _userManager.Users
  1123. .FirstOrDefault(i => i.Id == idGuid);
  1124. }
  1125. if (user == null)
  1126. {
  1127. user = _userManager.Users
  1128. .FirstOrDefault(i => string.Equals(request.Username, i.Name, StringComparison.OrdinalIgnoreCase));
  1129. }
  1130. if (user != null && !string.IsNullOrWhiteSpace(request.DeviceId))
  1131. {
  1132. if (!_deviceManager.CanAccessDevice(user.Id.ToString("N"), request.DeviceId))
  1133. {
  1134. throw new SecurityException("User is not allowed access from this device.");
  1135. }
  1136. }
  1137. if (enforcePassword)
  1138. {
  1139. var result = await _userManager.AuthenticateUser(request.Username, request.PasswordSha1, request.PasswordMd5, request.RemoteEndPoint).ConfigureAwait(false);
  1140. if (!result)
  1141. {
  1142. EventHelper.FireEventIfNotNull(AuthenticationFailed, this, new GenericEventArgs<AuthenticationRequest>(request), _logger);
  1143. throw new SecurityException("Invalid user or password entered.");
  1144. }
  1145. }
  1146. var token = await GetAuthorizationToken(user.Id.ToString("N"), request.DeviceId, request.App, request.AppVersion, request.DeviceName).ConfigureAwait(false);
  1147. EventHelper.FireEventIfNotNull(AuthenticationSucceeded, this, new GenericEventArgs<AuthenticationRequest>(request), _logger);
  1148. var session = await LogSessionActivity(request.App,
  1149. request.AppVersion,
  1150. request.DeviceId,
  1151. request.DeviceName,
  1152. request.RemoteEndPoint,
  1153. user)
  1154. .ConfigureAwait(false);
  1155. return new AuthenticationResult
  1156. {
  1157. User = _userManager.GetUserDto(user, request.RemoteEndPoint),
  1158. SessionInfo = GetSessionInfoDto(session),
  1159. AccessToken = token,
  1160. ServerId = _appHost.SystemId
  1161. };
  1162. }
  1163. private async Task<string> GetAuthorizationToken(string userId, string deviceId, string app, string appVersion, string deviceName)
  1164. {
  1165. var existing = _authRepo.Get(new AuthenticationInfoQuery
  1166. {
  1167. DeviceId = deviceId,
  1168. IsActive = true,
  1169. UserId = userId,
  1170. Limit = 1
  1171. });
  1172. if (existing.Items.Length > 0)
  1173. {
  1174. var token = existing.Items[0].AccessToken;
  1175. _logger.Info("Reissuing access token: " + token);
  1176. return token;
  1177. }
  1178. var newToken = new AuthenticationInfo
  1179. {
  1180. AppName = app,
  1181. AppVersion = appVersion,
  1182. DateCreated = DateTime.UtcNow,
  1183. DeviceId = deviceId,
  1184. DeviceName = deviceName,
  1185. UserId = userId,
  1186. IsActive = true,
  1187. AccessToken = Guid.NewGuid().ToString("N")
  1188. };
  1189. _logger.Info("Creating new access token for user {0}", userId);
  1190. await _authRepo.Create(newToken, CancellationToken.None).ConfigureAwait(false);
  1191. return newToken.AccessToken;
  1192. }
  1193. public async Task Logout(string accessToken)
  1194. {
  1195. if (string.IsNullOrWhiteSpace(accessToken))
  1196. {
  1197. throw new ArgumentNullException("accessToken");
  1198. }
  1199. _logger.Info("Logging out access token {0}", accessToken);
  1200. var existing = _authRepo.Get(new AuthenticationInfoQuery
  1201. {
  1202. Limit = 1,
  1203. AccessToken = accessToken
  1204. }).Items.FirstOrDefault();
  1205. if (existing != null)
  1206. {
  1207. existing.IsActive = false;
  1208. await _authRepo.Update(existing, CancellationToken.None).ConfigureAwait(false);
  1209. var sessions = Sessions
  1210. .Where(i => string.Equals(i.DeviceId, existing.DeviceId, StringComparison.OrdinalIgnoreCase))
  1211. .ToList();
  1212. foreach (var session in sessions)
  1213. {
  1214. try
  1215. {
  1216. ReportSessionEnded(session.Id);
  1217. }
  1218. catch (Exception ex)
  1219. {
  1220. _logger.ErrorException("Error reporting session ended", ex);
  1221. }
  1222. }
  1223. }
  1224. }
  1225. public async Task RevokeUserTokens(string userId, string currentAccessToken)
  1226. {
  1227. var existing = _authRepo.Get(new AuthenticationInfoQuery
  1228. {
  1229. IsActive = true,
  1230. UserId = userId
  1231. });
  1232. foreach (var info in existing.Items)
  1233. {
  1234. if (!string.Equals(currentAccessToken, info.AccessToken, StringComparison.OrdinalIgnoreCase))
  1235. {
  1236. await Logout(info.AccessToken).ConfigureAwait(false);
  1237. }
  1238. }
  1239. }
  1240. public Task RevokeToken(string token)
  1241. {
  1242. return Logout(token);
  1243. }
  1244. /// <summary>
  1245. /// Reports the capabilities.
  1246. /// </summary>
  1247. /// <param name="sessionId">The session identifier.</param>
  1248. /// <param name="capabilities">The capabilities.</param>
  1249. public void ReportCapabilities(string sessionId, ClientCapabilities capabilities)
  1250. {
  1251. var session = GetSession(sessionId);
  1252. ReportCapabilities(session, capabilities, true);
  1253. }
  1254. private async void ReportCapabilities(SessionInfo session,
  1255. ClientCapabilities capabilities,
  1256. bool saveCapabilities)
  1257. {
  1258. session.Capabilities = capabilities;
  1259. if (!string.IsNullOrWhiteSpace(capabilities.MessageCallbackUrl))
  1260. {
  1261. var controller = session.SessionController as HttpSessionController;
  1262. if (controller == null)
  1263. {
  1264. session.SessionController = new HttpSessionController(_httpClient, _jsonSerializer, session, capabilities.MessageCallbackUrl, this);
  1265. }
  1266. }
  1267. EventHelper.FireEventIfNotNull(CapabilitiesChanged, this, new SessionEventArgs
  1268. {
  1269. SessionInfo = session
  1270. }, _logger);
  1271. if (saveCapabilities)
  1272. {
  1273. try
  1274. {
  1275. await SaveCapabilities(session.DeviceId, capabilities).ConfigureAwait(false);
  1276. }
  1277. catch (Exception ex)
  1278. {
  1279. _logger.ErrorException("Error saving device capabilities", ex);
  1280. }
  1281. }
  1282. }
  1283. private ClientCapabilities GetSavedCapabilities(string deviceId)
  1284. {
  1285. return _deviceManager.GetCapabilities(deviceId);
  1286. }
  1287. private Task SaveCapabilities(string deviceId, ClientCapabilities capabilities)
  1288. {
  1289. return _deviceManager.SaveCapabilities(deviceId, capabilities);
  1290. }
  1291. public SessionInfoDto GetSessionInfoDto(SessionInfo session)
  1292. {
  1293. var dto = new SessionInfoDto
  1294. {
  1295. Client = session.Client,
  1296. DeviceId = session.DeviceId,
  1297. DeviceName = session.DeviceName,
  1298. Id = session.Id,
  1299. LastActivityDate = session.LastActivityDate,
  1300. NowViewingItem = session.NowViewingItem,
  1301. ApplicationVersion = session.ApplicationVersion,
  1302. QueueableMediaTypes = session.QueueableMediaTypes,
  1303. PlayableMediaTypes = session.PlayableMediaTypes,
  1304. AdditionalUsers = session.AdditionalUsers,
  1305. SupportedCommands = session.SupportedCommands,
  1306. UserName = session.UserName,
  1307. NowPlayingItem = session.NowPlayingItem,
  1308. SupportsRemoteControl = session.SupportsMediaControl,
  1309. PlayState = session.PlayState,
  1310. AppIconUrl = session.AppIconUrl,
  1311. TranscodingInfo = session.NowPlayingItem == null ? null : session.TranscodingInfo
  1312. };
  1313. if (session.UserId.HasValue)
  1314. {
  1315. dto.UserId = session.UserId.Value.ToString("N");
  1316. var user = _userManager.GetUserById(session.UserId.Value);
  1317. if (user != null)
  1318. {
  1319. dto.UserPrimaryImageTag = GetImageCacheTag(user, ImageType.Primary);
  1320. }
  1321. }
  1322. return dto;
  1323. }
  1324. /// <summary>
  1325. /// Converts a BaseItem to a BaseItemInfo
  1326. /// </summary>
  1327. /// <param name="item">The item.</param>
  1328. /// <param name="chapterOwner">The chapter owner.</param>
  1329. /// <param name="mediaSource">The media source.</param>
  1330. /// <returns>BaseItemInfo.</returns>
  1331. /// <exception cref="System.ArgumentNullException">item</exception>
  1332. private BaseItemInfo GetItemInfo(BaseItem item, BaseItem chapterOwner, MediaSourceInfo mediaSource)
  1333. {
  1334. if (item == null)
  1335. {
  1336. throw new ArgumentNullException("item");
  1337. }
  1338. var info = new BaseItemInfo
  1339. {
  1340. Id = GetDtoId(item),
  1341. Name = item.Name,
  1342. MediaType = item.MediaType,
  1343. Type = item.GetClientTypeName(),
  1344. RunTimeTicks = item.RunTimeTicks,
  1345. IndexNumber = item.IndexNumber,
  1346. ParentIndexNumber = item.ParentIndexNumber,
  1347. PremiereDate = item.PremiereDate,
  1348. ProductionYear = item.ProductionYear
  1349. };
  1350. info.PrimaryImageTag = GetImageCacheTag(item, ImageType.Primary);
  1351. if (info.PrimaryImageTag != null)
  1352. {
  1353. info.PrimaryImageItemId = GetDtoId(item);
  1354. }
  1355. var episode = item as Episode;
  1356. if (episode != null)
  1357. {
  1358. info.IndexNumberEnd = episode.IndexNumberEnd;
  1359. }
  1360. var hasSeries = item as IHasSeries;
  1361. if (hasSeries != null)
  1362. {
  1363. info.SeriesName = hasSeries.SeriesName;
  1364. }
  1365. var recording = item as ILiveTvRecording;
  1366. if (recording != null)
  1367. {
  1368. if (recording.IsSeries)
  1369. {
  1370. info.Name = recording.EpisodeTitle;
  1371. info.SeriesName = recording.Name;
  1372. if (string.IsNullOrWhiteSpace(info.Name))
  1373. {
  1374. info.Name = recording.Name;
  1375. }
  1376. }
  1377. }
  1378. var audio = item as Audio;
  1379. if (audio != null)
  1380. {
  1381. info.Album = audio.Album;
  1382. info.Artists = audio.Artists;
  1383. if (info.PrimaryImageTag == null)
  1384. {
  1385. var album = audio.AlbumEntity;
  1386. if (album != null && album.HasImage(ImageType.Primary))
  1387. {
  1388. info.PrimaryImageTag = GetImageCacheTag(album, ImageType.Primary);
  1389. if (info.PrimaryImageTag != null)
  1390. {
  1391. info.PrimaryImageItemId = GetDtoId(album);
  1392. }
  1393. }
  1394. }
  1395. }
  1396. var musicVideo = item as MusicVideo;
  1397. if (musicVideo != null)
  1398. {
  1399. info.Album = musicVideo.Album;
  1400. info.Artists = musicVideo.Artists.ToList();
  1401. }
  1402. var backropItem = item.HasImage(ImageType.Backdrop) ? item : null;
  1403. var thumbItem = item.HasImage(ImageType.Thumb) ? item : null;
  1404. var logoItem = item.HasImage(ImageType.Logo) ? item : null;
  1405. if (thumbItem == null)
  1406. {
  1407. if (episode != null)
  1408. {
  1409. var series = episode.Series;
  1410. if (series != null && series.HasImage(ImageType.Thumb))
  1411. {
  1412. thumbItem = series;
  1413. }
  1414. }
  1415. }
  1416. if (backropItem == null)
  1417. {
  1418. if (episode != null)
  1419. {
  1420. var series = episode.Series;
  1421. if (series != null && series.HasImage(ImageType.Backdrop))
  1422. {
  1423. backropItem = series;
  1424. }
  1425. }
  1426. }
  1427. if (backropItem == null)
  1428. {
  1429. backropItem = item.GetParents().FirstOrDefault(i => i.HasImage(ImageType.Backdrop));
  1430. }
  1431. if (thumbItem == null)
  1432. {
  1433. thumbItem = item.GetParents().FirstOrDefault(i => i.HasImage(ImageType.Thumb));
  1434. }
  1435. if (logoItem == null)
  1436. {
  1437. logoItem = item.GetParents().FirstOrDefault(i => i.HasImage(ImageType.Logo));
  1438. }
  1439. if (thumbItem != null)
  1440. {
  1441. info.ThumbImageTag = GetImageCacheTag(thumbItem, ImageType.Thumb);
  1442. info.ThumbItemId = GetDtoId(thumbItem);
  1443. }
  1444. if (backropItem != null)
  1445. {
  1446. info.BackdropImageTag = GetImageCacheTag(backropItem, ImageType.Backdrop);
  1447. info.BackdropItemId = GetDtoId(backropItem);
  1448. }
  1449. if (logoItem != null)
  1450. {
  1451. info.LogoImageTag = GetImageCacheTag(logoItem, ImageType.Logo);
  1452. info.LogoItemId = GetDtoId(logoItem);
  1453. }
  1454. if (chapterOwner != null)
  1455. {
  1456. info.ChapterImagesItemId = chapterOwner.Id.ToString("N");
  1457. info.Chapters = _dtoService.GetChapterInfoDtos(chapterOwner).ToList();
  1458. }
  1459. if (mediaSource != null)
  1460. {
  1461. info.MediaStreams = mediaSource.MediaStreams;
  1462. }
  1463. return info;
  1464. }
  1465. private string GetImageCacheTag(BaseItem item, ImageType type)
  1466. {
  1467. try
  1468. {
  1469. return _imageProcessor.GetImageCacheTag(item, type);
  1470. }
  1471. catch (Exception ex)
  1472. {
  1473. _logger.ErrorException("Error getting {0} image info", ex, type);
  1474. return null;
  1475. }
  1476. }
  1477. private string GetDtoId(BaseItem item)
  1478. {
  1479. return _dtoService.GetDtoId(item);
  1480. }
  1481. public void ReportNowViewingItem(string sessionId, string itemId)
  1482. {
  1483. if (string.IsNullOrWhiteSpace(itemId))
  1484. {
  1485. throw new ArgumentNullException("itemId");
  1486. }
  1487. var item = _libraryManager.GetItemById(new Guid(itemId));
  1488. var info = GetItemInfo(item, null, null);
  1489. ReportNowViewingItem(sessionId, info);
  1490. }
  1491. public void ReportNowViewingItem(string sessionId, BaseItemInfo item)
  1492. {
  1493. var session = GetSession(sessionId);
  1494. session.NowViewingItem = item;
  1495. }
  1496. public void ReportTranscodingInfo(string deviceId, TranscodingInfo info)
  1497. {
  1498. var session = Sessions.FirstOrDefault(i => string.Equals(i.DeviceId, deviceId));
  1499. if (session != null)
  1500. {
  1501. session.TranscodingInfo = info;
  1502. }
  1503. }
  1504. public void ClearTranscodingInfo(string deviceId)
  1505. {
  1506. ReportTranscodingInfo(deviceId, null);
  1507. }
  1508. public SessionInfo GetSession(string deviceId, string client, string version)
  1509. {
  1510. return Sessions.FirstOrDefault(i => string.Equals(i.DeviceId, deviceId) &&
  1511. string.Equals(i.Client, client));
  1512. }
  1513. public Task<SessionInfo> GetSessionByAuthenticationToken(AuthenticationInfo info, string deviceId, string remoteEndpoint, string appVersion)
  1514. {
  1515. if (info == null)
  1516. {
  1517. throw new ArgumentNullException("info");
  1518. }
  1519. var user = string.IsNullOrWhiteSpace(info.UserId)
  1520. ? null
  1521. : _userManager.GetUserById(info.UserId);
  1522. appVersion = string.IsNullOrWhiteSpace(appVersion)
  1523. ? info.AppVersion
  1524. : appVersion;
  1525. var deviceName = info.DeviceName;
  1526. var appName = info.AppName;
  1527. if (!string.IsNullOrWhiteSpace(deviceId))
  1528. {
  1529. // Replace the info from the token with more recent info
  1530. var device = _deviceManager.GetDevice(deviceId);
  1531. if (device != null)
  1532. {
  1533. deviceName = device.Name;
  1534. appName = device.AppName;
  1535. if (!string.IsNullOrWhiteSpace(device.AppVersion))
  1536. {
  1537. appVersion = device.AppVersion;
  1538. }
  1539. }
  1540. }
  1541. else
  1542. {
  1543. deviceId = info.DeviceId;
  1544. }
  1545. // Prevent argument exception
  1546. if (string.IsNullOrWhiteSpace(appVersion))
  1547. {
  1548. appVersion = "1";
  1549. }
  1550. return LogSessionActivity(appName, appVersion, deviceId, deviceName, remoteEndpoint, user);
  1551. }
  1552. public Task<SessionInfo> GetSessionByAuthenticationToken(string token, string deviceId, string remoteEndpoint)
  1553. {
  1554. var result = _authRepo.Get(new AuthenticationInfoQuery
  1555. {
  1556. AccessToken = token
  1557. });
  1558. var info = result.Items.FirstOrDefault();
  1559. if (info == null)
  1560. {
  1561. return Task.FromResult<SessionInfo>(null);
  1562. }
  1563. return GetSessionByAuthenticationToken(info, deviceId, remoteEndpoint, null);
  1564. }
  1565. public Task SendMessageToAdminSessions<T>(string name, T data, CancellationToken cancellationToken)
  1566. {
  1567. var adminUserIds = _userManager.Users.Where(i => i.Policy.IsAdministrator).Select(i => i.Id.ToString("N")).ToList();
  1568. return SendMessageToUserSessions(adminUserIds, name, data, cancellationToken);
  1569. }
  1570. public Task SendMessageToUserSessions<T>(List<string> userIds, string name, T data,
  1571. CancellationToken cancellationToken)
  1572. {
  1573. var sessions = Sessions.Where(i => i.IsActive && i.SessionController != null && userIds.Any(i.ContainsUser)).ToList();
  1574. var tasks = sessions.Select(session => Task.Run(async () =>
  1575. {
  1576. try
  1577. {
  1578. await session.SessionController.SendMessage(name, data, cancellationToken).ConfigureAwait(false);
  1579. }
  1580. catch (Exception ex)
  1581. {
  1582. _logger.ErrorException("Error sending message", ex);
  1583. }
  1584. }, cancellationToken));
  1585. return Task.WhenAll(tasks);
  1586. }
  1587. public Task SendMessageToUserDeviceSessions<T>(string deviceId, string name, T data,
  1588. CancellationToken cancellationToken)
  1589. {
  1590. var sessions = Sessions.Where(i => i.IsActive && i.SessionController != null && string.Equals(i.DeviceId, deviceId, StringComparison.OrdinalIgnoreCase)).ToList();
  1591. var tasks = sessions.Select(session => Task.Run(async () =>
  1592. {
  1593. try
  1594. {
  1595. await session.SessionController.SendMessage(name, data, cancellationToken).ConfigureAwait(false);
  1596. }
  1597. catch (Exception ex)
  1598. {
  1599. _logger.ErrorException("Error sending message", ex);
  1600. }
  1601. }, cancellationToken));
  1602. return Task.WhenAll(tasks);
  1603. }
  1604. }
  1605. }