|
@@ -1,17 +1,21 @@
|
|
|
using System;
|
|
|
+using System.Collections.Generic;
|
|
|
+using System.Diagnostics.CodeAnalysis;
|
|
|
+using System.Globalization;
|
|
|
using System.Linq;
|
|
|
using Jellyfin.Api.Constants;
|
|
|
using Jellyfin.Api.Extensions;
|
|
|
+using MediaBrowser.Common.Extensions;
|
|
|
using MediaBrowser.Controller.Dto;
|
|
|
using MediaBrowser.Controller.Entities;
|
|
|
using MediaBrowser.Controller.Entities.TV;
|
|
|
using MediaBrowser.Controller.Library;
|
|
|
-using MediaBrowser.Controller.Net;
|
|
|
using MediaBrowser.Controller.TV;
|
|
|
using MediaBrowser.Model.Dto;
|
|
|
using MediaBrowser.Model.Entities;
|
|
|
using MediaBrowser.Model.Querying;
|
|
|
using Microsoft.AspNetCore.Authorization;
|
|
|
+using Microsoft.AspNetCore.Http;
|
|
|
using Microsoft.AspNetCore.Mvc;
|
|
|
|
|
|
namespace Jellyfin.Api.Controllers
|
|
@@ -27,7 +31,6 @@ namespace Jellyfin.Api.Controllers
|
|
|
private readonly ILibraryManager _libraryManager;
|
|
|
private readonly IDtoService _dtoService;
|
|
|
private readonly ITVSeriesManager _tvSeriesManager;
|
|
|
- private readonly IAuthorizationContext _authContext;
|
|
|
|
|
|
/// <summary>
|
|
|
/// Initializes a new instance of the <see cref="TvShowsController"/> class.
|
|
@@ -36,19 +39,16 @@ namespace Jellyfin.Api.Controllers
|
|
|
/// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
|
|
|
/// <param name="dtoService">Instance of the <see cref="IDtoService"/> interface.</param>
|
|
|
/// <param name="tvSeriesManager">Instance of the <see cref="ITVSeriesManager"/> interface.</param>
|
|
|
- /// <param name="authContext">Instance of the <see cref="IAuthorizationContext"/> interface.</param>
|
|
|
public TvShowsController(
|
|
|
IUserManager userManager,
|
|
|
ILibraryManager libraryManager,
|
|
|
IDtoService dtoService,
|
|
|
- ITVSeriesManager tvSeriesManager,
|
|
|
- IAuthorizationContext authContext)
|
|
|
+ ITVSeriesManager tvSeriesManager)
|
|
|
{
|
|
|
_userManager = userManager;
|
|
|
_libraryManager = libraryManager;
|
|
|
_dtoService = dtoService;
|
|
|
_tvSeriesManager = tvSeriesManager;
|
|
|
- _authContext = authContext;
|
|
|
}
|
|
|
|
|
|
/// <summary>
|
|
@@ -67,6 +67,7 @@ namespace Jellyfin.Api.Controllers
|
|
|
/// <param name="enableTotalRecordCount">Whether to enable the total records count. Defaults to true.</param>
|
|
|
/// <returns>A <see cref="QueryResult{BaseItemDto}"/> with the next up episodes.</returns>
|
|
|
[HttpGet("NextUp")]
|
|
|
+ [ProducesResponseType(StatusCodes.Status200OK)]
|
|
|
public ActionResult<QueryResult<BaseItemDto>> GetNextUp(
|
|
|
[FromQuery] Guid userId,
|
|
|
[FromQuery] int? startIndex,
|
|
@@ -76,14 +77,14 @@ namespace Jellyfin.Api.Controllers
|
|
|
[FromQuery] string? parentId,
|
|
|
[FromQuery] bool? enableImges,
|
|
|
[FromQuery] int? imageTypeLimit,
|
|
|
- [FromQuery] string enableImageTypes,
|
|
|
+ [FromQuery] string? enableImageTypes,
|
|
|
[FromQuery] bool? enableUserData,
|
|
|
[FromQuery] bool enableTotalRecordCount = true)
|
|
|
{
|
|
|
var options = new DtoOptions()
|
|
|
- .AddItemFields(fields)
|
|
|
+ .AddItemFields(fields!)
|
|
|
.AddClientFields(Request)
|
|
|
- .AddAdditionalDtoOptions(enableImges, enableUserData, imageTypeLimit, enableImageTypes);
|
|
|
+ .AddAdditionalDtoOptions(enableImges, enableUserData, imageTypeLimit, enableImageTypes!);
|
|
|
|
|
|
var result = _tvSeriesManager.GetNextUp(
|
|
|
new NextUpQuery
|
|
@@ -115,27 +116,24 @@ namespace Jellyfin.Api.Controllers
|
|
|
/// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
|
/// <param name="limit">Optional. The maximum number of records to return.</param>
|
|
|
/// <param name="fields">Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.</param>
|
|
|
- /// <param name="seriesId">Optional. Filter by series id.</param>
|
|
|
/// <param name="parentId">Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
|
|
/// <param name="enableImges">Optional. Include image information in output.</param>
|
|
|
/// <param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
|
/// <param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
|
/// <param name="enableUserData">Optional. Include user data.</param>
|
|
|
- /// <param name="enableTotalRecordCount">Whether to enable the total records count. Defaults to true.</param>
|
|
|
/// <returns>A <see cref="QueryResult{BaseItemDto}"/> with the next up episodes.</returns>
|
|
|
[HttpGet("Upcoming")]
|
|
|
+ [ProducesResponseType(StatusCodes.Status200OK)]
|
|
|
public ActionResult<QueryResult<BaseItemDto>> GetUpcomingEpisodes(
|
|
|
[FromQuery] Guid userId,
|
|
|
[FromQuery] int? startIndex,
|
|
|
[FromQuery] int? limit,
|
|
|
[FromQuery] string? fields,
|
|
|
- [FromQuery] string? seriesId,
|
|
|
[FromQuery] string? parentId,
|
|
|
[FromQuery] bool? enableImges,
|
|
|
[FromQuery] int? imageTypeLimit,
|
|
|
- [FromQuery] string enableImageTypes,
|
|
|
- [FromQuery] bool? enableUserData,
|
|
|
- [FromQuery] bool enableTotalRecordCount = true)
|
|
|
+ [FromQuery] string? enableImageTypes,
|
|
|
+ [FromQuery] bool? enableUserData)
|
|
|
{
|
|
|
var user = _userManager.GetUserById(userId);
|
|
|
|
|
@@ -144,9 +142,9 @@ namespace Jellyfin.Api.Controllers
|
|
|
var parentIdGuid = string.IsNullOrWhiteSpace(parentId) ? Guid.Empty : new Guid(parentId);
|
|
|
|
|
|
var options = new DtoOptions()
|
|
|
- .AddItemFields(fields)
|
|
|
+ .AddItemFields(fields!)
|
|
|
.AddClientFields(Request)
|
|
|
- .AddAdditionalDtoOptions(enableImges, enableUserData, imageTypeLimit, enableImageTypes);
|
|
|
+ .AddAdditionalDtoOptions(enableImges, enableUserData, imageTypeLimit, enableImageTypes!);
|
|
|
|
|
|
var itemsResult = _libraryManager.GetItemList(new InternalItemsQuery(user)
|
|
|
{
|
|
@@ -168,5 +166,215 @@ namespace Jellyfin.Api.Controllers
|
|
|
Items = returnItems
|
|
|
};
|
|
|
}
|
|
|
+
|
|
|
+ /// <summary>
|
|
|
+ /// Gets episodes for a tv season.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="seriesId">The series id.</param>
|
|
|
+ /// <param name="userId">The user id.</param>
|
|
|
+ /// <param name="fields">Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.</param>
|
|
|
+ /// <param name="season">Optional filter by season number.</param>
|
|
|
+ /// <param name="seasonId">Optional. Filter by season id.</param>
|
|
|
+ /// <param name="isMissing">Optional. Filter by items that are missing episodes or not.</param>
|
|
|
+ /// <param name="adjacentTo">Optional. Return items that are siblings of a supplied item.</param>
|
|
|
+ /// <param name="startItemId">Optional. Skip through the list until a given item is found.</param>
|
|
|
+ /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
|
+ /// <param name="limit">Optional. The maximum number of records to return.</param>
|
|
|
+ /// <param name="enableImages">Optional, include image information in output.</param>
|
|
|
+ /// <param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param>
|
|
|
+ /// <param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
|
+ /// <param name="enableUserData">Optional. Include user data.</param>
|
|
|
+ /// <param name="sortBy">Optional. Specify one or more sort orders, comma delimeted. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.</param>
|
|
|
+ /// <param name="sortOrder">Optional. Sort order: Ascending,Descending.</param>
|
|
|
+ /// <returns>A <see cref="QueryResult{BaseItemDto}"/> with the episodes on success or a <see cref="NotFoundResult"/> if the series was not found.</returns>
|
|
|
+ [HttpGet("{seriesId}/Episodes")]
|
|
|
+ [ProducesResponseType(StatusCodes.Status200OK)]
|
|
|
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
|
|
|
+ [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "sortOrder", Justification = "Imported from ServiceStack")]
|
|
|
+ public ActionResult<QueryResult<BaseItemDto>> GetEpisodes(
|
|
|
+ [FromRoute] string seriesId,
|
|
|
+ [FromQuery] Guid userId,
|
|
|
+ [FromQuery] string? fields,
|
|
|
+ [FromQuery] int? season,
|
|
|
+ [FromQuery] string? seasonId,
|
|
|
+ [FromQuery] bool? isMissing,
|
|
|
+ [FromQuery] string? adjacentTo,
|
|
|
+ [FromQuery] string? startItemId,
|
|
|
+ [FromQuery] int? startIndex,
|
|
|
+ [FromQuery] int? limit,
|
|
|
+ [FromQuery] bool? enableImages,
|
|
|
+ [FromQuery] int? imageTypeLimit,
|
|
|
+ [FromQuery] string? enableImageTypes,
|
|
|
+ [FromQuery] bool? enableUserData,
|
|
|
+ [FromQuery] string? sortBy,
|
|
|
+ [FromQuery] SortOrder? sortOrder)
|
|
|
+ {
|
|
|
+ var user = _userManager.GetUserById(userId);
|
|
|
+
|
|
|
+ List<BaseItem> episodes;
|
|
|
+
|
|
|
+ var dtoOptions = new DtoOptions()
|
|
|
+ .AddItemFields(fields!)
|
|
|
+ .AddClientFields(Request)
|
|
|
+ .AddAdditionalDtoOptions(enableImages, enableUserData, imageTypeLimit, enableImageTypes!);
|
|
|
+
|
|
|
+ if (!string.IsNullOrWhiteSpace(seasonId)) // Season id was supplied. Get episodes by season id.
|
|
|
+ {
|
|
|
+ var item = _libraryManager.GetItemById(new Guid(seasonId));
|
|
|
+ if (!(item is Season seasonItem))
|
|
|
+ {
|
|
|
+ return NotFound("No season exists with Id " + seasonId);
|
|
|
+ }
|
|
|
+
|
|
|
+ episodes = seasonItem.GetEpisodes(user, dtoOptions);
|
|
|
+ }
|
|
|
+ else if (season.HasValue) // Season number was supplied. Get episodes by season number
|
|
|
+ {
|
|
|
+ if (!(_libraryManager.GetItemById(seriesId) is Series series))
|
|
|
+ {
|
|
|
+ return NotFound("Series not found");
|
|
|
+ }
|
|
|
+
|
|
|
+ var seasonItem = series
|
|
|
+ .GetSeasons(user, dtoOptions)
|
|
|
+ .FirstOrDefault(i => i.IndexNumber == season.Value);
|
|
|
+
|
|
|
+ episodes = seasonItem == null ?
|
|
|
+ new List<BaseItem>()
|
|
|
+ : ((Season)seasonItem).GetEpisodes(user, dtoOptions);
|
|
|
+ }
|
|
|
+ else // No season number or season id was supplied. Returning all episodes.
|
|
|
+ {
|
|
|
+ if (!(_libraryManager.GetItemById(seriesId) is Series series))
|
|
|
+ {
|
|
|
+ return NotFound("Series not found");
|
|
|
+ }
|
|
|
+
|
|
|
+ episodes = series.GetEpisodes(user, dtoOptions).ToList();
|
|
|
+ }
|
|
|
+
|
|
|
+ // Filter after the fact in case the ui doesn't want them
|
|
|
+ if (isMissing.HasValue)
|
|
|
+ {
|
|
|
+ var val = isMissing.Value;
|
|
|
+ episodes = episodes
|
|
|
+ .Where(i => ((Episode)i).IsMissingEpisode == val)
|
|
|
+ .ToList();
|
|
|
+ }
|
|
|
+
|
|
|
+ if (!string.IsNullOrWhiteSpace(startItemId))
|
|
|
+ {
|
|
|
+ episodes = episodes
|
|
|
+ .SkipWhile(i => !string.Equals(i.Id.ToString("N", CultureInfo.InvariantCulture), startItemId, StringComparison.OrdinalIgnoreCase))
|
|
|
+ .ToList();
|
|
|
+ }
|
|
|
+
|
|
|
+ // This must be the last filter
|
|
|
+ if (!string.IsNullOrEmpty(adjacentTo))
|
|
|
+ {
|
|
|
+ episodes = UserViewBuilder.FilterForAdjacency(episodes, adjacentTo).ToList();
|
|
|
+ }
|
|
|
+
|
|
|
+ if (string.Equals(sortBy, ItemSortBy.Random, StringComparison.OrdinalIgnoreCase))
|
|
|
+ {
|
|
|
+ episodes.Shuffle();
|
|
|
+ }
|
|
|
+
|
|
|
+ var returnItems = episodes;
|
|
|
+
|
|
|
+ if (startIndex.HasValue || limit.HasValue)
|
|
|
+ {
|
|
|
+ returnItems = ApplyPaging(episodes, startIndex, limit).ToList();
|
|
|
+ }
|
|
|
+
|
|
|
+ var dtos = _dtoService.GetBaseItemDtos(returnItems, dtoOptions, user);
|
|
|
+
|
|
|
+ return new QueryResult<BaseItemDto>
|
|
|
+ {
|
|
|
+ TotalRecordCount = episodes.Count,
|
|
|
+ Items = dtos
|
|
|
+ };
|
|
|
+ }
|
|
|
+
|
|
|
+ /// <summary>
|
|
|
+ /// Gets seasons for a tv series.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="seriesId">The series id.</param>
|
|
|
+ /// <param name="userId">The user id.</param>
|
|
|
+ /// <param name="fields">Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.</param>
|
|
|
+ /// <param name="isSpecialSeason">Optional. Filter by special season.</param>
|
|
|
+ /// <param name="isMissing">Optional. Filter by items that are missing episodes or not.</param>
|
|
|
+ /// <param name="adjacentTo">Optional. Return items that are siblings of a supplied item.</param>
|
|
|
+ /// <param name="enableImages">Optional. Include image information in output.</param>
|
|
|
+ /// <param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
|
|
|
+ /// <param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
|
+ /// <param name="enableUserData">Optional. Include user data.</param>
|
|
|
+ /// <returns>A <see cref="QueryResult{BaseItemDto}"/> on success or a <see cref="NotFoundResult"/> if the series was not found.</returns>
|
|
|
+ [HttpGet("{seriesId}/Seasons")]
|
|
|
+ [ProducesResponseType(StatusCodes.Status200OK)]
|
|
|
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
|
|
|
+ public ActionResult<QueryResult<BaseItemDto>> GetSeasons(
|
|
|
+ [FromRoute] string seriesId,
|
|
|
+ [FromQuery] Guid userId,
|
|
|
+ [FromQuery] string fields,
|
|
|
+ [FromQuery] bool? isSpecialSeason,
|
|
|
+ [FromQuery] bool? isMissing,
|
|
|
+ [FromQuery] string adjacentTo,
|
|
|
+ [FromQuery] bool? enableImages,
|
|
|
+ [FromQuery] int? imageTypeLimit,
|
|
|
+ [FromQuery] string? enableImageTypes,
|
|
|
+ [FromQuery] bool? enableUserData)
|
|
|
+ {
|
|
|
+ var user = _userManager.GetUserById(userId);
|
|
|
+
|
|
|
+ if (!(_libraryManager.GetItemById(seriesId) is Series series))
|
|
|
+ {
|
|
|
+ return NotFound("Series not found");
|
|
|
+ }
|
|
|
+
|
|
|
+ var seasons = series.GetItemList(new InternalItemsQuery(user)
|
|
|
+ {
|
|
|
+ IsMissing = isMissing,
|
|
|
+ IsSpecialSeason = isSpecialSeason,
|
|
|
+ AdjacentTo = adjacentTo
|
|
|
+ });
|
|
|
+
|
|
|
+ var dtoOptions = new DtoOptions()
|
|
|
+ .AddItemFields(fields)
|
|
|
+ .AddClientFields(Request)
|
|
|
+ .AddAdditionalDtoOptions(enableImages, enableUserData, imageTypeLimit, enableImageTypes!);
|
|
|
+
|
|
|
+ var returnItems = _dtoService.GetBaseItemDtos(seasons, dtoOptions, user);
|
|
|
+
|
|
|
+ return new QueryResult<BaseItemDto>
|
|
|
+ {
|
|
|
+ TotalRecordCount = returnItems.Count,
|
|
|
+ Items = returnItems
|
|
|
+ };
|
|
|
+ }
|
|
|
+
|
|
|
+ /// <summary>
|
|
|
+ /// Applies the paging.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="items">The items.</param>
|
|
|
+ /// <param name="startIndex">The start index.</param>
|
|
|
+ /// <param name="limit">The limit.</param>
|
|
|
+ /// <returns>IEnumerable{BaseItem}.</returns>
|
|
|
+ private IEnumerable<BaseItem> ApplyPaging(IEnumerable<BaseItem> items, int? startIndex, int? limit)
|
|
|
+ {
|
|
|
+ // Start at
|
|
|
+ if (startIndex.HasValue)
|
|
|
+ {
|
|
|
+ items = items.Skip(startIndex.Value);
|
|
|
+ }
|
|
|
+
|
|
|
+ // Return limit
|
|
|
+ if (limit.HasValue)
|
|
|
+ {
|
|
|
+ items = items.Take(limit.Value);
|
|
|
+ }
|
|
|
+
|
|
|
+ return items;
|
|
|
+ }
|
|
|
}
|
|
|
}
|