2019-01-13 15:01:16 -05:00
using System ;
2019-01-13 14:24:58 -05:00
using System.Linq ;
using System.Threading.Tasks ;
2017-08-24 15:52:19 -04:00
using MediaBrowser.Controller.Dto ;
2014-08-02 22:16:37 -04:00
using MediaBrowser.Controller.Library ;
2014-08-01 22:34:45 -04:00
using MediaBrowser.Controller.Net ;
using MediaBrowser.Controller.Playlists ;
2014-08-02 22:16:37 -04:00
using MediaBrowser.Model.Dto ;
2014-08-01 22:34:45 -04:00
using MediaBrowser.Model.Playlists ;
using MediaBrowser.Model.Querying ;
2016-10-25 15:02:04 -04:00
using MediaBrowser.Model.Services ;
2014-08-01 22:34:45 -04:00
namespace MediaBrowser.Api
{
[Route("/Playlists", "POST", Summary = "Creates a new playlist")]
public class CreatePlaylist : IReturn < PlaylistCreationResult >
{
[ApiMember(Name = "Name", Description = "The name of the new playlist.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
public string Name { get ; set ; }
[ApiMember(Name = "Ids", Description = "Item Ids to add to the playlist", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST", AllowMultiple = true)]
public string Ids { get ; set ; }
2014-08-02 22:16:37 -04:00
2018-09-12 13:26:21 -04:00
[ApiMember(Name = "UserId", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
public Guid UserId { get ; set ; }
2014-08-21 11:55:35 -04:00
2018-09-12 13:26:21 -04:00
[ApiMember(Name = "MediaType", Description = "The playlist media type", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
2014-08-21 11:55:35 -04:00
public string MediaType { get ; set ; }
2014-08-01 22:34:45 -04:00
}
[Route("/Playlists/{Id}/Items", "POST", Summary = "Adds items to a playlist")]
public class AddToPlaylist : IReturnVoid
{
[ApiMember(Name = "Ids", Description = "Item id, comma delimited", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
public string Ids { get ; set ; }
[ApiMember(Name = "Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
public string Id { get ; set ; }
2014-08-21 22:24:38 -04:00
/// <summary>
/// Gets or sets the user id.
/// </summary>
/// <value>The user id.</value>
2015-10-15 01:48:03 -04:00
[ApiMember(Name = "UserId", Description = "User Id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
2018-09-12 13:26:21 -04:00
public Guid UserId { get ; set ; }
2014-08-01 22:34:45 -04:00
}
2015-10-15 01:48:03 -04:00
[Route("/Playlists/{Id}/Items/{ItemId}/Move/{NewIndex}", "POST", Summary = "Moves a playlist item")]
public class MoveItem : IReturnVoid
{
[ApiMember(Name = "ItemId", Description = "ItemId", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
public string ItemId { get ; set ; }
[ApiMember(Name = "Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
public string Id { get ; set ; }
/// <summary>
/// Gets or sets the user id.
/// </summary>
/// <value>The user id.</value>
[ApiMember(Name = "NewIndex", Description = "NewIndex", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
public int NewIndex { get ; set ; }
}
2014-08-01 22:34:45 -04:00
[Route("/Playlists/{Id}/Items", "DELETE", Summary = "Removes items from a playlist")]
public class RemoveFromPlaylist : IReturnVoid
{
[ApiMember(Name = "Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
public string Id { get ; set ; }
2014-08-06 00:18:13 -04:00
[ApiMember(Name = "EntryIds", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "DELETE")]
public string EntryIds { get ; set ; }
2014-08-01 22:34:45 -04:00
}
2014-08-02 22:16:37 -04:00
[Route("/Playlists/{Id}/Items", "GET", Summary = "Gets the original items of a playlist")]
2016-08-17 15:28:43 -04:00
public class GetPlaylistItems : IReturn < QueryResult < BaseItemDto > > , IHasDtoOptions
2014-08-02 22:16:37 -04:00
{
[ApiMember(Name = "Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
2018-09-12 13:26:21 -04:00
public Guid Id { get ; set ; }
2014-08-02 22:16:37 -04:00
/// <summary>
/// Gets or sets the user id.
/// </summary>
/// <value>The user id.</value>
2014-08-21 22:24:38 -04:00
[ApiMember(Name = "UserId", Description = "User Id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
2018-09-12 13:26:21 -04:00
public Guid UserId { get ; set ; }
2014-08-02 22:16:37 -04:00
/// <summary>
/// Skips over a given number of items within the results. Use for paging.
/// </summary>
/// <value>The start index.</value>
[ApiMember(Name = "StartIndex", Description = "Optional. The record index to start at. All items with a lower index will be dropped from the results.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? StartIndex { get ; set ; }
/// <summary>
/// The maximum number of items to return
/// </summary>
/// <value>The limit.</value>
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? Limit { get ; set ; }
/// <summary>
/// Fields to return within the items, in addition to basic information
/// </summary>
/// <value>The fields.</value>
2017-04-29 02:22:33 -04:00
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
2014-08-02 22:16:37 -04:00
public string Fields { get ; set ; }
2016-08-17 15:28:43 -04:00
[ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
public bool? EnableImages { get ; set ; }
[ApiMember(Name = "EnableUserData", Description = "Optional, include user data", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
public bool? EnableUserData { get ; set ; }
[ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? ImageTypeLimit { get ; set ; }
[ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string EnableImageTypes { get ; set ; }
2014-08-02 22:16:37 -04:00
}
2014-08-01 22:34:45 -04:00
[Authenticated]
public class PlaylistService : BaseApiService
{
private readonly IPlaylistManager _playlistManager ;
private readonly IDtoService _dtoService ;
2014-08-02 22:16:37 -04:00
private readonly IUserManager _userManager ;
private readonly ILibraryManager _libraryManager ;
2016-11-10 09:41:24 -05:00
private readonly IAuthorizationContext _authContext ;
2014-08-01 22:34:45 -04:00
2016-11-10 09:41:24 -05:00
public PlaylistService ( IDtoService dtoService , IPlaylistManager playlistManager , IUserManager userManager , ILibraryManager libraryManager , IAuthorizationContext authContext )
2014-08-01 22:34:45 -04:00
{
_dtoService = dtoService ;
_playlistManager = playlistManager ;
2014-08-02 22:16:37 -04:00
_userManager = userManager ;
_libraryManager = libraryManager ;
2016-11-10 09:41:24 -05:00
_authContext = authContext ;
2014-08-01 22:34:45 -04:00
}
2015-10-15 01:48:03 -04:00
public void Post ( MoveItem request )
{
2018-09-12 13:26:21 -04:00
_playlistManager . MoveItem ( request . Id , request . ItemId , request . NewIndex ) ;
2015-10-15 01:48:03 -04:00
}
2014-08-17 01:38:13 -04:00
public async Task < object > Post ( CreatePlaylist request )
2014-08-01 22:34:45 -04:00
{
2014-08-21 11:55:35 -04:00
var result = await _playlistManager . CreatePlaylist ( new PlaylistCreationRequest
2014-08-01 22:34:45 -04:00
{
Name = request . Name ,
2018-09-12 13:26:21 -04:00
ItemIdList = GetGuids ( request . Ids ) ,
2014-08-21 11:55:35 -04:00
UserId = request . UserId ,
MediaType = request . MediaType
2014-08-01 22:34:45 -04:00
2014-08-17 01:38:13 -04:00
} ) . ConfigureAwait ( false ) ;
2014-08-01 22:34:45 -04:00
2014-08-21 11:55:35 -04:00
return ToOptimizedResult ( result ) ;
2014-08-01 22:34:45 -04:00
}
public void Post ( AddToPlaylist request )
{
2018-09-12 13:26:21 -04:00
_playlistManager . AddToPlaylist ( request . Id , GetGuids ( request . Ids ) , request . UserId ) ;
2014-08-01 22:34:45 -04:00
}
public void Delete ( RemoveFromPlaylist request )
{
2018-09-12 13:26:21 -04:00
_playlistManager . RemoveFromPlaylist ( request . Id , request . EntryIds . Split ( ',' ) ) ;
2014-08-01 22:34:45 -04:00
}
2014-08-02 22:16:37 -04:00
2017-08-27 20:33:05 -04:00
public object Get ( GetPlaylistItems request )
2014-08-02 22:16:37 -04:00
{
var playlist = ( Playlist ) _libraryManager . GetItemById ( request . Id ) ;
2018-09-12 13:26:21 -04:00
var user = ! request . UserId . Equals ( Guid . Empty ) ? _userManager . GetUserById ( request . UserId ) : null ;
2014-08-11 19:41:11 -04:00
2014-08-02 22:16:37 -04:00
var items = playlist . GetManageableItems ( ) . ToArray ( ) ;
var count = items . Length ;
if ( request . StartIndex . HasValue )
{
items = items . Skip ( request . StartIndex . Value ) . ToArray ( ) ;
}
if ( request . Limit . HasValue )
{
items = items . Take ( request . Limit . Value ) . ToArray ( ) ;
}
2015-01-24 14:03:55 -05:00
2016-11-10 09:41:24 -05:00
var dtoOptions = GetDtoOptions ( _authContext , request ) ;
2015-01-24 14:03:55 -05:00
2017-08-27 20:33:05 -04:00
var dtos = _dtoService . GetBaseItemDtos ( items . Select ( i = > i . Item2 ) . ToList ( ) , dtoOptions , user ) ;
2014-08-02 22:16:37 -04:00
2019-09-02 02:19:29 -04:00
for ( int index = 0 ; index < dtos . Count ; index + + )
2014-08-11 19:41:11 -04:00
{
2019-09-02 02:19:29 -04:00
dtos [ index ] . PlaylistItemId = items [ index ] . Item1 . Id ;
2014-08-11 19:41:11 -04:00
}
2017-08-19 15:43:35 -04:00
var result = new QueryResult < BaseItemDto >
2014-08-02 22:16:37 -04:00
{
Items = dtos ,
TotalRecordCount = count
} ;
return ToOptimizedResult ( result ) ;
}
2014-08-01 22:34:45 -04:00
}
}