mirror of
https://github.com/jellyfin/jellyfin.git
synced 2024-11-16 10:29:01 -07:00
Merge pull request #3440 from Ullmie02/api-collection
Move CollectionService to Jellyfin.Api
This commit is contained in:
Patrick Barron
GitHub
commit
45f195aca9
110
Jellyfin.Api/Controllers/CollectionController.cs
Normal file
110
Jellyfin.Api/Controllers/CollectionController.cs
Normal file
@ -0,0 +1,110 @@
|
|||||||
|
using System;
|
||||||
|
using Jellyfin.Api.Constants;
|
||||||
|
using Jellyfin.Api.Extensions;
|
||||||
|
using Jellyfin.Api.Helpers;
|
||||||
|
using MediaBrowser.Controller.Collections;
|
||||||
|
using MediaBrowser.Controller.Dto;
|
||||||
|
using MediaBrowser.Controller.Net;
|
||||||
|
using MediaBrowser.Model.Collections;
|
||||||
|
using Microsoft.AspNetCore.Authorization;
|
||||||
|
using Microsoft.AspNetCore.Http;
|
||||||
|
using Microsoft.AspNetCore.Mvc;
|
||||||
|
|
||||||
|
namespace Jellyfin.Api.Controllers
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// The collection controller.
|
||||||
|
/// </summary>
|
||||||
|
[Authorize(Policy = Policies.DefaultAuthorization)]
|
||||||
|
[Route("/Collections")]
|
||||||
|
public class CollectionController : BaseJellyfinApiController
|
||||||
|
{
|
||||||
|
private readonly ICollectionManager _collectionManager;
|
||||||
|
private readonly IDtoService _dtoService;
|
||||||
|
private readonly IAuthorizationContext _authContext;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Initializes a new instance of the <see cref="CollectionController"/> class.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="collectionManager">Instance of <see cref="ICollectionManager"/> interface.</param>
|
||||||
|
/// <param name="dtoService">Instance of <see cref="IDtoService"/> interface.</param>
|
||||||
|
/// <param name="authContext">Instance of <see cref="IAuthorizationContext"/> interface.</param>
|
||||||
|
public CollectionController(
|
||||||
|
ICollectionManager collectionManager,
|
||||||
|
IDtoService dtoService,
|
||||||
|
IAuthorizationContext authContext)
|
||||||
|
{
|
||||||
|
_collectionManager = collectionManager;
|
||||||
|
_dtoService = dtoService;
|
||||||
|
_authContext = authContext;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Creates a new collection.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="name">The name of the collection.</param>
|
||||||
|
/// <param name="ids">Item Ids to add to the collection.</param>
|
||||||
|
/// <param name="isLocked">Whether or not to lock the new collection.</param>
|
||||||
|
/// <param name="parentId">Optional. Create the collection within a specific folder.</param>
|
||||||
|
/// <response code="200">Collection created.</response>
|
||||||
|
/// <returns>A <see cref="CollectionCreationOptions"/> with information about the new collection.</returns>
|
||||||
|
[HttpPost]
|
||||||
|
[ProducesResponseType(StatusCodes.Status200OK)]
|
||||||
|
public ActionResult<CollectionCreationResult> CreateCollection(
|
||||||
|
[FromQuery] string name,
|
||||||
|
[FromQuery] string ids,
|
||||||
|
[FromQuery] bool isLocked,
|
||||||
|
[FromQuery] Guid? parentId)
|
||||||
|
{
|
||||||
|
var userId = _authContext.GetAuthorizationInfo(Request).UserId;
|
||||||
|
|
||||||
|
var item = _collectionManager.CreateCollection(new CollectionCreationOptions
|
||||||
|
{
|
||||||
|
IsLocked = isLocked,
|
||||||
|
Name = name,
|
||||||
|
ParentId = parentId,
|
||||||
|
ItemIdList = RequestHelpers.Split(ids, ',', true),
|
||||||
|
UserIds = new[] { userId }
|
||||||
|
});
|
||||||
|
|
||||||
|
var dtoOptions = new DtoOptions().AddClientFields(Request);
|
||||||
|
|
||||||
|
var dto = _dtoService.GetBaseItemDto(item, dtoOptions);
|
||||||
|
|
||||||
|
return new CollectionCreationResult
|
||||||
|
{
|
||||||
|
Id = dto.Id
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Adds items to a collection.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="collectionId">The collection id.</param>
|
||||||
|
/// <param name="itemIds">Item ids, comma delimited.</param>
|
||||||
|
/// <response code="204">Items added to collection.</response>
|
||||||
|
/// <returns>A <see cref="NoContentResult"/> indicating success.</returns>
|
||||||
|
[HttpPost("{collectionId}/Items")]
|
||||||
|
[ProducesResponseType(StatusCodes.Status204NoContent)]
|
||||||
|
public ActionResult AddToCollection([FromRoute] Guid collectionId, [FromQuery] string itemIds)
|
||||||
|
{
|
||||||
|
_collectionManager.AddToCollection(collectionId, RequestHelpers.Split(itemIds, ',', true));
|
||||||
|
return NoContent();
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Removes items from a collection.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="collectionId">The collection id.</param>
|
||||||
|
/// <param name="itemIds">Item ids, comma delimited.</param>
|
||||||
|
/// <response code="204">Items removed from collection.</response>
|
||||||
|
/// <returns>A <see cref="NoContentResult"/> indicating success.</returns>
|
||||||
|
[HttpDelete("{collectionId}/Items")]
|
||||||
|
[ProducesResponseType(StatusCodes.Status204NoContent)]
|
||||||
|
public ActionResult RemoveFromCollection([FromRoute] Guid collectionId, [FromQuery] string itemIds)
|
||||||
|
{
|
||||||
|
_collectionManager.RemoveFromCollection(collectionId, RequestHelpers.Split(itemIds, ',', true));
|
||||||
|
return NoContent();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -1,105 +0,0 @@
|
|||||||
using System;
|
|
||||||
using MediaBrowser.Controller.Collections;
|
|
||||||
using MediaBrowser.Controller.Configuration;
|
|
||||||
using MediaBrowser.Controller.Dto;
|
|
||||||
using MediaBrowser.Controller.Net;
|
|
||||||
using MediaBrowser.Model.Collections;
|
|
||||||
using MediaBrowser.Model.Services;
|
|
||||||
using Microsoft.Extensions.Logging;
|
|
||||||
|
|
||||||
namespace MediaBrowser.Api.Movies
|
|
||||||
{
|
|
||||||
[Route("/Collections", "POST", Summary = "Creates a new collection")]
|
|
||||||
public class CreateCollection : IReturn<CollectionCreationResult>
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "IsLocked", Description = "Whether or not to lock the new collection.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "POST")]
|
|
||||||
public bool IsLocked { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "Name", Description = "The name of the new collection.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
|
|
||||||
public string Name { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "ParentId", Description = "Optional - create the collection within a specific folder", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
|
|
||||||
public string ParentId { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "Ids", Description = "Item Ids to add to the collection", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST", AllowMultiple = true)]
|
|
||||||
public string Ids { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/Collections/{Id}/Items", "POST", Summary = "Adds items to a collection")]
|
|
||||||
public class AddToCollection : 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; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Route("/Collections/{Id}/Items", "DELETE", Summary = "Removes items from a collection")]
|
|
||||||
public class RemoveFromCollection : IReturnVoid
|
|
||||||
{
|
|
||||||
[ApiMember(Name = "Ids", Description = "Item id, comma delimited", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "DELETE")]
|
|
||||||
public string Ids { get; set; }
|
|
||||||
|
|
||||||
[ApiMember(Name = "Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
|
|
||||||
public string Id { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
[Authenticated]
|
|
||||||
public class CollectionService : BaseApiService
|
|
||||||
{
|
|
||||||
private readonly ICollectionManager _collectionManager;
|
|
||||||
private readonly IDtoService _dtoService;
|
|
||||||
private readonly IAuthorizationContext _authContext;
|
|
||||||
|
|
||||||
public CollectionService(
|
|
||||||
ILogger<CollectionService> logger,
|
|
||||||
IServerConfigurationManager serverConfigurationManager,
|
|
||||||
IHttpResultFactory httpResultFactory,
|
|
||||||
ICollectionManager collectionManager,
|
|
||||||
IDtoService dtoService,
|
|
||||||
IAuthorizationContext authContext)
|
|
||||||
: base(logger, serverConfigurationManager, httpResultFactory)
|
|
||||||
{
|
|
||||||
_collectionManager = collectionManager;
|
|
||||||
_dtoService = dtoService;
|
|
||||||
_authContext = authContext;
|
|
||||||
}
|
|
||||||
|
|
||||||
public object Post(CreateCollection request)
|
|
||||||
{
|
|
||||||
var userId = _authContext.GetAuthorizationInfo(Request).UserId;
|
|
||||||
|
|
||||||
var parentId = string.IsNullOrWhiteSpace(request.ParentId) ? (Guid?)null : new Guid(request.ParentId);
|
|
||||||
|
|
||||||
var item = _collectionManager.CreateCollection(new CollectionCreationOptions
|
|
||||||
{
|
|
||||||
IsLocked = request.IsLocked,
|
|
||||||
Name = request.Name,
|
|
||||||
ParentId = parentId,
|
|
||||||
ItemIdList = SplitValue(request.Ids, ','),
|
|
||||||
UserIds = new[] { userId }
|
|
||||||
|
|
||||||
});
|
|
||||||
|
|
||||||
var dtoOptions = GetDtoOptions(_authContext, request);
|
|
||||||
|
|
||||||
var dto = _dtoService.GetBaseItemDto(item, dtoOptions);
|
|
||||||
|
|
||||||
return new CollectionCreationResult
|
|
||||||
{
|
|
||||||
Id = dto.Id
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
public void Post(AddToCollection request)
|
|
||||||
{
|
|
||||||
_collectionManager.AddToCollection(new Guid(request.Id), SplitValue(request.Ids, ','));
|
|
||||||
}
|
|
||||||
|
|
||||||
public void Delete(RemoveFromCollection request)
|
|
||||||
{
|
|
||||||
_collectionManager.RemoveFromCollection(new Guid(request.Id), SplitValue(request.Ids, ','));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Loading…
Reference in New Issue
Block a user