jellyfin/MediaBrowser.Api/UserLibrary/YearsService.cs

132 lines
4.2 KiB
C#
Raw Normal View History

using System;
using System.Collections.Generic;
using System.Linq;
using MediaBrowser.Controller.Configuration;
using MediaBrowser.Controller.Dto;
2013-04-22 04:38:03 +00:00
using MediaBrowser.Controller.Entities;
using MediaBrowser.Controller.Library;
2014-07-02 18:34:08 +00:00
using MediaBrowser.Controller.Net;
2013-04-22 04:38:03 +00:00
using MediaBrowser.Model.Dto;
2016-10-25 19:02:04 +00:00
using MediaBrowser.Model.Services;
using Microsoft.Extensions.Logging;
2013-02-21 01:33:05 +00:00
namespace MediaBrowser.Api.UserLibrary
{
/// <summary>
/// Class GetYears
/// </summary>
[Route("/Years", "GET", Summary = "Gets all years from a given item, folder, or the entire library")]
2013-02-21 01:33:05 +00:00
public class GetYears : GetItemsByName
{
}
2013-04-22 04:38:03 +00:00
/// <summary>
/// Class GetYear
/// </summary>
[Route("/Years/{Year}", "GET", Summary = "Gets a year")]
2013-04-22 04:38:03 +00:00
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")]
2018-09-12 17:26:21 +00:00
public Guid UserId { get; set; }
2013-04-22 04:38:03 +00:00
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Class YearsService
/// </summary>
2014-07-02 18:34:08 +00:00
[Authenticated]
2013-02-21 01:33:05 +00:00
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)
{
}
2013-04-22 04:38:03 +00:00
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
public object Get(GetYear request)
{
2013-09-17 02:44:06 +00:00
var result = GetItem(request);
2013-04-22 04:38:03 +00:00
2018-09-12 17:26:21 +00:00
return ToOptimizedResult(result);
2013-04-22 04:38:03 +00:00
}
/// <summary>
/// Gets the item.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Task{BaseItemDto}.</returns>
2013-09-17 02:44:06 +00:00
private BaseItemDto GetItem(GetYear request)
2013-04-22 04:38:03 +00:00
{
var item = LibraryManager.GetYear(request.Year);
2019-01-07 23:27:46 +00:00
2016-11-10 14:41:24 +00:00
var dtoOptions = GetDtoOptions(AuthorizationContext, request);
2018-09-12 17:26:21 +00:00
if (!request.UserId.Equals(Guid.Empty))
2013-04-22 04:38:03 +00:00
{
2015-05-29 23:51:33 +00:00
var user = UserManager.GetUserById(request.UserId);
2013-04-22 04:38:03 +00:00
2014-12-27 05:08:39 +00:00
return DtoService.GetBaseItemDto(item, dtoOptions, user);
2013-04-22 04:38:03 +00:00
}
2014-12-27 05:08:39 +00:00
return DtoService.GetBaseItemDto(item, dtoOptions);
2013-04-22 04:38:03 +00:00
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
public object Get(GetYears request)
{
2013-09-27 12:24:28 +00:00
var result = GetResult(request);
2013-02-21 01:33:05 +00:00
2018-09-12 17:26:21 +00:00
return ToOptimizedResult(result);
2013-02-21 01:33:05 +00:00
}
/// <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>
2017-08-24 19:52:19 +00:00
protected override IEnumerable<BaseItem> GetAllItems(GetItemsByName request, IList<BaseItem> items)
2013-02-21 01:33:05 +00:00
{
2017-08-24 19:52:19 +00:00
return items
2014-01-16 17:56:50 +00:00
.Select(i => i.ProductionYear ?? 0)
.Where(i => i > 0)
2013-02-21 01:33:05 +00:00
.Distinct()
.Select(year => LibraryManager.GetYear(year));
2013-02-21 01:33:05 +00:00
}
}
}