jellyfin/MediaBrowser.Api/SessionsService.cs

375 lines
16 KiB
C#
Raw Normal View History

using MediaBrowser.Controller.Dto;
using MediaBrowser.Controller.Library;
2013-05-09 22:43:11 +00:00
using MediaBrowser.Controller.Session;
using MediaBrowser.Model.Session;
2013-12-07 15:52:38 +00:00
using ServiceStack;
2013-05-10 12:18:07 +00:00
using System;
using System.Collections.Generic;
using System.Linq;
2013-05-10 12:18:07 +00:00
using System.Threading;
2013-05-28 17:25:10 +00:00
using System.Threading.Tasks;
namespace MediaBrowser.Api
{
/// <summary>
/// Class GetSessions
/// </summary>
2014-03-23 19:36:25 +00:00
[Route("/Sessions", "GET", Summary = "Gets a list of sessions")]
2013-05-09 22:43:11 +00:00
public class GetSessions : IReturn<List<SessionInfoDto>>
{
2013-05-11 16:45:20 +00:00
/// <summary>
/// Gets or sets a value indicating whether [supports remote control].
/// </summary>
/// <value><c>null</c> if [supports remote control] contains no value, <c>true</c> if [supports remote control]; otherwise, <c>false</c>.</value>
2013-05-10 12:18:07 +00:00
[ApiMember(Name = "SupportsRemoteControl", Description = "Optional. Filter by sessions that can be remote controlled.", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
public bool? SupportsRemoteControl { get; set; }
[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")]
public Guid? ControllableByUserId { get; set; }
2014-01-06 16:48:43 +00:00
2014-03-23 20:49:05 +00:00
[ApiMember(Name = "DeviceId", Description = "Optional. Filter by device id.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
2014-01-06 16:48:43 +00:00
public string DeviceId { get; set; }
2013-05-10 12:18:07 +00:00
}
2013-05-11 16:45:20 +00:00
/// <summary>
/// Class BrowseTo
/// </summary>
2014-03-23 19:36:25 +00:00
[Route("/Sessions/{Id}/Viewing", "POST", Summary = "Instructs a session to browse to an item or view")]
2013-05-10 12:18:07 +00:00
public class BrowseTo : IReturnVoid
{
2013-05-11 16:45:20 +00:00
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
2013-05-10 12:18:07 +00:00
[ApiMember(Name = "Id", Description = "Session Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
public Guid Id { get; set; }
/// <summary>
2013-05-10 12:18:07 +00:00
/// Artist, Genre, Studio, Person, or any kind of BaseItem
/// </summary>
2013-05-10 12:18:07 +00:00
/// <value>The type of the item.</value>
2013-05-28 17:25:10 +00:00
[ApiMember(Name = "ItemType", Description = "The type of item to browse to.", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
2013-05-10 12:18:07 +00:00
public string ItemType { get; set; }
/// <summary>
/// Artist name, genre name, item Id, etc
/// </summary>
/// <value>The item identifier.</value>
2013-05-26 00:53:51 +00:00
[ApiMember(Name = "ItemId", Description = "The Id of the item.", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
public string ItemId { get; set; }
2013-05-10 12:18:07 +00:00
2013-05-26 00:53:51 +00:00
/// <summary>
/// Gets or sets the name of the item.
/// </summary>
/// <value>The name of the item.</value>
[ApiMember(Name = "ItemName", Description = "The name of the item.", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
public string ItemName { get; set; }
2013-05-28 17:25:10 +00:00
2013-05-10 12:18:07 +00:00
/// <summary>
/// Gets or sets the context (Movies, Music, TvShows, etc)
/// Applicable to genres, studios and persons only because the context of items and artists can be inferred.
/// This is optional to supply and clients are free to ignore it.
/// </summary>
/// <value>The context.</value>
2013-05-26 01:53:34 +00:00
[ApiMember(Name = "Context", Description = "The ui context for the client (movies, music, tv, games etc). This is optional to supply and clients are free to ignore it.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
2013-05-10 12:18:07 +00:00
public string Context { get; set; }
}
2014-03-23 19:36:25 +00:00
[Route("/Sessions/{Id}/Playing", "POST", Summary = "Instructs a session to play an item")]
2013-05-28 17:25:10 +00:00
public class Play : IReturnVoid
{
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
[ApiMember(Name = "Id", Description = "Session Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
public Guid Id { get; set; }
/// <summary>
/// Artist, Genre, Studio, Person, or any kind of BaseItem
/// </summary>
/// <value>The type of the item.</value>
[ApiMember(Name = "ItemIds", Description = "The ids of the items to play, comma delimited", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST", AllowMultiple = true)]
public string ItemIds { get; set; }
/// <summary>
/// Gets or sets the start position ticks that the first item should be played at
/// </summary>
/// <value>The start position ticks.</value>
[ApiMember(Name = "StartPositionTicks", Description = "The starting position of the first item.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
public long? StartPositionTicks { get; set; }
/// <summary>
/// Gets or sets the play command.
/// </summary>
/// <value>The play command.</value>
[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")]
public PlayCommand PlayCommand { get; set; }
}
2014-03-23 19:36:25 +00:00
[Route("/Sessions/{Id}/Playing/{Command}", "POST", Summary = "Issues a playstate command to a client")]
public class SendPlaystateCommand : IReturnVoid
{
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
[ApiMember(Name = "Id", Description = "Session Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
public Guid Id { get; set; }
/// <summary>
/// Gets or sets the position to seek to
/// </summary>
[ApiMember(Name = "SeekPositionTicks", Description = "The position to seek to.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
public long? SeekPositionTicks { get; set; }
/// <summary>
/// Gets or sets the play command.
/// </summary>
/// <value>The play command.</value>
[ApiMember(Name = "Command", Description = "The command to send - stop, pause, unpause, nexttrack, previoustrack, seek, fullscreen.", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
public PlaystateCommand Command { get; set; }
}
2014-03-23 19:36:25 +00:00
[Route("/Sessions/{Id}/System/{Command}", "POST", Summary = "Issues a system command to a client")]
2013-08-28 04:16:21 +00:00
public class SendSystemCommand : IReturnVoid
{
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
[ApiMember(Name = "Id", Description = "Session Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
public Guid Id { get; set; }
/// <summary>
/// Gets or sets the command.
/// </summary>
/// <value>The play command.</value>
[ApiMember(Name = "Command", Description = "The command to send.", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
public SystemCommand Command { get; set; }
}
2014-03-23 19:36:25 +00:00
[Route("/Sessions/{Id}/Message", "POST", Summary = "Issues a command to a client to display a message to the user")]
2013-08-28 04:16:21 +00:00
public class SendMessageCommand : IReturnVoid
{
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
[ApiMember(Name = "Id", Description = "Session Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
public Guid Id { get; set; }
[ApiMember(Name = "Text", Description = "The message text.", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
public string Text { get; set; }
[ApiMember(Name = "Header", Description = "The message header.", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
public string Header { get; set; }
[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")]
2013-08-28 04:16:21 +00:00
public long? TimeoutMs { get; set; }
}
2014-03-23 19:36:25 +00:00
[Route("/Sessions/{Id}/Users/{UserId}", "POST", Summary = "Adds an additional user to a session")]
public class AddUserToSession : IReturnVoid
{
[ApiMember(Name = "Id", Description = "Session Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
public Guid Id { get; set; }
[ApiMember(Name = "UserId", Description = "UserId Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
public Guid UserId { get; set; }
}
2014-03-23 19:36:25 +00:00
[Route("/Sessions/{Id}/Users/{UserId}", "DELETE", Summary = "Removes an additional user from a session")]
public class RemoveUserFromSession : IReturnVoid
{
[ApiMember(Name = "Id", Description = "Session Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
public Guid Id { get; set; }
[ApiMember(Name = "UserId", Description = "UserId Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
public Guid UserId { get; set; }
}
2014-03-23 19:36:25 +00:00
[Route("/Sessions/{Id}/Capabilities", "POST", Summary = "Updates capabilities for a device")]
public class PostCapabilities : IReturnVoid
{
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
[ApiMember(Name = "Id", Description = "Session Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
public Guid Id { get; set; }
2014-01-05 06:08:22 +00:00
[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")]
public string PlayableMediaTypes { get; set; }
2014-03-21 03:31:40 +00:00
[ApiMember(Name = "SupportsFullscreenToggle", Description = "Whether or not the session supports fullscreen toggle", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "POST")]
public bool SupportsFullscreenToggle { get; set; }
}
2014-03-13 09:18:32 +00:00
/// <summary>
/// Class SessionsService
/// </summary>
public class SessionsService : BaseApiService
{
/// <summary>
/// The _session manager
/// </summary>
private readonly ISessionManager _sessionManager;
2013-09-04 17:02:19 +00:00
private readonly IDtoService _dtoService;
private readonly IUserManager _userManager;
2013-09-04 17:02:19 +00:00
/// <summary>
2013-05-11 16:45:20 +00:00
/// Initializes a new instance of the <see cref="SessionsService" /> class.
/// </summary>
/// <param name="sessionManager">The session manager.</param>
/// <param name="dtoService">The dto service.</param>
public SessionsService(ISessionManager sessionManager, IDtoService dtoService, IUserManager userManager)
{
_sessionManager = sessionManager;
2013-09-04 17:02:19 +00:00
_dtoService = dtoService;
_userManager = userManager;
}
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
public object Get(GetSessions request)
{
2013-05-10 12:18:07 +00:00
var result = _sessionManager.Sessions.Where(i => i.IsActive);
if (request.SupportsRemoteControl.HasValue)
{
result = result.Where(i => i.SupportsRemoteControl == request.SupportsRemoteControl.Value);
2013-05-10 12:18:07 +00:00
}
2014-01-06 16:48:43 +00:00
if (!string.IsNullOrEmpty(request.DeviceId))
{
result = result.Where(i => string.Equals(i.DeviceId, request.DeviceId, StringComparison.OrdinalIgnoreCase));
}
if (request.ControllableByUserId.HasValue)
{
var user = _userManager.GetUserById(request.ControllableByUserId.Value);
if (!user.Configuration.EnableRemoteControlOfOtherUsers)
{
2014-01-04 02:59:20 +00:00
result = result.Where(i => !i.UserId.HasValue || i.ContainsUser(request.ControllableByUserId.Value));
}
}
2013-09-04 17:02:19 +00:00
return ToOptimizedResult(result.Select(_dtoService.GetSessionInfoDto).ToList());
}
2013-05-10 12:18:07 +00:00
public void Post(SendPlaystateCommand request)
2014-03-13 09:18:32 +00:00
{
var command = new PlaystateRequest
{
Command = request.Command,
SeekPositionTicks = request.SeekPositionTicks
};
2014-03-16 16:15:10 +00:00
var task = _sessionManager.SendPlaystateCommand(GetSession().Id, request.Id, command, CancellationToken.None);
Task.WaitAll(task);
}
2013-05-11 16:45:20 +00:00
/// <summary>
/// Posts the specified request.
/// </summary>
/// <param name="request">The request.</param>
2013-05-28 17:25:10 +00:00
public void Post(BrowseTo request)
{
var command = new BrowseRequest
{
Context = request.Context,
ItemId = request.ItemId,
ItemName = request.ItemName,
ItemType = request.ItemType
};
2014-03-16 16:15:10 +00:00
var task = _sessionManager.SendBrowseCommand(GetSession().Id, request.Id, command, CancellationToken.None);
2013-05-26 00:53:51 +00:00
Task.WaitAll(task);
2013-05-10 12:18:07 +00:00
}
2013-05-28 17:25:10 +00:00
2013-08-28 04:16:21 +00:00
/// <summary>
/// Posts the specified request.
/// </summary>
/// <param name="request">The request.</param>
public void Post(SendSystemCommand request)
{
2014-03-16 16:15:10 +00:00
var task = _sessionManager.SendSystemCommand(GetSession().Id, request.Id, request.Command, CancellationToken.None);
2013-08-28 04:16:21 +00:00
Task.WaitAll(task);
}
/// <summary>
/// Posts the specified request.
/// </summary>
/// <param name="request">The request.</param>
public void Post(SendMessageCommand request)
{
var command = new MessageCommand
2013-08-28 04:16:21 +00:00
{
Header = string.IsNullOrEmpty(request.Header) ? "Message from Server" : request.Header,
TimeoutMs = request.TimeoutMs,
Text = request.Text
};
2013-08-28 04:16:21 +00:00
2014-03-16 16:15:10 +00:00
var task = _sessionManager.SendMessageCommand(GetSession().Id, request.Id, command, CancellationToken.None);
2013-08-28 04:16:21 +00:00
Task.WaitAll(task);
2013-08-28 04:16:21 +00:00
}
2013-05-28 17:25:10 +00:00
/// <summary>
/// Posts the specified request.
/// </summary>
/// <param name="request">The request.</param>
public void Post(Play request)
{
var command = new PlayRequest
2013-05-28 17:25:10 +00:00
{
ItemIds = request.ItemIds.Split(',').ToArray(),
2014-03-13 09:18:32 +00:00
PlayCommand = request.PlayCommand,
StartPositionTicks = request.StartPositionTicks
};
2013-05-28 17:25:10 +00:00
2014-03-16 16:15:10 +00:00
var task = _sessionManager.SendPlayCommand(GetSession().Id, request.Id, command, CancellationToken.None);
2013-05-28 17:25:10 +00:00
Task.WaitAll(task);
2013-05-28 17:25:10 +00:00
}
public void Post(AddUserToSession request)
{
_sessionManager.AddAdditionalUser(request.Id, request.UserId);
}
public void Delete(RemoveUserFromSession request)
{
_sessionManager.RemoveAdditionalUser(request.Id, request.UserId);
}
public void Post(PostCapabilities request)
{
2014-03-21 03:31:40 +00:00
_sessionManager.ReportCapabilities(request.Id, new SessionCapabilities
{
PlayableMediaTypes = request.PlayableMediaTypes.Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries),
2014-03-21 03:31:40 +00:00
SupportsFullscreenToggle = request.SupportsFullscreenToggle
});
}
2014-03-16 16:15:10 +00:00
private SessionInfo GetSession()
{
var auth = AuthorizationRequestFilterAttribute.GetAuthorization(Request);
return _sessionManager.Sessions.First(i => string.Equals(i.DeviceId, auth.DeviceId) &&
string.Equals(i.Client, auth.Client) &&
string.Equals(i.ApplicationVersion, auth.Version));
}
}
2014-03-13 09:18:32 +00:00
}