GenresController.cs 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  1. using System;
  2. using System.ComponentModel.DataAnnotations;
  3. using System.Linq;
  4. using Jellyfin.Api.Constants;
  5. using Jellyfin.Api.Extensions;
  6. using Jellyfin.Api.Helpers;
  7. using Jellyfin.Api.ModelBinders;
  8. using Jellyfin.Data.Entities;
  9. using Jellyfin.Data.Enums;
  10. using MediaBrowser.Controller.Dto;
  11. using MediaBrowser.Controller.Entities;
  12. using MediaBrowser.Controller.Library;
  13. using MediaBrowser.Model.Dto;
  14. using MediaBrowser.Model.Entities;
  15. using MediaBrowser.Model.Querying;
  16. using Microsoft.AspNetCore.Authorization;
  17. using Microsoft.AspNetCore.Http;
  18. using Microsoft.AspNetCore.Mvc;
  19. using Genre = MediaBrowser.Controller.Entities.Genre;
  20. namespace Jellyfin.Api.Controllers
  21. {
  22. /// <summary>
  23. /// The genres controller.
  24. /// </summary>
  25. [Authorize(Policy = Policies.DefaultAuthorization)]
  26. public class GenresController : BaseJellyfinApiController
  27. {
  28. private readonly IUserManager _userManager;
  29. private readonly ILibraryManager _libraryManager;
  30. private readonly IDtoService _dtoService;
  31. /// <summary>
  32. /// Initializes a new instance of the <see cref="GenresController"/> class.
  33. /// </summary>
  34. /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
  35. /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
  36. /// <param name="dtoService">Instance of the <see cref="IDtoService"/> interface.</param>
  37. public GenresController(
  38. IUserManager userManager,
  39. ILibraryManager libraryManager,
  40. IDtoService dtoService)
  41. {
  42. _userManager = userManager;
  43. _libraryManager = libraryManager;
  44. _dtoService = dtoService;
  45. }
  46. /// <summary>
  47. /// Gets all genres from a given item, folder, or the entire library.
  48. /// </summary>
  49. /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
  50. /// <param name="limit">Optional. The maximum number of records to return.</param>
  51. /// <param name="searchTerm">The search term.</param>
  52. /// <param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
  53. /// <param name="fields">Optional. Specify additional fields of information to return in the output.</param>
  54. /// <param name="excludeItemTypes">Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.</param>
  55. /// <param name="includeItemTypes">Optional. If specified, results will be filtered in based on item type. This allows multiple, comma delimited.</param>
  56. /// <param name="isFavorite">Optional filter by items that are marked as favorite, or not.</param>
  57. /// <param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param>
  58. /// <param name="enableImageTypes">Optional. The image types to include in the output.</param>
  59. /// <param name="userId">User id.</param>
  60. /// <param name="nameStartsWithOrGreater">Optional filter by items whose name is sorted equally or greater than a given input string.</param>
  61. /// <param name="nameStartsWith">Optional filter by items whose name is sorted equally than a given input string.</param>
  62. /// <param name="nameLessThan">Optional filter by items whose name is equally or lesser than a given input string.</param>
  63. /// <param name="sortBy">Optional. Specify one or more sort orders, comma delimited.</param>
  64. /// <param name="sortOrder">Sort Order - Ascending,Descending.</param>
  65. /// <param name="enableImages">Optional, include image information in output.</param>
  66. /// <param name="enableTotalRecordCount">Optional. Include total record count.</param>
  67. /// <response code="200">Genres returned.</response>
  68. /// <returns>An <see cref="OkResult"/> containing the queryresult of genres.</returns>
  69. [HttpGet]
  70. [ProducesResponseType(StatusCodes.Status200OK)]
  71. public ActionResult<QueryResult<BaseItemDto>> GetGenres(
  72. [FromQuery] int? startIndex,
  73. [FromQuery] int? limit,
  74. [FromQuery] string? searchTerm,
  75. [FromQuery] Guid? parentId,
  76. [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ItemFields[] fields,
  77. [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] BaseItemKind[] excludeItemTypes,
  78. [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] BaseItemKind[] includeItemTypes,
  79. [FromQuery] bool? isFavorite,
  80. [FromQuery] int? imageTypeLimit,
  81. [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ImageType[] enableImageTypes,
  82. [FromQuery] Guid? userId,
  83. [FromQuery] string? nameStartsWithOrGreater,
  84. [FromQuery] string? nameStartsWith,
  85. [FromQuery] string? nameLessThan,
  86. [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] string[] sortBy,
  87. [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] SortOrder[] sortOrder,
  88. [FromQuery] bool? enableImages = true,
  89. [FromQuery] bool enableTotalRecordCount = true)
  90. {
  91. var dtoOptions = new DtoOptions { Fields = fields }
  92. .AddClientFields(Request)
  93. .AddAdditionalDtoOptions(enableImages, false, imageTypeLimit, enableImageTypes);
  94. User? user = userId.HasValue && userId != Guid.Empty ? _userManager.GetUserById(userId.Value) : null;
  95. var parentItem = _libraryManager.GetParentItem(parentId, userId);
  96. var query = new InternalItemsQuery(user)
  97. {
  98. ExcludeItemTypes = RequestHelpers.GetItemTypeStrings(excludeItemTypes),
  99. IncludeItemTypes = RequestHelpers.GetItemTypeStrings(includeItemTypes),
  100. StartIndex = startIndex,
  101. Limit = limit,
  102. IsFavorite = isFavorite,
  103. NameLessThan = nameLessThan,
  104. NameStartsWith = nameStartsWith,
  105. NameStartsWithOrGreater = nameStartsWithOrGreater,
  106. DtoOptions = dtoOptions,
  107. SearchTerm = searchTerm,
  108. EnableTotalRecordCount = enableTotalRecordCount,
  109. OrderBy = RequestHelpers.GetOrderBy(sortBy, sortOrder)
  110. };
  111. if (parentId.HasValue)
  112. {
  113. if (parentItem is Folder)
  114. {
  115. query.AncestorIds = new[] { parentId.Value };
  116. }
  117. else
  118. {
  119. query.ItemIds = new[] { parentId.Value };
  120. }
  121. }
  122. QueryResult<(BaseItem, ItemCounts)> result;
  123. if (parentItem is ICollectionFolder parentCollectionFolder
  124. && (string.Equals(parentCollectionFolder.CollectionType, CollectionType.Music, StringComparison.Ordinal)
  125. || string.Equals(parentCollectionFolder.CollectionType, CollectionType.MusicVideos, StringComparison.Ordinal)))
  126. {
  127. result = _libraryManager.GetMusicGenres(query);
  128. }
  129. else
  130. {
  131. result = _libraryManager.GetGenres(query);
  132. }
  133. var shouldIncludeItemTypes = includeItemTypes.Length != 0;
  134. return RequestHelpers.CreateQueryResult(result, dtoOptions, _dtoService, shouldIncludeItemTypes, user);
  135. }
  136. /// <summary>
  137. /// Gets a genre, by name.
  138. /// </summary>
  139. /// <param name="genreName">The genre name.</param>
  140. /// <param name="userId">The user id.</param>
  141. /// <response code="200">Genres returned.</response>
  142. /// <returns>An <see cref="OkResult"/> containing the genre.</returns>
  143. [HttpGet("{genreName}")]
  144. [ProducesResponseType(StatusCodes.Status200OK)]
  145. public ActionResult<BaseItemDto> GetGenre([FromRoute, Required] string genreName, [FromQuery] Guid? userId)
  146. {
  147. var dtoOptions = new DtoOptions()
  148. .AddClientFields(Request);
  149. Genre item = new Genre();
  150. if (genreName.IndexOf(BaseItem.SlugChar, StringComparison.OrdinalIgnoreCase) != -1)
  151. {
  152. var result = GetItemFromSlugName<Genre>(_libraryManager, genreName, dtoOptions);
  153. if (result != null)
  154. {
  155. item = result;
  156. }
  157. }
  158. else
  159. {
  160. item = _libraryManager.GetGenre(genreName);
  161. }
  162. if (userId.HasValue && !userId.Equals(Guid.Empty))
  163. {
  164. var user = _userManager.GetUserById(userId.Value);
  165. return _dtoService.GetBaseItemDto(item, dtoOptions, user);
  166. }
  167. return _dtoService.GetBaseItemDto(item, dtoOptions);
  168. }
  169. private T? GetItemFromSlugName<T>(ILibraryManager libraryManager, string name, DtoOptions dtoOptions)
  170. where T : BaseItem, new()
  171. {
  172. var result = libraryManager.GetItemList(new InternalItemsQuery
  173. {
  174. Name = name.Replace(BaseItem.SlugChar, '&'),
  175. IncludeItemTypes = new[] { typeof(T).Name },
  176. DtoOptions = dtoOptions
  177. }).OfType<T>().FirstOrDefault();
  178. result ??= libraryManager.GetItemList(new InternalItemsQuery
  179. {
  180. Name = name.Replace(BaseItem.SlugChar, '/'),
  181. IncludeItemTypes = new[] { typeof(T).Name },
  182. DtoOptions = dtoOptions
  183. }).OfType<T>().FirstOrDefault();
  184. result ??= libraryManager.GetItemList(new InternalItemsQuery
  185. {
  186. Name = name.Replace(BaseItem.SlugChar, '?'),
  187. IncludeItemTypes = new[] { typeof(T).Name },
  188. DtoOptions = dtoOptions
  189. }).OfType<T>().FirstOrDefault();
  190. return result;
  191. }
  192. }
  193. }