diff --git a/Jellyfin.Api/Controllers/TvShowsController.cs b/Jellyfin.Api/Controllers/TvShowsController.cs
new file mode 100644
index 0000000000..bd950b39fd
--- /dev/null
+++ b/Jellyfin.Api/Controllers/TvShowsController.cs
@@ -0,0 +1,380 @@
+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.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
+{
+ ///
+ /// The tv shows controller.
+ ///
+ [Route("/Shows")]
+ [Authorize(Policy = Policies.DefaultAuthorization)]
+ public class TvShowsController : BaseJellyfinApiController
+ {
+ private readonly IUserManager _userManager;
+ private readonly ILibraryManager _libraryManager;
+ private readonly IDtoService _dtoService;
+ private readonly ITVSeriesManager _tvSeriesManager;
+
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// Instance of the interface.
+ /// Instance of the interface.
+ /// Instance of the interface.
+ /// Instance of the interface.
+ public TvShowsController(
+ IUserManager userManager,
+ ILibraryManager libraryManager,
+ IDtoService dtoService,
+ ITVSeriesManager tvSeriesManager)
+ {
+ _userManager = userManager;
+ _libraryManager = libraryManager;
+ _dtoService = dtoService;
+ _tvSeriesManager = tvSeriesManager;
+ }
+
+ ///
+ /// Gets a list of next up episodes.
+ ///
+ /// The user id of the user to get the next up episodes for.
+ /// Optional. The record index to start at. All items with a lower index will be dropped from the results.
+ /// Optional. The maximum number of records to return.
+ /// 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.
+ /// Optional. Filter by series id.
+ /// Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.
+ /// Optional. Include image information in output.
+ /// Optional. The max number of images to return, per image type.
+ /// Optional. The image types to include in the output.
+ /// Optional. Include user data.
+ /// Whether to enable the total records count. Defaults to true.
+ /// A with the next up episodes.
+ [HttpGet("NextUp")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ public ActionResult> GetNextUp(
+ [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)
+ {
+ var options = new DtoOptions()
+ .AddItemFields(fields!)
+ .AddClientFields(Request)
+ .AddAdditionalDtoOptions(enableImges, enableUserData, imageTypeLimit, enableImageTypes!);
+
+ var result = _tvSeriesManager.GetNextUp(
+ new NextUpQuery
+ {
+ Limit = limit,
+ ParentId = parentId,
+ SeriesId = seriesId,
+ StartIndex = startIndex,
+ UserId = userId,
+ EnableTotalRecordCount = enableTotalRecordCount
+ },
+ options);
+
+ var user = _userManager.GetUserById(userId);
+
+ var returnItems = _dtoService.GetBaseItemDtos(result.Items, options, user);
+
+ return new QueryResult
+ {
+ TotalRecordCount = result.TotalRecordCount,
+ Items = returnItems
+ };
+ }
+
+ ///
+ /// Gets a list of upcoming episodes.
+ ///
+ /// The user id of the user to get the upcoming episodes for.
+ /// Optional. The record index to start at. All items with a lower index will be dropped from the results.
+ /// Optional. The maximum number of records to return.
+ /// 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.
+ /// Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.
+ /// Optional. Include image information in output.
+ /// Optional. The max number of images to return, per image type.
+ /// Optional. The image types to include in the output.
+ /// Optional. Include user data.
+ /// A with the next up episodes.
+ [HttpGet("Upcoming")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ public ActionResult> GetUpcomingEpisodes(
+ [FromQuery] Guid userId,
+ [FromQuery] int? startIndex,
+ [FromQuery] int? limit,
+ [FromQuery] string? fields,
+ [FromQuery] string? parentId,
+ [FromQuery] bool? enableImges,
+ [FromQuery] int? imageTypeLimit,
+ [FromQuery] string? enableImageTypes,
+ [FromQuery] bool? enableUserData)
+ {
+ var user = _userManager.GetUserById(userId);
+
+ var minPremiereDate = DateTime.Now.Date.ToUniversalTime().AddDays(-1);
+
+ var parentIdGuid = string.IsNullOrWhiteSpace(parentId) ? Guid.Empty : new Guid(parentId);
+
+ var options = new DtoOptions()
+ .AddItemFields(fields!)
+ .AddClientFields(Request)
+ .AddAdditionalDtoOptions(enableImges, enableUserData, imageTypeLimit, enableImageTypes!);
+
+ var itemsResult = _libraryManager.GetItemList(new InternalItemsQuery(user)
+ {
+ IncludeItemTypes = new[] { nameof(Episode) },
+ OrderBy = new[] { ItemSortBy.PremiereDate, ItemSortBy.SortName }.Select(i => new ValueTuple(i, SortOrder.Ascending)).ToArray(),
+ MinPremiereDate = minPremiereDate,
+ StartIndex = startIndex,
+ Limit = limit,
+ ParentId = parentIdGuid,
+ Recursive = true,
+ DtoOptions = options
+ });
+
+ var returnItems = _dtoService.GetBaseItemDtos(itemsResult, options, user);
+
+ return new QueryResult
+ {
+ TotalRecordCount = itemsResult.Count,
+ Items = returnItems
+ };
+ }
+
+ ///
+ /// Gets episodes for a tv season.
+ ///
+ /// The series id.
+ /// The user id.
+ /// 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.
+ /// Optional filter by season number.
+ /// Optional. Filter by season id.
+ /// Optional. Filter by items that are missing episodes or not.
+ /// Optional. Return items that are siblings of a supplied item.
+ /// Optional. Skip through the list until a given item is found.
+ /// Optional. The record index to start at. All items with a lower index will be dropped from the results.
+ /// Optional. The maximum number of records to return.
+ /// Optional, include image information in output.
+ /// Optional, the max number of images to return, per image type.
+ /// Optional. The image types to include in the output.
+ /// Optional. Include user data.
+ /// 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.
+ /// Optional. Sort order: Ascending,Descending.
+ /// A with the episodes on success or a if the series was not found.
+ [HttpGet("{seriesId}/Episodes")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "sortOrder", Justification = "Imported from ServiceStack")]
+ public ActionResult> 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 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()
+ : ((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
+ {
+ TotalRecordCount = episodes.Count,
+ Items = dtos
+ };
+ }
+
+ ///
+ /// Gets seasons for a tv series.
+ ///
+ /// The series id.
+ /// The user id.
+ /// 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.
+ /// Optional. Filter by special season.
+ /// Optional. Filter by items that are missing episodes or not.
+ /// Optional. Return items that are siblings of a supplied item.
+ /// Optional. Include image information in output.
+ /// Optional. The max number of images to return, per image type.
+ /// Optional. The image types to include in the output.
+ /// Optional. Include user data.
+ /// A on success or a if the series was not found.
+ [HttpGet("{seriesId}/Seasons")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public ActionResult> 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
+ {
+ TotalRecordCount = returnItems.Count,
+ Items = returnItems
+ };
+ }
+
+ ///
+ /// Applies the paging.
+ ///
+ /// The items.
+ /// The start index.
+ /// The limit.
+ /// IEnumerable{BaseItem}.
+ private IEnumerable ApplyPaging(IEnumerable 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;
+ }
+ }
+}
diff --git a/MediaBrowser.Api/TvShowsService.cs b/MediaBrowser.Api/TvShowsService.cs
deleted file mode 100644
index 0c23d8b291..0000000000
--- a/MediaBrowser.Api/TvShowsService.cs
+++ /dev/null
@@ -1,498 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Globalization;
-using System.Linq;
-using MediaBrowser.Common.Extensions;
-using MediaBrowser.Controller.Configuration;
-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 MediaBrowser.Model.Services;
-using Microsoft.Extensions.Logging;
-
-namespace MediaBrowser.Api
-{
- ///
- /// Class GetNextUpEpisodes
- ///
- [Route("/Shows/NextUp", "GET", Summary = "Gets a list of next up episodes")]
- public class GetNextUpEpisodes : IReturn>, IHasDtoOptions
- {
- ///
- /// Gets or sets the user id.
- ///
- /// The user id.
- [ApiMember(Name = "UserId", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
- public Guid UserId { get; set; }
-
- ///
- /// Skips over a given number of items within the results. Use for paging.
- ///
- /// The start index.
- [ApiMember(Name = "StartIndex", Description = "Optional. The record index to start at. All items with a lower index will be dropped from the results.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
- public int? StartIndex { get; set; }
-
- ///
- /// The maximum number of items to return
- ///
- /// The limit.
- [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
- public int? Limit { get; set; }
-
- ///
- /// Fields to return within the items, in addition to basic information
- ///
- /// The fields.
- [ApiMember(Name = "Fields", Description = "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", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
- public string Fields { get; set; }
-
- [ApiMember(Name = "SeriesId", Description = "Optional. Filter by series id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
- public string SeriesId { get; set; }
-
- ///
- /// Specify this to localize the search to a specific item or folder. Omit to use the root.
- ///
- /// The parent id.
- [ApiMember(Name = "ParentId", Description = "Specify this to localize the search to a specific item or folder. Omit to use the root", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
- public string ParentId { get; set; }
-
- [ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
- public bool? EnableImages { get; set; }
-
- [ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
- public int? ImageTypeLimit { get; set; }
-
- [ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
- public string EnableImageTypes { get; set; }
-
- [ApiMember(Name = "EnableUserData", Description = "Optional, include user data", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
- public bool? EnableUserData { get; set; }
- public bool EnableTotalRecordCount { get; set; }
-
- public GetNextUpEpisodes()
- {
- EnableTotalRecordCount = true;
- }
- }
-
- [Route("/Shows/Upcoming", "GET", Summary = "Gets a list of upcoming episodes")]
- public class GetUpcomingEpisodes : IReturn>, IHasDtoOptions
- {
- ///
- /// Gets or sets the user id.
- ///
- /// The user id.
- [ApiMember(Name = "UserId", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
- public Guid UserId { get; set; }
-
- ///
- /// Skips over a given number of items within the results. Use for paging.
- ///
- /// The start index.
- [ApiMember(Name = "StartIndex", Description = "Optional. The record index to start at. All items with a lower index will be dropped from the results.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
- public int? StartIndex { get; set; }
-
- ///
- /// The maximum number of items to return
- ///
- /// The limit.
- [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
- public int? Limit { get; set; }
-
- ///
- /// Fields to return within the items, in addition to basic information
- ///
- /// The fields.
- [ApiMember(Name = "Fields", Description = "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", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
- public string Fields { get; set; }
-
- ///
- /// Specify this to localize the search to a specific item or folder. Omit to use the root.
- ///
- /// The parent id.
- [ApiMember(Name = "ParentId", Description = "Specify this to localize the search to a specific item or folder. Omit to use the root", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
- public string ParentId { get; set; }
-
- [ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
- public bool? EnableImages { get; set; }
-
- [ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
- public int? ImageTypeLimit { get; set; }
-
- [ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
- public string EnableImageTypes { get; set; }
-
- [ApiMember(Name = "EnableUserData", Description = "Optional, include user data", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
- public bool? EnableUserData { get; set; }
- }
-
- [Route("/Shows/{Id}/Episodes", "GET", Summary = "Gets episodes for a tv season")]
- public class GetEpisodes : IReturn>, IHasItemFields, IHasDtoOptions
- {
- ///
- /// Gets or sets the user id.
- ///
- /// The user id.
- [ApiMember(Name = "UserId", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
- public Guid UserId { get; set; }
-
- ///
- /// Fields to return within the items, in addition to basic information
- ///
- /// The fields.
- [ApiMember(Name = "Fields", Description = "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", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
- public string Fields { get; set; }
-
- [ApiMember(Name = "Id", Description = "The series id", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
- public string Id { get; set; }
-
- [ApiMember(Name = "Season", Description = "Optional filter by season number.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
- public int? Season { get; set; }
-
- [ApiMember(Name = "SeasonId", Description = "Optional. Filter by season id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
- public string SeasonId { get; set; }
-
- [ApiMember(Name = "IsMissing", Description = "Optional filter by items that are missing episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
- public bool? IsMissing { get; set; }
-
- [ApiMember(Name = "AdjacentTo", Description = "Optional. Return items that are siblings of a supplied item.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
- public string AdjacentTo { get; set; }
-
- [ApiMember(Name = "StartItemId", Description = "Optional. Skip through the list until a given item is found.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
- public string StartItemId { get; set; }
-
- ///
- /// Skips over a given number of items within the results. Use for paging.
- ///
- /// The start index.
- [ApiMember(Name = "StartIndex", Description = "Optional. The record index to start at. All items with a lower index will be dropped from the results.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
- public int? StartIndex { get; set; }
-
- ///
- /// The maximum number of items to return
- ///
- /// The limit.
- [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
- public int? Limit { get; set; }
-
- [ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
- public bool? EnableImages { get; set; }
-
- [ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
- public int? ImageTypeLimit { get; set; }
-
- [ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
- public string EnableImageTypes { get; set; }
-
- [ApiMember(Name = "EnableUserData", Description = "Optional, include user data", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
- public bool? EnableUserData { get; set; }
-
- [ApiMember(Name = "SortBy", Description = "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", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
- public string SortBy { get; set; }
-
- [ApiMember(Name = "SortOrder", Description = "Sort Order - Ascending,Descending", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
- public SortOrder? SortOrder { get; set; }
- }
-
- [Route("/Shows/{Id}/Seasons", "GET", Summary = "Gets seasons for a tv series")]
- public class GetSeasons : IReturn>, IHasItemFields, IHasDtoOptions
- {
- ///
- /// Gets or sets the user id.
- ///
- /// The user id.
- [ApiMember(Name = "UserId", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
- public Guid UserId { get; set; }
-
- ///
- /// Fields to return within the items, in addition to basic information
- ///
- /// The fields.
- [ApiMember(Name = "Fields", Description = "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", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
- public string Fields { get; set; }
-
- [ApiMember(Name = "Id", Description = "The series id", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
- public string Id { get; set; }
-
- [ApiMember(Name = "IsSpecialSeason", Description = "Optional. Filter by special season.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
- public bool? IsSpecialSeason { get; set; }
-
- [ApiMember(Name = "IsMissing", Description = "Optional filter by items that are missing episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
- public bool? IsMissing { get; set; }
-
- [ApiMember(Name = "AdjacentTo", Description = "Optional. Return items that are siblings of a supplied item.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
- public string AdjacentTo { get; set; }
-
- [ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
- public bool? EnableImages { get; set; }
-
- [ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
- public int? ImageTypeLimit { get; set; }
-
- [ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
- public string EnableImageTypes { get; set; }
-
- [ApiMember(Name = "EnableUserData", Description = "Optional, include user data", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
- public bool? EnableUserData { get; set; }
- }
-
- ///
- /// Class TvShowsService
- ///
- [Authenticated]
- public class TvShowsService : BaseApiService
- {
- ///
- /// The _user manager
- ///
- private readonly IUserManager _userManager;
-
- ///
- /// The _library manager
- ///
- private readonly ILibraryManager _libraryManager;
-
- private readonly IDtoService _dtoService;
- private readonly ITVSeriesManager _tvSeriesManager;
- private readonly IAuthorizationContext _authContext;
-
- ///
- /// Initializes a new instance of the class.
- ///
- /// The user manager.
- /// The user data repository.
- /// The library manager.
- public TvShowsService(
- ILogger logger,
- IServerConfigurationManager serverConfigurationManager,
- IHttpResultFactory httpResultFactory,
- IUserManager userManager,
- ILibraryManager libraryManager,
- IDtoService dtoService,
- ITVSeriesManager tvSeriesManager,
- IAuthorizationContext authContext)
- : base(logger, serverConfigurationManager, httpResultFactory)
- {
- _userManager = userManager;
- _libraryManager = libraryManager;
- _dtoService = dtoService;
- _tvSeriesManager = tvSeriesManager;
- _authContext = authContext;
- }
-
- public object Get(GetUpcomingEpisodes request)
- {
- var user = _userManager.GetUserById(request.UserId);
-
- var minPremiereDate = DateTime.Now.Date.ToUniversalTime().AddDays(-1);
-
- var parentIdGuid = string.IsNullOrWhiteSpace(request.ParentId) ? Guid.Empty : new Guid(request.ParentId);
-
- var options = GetDtoOptions(_authContext, request);
-
- var itemsResult = _libraryManager.GetItemList(new InternalItemsQuery(user)
- {
- IncludeItemTypes = new[] { typeof(Episode).Name },
- OrderBy = new[] { ItemSortBy.PremiereDate, ItemSortBy.SortName }.Select(i => new ValueTuple(i, SortOrder.Ascending)).ToArray(),
- MinPremiereDate = minPremiereDate,
- StartIndex = request.StartIndex,
- Limit = request.Limit,
- ParentId = parentIdGuid,
- Recursive = true,
- DtoOptions = options
-
- });
-
- var returnItems = _dtoService.GetBaseItemDtos(itemsResult, options, user);
-
- var result = new QueryResult
- {
- TotalRecordCount = itemsResult.Count,
- Items = returnItems
- };
-
- return ToOptimizedResult(result);
- }
-
- ///
- /// Gets the specified request.
- ///
- /// The request.
- /// System.Object.
- public object Get(GetNextUpEpisodes request)
- {
- var options = GetDtoOptions(_authContext, request);
-
- var result = _tvSeriesManager.GetNextUp(new NextUpQuery
- {
- Limit = request.Limit,
- ParentId = request.ParentId,
- SeriesId = request.SeriesId,
- StartIndex = request.StartIndex,
- UserId = request.UserId,
- EnableTotalRecordCount = request.EnableTotalRecordCount
- }, options);
-
- var user = _userManager.GetUserById(request.UserId);
-
- var returnItems = _dtoService.GetBaseItemDtos(result.Items, options, user);
-
- return ToOptimizedResult(new QueryResult
- {
- TotalRecordCount = result.TotalRecordCount,
- Items = returnItems
- });
- }
-
- ///
- /// Applies the paging.
- ///
- /// The items.
- /// The start index.
- /// The limit.
- /// IEnumerable{BaseItem}.
- private IEnumerable ApplyPaging(IEnumerable 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;
- }
-
- public object Get(GetSeasons request)
- {
- var user = _userManager.GetUserById(request.UserId);
-
- var series = GetSeries(request.Id);
-
- if (series == null)
- {
- throw new ResourceNotFoundException("Series not found");
- }
-
- var seasons = series.GetItemList(new InternalItemsQuery(user)
- {
- IsMissing = request.IsMissing,
- IsSpecialSeason = request.IsSpecialSeason,
- AdjacentTo = request.AdjacentTo
-
- });
-
- var dtoOptions = GetDtoOptions(_authContext, request);
-
- var returnItems = _dtoService.GetBaseItemDtos(seasons, dtoOptions, user);
-
- return new QueryResult
- {
- TotalRecordCount = returnItems.Count,
- Items = returnItems
- };
- }
-
- private Series GetSeries(string seriesId)
- {
- if (!string.IsNullOrWhiteSpace(seriesId))
- {
- return _libraryManager.GetItemById(seriesId) as Series;
- }
-
- return null;
- }
-
- public object Get(GetEpisodes request)
- {
- var user = _userManager.GetUserById(request.UserId);
-
- List episodes;
-
- var dtoOptions = GetDtoOptions(_authContext, request);
-
- if (!string.IsNullOrWhiteSpace(request.SeasonId))
- {
- if (!(_libraryManager.GetItemById(new Guid(request.SeasonId)) is Season season))
- {
- throw new ResourceNotFoundException("No season exists with Id " + request.SeasonId);
- }
-
- episodes = season.GetEpisodes(user, dtoOptions);
- }
- else if (request.Season.HasValue)
- {
- var series = GetSeries(request.Id);
-
- if (series == null)
- {
- throw new ResourceNotFoundException("Series not found");
- }
-
- var season = series.GetSeasons(user, dtoOptions).FirstOrDefault(i => i.IndexNumber == request.Season.Value);
-
- episodes = season == null ? new List() : ((Season)season).GetEpisodes(user, dtoOptions);
- }
- else
- {
- var series = GetSeries(request.Id);
-
- if (series == null)
- {
- throw new ResourceNotFoundException("Series not found");
- }
-
- episodes = series.GetEpisodes(user, dtoOptions).ToList();
- }
-
- // Filter after the fact in case the ui doesn't want them
- if (request.IsMissing.HasValue)
- {
- var val = request.IsMissing.Value;
- episodes = episodes.Where(i => ((Episode)i).IsMissingEpisode == val).ToList();
- }
-
- if (!string.IsNullOrWhiteSpace(request.StartItemId))
- {
- episodes = episodes.SkipWhile(i => !string.Equals(i.Id.ToString("N", CultureInfo.InvariantCulture), request.StartItemId, StringComparison.OrdinalIgnoreCase)).ToList();
- }
-
- // This must be the last filter
- if (!string.IsNullOrEmpty(request.AdjacentTo))
- {
- episodes = UserViewBuilder.FilterForAdjacency(episodes, request.AdjacentTo).ToList();
- }
-
- if (string.Equals(request.SortBy, ItemSortBy.Random, StringComparison.OrdinalIgnoreCase))
- {
- episodes.Shuffle();
- }
-
- var returnItems = episodes;
-
- if (request.StartIndex.HasValue || request.Limit.HasValue)
- {
- returnItems = ApplyPaging(episodes, request.StartIndex, request.Limit).ToList();
- }
-
- var dtos = _dtoService.GetBaseItemDtos(returnItems, dtoOptions, user);
-
- return new QueryResult
- {
- TotalRecordCount = episodes.Count,
- Items = dtos
- };
- }
- }
-}