SessionManager.cs 68 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894
  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. if (_activeConnections.TryRemove(key, out removed))
  258. {
  259. OnSessionEnded(removed);
  260. }
  261. }
  262. }
  263. finally
  264. {
  265. _sessionLock.Release();
  266. }
  267. }
  268. private Task<MediaSourceInfo> GetMediaSource(IHasMediaSources item, string mediaSourceId)
  269. {
  270. return _mediaSourceManager.GetMediaSource(item, mediaSourceId, false);
  271. }
  272. /// <summary>
  273. /// Updates the now playing item id.
  274. /// </summary>
  275. /// <param name="session">The session.</param>
  276. /// <param name="info">The information.</param>
  277. /// <param name="libraryItem">The library item.</param>
  278. private async Task UpdateNowPlayingItem(SessionInfo session, PlaybackProgressInfo info, BaseItem libraryItem)
  279. {
  280. if (string.IsNullOrWhiteSpace(info.MediaSourceId))
  281. {
  282. info.MediaSourceId = info.ItemId;
  283. }
  284. if (!string.IsNullOrWhiteSpace(info.ItemId) && info.Item == null && libraryItem != null)
  285. {
  286. var current = session.NowPlayingItem;
  287. if (current == null || !string.Equals(current.Id, info.ItemId, StringComparison.OrdinalIgnoreCase))
  288. {
  289. var runtimeTicks = libraryItem.RunTimeTicks;
  290. MediaSourceInfo mediaSource = null;
  291. var hasMediaSources = libraryItem as IHasMediaSources;
  292. if (hasMediaSources != null)
  293. {
  294. mediaSource = await GetMediaSource(hasMediaSources, info.MediaSourceId).ConfigureAwait(false);
  295. if (mediaSource != null)
  296. {
  297. runtimeTicks = mediaSource.RunTimeTicks;
  298. }
  299. }
  300. info.Item = GetItemInfo(libraryItem, libraryItem, mediaSource);
  301. info.Item.RunTimeTicks = runtimeTicks;
  302. }
  303. else
  304. {
  305. info.Item = current;
  306. }
  307. }
  308. session.NowPlayingItem = info.Item;
  309. session.LastActivityDate = DateTime.UtcNow;
  310. session.LastPlaybackCheckIn = DateTime.UtcNow;
  311. session.PlayState.IsPaused = info.IsPaused;
  312. session.PlayState.PositionTicks = info.PositionTicks;
  313. session.PlayState.MediaSourceId = info.MediaSourceId;
  314. session.PlayState.CanSeek = info.CanSeek;
  315. session.PlayState.IsMuted = info.IsMuted;
  316. session.PlayState.VolumeLevel = info.VolumeLevel;
  317. session.PlayState.AudioStreamIndex = info.AudioStreamIndex;
  318. session.PlayState.SubtitleStreamIndex = info.SubtitleStreamIndex;
  319. session.PlayState.PlayMethod = info.PlayMethod;
  320. session.PlayState.RepeatMode = info.RepeatMode;
  321. }
  322. /// <summary>
  323. /// Removes the now playing item id.
  324. /// </summary>
  325. /// <param name="session">The session.</param>
  326. /// <exception cref="System.ArgumentNullException">item</exception>
  327. private void RemoveNowPlayingItem(SessionInfo session)
  328. {
  329. session.NowPlayingItem = null;
  330. session.PlayState = new PlayerStateInfo();
  331. if (!string.IsNullOrEmpty(session.DeviceId))
  332. {
  333. ClearTranscodingInfo(session.DeviceId);
  334. }
  335. }
  336. private string GetSessionKey(string appName, string deviceId)
  337. {
  338. return appName + deviceId;
  339. }
  340. /// <summary>
  341. /// Gets the connection.
  342. /// </summary>
  343. /// <param name="appName">Type of the client.</param>
  344. /// <param name="appVersion">The app version.</param>
  345. /// <param name="deviceId">The device id.</param>
  346. /// <param name="deviceName">Name of the device.</param>
  347. /// <param name="remoteEndPoint">The remote end point.</param>
  348. /// <param name="user">The user.</param>
  349. /// <returns>SessionInfo.</returns>
  350. private async Task<SessionInfo> GetSessionInfo(string appName, string appVersion, string deviceId, string deviceName, string remoteEndPoint, User user)
  351. {
  352. var key = GetSessionKey(appName, deviceId);
  353. await _sessionLock.WaitAsync(CancellationToken.None).ConfigureAwait(false);
  354. var userId = user == null ? (Guid?)null : user.Id;
  355. var username = user == null ? null : user.Name;
  356. try
  357. {
  358. SessionInfo sessionInfo;
  359. DeviceInfo device = null;
  360. if (!_activeConnections.TryGetValue(key, out sessionInfo))
  361. {
  362. sessionInfo = new SessionInfo
  363. {
  364. Client = appName,
  365. DeviceId = deviceId,
  366. ApplicationVersion = appVersion,
  367. Id = key.GetMD5().ToString("N")
  368. };
  369. sessionInfo.DeviceName = deviceName;
  370. sessionInfo.UserId = userId;
  371. sessionInfo.UserName = username;
  372. sessionInfo.RemoteEndPoint = remoteEndPoint;
  373. OnSessionStarted(sessionInfo);
  374. _activeConnections.TryAdd(key, sessionInfo);
  375. if (!string.IsNullOrEmpty(deviceId))
  376. {
  377. var userIdString = userId.HasValue ? userId.Value.ToString("N") : null;
  378. device = await _deviceManager.RegisterDevice(deviceId, deviceName, appName, appVersion, userIdString).ConfigureAwait(false);
  379. }
  380. }
  381. device = device ?? _deviceManager.GetDevice(deviceId);
  382. if (device == null)
  383. {
  384. var userIdString = userId.HasValue ? userId.Value.ToString("N") : null;
  385. device = await _deviceManager.RegisterDevice(deviceId, deviceName, appName, appVersion, userIdString).ConfigureAwait(false);
  386. }
  387. if (device != null)
  388. {
  389. if (!string.IsNullOrEmpty(device.CustomName))
  390. {
  391. deviceName = device.CustomName;
  392. }
  393. }
  394. sessionInfo.DeviceName = deviceName;
  395. sessionInfo.UserId = userId;
  396. sessionInfo.UserName = username;
  397. sessionInfo.RemoteEndPoint = remoteEndPoint;
  398. sessionInfo.ApplicationVersion = appVersion;
  399. if (!userId.HasValue)
  400. {
  401. sessionInfo.AdditionalUsers.Clear();
  402. }
  403. if (sessionInfo.SessionController == null)
  404. {
  405. sessionInfo.SessionController = _sessionFactories
  406. .Select(i => i.GetSessionController(sessionInfo))
  407. .FirstOrDefault(i => i != null);
  408. }
  409. return sessionInfo;
  410. }
  411. finally
  412. {
  413. _sessionLock.Release();
  414. }
  415. }
  416. private List<User> GetUsers(SessionInfo session)
  417. {
  418. var users = new List<User>();
  419. if (session.UserId.HasValue)
  420. {
  421. var user = _userManager.GetUserById(session.UserId.Value);
  422. if (user == null)
  423. {
  424. throw new InvalidOperationException("User not found");
  425. }
  426. users.Add(user);
  427. var additionalUsers = session.AdditionalUsers
  428. .Select(i => _userManager.GetUserById(i.UserId))
  429. .Where(i => i != null);
  430. users.AddRange(additionalUsers);
  431. }
  432. return users;
  433. }
  434. private Timer _idleTimer;
  435. private void StartIdleCheckTimer()
  436. {
  437. if (_idleTimer == null)
  438. {
  439. _idleTimer = new Timer(CheckForIdlePlayback, null, TimeSpan.FromMinutes(5), TimeSpan.FromMinutes(5));
  440. }
  441. }
  442. private void StopIdleCheckTimer()
  443. {
  444. if (_idleTimer != null)
  445. {
  446. _idleTimer.Dispose();
  447. _idleTimer = null;
  448. }
  449. }
  450. private async void CheckForIdlePlayback(object state)
  451. {
  452. var playingSessions = Sessions.Where(i => i.NowPlayingItem != null)
  453. .ToList();
  454. if (playingSessions.Count > 0)
  455. {
  456. var idle = playingSessions
  457. .Where(i => (DateTime.UtcNow - i.LastPlaybackCheckIn).TotalMinutes > 5)
  458. .ToList();
  459. foreach (var session in idle)
  460. {
  461. _logger.Debug("Session {0} has gone idle while playing", session.Id);
  462. try
  463. {
  464. await OnPlaybackStopped(new PlaybackStopInfo
  465. {
  466. Item = session.NowPlayingItem,
  467. ItemId = (session.NowPlayingItem == null ? null : session.NowPlayingItem.Id),
  468. SessionId = session.Id,
  469. MediaSourceId = (session.PlayState == null ? null : session.PlayState.MediaSourceId),
  470. PositionTicks = session.PlayState == null ? null : session.PlayState.PositionTicks
  471. });
  472. }
  473. catch (Exception ex)
  474. {
  475. _logger.Debug("Error calling OnPlaybackStopped", ex);
  476. }
  477. }
  478. playingSessions = Sessions.Where(i => i.NowPlayingItem != null)
  479. .ToList();
  480. }
  481. if (playingSessions.Count == 0)
  482. {
  483. StopIdleCheckTimer();
  484. }
  485. }
  486. /// <summary>
  487. /// Used to report that playback has started for an item
  488. /// </summary>
  489. /// <param name="info">The info.</param>
  490. /// <returns>Task.</returns>
  491. /// <exception cref="System.ArgumentNullException">info</exception>
  492. public async Task OnPlaybackStart(PlaybackStartInfo info)
  493. {
  494. if (info == null)
  495. {
  496. throw new ArgumentNullException("info");
  497. }
  498. var session = GetSession(info.SessionId);
  499. var libraryItem = string.IsNullOrWhiteSpace(info.ItemId)
  500. ? null
  501. : _libraryManager.GetItemById(new Guid(info.ItemId));
  502. await UpdateNowPlayingItem(session, info, libraryItem).ConfigureAwait(false);
  503. if (!string.IsNullOrEmpty(session.DeviceId) && info.PlayMethod != PlayMethod.Transcode)
  504. {
  505. ClearTranscodingInfo(session.DeviceId);
  506. }
  507. session.QueueableMediaTypes = info.QueueableMediaTypes;
  508. var users = GetUsers(session);
  509. if (libraryItem != null)
  510. {
  511. var key = libraryItem.GetUserDataKey();
  512. foreach (var user in users)
  513. {
  514. await OnPlaybackStart(user.Id, key, libraryItem).ConfigureAwait(false);
  515. }
  516. }
  517. // Nothing to save here
  518. // Fire events to inform plugins
  519. EventHelper.QueueEventIfNotNull(PlaybackStart, this, new PlaybackProgressEventArgs
  520. {
  521. Item = libraryItem,
  522. Users = users,
  523. MediaSourceId = info.MediaSourceId,
  524. MediaInfo = info.Item,
  525. DeviceName = session.DeviceName,
  526. ClientName = session.Client,
  527. DeviceId = session.DeviceId
  528. }, _logger);
  529. await SendPlaybackStartNotification(session, CancellationToken.None).ConfigureAwait(false);
  530. StartIdleCheckTimer();
  531. }
  532. /// <summary>
  533. /// Called when [playback start].
  534. /// </summary>
  535. /// <param name="userId">The user identifier.</param>
  536. /// <param name="userDataKey">The user data key.</param>
  537. /// <param name="item">The item.</param>
  538. /// <returns>Task.</returns>
  539. private async Task OnPlaybackStart(Guid userId, string userDataKey, IHasUserData item)
  540. {
  541. var data = _userDataRepository.GetUserData(userId, userDataKey);
  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. var key = libraryItem.GetUserDataKey();
  572. foreach (var user in users)
  573. {
  574. await OnPlaybackProgress(user, key, libraryItem, info).ConfigureAwait(false);
  575. }
  576. }
  577. if (!string.IsNullOrWhiteSpace(info.LiveStreamId))
  578. {
  579. try
  580. {
  581. await _mediaSourceManager.PingLiveStream(info.LiveStreamId, CancellationToken.None).ConfigureAwait(false);
  582. }
  583. catch (Exception ex)
  584. {
  585. _logger.ErrorException("Error closing live stream", ex);
  586. }
  587. }
  588. EventHelper.FireEventIfNotNull(PlaybackProgress, this, new PlaybackProgressEventArgs
  589. {
  590. Item = libraryItem,
  591. Users = users,
  592. PlaybackPositionTicks = session.PlayState.PositionTicks,
  593. MediaSourceId = session.PlayState.MediaSourceId,
  594. MediaInfo = info.Item,
  595. DeviceName = session.DeviceName,
  596. ClientName = session.Client,
  597. DeviceId = session.DeviceId
  598. }, _logger);
  599. StartIdleCheckTimer();
  600. }
  601. private async Task OnPlaybackProgress(User user, string userDataKey, BaseItem item, PlaybackProgressInfo info)
  602. {
  603. var data = _userDataRepository.GetUserData(user.Id, userDataKey);
  604. var positionTicks = info.PositionTicks;
  605. if (positionTicks.HasValue)
  606. {
  607. _userDataRepository.UpdatePlayState(item, data, positionTicks.Value);
  608. UpdatePlaybackSettings(user, info, data);
  609. await _userDataRepository.SaveUserData(user.Id, item, data, UserDataSaveReason.PlaybackProgress, CancellationToken.None).ConfigureAwait(false);
  610. }
  611. }
  612. private void UpdatePlaybackSettings(User user, PlaybackProgressInfo info, UserItemData data)
  613. {
  614. if (user.Configuration.RememberAudioSelections)
  615. {
  616. data.AudioStreamIndex = info.AudioStreamIndex;
  617. }
  618. else
  619. {
  620. data.AudioStreamIndex = null;
  621. }
  622. if (user.Configuration.RememberSubtitleSelections)
  623. {
  624. data.SubtitleStreamIndex = info.SubtitleStreamIndex;
  625. }
  626. else
  627. {
  628. data.SubtitleStreamIndex = null;
  629. }
  630. }
  631. /// <summary>
  632. /// Used to report that playback has ended for an item
  633. /// </summary>
  634. /// <param name="info">The info.</param>
  635. /// <returns>Task.</returns>
  636. /// <exception cref="System.ArgumentNullException">info</exception>
  637. /// <exception cref="System.ArgumentOutOfRangeException">positionTicks</exception>
  638. public async Task OnPlaybackStopped(PlaybackStopInfo info)
  639. {
  640. if (info == null)
  641. {
  642. throw new ArgumentNullException("info");
  643. }
  644. if (info.PositionTicks.HasValue && info.PositionTicks.Value < 0)
  645. {
  646. throw new ArgumentOutOfRangeException("positionTicks");
  647. }
  648. var session = GetSession(info.SessionId);
  649. var libraryItem = string.IsNullOrWhiteSpace(info.ItemId)
  650. ? null
  651. : _libraryManager.GetItemById(new Guid(info.ItemId));
  652. // Normalize
  653. if (string.IsNullOrWhiteSpace(info.MediaSourceId))
  654. {
  655. info.MediaSourceId = info.ItemId;
  656. }
  657. if (!string.IsNullOrWhiteSpace(info.ItemId) && info.Item == null && libraryItem != null)
  658. {
  659. var current = session.NowPlayingItem;
  660. if (current == null || !string.Equals(current.Id, info.ItemId, StringComparison.OrdinalIgnoreCase))
  661. {
  662. MediaSourceInfo mediaSource = null;
  663. var hasMediaSources = libraryItem as IHasMediaSources;
  664. if (hasMediaSources != null)
  665. {
  666. mediaSource = await GetMediaSource(hasMediaSources, info.MediaSourceId).ConfigureAwait(false);
  667. }
  668. info.Item = GetItemInfo(libraryItem, libraryItem, mediaSource);
  669. }
  670. else
  671. {
  672. info.Item = current;
  673. }
  674. }
  675. RemoveNowPlayingItem(session);
  676. var users = GetUsers(session);
  677. var playedToCompletion = false;
  678. if (libraryItem != null)
  679. {
  680. var key = libraryItem.GetUserDataKey();
  681. foreach (var user in users)
  682. {
  683. playedToCompletion = await OnPlaybackStopped(user.Id, key, 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, string userDataKey, BaseItem item, long? positionTicks, bool playbackFailed)
  712. {
  713. bool playedToCompletion = false;
  714. if (!playbackFailed)
  715. {
  716. var data = _userDataRepository.GetUserData(userId, userDataKey);
  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 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. items = command.ItemIds.SelectMany(i => TranslateItemForPlayback(i, user))
  795. .Where(i => i.LocationType != LocationType.Virtual)
  796. .ToList();
  797. }
  798. if (command.PlayCommand == PlayCommand.PlayShuffle)
  799. {
  800. items = items.OrderBy(i => Guid.NewGuid()).ToList();
  801. command.PlayCommand = PlayCommand.PlayNow;
  802. }
  803. command.ItemIds = items.Select(i => i.Id.ToString("N")).ToArray();
  804. if (user != null)
  805. {
  806. if (items.Any(i => i.GetPlayAccess(user) != PlayAccess.Full))
  807. {
  808. throw new ArgumentException(string.Format("{0} is not allowed to play media.", user.Name));
  809. }
  810. }
  811. if (command.PlayCommand != PlayCommand.PlayNow)
  812. {
  813. if (items.Any(i => !session.QueueableMediaTypes.Contains(i.MediaType, StringComparer.OrdinalIgnoreCase)))
  814. {
  815. throw new ArgumentException(string.Format("{0} is unable to queue the requested media type.", session.DeviceName ?? session.Id));
  816. }
  817. }
  818. else
  819. {
  820. if (items.Any(i => !session.PlayableMediaTypes.Contains(i.MediaType, StringComparer.OrdinalIgnoreCase)))
  821. {
  822. throw new ArgumentException(string.Format("{0} is unable to play the requested media type.", session.DeviceName ?? session.Id));
  823. }
  824. }
  825. if (user != null && command.ItemIds.Length == 1 && user.Configuration.EnableNextEpisodeAutoPlay)
  826. {
  827. var episode = _libraryManager.GetItemById(command.ItemIds[0]) as Episode;
  828. if (episode != null)
  829. {
  830. var series = episode.Series;
  831. if (series != null)
  832. {
  833. var episodes = series.GetEpisodes(user, false, false)
  834. .SkipWhile(i => i.Id != episode.Id)
  835. .ToList();
  836. if (episodes.Count > 0)
  837. {
  838. command.ItemIds = episodes.Select(i => i.Id.ToString("N")).ToArray();
  839. }
  840. }
  841. }
  842. }
  843. var controllingSession = GetSession(controllingSessionId);
  844. AssertCanControl(session, controllingSession);
  845. if (controllingSession.UserId.HasValue)
  846. {
  847. command.ControllingUserId = controllingSession.UserId.Value.ToString("N");
  848. }
  849. return session.SessionController.SendPlayCommand(command, cancellationToken);
  850. }
  851. private IEnumerable<BaseItem> TranslateItemForPlayback(string id, User user)
  852. {
  853. var item = _libraryManager.GetItemById(id);
  854. if (item == null)
  855. {
  856. _logger.Error("A non-existant item Id {0} was passed into TranslateItemForPlayback", id);
  857. return new List<BaseItem>();
  858. }
  859. var byName = item as IItemByName;
  860. if (byName != null)
  861. {
  862. var itemFilter = byName.GetItemFilter();
  863. var items = user == null ?
  864. _libraryManager.RootFolder.GetRecursiveChildren(i => !i.IsFolder && itemFilter(i)) :
  865. user.RootFolder.GetRecursiveChildren(user, i => !i.IsFolder && itemFilter(i));
  866. return FilterToSingleMediaType(items)
  867. .OrderBy(i => i.SortName);
  868. }
  869. if (item.IsFolder)
  870. {
  871. var folder = (Folder)item;
  872. var items = user == null ?
  873. folder.GetRecursiveChildren(i => !i.IsFolder) :
  874. folder.GetRecursiveChildren(user, i => !i.IsFolder);
  875. return FilterToSingleMediaType(items)
  876. .OrderBy(i => i.SortName);
  877. }
  878. return new[] { item };
  879. }
  880. private IEnumerable<BaseItem> FilterToSingleMediaType(IEnumerable<BaseItem> items)
  881. {
  882. return items
  883. .Where(i => !string.IsNullOrWhiteSpace(i.MediaType))
  884. .ToLookup(i => i.MediaType, StringComparer.OrdinalIgnoreCase)
  885. .OrderByDescending(i => i.Count())
  886. .FirstOrDefault();
  887. }
  888. private IEnumerable<BaseItem> TranslateItemForInstantMix(string id, User user)
  889. {
  890. var item = _libraryManager.GetItemById(id);
  891. if (item == null)
  892. {
  893. _logger.Error("A non-existant item Id {0} was passed into TranslateItemForInstantMix", id);
  894. return new List<BaseItem>();
  895. }
  896. return _musicManager.GetInstantMixFromItem(item, user);
  897. }
  898. public Task SendBrowseCommand(string controllingSessionId, string sessionId, BrowseRequest command, CancellationToken cancellationToken)
  899. {
  900. var generalCommand = new GeneralCommand
  901. {
  902. Name = GeneralCommandType.DisplayContent.ToString()
  903. };
  904. generalCommand.Arguments["ItemId"] = command.ItemId;
  905. generalCommand.Arguments["ItemName"] = command.ItemName;
  906. generalCommand.Arguments["ItemType"] = command.ItemType;
  907. return SendGeneralCommand(controllingSessionId, sessionId, generalCommand, cancellationToken);
  908. }
  909. public Task SendPlaystateCommand(string controllingSessionId, string sessionId, PlaystateRequest command, CancellationToken cancellationToken)
  910. {
  911. var session = GetSessionToRemoteControl(sessionId);
  912. var controllingSession = GetSession(controllingSessionId);
  913. AssertCanControl(session, controllingSession);
  914. if (controllingSession.UserId.HasValue)
  915. {
  916. command.ControllingUserId = controllingSession.UserId.Value.ToString("N");
  917. }
  918. return session.SessionController.SendPlaystateCommand(command, cancellationToken);
  919. }
  920. private void AssertCanControl(SessionInfo session, SessionInfo controllingSession)
  921. {
  922. if (session == null)
  923. {
  924. throw new ArgumentNullException("session");
  925. }
  926. if (controllingSession == null)
  927. {
  928. throw new ArgumentNullException("controllingSession");
  929. }
  930. }
  931. /// <summary>
  932. /// Sends the restart required message.
  933. /// </summary>
  934. /// <param name="cancellationToken">The cancellation token.</param>
  935. /// <returns>Task.</returns>
  936. public Task SendRestartRequiredNotification(CancellationToken cancellationToken)
  937. {
  938. var sessions = Sessions.Where(i => i.IsActive && i.SessionController != null).ToList();
  939. var info = _appHost.GetSystemInfo();
  940. var tasks = sessions.Select(session => Task.Run(async () =>
  941. {
  942. try
  943. {
  944. await session.SessionController.SendRestartRequiredNotification(info, cancellationToken).ConfigureAwait(false);
  945. }
  946. catch (Exception ex)
  947. {
  948. _logger.ErrorException("Error in SendRestartRequiredNotification.", ex);
  949. }
  950. }, cancellationToken));
  951. return Task.WhenAll(tasks);
  952. }
  953. /// <summary>
  954. /// Sends the server shutdown notification.
  955. /// </summary>
  956. /// <param name="cancellationToken">The cancellation token.</param>
  957. /// <returns>Task.</returns>
  958. public Task SendServerShutdownNotification(CancellationToken cancellationToken)
  959. {
  960. var sessions = Sessions.Where(i => i.IsActive && i.SessionController != null).ToList();
  961. var tasks = sessions.Select(session => Task.Run(async () =>
  962. {
  963. try
  964. {
  965. await session.SessionController.SendServerShutdownNotification(cancellationToken).ConfigureAwait(false);
  966. }
  967. catch (Exception ex)
  968. {
  969. _logger.ErrorException("Error in SendServerShutdownNotification.", ex);
  970. }
  971. }, cancellationToken));
  972. return Task.WhenAll(tasks);
  973. }
  974. /// <summary>
  975. /// Sends the server restart notification.
  976. /// </summary>
  977. /// <param name="cancellationToken">The cancellation token.</param>
  978. /// <returns>Task.</returns>
  979. public Task SendServerRestartNotification(CancellationToken cancellationToken)
  980. {
  981. _logger.Debug("Beginning SendServerRestartNotification");
  982. var sessions = Sessions.Where(i => i.IsActive && i.SessionController != null).ToList();
  983. var tasks = sessions.Select(session => Task.Run(async () =>
  984. {
  985. try
  986. {
  987. await session.SessionController.SendServerRestartNotification(cancellationToken).ConfigureAwait(false);
  988. }
  989. catch (Exception ex)
  990. {
  991. _logger.ErrorException("Error in SendServerRestartNotification.", ex);
  992. }
  993. }, cancellationToken));
  994. return Task.WhenAll(tasks);
  995. }
  996. public Task SendSessionEndedNotification(SessionInfo sessionInfo, CancellationToken cancellationToken)
  997. {
  998. var sessions = Sessions.Where(i => i.IsActive && i.SessionController != null).ToList();
  999. var dto = GetSessionInfoDto(sessionInfo);
  1000. var tasks = sessions.Select(session => Task.Run(async () =>
  1001. {
  1002. try
  1003. {
  1004. await session.SessionController.SendSessionEndedNotification(dto, cancellationToken).ConfigureAwait(false);
  1005. }
  1006. catch (Exception ex)
  1007. {
  1008. _logger.ErrorException("Error in SendSessionEndedNotification.", ex);
  1009. }
  1010. }, cancellationToken));
  1011. return Task.WhenAll(tasks);
  1012. }
  1013. public Task SendPlaybackStartNotification(SessionInfo sessionInfo, CancellationToken cancellationToken)
  1014. {
  1015. var sessions = Sessions.Where(i => i.IsActive && i.SessionController != null).ToList();
  1016. var dto = GetSessionInfoDto(sessionInfo);
  1017. var tasks = sessions.Select(session => Task.Run(async () =>
  1018. {
  1019. try
  1020. {
  1021. await session.SessionController.SendPlaybackStartNotification(dto, cancellationToken).ConfigureAwait(false);
  1022. }
  1023. catch (Exception ex)
  1024. {
  1025. _logger.ErrorException("Error in SendPlaybackStartNotification.", ex);
  1026. }
  1027. }, cancellationToken));
  1028. return Task.WhenAll(tasks);
  1029. }
  1030. public Task SendPlaybackStoppedNotification(SessionInfo sessionInfo, CancellationToken cancellationToken)
  1031. {
  1032. var sessions = Sessions.Where(i => i.IsActive && i.SessionController != null).ToList();
  1033. var dto = GetSessionInfoDto(sessionInfo);
  1034. var tasks = sessions.Select(session => Task.Run(async () =>
  1035. {
  1036. try
  1037. {
  1038. await session.SessionController.SendPlaybackStoppedNotification(dto, cancellationToken).ConfigureAwait(false);
  1039. }
  1040. catch (Exception ex)
  1041. {
  1042. _logger.ErrorException("Error in SendPlaybackStoppedNotification.", ex);
  1043. }
  1044. }, cancellationToken));
  1045. return Task.WhenAll(tasks);
  1046. }
  1047. /// <summary>
  1048. /// Adds the additional user.
  1049. /// </summary>
  1050. /// <param name="sessionId">The session identifier.</param>
  1051. /// <param name="userId">The user identifier.</param>
  1052. /// <exception cref="System.UnauthorizedAccessException">Cannot modify additional users without authenticating first.</exception>
  1053. /// <exception cref="System.ArgumentException">The requested user is already the primary user of the session.</exception>
  1054. public void AddAdditionalUser(string sessionId, string userId)
  1055. {
  1056. var session = GetSession(sessionId);
  1057. if (session.UserId.HasValue && session.UserId.Value == new Guid(userId))
  1058. {
  1059. throw new ArgumentException("The requested user is already the primary user of the session.");
  1060. }
  1061. if (session.AdditionalUsers.All(i => new Guid(i.UserId) != new Guid(userId)))
  1062. {
  1063. var user = _userManager.GetUserById(userId);
  1064. session.AdditionalUsers.Add(new SessionUserInfo
  1065. {
  1066. UserId = userId,
  1067. UserName = user.Name
  1068. });
  1069. }
  1070. }
  1071. /// <summary>
  1072. /// Removes the additional user.
  1073. /// </summary>
  1074. /// <param name="sessionId">The session identifier.</param>
  1075. /// <param name="userId">The user identifier.</param>
  1076. /// <exception cref="System.UnauthorizedAccessException">Cannot modify additional users without authenticating first.</exception>
  1077. /// <exception cref="System.ArgumentException">The requested user is already the primary user of the session.</exception>
  1078. public void RemoveAdditionalUser(string sessionId, string userId)
  1079. {
  1080. var session = GetSession(sessionId);
  1081. if (session.UserId.HasValue && session.UserId.Value == new Guid(userId))
  1082. {
  1083. throw new ArgumentException("The requested user is already the primary user of the session.");
  1084. }
  1085. var user = session.AdditionalUsers.FirstOrDefault(i => new Guid(i.UserId) == new Guid(userId));
  1086. if (user != null)
  1087. {
  1088. session.AdditionalUsers.Remove(user);
  1089. }
  1090. }
  1091. /// <summary>
  1092. /// Authenticates the new session.
  1093. /// </summary>
  1094. /// <param name="request">The request.</param>
  1095. /// <returns>Task{SessionInfo}.</returns>
  1096. public Task<AuthenticationResult> AuthenticateNewSession(AuthenticationRequest request)
  1097. {
  1098. return AuthenticateNewSessionInternal(request, true);
  1099. }
  1100. public Task<AuthenticationResult> CreateNewSession(AuthenticationRequest request)
  1101. {
  1102. return AuthenticateNewSessionInternal(request, false);
  1103. }
  1104. private async Task<AuthenticationResult> AuthenticateNewSessionInternal(AuthenticationRequest request, bool enforcePassword)
  1105. {
  1106. var user = _userManager.Users
  1107. .FirstOrDefault(i => string.Equals(request.Username, i.Name, StringComparison.OrdinalIgnoreCase));
  1108. if (user != null && !string.IsNullOrWhiteSpace(request.DeviceId))
  1109. {
  1110. if (!_deviceManager.CanAccessDevice(user.Id.ToString("N"), request.DeviceId))
  1111. {
  1112. throw new SecurityException("User is not allowed access from this device.");
  1113. }
  1114. }
  1115. if (enforcePassword)
  1116. {
  1117. var result = await _userManager.AuthenticateUser(request.Username, request.PasswordSha1, request.PasswordMd5, request.RemoteEndPoint).ConfigureAwait(false);
  1118. if (!result)
  1119. {
  1120. EventHelper.FireEventIfNotNull(AuthenticationFailed, this, new GenericEventArgs<AuthenticationRequest>(request), _logger);
  1121. throw new SecurityException("Invalid user or password entered.");
  1122. }
  1123. }
  1124. var token = await GetAuthorizationToken(user.Id.ToString("N"), request.DeviceId, request.App, request.AppVersion, request.DeviceName).ConfigureAwait(false);
  1125. EventHelper.FireEventIfNotNull(AuthenticationSucceeded, this, new GenericEventArgs<AuthenticationRequest>(request), _logger);
  1126. var session = await LogSessionActivity(request.App,
  1127. request.AppVersion,
  1128. request.DeviceId,
  1129. request.DeviceName,
  1130. request.RemoteEndPoint,
  1131. user)
  1132. .ConfigureAwait(false);
  1133. return new AuthenticationResult
  1134. {
  1135. User = _userManager.GetUserDto(user, request.RemoteEndPoint),
  1136. SessionInfo = GetSessionInfoDto(session),
  1137. AccessToken = token,
  1138. ServerId = _appHost.SystemId
  1139. };
  1140. }
  1141. private async Task<string> GetAuthorizationToken(string userId, string deviceId, string app, string appVersion, string deviceName)
  1142. {
  1143. var existing = _authRepo.Get(new AuthenticationInfoQuery
  1144. {
  1145. DeviceId = deviceId,
  1146. IsActive = true,
  1147. UserId = userId,
  1148. Limit = 1
  1149. });
  1150. if (existing.Items.Length > 0)
  1151. {
  1152. var token = existing.Items[0].AccessToken;
  1153. _logger.Info("Reissuing access token: " + token);
  1154. return token;
  1155. }
  1156. var newToken = new AuthenticationInfo
  1157. {
  1158. AppName = app,
  1159. AppVersion = appVersion,
  1160. DateCreated = DateTime.UtcNow,
  1161. DeviceId = deviceId,
  1162. DeviceName = deviceName,
  1163. UserId = userId,
  1164. IsActive = true,
  1165. AccessToken = Guid.NewGuid().ToString("N")
  1166. };
  1167. _logger.Info("Creating new access token for user {0}", userId);
  1168. await _authRepo.Create(newToken, CancellationToken.None).ConfigureAwait(false);
  1169. return newToken.AccessToken;
  1170. }
  1171. public async Task Logout(string accessToken)
  1172. {
  1173. if (string.IsNullOrWhiteSpace(accessToken))
  1174. {
  1175. throw new ArgumentNullException("accessToken");
  1176. }
  1177. _logger.Info("Logging out access token {0}", accessToken);
  1178. var existing = _authRepo.Get(new AuthenticationInfoQuery
  1179. {
  1180. Limit = 1,
  1181. AccessToken = accessToken
  1182. }).Items.FirstOrDefault();
  1183. if (existing != null)
  1184. {
  1185. existing.IsActive = false;
  1186. await _authRepo.Update(existing, CancellationToken.None).ConfigureAwait(false);
  1187. var sessions = Sessions
  1188. .Where(i => string.Equals(i.DeviceId, existing.DeviceId, StringComparison.OrdinalIgnoreCase))
  1189. .ToList();
  1190. foreach (var session in sessions)
  1191. {
  1192. try
  1193. {
  1194. ReportSessionEnded(session.Id);
  1195. }
  1196. catch (Exception ex)
  1197. {
  1198. _logger.ErrorException("Error reporting session ended", ex);
  1199. }
  1200. }
  1201. }
  1202. }
  1203. public async Task RevokeUserTokens(string userId)
  1204. {
  1205. var existing = _authRepo.Get(new AuthenticationInfoQuery
  1206. {
  1207. IsActive = true,
  1208. UserId = userId
  1209. });
  1210. foreach (var info in existing.Items)
  1211. {
  1212. await Logout(info.AccessToken).ConfigureAwait(false);
  1213. }
  1214. }
  1215. public Task RevokeToken(string token)
  1216. {
  1217. return Logout(token);
  1218. }
  1219. /// <summary>
  1220. /// Reports the capabilities.
  1221. /// </summary>
  1222. /// <param name="sessionId">The session identifier.</param>
  1223. /// <param name="capabilities">The capabilities.</param>
  1224. public void ReportCapabilities(string sessionId, ClientCapabilities capabilities)
  1225. {
  1226. var session = GetSession(sessionId);
  1227. ReportCapabilities(session, capabilities, true);
  1228. }
  1229. private async void ReportCapabilities(SessionInfo session,
  1230. ClientCapabilities capabilities,
  1231. bool saveCapabilities)
  1232. {
  1233. session.Capabilities = capabilities;
  1234. if (!string.IsNullOrWhiteSpace(capabilities.MessageCallbackUrl))
  1235. {
  1236. var controller = session.SessionController as HttpSessionController;
  1237. if (controller == null)
  1238. {
  1239. session.SessionController = new HttpSessionController(_httpClient, _jsonSerializer, session, capabilities.MessageCallbackUrl, this);
  1240. }
  1241. }
  1242. EventHelper.FireEventIfNotNull(CapabilitiesChanged, this, new SessionEventArgs
  1243. {
  1244. SessionInfo = session
  1245. }, _logger);
  1246. if (saveCapabilities)
  1247. {
  1248. try
  1249. {
  1250. await SaveCapabilities(session.DeviceId, capabilities).ConfigureAwait(false);
  1251. }
  1252. catch (Exception ex)
  1253. {
  1254. _logger.ErrorException("Error saving device capabilities", ex);
  1255. }
  1256. }
  1257. }
  1258. private ClientCapabilities GetSavedCapabilities(string deviceId)
  1259. {
  1260. return _deviceManager.GetCapabilities(deviceId);
  1261. }
  1262. private Task SaveCapabilities(string deviceId, ClientCapabilities capabilities)
  1263. {
  1264. return _deviceManager.SaveCapabilities(deviceId, capabilities);
  1265. }
  1266. public SessionInfoDto GetSessionInfoDto(SessionInfo session)
  1267. {
  1268. var dto = new SessionInfoDto
  1269. {
  1270. Client = session.Client,
  1271. DeviceId = session.DeviceId,
  1272. DeviceName = session.DeviceName,
  1273. Id = session.Id,
  1274. LastActivityDate = session.LastActivityDate,
  1275. NowViewingItem = session.NowViewingItem,
  1276. ApplicationVersion = session.ApplicationVersion,
  1277. QueueableMediaTypes = session.QueueableMediaTypes,
  1278. PlayableMediaTypes = session.PlayableMediaTypes,
  1279. AdditionalUsers = session.AdditionalUsers,
  1280. SupportedCommands = session.SupportedCommands,
  1281. UserName = session.UserName,
  1282. NowPlayingItem = session.NowPlayingItem,
  1283. SupportsRemoteControl = session.SupportsMediaControl,
  1284. PlayState = session.PlayState,
  1285. AppIconUrl = session.AppIconUrl,
  1286. TranscodingInfo = session.NowPlayingItem == null ? null : session.TranscodingInfo
  1287. };
  1288. if (session.UserId.HasValue)
  1289. {
  1290. dto.UserId = session.UserId.Value.ToString("N");
  1291. var user = _userManager.GetUserById(session.UserId.Value);
  1292. if (user != null)
  1293. {
  1294. dto.UserPrimaryImageTag = GetImageCacheTag(user, ImageType.Primary);
  1295. }
  1296. }
  1297. return dto;
  1298. }
  1299. /// <summary>
  1300. /// Converts a BaseItem to a BaseItemInfo
  1301. /// </summary>
  1302. /// <param name="item">The item.</param>
  1303. /// <param name="chapterOwner">The chapter owner.</param>
  1304. /// <param name="mediaSource">The media source.</param>
  1305. /// <returns>BaseItemInfo.</returns>
  1306. /// <exception cref="System.ArgumentNullException">item</exception>
  1307. private BaseItemInfo GetItemInfo(BaseItem item, BaseItem chapterOwner, MediaSourceInfo mediaSource)
  1308. {
  1309. if (item == null)
  1310. {
  1311. throw new ArgumentNullException("item");
  1312. }
  1313. var info = new BaseItemInfo
  1314. {
  1315. Id = GetDtoId(item),
  1316. Name = item.Name,
  1317. MediaType = item.MediaType,
  1318. Type = item.GetClientTypeName(),
  1319. RunTimeTicks = item.RunTimeTicks,
  1320. IndexNumber = item.IndexNumber,
  1321. ParentIndexNumber = item.ParentIndexNumber,
  1322. PremiereDate = item.PremiereDate,
  1323. ProductionYear = item.ProductionYear
  1324. };
  1325. info.PrimaryImageTag = GetImageCacheTag(item, ImageType.Primary);
  1326. if (info.PrimaryImageTag != null)
  1327. {
  1328. info.PrimaryImageItemId = GetDtoId(item);
  1329. }
  1330. var episode = item as Episode;
  1331. if (episode != null)
  1332. {
  1333. info.IndexNumberEnd = episode.IndexNumberEnd;
  1334. }
  1335. var hasSeries = item as IHasSeries;
  1336. if (hasSeries != null)
  1337. {
  1338. info.SeriesName = hasSeries.SeriesName;
  1339. }
  1340. var recording = item as ILiveTvRecording;
  1341. if (recording != null)
  1342. {
  1343. if (recording.IsSeries)
  1344. {
  1345. info.Name = recording.EpisodeTitle;
  1346. info.SeriesName = recording.Name;
  1347. if (string.IsNullOrWhiteSpace(info.Name))
  1348. {
  1349. info.Name = recording.Name;
  1350. }
  1351. }
  1352. }
  1353. var audio = item as Audio;
  1354. if (audio != null)
  1355. {
  1356. info.Album = audio.Album;
  1357. info.Artists = audio.Artists;
  1358. if (info.PrimaryImageTag == null)
  1359. {
  1360. var album = audio.AlbumEntity;
  1361. if (album != null && album.HasImage(ImageType.Primary))
  1362. {
  1363. info.PrimaryImageTag = GetImageCacheTag(album, ImageType.Primary);
  1364. if (info.PrimaryImageTag != null)
  1365. {
  1366. info.PrimaryImageItemId = GetDtoId(album);
  1367. }
  1368. }
  1369. }
  1370. }
  1371. var musicVideo = item as MusicVideo;
  1372. if (musicVideo != null)
  1373. {
  1374. info.Album = musicVideo.Album;
  1375. info.Artists = musicVideo.Artists.ToList();
  1376. }
  1377. var backropItem = item.HasImage(ImageType.Backdrop) ? item : null;
  1378. var thumbItem = item.HasImage(ImageType.Thumb) ? item : null;
  1379. var logoItem = item.HasImage(ImageType.Logo) ? item : null;
  1380. if (thumbItem == null)
  1381. {
  1382. if (episode != null)
  1383. {
  1384. var series = episode.Series;
  1385. if (series != null && series.HasImage(ImageType.Thumb))
  1386. {
  1387. thumbItem = series;
  1388. }
  1389. }
  1390. }
  1391. if (backropItem == null)
  1392. {
  1393. if (episode != null)
  1394. {
  1395. var series = episode.Series;
  1396. if (series != null && series.HasImage(ImageType.Backdrop))
  1397. {
  1398. backropItem = series;
  1399. }
  1400. }
  1401. }
  1402. if (backropItem == null)
  1403. {
  1404. backropItem = item.GetParents().FirstOrDefault(i => i.HasImage(ImageType.Backdrop));
  1405. }
  1406. if (thumbItem == null)
  1407. {
  1408. thumbItem = item.GetParents().FirstOrDefault(i => i.HasImage(ImageType.Thumb));
  1409. }
  1410. if (logoItem == null)
  1411. {
  1412. logoItem = item.GetParents().FirstOrDefault(i => i.HasImage(ImageType.Logo));
  1413. }
  1414. if (thumbItem != null)
  1415. {
  1416. info.ThumbImageTag = GetImageCacheTag(thumbItem, ImageType.Thumb);
  1417. info.ThumbItemId = GetDtoId(thumbItem);
  1418. }
  1419. if (backropItem != null)
  1420. {
  1421. info.BackdropImageTag = GetImageCacheTag(backropItem, ImageType.Backdrop);
  1422. info.BackdropItemId = GetDtoId(backropItem);
  1423. }
  1424. if (logoItem != null)
  1425. {
  1426. info.LogoImageTag = GetImageCacheTag(logoItem, ImageType.Logo);
  1427. info.LogoItemId = GetDtoId(logoItem);
  1428. }
  1429. if (chapterOwner != null)
  1430. {
  1431. info.ChapterImagesItemId = chapterOwner.Id.ToString("N");
  1432. info.Chapters = _dtoService.GetChapterInfoDtos(chapterOwner).ToList();
  1433. }
  1434. if (mediaSource != null)
  1435. {
  1436. info.MediaStreams = mediaSource.MediaStreams;
  1437. }
  1438. return info;
  1439. }
  1440. private string GetImageCacheTag(BaseItem item, ImageType type)
  1441. {
  1442. try
  1443. {
  1444. return _imageProcessor.GetImageCacheTag(item, type);
  1445. }
  1446. catch (Exception ex)
  1447. {
  1448. _logger.ErrorException("Error getting {0} image info", ex, type);
  1449. return null;
  1450. }
  1451. }
  1452. private string GetDtoId(BaseItem item)
  1453. {
  1454. return _dtoService.GetDtoId(item);
  1455. }
  1456. public void ReportNowViewingItem(string sessionId, string itemId)
  1457. {
  1458. var item = _libraryManager.GetItemById(new Guid(itemId));
  1459. var info = GetItemInfo(item, null, null);
  1460. ReportNowViewingItem(sessionId, info);
  1461. }
  1462. public void ReportNowViewingItem(string sessionId, BaseItemInfo item)
  1463. {
  1464. var session = GetSession(sessionId);
  1465. session.NowViewingItem = item;
  1466. }
  1467. public void ReportTranscodingInfo(string deviceId, TranscodingInfo info)
  1468. {
  1469. var session = Sessions.FirstOrDefault(i => string.Equals(i.DeviceId, deviceId));
  1470. if (session != null)
  1471. {
  1472. session.TranscodingInfo = info;
  1473. }
  1474. }
  1475. public void ClearTranscodingInfo(string deviceId)
  1476. {
  1477. ReportTranscodingInfo(deviceId, null);
  1478. }
  1479. public SessionInfo GetSession(string deviceId, string client, string version)
  1480. {
  1481. return Sessions.FirstOrDefault(i => string.Equals(i.DeviceId, deviceId) &&
  1482. string.Equals(i.Client, client));
  1483. }
  1484. public Task<SessionInfo> GetSessionByAuthenticationToken(AuthenticationInfo info, string deviceId, string remoteEndpoint, string appVersion)
  1485. {
  1486. if (info == null)
  1487. {
  1488. throw new ArgumentNullException("info");
  1489. }
  1490. var user = string.IsNullOrWhiteSpace(info.UserId)
  1491. ? null
  1492. : _userManager.GetUserById(info.UserId);
  1493. appVersion = string.IsNullOrWhiteSpace(appVersion)
  1494. ? info.AppVersion
  1495. : appVersion;
  1496. var deviceName = info.DeviceName;
  1497. var appName = info.AppName;
  1498. if (!string.IsNullOrWhiteSpace(deviceId))
  1499. {
  1500. // Replace the info from the token with more recent info
  1501. var device = _deviceManager.GetDevice(deviceId);
  1502. if (device != null)
  1503. {
  1504. deviceName = device.Name;
  1505. appName = device.AppName;
  1506. if (!string.IsNullOrWhiteSpace(device.AppVersion))
  1507. {
  1508. appVersion = device.AppVersion;
  1509. }
  1510. }
  1511. }
  1512. else
  1513. {
  1514. deviceId = info.DeviceId;
  1515. }
  1516. // Prevent argument exception
  1517. if (string.IsNullOrWhiteSpace(appVersion))
  1518. {
  1519. appVersion = "1";
  1520. }
  1521. return LogSessionActivity(appName, appVersion, deviceId, deviceName, remoteEndpoint, user);
  1522. }
  1523. public Task<SessionInfo> GetSessionByAuthenticationToken(string token, string deviceId, string remoteEndpoint)
  1524. {
  1525. var result = _authRepo.Get(new AuthenticationInfoQuery
  1526. {
  1527. AccessToken = token
  1528. });
  1529. var info = result.Items.FirstOrDefault();
  1530. if (info == null)
  1531. {
  1532. return Task.FromResult<SessionInfo>(null);
  1533. }
  1534. return GetSessionByAuthenticationToken(info, deviceId, remoteEndpoint, null);
  1535. }
  1536. public Task SendMessageToUserSessions<T>(string userId, string name, T data,
  1537. CancellationToken cancellationToken)
  1538. {
  1539. var sessions = Sessions.Where(i => i.IsActive && i.SessionController != null && i.ContainsUser(userId)).ToList();
  1540. var tasks = sessions.Select(session => Task.Run(async () =>
  1541. {
  1542. try
  1543. {
  1544. await session.SessionController.SendMessage(name, data, cancellationToken).ConfigureAwait(false);
  1545. }
  1546. catch (Exception ex)
  1547. {
  1548. _logger.ErrorException("Error sending message", ex);
  1549. }
  1550. }, cancellationToken));
  1551. return Task.WhenAll(tasks);
  1552. }
  1553. public Task SendMessageToUserDeviceSessions<T>(string deviceId, string name, T data,
  1554. CancellationToken cancellationToken)
  1555. {
  1556. var sessions = Sessions.Where(i => i.IsActive && i.SessionController != null && string.Equals(i.DeviceId, deviceId, StringComparison.OrdinalIgnoreCase)).ToList();
  1557. var tasks = sessions.Select(session => Task.Run(async () =>
  1558. {
  1559. try
  1560. {
  1561. await session.SessionController.SendMessage(name, data, cancellationToken).ConfigureAwait(false);
  1562. }
  1563. catch (Exception ex)
  1564. {
  1565. _logger.ErrorException("Error sending message", ex);
  1566. }
  1567. }, cancellationToken));
  1568. return Task.WhenAll(tasks);
  1569. }
  1570. }
  1571. }