SessionsService.cs 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577
  1. using MediaBrowser.Controller.Devices;
  2. using MediaBrowser.Controller.Library;
  3. using MediaBrowser.Controller.Net;
  4. using MediaBrowser.Controller.Security;
  5. using MediaBrowser.Controller.Session;
  6. using MediaBrowser.Model.Session;
  7. using ServiceStack;
  8. using System;
  9. using System.Collections.Generic;
  10. using System.Linq;
  11. using System.Threading;
  12. using System.Threading.Tasks;
  13. namespace MediaBrowser.Api.Session
  14. {
  15. /// <summary>
  16. /// Class GetSessions
  17. /// </summary>
  18. [Route("/Sessions", "GET", Summary = "Gets a list of sessions")]
  19. [Authenticated]
  20. public class GetSessions : IReturn<List<SessionInfoDto>>
  21. {
  22. [ApiMember(Name = "ControllableByUserId", Description = "Optional. Filter by sessions that a given user is allowed to remote control.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  23. public string ControllableByUserId { get; set; }
  24. [ApiMember(Name = "DeviceId", Description = "Optional. Filter by device id.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  25. public string DeviceId { get; set; }
  26. }
  27. /// <summary>
  28. /// Class DisplayContent
  29. /// </summary>
  30. [Route("/Sessions/{Id}/Viewing", "POST", Summary = "Instructs a session to browse to an item or view")]
  31. [Authenticated]
  32. public class DisplayContent : IReturnVoid
  33. {
  34. /// <summary>
  35. /// Gets or sets the id.
  36. /// </summary>
  37. /// <value>The id.</value>
  38. [ApiMember(Name = "Id", Description = "Session Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  39. public string Id { get; set; }
  40. /// <summary>
  41. /// Artist, Genre, Studio, Person, or any kind of BaseItem
  42. /// </summary>
  43. /// <value>The type of the item.</value>
  44. [ApiMember(Name = "ItemType", Description = "The type of item to browse to.", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
  45. public string ItemType { get; set; }
  46. /// <summary>
  47. /// Artist name, genre name, item Id, etc
  48. /// </summary>
  49. /// <value>The item identifier.</value>
  50. [ApiMember(Name = "ItemId", Description = "The Id of the item.", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
  51. public string ItemId { get; set; }
  52. /// <summary>
  53. /// Gets or sets the name of the item.
  54. /// </summary>
  55. /// <value>The name of the item.</value>
  56. [ApiMember(Name = "ItemName", Description = "The name of the item.", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
  57. public string ItemName { get; set; }
  58. }
  59. [Route("/Sessions/{Id}/Playing", "POST", Summary = "Instructs a session to play an item")]
  60. [Authenticated]
  61. public class Play : IReturnVoid
  62. {
  63. /// <summary>
  64. /// Gets or sets the id.
  65. /// </summary>
  66. /// <value>The id.</value>
  67. [ApiMember(Name = "Id", Description = "Session Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  68. public string Id { get; set; }
  69. /// <summary>
  70. /// Artist, Genre, Studio, Person, or any kind of BaseItem
  71. /// </summary>
  72. /// <value>The type of the item.</value>
  73. [ApiMember(Name = "ItemIds", Description = "The ids of the items to play, comma delimited", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST", AllowMultiple = true)]
  74. public string ItemIds { get; set; }
  75. /// <summary>
  76. /// Gets or sets the start position ticks that the first item should be played at
  77. /// </summary>
  78. /// <value>The start position ticks.</value>
  79. [ApiMember(Name = "StartPositionTicks", Description = "The starting position of the first item.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
  80. public long? StartPositionTicks { get; set; }
  81. /// <summary>
  82. /// Gets or sets the play command.
  83. /// </summary>
  84. /// <value>The play command.</value>
  85. [ApiMember(Name = "PlayCommand", Description = "The type of play command to issue (PlayNow, PlayNext, PlayLast). Clients who have not yet implemented play next and play last may play now.", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
  86. public PlayCommand PlayCommand { get; set; }
  87. }
  88. [Route("/Sessions/{Id}/Playing/{Command}", "POST", Summary = "Issues a playstate command to a client")]
  89. [Authenticated]
  90. public class SendPlaystateCommand : IReturnVoid
  91. {
  92. /// <summary>
  93. /// Gets or sets the id.
  94. /// </summary>
  95. /// <value>The id.</value>
  96. [ApiMember(Name = "Id", Description = "Session Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  97. public string Id { get; set; }
  98. /// <summary>
  99. /// Gets or sets the position to seek to
  100. /// </summary>
  101. [ApiMember(Name = "SeekPositionTicks", Description = "The position to seek to.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
  102. public long? SeekPositionTicks { get; set; }
  103. /// <summary>
  104. /// Gets or sets the play command.
  105. /// </summary>
  106. /// <value>The play command.</value>
  107. [ApiMember(Name = "Command", Description = "The command to send - stop, pause, unpause, nexttrack, previoustrack, seek, fullscreen.", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  108. public PlaystateCommand Command { get; set; }
  109. }
  110. [Route("/Sessions/{Id}/System/{Command}", "POST", Summary = "Issues a system command to a client")]
  111. [Authenticated]
  112. public class SendSystemCommand : IReturnVoid
  113. {
  114. /// <summary>
  115. /// Gets or sets the id.
  116. /// </summary>
  117. /// <value>The id.</value>
  118. [ApiMember(Name = "Id", Description = "Session Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  119. public string Id { get; set; }
  120. /// <summary>
  121. /// Gets or sets the command.
  122. /// </summary>
  123. /// <value>The play command.</value>
  124. [ApiMember(Name = "Command", Description = "The command to send.", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  125. public string Command { get; set; }
  126. }
  127. [Route("/Sessions/{Id}/Command/{Command}", "POST", Summary = "Issues a system command to a client")]
  128. [Authenticated]
  129. public class SendGeneralCommand : IReturnVoid
  130. {
  131. /// <summary>
  132. /// Gets or sets the id.
  133. /// </summary>
  134. /// <value>The id.</value>
  135. [ApiMember(Name = "Id", Description = "Session Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  136. public string Id { get; set; }
  137. /// <summary>
  138. /// Gets or sets the command.
  139. /// </summary>
  140. /// <value>The play command.</value>
  141. [ApiMember(Name = "Command", Description = "The command to send.", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  142. public string Command { get; set; }
  143. }
  144. [Route("/Sessions/{Id}/Command", "POST", Summary = "Issues a system command to a client")]
  145. [Authenticated]
  146. public class SendFullGeneralCommand : GeneralCommand, IReturnVoid
  147. {
  148. /// <summary>
  149. /// Gets or sets the id.
  150. /// </summary>
  151. /// <value>The id.</value>
  152. [ApiMember(Name = "Id", Description = "Session Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  153. public string Id { get; set; }
  154. }
  155. [Route("/Sessions/{Id}/Message", "POST", Summary = "Issues a command to a client to display a message to the user")]
  156. [Authenticated]
  157. public class SendMessageCommand : IReturnVoid
  158. {
  159. /// <summary>
  160. /// Gets or sets the id.
  161. /// </summary>
  162. /// <value>The id.</value>
  163. [ApiMember(Name = "Id", Description = "Session Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  164. public string Id { get; set; }
  165. [ApiMember(Name = "Text", Description = "The message text.", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
  166. public string Text { get; set; }
  167. [ApiMember(Name = "Header", Description = "The message header.", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
  168. public string Header { get; set; }
  169. [ApiMember(Name = "TimeoutMs", Description = "The message timeout. If omitted the user will have to confirm viewing the message.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
  170. public long? TimeoutMs { get; set; }
  171. }
  172. [Route("/Sessions/{Id}/Users/{UserId}", "POST", Summary = "Adds an additional user to a session")]
  173. [Authenticated]
  174. public class AddUserToSession : IReturnVoid
  175. {
  176. [ApiMember(Name = "Id", Description = "Session Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  177. public string Id { get; set; }
  178. [ApiMember(Name = "UserId", Description = "UserId Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  179. public string UserId { get; set; }
  180. }
  181. [Route("/Sessions/{Id}/Users/{UserId}", "DELETE", Summary = "Removes an additional user from a session")]
  182. [Authenticated]
  183. public class RemoveUserFromSession : IReturnVoid
  184. {
  185. [ApiMember(Name = "Id", Description = "Session Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  186. public string Id { get; set; }
  187. [ApiMember(Name = "UserId", Description = "UserId Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  188. public string UserId { get; set; }
  189. }
  190. [Route("/Sessions/Capabilities", "POST", Summary = "Updates capabilities for a device")]
  191. [Authenticated]
  192. public class PostCapabilities : IReturnVoid
  193. {
  194. /// <summary>
  195. /// Gets or sets the id.
  196. /// </summary>
  197. /// <value>The id.</value>
  198. [ApiMember(Name = "Id", Description = "Session Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  199. public string Id { get; set; }
  200. [ApiMember(Name = "PlayableMediaTypes", Description = "A list of playable media types, comma delimited. Audio, Video, Book, Game, Photo.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
  201. public string PlayableMediaTypes { get; set; }
  202. [ApiMember(Name = "SupportedCommands", Description = "A list of supported remote control commands, comma delimited", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
  203. public string SupportedCommands { get; set; }
  204. [ApiMember(Name = "MessageCallbackUrl", Description = "A url to post messages to, including remote control commands.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
  205. public string MessageCallbackUrl { get; set; }
  206. [ApiMember(Name = "SupportsMediaControl", Description = "Determines whether media can be played remotely.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "POST")]
  207. public bool SupportsMediaControl { get; set; }
  208. [ApiMember(Name = "SupportsContentUploading", Description = "Determines whether camera upload is supported.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "POST")]
  209. public bool SupportsContentUploading { get; set; }
  210. [ApiMember(Name = "SupportsSync", Description = "Determines whether sync is supported.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "POST")]
  211. public bool SupportsSync { get; set; }
  212. [ApiMember(Name = "SupportsPersistentIdentifier", Description = "Determines whether the device supports a unique identifier.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "POST")]
  213. public bool SupportsPersistentIdentifier { get; set; }
  214. public PostCapabilities()
  215. {
  216. SupportsPersistentIdentifier = true;
  217. }
  218. }
  219. [Route("/Sessions/Capabilities/Full", "POST", Summary = "Updates capabilities for a device")]
  220. [Authenticated]
  221. public class PostFullCapabilities : ClientCapabilities, IReturnVoid
  222. {
  223. /// <summary>
  224. /// Gets or sets the id.
  225. /// </summary>
  226. /// <value>The id.</value>
  227. [ApiMember(Name = "Id", Description = "Session Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  228. public string Id { get; set; }
  229. }
  230. [Route("/Sessions/Logout", "POST", Summary = "Reports that a session has ended")]
  231. [Authenticated]
  232. public class ReportSessionEnded : IReturnVoid
  233. {
  234. }
  235. [Route("/Auth/Keys", "GET")]
  236. [Authenticated(Roles = "Admin")]
  237. public class GetApiKeys
  238. {
  239. }
  240. [Route("/Auth/Keys/{Key}", "DELETE")]
  241. [Authenticated(Roles = "Admin")]
  242. public class RevokeKey
  243. {
  244. [ApiMember(Name = "Key", Description = "Auth Key", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  245. public string Key { get; set; }
  246. }
  247. [Route("/Auth/Keys", "POST")]
  248. [Authenticated(Roles = "Admin")]
  249. public class CreateKey
  250. {
  251. [ApiMember(Name = "App", Description = "App", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
  252. public string App { get; set; }
  253. }
  254. /// <summary>
  255. /// Class SessionsService
  256. /// </summary>
  257. public class SessionsService : BaseApiService
  258. {
  259. /// <summary>
  260. /// The _session manager
  261. /// </summary>
  262. private readonly ISessionManager _sessionManager;
  263. private readonly IUserManager _userManager;
  264. private readonly IAuthorizationContext _authContext;
  265. private readonly IAuthenticationRepository _authRepo;
  266. private readonly IDeviceManager _deviceManager;
  267. /// <summary>
  268. /// Initializes a new instance of the <see cref="SessionsService" /> class.
  269. /// </summary>
  270. /// <param name="sessionManager">The session manager.</param>
  271. /// <param name="userManager">The user manager.</param>
  272. /// <param name="authContext">The authentication context.</param>
  273. /// <param name="authRepo">The authentication repo.</param>
  274. public SessionsService(ISessionManager sessionManager, IUserManager userManager, IAuthorizationContext authContext, IAuthenticationRepository authRepo, IDeviceManager deviceManager)
  275. {
  276. _sessionManager = sessionManager;
  277. _userManager = userManager;
  278. _authContext = authContext;
  279. _authRepo = authRepo;
  280. _deviceManager = deviceManager;
  281. }
  282. public void Delete(RevokeKey request)
  283. {
  284. var task = _sessionManager.RevokeToken(request.Key);
  285. Task.WaitAll(task);
  286. }
  287. public void Post(CreateKey request)
  288. {
  289. var task = _authRepo.Create(new AuthenticationInfo
  290. {
  291. AppName = request.App,
  292. IsActive = true,
  293. AccessToken = Guid.NewGuid().ToString("N"),
  294. DateCreated = DateTime.UtcNow
  295. }, CancellationToken.None);
  296. Task.WaitAll(task);
  297. }
  298. public void Post(ReportSessionEnded request)
  299. {
  300. var auth = _authContext.GetAuthorizationInfo(Request);
  301. _sessionManager.Logout(auth.Token);
  302. }
  303. public object Get(GetApiKeys request)
  304. {
  305. var result = _authRepo.Get(new AuthenticationInfoQuery
  306. {
  307. IsActive = true
  308. });
  309. return ToOptimizedResult(result);
  310. }
  311. /// <summary>
  312. /// Gets the specified request.
  313. /// </summary>
  314. /// <param name="request">The request.</param>
  315. /// <returns>System.Object.</returns>
  316. public object Get(GetSessions request)
  317. {
  318. var result = _sessionManager.Sessions.Where(i => i.IsActive);
  319. if (!string.IsNullOrEmpty(request.DeviceId))
  320. {
  321. result = result.Where(i => string.Equals(i.DeviceId, request.DeviceId, StringComparison.OrdinalIgnoreCase));
  322. }
  323. if (!string.IsNullOrWhiteSpace(request.ControllableByUserId))
  324. {
  325. result = result.Where(i => i.SupportsMediaControl);
  326. var user = _userManager.GetUserById(request.ControllableByUserId);
  327. if (!user.Policy.EnableRemoteControlOfOtherUsers)
  328. {
  329. result = result.Where(i => !i.UserId.HasValue || i.ContainsUser(request.ControllableByUserId));
  330. }
  331. if (!user.Policy.EnableSharedDeviceControl)
  332. {
  333. result = result.Where(i => i.UserId.HasValue);
  334. }
  335. result = result.Where(i =>
  336. {
  337. var deviceId = i.DeviceId;
  338. if (!string.IsNullOrWhiteSpace(deviceId))
  339. {
  340. if (!_deviceManager.CanAccessDevice(user.Id.ToString("N"), deviceId))
  341. {
  342. return false;
  343. }
  344. }
  345. return true;
  346. });
  347. }
  348. return ToOptimizedResult(result.Select(_sessionManager.GetSessionInfoDto).ToList());
  349. }
  350. public void Post(SendPlaystateCommand request)
  351. {
  352. var command = new PlaystateRequest
  353. {
  354. Command = request.Command,
  355. SeekPositionTicks = request.SeekPositionTicks
  356. };
  357. var task = _sessionManager.SendPlaystateCommand(GetSession().Result.Id, request.Id, command, CancellationToken.None);
  358. Task.WaitAll(task);
  359. }
  360. /// <summary>
  361. /// Posts the specified request.
  362. /// </summary>
  363. /// <param name="request">The request.</param>
  364. public void Post(DisplayContent request)
  365. {
  366. var command = new BrowseRequest
  367. {
  368. ItemId = request.ItemId,
  369. ItemName = request.ItemName,
  370. ItemType = request.ItemType
  371. };
  372. var task = _sessionManager.SendBrowseCommand(GetSession().Result.Id, request.Id, command, CancellationToken.None);
  373. Task.WaitAll(task);
  374. }
  375. /// <summary>
  376. /// Posts the specified request.
  377. /// </summary>
  378. /// <param name="request">The request.</param>
  379. public void Post(SendSystemCommand request)
  380. {
  381. GeneralCommandType commandType;
  382. var name = request.Command;
  383. if (Enum.TryParse(name, true, out commandType))
  384. {
  385. name = commandType.ToString();
  386. }
  387. var currentSession = GetSession().Result;
  388. var command = new GeneralCommand
  389. {
  390. Name = name,
  391. ControllingUserId = currentSession.UserId.HasValue ? currentSession.UserId.Value.ToString("N") : null
  392. };
  393. var task = _sessionManager.SendGeneralCommand(currentSession.Id, request.Id, command, CancellationToken.None);
  394. Task.WaitAll(task);
  395. }
  396. /// <summary>
  397. /// Posts the specified request.
  398. /// </summary>
  399. /// <param name="request">The request.</param>
  400. public void Post(SendMessageCommand request)
  401. {
  402. var command = new MessageCommand
  403. {
  404. Header = string.IsNullOrEmpty(request.Header) ? "Message from Server" : request.Header,
  405. TimeoutMs = request.TimeoutMs,
  406. Text = request.Text
  407. };
  408. var task = _sessionManager.SendMessageCommand(GetSession().Result.Id, request.Id, command, CancellationToken.None);
  409. Task.WaitAll(task);
  410. }
  411. /// <summary>
  412. /// Posts the specified request.
  413. /// </summary>
  414. /// <param name="request">The request.</param>
  415. public void Post(Play request)
  416. {
  417. var command = new PlayRequest
  418. {
  419. ItemIds = request.ItemIds.Split(',').ToArray(),
  420. PlayCommand = request.PlayCommand,
  421. StartPositionTicks = request.StartPositionTicks
  422. };
  423. var task = _sessionManager.SendPlayCommand(GetSession().Result.Id, request.Id, command, CancellationToken.None);
  424. Task.WaitAll(task);
  425. }
  426. public void Post(SendGeneralCommand request)
  427. {
  428. var currentSession = GetSession().Result;
  429. var command = new GeneralCommand
  430. {
  431. Name = request.Command,
  432. ControllingUserId = currentSession.UserId.HasValue ? currentSession.UserId.Value.ToString("N") : null
  433. };
  434. var task = _sessionManager.SendGeneralCommand(currentSession.Id, request.Id, command, CancellationToken.None);
  435. Task.WaitAll(task);
  436. }
  437. public void Post(SendFullGeneralCommand request)
  438. {
  439. var currentSession = GetSession().Result;
  440. request.ControllingUserId = currentSession.UserId.HasValue ? currentSession.UserId.Value.ToString("N") : null;
  441. var task = _sessionManager.SendGeneralCommand(currentSession.Id, request.Id, request, CancellationToken.None);
  442. Task.WaitAll(task);
  443. }
  444. public void Post(AddUserToSession request)
  445. {
  446. _sessionManager.AddAdditionalUser(request.Id, request.UserId);
  447. }
  448. public void Delete(RemoveUserFromSession request)
  449. {
  450. _sessionManager.RemoveAdditionalUser(request.Id, request.UserId);
  451. }
  452. public void Post(PostCapabilities request)
  453. {
  454. if (string.IsNullOrWhiteSpace(request.Id))
  455. {
  456. request.Id = GetSession().Result.Id;
  457. }
  458. _sessionManager.ReportCapabilities(request.Id, new ClientCapabilities
  459. {
  460. PlayableMediaTypes = (request.PlayableMediaTypes ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries).ToList(),
  461. SupportedCommands = (request.SupportedCommands ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries).ToList(),
  462. SupportsMediaControl = request.SupportsMediaControl,
  463. MessageCallbackUrl = request.MessageCallbackUrl,
  464. SupportsContentUploading = request.SupportsContentUploading,
  465. SupportsSync = request.SupportsSync,
  466. SupportsPersistentIdentifier = request.SupportsPersistentIdentifier
  467. });
  468. }
  469. public void Post(PostFullCapabilities request)
  470. {
  471. if (string.IsNullOrWhiteSpace(request.Id))
  472. {
  473. request.Id = GetSession().Result.Id;
  474. }
  475. _sessionManager.ReportCapabilities(request.Id, request);
  476. }
  477. }
  478. }