| | | 1 | | using System; |
| | | 2 | | using System.Collections.Generic; |
| | | 3 | | using System.ComponentModel.DataAnnotations; |
| | | 4 | | using System.Linq; |
| | | 5 | | using System.Threading.Tasks; |
| | | 6 | | using Jellyfin.Api.Extensions; |
| | | 7 | | using Jellyfin.Api.Helpers; |
| | | 8 | | using Jellyfin.Api.ModelBinders; |
| | | 9 | | using Jellyfin.Data; |
| | | 10 | | using Jellyfin.Data.Enums; |
| | | 11 | | using Jellyfin.Database.Implementations.Enums; |
| | | 12 | | using Jellyfin.Extensions; |
| | | 13 | | using MediaBrowser.Common.Extensions; |
| | | 14 | | using MediaBrowser.Controller.Dto; |
| | | 15 | | using MediaBrowser.Controller.Entities; |
| | | 16 | | using MediaBrowser.Controller.Entities.Movies; |
| | | 17 | | using MediaBrowser.Controller.Library; |
| | | 18 | | using MediaBrowser.Controller.Playlists; |
| | | 19 | | using MediaBrowser.Controller.Session; |
| | | 20 | | using MediaBrowser.Model.Dto; |
| | | 21 | | using MediaBrowser.Model.Entities; |
| | | 22 | | using MediaBrowser.Model.Globalization; |
| | | 23 | | using MediaBrowser.Model.Querying; |
| | | 24 | | using Microsoft.AspNetCore.Authorization; |
| | | 25 | | using Microsoft.AspNetCore.Http; |
| | | 26 | | using Microsoft.AspNetCore.Mvc; |
| | | 27 | | using Microsoft.Extensions.Logging; |
| | | 28 | | |
| | | 29 | | namespace Jellyfin.Api.Controllers; |
| | | 30 | | |
| | | 31 | | /// <summary> |
| | | 32 | | /// The items controller. |
| | | 33 | | /// </summary> |
| | | 34 | | [Route("")] |
| | | 35 | | [Authorize] |
| | | 36 | | [Tags("Library")] |
| | | 37 | | public class ItemsController : BaseJellyfinApiController |
| | | 38 | | { |
| | | 39 | | private readonly IUserManager _userManager; |
| | | 40 | | private readonly ILibraryManager _libraryManager; |
| | | 41 | | private readonly ILocalizationManager _localization; |
| | | 42 | | private readonly IDtoService _dtoService; |
| | | 43 | | private readonly ILogger<ItemsController> _logger; |
| | | 44 | | private readonly ISessionManager _sessionManager; |
| | | 45 | | private readonly IUserDataManager _userDataRepository; |
| | | 46 | | private readonly ISearchManager _searchManager; |
| | | 47 | | |
| | | 48 | | /// <summary> |
| | | 49 | | /// Initializes a new instance of the <see cref="ItemsController"/> class. |
| | | 50 | | /// </summary> |
| | | 51 | | /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param> |
| | | 52 | | /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param> |
| | | 53 | | /// <param name="localization">Instance of the <see cref="ILocalizationManager"/> interface.</param> |
| | | 54 | | /// <param name="dtoService">Instance of the <see cref="IDtoService"/> interface.</param> |
| | | 55 | | /// <param name="logger">Instance of the <see cref="ILogger"/> interface.</param> |
| | | 56 | | /// <param name="sessionManager">Instance of the <see cref="ISessionManager"/> interface.</param> |
| | | 57 | | /// <param name="userDataRepository">Instance of the <see cref="IUserDataManager"/> interface.</param> |
| | | 58 | | /// <param name="searchManager">Instance of the <see cref="ISearchManager"/> interface.</param> |
| | 6 | 59 | | public ItemsController( |
| | 6 | 60 | | IUserManager userManager, |
| | 6 | 61 | | ILibraryManager libraryManager, |
| | 6 | 62 | | ILocalizationManager localization, |
| | 6 | 63 | | IDtoService dtoService, |
| | 6 | 64 | | ILogger<ItemsController> logger, |
| | 6 | 65 | | ISessionManager sessionManager, |
| | 6 | 66 | | IUserDataManager userDataRepository, |
| | 6 | 67 | | ISearchManager searchManager) |
| | | 68 | | { |
| | 6 | 69 | | _userManager = userManager; |
| | 6 | 70 | | _libraryManager = libraryManager; |
| | 6 | 71 | | _localization = localization; |
| | 6 | 72 | | _dtoService = dtoService; |
| | 6 | 73 | | _logger = logger; |
| | 6 | 74 | | _sessionManager = sessionManager; |
| | 6 | 75 | | _userDataRepository = userDataRepository; |
| | 6 | 76 | | _searchManager = searchManager; |
| | 6 | 77 | | } |
| | | 78 | | |
| | | 79 | | /// <summary> |
| | | 80 | | /// Gets items based on a query. |
| | | 81 | | /// </summary> |
| | | 82 | | /// <param name="userId">The user id supplied as query parameter; this is required when not using an API key.</param |
| | | 83 | | /// <param name="maxOfficialRating">Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).</param> |
| | | 84 | | /// <param name="hasThemeSong">Optional filter by items with theme songs.</param> |
| | | 85 | | /// <param name="hasThemeVideo">Optional filter by items with theme videos.</param> |
| | | 86 | | /// <param name="hasSubtitles">Optional filter by items with subtitles.</param> |
| | | 87 | | /// <param name="hasSpecialFeature">Optional filter by items with special features.</param> |
| | | 88 | | /// <param name="hasTrailer">Optional filter by items with trailers.</param> |
| | | 89 | | /// <param name="adjacentTo">Optional. Return items that are siblings of a supplied item.</param> |
| | | 90 | | /// <param name="indexNumber">Optional filter by index number.</param> |
| | | 91 | | /// <param name="parentIndexNumber">Optional filter by parent index number.</param> |
| | | 92 | | /// <param name="hasParentalRating">Optional filter by items that have or do not have a parental rating.</param> |
| | | 93 | | /// <param name="isHd">Optional filter by items that are HD or not.</param> |
| | | 94 | | /// <param name="is4K">Optional filter by items that are 4K or not.</param> |
| | | 95 | | /// <param name="locationTypes">Optional. If specified, results will be filtered based on LocationType. This allows |
| | | 96 | | /// <param name="excludeLocationTypes">Optional. If specified, results will be filtered based on the LocationType. T |
| | | 97 | | /// <param name="isMissing">Optional filter by items that are missing episodes or not.</param> |
| | | 98 | | /// <param name="isUnaired">Optional filter by items that are unaired episodes or not.</param> |
| | | 99 | | /// <param name="minCommunityRating">Optional filter by minimum community rating.</param> |
| | | 100 | | /// <param name="minCriticRating">Optional filter by minimum critic rating.</param> |
| | | 101 | | /// <param name="minPremiereDate">Optional. The minimum premiere date. Format = ISO.</param> |
| | | 102 | | /// <param name="minDateLastSaved">Optional. The minimum last saved date. Format = ISO.</param> |
| | | 103 | | /// <param name="minDateLastSavedForUser">Optional. The minimum last saved date for the current user. Format = ISO.< |
| | | 104 | | /// <param name="maxPremiereDate">Optional. The maximum premiere date. Format = ISO.</param> |
| | | 105 | | /// <param name="hasOverview">Optional filter by items that have an overview or not.</param> |
| | | 106 | | /// <param name="hasImdbId">Optional filter by items that have an IMDb id or not.</param> |
| | | 107 | | /// <param name="hasTmdbId">Optional filter by items that have a TMDb id or not.</param> |
| | | 108 | | /// <param name="hasTvdbId">Optional filter by items that have a TVDb id or not.</param> |
| | | 109 | | /// <param name="isMovie">Optional filter for live tv movies.</param> |
| | | 110 | | /// <param name="isSeries">Optional filter for live tv series.</param> |
| | | 111 | | /// <param name="isNews">Optional filter for live tv news.</param> |
| | | 112 | | /// <param name="isKids">Optional filter for live tv kids.</param> |
| | | 113 | | /// <param name="isSports">Optional filter for live tv sports.</param> |
| | | 114 | | /// <param name="excludeItemIds">Optional. If specified, results will be filtered by excluding item ids. This allows |
| | | 115 | | /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped fr |
| | | 116 | | /// <param name="limit">Optional. The maximum number of records to return.</param> |
| | | 117 | | /// <param name="recursive">When searching within folders, this determines whether or not the search will be recursi |
| | | 118 | | /// <param name="searchTerm">Optional. Filter based on a search term.</param> |
| | | 119 | | /// <param name="sortOrder">Sort Order - Ascending, Descending.</param> |
| | | 120 | | /// <param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</ |
| | | 121 | | /// <param name="fields">Optional. Specify additional fields of information to return in the output. This allows mul |
| | | 122 | | /// <param name="excludeItemTypes">Optional. If specified, results will be filtered based on item type. This allows |
| | | 123 | | /// <param name="includeItemTypes">Optional. If specified, results will be filtered based on the item type. This all |
| | | 124 | | /// <param name="filters">Optional. Specify additional filters to apply. This allows multiple, comma delimited. Opti |
| | | 125 | | /// <param name="isFavorite">Optional filter by items that are marked as favorite, or not.</param> |
| | | 126 | | /// <param name="mediaTypes">Optional filter by MediaType. Allows multiple, comma delimited.</param> |
| | | 127 | | /// <param name="imageTypes">Optional. If specified, results will be filtered based on those containing image types. |
| | | 128 | | /// <param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Ar |
| | | 129 | | /// <param name="isPlayed">Optional filter by items that are played, or not.</param> |
| | | 130 | | /// <param name="genres">Optional. If specified, results will be filtered based on genre. This allows multiple, pipe |
| | | 131 | | /// <param name="officialRatings">Optional. If specified, results will be filtered based on OfficialRating. This all |
| | | 132 | | /// <param name="tags">Optional. If specified, results will be filtered based on tag. This allows multiple, pipe del |
| | | 133 | | /// <param name="years">Optional. If specified, results will be filtered based on production year. This allows multi |
| | | 134 | | /// <param name="enableUserData">Optional, include user data.</param> |
| | | 135 | | /// <param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param> |
| | | 136 | | /// <param name="enableImageTypes">Optional. The image types to include in the output.</param> |
| | | 137 | | /// <param name="person">Optional. If specified, results will be filtered to include only those containing the speci |
| | | 138 | | /// <param name="personIds">Optional. If specified, results will be filtered to include only those containing the sp |
| | | 139 | | /// <param name="personTypes">Optional. If specified, along with Person, results will be filtered to include only th |
| | | 140 | | /// <param name="studios">Optional. If specified, results will be filtered based on studio. This allows multiple, pi |
| | | 141 | | /// <param name="artists">Optional. If specified, results will be filtered based on artists. This allows multiple, p |
| | | 142 | | /// <param name="excludeArtistIds">Optional. If specified, results will be filtered based on artist id. This allows |
| | | 143 | | /// <param name="artistIds">Optional. If specified, results will be filtered to include only those containing the sp |
| | | 144 | | /// <param name="albumArtistIds">Optional. If specified, results will be filtered to include only those containing t |
| | | 145 | | /// <param name="contributingArtistIds">Optional. If specified, results will be filtered to include only those conta |
| | | 146 | | /// <param name="albums">Optional. If specified, results will be filtered based on album. This allows multiple, pipe |
| | | 147 | | /// <param name="albumIds">Optional. If specified, results will be filtered based on album id. This allows multiple, |
| | | 148 | | /// <param name="ids">Optional. If specific items are needed, specify a list of item id's to retrieve. This allows m |
| | | 149 | | /// <param name="videoTypes">Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma deli |
| | | 150 | | /// <param name="minOfficialRating">Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).</param> |
| | | 151 | | /// <param name="isLocked">Optional filter by items that are locked.</param> |
| | | 152 | | /// <param name="isPlaceHolder">Optional filter by items that are placeholders.</param> |
| | | 153 | | /// <param name="hasOfficialRating">Optional filter by items that have official ratings.</param> |
| | | 154 | | /// <param name="collapseBoxSetItems">Whether or not to hide items behind their boxsets.</param> |
| | | 155 | | /// <param name="minWidth">Optional. Filter by the minimum width of the item.</param> |
| | | 156 | | /// <param name="minHeight">Optional. Filter by the minimum height of the item.</param> |
| | | 157 | | /// <param name="maxWidth">Optional. Filter by the maximum width of the item.</param> |
| | | 158 | | /// <param name="maxHeight">Optional. Filter by the maximum height of the item.</param> |
| | | 159 | | /// <param name="is3D">Optional filter by items that are 3D, or not.</param> |
| | | 160 | | /// <param name="seriesStatus">Optional filter by Series Status. Allows multiple, comma delimited.</param> |
| | | 161 | | /// <param name="nameStartsWithOrGreater">Optional filter by items whose name is sorted equally or greater than a gi |
| | | 162 | | /// <param name="nameStartsWith">Optional filter by items whose name is sorted equally than a given input string.</p |
| | | 163 | | /// <param name="nameLessThan">Optional filter by items whose name is equally or lesser than a given input string.</ |
| | | 164 | | /// <param name="studioIds">Optional. If specified, results will be filtered based on studio id. This allows multipl |
| | | 165 | | /// <param name="genreIds">Optional. If specified, results will be filtered based on genre id. This allows multiple, |
| | | 166 | | /// <param name="audioLanguages">Optional. If specified, results will be filtered based on audio language. This allo |
| | | 167 | | /// <param name="subtitleLanguages">Optional. If specified, results will be filtered based on subtitle language. Thi |
| | | 168 | | /// <param name="enableTotalRecordCount">Optional. Enable the total record count.</param> |
| | | 169 | | /// <param name="enableImages">Optional, include image information in output.</param> |
| | | 170 | | /// <returns>A <see cref="QueryResult{BaseItemDto}"/> with the items.</returns> |
| | | 171 | | [HttpGet("Items")] |
| | | 172 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 173 | | public async Task<ActionResult<QueryResult<BaseItemDto>>> GetItems( |
| | | 174 | | [FromQuery] Guid? userId, |
| | | 175 | | [FromQuery] string? maxOfficialRating, |
| | | 176 | | [FromQuery] bool? hasThemeSong, |
| | | 177 | | [FromQuery] bool? hasThemeVideo, |
| | | 178 | | [FromQuery] bool? hasSubtitles, |
| | | 179 | | [FromQuery] bool? hasSpecialFeature, |
| | | 180 | | [FromQuery] bool? hasTrailer, |
| | | 181 | | [FromQuery] Guid? adjacentTo, |
| | | 182 | | [FromQuery] int? indexNumber, |
| | | 183 | | [FromQuery] int? parentIndexNumber, |
| | | 184 | | [FromQuery] bool? hasParentalRating, |
| | | 185 | | [FromQuery] bool? isHd, |
| | | 186 | | [FromQuery] bool? is4K, |
| | | 187 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] LocationType[] locationTypes, |
| | | 188 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] LocationType[] excludeLocationTypes, |
| | | 189 | | [FromQuery] bool? isMissing, |
| | | 190 | | [FromQuery] bool? isUnaired, |
| | | 191 | | [FromQuery] double? minCommunityRating, |
| | | 192 | | [FromQuery] double? minCriticRating, |
| | | 193 | | [FromQuery] DateTime? minPremiereDate, |
| | | 194 | | [FromQuery] DateTime? minDateLastSaved, |
| | | 195 | | [FromQuery] DateTime? minDateLastSavedForUser, |
| | | 196 | | [FromQuery] DateTime? maxPremiereDate, |
| | | 197 | | [FromQuery] bool? hasOverview, |
| | | 198 | | [FromQuery] bool? hasImdbId, |
| | | 199 | | [FromQuery] bool? hasTmdbId, |
| | | 200 | | [FromQuery] bool? hasTvdbId, |
| | | 201 | | [FromQuery] bool? isMovie, |
| | | 202 | | [FromQuery] bool? isSeries, |
| | | 203 | | [FromQuery] bool? isNews, |
| | | 204 | | [FromQuery] bool? isKids, |
| | | 205 | | [FromQuery] bool? isSports, |
| | | 206 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] excludeItemIds, |
| | | 207 | | [FromQuery] int? startIndex, |
| | | 208 | | [FromQuery] int? limit, |
| | | 209 | | [FromQuery] bool? recursive, |
| | | 210 | | [FromQuery] string? searchTerm, |
| | | 211 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] SortOrder[] sortOrder, |
| | | 212 | | [FromQuery] Guid? parentId, |
| | | 213 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemFields[] fields, |
| | | 214 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] excludeItemTypes, |
| | | 215 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] includeItemTypes, |
| | | 216 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemFilter[] filters, |
| | | 217 | | [FromQuery] bool? isFavorite, |
| | | 218 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] MediaType[] mediaTypes, |
| | | 219 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ImageType[] imageTypes, |
| | | 220 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemSortBy[] sortBy, |
| | | 221 | | [FromQuery] bool? isPlayed, |
| | | 222 | | [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] genres, |
| | | 223 | | [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] officialRatings, |
| | | 224 | | [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] tags, |
| | | 225 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] int[] years, |
| | | 226 | | [FromQuery] bool? enableUserData, |
| | | 227 | | [FromQuery] int? imageTypeLimit, |
| | | 228 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ImageType[] enableImageTypes, |
| | | 229 | | [FromQuery] string? person, |
| | | 230 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] personIds, |
| | | 231 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] string[] personTypes, |
| | | 232 | | [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] studios, |
| | | 233 | | [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] artists, |
| | | 234 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] excludeArtistIds, |
| | | 235 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] artistIds, |
| | | 236 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] albumArtistIds, |
| | | 237 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] contributingArtistIds, |
| | | 238 | | [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] albums, |
| | | 239 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] albumIds, |
| | | 240 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] ids, |
| | | 241 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] VideoType[] videoTypes, |
| | | 242 | | [FromQuery] string? minOfficialRating, |
| | | 243 | | [FromQuery] bool? isLocked, |
| | | 244 | | [FromQuery] bool? isPlaceHolder, |
| | | 245 | | [FromQuery] bool? hasOfficialRating, |
| | | 246 | | [FromQuery] bool? collapseBoxSetItems, |
| | | 247 | | [FromQuery] int? minWidth, |
| | | 248 | | [FromQuery] int? minHeight, |
| | | 249 | | [FromQuery] int? maxWidth, |
| | | 250 | | [FromQuery] int? maxHeight, |
| | | 251 | | [FromQuery] bool? is3D, |
| | | 252 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] SeriesStatus[] seriesStatus, |
| | | 253 | | [FromQuery] string? nameStartsWithOrGreater, |
| | | 254 | | [FromQuery] string? nameStartsWith, |
| | | 255 | | [FromQuery] string? nameLessThan, |
| | | 256 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] studioIds, |
| | | 257 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] genreIds, |
| | | 258 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] string[] audioLanguages, |
| | | 259 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] string[] subtitleLanguages, |
| | | 260 | | [FromQuery] bool enableTotalRecordCount = true, |
| | | 261 | | [FromQuery] bool? enableImages = true) |
| | | 262 | | { |
| | 4 | 263 | | var isApiKey = User.GetIsApiKey(); |
| | | 264 | | // if api key is used (auth.IsApiKey == true), then `user` will be null throughout this method |
| | 4 | 265 | | userId = RequestHelpers.GetUserId(User, userId); |
| | 4 | 266 | | var user = userId.IsNullOrEmpty() |
| | 4 | 267 | | ? null |
| | 4 | 268 | | : _userManager.GetUserById(userId.Value) ?? throw new ResourceNotFoundException(); |
| | | 269 | | |
| | | 270 | | // beyond this point, we're either using an api key or we have a valid user |
| | 3 | 271 | | if (!isApiKey && user is null) |
| | | 272 | | { |
| | 0 | 273 | | return BadRequest("userId is required"); |
| | | 274 | | } |
| | | 275 | | |
| | 3 | 276 | | if (user is not null |
| | 3 | 277 | | && user.GetPreference(PreferenceKind.AllowedTags).Length != 0 |
| | 3 | 278 | | && !fields.Contains(ItemFields.Tags)) |
| | | 279 | | { |
| | 0 | 280 | | fields = [.. fields, ItemFields.Tags]; |
| | | 281 | | } |
| | | 282 | | |
| | 3 | 283 | | var dtoOptions = new DtoOptions { Fields = fields } |
| | 3 | 284 | | .AddAdditionalDtoOptions(enableImages, enableUserData, imageTypeLimit, enableImageTypes); |
| | | 285 | | |
| | 3 | 286 | | var item = _libraryManager.GetParentItem(parentId, userId); |
| | | 287 | | QueryResult<BaseItem> result; |
| | | 288 | | |
| | 3 | 289 | | Guid[] linkedChildAncestorIds = []; |
| | | 290 | | |
| | 3 | 291 | | includeItemTypes ??= []; |
| | 3 | 292 | | if (includeItemTypes.Length == 1 |
| | 3 | 293 | | && (includeItemTypes[0] == BaseItemKind.BoxSet || includeItemTypes[0] == BaseItemKind.Playlist) |
| | 3 | 294 | | && item is not BoxSet |
| | 3 | 295 | | && item is not Playlist) |
| | | 296 | | { |
| | 0 | 297 | | var itemCollectionType = item is IHasCollectionType hct ? hct.CollectionType : null; |
| | 0 | 298 | | var targetCollectionType = includeItemTypes[0] == BaseItemKind.BoxSet |
| | 0 | 299 | | ? CollectionType.boxsets |
| | 0 | 300 | | : CollectionType.playlists; |
| | 0 | 301 | | if (parentId.HasValue && item is not UserRootFolder && itemCollectionType != targetCollectionType) |
| | | 302 | | { |
| | 0 | 303 | | linkedChildAncestorIds = [parentId.Value]; |
| | | 304 | | } |
| | | 305 | | |
| | 0 | 306 | | parentId = null; |
| | 0 | 307 | | item = _libraryManager.GetUserRootFolder(); |
| | | 308 | | } |
| | | 309 | | |
| | 3 | 310 | | if (item is not Folder folder) |
| | | 311 | | { |
| | 0 | 312 | | folder = _libraryManager.GetUserRootFolder(); |
| | | 313 | | } |
| | | 314 | | |
| | 3 | 315 | | CollectionType? collectionType = null; |
| | 3 | 316 | | if (folder is IHasCollectionType hasCollectionType) |
| | | 317 | | { |
| | 0 | 318 | | collectionType = hasCollectionType.CollectionType; |
| | 0 | 319 | | includeItemTypes = [.. includeItemTypes.Union(DtoExtensions.GetBaseItemKindsForCollectionType(collectionType |
| | | 320 | | } |
| | | 321 | | |
| | 3 | 322 | | if (collectionType == CollectionType.playlists) |
| | | 323 | | { |
| | 0 | 324 | | recursive = true; |
| | 0 | 325 | | includeItemTypes = [BaseItemKind.Playlist]; |
| | | 326 | | } |
| | 3 | 327 | | else if (folder is ICollectionFolder && includeItemTypes.Length == 0) |
| | | 328 | | { |
| | 0 | 329 | | includeItemTypes = collectionType switch |
| | 0 | 330 | | { |
| | 0 | 331 | | CollectionType.boxsets => [BaseItemKind.BoxSet], |
| | 0 | 332 | | null => [BaseItemKind.Movie, BaseItemKind.Series], |
| | 0 | 333 | | _ => [] |
| | 0 | 334 | | }; |
| | | 335 | | } |
| | | 336 | | |
| | | 337 | | // includeItemTypes on a library lists its contents recursively rather than just its |
| | | 338 | | // immediate children, so default to a recursive query when the client didn't choose. |
| | 3 | 339 | | if (folder is ICollectionFolder && includeItemTypes.Length > 0) |
| | | 340 | | { |
| | 0 | 341 | | recursive ??= true; |
| | | 342 | | } |
| | | 343 | | |
| | 3 | 344 | | if (item is not UserRootFolder |
| | 3 | 345 | | // api keys can always access all folders |
| | 3 | 346 | | && !isApiKey |
| | 3 | 347 | | // check the item is visible for the user |
| | 3 | 348 | | && !item.IsVisible(user)) |
| | | 349 | | { |
| | 0 | 350 | | _logger.LogWarning("{UserName} is not permitted to access Library {ItemName}", user!.Username, item.Name); |
| | 0 | 351 | | return Unauthorized($"{user.Username} is not permitted to access Library {item.Name}."); |
| | | 352 | | } |
| | | 353 | | |
| | | 354 | | // Build the query up front so the dispatch below can decide the path from it. |
| | | 355 | | // Use search providers when searchTerm is provided. Providers return only IDs and scores; |
| | | 356 | | // items are loaded server-side via folder.GetItems below, which applies user-access filtering. |
| | 3 | 357 | | Dictionary<Guid, float>? searchResultScores = null; |
| | 3 | 358 | | Guid[] itemIds = ids; |
| | | 359 | | |
| | 3 | 360 | | if (!string.IsNullOrWhiteSpace(searchTerm)) |
| | | 361 | | { |
| | 0 | 362 | | var searchProviderQuery = new SearchProviderQuery |
| | 0 | 363 | | { |
| | 0 | 364 | | SearchTerm = searchTerm, |
| | 0 | 365 | | UserId = userId, |
| | 0 | 366 | | IncludeItemTypes = includeItemTypes, |
| | 0 | 367 | | ExcludeItemTypes = excludeItemTypes, |
| | 0 | 368 | | MediaTypes = mediaTypes, |
| | 0 | 369 | | Limit = limit.HasValue ? limit.Value * 3 : null, |
| | 0 | 370 | | ParentId = parentId |
| | 0 | 371 | | }; |
| | | 372 | | |
| | 0 | 373 | | var searchResults = await _searchManager.GetSearchResultsAsync(searchProviderQuery, HttpContext.RequestAbort |
| | 0 | 374 | | if (searchResults.Count > 0) |
| | | 375 | | { |
| | 0 | 376 | | searchResultScores = searchResults.ToDictionary(r => r.ItemId, r => r.Score); |
| | 0 | 377 | | itemIds = ids.Length > 0 |
| | 0 | 378 | | ? ids.Concat(searchResultScores.Keys).Distinct().ToArray() |
| | 0 | 379 | | : searchResultScores.Keys.ToArray(); |
| | | 380 | | } |
| | | 381 | | } |
| | | 382 | | |
| | 3 | 383 | | var query = new InternalItemsQuery(user) |
| | 3 | 384 | | { |
| | 3 | 385 | | IsPlayed = isPlayed, |
| | 3 | 386 | | MediaTypes = mediaTypes, |
| | 3 | 387 | | IncludeItemTypes = includeItemTypes, |
| | 3 | 388 | | ExcludeItemTypes = excludeItemTypes, |
| | 3 | 389 | | Recursive = recursive ?? false, |
| | 3 | 390 | | OrderBy = RequestHelpers.GetOrderBy(sortBy, sortOrder), |
| | 3 | 391 | | IsFavorite = isFavorite, |
| | 3 | 392 | | Limit = searchResultScores is null ? limit : null, |
| | 3 | 393 | | StartIndex = searchResultScores is null ? startIndex : null, |
| | 3 | 394 | | IsMissing = isMissing, |
| | 3 | 395 | | IsUnaired = isUnaired, |
| | 3 | 396 | | CollapseBoxSetItems = collapseBoxSetItems, |
| | 3 | 397 | | NameLessThan = nameLessThan, |
| | 3 | 398 | | NameStartsWith = nameStartsWith, |
| | 3 | 399 | | NameStartsWithOrGreater = nameStartsWithOrGreater, |
| | 3 | 400 | | HasImdbId = hasImdbId, |
| | 3 | 401 | | IsPlaceHolder = isPlaceHolder, |
| | 3 | 402 | | IsLocked = isLocked, |
| | 3 | 403 | | MinWidth = minWidth, |
| | 3 | 404 | | MinHeight = minHeight, |
| | 3 | 405 | | MaxWidth = maxWidth, |
| | 3 | 406 | | MaxHeight = maxHeight, |
| | 3 | 407 | | Is3D = is3D, |
| | 3 | 408 | | HasTvdbId = hasTvdbId, |
| | 3 | 409 | | HasTmdbId = hasTmdbId, |
| | 3 | 410 | | IsMovie = isMovie, |
| | 3 | 411 | | IsSeries = isSeries, |
| | 3 | 412 | | IsNews = isNews, |
| | 3 | 413 | | IsKids = isKids, |
| | 3 | 414 | | IsSports = isSports, |
| | 3 | 415 | | HasOverview = hasOverview, |
| | 3 | 416 | | HasOfficialRating = hasOfficialRating, |
| | 3 | 417 | | HasParentalRating = hasParentalRating, |
| | 3 | 418 | | HasSpecialFeature = hasSpecialFeature, |
| | 3 | 419 | | HasSubtitles = hasSubtitles, |
| | 3 | 420 | | HasThemeSong = hasThemeSong, |
| | 3 | 421 | | HasThemeVideo = hasThemeVideo, |
| | 3 | 422 | | HasTrailer = hasTrailer, |
| | 3 | 423 | | IsHD = isHd, |
| | 3 | 424 | | Is4K = is4K, |
| | 3 | 425 | | Tags = tags, |
| | 3 | 426 | | OfficialRatings = officialRatings, |
| | 3 | 427 | | Genres = genres, |
| | 3 | 428 | | ArtistIds = artistIds, |
| | 3 | 429 | | AlbumArtistIds = albumArtistIds, |
| | 3 | 430 | | ContributingArtistIds = contributingArtistIds, |
| | 3 | 431 | | GenreIds = genreIds, |
| | 3 | 432 | | StudioIds = studioIds, |
| | 3 | 433 | | Person = person, |
| | 3 | 434 | | PersonIds = personIds, |
| | 3 | 435 | | PersonTypes = personTypes, |
| | 3 | 436 | | Years = years, |
| | 3 | 437 | | ImageTypes = imageTypes, |
| | 3 | 438 | | VideoTypes = videoTypes, |
| | 3 | 439 | | AdjacentTo = adjacentTo, |
| | 3 | 440 | | ItemIds = itemIds, |
| | 3 | 441 | | MinCommunityRating = minCommunityRating, |
| | 3 | 442 | | MinCriticRating = minCriticRating, |
| | 3 | 443 | | ParentId = parentId ?? Guid.Empty, |
| | 3 | 444 | | IndexNumber = indexNumber, |
| | 3 | 445 | | ParentIndexNumber = parentIndexNumber, |
| | 3 | 446 | | EnableTotalRecordCount = enableTotalRecordCount, |
| | 3 | 447 | | ExcludeItemIds = excludeItemIds, |
| | 3 | 448 | | DtoOptions = dtoOptions, |
| | 3 | 449 | | SearchTerm = searchResultScores is null ? searchTerm : null, |
| | 3 | 450 | | MinDateLastSaved = minDateLastSaved?.ToUniversalTime(), |
| | 3 | 451 | | MinDateLastSavedForUser = minDateLastSavedForUser?.ToUniversalTime(), |
| | 3 | 452 | | MinPremiereDate = minPremiereDate?.ToUniversalTime(), |
| | 3 | 453 | | MaxPremiereDate = maxPremiereDate?.ToUniversalTime(), |
| | 3 | 454 | | AudioLanguages = audioLanguages, |
| | 3 | 455 | | SubtitleLanguages = subtitleLanguages, |
| | 3 | 456 | | LinkedChildAncestorIds = linkedChildAncestorIds, |
| | 3 | 457 | | }; |
| | | 458 | | |
| | 3 | 459 | | if (ids.Length != 0 || !string.IsNullOrWhiteSpace(searchTerm)) |
| | | 460 | | { |
| | 0 | 461 | | query.CollapseBoxSetItems = false; |
| | | 462 | | } |
| | | 463 | | |
| | 3 | 464 | | if (query.SubtitleLanguages.Count > 0 && query.HasSubtitles.HasValue) |
| | | 465 | | { |
| | 0 | 466 | | if (query.HasSubtitles.Value) |
| | | 467 | | { |
| | | 468 | | // if we check for specific subtitles we don't need a separate check for subtitle existence |
| | 0 | 469 | | query.HasSubtitles = null; |
| | | 470 | | } |
| | | 471 | | else |
| | | 472 | | { |
| | | 473 | | // if we search for items without subtitles, we don't need to check for subtitles of a specific language |
| | 0 | 474 | | query.SubtitleLanguages = []; |
| | | 475 | | } |
| | | 476 | | } |
| | | 477 | | |
| | | 478 | | // for filter values that rely on media streams, we need to include alternative and linked versions |
| | 3 | 479 | | if (query.HasSubtitles.HasValue |
| | 3 | 480 | | || query.SubtitleLanguages.Count > 0 |
| | 3 | 481 | | || query.AudioLanguages.Count > 0 |
| | 3 | 482 | | || query.Is3D.HasValue |
| | 3 | 483 | | || query.IsHD.HasValue |
| | 3 | 484 | | || query.Is4K.HasValue |
| | 3 | 485 | | || query.VideoTypes.Length > 0 |
| | 3 | 486 | | ) |
| | | 487 | | { |
| | 0 | 488 | | query.IncludeOwnedItems = true; |
| | | 489 | | } |
| | | 490 | | |
| | 3 | 491 | | query.ApplyFilters(filters); |
| | | 492 | | |
| | | 493 | | // Filter by Series Status |
| | 3 | 494 | | if (seriesStatus.Length != 0) |
| | | 495 | | { |
| | 0 | 496 | | query.SeriesStatuses = seriesStatus; |
| | | 497 | | } |
| | | 498 | | |
| | | 499 | | // Exclude Blocked Unrated Items |
| | 3 | 500 | | var blockedUnratedItems = user?.GetPreferenceValues<UnratedItem>(PreferenceKind.BlockUnratedItems); |
| | 3 | 501 | | if (blockedUnratedItems is not null) |
| | | 502 | | { |
| | 3 | 503 | | query.BlockUnratedItems = blockedUnratedItems; |
| | | 504 | | } |
| | | 505 | | |
| | | 506 | | // ExcludeLocationTypes |
| | 3 | 507 | | if (excludeLocationTypes.Any(t => t == LocationType.Virtual)) |
| | | 508 | | { |
| | 0 | 509 | | query.IsVirtualItem = false; |
| | | 510 | | } |
| | | 511 | | |
| | 3 | 512 | | if (locationTypes.Length > 0 && locationTypes.Length < 4) |
| | | 513 | | { |
| | 0 | 514 | | query.IsVirtualItem = locationTypes.Contains(LocationType.Virtual); |
| | | 515 | | } |
| | | 516 | | |
| | | 517 | | // Min official rating |
| | 3 | 518 | | if (!string.IsNullOrWhiteSpace(minOfficialRating)) |
| | | 519 | | { |
| | 0 | 520 | | query.MinParentalRating = _localization.GetRatingScore(minOfficialRating); |
| | | 521 | | } |
| | | 522 | | |
| | | 523 | | // Max official rating |
| | 3 | 524 | | if (!string.IsNullOrWhiteSpace(maxOfficialRating)) |
| | | 525 | | { |
| | 0 | 526 | | query.MaxParentalRating = _localization.GetRatingScore(maxOfficialRating); |
| | | 527 | | } |
| | | 528 | | |
| | | 529 | | // Artists |
| | 3 | 530 | | if (artists.Length != 0) |
| | | 531 | | { |
| | 0 | 532 | | query.ArtistIds = artists.Select(i => |
| | 0 | 533 | | { |
| | 0 | 534 | | try |
| | 0 | 535 | | { |
| | 0 | 536 | | return _libraryManager.GetArtist(i, new DtoOptions(false)); |
| | 0 | 537 | | } |
| | 0 | 538 | | catch |
| | 0 | 539 | | { |
| | 0 | 540 | | return null; |
| | 0 | 541 | | } |
| | 0 | 542 | | }).Where(i => i is not null).Select(i => i!.Id).ToArray(); |
| | | 543 | | } |
| | | 544 | | |
| | | 545 | | // ExcludeArtistIds |
| | 3 | 546 | | if (excludeArtistIds.Length != 0) |
| | | 547 | | { |
| | 0 | 548 | | query.ExcludeArtistIds = excludeArtistIds; |
| | | 549 | | } |
| | | 550 | | |
| | 3 | 551 | | if (albumIds.Length != 0) |
| | | 552 | | { |
| | 0 | 553 | | query.AlbumIds = albumIds; |
| | | 554 | | } |
| | | 555 | | |
| | | 556 | | // Albums |
| | 3 | 557 | | if (albums.Length != 0) |
| | | 558 | | { |
| | 0 | 559 | | query.AlbumIds = albums.SelectMany(i => |
| | 0 | 560 | | { |
| | 0 | 561 | | return _libraryManager.GetItemIds(new InternalItemsQuery { IncludeItemTypes = [BaseItemKind.MusicAlbum], |
| | 0 | 562 | | }).ToArray(); |
| | | 563 | | } |
| | | 564 | | |
| | | 565 | | // Studios |
| | 3 | 566 | | if (studios.Length != 0) |
| | | 567 | | { |
| | 0 | 568 | | query.StudioIds = studios.Select(i => |
| | 0 | 569 | | { |
| | 0 | 570 | | try |
| | 0 | 571 | | { |
| | 0 | 572 | | return _libraryManager.GetStudio(i); |
| | 0 | 573 | | } |
| | 0 | 574 | | catch |
| | 0 | 575 | | { |
| | 0 | 576 | | return null; |
| | 0 | 577 | | } |
| | 0 | 578 | | }).Where(i => i is not null).Select(i => i!.Id).ToArray(); |
| | | 579 | | } |
| | | 580 | | |
| | | 581 | | // Apply default sorting if none requested |
| | 3 | 582 | | if (query.OrderBy.Count == 0) |
| | | 583 | | { |
| | | 584 | | // Albums by artist |
| | 3 | 585 | | if (query.ArtistIds.Length > 0 && query.IncludeItemTypes.Length == 1 && query.IncludeItemTypes[0] == BaseIte |
| | | 586 | | { |
| | 0 | 587 | | query.OrderBy = [(ItemSortBy.ProductionYear, SortOrder.Descending), (ItemSortBy.SortName, SortOrder.Asce |
| | | 588 | | } |
| | | 589 | | } |
| | | 590 | | |
| | 3 | 591 | | query.Parent = null; |
| | | 592 | | |
| | | 593 | | // At the user root an unfiltered, non-recursive request is a plain listing of the user's libraries |
| | 3 | 594 | | if ((recursive.HasValue && recursive.Value) || ids.Length != 0 || item is not UserRootFolder || query.HasFilters |
| | | 595 | | { |
| | | 596 | | // folder.GetItems applies user-access filtering via the InternalItemsQuery's User. |
| | 0 | 597 | | result = folder.GetItems(query); |
| | 0 | 598 | | if (searchResultScores is not null && searchResultScores.Count > 0) |
| | | 599 | | { |
| | 0 | 600 | | var orderedItems = result.Items |
| | 0 | 601 | | .OrderByDescending(item => searchResultScores.GetValueOrDefault(item.Id, 0f)) |
| | 0 | 602 | | .ThenBy(item => item.SortName) |
| | 0 | 603 | | .ToArray(); |
| | | 604 | | |
| | 0 | 605 | | var totalCount = orderedItems.Length; |
| | 0 | 606 | | if (startIndex.HasValue && startIndex.Value > 0) |
| | | 607 | | { |
| | 0 | 608 | | orderedItems = orderedItems.Skip(startIndex.Value).ToArray(); |
| | | 609 | | } |
| | | 610 | | |
| | 0 | 611 | | if (limit.HasValue) |
| | | 612 | | { |
| | 0 | 613 | | orderedItems = orderedItems.Take(limit.Value).ToArray(); |
| | | 614 | | } |
| | | 615 | | |
| | 0 | 616 | | return new QueryResult<BaseItemDto>( |
| | 0 | 617 | | startIndex, |
| | 0 | 618 | | totalCount, |
| | 0 | 619 | | _dtoService.GetBaseItemDtos(orderedItems, dtoOptions, user)); |
| | | 620 | | } |
| | | 621 | | } |
| | | 622 | | else |
| | | 623 | | { |
| | 3 | 624 | | var itemsArray = folder.GetChildren(user, true); |
| | 3 | 625 | | result = new QueryResult<BaseItem>(itemsArray); |
| | | 626 | | } |
| | | 627 | | |
| | 3 | 628 | | return new QueryResult<BaseItemDto>( |
| | 3 | 629 | | startIndex, |
| | 3 | 630 | | result.TotalRecordCount, |
| | 3 | 631 | | _dtoService.GetBaseItemDtos(result.Items, dtoOptions, user, skipVisibilityCheck: true)); |
| | 3 | 632 | | } |
| | | 633 | | |
| | | 634 | | /// <summary> |
| | | 635 | | /// Gets items based on a query. |
| | | 636 | | /// </summary> |
| | | 637 | | /// <param name="userId">The user id supplied as query parameter.</param> |
| | | 638 | | /// <param name="maxOfficialRating">Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).</param> |
| | | 639 | | /// <param name="hasThemeSong">Optional filter by items with theme songs.</param> |
| | | 640 | | /// <param name="hasThemeVideo">Optional filter by items with theme videos.</param> |
| | | 641 | | /// <param name="hasSubtitles">Optional filter by items with subtitles.</param> |
| | | 642 | | /// <param name="hasSpecialFeature">Optional filter by items with special features.</param> |
| | | 643 | | /// <param name="hasTrailer">Optional filter by items with trailers.</param> |
| | | 644 | | /// <param name="adjacentTo">Optional. Return items that are siblings of a supplied item.</param> |
| | | 645 | | /// <param name="parentIndexNumber">Optional filter by parent index number.</param> |
| | | 646 | | /// <param name="hasParentalRating">Optional filter by items that have or do not have a parental rating.</param> |
| | | 647 | | /// <param name="isHd">Optional filter by items that are HD or not.</param> |
| | | 648 | | /// <param name="is4K">Optional filter by items that are 4K or not.</param> |
| | | 649 | | /// <param name="locationTypes">Optional. If specified, results will be filtered based on LocationType. This allows |
| | | 650 | | /// <param name="excludeLocationTypes">Optional. If specified, results will be filtered based on the LocationType. T |
| | | 651 | | /// <param name="isMissing">Optional filter by items that are missing episodes or not.</param> |
| | | 652 | | /// <param name="isUnaired">Optional filter by items that are unaired episodes or not.</param> |
| | | 653 | | /// <param name="minCommunityRating">Optional filter by minimum community rating.</param> |
| | | 654 | | /// <param name="minCriticRating">Optional filter by minimum critic rating.</param> |
| | | 655 | | /// <param name="minPremiereDate">Optional. The minimum premiere date. Format = ISO.</param> |
| | | 656 | | /// <param name="minDateLastSaved">Optional. The minimum last saved date. Format = ISO.</param> |
| | | 657 | | /// <param name="minDateLastSavedForUser">Optional. The minimum last saved date for the current user. Format = ISO.< |
| | | 658 | | /// <param name="maxPremiereDate">Optional. The maximum premiere date. Format = ISO.</param> |
| | | 659 | | /// <param name="hasOverview">Optional filter by items that have an overview or not.</param> |
| | | 660 | | /// <param name="hasImdbId">Optional filter by items that have an IMDb id or not.</param> |
| | | 661 | | /// <param name="hasTmdbId">Optional filter by items that have a TMDb id or not.</param> |
| | | 662 | | /// <param name="hasTvdbId">Optional filter by items that have a TVDb id or not.</param> |
| | | 663 | | /// <param name="isMovie">Optional filter for live tv movies.</param> |
| | | 664 | | /// <param name="isSeries">Optional filter for live tv series.</param> |
| | | 665 | | /// <param name="isNews">Optional filter for live tv news.</param> |
| | | 666 | | /// <param name="isKids">Optional filter for live tv kids.</param> |
| | | 667 | | /// <param name="isSports">Optional filter for live tv sports.</param> |
| | | 668 | | /// <param name="excludeItemIds">Optional. If specified, results will be filtered by excluding item ids. This allows |
| | | 669 | | /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped fr |
| | | 670 | | /// <param name="limit">Optional. The maximum number of records to return.</param> |
| | | 671 | | /// <param name="recursive">When searching within folders, this determines whether or not the search will be recursi |
| | | 672 | | /// <param name="searchTerm">Optional. Filter based on a search term.</param> |
| | | 673 | | /// <param name="sortOrder">Sort Order - Ascending, Descending.</param> |
| | | 674 | | /// <param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</ |
| | | 675 | | /// <param name="fields">Optional. Specify additional fields of information to return in the output. This allows mul |
| | | 676 | | /// <param name="excludeItemTypes">Optional. If specified, results will be filtered based on item type. This allows |
| | | 677 | | /// <param name="includeItemTypes">Optional. If specified, results will be filtered based on the item type. This all |
| | | 678 | | /// <param name="filters">Optional. Specify additional filters to apply. This allows multiple, comma delimited. Opti |
| | | 679 | | /// <param name="isFavorite">Optional filter by items that are marked as favorite, or not.</param> |
| | | 680 | | /// <param name="mediaTypes">Optional filter by MediaType. Allows multiple, comma delimited.</param> |
| | | 681 | | /// <param name="imageTypes">Optional. If specified, results will be filtered based on those containing image types. |
| | | 682 | | /// <param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Ar |
| | | 683 | | /// <param name="isPlayed">Optional filter by items that are played, or not.</param> |
| | | 684 | | /// <param name="genres">Optional. If specified, results will be filtered based on genre. This allows multiple, pipe |
| | | 685 | | /// <param name="officialRatings">Optional. If specified, results will be filtered based on OfficialRating. This all |
| | | 686 | | /// <param name="tags">Optional. If specified, results will be filtered based on tag. This allows multiple, pipe del |
| | | 687 | | /// <param name="years">Optional. If specified, results will be filtered based on production year. This allows multi |
| | | 688 | | /// <param name="enableUserData">Optional, include user data.</param> |
| | | 689 | | /// <param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param> |
| | | 690 | | /// <param name="enableImageTypes">Optional. The image types to include in the output.</param> |
| | | 691 | | /// <param name="person">Optional. If specified, results will be filtered to include only those containing the speci |
| | | 692 | | /// <param name="personIds">Optional. If specified, results will be filtered to include only those containing the sp |
| | | 693 | | /// <param name="personTypes">Optional. If specified, along with Person, results will be filtered to include only th |
| | | 694 | | /// <param name="studios">Optional. If specified, results will be filtered based on studio. This allows multiple, pi |
| | | 695 | | /// <param name="artists">Optional. If specified, results will be filtered based on artists. This allows multiple, p |
| | | 696 | | /// <param name="excludeArtistIds">Optional. If specified, results will be filtered based on artist id. This allows |
| | | 697 | | /// <param name="artistIds">Optional. If specified, results will be filtered to include only those containing the sp |
| | | 698 | | /// <param name="albumArtistIds">Optional. If specified, results will be filtered to include only those containing t |
| | | 699 | | /// <param name="contributingArtistIds">Optional. If specified, results will be filtered to include only those conta |
| | | 700 | | /// <param name="albums">Optional. If specified, results will be filtered based on album. This allows multiple, pipe |
| | | 701 | | /// <param name="albumIds">Optional. If specified, results will be filtered based on album id. This allows multiple, |
| | | 702 | | /// <param name="ids">Optional. If specific items are needed, specify a list of item id's to retrieve. This allows m |
| | | 703 | | /// <param name="videoTypes">Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma deli |
| | | 704 | | /// <param name="minOfficialRating">Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).</param> |
| | | 705 | | /// <param name="isLocked">Optional filter by items that are locked.</param> |
| | | 706 | | /// <param name="isPlaceHolder">Optional filter by items that are placeholders.</param> |
| | | 707 | | /// <param name="hasOfficialRating">Optional filter by items that have official ratings.</param> |
| | | 708 | | /// <param name="collapseBoxSetItems">Whether or not to hide items behind their boxsets.</param> |
| | | 709 | | /// <param name="minWidth">Optional. Filter by the minimum width of the item.</param> |
| | | 710 | | /// <param name="minHeight">Optional. Filter by the minimum height of the item.</param> |
| | | 711 | | /// <param name="maxWidth">Optional. Filter by the maximum width of the item.</param> |
| | | 712 | | /// <param name="maxHeight">Optional. Filter by the maximum height of the item.</param> |
| | | 713 | | /// <param name="is3D">Optional filter by items that are 3D, or not.</param> |
| | | 714 | | /// <param name="seriesStatus">Optional filter by Series Status. Allows multiple, comma delimited.</param> |
| | | 715 | | /// <param name="nameStartsWithOrGreater">Optional filter by items whose name is sorted equally or greater than a gi |
| | | 716 | | /// <param name="nameStartsWith">Optional filter by items whose name is sorted equally than a given input string.</p |
| | | 717 | | /// <param name="nameLessThan">Optional filter by items whose name is equally or lesser than a given input string.</ |
| | | 718 | | /// <param name="studioIds">Optional. If specified, results will be filtered based on studio id. This allows multipl |
| | | 719 | | /// <param name="genreIds">Optional. If specified, results will be filtered based on genre id. This allows multiple, |
| | | 720 | | /// <param name="enableTotalRecordCount">Optional. Enable the total record count.</param> |
| | | 721 | | /// <param name="enableImages">Optional, include image information in output.</param> |
| | | 722 | | /// <returns>A <see cref="QueryResult{BaseItemDto}"/> with the items.</returns> |
| | | 723 | | [HttpGet("Users/{userId}/Items")] |
| | | 724 | | [Obsolete("Kept for backwards compatibility")] |
| | | 725 | | [ApiExplorerSettings(IgnoreApi = true)] |
| | | 726 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 727 | | public async Task<ActionResult<QueryResult<BaseItemDto>>> GetItemsByUserIdLegacy( |
| | | 728 | | [FromRoute] Guid userId, |
| | | 729 | | [FromQuery] string? maxOfficialRating, |
| | | 730 | | [FromQuery] bool? hasThemeSong, |
| | | 731 | | [FromQuery] bool? hasThemeVideo, |
| | | 732 | | [FromQuery] bool? hasSubtitles, |
| | | 733 | | [FromQuery] bool? hasSpecialFeature, |
| | | 734 | | [FromQuery] bool? hasTrailer, |
| | | 735 | | [FromQuery] Guid? adjacentTo, |
| | | 736 | | [FromQuery] int? parentIndexNumber, |
| | | 737 | | [FromQuery] bool? hasParentalRating, |
| | | 738 | | [FromQuery] bool? isHd, |
| | | 739 | | [FromQuery] bool? is4K, |
| | | 740 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] LocationType[] locationTypes, |
| | | 741 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] LocationType[] excludeLocationTypes, |
| | | 742 | | [FromQuery] bool? isMissing, |
| | | 743 | | [FromQuery] bool? isUnaired, |
| | | 744 | | [FromQuery] double? minCommunityRating, |
| | | 745 | | [FromQuery] double? minCriticRating, |
| | | 746 | | [FromQuery] DateTime? minPremiereDate, |
| | | 747 | | [FromQuery] DateTime? minDateLastSaved, |
| | | 748 | | [FromQuery] DateTime? minDateLastSavedForUser, |
| | | 749 | | [FromQuery] DateTime? maxPremiereDate, |
| | | 750 | | [FromQuery] bool? hasOverview, |
| | | 751 | | [FromQuery] bool? hasImdbId, |
| | | 752 | | [FromQuery] bool? hasTmdbId, |
| | | 753 | | [FromQuery] bool? hasTvdbId, |
| | | 754 | | [FromQuery] bool? isMovie, |
| | | 755 | | [FromQuery] bool? isSeries, |
| | | 756 | | [FromQuery] bool? isNews, |
| | | 757 | | [FromQuery] bool? isKids, |
| | | 758 | | [FromQuery] bool? isSports, |
| | | 759 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] excludeItemIds, |
| | | 760 | | [FromQuery] int? startIndex, |
| | | 761 | | [FromQuery] int? limit, |
| | | 762 | | [FromQuery] bool? recursive, |
| | | 763 | | [FromQuery] string? searchTerm, |
| | | 764 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] SortOrder[] sortOrder, |
| | | 765 | | [FromQuery] Guid? parentId, |
| | | 766 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemFields[] fields, |
| | | 767 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] excludeItemTypes, |
| | | 768 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] includeItemTypes, |
| | | 769 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemFilter[] filters, |
| | | 770 | | [FromQuery] bool? isFavorite, |
| | | 771 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] MediaType[] mediaTypes, |
| | | 772 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ImageType[] imageTypes, |
| | | 773 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemSortBy[] sortBy, |
| | | 774 | | [FromQuery] bool? isPlayed, |
| | | 775 | | [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] genres, |
| | | 776 | | [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] officialRatings, |
| | | 777 | | [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] tags, |
| | | 778 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] int[] years, |
| | | 779 | | [FromQuery] bool? enableUserData, |
| | | 780 | | [FromQuery] int? imageTypeLimit, |
| | | 781 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ImageType[] enableImageTypes, |
| | | 782 | | [FromQuery] string? person, |
| | | 783 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] personIds, |
| | | 784 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] string[] personTypes, |
| | | 785 | | [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] studios, |
| | | 786 | | [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] artists, |
| | | 787 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] excludeArtistIds, |
| | | 788 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] artistIds, |
| | | 789 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] albumArtistIds, |
| | | 790 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] contributingArtistIds, |
| | | 791 | | [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] albums, |
| | | 792 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] albumIds, |
| | | 793 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] ids, |
| | | 794 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] VideoType[] videoTypes, |
| | | 795 | | [FromQuery] string? minOfficialRating, |
| | | 796 | | [FromQuery] bool? isLocked, |
| | | 797 | | [FromQuery] bool? isPlaceHolder, |
| | | 798 | | [FromQuery] bool? hasOfficialRating, |
| | | 799 | | [FromQuery] bool? collapseBoxSetItems, |
| | | 800 | | [FromQuery] int? minWidth, |
| | | 801 | | [FromQuery] int? minHeight, |
| | | 802 | | [FromQuery] int? maxWidth, |
| | | 803 | | [FromQuery] int? maxHeight, |
| | | 804 | | [FromQuery] bool? is3D, |
| | | 805 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] SeriesStatus[] seriesStatus, |
| | | 806 | | [FromQuery] string? nameStartsWithOrGreater, |
| | | 807 | | [FromQuery] string? nameStartsWith, |
| | | 808 | | [FromQuery] string? nameLessThan, |
| | | 809 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] studioIds, |
| | | 810 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] genreIds, |
| | | 811 | | [FromQuery] bool enableTotalRecordCount = true, |
| | | 812 | | [FromQuery] bool? enableImages = true) |
| | | 813 | | => await GetItems( |
| | | 814 | | userId, |
| | | 815 | | maxOfficialRating, |
| | | 816 | | hasThemeSong, |
| | | 817 | | hasThemeVideo, |
| | | 818 | | hasSubtitles, |
| | | 819 | | hasSpecialFeature, |
| | | 820 | | hasTrailer, |
| | | 821 | | adjacentTo, |
| | | 822 | | null, |
| | | 823 | | parentIndexNumber, |
| | | 824 | | hasParentalRating, |
| | | 825 | | isHd, |
| | | 826 | | is4K, |
| | | 827 | | locationTypes, |
| | | 828 | | excludeLocationTypes, |
| | | 829 | | isMissing, |
| | | 830 | | isUnaired, |
| | | 831 | | minCommunityRating, |
| | | 832 | | minCriticRating, |
| | | 833 | | minPremiereDate, |
| | | 834 | | minDateLastSaved, |
| | | 835 | | minDateLastSavedForUser, |
| | | 836 | | maxPremiereDate, |
| | | 837 | | hasOverview, |
| | | 838 | | hasImdbId, |
| | | 839 | | hasTmdbId, |
| | | 840 | | hasTvdbId, |
| | | 841 | | isMovie, |
| | | 842 | | isSeries, |
| | | 843 | | isNews, |
| | | 844 | | isKids, |
| | | 845 | | isSports, |
| | | 846 | | excludeItemIds, |
| | | 847 | | startIndex, |
| | | 848 | | limit, |
| | | 849 | | recursive, |
| | | 850 | | searchTerm, |
| | | 851 | | sortOrder, |
| | | 852 | | parentId, |
| | | 853 | | fields, |
| | | 854 | | excludeItemTypes, |
| | | 855 | | includeItemTypes, |
| | | 856 | | filters, |
| | | 857 | | isFavorite, |
| | | 858 | | mediaTypes, |
| | | 859 | | imageTypes, |
| | | 860 | | sortBy, |
| | | 861 | | isPlayed, |
| | | 862 | | genres, |
| | | 863 | | officialRatings, |
| | | 864 | | tags, |
| | | 865 | | years, |
| | | 866 | | enableUserData, |
| | | 867 | | imageTypeLimit, |
| | | 868 | | enableImageTypes, |
| | | 869 | | person, |
| | | 870 | | personIds, |
| | | 871 | | personTypes, |
| | | 872 | | studios, |
| | | 873 | | artists, |
| | | 874 | | excludeArtistIds, |
| | | 875 | | artistIds, |
| | | 876 | | albumArtistIds, |
| | | 877 | | contributingArtistIds, |
| | | 878 | | albums, |
| | | 879 | | albumIds, |
| | | 880 | | ids, |
| | | 881 | | videoTypes, |
| | | 882 | | minOfficialRating, |
| | | 883 | | isLocked, |
| | | 884 | | isPlaceHolder, |
| | | 885 | | hasOfficialRating, |
| | | 886 | | collapseBoxSetItems, |
| | | 887 | | minWidth, |
| | | 888 | | minHeight, |
| | | 889 | | maxWidth, |
| | | 890 | | maxHeight, |
| | | 891 | | is3D, |
| | | 892 | | seriesStatus, |
| | | 893 | | nameStartsWithOrGreater, |
| | | 894 | | nameStartsWith, |
| | | 895 | | nameLessThan, |
| | | 896 | | studioIds, |
| | | 897 | | genreIds, |
| | | 898 | | [], |
| | | 899 | | [], |
| | | 900 | | enableTotalRecordCount, |
| | | 901 | | enableImages).ConfigureAwait(false); |
| | | 902 | | |
| | | 903 | | /// <summary> |
| | | 904 | | /// Gets items based on a query. |
| | | 905 | | /// </summary> |
| | | 906 | | /// <param name="userId">The user id.</param> |
| | | 907 | | /// <param name="startIndex">The start index.</param> |
| | | 908 | | /// <param name="limit">The item limit.</param> |
| | | 909 | | /// <param name="searchTerm">The search term.</param> |
| | | 910 | | /// <param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</ |
| | | 911 | | /// <param name="fields">Optional. Specify additional fields of information to return in the output. This allows mul |
| | | 912 | | /// <param name="mediaTypes">Optional. Filter by MediaType. Allows multiple, comma delimited.</param> |
| | | 913 | | /// <param name="enableUserData">Optional. Include user data.</param> |
| | | 914 | | /// <param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param> |
| | | 915 | | /// <param name="enableImageTypes">Optional. The image types to include in the output.</param> |
| | | 916 | | /// <param name="excludeItemTypes">Optional. If specified, results will be filtered based on item type. This allows |
| | | 917 | | /// <param name="includeItemTypes">Optional. If specified, results will be filtered based on the item type. This all |
| | | 918 | | /// <param name="enableTotalRecordCount">Optional. Enable the total record count.</param> |
| | | 919 | | /// <param name="enableImages">Optional. Include image information in output.</param> |
| | | 920 | | /// <param name="excludeActiveSessions">Optional. Whether to exclude the currently active sessions.</param> |
| | | 921 | | /// <response code="200">Items returned.</response> |
| | | 922 | | /// <returns>A <see cref="QueryResult{BaseItemDto}"/> with the items that are resumable.</returns> |
| | | 923 | | [HttpGet("UserItems/Resume")] |
| | | 924 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 925 | | public ActionResult<QueryResult<BaseItemDto>> GetResumeItems( |
| | | 926 | | [FromQuery] Guid? userId, |
| | | 927 | | [FromQuery] int? startIndex, |
| | | 928 | | [FromQuery] int? limit, |
| | | 929 | | [FromQuery] string? searchTerm, |
| | | 930 | | [FromQuery] Guid? parentId, |
| | | 931 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemFields[] fields, |
| | | 932 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] MediaType[] mediaTypes, |
| | | 933 | | [FromQuery] bool? enableUserData, |
| | | 934 | | [FromQuery] int? imageTypeLimit, |
| | | 935 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ImageType[] enableImageTypes, |
| | | 936 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] excludeItemTypes, |
| | | 937 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] includeItemTypes, |
| | | 938 | | [FromQuery] bool enableTotalRecordCount = true, |
| | | 939 | | [FromQuery] bool? enableImages = true, |
| | | 940 | | [FromQuery] bool excludeActiveSessions = false) |
| | | 941 | | { |
| | 2 | 942 | | var requestUserId = RequestHelpers.GetUserId(User, userId); |
| | 2 | 943 | | var user = _userManager.GetUserById(requestUserId); |
| | 2 | 944 | | if (user is null) |
| | | 945 | | { |
| | 1 | 946 | | return NotFound(); |
| | | 947 | | } |
| | | 948 | | |
| | 1 | 949 | | var parentIdGuid = parentId ?? Guid.Empty; |
| | 1 | 950 | | var dtoOptions = new DtoOptions { Fields = fields } |
| | 1 | 951 | | .AddAdditionalDtoOptions(enableImages, enableUserData, imageTypeLimit, enableImageTypes); |
| | | 952 | | |
| | 1 | 953 | | var ancestorIds = Array.Empty<Guid>(); |
| | | 954 | | |
| | 1 | 955 | | var excludeFolderIds = user.GetPreferenceValues<Guid>(PreferenceKind.LatestItemExcludes); |
| | 1 | 956 | | if (parentIdGuid.IsEmpty() && excludeFolderIds.Length > 0) |
| | | 957 | | { |
| | 0 | 958 | | ancestorIds = _libraryManager.GetUserRootFolder().GetChildren(user, true) |
| | 0 | 959 | | .Where(i => i is Folder) |
| | 0 | 960 | | .Where(i => !excludeFolderIds.Contains(i.Id)) |
| | 0 | 961 | | .Select(i => i.Id) |
| | 0 | 962 | | .ToArray(); |
| | | 963 | | } |
| | | 964 | | |
| | 1 | 965 | | var excludeItemIds = Array.Empty<Guid>(); |
| | 1 | 966 | | if (excludeActiveSessions) |
| | | 967 | | { |
| | | 968 | | // NowPlayingItem.Id is the displayed/primary id, but resume queries surface the actually-played |
| | | 969 | | // alternate version's own id. Expand each active session to every version id so an in-progress |
| | | 970 | | // alternate is excluded too, instead of leaking back into the resume list. |
| | 0 | 971 | | excludeItemIds = _sessionManager.Sessions |
| | 0 | 972 | | .Where(s => s.UserId.Equals(requestUserId) && s.NowPlayingItem is not null) |
| | 0 | 973 | | .SelectMany(s => _libraryManager.GetItemById(s.NowPlayingItem.Id) is Video video |
| | 0 | 974 | | ? video.GetAllVersions().Select(v => v.Id) |
| | 0 | 975 | | : [s.NowPlayingItem.Id]) |
| | 0 | 976 | | .Distinct() |
| | 0 | 977 | | .ToArray(); |
| | | 978 | | } |
| | | 979 | | |
| | 1 | 980 | | var itemsResult = _libraryManager.GetItemsResult(new InternalItemsQuery(user) |
| | 1 | 981 | | { |
| | 1 | 982 | | OrderBy = [(ItemSortBy.DatePlayed, SortOrder.Descending)], |
| | 1 | 983 | | IsResumable = true, |
| | 1 | 984 | | StartIndex = startIndex, |
| | 1 | 985 | | Limit = limit, |
| | 1 | 986 | | ParentId = parentIdGuid, |
| | 1 | 987 | | Recursive = true, |
| | 1 | 988 | | DtoOptions = dtoOptions, |
| | 1 | 989 | | MediaTypes = mediaTypes, |
| | 1 | 990 | | IsVirtualItem = false, |
| | 1 | 991 | | CollapseBoxSetItems = false, |
| | 1 | 992 | | IncludeOwnedItems = true, |
| | 1 | 993 | | EnableTotalRecordCount = enableTotalRecordCount, |
| | 1 | 994 | | AncestorIds = ancestorIds, |
| | 1 | 995 | | IncludeItemTypes = includeItemTypes, |
| | 1 | 996 | | ExcludeItemTypes = excludeItemTypes, |
| | 1 | 997 | | SearchTerm = searchTerm, |
| | 1 | 998 | | ExcludeItemIds = excludeItemIds |
| | 1 | 999 | | }); |
| | | 1000 | | |
| | 1 | 1001 | | var returnItems = _dtoService.GetBaseItemDtos(itemsResult.Items, dtoOptions, user); |
| | | 1002 | | |
| | 1 | 1003 | | return new QueryResult<BaseItemDto>( |
| | 1 | 1004 | | startIndex, |
| | 1 | 1005 | | itemsResult.TotalRecordCount, |
| | 1 | 1006 | | returnItems); |
| | | 1007 | | } |
| | | 1008 | | |
| | | 1009 | | /// <summary> |
| | | 1010 | | /// Gets items based on a query. |
| | | 1011 | | /// </summary> |
| | | 1012 | | /// <param name="userId">The user id.</param> |
| | | 1013 | | /// <param name="startIndex">The start index.</param> |
| | | 1014 | | /// <param name="limit">The item limit.</param> |
| | | 1015 | | /// <param name="searchTerm">The search term.</param> |
| | | 1016 | | /// <param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</ |
| | | 1017 | | /// <param name="fields">Optional. Specify additional fields of information to return in the output. This allows mul |
| | | 1018 | | /// <param name="mediaTypes">Optional. Filter by MediaType. Allows multiple, comma delimited.</param> |
| | | 1019 | | /// <param name="enableUserData">Optional. Include user data.</param> |
| | | 1020 | | /// <param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param> |
| | | 1021 | | /// <param name="enableImageTypes">Optional. The image types to include in the output.</param> |
| | | 1022 | | /// <param name="excludeItemTypes">Optional. If specified, results will be filtered based on item type. This allows |
| | | 1023 | | /// <param name="includeItemTypes">Optional. If specified, results will be filtered based on the item type. This all |
| | | 1024 | | /// <param name="enableTotalRecordCount">Optional. Enable the total record count.</param> |
| | | 1025 | | /// <param name="enableImages">Optional. Include image information in output.</param> |
| | | 1026 | | /// <param name="excludeActiveSessions">Optional. Whether to exclude the currently active sessions.</param> |
| | | 1027 | | /// <response code="200">Items returned.</response> |
| | | 1028 | | /// <returns>A <see cref="QueryResult{BaseItemDto}"/> with the items that are resumable.</returns> |
| | | 1029 | | [HttpGet("Users/{userId}/Items/Resume")] |
| | | 1030 | | [Obsolete("Kept for backwards compatibility")] |
| | | 1031 | | [ApiExplorerSettings(IgnoreApi = true)] |
| | | 1032 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 1033 | | public ActionResult<QueryResult<BaseItemDto>> GetResumeItemsLegacy( |
| | | 1034 | | [FromRoute, Required] Guid userId, |
| | | 1035 | | [FromQuery] int? startIndex, |
| | | 1036 | | [FromQuery] int? limit, |
| | | 1037 | | [FromQuery] string? searchTerm, |
| | | 1038 | | [FromQuery] Guid? parentId, |
| | | 1039 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemFields[] fields, |
| | | 1040 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] MediaType[] mediaTypes, |
| | | 1041 | | [FromQuery] bool? enableUserData, |
| | | 1042 | | [FromQuery] int? imageTypeLimit, |
| | | 1043 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ImageType[] enableImageTypes, |
| | | 1044 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] excludeItemTypes, |
| | | 1045 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] includeItemTypes, |
| | | 1046 | | [FromQuery] bool enableTotalRecordCount = true, |
| | | 1047 | | [FromQuery] bool? enableImages = true, |
| | | 1048 | | [FromQuery] bool excludeActiveSessions = false) |
| | | 1049 | | => GetResumeItems( |
| | | 1050 | | userId, |
| | | 1051 | | startIndex, |
| | | 1052 | | limit, |
| | | 1053 | | searchTerm, |
| | | 1054 | | parentId, |
| | | 1055 | | fields, |
| | | 1056 | | mediaTypes, |
| | | 1057 | | enableUserData, |
| | | 1058 | | imageTypeLimit, |
| | | 1059 | | enableImageTypes, |
| | | 1060 | | excludeItemTypes, |
| | | 1061 | | includeItemTypes, |
| | | 1062 | | enableTotalRecordCount, |
| | | 1063 | | enableImages, |
| | | 1064 | | excludeActiveSessions); |
| | | 1065 | | |
| | | 1066 | | /// <summary> |
| | | 1067 | | /// Get Item User Data. |
| | | 1068 | | /// </summary> |
| | | 1069 | | /// <param name="userId">The user id.</param> |
| | | 1070 | | /// <param name="itemId">The item id.</param> |
| | | 1071 | | /// <response code="200">return item user data.</response> |
| | | 1072 | | /// <response code="404">Item is not found.</response> |
| | | 1073 | | /// <returns>Return <see cref="UserItemDataDto"/>.</returns> |
| | | 1074 | | [HttpGet("UserItems/{itemId}/UserData")] |
| | | 1075 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 1076 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 1077 | | [Tags("UserData")] |
| | | 1078 | | public ActionResult<UserItemDataDto?> GetItemUserData( |
| | | 1079 | | [FromQuery] Guid? userId, |
| | | 1080 | | [FromRoute, Required] Guid itemId) |
| | | 1081 | | { |
| | 0 | 1082 | | var requestUserId = RequestHelpers.GetUserId(User, userId); |
| | 0 | 1083 | | var user = _userManager.GetUserById(requestUserId); |
| | 0 | 1084 | | if (user is null) |
| | | 1085 | | { |
| | 0 | 1086 | | return NotFound(); |
| | | 1087 | | } |
| | | 1088 | | |
| | 0 | 1089 | | if (!RequestHelpers.AssertCanUpdateUser(User, user, true)) |
| | | 1090 | | { |
| | 0 | 1091 | | return StatusCode(StatusCodes.Status403Forbidden, "User is not allowed to view this item user data."); |
| | | 1092 | | } |
| | | 1093 | | |
| | 0 | 1094 | | var item = _libraryManager.GetItemById<BaseItem>(itemId, user); |
| | 0 | 1095 | | if (item is null) |
| | | 1096 | | { |
| | 0 | 1097 | | return NotFound(); |
| | | 1098 | | } |
| | | 1099 | | |
| | 0 | 1100 | | return _userDataRepository.GetUserDataDto(item, user); |
| | | 1101 | | } |
| | | 1102 | | |
| | | 1103 | | /// <summary> |
| | | 1104 | | /// Get Item User Data. |
| | | 1105 | | /// </summary> |
| | | 1106 | | /// <param name="userId">The user id.</param> |
| | | 1107 | | /// <param name="itemId">The item id.</param> |
| | | 1108 | | /// <response code="200">return item user data.</response> |
| | | 1109 | | /// <response code="404">Item is not found.</response> |
| | | 1110 | | /// <returns>Return <see cref="UserItemDataDto"/>.</returns> |
| | | 1111 | | [HttpGet("Users/{userId}/Items/{itemId}/UserData")] |
| | | 1112 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 1113 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 1114 | | [Obsolete("Kept for backwards compatibility")] |
| | | 1115 | | [ApiExplorerSettings(IgnoreApi = true)] |
| | | 1116 | | public ActionResult<UserItemDataDto?> GetItemUserDataLegacy( |
| | | 1117 | | [FromRoute, Required] Guid userId, |
| | | 1118 | | [FromRoute, Required] Guid itemId) |
| | | 1119 | | => GetItemUserData(userId, itemId); |
| | | 1120 | | |
| | | 1121 | | /// <summary> |
| | | 1122 | | /// Update Item User Data. |
| | | 1123 | | /// </summary> |
| | | 1124 | | /// <param name="userId">The user id.</param> |
| | | 1125 | | /// <param name="itemId">The item id.</param> |
| | | 1126 | | /// <param name="userDataDto">New user data object.</param> |
| | | 1127 | | /// <response code="200">return updated user item data.</response> |
| | | 1128 | | /// <response code="404">Item is not found.</response> |
| | | 1129 | | /// <returns>Return <see cref="UserItemDataDto"/>.</returns> |
| | | 1130 | | [HttpPost("UserItems/{itemId}/UserData")] |
| | | 1131 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 1132 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 1133 | | [Tags("UserData")] |
| | | 1134 | | public ActionResult<UserItemDataDto?> UpdateItemUserData( |
| | | 1135 | | [FromQuery] Guid? userId, |
| | | 1136 | | [FromRoute, Required] Guid itemId, |
| | | 1137 | | [FromBody, Required] UpdateUserItemDataDto userDataDto) |
| | | 1138 | | { |
| | 0 | 1139 | | var requestUserId = RequestHelpers.GetUserId(User, userId); |
| | 0 | 1140 | | var user = _userManager.GetUserById(requestUserId); |
| | 0 | 1141 | | if (user is null) |
| | | 1142 | | { |
| | 0 | 1143 | | return NotFound(); |
| | | 1144 | | } |
| | | 1145 | | |
| | 0 | 1146 | | if (!RequestHelpers.AssertCanUpdateUser(User, user, true)) |
| | | 1147 | | { |
| | 0 | 1148 | | return StatusCode(StatusCodes.Status403Forbidden, "User is not allowed to update this item user data."); |
| | | 1149 | | } |
| | | 1150 | | |
| | 0 | 1151 | | var item = _libraryManager.GetItemById<BaseItem>(itemId, user); |
| | 0 | 1152 | | if (item is null) |
| | | 1153 | | { |
| | 0 | 1154 | | return NotFound(); |
| | | 1155 | | } |
| | | 1156 | | |
| | 0 | 1157 | | _userDataRepository.SaveUserData(user, item, userDataDto, UserDataSaveReason.UpdateUserData); |
| | | 1158 | | |
| | 0 | 1159 | | return _userDataRepository.GetUserDataDto(item, user); |
| | | 1160 | | } |
| | | 1161 | | |
| | | 1162 | | /// <summary> |
| | | 1163 | | /// Update Item User Data. |
| | | 1164 | | /// </summary> |
| | | 1165 | | /// <param name="userId">The user id.</param> |
| | | 1166 | | /// <param name="itemId">The item id.</param> |
| | | 1167 | | /// <param name="userDataDto">New user data object.</param> |
| | | 1168 | | /// <response code="200">return updated user item data.</response> |
| | | 1169 | | /// <response code="404">Item is not found.</response> |
| | | 1170 | | /// <returns>Return <see cref="UserItemDataDto"/>.</returns> |
| | | 1171 | | [HttpPost("Users/{userId}/Items/{itemId}/UserData")] |
| | | 1172 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 1173 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 1174 | | [Obsolete("Kept for backwards compatibility")] |
| | | 1175 | | [ApiExplorerSettings(IgnoreApi = true)] |
| | | 1176 | | public ActionResult<UserItemDataDto?> UpdateItemUserDataLegacy( |
| | | 1177 | | [FromRoute, Required] Guid userId, |
| | | 1178 | | [FromRoute, Required] Guid itemId, |
| | | 1179 | | [FromBody, Required] UpdateUserItemDataDto userDataDto) |
| | | 1180 | | => UpdateItemUserData(userId, itemId, userDataDto); |
| | | 1181 | | } |