| | | 1 | | using System; |
| | | 2 | | using System.ComponentModel.DataAnnotations; |
| | | 3 | | using System.Linq; |
| | | 4 | | using Jellyfin.Api.Extensions; |
| | | 5 | | using Jellyfin.Api.Helpers; |
| | | 6 | | using Jellyfin.Api.ModelBinders; |
| | | 7 | | using Jellyfin.Database.Implementations.Entities; |
| | | 8 | | using Jellyfin.Extensions; |
| | | 9 | | using MediaBrowser.Controller.Dto; |
| | | 10 | | using MediaBrowser.Controller.Entities; |
| | | 11 | | using MediaBrowser.Controller.Library; |
| | | 12 | | using MediaBrowser.Model.Dto; |
| | | 13 | | using MediaBrowser.Model.Entities; |
| | | 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 | | /// Persons controller. |
| | | 23 | | /// </summary> |
| | | 24 | | [Authorize] |
| | | 25 | | [Tags("Person")] |
| | | 26 | | public class PersonsController : BaseJellyfinApiController |
| | | 27 | | { |
| | | 28 | | private readonly ILibraryManager _libraryManager; |
| | | 29 | | private readonly IDtoService _dtoService; |
| | | 30 | | private readonly IUserManager _userManager; |
| | | 31 | | |
| | | 32 | | /// <summary> |
| | | 33 | | /// Initializes a new instance of the <see cref="PersonsController"/> class. |
| | | 34 | | /// </summary> |
| | | 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 | | /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param> |
| | 1 | 38 | | public PersonsController( |
| | 1 | 39 | | ILibraryManager libraryManager, |
| | 1 | 40 | | IDtoService dtoService, |
| | 1 | 41 | | IUserManager userManager) |
| | | 42 | | { |
| | 1 | 43 | | _libraryManager = libraryManager; |
| | 1 | 44 | | _dtoService = dtoService; |
| | 1 | 45 | | _userManager = userManager; |
| | 1 | 46 | | } |
| | | 47 | | |
| | | 48 | | /// <summary> |
| | | 49 | | /// Gets all persons. |
| | | 50 | | /// </summary> |
| | | 51 | | /// <param name="startIndex">Optional. All items with a lower index will be dropped from the response.</param> |
| | | 52 | | /// <param name="limit">Optional. The maximum number of records to return.</param> |
| | | 53 | | /// <param name="searchTerm">The search term.</param> |
| | | 54 | | /// <param name="nameStartsWith">Optional. Filter by items whose name starts with the given input string.</param> |
| | | 55 | | /// <param name="nameLessThan">Optional. Filter by items whose name will appear before this value when sorted alphab |
| | | 56 | | /// <param name="nameStartsWithOrGreater">Optional. Filter by items whose name will appear after this value when sor |
| | | 57 | | /// <param name="fields">Optional. Specify additional fields of information to return in the output.</param> |
| | | 58 | | /// <param name="filters">Optional. Specify additional filters to apply.</param> |
| | | 59 | | /// <param name="isFavorite">Optional filter by items that are marked as favorite, or not. userId is required.</para |
| | | 60 | | /// <param name="enableUserData">Optional, include user data.</param> |
| | | 61 | | /// <param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param> |
| | | 62 | | /// <param name="enableImageTypes">Optional. The image types to include in the output.</param> |
| | | 63 | | /// <param name="excludePersonTypes">Optional. If specified results will be filtered to exclude those containing the |
| | | 64 | | /// <param name="personTypes">Optional. If specified results will be filtered to include only those containing the s |
| | | 65 | | /// <param name="parentId">Optional. Specify this to localize the search to a specific library. Omit to use the root |
| | | 66 | | /// <param name="appearsInItemId">Optional. If specified, person results will be filtered on items related to said p |
| | | 67 | | /// <param name="userId">User id.</param> |
| | | 68 | | /// <param name="enableImages">Optional, include image information in output.</param> |
| | | 69 | | /// <response code="200">Persons returned.</response> |
| | | 70 | | /// <returns>An <see cref="OkResult"/> containing the queryresult of persons.</returns> |
| | | 71 | | [HttpGet] |
| | | 72 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 73 | | public ActionResult<QueryResult<BaseItemDto>> GetPersons( |
| | | 74 | | [FromQuery] int? startIndex, |
| | | 75 | | [FromQuery] int? limit, |
| | | 76 | | [FromQuery] string? searchTerm, |
| | | 77 | | [FromQuery] string? nameStartsWith, |
| | | 78 | | [FromQuery] string? nameLessThan, |
| | | 79 | | [FromQuery] string? nameStartsWithOrGreater, |
| | | 80 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemFields[] fields, |
| | | 81 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemFilter[] filters, |
| | | 82 | | [FromQuery] bool? isFavorite, |
| | | 83 | | [FromQuery] bool? enableUserData, |
| | | 84 | | [FromQuery] int? imageTypeLimit, |
| | | 85 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ImageType[] enableImageTypes, |
| | | 86 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] string[] excludePersonTypes, |
| | | 87 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] string[] personTypes, |
| | | 88 | | [FromQuery] Guid? parentId, |
| | | 89 | | [FromQuery] Guid? appearsInItemId, |
| | | 90 | | [FromQuery] Guid? userId, |
| | | 91 | | [FromQuery] bool? enableImages = true) |
| | | 92 | | { |
| | 0 | 93 | | userId = RequestHelpers.GetUserId(User, userId); |
| | 0 | 94 | | var dtoOptions = new DtoOptions { Fields = fields } |
| | 0 | 95 | | .AddAdditionalDtoOptions(enableImages, enableUserData, imageTypeLimit, enableImageTypes); |
| | | 96 | | |
| | 0 | 97 | | User? user = userId.IsNullOrEmpty() |
| | 0 | 98 | | ? null |
| | 0 | 99 | | : _userManager.GetUserById(userId.Value); |
| | | 100 | | |
| | 0 | 101 | | var isFavoriteInFilters = filters.Any(f => f == ItemFilter.IsFavorite); |
| | 0 | 102 | | var peopleItems = _libraryManager.GetPeopleItems(new InternalPeopleQuery( |
| | 0 | 103 | | personTypes, |
| | 0 | 104 | | excludePersonTypes) |
| | 0 | 105 | | { |
| | 0 | 106 | | NameContains = searchTerm, |
| | 0 | 107 | | NameStartsWith = nameStartsWith, |
| | 0 | 108 | | NameLessThan = nameLessThan, |
| | 0 | 109 | | NameStartsWithOrGreater = nameStartsWithOrGreater, |
| | 0 | 110 | | User = user, |
| | 0 | 111 | | IsFavorite = !isFavorite.HasValue && isFavoriteInFilters ? true : isFavorite, |
| | 0 | 112 | | AppearsInItemId = appearsInItemId ?? Guid.Empty, |
| | 0 | 113 | | ParentId = parentId, |
| | 0 | 114 | | StartIndex = startIndex, |
| | 0 | 115 | | Limit = limit ?? 0 |
| | 0 | 116 | | }); |
| | | 117 | | |
| | 0 | 118 | | return new QueryResult<BaseItemDto>( |
| | 0 | 119 | | peopleItems.StartIndex, |
| | 0 | 120 | | peopleItems.TotalRecordCount, |
| | 0 | 121 | | peopleItems.Items |
| | 0 | 122 | | .Select(person => _dtoService.GetItemByNameDto(person, dtoOptions, null, user)) |
| | 0 | 123 | | .ToArray()); |
| | | 124 | | } |
| | | 125 | | |
| | | 126 | | /// <summary> |
| | | 127 | | /// Get person by name. |
| | | 128 | | /// </summary> |
| | | 129 | | /// <param name="name">Person name.</param> |
| | | 130 | | /// <param name="userId">Optional. Filter by user id, and attach user data.</param> |
| | | 131 | | /// <response code="200">Person returned.</response> |
| | | 132 | | /// <response code="404">Person not found.</response> |
| | | 133 | | /// <returns>An <see cref="OkResult"/> containing the person on success, |
| | | 134 | | /// or a <see cref="NotFoundResult"/> if person not found.</returns> |
| | | 135 | | [HttpGet("{name}")] |
| | | 136 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 137 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 138 | | public ActionResult<BaseItemDto> GetPerson([FromRoute, Required] string name, [FromQuery] Guid? userId) |
| | | 139 | | { |
| | 1 | 140 | | userId = RequestHelpers.GetUserId(User, userId); |
| | 1 | 141 | | var dtoOptions = new DtoOptions(); |
| | | 142 | | |
| | 1 | 143 | | var item = _libraryManager.GetPerson(name); |
| | 1 | 144 | | if (item is null) |
| | | 145 | | { |
| | 1 | 146 | | return NotFound(); |
| | | 147 | | } |
| | | 148 | | |
| | 0 | 149 | | if (!userId.IsNullOrEmpty()) |
| | | 150 | | { |
| | 0 | 151 | | var user = _userManager.GetUserById(userId.Value); |
| | 0 | 152 | | return _dtoService.GetBaseItemDto(item, dtoOptions, user); |
| | | 153 | | } |
| | | 154 | | |
| | 0 | 155 | | return _dtoService.GetBaseItemDto(item, dtoOptions); |
| | | 156 | | } |
| | | 157 | | } |