SessionManager.cs 62 KB

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