| | | 1 | | using System; |
| | | 2 | | using System.Collections.Generic; |
| | | 3 | | using System.ComponentModel.DataAnnotations; |
| | | 4 | | using System.Globalization; |
| | | 5 | | using System.Linq; |
| | | 6 | | using System.Threading.Tasks; |
| | | 7 | | using Jellyfin.Api.Attributes; |
| | | 8 | | using Jellyfin.Api.Extensions; |
| | | 9 | | using Jellyfin.Api.Helpers; |
| | | 10 | | using Jellyfin.Api.ModelBinders; |
| | | 11 | | using Jellyfin.Api.Models.PlaylistDtos; |
| | | 12 | | using Jellyfin.Data.Enums; |
| | | 13 | | using Jellyfin.Extensions; |
| | | 14 | | using MediaBrowser.Controller.Dto; |
| | | 15 | | using MediaBrowser.Controller.Library; |
| | | 16 | | using MediaBrowser.Controller.Playlists; |
| | | 17 | | using MediaBrowser.Model.Dto; |
| | | 18 | | using MediaBrowser.Model.Entities; |
| | | 19 | | using MediaBrowser.Model.Playlists; |
| | | 20 | | using MediaBrowser.Model.Querying; |
| | | 21 | | using Microsoft.AspNetCore.Authorization; |
| | | 22 | | using Microsoft.AspNetCore.Http; |
| | | 23 | | using Microsoft.AspNetCore.Mvc; |
| | | 24 | | using Microsoft.AspNetCore.Mvc.ModelBinding; |
| | | 25 | | |
| | | 26 | | namespace Jellyfin.Api.Controllers; |
| | | 27 | | |
| | | 28 | | /// <summary> |
| | | 29 | | /// Playlists controller. |
| | | 30 | | /// </summary> |
| | | 31 | | [Authorize] |
| | | 32 | | [Tags("Playlist")] |
| | | 33 | | public class PlaylistsController : BaseJellyfinApiController |
| | | 34 | | { |
| | | 35 | | private readonly IPlaylistManager _playlistManager; |
| | | 36 | | private readonly IDtoService _dtoService; |
| | | 37 | | private readonly IUserManager _userManager; |
| | | 38 | | private readonly ILibraryManager _libraryManager; |
| | | 39 | | |
| | | 40 | | /// <summary> |
| | | 41 | | /// Initializes a new instance of the <see cref="PlaylistsController"/> class. |
| | | 42 | | /// </summary> |
| | | 43 | | /// <param name="dtoService">Instance of the <see cref="IDtoService"/> interface.</param> |
| | | 44 | | /// <param name="playlistManager">Instance of the <see cref="IPlaylistManager"/> interface.</param> |
| | | 45 | | /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param> |
| | | 46 | | /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param> |
| | 0 | 47 | | public PlaylistsController( |
| | 0 | 48 | | IDtoService dtoService, |
| | 0 | 49 | | IPlaylistManager playlistManager, |
| | 0 | 50 | | IUserManager userManager, |
| | 0 | 51 | | ILibraryManager libraryManager) |
| | | 52 | | { |
| | 0 | 53 | | _dtoService = dtoService; |
| | 0 | 54 | | _playlistManager = playlistManager; |
| | 0 | 55 | | _userManager = userManager; |
| | 0 | 56 | | _libraryManager = libraryManager; |
| | 0 | 57 | | } |
| | | 58 | | |
| | | 59 | | /// <summary> |
| | | 60 | | /// Creates a new playlist. |
| | | 61 | | /// </summary> |
| | | 62 | | /// <remarks> |
| | | 63 | | /// For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. |
| | | 64 | | /// Query parameters are obsolete. |
| | | 65 | | /// </remarks> |
| | | 66 | | /// <param name="name">The playlist name.</param> |
| | | 67 | | /// <param name="ids">The item ids.</param> |
| | | 68 | | /// <param name="userId">The user id.</param> |
| | | 69 | | /// <param name="mediaType">The media type.</param> |
| | | 70 | | /// <param name="createPlaylistRequest">The create playlist payload.</param> |
| | | 71 | | /// <response code="200">Playlist created.</response> |
| | | 72 | | /// <returns> |
| | | 73 | | /// A <see cref="Task" /> that represents the asynchronous operation to create a playlist. |
| | | 74 | | /// The task result contains an <see cref="OkResult"/> indicating success. |
| | | 75 | | /// </returns> |
| | | 76 | | [HttpPost] |
| | | 77 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 78 | | public async Task<ActionResult<PlaylistCreationResult>> CreatePlaylist( |
| | | 79 | | [FromQuery, ParameterObsolete] string? name, |
| | | 80 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder)), ParameterObsolete] IReadOnlyList<Guid> ids |
| | | 81 | | [FromQuery, ParameterObsolete] Guid? userId, |
| | | 82 | | [FromQuery, ParameterObsolete] MediaType? mediaType, |
| | | 83 | | [FromBody(EmptyBodyBehavior = EmptyBodyBehavior.Allow)] CreatePlaylistDto? createPlaylistRequest) |
| | | 84 | | { |
| | 0 | 85 | | if (ids.Count == 0) |
| | | 86 | | { |
| | 0 | 87 | | ids = createPlaylistRequest?.Ids ?? Array.Empty<Guid>(); |
| | | 88 | | } |
| | | 89 | | |
| | 0 | 90 | | userId ??= createPlaylistRequest?.UserId ?? default; |
| | 0 | 91 | | userId = RequestHelpers.GetUserId(User, userId); |
| | 0 | 92 | | var result = await _playlistManager.CreatePlaylist(new PlaylistCreationRequest |
| | 0 | 93 | | { |
| | 0 | 94 | | Name = name ?? createPlaylistRequest?.Name, |
| | 0 | 95 | | ItemIdList = ids, |
| | 0 | 96 | | UserId = userId.Value, |
| | 0 | 97 | | MediaType = mediaType ?? createPlaylistRequest?.MediaType, |
| | 0 | 98 | | Users = createPlaylistRequest?.Users.ToArray() ?? [], |
| | 0 | 99 | | Public = createPlaylistRequest?.IsPublic |
| | 0 | 100 | | }).ConfigureAwait(false); |
| | | 101 | | |
| | 0 | 102 | | return result; |
| | 0 | 103 | | } |
| | | 104 | | |
| | | 105 | | /// <summary> |
| | | 106 | | /// Updates a playlist. |
| | | 107 | | /// </summary> |
| | | 108 | | /// <param name="playlistId">The playlist id.</param> |
| | | 109 | | /// <param name="updatePlaylistRequest">The <see cref="UpdatePlaylistDto"/> id.</param> |
| | | 110 | | /// <response code="204">Playlist updated.</response> |
| | | 111 | | /// <response code="403">Access forbidden.</response> |
| | | 112 | | /// <response code="404">Playlist not found.</response> |
| | | 113 | | /// <returns> |
| | | 114 | | /// A <see cref="Task" /> that represents the asynchronous operation to update a playlist. |
| | | 115 | | /// The task result contains an <see cref="OkResult"/> indicating success. |
| | | 116 | | /// </returns> |
| | | 117 | | [HttpPost("{playlistId}")] |
| | | 118 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 119 | | [ProducesResponseType(StatusCodes.Status403Forbidden)] |
| | | 120 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 121 | | public async Task<ActionResult> UpdatePlaylist( |
| | | 122 | | [FromRoute, Required] Guid playlistId, |
| | | 123 | | [FromBody, Required] UpdatePlaylistDto updatePlaylistRequest) |
| | | 124 | | { |
| | 0 | 125 | | var callingUserId = User.GetUserId(); |
| | | 126 | | |
| | 0 | 127 | | var playlist = _playlistManager.GetPlaylistForUser(playlistId, callingUserId); |
| | 0 | 128 | | if (playlist is null) |
| | | 129 | | { |
| | 0 | 130 | | return NotFound("Playlist not found"); |
| | | 131 | | } |
| | | 132 | | |
| | 0 | 133 | | var isPermitted = playlist.OwnerUserId.Equals(callingUserId) |
| | 0 | 134 | | || playlist.Shares.Any(s => s.CanEdit && s.UserId.Equals(callingUserId)); |
| | | 135 | | |
| | 0 | 136 | | if (!isPermitted) |
| | | 137 | | { |
| | 0 | 138 | | return Forbid(); |
| | | 139 | | } |
| | | 140 | | |
| | 0 | 141 | | await _playlistManager.UpdatePlaylist(new PlaylistUpdateRequest |
| | 0 | 142 | | { |
| | 0 | 143 | | UserId = callingUserId, |
| | 0 | 144 | | Id = playlistId, |
| | 0 | 145 | | Name = updatePlaylistRequest.Name, |
| | 0 | 146 | | Ids = updatePlaylistRequest.Ids, |
| | 0 | 147 | | Users = updatePlaylistRequest.Users, |
| | 0 | 148 | | Public = updatePlaylistRequest.IsPublic |
| | 0 | 149 | | }).ConfigureAwait(false); |
| | | 150 | | |
| | 0 | 151 | | return NoContent(); |
| | 0 | 152 | | } |
| | | 153 | | |
| | | 154 | | /// <summary> |
| | | 155 | | /// Get a playlist. |
| | | 156 | | /// </summary> |
| | | 157 | | /// <param name="playlistId">The playlist id.</param> |
| | | 158 | | /// <response code="200">The playlist.</response> |
| | | 159 | | /// <response code="404">Playlist not found.</response> |
| | | 160 | | /// <returns> |
| | | 161 | | /// A <see cref="Playlist"/> objects. |
| | | 162 | | /// </returns> |
| | | 163 | | [HttpGet("{playlistId}")] |
| | | 164 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 165 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 166 | | public ActionResult<PlaylistDto> GetPlaylist( |
| | | 167 | | [FromRoute, Required] Guid playlistId) |
| | | 168 | | { |
| | 0 | 169 | | var userId = User.GetUserId(); |
| | | 170 | | |
| | 0 | 171 | | var playlist = _playlistManager.GetPlaylistForUser(playlistId, userId); |
| | 0 | 172 | | if (playlist is null) |
| | | 173 | | { |
| | 0 | 174 | | return NotFound("Playlist not found"); |
| | | 175 | | } |
| | | 176 | | |
| | 0 | 177 | | return new PlaylistDto() |
| | 0 | 178 | | { |
| | 0 | 179 | | Shares = playlist.Shares, |
| | 0 | 180 | | OpenAccess = playlist.OpenAccess, |
| | 0 | 181 | | ItemIds = playlist.GetManageableItems().Select(t => t.Item2.Id).ToList() |
| | 0 | 182 | | }; |
| | | 183 | | } |
| | | 184 | | |
| | | 185 | | /// <summary> |
| | | 186 | | /// Get a playlist's users. |
| | | 187 | | /// </summary> |
| | | 188 | | /// <param name="playlistId">The playlist id.</param> |
| | | 189 | | /// <response code="200">Found shares.</response> |
| | | 190 | | /// <response code="403">Access forbidden.</response> |
| | | 191 | | /// <response code="404">Playlist not found.</response> |
| | | 192 | | /// <returns> |
| | | 193 | | /// A list of <see cref="PlaylistUserPermissions"/> objects. |
| | | 194 | | /// </returns> |
| | | 195 | | [HttpGet("{playlistId}/Users")] |
| | | 196 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 197 | | [ProducesResponseType(StatusCodes.Status403Forbidden)] |
| | | 198 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 199 | | public ActionResult<IReadOnlyList<PlaylistUserPermissions>> GetPlaylistUsers( |
| | | 200 | | [FromRoute, Required] Guid playlistId) |
| | | 201 | | { |
| | 0 | 202 | | var userId = User.GetUserId(); |
| | | 203 | | |
| | 0 | 204 | | var playlist = _playlistManager.GetPlaylistForUser(playlistId, userId); |
| | 0 | 205 | | if (playlist is null) |
| | | 206 | | { |
| | 0 | 207 | | return NotFound("Playlist not found"); |
| | | 208 | | } |
| | | 209 | | |
| | 0 | 210 | | var isPermitted = playlist.OwnerUserId.Equals(userId); |
| | | 211 | | |
| | 0 | 212 | | return isPermitted ? playlist.Shares.ToList() : Forbid(); |
| | | 213 | | } |
| | | 214 | | |
| | | 215 | | /// <summary> |
| | | 216 | | /// Get a playlist user. |
| | | 217 | | /// </summary> |
| | | 218 | | /// <param name="playlistId">The playlist id.</param> |
| | | 219 | | /// <param name="userId">The user id.</param> |
| | | 220 | | /// <response code="200">User permission found.</response> |
| | | 221 | | /// <response code="403">Access forbidden.</response> |
| | | 222 | | /// <response code="404">Playlist not found.</response> |
| | | 223 | | /// <returns> |
| | | 224 | | /// <see cref="PlaylistUserPermissions"/>. |
| | | 225 | | /// </returns> |
| | | 226 | | [HttpGet("{playlistId}/Users/{userId}")] |
| | | 227 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 228 | | [ProducesResponseType(StatusCodes.Status403Forbidden)] |
| | | 229 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 230 | | public ActionResult<PlaylistUserPermissions?> GetPlaylistUser( |
| | | 231 | | [FromRoute, Required] Guid playlistId, |
| | | 232 | | [FromRoute, Required] Guid userId) |
| | | 233 | | { |
| | 0 | 234 | | var callingUserId = User.GetUserId(); |
| | | 235 | | |
| | 0 | 236 | | var playlist = _playlistManager.GetPlaylistForUser(playlistId, callingUserId); |
| | 0 | 237 | | if (playlist is null) |
| | | 238 | | { |
| | 0 | 239 | | return NotFound("Playlist not found"); |
| | | 240 | | } |
| | | 241 | | |
| | 0 | 242 | | if (playlist.OwnerUserId.Equals(callingUserId)) |
| | | 243 | | { |
| | 0 | 244 | | return new PlaylistUserPermissions(callingUserId, true); |
| | | 245 | | } |
| | | 246 | | |
| | 0 | 247 | | var userPermission = playlist.Shares.FirstOrDefault(s => s.UserId.Equals(userId)); |
| | 0 | 248 | | var isPermitted = playlist.Shares.Any(s => s.CanEdit && s.UserId.Equals(callingUserId)) |
| | 0 | 249 | | || userId.Equals(callingUserId); |
| | | 250 | | |
| | 0 | 251 | | if (!isPermitted) |
| | | 252 | | { |
| | 0 | 253 | | return Forbid(); |
| | | 254 | | } |
| | | 255 | | |
| | 0 | 256 | | if (userPermission is not null) |
| | | 257 | | { |
| | 0 | 258 | | return userPermission; |
| | | 259 | | } |
| | | 260 | | |
| | 0 | 261 | | return NotFound("User permissions not found"); |
| | | 262 | | } |
| | | 263 | | |
| | | 264 | | /// <summary> |
| | | 265 | | /// Modify a user of a playlist's users. |
| | | 266 | | /// </summary> |
| | | 267 | | /// <param name="playlistId">The playlist id.</param> |
| | | 268 | | /// <param name="userId">The user id.</param> |
| | | 269 | | /// <param name="updatePlaylistUserRequest">The <see cref="UpdatePlaylistUserDto"/>.</param> |
| | | 270 | | /// <response code="204">User's permissions modified.</response> |
| | | 271 | | /// <response code="403">Access forbidden.</response> |
| | | 272 | | /// <response code="404">Playlist not found.</response> |
| | | 273 | | /// <returns> |
| | | 274 | | /// A <see cref="Task" /> that represents the asynchronous operation to modify an user's playlist permissions. |
| | | 275 | | /// The task result contains an <see cref="OkResult"/> indicating success. |
| | | 276 | | /// </returns> |
| | | 277 | | [HttpPost("{playlistId}/Users/{userId}")] |
| | | 278 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 279 | | [ProducesResponseType(StatusCodes.Status403Forbidden)] |
| | | 280 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 281 | | public async Task<ActionResult> UpdatePlaylistUser( |
| | | 282 | | [FromRoute, Required] Guid playlistId, |
| | | 283 | | [FromRoute, Required] Guid userId, |
| | | 284 | | [FromBody(EmptyBodyBehavior = EmptyBodyBehavior.Allow), Required] UpdatePlaylistUserDto updatePlaylistUserReques |
| | | 285 | | { |
| | 0 | 286 | | var callingUserId = User.GetUserId(); |
| | | 287 | | |
| | 0 | 288 | | var playlist = _playlistManager.GetPlaylistForUser(playlistId, callingUserId); |
| | 0 | 289 | | if (playlist is null) |
| | | 290 | | { |
| | 0 | 291 | | return NotFound("Playlist not found"); |
| | | 292 | | } |
| | | 293 | | |
| | 0 | 294 | | var isPermitted = playlist.OwnerUserId.Equals(callingUserId); |
| | | 295 | | |
| | 0 | 296 | | if (!isPermitted) |
| | | 297 | | { |
| | 0 | 298 | | return Forbid(); |
| | | 299 | | } |
| | | 300 | | |
| | 0 | 301 | | await _playlistManager.AddUserToShares(new PlaylistUserUpdateRequest |
| | 0 | 302 | | { |
| | 0 | 303 | | Id = playlistId, |
| | 0 | 304 | | UserId = userId, |
| | 0 | 305 | | CanEdit = updatePlaylistUserRequest.CanEdit |
| | 0 | 306 | | }).ConfigureAwait(false); |
| | | 307 | | |
| | 0 | 308 | | return NoContent(); |
| | 0 | 309 | | } |
| | | 310 | | |
| | | 311 | | /// <summary> |
| | | 312 | | /// Remove a user from a playlist's users. |
| | | 313 | | /// </summary> |
| | | 314 | | /// <param name="playlistId">The playlist id.</param> |
| | | 315 | | /// <param name="userId">The user id.</param> |
| | | 316 | | /// <response code="204">User permissions removed from playlist.</response> |
| | | 317 | | /// <response code="401">Unauthorized access.</response> |
| | | 318 | | /// <response code="404">No playlist or user permissions found.</response> |
| | | 319 | | /// <returns> |
| | | 320 | | /// A <see cref="Task" /> that represents the asynchronous operation to delete a user from a playlist's shares. |
| | | 321 | | /// The task result contains an <see cref="OkResult"/> indicating success. |
| | | 322 | | /// </returns> |
| | | 323 | | [HttpDelete("{playlistId}/Users/{userId}")] |
| | | 324 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 325 | | [ProducesResponseType(StatusCodes.Status403Forbidden)] |
| | | 326 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 327 | | public async Task<ActionResult> RemoveUserFromPlaylist( |
| | | 328 | | [FromRoute, Required] Guid playlistId, |
| | | 329 | | [FromRoute, Required] Guid userId) |
| | | 330 | | { |
| | 0 | 331 | | var callingUserId = User.GetUserId(); |
| | | 332 | | |
| | 0 | 333 | | var playlist = _playlistManager.GetPlaylistForUser(playlistId, callingUserId); |
| | 0 | 334 | | if (playlist is null) |
| | | 335 | | { |
| | 0 | 336 | | return NotFound("Playlist not found"); |
| | | 337 | | } |
| | | 338 | | |
| | 0 | 339 | | var isPermitted = playlist.OwnerUserId.Equals(callingUserId) |
| | 0 | 340 | | || playlist.Shares.Any(s => s.CanEdit && s.UserId.Equals(callingUserId)); |
| | | 341 | | |
| | 0 | 342 | | if (!isPermitted) |
| | | 343 | | { |
| | 0 | 344 | | return Forbid(); |
| | | 345 | | } |
| | | 346 | | |
| | 0 | 347 | | var share = playlist.Shares.FirstOrDefault(s => s.UserId.Equals(userId)); |
| | 0 | 348 | | if (share is null) |
| | | 349 | | { |
| | 0 | 350 | | return NotFound("User permissions not found"); |
| | | 351 | | } |
| | | 352 | | |
| | 0 | 353 | | await _playlistManager.RemoveUserFromShares(playlistId, callingUserId, share).ConfigureAwait(false); |
| | | 354 | | |
| | 0 | 355 | | return NoContent(); |
| | 0 | 356 | | } |
| | | 357 | | |
| | | 358 | | /// <summary> |
| | | 359 | | /// Adds items to a playlist. |
| | | 360 | | /// </summary> |
| | | 361 | | /// <param name="playlistId">The playlist id.</param> |
| | | 362 | | /// <param name="ids">Item id, comma delimited.</param> |
| | | 363 | | /// <param name="position">Optional. 0-based index where to place the items or at the end if <c>null</c>.</param> |
| | | 364 | | /// <param name="userId">The userId.</param> |
| | | 365 | | /// <response code="204">Items added to playlist.</response> |
| | | 366 | | /// <response code="403">Access forbidden.</response> |
| | | 367 | | /// <response code="404">Playlist not found.</response> |
| | | 368 | | /// <returns>An <see cref="NoContentResult"/> on success.</returns> |
| | | 369 | | [HttpPost("{playlistId}/Items")] |
| | | 370 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 371 | | [ProducesResponseType(StatusCodes.Status403Forbidden)] |
| | | 372 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 373 | | public async Task<ActionResult> AddItemToPlaylist( |
| | | 374 | | [FromRoute, Required] Guid playlistId, |
| | | 375 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] ids, |
| | | 376 | | [FromQuery] int? position, |
| | | 377 | | [FromQuery] Guid? userId) |
| | | 378 | | { |
| | 0 | 379 | | userId = RequestHelpers.GetUserId(User, userId); |
| | 0 | 380 | | var playlist = _playlistManager.GetPlaylistForUser(playlistId, userId.Value); |
| | 0 | 381 | | if (playlist is null) |
| | | 382 | | { |
| | 0 | 383 | | return NotFound("Playlist not found"); |
| | | 384 | | } |
| | | 385 | | |
| | 0 | 386 | | var isPermitted = playlist.OwnerUserId.Equals(userId.Value) |
| | 0 | 387 | | || playlist.Shares.Any(s => s.CanEdit && s.UserId.Equals(userId.Value)); |
| | | 388 | | |
| | 0 | 389 | | if (!isPermitted) |
| | | 390 | | { |
| | 0 | 391 | | return Forbid(); |
| | | 392 | | } |
| | | 393 | | |
| | 0 | 394 | | await _playlistManager.AddItemToPlaylistAsync(playlistId, ids, position, userId.Value).ConfigureAwait(false); |
| | 0 | 395 | | return NoContent(); |
| | 0 | 396 | | } |
| | | 397 | | |
| | | 398 | | /// <summary> |
| | | 399 | | /// Moves a playlist item. |
| | | 400 | | /// </summary> |
| | | 401 | | /// <param name="playlistId">The playlist id.</param> |
| | | 402 | | /// <param name="itemId">The item id.</param> |
| | | 403 | | /// <param name="newIndex">The new index.</param> |
| | | 404 | | /// <response code="204">Item moved to new index.</response> |
| | | 405 | | /// <response code="403">Access forbidden.</response> |
| | | 406 | | /// <response code="404">Playlist not found.</response> |
| | | 407 | | /// <returns>An <see cref="NoContentResult"/> on success.</returns> |
| | | 408 | | [HttpPost("{playlistId}/Items/{itemId}/Move/{newIndex}")] |
| | | 409 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 410 | | [ProducesResponseType(StatusCodes.Status403Forbidden)] |
| | | 411 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 412 | | public async Task<ActionResult> MoveItem( |
| | | 413 | | [FromRoute, Required] string playlistId, |
| | | 414 | | [FromRoute, Required] string itemId, |
| | | 415 | | [FromRoute, Required] int newIndex) |
| | | 416 | | { |
| | 0 | 417 | | var callingUserId = User.GetUserId(); |
| | | 418 | | |
| | 0 | 419 | | var playlist = _playlistManager.GetPlaylistForUser(Guid.Parse(playlistId), callingUserId); |
| | 0 | 420 | | if (playlist is null) |
| | | 421 | | { |
| | 0 | 422 | | return NotFound("Playlist not found"); |
| | | 423 | | } |
| | | 424 | | |
| | 0 | 425 | | var isPermitted = playlist.OwnerUserId.Equals(callingUserId) |
| | 0 | 426 | | || playlist.Shares.Any(s => s.CanEdit && s.UserId.Equals(callingUserId)); |
| | | 427 | | |
| | 0 | 428 | | if (!isPermitted) |
| | | 429 | | { |
| | 0 | 430 | | return Forbid(); |
| | | 431 | | } |
| | | 432 | | |
| | 0 | 433 | | await _playlistManager.MoveItemAsync(playlistId, itemId, newIndex, callingUserId).ConfigureAwait(false); |
| | 0 | 434 | | return NoContent(); |
| | 0 | 435 | | } |
| | | 436 | | |
| | | 437 | | /// <summary> |
| | | 438 | | /// Removes items from a playlist. |
| | | 439 | | /// </summary> |
| | | 440 | | /// <param name="playlistId">The playlist id.</param> |
| | | 441 | | /// <param name="entryIds">The item ids, comma delimited.</param> |
| | | 442 | | /// <response code="204">Items removed.</response> |
| | | 443 | | /// <response code="403">Access forbidden.</response> |
| | | 444 | | /// <response code="404">Playlist not found.</response> |
| | | 445 | | /// <returns>An <see cref="NoContentResult"/> on success.</returns> |
| | | 446 | | [HttpDelete("{playlistId}/Items")] |
| | | 447 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 448 | | [ProducesResponseType(StatusCodes.Status403Forbidden)] |
| | | 449 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 450 | | public async Task<ActionResult> RemoveItemFromPlaylist( |
| | | 451 | | [FromRoute, Required] string playlistId, |
| | | 452 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] string[] entryIds) |
| | | 453 | | { |
| | 0 | 454 | | var callingUserId = User.GetUserId(); |
| | | 455 | | |
| | 0 | 456 | | if (!callingUserId.IsEmpty()) |
| | | 457 | | { |
| | 0 | 458 | | var playlist = _playlistManager.GetPlaylistForUser(Guid.Parse(playlistId), callingUserId); |
| | 0 | 459 | | if (playlist is null) |
| | | 460 | | { |
| | 0 | 461 | | return NotFound("Playlist not found"); |
| | | 462 | | } |
| | | 463 | | |
| | 0 | 464 | | var isPermitted = playlist.OwnerUserId.Equals(callingUserId) |
| | 0 | 465 | | || playlist.Shares.Any(s => s.CanEdit && s.UserId.Equals(callingUserId)); |
| | | 466 | | |
| | 0 | 467 | | if (!isPermitted) |
| | | 468 | | { |
| | 0 | 469 | | return Forbid(); |
| | | 470 | | } |
| | | 471 | | } |
| | | 472 | | else |
| | | 473 | | { |
| | 0 | 474 | | var isApiKey = User.GetIsApiKey(); |
| | | 475 | | |
| | 0 | 476 | | if (!isApiKey) |
| | | 477 | | { |
| | 0 | 478 | | return Forbid(); |
| | | 479 | | } |
| | | 480 | | } |
| | | 481 | | |
| | | 482 | | try |
| | | 483 | | { |
| | 0 | 484 | | await _playlistManager.RemoveItemFromPlaylistAsync(playlistId, entryIds).ConfigureAwait(false); |
| | 0 | 485 | | return NoContent(); |
| | | 486 | | } |
| | 0 | 487 | | catch (ArgumentException) |
| | | 488 | | { |
| | 0 | 489 | | return NotFound(); |
| | | 490 | | } |
| | 0 | 491 | | } |
| | | 492 | | |
| | | 493 | | /// <summary> |
| | | 494 | | /// Gets the original items of a playlist. |
| | | 495 | | /// </summary> |
| | | 496 | | /// <param name="playlistId">The playlist id.</param> |
| | | 497 | | /// <param name="userId">User id.</param> |
| | | 498 | | /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped fr |
| | | 499 | | /// <param name="limit">Optional. The maximum number of records to return.</param> |
| | | 500 | | /// <param name="fields">Optional. Specify additional fields of information to return in the output.</param> |
| | | 501 | | /// <param name="enableImages">Optional. Include image information in output.</param> |
| | | 502 | | /// <param name="enableUserData">Optional. Include user data.</param> |
| | | 503 | | /// <param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param> |
| | | 504 | | /// <param name="enableImageTypes">Optional. The image types to include in the output.</param> |
| | | 505 | | /// <response code="200">Original playlist returned.</response> |
| | | 506 | | /// <response code="404">Access forbidden.</response> |
| | | 507 | | /// <response code="404">Playlist not found.</response> |
| | | 508 | | /// <returns>The original playlist items.</returns> |
| | | 509 | | [HttpGet("{playlistId}/Items")] |
| | | 510 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 511 | | [ProducesResponseType(StatusCodes.Status403Forbidden)] |
| | | 512 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 513 | | public ActionResult<QueryResult<BaseItemDto>> GetPlaylistItems( |
| | | 514 | | [FromRoute, Required] Guid playlistId, |
| | | 515 | | [FromQuery] Guid? userId, |
| | | 516 | | [FromQuery] int? startIndex, |
| | | 517 | | [FromQuery] int? limit, |
| | | 518 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemFields[] fields, |
| | | 519 | | [FromQuery] bool? enableImages, |
| | | 520 | | [FromQuery] bool? enableUserData, |
| | | 521 | | [FromQuery] int? imageTypeLimit, |
| | | 522 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ImageType[] enableImageTypes) |
| | | 523 | | { |
| | 0 | 524 | | var callingUserId = userId ?? User.GetUserId(); |
| | 0 | 525 | | var playlist = _playlistManager.GetPlaylistForUser(playlistId, callingUserId); |
| | 0 | 526 | | if (playlist is null) |
| | | 527 | | { |
| | 0 | 528 | | return NotFound("Playlist not found"); |
| | | 529 | | } |
| | | 530 | | |
| | 0 | 531 | | var isPermitted = playlist.OpenAccess |
| | 0 | 532 | | || playlist.OwnerUserId.Equals(callingUserId) |
| | 0 | 533 | | || playlist.Shares.Any(s => s.UserId.Equals(callingUserId)); |
| | | 534 | | |
| | 0 | 535 | | if (!isPermitted) |
| | | 536 | | { |
| | 0 | 537 | | return Forbid(); |
| | | 538 | | } |
| | | 539 | | |
| | 0 | 540 | | var user = _userManager.GetUserById(callingUserId); |
| | 0 | 541 | | var items = playlist.GetManageableItems().Where(i => i.Item2.IsVisible(user)).ToArray(); |
| | 0 | 542 | | var count = items.Length; |
| | 0 | 543 | | if (startIndex.HasValue) |
| | | 544 | | { |
| | 0 | 545 | | items = items.Skip(startIndex.Value).ToArray(); |
| | | 546 | | } |
| | | 547 | | |
| | 0 | 548 | | if (limit.HasValue) |
| | | 549 | | { |
| | 0 | 550 | | items = items.Take(limit.Value).ToArray(); |
| | | 551 | | } |
| | | 552 | | |
| | 0 | 553 | | var dtoOptions = new DtoOptions { Fields = fields } |
| | 0 | 554 | | .AddAdditionalDtoOptions(enableImages, enableUserData, imageTypeLimit, enableImageTypes); |
| | | 555 | | |
| | 0 | 556 | | var dtos = _dtoService.GetBaseItemDtos(items.Select(i => i.Item2).ToList(), dtoOptions, user); |
| | 0 | 557 | | for (int index = 0; index < dtos.Count; index++) |
| | | 558 | | { |
| | 0 | 559 | | dtos[index].PlaylistItemId = items[index].Item1.ItemId?.ToString("N", CultureInfo.InvariantCulture); |
| | | 560 | | } |
| | | 561 | | |
| | 0 | 562 | | var result = new QueryResult<BaseItemDto>( |
| | 0 | 563 | | startIndex, |
| | 0 | 564 | | count, |
| | 0 | 565 | | dtos); |
| | | 566 | | |
| | 0 | 567 | | return result; |
| | | 568 | | } |
| | | 569 | | } |