2020-06-22 12:02:57 -04:00
using System ;
2020-06-24 08:40:37 -04:00
using System.Collections.Generic ;
2020-08-06 10:17:45 -04:00
using System.ComponentModel.DataAnnotations ;
2020-06-22 12:02:57 -04:00
using System.Linq ;
using Jellyfin.Api.Constants ;
using Jellyfin.Api.Extensions ;
2020-11-09 16:59:04 -05:00
using Jellyfin.Api.ModelBinders ;
2020-08-03 14:01:24 -04:00
using Jellyfin.Data.Enums ;
2020-06-24 08:40:37 -04:00
using MediaBrowser.Common.Extensions ;
2020-06-22 12:02:57 -04:00
using MediaBrowser.Controller.Dto ;
using MediaBrowser.Controller.Entities ;
using MediaBrowser.Controller.Entities.TV ;
using MediaBrowser.Controller.Library ;
using MediaBrowser.Controller.TV ;
using MediaBrowser.Model.Dto ;
2020-10-09 19:52:39 -04:00
using MediaBrowser.Model.Entities ;
2020-06-22 12:02:57 -04:00
using MediaBrowser.Model.Querying ;
using Microsoft.AspNetCore.Authorization ;
2020-06-24 08:40:37 -04:00
using Microsoft.AspNetCore.Http ;
2020-06-22 12:02:57 -04:00
using Microsoft.AspNetCore.Mvc ;
namespace Jellyfin.Api.Controllers
{
/// <summary>
/// The tv shows controller.
/// </summary>
2020-08-04 10:27:54 -04:00
[Route("Shows")]
2020-06-22 12:02:57 -04:00
[Authorize(Policy = Policies.DefaultAuthorization)]
public class TvShowsController : BaseJellyfinApiController
{
private readonly IUserManager _userManager ;
private readonly ILibraryManager _libraryManager ;
private readonly IDtoService _dtoService ;
private readonly ITVSeriesManager _tvSeriesManager ;
/// <summary>
/// Initializes a new instance of the <see cref="TvShowsController"/> class.
/// </summary>
/// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
/// <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>
public TvShowsController (
IUserManager userManager ,
ILibraryManager libraryManager ,
IDtoService dtoService ,
2020-06-24 08:40:37 -04:00
ITVSeriesManager tvSeriesManager )
2020-06-22 12:02:57 -04:00
{
_userManager = userManager ;
_libraryManager = libraryManager ;
_dtoService = dtoService ;
_tvSeriesManager = tvSeriesManager ;
}
/// <summary>
/// Gets a list of next up episodes.
/// </summary>
/// <param name="userId">The user id of the user to get the next up episodes for.</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>
2020-10-09 19:35:08 -04:00
/// <param name="fields">Optional. Specify additional fields of information to return in the output.</param>
2020-06-22 12:02:57 -04:00
/// <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>
2021-01-15 17:08:48 -05:00
/// <param name="disableFirstEpisode">Whether to disable sending the first episode in a series as next up.</param>
2020-06-22 12:02:57 -04:00
/// <returns>A <see cref="QueryResult{BaseItemDto}"/> with the next up episodes.</returns>
[HttpGet("NextUp")]
2020-06-24 08:40:37 -04:00
[ProducesResponseType(StatusCodes.Status200OK)]
2020-06-22 12:02:57 -04:00
public ActionResult < QueryResult < BaseItemDto > > GetNextUp (
2020-09-09 16:28:30 -04:00
[FromQuery] Guid ? userId ,
2020-06-22 12:02:57 -04:00
[FromQuery] int? startIndex ,
[FromQuery] int? limit ,
2020-11-09 16:59:04 -05:00
[FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ItemFields [ ] fields ,
2020-06-22 12:02:57 -04:00
[FromQuery] string? seriesId ,
2020-12-01 13:07:41 -05:00
[FromQuery] Guid ? parentId ,
2020-06-22 12:02:57 -04:00
[FromQuery] bool? enableImges ,
[FromQuery] int? imageTypeLimit ,
2020-11-09 16:53:23 -05:00
[FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ImageType [ ] enableImageTypes ,
2020-06-22 12:02:57 -04:00
[FromQuery] bool? enableUserData ,
2021-01-15 17:08:48 -05:00
[FromQuery] bool enableTotalRecordCount = true ,
[FromQuery] bool disableFirstEpisode = false )
2020-06-22 12:02:57 -04:00
{
2020-10-29 13:36:45 -04:00
var options = new DtoOptions { Fields = fields }
2020-06-22 12:02:57 -04:00
. AddClientFields ( Request )
2020-06-24 08:40:37 -04:00
. AddAdditionalDtoOptions ( enableImges , enableUserData , imageTypeLimit , enableImageTypes ! ) ;
2020-06-22 12:02:57 -04:00
var result = _tvSeriesManager . GetNextUp (
new NextUpQuery
{
Limit = limit ,
ParentId = parentId ,
SeriesId = seriesId ,
StartIndex = startIndex ,
2020-07-07 11:10:51 -04:00
UserId = userId ? ? Guid . Empty ,
2021-01-15 17:08:48 -05:00
EnableTotalRecordCount = enableTotalRecordCount ,
DisableFirstEpisode = disableFirstEpisode
2020-06-22 12:02:57 -04:00
} ,
options ) ;
2020-07-07 11:10:51 -04:00
var user = userId . HasValue & & ! userId . Equals ( Guid . Empty )
? _userManager . GetUserById ( userId . Value )
: null ;
2020-06-22 12:02:57 -04:00
var returnItems = _dtoService . GetBaseItemDtos ( result . Items , options , user ) ;
return new QueryResult < BaseItemDto >
{
TotalRecordCount = result . TotalRecordCount ,
Items = returnItems
} ;
}
/// <summary>
/// Gets a list of upcoming episodes.
/// </summary>
/// <param name="userId">The user id of the user to get the upcoming episodes for.</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>
2020-10-09 19:35:08 -04:00
/// <param name="fields">Optional. Specify additional fields of information to return in the output.</param>
2020-06-22 12:02:57 -04:00
/// <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>
/// <returns>A <see cref="QueryResult{BaseItemDto}"/> with the next up episodes.</returns>
[HttpGet("Upcoming")]
2020-06-24 08:40:37 -04:00
[ProducesResponseType(StatusCodes.Status200OK)]
2020-06-22 12:02:57 -04:00
public ActionResult < QueryResult < BaseItemDto > > GetUpcomingEpisodes (
2020-09-09 16:28:30 -04:00
[FromQuery] Guid ? userId ,
2020-06-22 12:02:57 -04:00
[FromQuery] int? startIndex ,
[FromQuery] int? limit ,
2020-11-09 16:59:04 -05:00
[FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ItemFields [ ] fields ,
2020-12-01 13:07:41 -05:00
[FromQuery] Guid ? parentId ,
2020-06-22 12:02:57 -04:00
[FromQuery] bool? enableImges ,
[FromQuery] int? imageTypeLimit ,
2020-11-09 16:53:23 -05:00
[FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ImageType [ ] enableImageTypes ,
2020-06-24 08:40:37 -04:00
[FromQuery] bool? enableUserData )
2020-06-22 12:02:57 -04:00
{
2020-07-07 11:10:51 -04:00
var user = userId . HasValue & & ! userId . Equals ( Guid . Empty )
? _userManager . GetUserById ( userId . Value )
: null ;
2020-06-22 12:02:57 -04:00
var minPremiereDate = DateTime . Now . Date . ToUniversalTime ( ) . AddDays ( - 1 ) ;
2020-12-01 13:07:41 -05:00
var parentIdGuid = parentId ? ? Guid . Empty ;
2020-06-22 12:02:57 -04:00
2020-10-29 13:36:45 -04:00
var options = new DtoOptions { Fields = fields }
2020-06-22 12:02:57 -04:00
. AddClientFields ( Request )
2020-06-24 08:40:37 -04:00
. AddAdditionalDtoOptions ( enableImges , enableUserData , imageTypeLimit , enableImageTypes ! ) ;
2020-06-22 12:02:57 -04:00
var itemsResult = _libraryManager . GetItemList ( new InternalItemsQuery ( user )
{
IncludeItemTypes = new [ ] { nameof ( Episode ) } ,
2021-04-21 16:25:08 -04:00
OrderBy = new [ ] { ( ItemSortBy . PremiereDate , SortOrder . Ascending ) , ( ItemSortBy . SortName , SortOrder . Ascending ) } ,
2020-06-22 12:02:57 -04:00
MinPremiereDate = minPremiereDate ,
StartIndex = startIndex ,
Limit = limit ,
ParentId = parentIdGuid ,
Recursive = true ,
DtoOptions = options
} ) ;
var returnItems = _dtoService . GetBaseItemDtos ( itemsResult , options , user ) ;
return new QueryResult < BaseItemDto >
{
TotalRecordCount = itemsResult . Count ,
Items = returnItems
} ;
}
2020-06-24 08:40:37 -04:00
/// <summary>
/// Gets episodes for a tv season.
/// </summary>
/// <param name="seriesId">The series id.</param>
/// <param name="userId">The user id.</param>
2020-11-18 08:23:45 -05:00
/// <param name="fields">Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.</param>
2020-06-24 08:40:37 -04:00
/// <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>
2020-11-18 08:23:45 -05:00
/// <param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.</param>
2020-06-24 08:40:37 -04:00
/// <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)]
public ActionResult < QueryResult < BaseItemDto > > GetEpisodes (
2020-12-01 13:07:41 -05:00
[FromRoute, Required] Guid seriesId ,
2020-09-07 20:45:06 -04:00
[FromQuery] Guid ? userId ,
2020-11-09 16:59:04 -05:00
[FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ItemFields [ ] fields ,
2020-06-24 08:40:37 -04:00
[FromQuery] int? season ,
2020-12-01 13:07:41 -05:00
[FromQuery] Guid ? seasonId ,
2020-06-24 08:40:37 -04:00
[FromQuery] bool? isMissing ,
[FromQuery] string? adjacentTo ,
2020-12-01 13:07:41 -05:00
[FromQuery] Guid ? startItemId ,
2020-06-24 08:40:37 -04:00
[FromQuery] int? startIndex ,
[FromQuery] int? limit ,
[FromQuery] bool? enableImages ,
[FromQuery] int? imageTypeLimit ,
2020-11-09 16:53:23 -05:00
[FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ImageType [ ] enableImageTypes ,
2020-06-24 08:40:37 -04:00
[FromQuery] bool? enableUserData ,
2020-06-24 16:43:28 -04:00
[FromQuery] string? sortBy )
2020-06-24 08:40:37 -04:00
{
2020-07-07 11:10:51 -04:00
var user = userId . HasValue & & ! userId . Equals ( Guid . Empty )
? _userManager . GetUserById ( userId . Value )
: null ;
2020-06-24 08:40:37 -04:00
List < BaseItem > episodes ;
2020-10-29 13:36:45 -04:00
var dtoOptions = new DtoOptions { Fields = fields }
2020-06-24 08:40:37 -04:00
. AddClientFields ( Request )
. AddAdditionalDtoOptions ( enableImages , enableUserData , imageTypeLimit , enableImageTypes ! ) ;
2020-12-01 13:07:41 -05:00
if ( seasonId . HasValue ) // Season id was supplied. Get episodes by season id.
2020-06-24 08:40:37 -04:00
{
2020-12-01 13:07:41 -05:00
var item = _libraryManager . GetItemById ( seasonId . Value ) ;
2020-06-24 08:40:37 -04:00
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 ( ) ;
}
2020-12-01 13:07:41 -05:00
if ( startItemId . HasValue )
2020-06-24 08:40:37 -04:00
{
episodes = episodes
2021-01-02 21:23:54 -05:00
. SkipWhile ( i = > ! startItemId . Value . Equals ( i . Id ) )
2020-06-24 08:40:37 -04:00
. 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>
2020-11-18 08:23:45 -05:00
/// <param name="fields">Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.</param>
2020-06-24 08:40:37 -04:00
/// <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 (
2020-12-01 13:07:41 -05:00
[FromRoute, Required] Guid seriesId ,
2020-09-07 20:45:06 -04:00
[FromQuery] Guid ? userId ,
2020-11-09 16:59:04 -05:00
[FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ItemFields [ ] fields ,
2020-06-24 08:40:37 -04:00
[FromQuery] bool? isSpecialSeason ,
[FromQuery] bool? isMissing ,
2020-06-27 12:50:44 -04:00
[FromQuery] string? adjacentTo ,
2020-06-24 08:40:37 -04:00
[FromQuery] bool? enableImages ,
[FromQuery] int? imageTypeLimit ,
2020-11-09 16:53:23 -05:00
[FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ImageType [ ] enableImageTypes ,
2020-06-24 08:40:37 -04:00
[FromQuery] bool? enableUserData )
{
2020-07-07 11:10:51 -04:00
var user = userId . HasValue & & ! userId . Equals ( Guid . Empty )
? _userManager . GetUserById ( userId . Value )
: null ;
2020-06-24 08:40:37 -04:00
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
} ) ;
2020-10-29 13:36:45 -04:00
var dtoOptions = new DtoOptions { Fields = fields }
2020-06-24 08:40:37 -04:00
. 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 ;
}
2020-06-22 12:02:57 -04:00
}
}