jellyfin/MediaBrowser.Api/TvShowsService.cs

473 lines
21 KiB
C#
Raw Normal View History

2014-11-15 02:31:03 +00:00
using MediaBrowser.Common.Extensions;
using MediaBrowser.Controller.Dto;
2013-05-01 13:45:25 +00:00
using MediaBrowser.Controller.Entities;
using MediaBrowser.Controller.Entities.TV;
using MediaBrowser.Controller.Library;
2014-07-02 18:34:08 +00:00
using MediaBrowser.Controller.Net;
2013-05-01 13:45:25 +00:00
using MediaBrowser.Controller.Persistence;
using MediaBrowser.Controller.TV;
2013-10-26 22:01:21 +00:00
using MediaBrowser.Model.Entities;
2013-05-01 13:45:25 +00:00
using MediaBrowser.Model.Querying;
2013-12-07 15:52:38 +00:00
using ServiceStack;
2013-05-01 13:45:25 +00:00
using System;
using System.Collections.Generic;
using System.Linq;
namespace MediaBrowser.Api
{
/// <summary>
/// Class GetNextUpEpisodes
/// </summary>
2014-03-23 19:36:25 +00:00
[Route("/Shows/NextUp", "GET", Summary = "Gets a list of next up episodes")]
2014-12-01 12:43:34 +00:00
public class GetNextUpEpisodes : IReturn<ItemsResult>, IHasDtoOptions
2013-05-01 13:45:25 +00:00
{
/// <summary>
/// Gets or sets the user id.
/// </summary>
/// <value>The user id.</value>
[ApiMember(Name = "UserId", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
public string UserId { get; set; }
2013-05-01 13:45:25 +00:00
/// <summary>
/// Skips over a given number of items within the results. Use for paging.
/// </summary>
/// <value>The start index.</value>
[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; }
/// <summary>
/// The maximum number of items to return
/// </summary>
/// <value>The limit.</value>
[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; }
/// <summary>
/// Fields to return within the items, in addition to basic information
/// </summary>
/// <value>The fields.</value>
2014-05-27 14:30:21 +00:00
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, CriticRatingSummary, 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)]
2013-05-01 13:45:25 +00:00
public string Fields { get; set; }
2013-10-26 22:01:21 +00:00
[ApiMember(Name = "SeriesId", Description = "Optional. Filter by series id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string SeriesId { get; set; }
2014-05-02 02:54:33 +00:00
/// <summary>
/// Specify this to localize the search to a specific item or folder. Omit to use the root.
/// </summary>
/// <value>The parent id.</value>
[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; }
2014-12-01 12:43:34 +00:00
[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; }
}
2014-03-23 19:36:25 +00:00
[Route("/Shows/Upcoming", "GET", Summary = "Gets a list of upcoming episodes")]
2014-12-01 12:43:34 +00:00
public class GetUpcomingEpisodes : IReturn<ItemsResult>, IHasDtoOptions
2014-03-06 05:17:13 +00:00
{
/// <summary>
/// Gets or sets the user id.
/// </summary>
/// <value>The user id.</value>
[ApiMember(Name = "UserId", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
public Guid UserId { get; set; }
/// <summary>
/// Skips over a given number of items within the results. Use for paging.
/// </summary>
/// <value>The start index.</value>
[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; }
/// <summary>
/// The maximum number of items to return
/// </summary>
/// <value>The limit.</value>
[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; }
/// <summary>
/// Fields to return within the items, in addition to basic information
/// </summary>
/// <value>The fields.</value>
2014-05-27 14:30:21 +00:00
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, CriticRatingSummary, 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)]
2014-03-06 05:17:13 +00:00
public string Fields { get; set; }
2014-05-02 02:54:33 +00:00
/// <summary>
/// Specify this to localize the search to a specific item or folder. Omit to use the root.
/// </summary>
/// <value>The parent id.</value>
[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; }
2014-12-01 12:43:34 +00:00
[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; }
2014-03-06 05:17:13 +00:00
}
2014-03-23 19:36:25 +00:00
[Route("/Shows/{Id}/Similar", "GET", Summary = "Finds tv shows similar to a given one.")]
public class GetSimilarShows : BaseGetSimilarItemsFromItem
{
}
2014-03-23 19:36:25 +00:00
[Route("/Shows/{Id}/Episodes", "GET", Summary = "Gets episodes for a tv season")]
public class GetEpisodes : IReturn<ItemsResult>, IHasItemFields
{
2013-05-01 13:45:25 +00:00
/// <summary>
/// Gets or sets the user id.
2013-05-01 13:45:25 +00:00
/// </summary>
/// <value>The user id.</value>
[ApiMember(Name = "UserId", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
public Guid UserId { get; set; }
2013-05-01 13:45:25 +00:00
/// <summary>
/// Fields to return within the items, in addition to basic information
/// </summary>
/// <value>The fields.</value>
2014-05-27 14:30:21 +00:00
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, CriticRatingSummary, 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; }
2013-07-22 14:58:38 +00:00
[ApiMember(Name = "Id", Description = "The series id", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
public Guid Id { get; set; }
2013-07-22 14:58:38 +00:00
[ApiMember(Name = "Season", Description = "Optional filter by season number.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public int? Season { get; set; }
2013-05-01 13:45:25 +00:00
2013-11-30 18:32:39 +00:00
[ApiMember(Name = "SeasonId", Description = "Optional. Filter by season id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string SeasonId { get; set; }
2014-03-06 05:17:13 +00:00
[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 = "IsVirtualUnaired", Description = "Optional filter by items that are virtual unaired episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool? IsVirtualUnaired { 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; }
}
2013-06-17 20:35:43 +00:00
2014-03-23 19:36:25 +00:00
[Route("/Shows/{Id}/Seasons", "GET", Summary = "Gets seasons for a tv series")]
2013-11-28 18:27:29 +00:00
public class GetSeasons : IReturn<ItemsResult>, IHasItemFields
{
/// <summary>
/// Gets or sets the user id.
/// </summary>
/// <value>The user id.</value>
[ApiMember(Name = "UserId", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
public Guid UserId { get; set; }
/// <summary>
/// Fields to return within the items, in addition to basic information
/// </summary>
/// <value>The fields.</value>
2014-05-27 14:30:21 +00:00
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, CriticRatingSummary, 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)]
2013-11-28 18:27:29 +00:00
public string Fields { get; set; }
[ApiMember(Name = "Id", Description = "The series id", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
public Guid 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 = "IsVirtualUnaired", Description = "Optional filter by items that are virtual unaired episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool? IsVirtualUnaired { 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; }
2013-11-28 18:27:29 +00:00
}
2013-05-01 13:45:25 +00:00
/// <summary>
/// Class TvShowsService
/// </summary>
2014-07-02 18:34:08 +00:00
[Authenticated]
2013-05-01 13:45:25 +00:00
public class TvShowsService : BaseApiService
{
/// <summary>
/// The _user manager
/// </summary>
private readonly IUserManager _userManager;
/// <summary>
/// The _user data repository
/// </summary>
2013-11-03 20:48:16 +00:00
private readonly IUserDataManager _userDataManager;
2013-05-01 13:45:25 +00:00
/// <summary>
/// The _library manager
/// </summary>
private readonly ILibraryManager _libraryManager;
2013-06-18 19:16:27 +00:00
private readonly IItemRepository _itemRepo;
2013-09-04 17:02:19 +00:00
private readonly IDtoService _dtoService;
private readonly ITVSeriesManager _tvSeriesManager;
2013-09-04 17:02:19 +00:00
2013-05-01 13:45:25 +00:00
/// <summary>
/// Initializes a new instance of the <see cref="TvShowsService" /> class.
/// </summary>
/// <param name="userManager">The user manager.</param>
2013-11-03 20:48:16 +00:00
/// <param name="userDataManager">The user data repository.</param>
2013-05-01 13:45:25 +00:00
/// <param name="libraryManager">The library manager.</param>
public TvShowsService(IUserManager userManager, IUserDataManager userDataManager, ILibraryManager libraryManager, IItemRepository itemRepo, IDtoService dtoService, ITVSeriesManager tvSeriesManager)
2013-05-01 13:45:25 +00:00
{
_userManager = userManager;
2013-11-03 20:48:16 +00:00
_userDataManager = userDataManager;
2013-05-01 13:45:25 +00:00
_libraryManager = libraryManager;
2013-06-18 19:16:27 +00:00
_itemRepo = itemRepo;
2013-09-04 17:02:19 +00:00
_dtoService = dtoService;
_tvSeriesManager = tvSeriesManager;
2013-05-01 13:45:25 +00:00
}
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
public object Get(GetSimilarShows request)
{
2013-08-08 20:18:05 +00:00
var result = SimilarItemsHelper.GetSimilarItemsResult(_userManager,
2013-06-18 19:16:27 +00:00
_itemRepo,
2013-06-17 20:35:43 +00:00
_libraryManager,
2013-11-03 20:48:16 +00:00
_userDataManager,
2013-09-04 17:02:19 +00:00
_dtoService,
Logger,
request, item => item is Series,
SimilarItemsHelper.GetSimiliarityScore);
return ToOptimizedSerializedResultUsingCache(result);
}
2013-05-01 13:45:25 +00:00
2014-03-06 05:17:13 +00:00
public object Get(GetUpcomingEpisodes request)
{
var user = _userManager.GetUserById(request.UserId);
2014-05-02 02:54:33 +00:00
var items = GetAllLibraryItems(request.UserId, _userManager, _libraryManager, request.ParentId)
2014-03-06 05:17:13 +00:00
.OfType<Episode>();
var itemsList = _libraryManager.Sort(items, user, new[] { "PremiereDate", "AirTime", "SortName" }, SortOrder.Ascending)
.Cast<Episode>()
.ToList();
var unairedEpisodes = itemsList.Where(i => i.IsUnaired).ToList();
var minPremiereDate = DateTime.Now.Date.AddDays(-1).ToUniversalTime();
var previousEpisodes = itemsList.Where(i => !i.IsUnaired && (i.PremiereDate ?? DateTime.MinValue) >= minPremiereDate).ToList();
previousEpisodes.AddRange(unairedEpisodes);
var pagedItems = ApplyPaging(previousEpisodes, request.StartIndex, request.Limit);
2014-12-01 12:43:34 +00:00
var options = request.GetDtoOptions();
2014-03-06 05:17:13 +00:00
2014-12-01 12:43:34 +00:00
var returnItems = pagedItems.Select(i => _dtoService.GetBaseItemDto(i, options, user)).ToArray();
2014-03-06 05:17:13 +00:00
var result = new ItemsResult
{
TotalRecordCount = itemsList.Count,
Items = returnItems
};
return ToOptimizedSerializedResultUsingCache(result);
}
2013-05-01 13:45:25 +00:00
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
public object Get(GetNextUpEpisodes request)
2013-11-03 20:48:16 +00:00
{
var result = _tvSeriesManager.GetNextUp(new NextUpQuery
{
Limit = request.Limit,
ParentId = request.ParentId,
SeriesId = request.SeriesId,
StartIndex = request.StartIndex,
UserId = request.UserId
});
2013-11-03 20:48:16 +00:00
2014-09-14 15:10:51 +00:00
var user = _userManager.GetUserById(request.UserId);
2013-11-03 20:48:16 +00:00
2014-12-01 12:43:34 +00:00
var options = request.GetDtoOptions();
2013-11-03 20:48:16 +00:00
2014-12-01 12:43:34 +00:00
var returnItems = result.Items.Select(i => _dtoService.GetBaseItemDto(i, options, user)).ToArray();
2013-11-03 20:48:16 +00:00
return ToOptimizedSerializedResultUsingCache(new ItemsResult
2013-11-03 20:48:16 +00:00
{
TotalRecordCount = result.TotalRecordCount,
2013-11-03 20:48:16 +00:00
Items = returnItems
});
}
2013-05-01 13:45:25 +00:00
/// <summary>
/// Applies the paging.
/// </summary>
/// <param name="items">The items.</param>
2014-03-06 05:17:13 +00:00
/// <param name="startIndex">The start index.</param>
/// <param name="limit">The limit.</param>
2013-05-01 13:45:25 +00:00
/// <returns>IEnumerable{BaseItem}.</returns>
2014-03-06 05:17:13 +00:00
private IEnumerable<BaseItem> ApplyPaging(IEnumerable<BaseItem> items, int? startIndex, int? limit)
2013-05-01 13:45:25 +00:00
{
// Start at
2014-03-06 05:17:13 +00:00
if (startIndex.HasValue)
2013-05-01 13:45:25 +00:00
{
2014-03-06 05:17:13 +00:00
items = items.Skip(startIndex.Value);
2013-05-01 13:45:25 +00:00
}
// Return limit
2014-03-06 05:17:13 +00:00
if (limit.HasValue)
2013-05-01 13:45:25 +00:00
{
2014-03-06 05:17:13 +00:00
items = items.Take(limit.Value);
2013-05-01 13:45:25 +00:00
}
return items;
}
2013-11-28 18:27:29 +00:00
public object Get(GetSeasons request)
{
var user = _userManager.GetUserById(request.UserId);
var series = _libraryManager.GetItemById(request.Id) as Series;
if (series == null)
{
throw new ResourceNotFoundException("No series exists with Id " + request.Id);
}
var seasons = series.GetSeasons(user);
2013-11-28 18:27:29 +00:00
if (request.IsSpecialSeason.HasValue)
{
var val = request.IsSpecialSeason.Value;
seasons = seasons.Where(i => i.IsSpecialSeason == val);
}
seasons = FilterVirtualSeasons(request, seasons);
2013-11-28 18:27:29 +00:00
// This must be the last filter
if (!string.IsNullOrEmpty(request.AdjacentTo))
{
2014-10-08 01:37:45 +00:00
seasons = UserViewBuilder.FilterForAdjacency(seasons, request.AdjacentTo)
.Cast<Season>();
}
var fields = request.GetItemFields().ToList();
2013-11-28 18:27:29 +00:00
var returnItems = seasons.Select(i => _dtoService.GetBaseItemDto(i, fields, user))
.ToArray();
return new ItemsResult
{
TotalRecordCount = returnItems.Length,
Items = returnItems
};
}
private IEnumerable<Season> FilterVirtualSeasons(GetSeasons request, IEnumerable<Season> items)
{
if (request.IsMissing.HasValue && request.IsVirtualUnaired.HasValue)
{
var isMissing = request.IsMissing.Value;
var isVirtualUnaired = request.IsVirtualUnaired.Value;
if (!isMissing && !isVirtualUnaired)
{
return items.Where(i => !i.IsMissingOrVirtualUnaired);
}
}
if (request.IsMissing.HasValue)
{
var val = request.IsMissing.Value;
items = items.Where(i => i.IsMissingSeason == val);
}
if (request.IsVirtualUnaired.HasValue)
{
var val = request.IsVirtualUnaired.Value;
items = items.Where(i => i.IsVirtualUnaired == val);
}
return items;
}
2014-03-06 05:17:13 +00:00
public object Get(GetEpisodes request)
{
var user = _userManager.GetUserById(request.UserId);
IEnumerable<Episode> episodes;
if (string.IsNullOrEmpty(request.SeasonId))
2013-11-30 18:32:39 +00:00
{
var series = _libraryManager.GetItemById(request.Id) as Series;
2013-11-30 18:32:39 +00:00
if (series == null)
2013-11-30 18:32:39 +00:00
{
throw new ResourceNotFoundException("No series exists with Id " + request.Id);
2013-11-30 18:32:39 +00:00
}
episodes = series.GetEpisodes(user, request.Season.Value);
2013-11-30 18:32:39 +00:00
}
else
{
var season = _libraryManager.GetItemById(new Guid(request.SeasonId)) as Season;
if (season == null)
{
throw new ResourceNotFoundException("No season exists with Id " + request.SeasonId);
}
2014-03-06 05:17:13 +00:00
episodes = season.GetEpisodes(user);
}
// 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 => i.IsMissingEpisode == val);
}
// Filter after the fact in case the ui doesn't want them
if (request.IsVirtualUnaired.HasValue)
{
var val = request.IsVirtualUnaired.Value;
episodes = episodes.Where(i => i.IsVirtualUnaired == val);
}
2013-11-28 18:27:29 +00:00
// This must be the last filter
if (!string.IsNullOrEmpty(request.AdjacentTo))
{
2014-10-08 01:37:45 +00:00
episodes = UserViewBuilder.FilterForAdjacency(episodes, request.AdjacentTo)
.Cast<Episode>();
}
var fields = request.GetItemFields().ToList();
2014-03-19 04:59:45 +00:00
episodes = _libraryManager.ReplaceVideosWithPrimaryVersions(episodes).Cast<Episode>();
var returnItems = episodes.Select(i => _dtoService.GetBaseItemDto(i, fields, user))
.ToArray();
return new ItemsResult
{
TotalRecordCount = returnItems.Length,
Items = returnItems
};
}
2013-05-01 13:45:25 +00:00
}
}