jellyfin-server/MediaBrowser.Api/UserLibrary/GenresService.cs

141 lines
4.6 KiB
C#
Raw Normal View History

using System;
using System.Collections.Generic;
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;
using MediaBrowser.Model.Dto;
2015-08-15 03:15:25 +00:00
using MediaBrowser.Model.Entities;
2016-06-17 13:06:13 +00:00
using MediaBrowser.Model.Querying;
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 GetGenres
/// </summary>
2014-11-15 02:31:03 +00:00
[Route("/Genres", "GET", Summary = "Gets all genres from a given item, folder, or the entire library")]
2013-02-21 01:33:05 +00:00
public class GetGenres : GetItemsByName
{
}
2013-04-22 04:38:03 +00:00
/// <summary>
/// Class GetGenre
/// </summary>
2014-11-15 02:31:03 +00:00
[Route("/Genres/{Name}", "GET", Summary = "Gets a genre, by name")]
2013-04-22 04:38:03 +00:00
public class GetGenre : IReturn<BaseItemDto>
{
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
[ApiMember(Name = "Name", Description = "The genre name", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
public string Name { 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 GenresService
/// </summary>
2014-07-02 18:34:08 +00:00
[Authenticated]
2013-02-21 01:33:05 +00:00
public class GenresService : BaseItemsByNameService<Genre>
{
public GenresService(
ILogger<GenresService> 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>
2013-04-22 04:38:03 +00:00
public object Get(GetGenre request)
{
2013-09-17 02:44:06 +00:00
var result = GetItem(request);
2018-09-12 17:26:21 +00:00
return ToOptimizedResult(result);
2013-04-22 04:38:03 +00:00
}
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(GetGenre request)
2013-04-22 04:38:03 +00:00
{
2017-05-22 04:54:02 +00:00
var dtoOptions = GetDtoOptions(AuthorizationContext, request);
2017-05-22 04:54:02 +00:00
var item = GetGenre(request.Name, LibraryManager, dtoOptions);
2019-01-07 23:27:46 +00:00
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);
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-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(GetGenres request)
{
2016-06-17 13:06:13 +00:00
var result = GetResultSlim(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
}
2019-02-08 23:48:09 +00:00
protected override QueryResult<(BaseItem, ItemCounts)> GetItems(GetItemsByName request, InternalItemsQuery query)
2013-02-21 01:33:05 +00:00
{
2015-08-15 03:15:25 +00:00
var viewType = GetParentItemViewType(request);
if (string.Equals(viewType, CollectionType.Music) || string.Equals(viewType, CollectionType.MusicVideos))
{
2016-06-17 13:06:13 +00:00
return LibraryManager.GetMusicGenres(query);
2015-08-15 03:15:25 +00:00
}
2016-06-17 13:06:13 +00:00
return LibraryManager.GetGenres(query);
}
/// <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)
2016-06-17 13:06:13 +00:00
{
throw new NotImplementedException();
2013-02-21 01:33:05 +00:00
}
}
}