@ -92,12 +92,232 @@ public class PlaylistsController : BaseJellyfinApiController
Name = name ? ? createPlaylistRequest ? . Name ,
ItemIdList = ids ,
UserId = userId . Value ,
MediaType = mediaType ? ? createPlaylistRequest ? . MediaType
MediaType = mediaType ? ? createPlaylistRequest ? . MediaType ,
Users = createPlaylistRequest ? . Users . ToArray ( ) ? ? [ ] ,
Public = createPlaylistRequest ? . IsPublic
} ) . ConfigureAwait ( false ) ;
return result ;
}
/// <summary>
/// Updates a playlist.
/// </summary>
/// <param name="playlistId">The playlist id.</param>
/// <param name="updatePlaylistRequest">The <see cref="UpdatePlaylistDto"/> id.</param>
/// <response code="204">Playlist updated.</response>
/// <response code="403">Access forbidden.</response>
/// <response code="404">Playlist not found.</response>
/// <returns>
/// A <see cref="Task" /> that represents the asynchronous operation to update a playlist.
/// The task result contains an <see cref="OkResult"/> indicating success.
/// </returns>
[HttpPost("{playlistId}")]
[ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(StatusCodes.Status403Forbidden)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public async Task < ActionResult > UpdatePlaylist (
[FromRoute, Required] Guid playlistId ,
[FromBody, Required] UpdatePlaylistDto updatePlaylistRequest )
{
var callingUserId = User . GetUserId ( ) ;
var playlist = _playlistManager . GetPlaylistForUser ( playlistId , callingUserId ) ;
if ( playlist is null )
{
return NotFound ( "Playlist not found" ) ;
}
var isPermitted = playlist . OwnerUserId . Equals ( callingUserId )
| | playlist . Shares . Any ( s = > s . CanEdit & & s . UserId . Equals ( callingUserId ) ) ;
if ( ! isPermitted )
{
return Forbid ( ) ;
}
await _playlistManager . UpdatePlaylist ( new PlaylistUpdateRequest
{
UserId = callingUserId ,
Id = playlistId ,
Name = updatePlaylistRequest . Name ,
Ids = updatePlaylistRequest . Ids ,
Users = updatePlaylistRequest . Users ,
Public = updatePlaylistRequest . IsPublic
} ) . ConfigureAwait ( false ) ;
return NoContent ( ) ;
}
/// <summary>
/// Get a playlist's users.
/// </summary>
/// <param name="playlistId">The playlist id.</param>
/// <response code="200">Found shares.</response>
/// <response code="403">Access forbidden.</response>
/// <response code="404">Playlist not found.</response>
/// <returns>
/// A list of <see cref="PlaylistUserPermissions"/> objects.
/// </returns>
[HttpGet("{playlistId}/Users")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status403Forbidden)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public ActionResult < IReadOnlyList < PlaylistUserPermissions > > GetPlaylistUsers (
[FromRoute, Required] Guid playlistId )
{
var userId = User . GetUserId ( ) ;
var playlist = _playlistManager . GetPlaylistForUser ( playlistId , userId ) ;
if ( playlist is null )
{
return NotFound ( "Playlist not found" ) ;
}
var isPermitted = playlist . OwnerUserId . Equals ( userId ) ;
return isPermitted ? playlist . Shares . ToList ( ) : Forbid ( ) ;
}
/// <summary>
/// Get a playlist user.
/// </summary>
/// <param name="playlistId">The playlist id.</param>
/// <param name="userId">The user id.</param>
/// <response code="200">User permission found.</response>
/// <response code="403">Access forbidden.</response>
/// <response code="404">Playlist not found.</response>
/// <returns>
/// <see cref="PlaylistUserPermissions"/>.
/// </returns>
[HttpGet("{playlistId}/Users/{userId}")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status403Forbidden)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public ActionResult < PlaylistUserPermissions ? > GetPlaylistUser (
[FromRoute, Required] Guid playlistId ,
[FromRoute, Required] Guid userId )
{
var callingUserId = User . GetUserId ( ) ;
var playlist = _playlistManager . GetPlaylistForUser ( playlistId , callingUserId ) ;
if ( playlist is null )
{
return NotFound ( "Playlist not found" ) ;
}
var userPermission = playlist . Shares . FirstOrDefault ( s = > s . UserId . Equals ( userId ) ) ;
var isPermitted = playlist . OwnerUserId . Equals ( callingUserId )
| | playlist . Shares . Any ( s = > s . CanEdit & & s . UserId . Equals ( callingUserId ) )
| | userId . Equals ( callingUserId ) ;
if ( ! isPermitted )
{
return Forbid ( ) ;
}
if ( userPermission is not null )
{
return userPermission ;
}
return NotFound ( "User permissions not found" ) ;
}
/// <summary>
/// Modify a user of a playlist's users.
/// </summary>
/// <param name="playlistId">The playlist id.</param>
/// <param name="userId">The user id.</param>
/// <param name="updatePlaylistUserRequest">The <see cref="UpdatePlaylistUserDto"/>.</param>
/// <response code="204">User's permissions modified.</response>
/// <response code="403">Access forbidden.</response>
/// <response code="404">Playlist not found.</response>
/// <returns>
/// A <see cref="Task" /> that represents the asynchronous operation to modify an user's playlist permissions.
/// The task result contains an <see cref="OkResult"/> indicating success.
/// </returns>
[HttpPost("{playlistId}/Users/{userId}")]
[ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(StatusCodes.Status403Forbidden)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public async Task < ActionResult > UpdatePlaylistUser (
[FromRoute, Required] Guid playlistId ,
[FromRoute, Required] Guid userId ,
[FromBody(EmptyBodyBehavior = EmptyBodyBehavior.Allow), Required] UpdatePlaylistUserDto updatePlaylistUserRequest )
{
var callingUserId = User . GetUserId ( ) ;
var playlist = _playlistManager . GetPlaylistForUser ( playlistId , callingUserId ) ;
if ( playlist is null )
{
return NotFound ( "Playlist not found" ) ;
}
var isPermitted = playlist . OwnerUserId . Equals ( callingUserId ) ;
if ( ! isPermitted )
{
return Forbid ( ) ;
}
await _playlistManager . AddUserToShares ( new PlaylistUserUpdateRequest
{
Id = playlistId ,
UserId = userId ,
CanEdit = updatePlaylistUserRequest . CanEdit
} ) . ConfigureAwait ( false ) ;
return NoContent ( ) ;
}
/// <summary>
/// Remove a user from a playlist's users.
/// </summary>
/// <param name="playlistId">The playlist id.</param>
/// <param name="userId">The user id.</param>
/// <response code="204">User permissions removed from playlist.</response>
/// <response code="401">Unauthorized access.</response>
/// <response code="404">No playlist or user permissions found.</response>
/// <returns>
/// A <see cref="Task" /> that represents the asynchronous operation to delete a user from a playlist's shares.
/// The task result contains an <see cref="OkResult"/> indicating success.
/// </returns>
[HttpDelete("{playlistId}/Users/{userId}")]
[ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(StatusCodes.Status403Forbidden)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public async Task < ActionResult > RemoveUserFromPlaylist (
[FromRoute, Required] Guid playlistId ,
[FromRoute, Required] Guid userId )
{
var callingUserId = User . GetUserId ( ) ;
var playlist = _playlistManager . GetPlaylistForUser ( playlistId , callingUserId ) ;
if ( playlist is null )
{
return NotFound ( "Playlist not found" ) ;
}
var isPermitted = playlist . OwnerUserId . Equals ( callingUserId )
| | playlist . Shares . Any ( s = > s . CanEdit & & s . UserId . Equals ( callingUserId ) ) ;
if ( ! isPermitted )
{
return Forbid ( ) ;
}
var share = playlist . Shares . FirstOrDefault ( s = > s . UserId . Equals ( userId ) ) ;
if ( share is null )
{
return NotFound ( "User permissions not found" ) ;
}
await _playlistManager . RemoveUserFromShares ( playlistId , callingUserId , share ) . ConfigureAwait ( false ) ;
return NoContent ( ) ;
}
/// <summary>
/// Adds items to a playlist.
/// </summary>
@ -105,16 +325,34 @@ public class PlaylistsController : BaseJellyfinApiController
/// <param name="ids">Item id, comma delimited.</param>
/// <param name="userId">The userId.</param>
/// <response code="204">Items added to playlist.</response>
/// <response code="403">Access forbidden.</response>
/// <response code="404">Playlist not found.</response>
/// <returns>An <see cref="NoContentResult"/> on success.</returns>
[HttpPost("{playlistId}/Items")]
[ProducesResponseType(StatusCodes.Status204NoContent)]
public async Task < ActionResult > AddToPlaylist (
[ProducesResponseType(StatusCodes.Status403Forbidden)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public async Task < ActionResult > AddItemToPlaylist (
[FromRoute, Required] Guid playlistId ,
[FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] Guid [ ] ids ,
[FromQuery] Guid ? userId )
{
userId = RequestHelpers . GetUserId ( User , userId ) ;
await _playlistManager . AddToPlaylistAsync ( playlistId , ids , userId . Value ) . ConfigureAwait ( false ) ;
var playlist = _playlistManager . GetPlaylistForUser ( playlistId , userId . Value ) ;
if ( playlist is null )
{
return NotFound ( "Playlist not found" ) ;
}
var isPermitted = playlist . OwnerUserId . Equals ( userId . Value )
| | playlist . Shares . Any ( s = > s . CanEdit & & s . UserId . Equals ( userId . Value ) ) ;
if ( ! isPermitted )
{
return Forbid ( ) ;
}
await _playlistManager . AddItemToPlaylistAsync ( playlistId , ids , userId . Value ) . ConfigureAwait ( false ) ;
return NoContent ( ) ;
}
@ -125,14 +363,34 @@ public class PlaylistsController : BaseJellyfinApiController
/// <param name="itemId">The item id.</param>
/// <param name="newIndex">The new index.</param>
/// <response code="204">Item moved to new index.</response>
/// <response code="403">Access forbidden.</response>
/// <response code="404">Playlist not found.</response>
/// <returns>An <see cref="NoContentResult"/> on success.</returns>
[HttpPost("{playlistId}/Items/{itemId}/Move/{newIndex}")]
[ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(StatusCodes.Status403Forbidden)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public async Task < ActionResult > MoveItem (
[FromRoute, Required] string playlistId ,
[FromRoute, Required] string itemId ,
[FromRoute, Required] int newIndex )
{
var callingUserId = User . GetUserId ( ) ;
var playlist = _playlistManager . GetPlaylistForUser ( Guid . Parse ( playlistId ) , callingUserId ) ;
if ( playlist is null )
{
return NotFound ( "Playlist not found" ) ;
}
var isPermitted = playlist . OwnerUserId . Equals ( callingUserId )
| | playlist . Shares . Any ( s = > s . CanEdit & & s . UserId . Equals ( callingUserId ) ) ;
if ( ! isPermitted )
{
return Forbid ( ) ;
}
await _playlistManager . MoveItemAsync ( playlistId , itemId , newIndex ) . ConfigureAwait ( false ) ;
return NoContent ( ) ;
}
@ -143,14 +401,34 @@ public class PlaylistsController : BaseJellyfinApiController
/// <param name="playlistId">The playlist id.</param>
/// <param name="entryIds">The item ids, comma delimited.</param>
/// <response code="204">Items removed.</response>
/// <response code="403">Access forbidden.</response>
/// <response code="404">Playlist not found.</response>
/// <returns>An <see cref="NoContentResult"/> on success.</returns>
[HttpDelete("{playlistId}/Items")]
[ProducesResponseType(StatusCodes.Status204NoContent)]
public async Task < ActionResult > RemoveFromPlaylist (
[ProducesResponseType(StatusCodes.Status403Forbidden)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public async Task < ActionResult > RemoveItemFromPlaylist (
[FromRoute, Required] string playlistId ,
[FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] string [ ] entryIds )
{
await _playlistManager . RemoveFromPlaylistAsync ( playlistId , entryIds ) . ConfigureAwait ( false ) ;
var callingUserId = User . GetUserId ( ) ;
var playlist = _playlistManager . GetPlaylistForUser ( Guid . Parse ( playlistId ) , callingUserId ) ;
if ( playlist is null )
{
return NotFound ( "Playlist not found" ) ;
}
var isPermitted = playlist . OwnerUserId . Equals ( callingUserId )
| | playlist . Shares . Any ( s = > s . CanEdit & & s . UserId . Equals ( callingUserId ) ) ;
if ( ! isPermitted )
{
return Forbid ( ) ;
}
await _playlistManager . RemoveItemFromPlaylistAsync ( playlistId , entryIds ) . ConfigureAwait ( false ) ;
return NoContent ( ) ;
}
@ -167,10 +445,12 @@ public class PlaylistsController : BaseJellyfinApiController
/// <param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
/// <param name="enableImageTypes">Optional. The image types to include in the output.</param>
/// <response code="200">Original playlist returned.</response>
/// <response code="404">Access forbidden.</response>
/// <response code="404">Playlist not found.</response>
/// <returns>The original playlist items.</returns>
[HttpGet("{playlistId}/Items")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status403Forbidden)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public ActionResult < QueryResult < BaseItemDto > > GetPlaylistItems (
[FromRoute, Required] Guid playlistId ,
@ -184,6 +464,21 @@ public class PlaylistsController : BaseJellyfinApiController
[FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ImageType [ ] enableImageTypes )
{
userId = RequestHelpers . GetUserId ( User , userId ) ;
var playlist = _playlistManager . GetPlaylistForUser ( playlistId , userId . Value ) ;
if ( playlist is null )
{
return NotFound ( "Playlist not found" ) ;
}
var isPermitted = playlist . OpenAccess
| | playlist . OwnerUserId . Equals ( userId . Value )
| | playlist . Shares . Any ( s = > s . UserId . Equals ( userId . Value ) ) ;
if ( ! isPermitted )
{
return Forbid ( ) ;
}
var user = userId . IsNullOrEmpty ( )
? null
: _userManager . GetUserById ( userId . Value ) ;
Cody Robibero
2 months ago