mirror of https://github.com/jellyfin/jellyfin.git
Merge pull request #3433 from crobibero/api-years
Move YearsService to Jellyfin.Api
This commit is contained in:
commit
90c01327aa
|
@ -0,0 +1,231 @@
|
||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Linq;
|
||||||
|
using Jellyfin.Api.Extensions;
|
||||||
|
using Jellyfin.Api.Helpers;
|
||||||
|
using Jellyfin.Data.Entities;
|
||||||
|
using MediaBrowser.Controller.Dto;
|
||||||
|
using MediaBrowser.Controller.Entities;
|
||||||
|
using MediaBrowser.Controller.Library;
|
||||||
|
using MediaBrowser.Model.Dto;
|
||||||
|
using MediaBrowser.Model.Querying;
|
||||||
|
using Microsoft.AspNetCore.Http;
|
||||||
|
using Microsoft.AspNetCore.Mvc;
|
||||||
|
|
||||||
|
namespace Jellyfin.Api.Controllers
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Years controller.
|
||||||
|
/// </summary>
|
||||||
|
public class YearsController : BaseJellyfinApiController
|
||||||
|
{
|
||||||
|
private readonly ILibraryManager _libraryManager;
|
||||||
|
private readonly IUserManager _userManager;
|
||||||
|
private readonly IDtoService _dtoService;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Initializes a new instance of the <see cref="YearsController"/> class.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
|
||||||
|
/// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
|
||||||
|
/// <param name="dtoService">Instance of the <see cref="IDtoService"/> interface.</param>
|
||||||
|
public YearsController(
|
||||||
|
ILibraryManager libraryManager,
|
||||||
|
IUserManager userManager,
|
||||||
|
IDtoService dtoService)
|
||||||
|
{
|
||||||
|
_libraryManager = libraryManager;
|
||||||
|
_userManager = userManager;
|
||||||
|
_dtoService = dtoService;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Get years.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="startIndex">Skips over a given number of items within the results. Use for paging.</param>
|
||||||
|
/// <param name="limit">Optional. The maximum number of records to return.</param>
|
||||||
|
/// <param name="sortOrder">Sort Order - Ascending,Descending.</param>
|
||||||
|
/// <param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
||||||
|
/// <param name="fields">Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.</param>
|
||||||
|
/// <param name="excludeItemTypes">Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited.</param>
|
||||||
|
/// <param name="includeItemTypes">Optional. If specified, results will be included based on item type. This allows multiple, comma delimited.</param>
|
||||||
|
/// <param name="mediaTypes">Optional. Filter by MediaType. Allows multiple, comma delimited.</param>
|
||||||
|
/// <param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.</param>
|
||||||
|
/// <param name="enableUserData">Optional. Include user data.</param>
|
||||||
|
/// <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>
|
||||||
|
/// <param name="userId">User Id.</param>
|
||||||
|
/// <param name="recursive">Search recursively.</param>
|
||||||
|
/// <param name="enableImages">Optional. Include image information in output.</param>
|
||||||
|
/// <response code="200">Year query returned.</response>
|
||||||
|
/// <returns> A <see cref="QueryResult{BaseItemDto}"/> containing the year result.</returns>
|
||||||
|
[HttpGet]
|
||||||
|
[ProducesResponseType(StatusCodes.Status200OK)]
|
||||||
|
public ActionResult<QueryResult<BaseItemDto>> GetYears(
|
||||||
|
[FromQuery] int? startIndex,
|
||||||
|
[FromQuery] int? limit,
|
||||||
|
[FromQuery] string sortOrder,
|
||||||
|
[FromQuery] string parentId,
|
||||||
|
[FromQuery] string fields,
|
||||||
|
[FromQuery] string excludeItemTypes,
|
||||||
|
[FromQuery] string includeItemTypes,
|
||||||
|
[FromQuery] string mediaTypes,
|
||||||
|
[FromQuery] string sortBy,
|
||||||
|
[FromQuery] bool? enableUserData,
|
||||||
|
[FromQuery] int? imageTypeLimit,
|
||||||
|
[FromQuery] string enableImageTypes,
|
||||||
|
[FromQuery] Guid userId,
|
||||||
|
[FromQuery] bool recursive = true,
|
||||||
|
[FromQuery] bool? enableImages = true)
|
||||||
|
{
|
||||||
|
var dtoOptions = new DtoOptions()
|
||||||
|
.AddItemFields(fields)
|
||||||
|
.AddClientFields(Request)
|
||||||
|
.AddAdditionalDtoOptions(enableImages, enableUserData, imageTypeLimit, enableImageTypes);
|
||||||
|
|
||||||
|
User? user = null;
|
||||||
|
BaseItem parentItem;
|
||||||
|
|
||||||
|
if (!userId.Equals(Guid.Empty))
|
||||||
|
{
|
||||||
|
user = _userManager.GetUserById(userId);
|
||||||
|
parentItem = string.IsNullOrEmpty(parentId) ? _libraryManager.GetUserRootFolder() : _libraryManager.GetItemById(parentId);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
parentItem = string.IsNullOrEmpty(parentId) ? _libraryManager.RootFolder : _libraryManager.GetItemById(parentId);
|
||||||
|
}
|
||||||
|
|
||||||
|
IList<BaseItem> items;
|
||||||
|
|
||||||
|
var excludeItemTypesArr = RequestHelpers.Split(excludeItemTypes, ',', true);
|
||||||
|
var includeItemTypesArr = RequestHelpers.Split(includeItemTypes, ',', true);
|
||||||
|
var mediaTypesArr = RequestHelpers.Split(mediaTypes, ',', true);
|
||||||
|
|
||||||
|
var query = new InternalItemsQuery(user)
|
||||||
|
{
|
||||||
|
ExcludeItemTypes = excludeItemTypesArr,
|
||||||
|
IncludeItemTypes = includeItemTypesArr,
|
||||||
|
MediaTypes = mediaTypesArr,
|
||||||
|
DtoOptions = dtoOptions
|
||||||
|
};
|
||||||
|
|
||||||
|
bool Filter(BaseItem i) => FilterItem(i, excludeItemTypesArr, includeItemTypesArr, mediaTypesArr);
|
||||||
|
|
||||||
|
if (parentItem.IsFolder)
|
||||||
|
{
|
||||||
|
var folder = (Folder)parentItem;
|
||||||
|
|
||||||
|
if (!userId.Equals(Guid.Empty))
|
||||||
|
{
|
||||||
|
items = recursive ? folder.GetRecursiveChildren(user, query).ToList() : folder.GetChildren(user, true).Where(Filter).ToList();
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
items = recursive ? folder.GetRecursiveChildren(Filter) : folder.Children.Where(Filter).ToList();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
items = new[] { parentItem }.Where(Filter).ToList();
|
||||||
|
}
|
||||||
|
|
||||||
|
var extractedItems = GetAllItems(items);
|
||||||
|
|
||||||
|
var filteredItems = _libraryManager.Sort(extractedItems, user, RequestHelpers.GetOrderBy(sortBy, sortOrder));
|
||||||
|
|
||||||
|
var ibnItemsArray = filteredItems.ToList();
|
||||||
|
|
||||||
|
IEnumerable<BaseItem> ibnItems = ibnItemsArray;
|
||||||
|
|
||||||
|
var result = new QueryResult<BaseItemDto> { TotalRecordCount = ibnItemsArray.Count };
|
||||||
|
|
||||||
|
if (startIndex.HasValue || limit.HasValue)
|
||||||
|
{
|
||||||
|
if (startIndex.HasValue)
|
||||||
|
{
|
||||||
|
ibnItems = ibnItems.Skip(startIndex.Value);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (limit.HasValue)
|
||||||
|
{
|
||||||
|
ibnItems = ibnItems.Take(limit.Value);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var tuples = ibnItems.Select(i => new Tuple<BaseItem, List<BaseItem>>(i, new List<BaseItem>()));
|
||||||
|
|
||||||
|
var dtos = tuples.Select(i => _dtoService.GetItemByNameDto(i.Item1, dtoOptions, i.Item2, user));
|
||||||
|
|
||||||
|
result.Items = dtos.Where(i => i != null).ToArray();
|
||||||
|
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets a year.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="year">The year.</param>
|
||||||
|
/// <param name="userId">Optional. Filter by user id, and attach user data.</param>
|
||||||
|
/// <response code="200">Year returned.</response>
|
||||||
|
/// <response code="404">Year not found.</response>
|
||||||
|
/// <returns>
|
||||||
|
/// An <see cref="OkResult"/> containing the year,
|
||||||
|
/// or a <see cref="NotFoundResult"/> if year not found.
|
||||||
|
/// </returns>
|
||||||
|
[HttpGet("{year}")]
|
||||||
|
[ProducesResponseType(StatusCodes.Status200OK)]
|
||||||
|
[ProducesResponseType(StatusCodes.Status404NotFound)]
|
||||||
|
public ActionResult<BaseItemDto> GetYear([FromRoute] int year, [FromQuery] Guid userId)
|
||||||
|
{
|
||||||
|
var item = _libraryManager.GetYear(year);
|
||||||
|
if (item == null)
|
||||||
|
{
|
||||||
|
return NotFound();
|
||||||
|
}
|
||||||
|
|
||||||
|
var dtoOptions = new DtoOptions()
|
||||||
|
.AddClientFields(Request);
|
||||||
|
|
||||||
|
if (!userId.Equals(Guid.Empty))
|
||||||
|
{
|
||||||
|
var user = _userManager.GetUserById(userId);
|
||||||
|
return _dtoService.GetBaseItemDto(item, dtoOptions, user);
|
||||||
|
}
|
||||||
|
|
||||||
|
return _dtoService.GetBaseItemDto(item, dtoOptions);
|
||||||
|
}
|
||||||
|
|
||||||
|
private bool FilterItem(BaseItem f, IReadOnlyCollection<string> excludeItemTypes, IReadOnlyCollection<string> includeItemTypes, IReadOnlyCollection<string> mediaTypes)
|
||||||
|
{
|
||||||
|
// Exclude item types
|
||||||
|
if (excludeItemTypes.Count > 0 && excludeItemTypes.Contains(f.GetType().Name, StringComparer.OrdinalIgnoreCase))
|
||||||
|
{
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Include item types
|
||||||
|
if (includeItemTypes.Count > 0 && !includeItemTypes.Contains(f.GetType().Name, StringComparer.OrdinalIgnoreCase))
|
||||||
|
{
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Include MediaTypes
|
||||||
|
if (mediaTypes.Count > 0 && !mediaTypes.Contains(f.MediaType ?? string.Empty, StringComparer.OrdinalIgnoreCase))
|
||||||
|
{
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
private IEnumerable<BaseItem> GetAllItems(IEnumerable<BaseItem> items)
|
||||||
|
{
|
||||||
|
return items
|
||||||
|
.Select(i => i.ProductionYear ?? 0)
|
||||||
|
.Where(i => i > 0)
|
||||||
|
.Distinct()
|
||||||
|
.Select(year => _libraryManager.GetYear(year));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
|
@ -3,6 +3,7 @@ using System.Linq;
|
||||||
using Jellyfin.Data.Enums;
|
using Jellyfin.Data.Enums;
|
||||||
using MediaBrowser.Controller.Net;
|
using MediaBrowser.Controller.Net;
|
||||||
using MediaBrowser.Controller.Session;
|
using MediaBrowser.Controller.Session;
|
||||||
|
using MediaBrowser.Model.Entities;
|
||||||
using Microsoft.AspNetCore.Http;
|
using Microsoft.AspNetCore.Http;
|
||||||
|
|
||||||
namespace Jellyfin.Api.Helpers
|
namespace Jellyfin.Api.Helpers
|
||||||
|
@ -91,5 +92,45 @@ namespace Jellyfin.Api.Helpers
|
||||||
.Select(i => new Guid(i))
|
.Select(i => new Guid(i))
|
||||||
.ToArray();
|
.ToArray();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Get orderby.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="sortBy">Sort by.</param>
|
||||||
|
/// <param name="requestedSortOrder">Sort order.</param>
|
||||||
|
/// <returns>Resulting order by.</returns>
|
||||||
|
internal static ValueTuple<string, SortOrder>[] GetOrderBy(string sortBy, string requestedSortOrder)
|
||||||
|
{
|
||||||
|
var val = sortBy;
|
||||||
|
|
||||||
|
if (string.IsNullOrEmpty(val))
|
||||||
|
{
|
||||||
|
return Array.Empty<ValueTuple<string, SortOrder>>();
|
||||||
|
}
|
||||||
|
|
||||||
|
var vals = val.Split(',');
|
||||||
|
if (string.IsNullOrWhiteSpace(requestedSortOrder))
|
||||||
|
{
|
||||||
|
requestedSortOrder = "Ascending";
|
||||||
|
}
|
||||||
|
|
||||||
|
var sortOrders = requestedSortOrder.Split(',');
|
||||||
|
|
||||||
|
var result = new ValueTuple<string, SortOrder>[vals.Length];
|
||||||
|
|
||||||
|
for (var i = 0; i < vals.Length; i++)
|
||||||
|
{
|
||||||
|
var sortOrderIndex = sortOrders.Length > i ? i : 0;
|
||||||
|
|
||||||
|
var sortOrderValue = sortOrders.Length > sortOrderIndex ? sortOrders[sortOrderIndex] : null;
|
||||||
|
var sortOrder = string.Equals(sortOrderValue, "Descending", StringComparison.OrdinalIgnoreCase)
|
||||||
|
? SortOrder.Descending
|
||||||
|
: SortOrder.Ascending;
|
||||||
|
|
||||||
|
result[i] = new ValueTuple<string, SortOrder>(vals[i], sortOrder);
|
||||||
|
}
|
||||||
|
|
||||||
|
return result;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,131 +0,0 @@
|
||||||
using System;
|
|
||||||
using System.Collections.Generic;
|
|
||||||
using System.Linq;
|
|
||||||
using MediaBrowser.Controller.Configuration;
|
|
||||||
using MediaBrowser.Controller.Dto;
|
|
||||||
using MediaBrowser.Controller.Entities;
|
|
||||||
using MediaBrowser.Controller.Library;
|
|
||||||
using MediaBrowser.Controller.Net;
|
|
||||||
using MediaBrowser.Model.Dto;
|
|
||||||
using MediaBrowser.Model.Services;
|
|
||||||
using Microsoft.Extensions.Logging;
|
|
||||||
|
|
||||||
namespace MediaBrowser.Api.UserLibrary
|
|
||||||
{
|
|
||||||
/// <summary>
|
|
||||||
/// Class GetYears
|
|
||||||
/// </summary>
|
|
||||||
[Route("/Years", "GET", Summary = "Gets all years from a given item, folder, or the entire library")]
|
|
||||||
public class GetYears : GetItemsByName
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Class GetYear
|
|
||||||
/// </summary>
|
|
||||||
[Route("/Years/{Year}", "GET", Summary = "Gets a year")]
|
|
||||||
public class GetYear : IReturn<BaseItemDto>
|
|
||||||
{
|
|
||||||
/// <summary>
|
|
||||||
/// Gets or sets the year.
|
|
||||||
/// </summary>
|
|
||||||
/// <value>The year.</value>
|
|
||||||
[ApiMember(Name = "Year", Description = "The year", IsRequired = true, DataType = "int", ParameterType = "path", Verb = "GET")]
|
|
||||||
public int Year { get; set; }
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets or sets the user id.
|
|
||||||
/// </summary>
|
|
||||||
/// <value>The user id.</value>
|
|
||||||
[ApiMember(Name = "UserId", Description = "Optional. Filter by user id, and attach user data", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
||||||
public Guid UserId { get; set; }
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Class YearsService
|
|
||||||
/// </summary>
|
|
||||||
[Authenticated]
|
|
||||||
public class YearsService : BaseItemsByNameService<Year>
|
|
||||||
{
|
|
||||||
public YearsService(
|
|
||||||
ILogger<YearsService> logger,
|
|
||||||
IServerConfigurationManager serverConfigurationManager,
|
|
||||||
IHttpResultFactory httpResultFactory,
|
|
||||||
IUserManager userManager,
|
|
||||||
ILibraryManager libraryManager,
|
|
||||||
IUserDataManager userDataRepository,
|
|
||||||
IDtoService dtoService,
|
|
||||||
IAuthorizationContext authorizationContext)
|
|
||||||
: base(
|
|
||||||
logger,
|
|
||||||
serverConfigurationManager,
|
|
||||||
httpResultFactory,
|
|
||||||
userManager,
|
|
||||||
libraryManager,
|
|
||||||
userDataRepository,
|
|
||||||
dtoService,
|
|
||||||
authorizationContext)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the specified request.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The request.</param>
|
|
||||||
/// <returns>System.Object.</returns>
|
|
||||||
public object Get(GetYear request)
|
|
||||||
{
|
|
||||||
var result = GetItem(request);
|
|
||||||
|
|
||||||
return ToOptimizedResult(result);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the item.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The request.</param>
|
|
||||||
/// <returns>Task{BaseItemDto}.</returns>
|
|
||||||
private BaseItemDto GetItem(GetYear request)
|
|
||||||
{
|
|
||||||
var item = LibraryManager.GetYear(request.Year);
|
|
||||||
|
|
||||||
var dtoOptions = GetDtoOptions(AuthorizationContext, request);
|
|
||||||
|
|
||||||
if (!request.UserId.Equals(Guid.Empty))
|
|
||||||
{
|
|
||||||
var user = UserManager.GetUserById(request.UserId);
|
|
||||||
|
|
||||||
return DtoService.GetBaseItemDto(item, dtoOptions, user);
|
|
||||||
}
|
|
||||||
|
|
||||||
return DtoService.GetBaseItemDto(item, dtoOptions);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the specified request.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The request.</param>
|
|
||||||
/// <returns>System.Object.</returns>
|
|
||||||
public object Get(GetYears request)
|
|
||||||
{
|
|
||||||
var result = GetResult(request);
|
|
||||||
|
|
||||||
return ToOptimizedResult(result);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets all items.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The request.</param>
|
|
||||||
/// <param name="items">The items.</param>
|
|
||||||
/// <returns>IEnumerable{Tuple{System.StringFunc{System.Int32}}}.</returns>
|
|
||||||
protected override IEnumerable<BaseItem> GetAllItems(GetItemsByName request, IList<BaseItem> items)
|
|
||||||
{
|
|
||||||
return items
|
|
||||||
.Select(i => i.ProductionYear ?? 0)
|
|
||||||
.Where(i => i > 0)
|
|
||||||
.Distinct()
|
|
||||||
.Select(year => LibraryManager.GetYear(year));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
Loading…
Reference in New Issue