| | | 1 | | using System; |
| | | 2 | | using System.ComponentModel.DataAnnotations; |
| | | 3 | | using Jellyfin.Api.Extensions; |
| | | 4 | | using Jellyfin.Api.Helpers; |
| | | 5 | | using Jellyfin.Api.ModelBinders; |
| | | 6 | | using Jellyfin.Data.Enums; |
| | | 7 | | using Jellyfin.Database.Implementations.Entities; |
| | | 8 | | using Jellyfin.Database.Implementations.Enums; |
| | | 9 | | using Jellyfin.Extensions; |
| | | 10 | | using MediaBrowser.Controller.Dto; |
| | | 11 | | using MediaBrowser.Controller.Entities; |
| | | 12 | | using MediaBrowser.Controller.Library; |
| | | 13 | | using MediaBrowser.Model.Dto; |
| | | 14 | | using MediaBrowser.Model.Querying; |
| | | 15 | | using Microsoft.AspNetCore.Authorization; |
| | | 16 | | using Microsoft.AspNetCore.Http; |
| | | 17 | | using Microsoft.AspNetCore.Mvc; |
| | | 18 | | |
| | | 19 | | namespace Jellyfin.Api.Controllers; |
| | | 20 | | |
| | | 21 | | /// <summary> |
| | | 22 | | /// The suggestions controller. |
| | | 23 | | /// </summary> |
| | | 24 | | [Route("")] |
| | | 25 | | [Authorize] |
| | | 26 | | [Tags("Suggestion")] |
| | | 27 | | public class SuggestionsController : BaseJellyfinApiController |
| | | 28 | | { |
| | | 29 | | private readonly IDtoService _dtoService; |
| | | 30 | | private readonly IUserManager _userManager; |
| | | 31 | | private readonly ILibraryManager _libraryManager; |
| | | 32 | | |
| | | 33 | | /// <summary> |
| | | 34 | | /// Initializes a new instance of the <see cref="SuggestionsController"/> class. |
| | | 35 | | /// </summary> |
| | | 36 | | /// <param name="dtoService">Instance of the <see cref="IDtoService"/> interface.</param> |
| | | 37 | | /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param> |
| | | 38 | | /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param> |
| | 0 | 39 | | public SuggestionsController( |
| | 0 | 40 | | IDtoService dtoService, |
| | 0 | 41 | | IUserManager userManager, |
| | 0 | 42 | | ILibraryManager libraryManager) |
| | | 43 | | { |
| | 0 | 44 | | _dtoService = dtoService; |
| | 0 | 45 | | _userManager = userManager; |
| | 0 | 46 | | _libraryManager = libraryManager; |
| | 0 | 47 | | } |
| | | 48 | | |
| | | 49 | | /// <summary> |
| | | 50 | | /// Gets suggestions. |
| | | 51 | | /// </summary> |
| | | 52 | | /// <param name="userId">The user id.</param> |
| | | 53 | | /// <param name="mediaType">The media types.</param> |
| | | 54 | | /// <param name="type">The type.</param> |
| | | 55 | | /// <param name="startIndex">Optional. The start index.</param> |
| | | 56 | | /// <param name="limit">Optional. The limit.</param> |
| | | 57 | | /// <param name="enableTotalRecordCount">Whether to enable the total record count.</param> |
| | | 58 | | /// <response code="200">Suggestions returned.</response> |
| | | 59 | | /// <returns>A <see cref="QueryResult{BaseItemDto}"/> with the suggestions.</returns> |
| | | 60 | | [HttpGet("Items/Suggestions")] |
| | | 61 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 62 | | public ActionResult<QueryResult<BaseItemDto>> GetSuggestions( |
| | | 63 | | [FromQuery] Guid? userId, |
| | | 64 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] MediaType[] mediaType, |
| | | 65 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] type, |
| | | 66 | | [FromQuery] int? startIndex, |
| | | 67 | | [FromQuery] int? limit, |
| | | 68 | | [FromQuery] bool enableTotalRecordCount = false) |
| | | 69 | | { |
| | | 70 | | User? user; |
| | 0 | 71 | | if (userId.IsNullOrEmpty()) |
| | | 72 | | { |
| | 0 | 73 | | user = null; |
| | | 74 | | } |
| | | 75 | | else |
| | | 76 | | { |
| | 0 | 77 | | var requestUserId = RequestHelpers.GetUserId(User, userId); |
| | 0 | 78 | | user = _userManager.GetUserById(requestUserId); |
| | | 79 | | } |
| | | 80 | | |
| | 0 | 81 | | var dtoOptions = new DtoOptions(); |
| | 0 | 82 | | var result = _libraryManager.GetItemsResult(new InternalItemsQuery(user) |
| | 0 | 83 | | { |
| | 0 | 84 | | OrderBy = new[] { (ItemSortBy.Random, SortOrder.Descending) }, |
| | 0 | 85 | | MediaTypes = mediaType, |
| | 0 | 86 | | IncludeItemTypes = type, |
| | 0 | 87 | | IsVirtualItem = false, |
| | 0 | 88 | | StartIndex = startIndex, |
| | 0 | 89 | | Limit = limit, |
| | 0 | 90 | | DtoOptions = dtoOptions, |
| | 0 | 91 | | EnableTotalRecordCount = enableTotalRecordCount, |
| | 0 | 92 | | Recursive = true |
| | 0 | 93 | | }); |
| | | 94 | | |
| | 0 | 95 | | var dtoList = _dtoService.GetBaseItemDtos(result.Items, dtoOptions, user); |
| | | 96 | | |
| | 0 | 97 | | return new QueryResult<BaseItemDto>( |
| | 0 | 98 | | startIndex, |
| | 0 | 99 | | result.TotalRecordCount, |
| | 0 | 100 | | dtoList); |
| | | 101 | | } |
| | | 102 | | |
| | | 103 | | /// <summary> |
| | | 104 | | /// Gets suggestions. |
| | | 105 | | /// </summary> |
| | | 106 | | /// <param name="userId">The user id.</param> |
| | | 107 | | /// <param name="mediaType">The media types.</param> |
| | | 108 | | /// <param name="type">The type.</param> |
| | | 109 | | /// <param name="startIndex">Optional. The start index.</param> |
| | | 110 | | /// <param name="limit">Optional. The limit.</param> |
| | | 111 | | /// <param name="enableTotalRecordCount">Whether to enable the total record count.</param> |
| | | 112 | | /// <response code="200">Suggestions returned.</response> |
| | | 113 | | /// <returns>A <see cref="QueryResult{BaseItemDto}"/> with the suggestions.</returns> |
| | | 114 | | [HttpGet("Users/{userId}/Suggestions")] |
| | | 115 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 116 | | [Obsolete("Kept for backwards compatibility")] |
| | | 117 | | [ApiExplorerSettings(IgnoreApi = true)] |
| | | 118 | | public ActionResult<QueryResult<BaseItemDto>> GetSuggestionsLegacy( |
| | | 119 | | [FromRoute, Required] Guid userId, |
| | | 120 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] MediaType[] mediaType, |
| | | 121 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] type, |
| | | 122 | | [FromQuery] int? startIndex, |
| | | 123 | | [FromQuery] int? limit, |
| | | 124 | | [FromQuery] bool enableTotalRecordCount = false) |
| | | 125 | | => GetSuggestions(userId, mediaType, type, startIndex, limit, enableTotalRecordCount); |
| | | 126 | | } |