TvShowsService.cs 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492
  1. using MediaBrowser.Api.UserLibrary;
  2. using MediaBrowser.Common.Extensions;
  3. using MediaBrowser.Controller.Dto;
  4. using MediaBrowser.Controller.Entities;
  5. using MediaBrowser.Controller.Entities.TV;
  6. using MediaBrowser.Controller.Library;
  7. using MediaBrowser.Controller.Persistence;
  8. using MediaBrowser.Model.Entities;
  9. using MediaBrowser.Model.Querying;
  10. using ServiceStack;
  11. using System;
  12. using System.Collections.Generic;
  13. using System.Linq;
  14. namespace MediaBrowser.Api
  15. {
  16. /// <summary>
  17. /// Class GetNextUpEpisodes
  18. /// </summary>
  19. [Route("/Shows/NextUp", "GET")]
  20. [Api(("Gets a list of currently installed plugins"))]
  21. public class GetNextUpEpisodes : IReturn<ItemsResult>, IHasItemFields
  22. {
  23. /// <summary>
  24. /// Gets or sets the user id.
  25. /// </summary>
  26. /// <value>The user id.</value>
  27. [ApiMember(Name = "UserId", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
  28. public Guid UserId { get; set; }
  29. /// <summary>
  30. /// Skips over a given number of items within the results. Use for paging.
  31. /// </summary>
  32. /// <value>The start index.</value>
  33. [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")]
  34. public int? StartIndex { get; set; }
  35. /// <summary>
  36. /// The maximum number of items to return
  37. /// </summary>
  38. /// <value>The limit.</value>
  39. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  40. public int? Limit { get; set; }
  41. /// <summary>
  42. /// Fields to return within the items, in addition to basic information
  43. /// </summary>
  44. /// <value>The fields.</value>
  45. [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, OverviewHtml, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  46. public string Fields { get; set; }
  47. [ApiMember(Name = "SeriesId", Description = "Optional. Filter by series id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  48. public string SeriesId { get; set; }
  49. }
  50. [Route("/Shows/{Id}/Similar", "GET")]
  51. [Api(Description = "Finds tv shows similar to a given one.")]
  52. public class GetSimilarShows : BaseGetSimilarItemsFromItem
  53. {
  54. }
  55. [Route("/Shows/{Id}/Episodes", "GET")]
  56. [Api(Description = "Gets episodes for a tv season")]
  57. public class GetEpisodes : IReturn<ItemsResult>, IHasItemFields
  58. {
  59. /// <summary>
  60. /// Gets or sets the user id.
  61. /// </summary>
  62. /// <value>The user id.</value>
  63. [ApiMember(Name = "UserId", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
  64. public Guid UserId { get; set; }
  65. /// <summary>
  66. /// Fields to return within the items, in addition to basic information
  67. /// </summary>
  68. /// <value>The fields.</value>
  69. [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, OverviewHtml, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  70. public string Fields { get; set; }
  71. [ApiMember(Name = "Id", Description = "The series id", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
  72. public Guid Id { get; set; }
  73. [ApiMember(Name = "Season", Description = "Optional filter by season number.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  74. public int? Season { get; set; }
  75. [ApiMember(Name = "SeasonId", Description = "Optional. Filter by season id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  76. public string SeasonId { get; set; }
  77. [ApiMember(Name = "IsMissing", Description = "Optional filter by items that are missing episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  78. public bool? IsMissing { get; set; }
  79. [ApiMember(Name = "IsVirtualUnaired", Description = "Optional filter by items that are virtual unaired episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  80. public bool? IsVirtualUnaired { get; set; }
  81. [ApiMember(Name = "AdjacentTo", Description = "Optional. Return items that are siblings of a supplied item.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  82. public string AdjacentTo { get; set; }
  83. }
  84. [Route("/Shows/{Id}/Seasons", "GET")]
  85. [Api(Description = "Gets seasons for a tv series")]
  86. public class GetSeasons : IReturn<ItemsResult>, IHasItemFields
  87. {
  88. /// <summary>
  89. /// Gets or sets the user id.
  90. /// </summary>
  91. /// <value>The user id.</value>
  92. [ApiMember(Name = "UserId", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
  93. public Guid UserId { get; set; }
  94. /// <summary>
  95. /// Fields to return within the items, in addition to basic information
  96. /// </summary>
  97. /// <value>The fields.</value>
  98. [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, OverviewHtml, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  99. public string Fields { get; set; }
  100. [ApiMember(Name = "Id", Description = "The series id", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
  101. public Guid Id { get; set; }
  102. [ApiMember(Name = "IsSpecialSeason", Description = "Optional. Filter by special season.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  103. public bool? IsSpecialSeason { get; set; }
  104. [ApiMember(Name = "IsMissing", Description = "Optional filter by items that are missing episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  105. public bool? IsMissing { get; set; }
  106. [ApiMember(Name = "IsVirtualUnaired", Description = "Optional filter by items that are virtual unaired episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  107. public bool? IsVirtualUnaired { get; set; }
  108. [ApiMember(Name = "AdjacentTo", Description = "Optional. Return items that are siblings of a supplied item.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  109. public string AdjacentTo { get; set; }
  110. }
  111. /// <summary>
  112. /// Class TvShowsService
  113. /// </summary>
  114. public class TvShowsService : BaseApiService
  115. {
  116. /// <summary>
  117. /// The _user manager
  118. /// </summary>
  119. private readonly IUserManager _userManager;
  120. /// <summary>
  121. /// The _user data repository
  122. /// </summary>
  123. private readonly IUserDataManager _userDataManager;
  124. /// <summary>
  125. /// The _library manager
  126. /// </summary>
  127. private readonly ILibraryManager _libraryManager;
  128. private readonly IItemRepository _itemRepo;
  129. private readonly IDtoService _dtoService;
  130. /// <summary>
  131. /// Initializes a new instance of the <see cref="TvShowsService" /> class.
  132. /// </summary>
  133. /// <param name="userManager">The user manager.</param>
  134. /// <param name="userDataManager">The user data repository.</param>
  135. /// <param name="libraryManager">The library manager.</param>
  136. public TvShowsService(IUserManager userManager, IUserDataManager userDataManager, ILibraryManager libraryManager, IItemRepository itemRepo, IDtoService dtoService)
  137. {
  138. _userManager = userManager;
  139. _userDataManager = userDataManager;
  140. _libraryManager = libraryManager;
  141. _itemRepo = itemRepo;
  142. _dtoService = dtoService;
  143. }
  144. /// <summary>
  145. /// Gets the specified request.
  146. /// </summary>
  147. /// <param name="request">The request.</param>
  148. /// <returns>System.Object.</returns>
  149. public object Get(GetSimilarShows request)
  150. {
  151. var result = SimilarItemsHelper.GetSimilarItemsResult(_userManager,
  152. _itemRepo,
  153. _libraryManager,
  154. _userDataManager,
  155. _dtoService,
  156. Logger,
  157. request, item => item is Series,
  158. SimilarItemsHelper.GetSimiliarityScore);
  159. return ToOptimizedResult(result);
  160. }
  161. /// <summary>
  162. /// Gets the specified request.
  163. /// </summary>
  164. /// <param name="request">The request.</param>
  165. /// <returns>System.Object.</returns>
  166. public object Get(GetNextUpEpisodes request)
  167. {
  168. var result = GetNextUpEpisodeItemsResult(request);
  169. return ToOptimizedResult(result);
  170. }
  171. /// <summary>
  172. /// Gets the next up episodes.
  173. /// </summary>
  174. /// <param name="request">The request.</param>
  175. /// <returns>Task{ItemsResult}.</returns>
  176. private ItemsResult GetNextUpEpisodeItemsResult(GetNextUpEpisodes request)
  177. {
  178. var user = _userManager.GetUserById(request.UserId);
  179. var itemsList = GetNextUpEpisodes(request)
  180. .ToList();
  181. var pagedItems = ApplyPaging(request, itemsList);
  182. var fields = request.GetItemFields().ToList();
  183. var returnItems = pagedItems.Select(i => _dtoService.GetBaseItemDto(i, fields, user)).ToArray();
  184. return new ItemsResult
  185. {
  186. TotalRecordCount = itemsList.Count,
  187. Items = returnItems
  188. };
  189. }
  190. public IEnumerable<Episode> GetNextUpEpisodes(GetNextUpEpisodes request)
  191. {
  192. var user = _userManager.GetUserById(request.UserId);
  193. var items = user.RootFolder
  194. .GetRecursiveChildren(user)
  195. .OfType<Series>();
  196. // Avoid implicitly captured closure
  197. return GetNextUpEpisodes(request, items);
  198. }
  199. public IEnumerable<Episode> GetNextUpEpisodes(GetNextUpEpisodes request, IEnumerable<Series> series)
  200. {
  201. var user = _userManager.GetUserById(request.UserId);
  202. // Avoid implicitly captured closure
  203. var currentUser = user;
  204. return FilterSeries(request, series)
  205. .AsParallel()
  206. .Select(i => GetNextUp(i, currentUser, request).Item1)
  207. .Where(i => i != null)
  208. .OrderByDescending(i =>
  209. {
  210. var seriesUserData = _userDataManager.GetUserData(user.Id, i.Series.GetUserDataKey());
  211. if (seriesUserData.IsFavorite)
  212. {
  213. return 2;
  214. }
  215. if (seriesUserData.Likes.HasValue)
  216. {
  217. return seriesUserData.Likes.Value ? 1 : -1;
  218. }
  219. return 0;
  220. })
  221. .ThenByDescending(i => i.PremiereDate ?? DateTime.MinValue);
  222. }
  223. /// <summary>
  224. /// Gets the next up.
  225. /// </summary>
  226. /// <param name="series">The series.</param>
  227. /// <param name="user">The user.</param>
  228. /// <param name="request">The request.</param>
  229. /// <returns>Task{Episode}.</returns>
  230. private Tuple<Episode, DateTime> GetNextUp(Series series, User user, GetNextUpEpisodes request)
  231. {
  232. var allEpisodes = series.GetRecursiveChildren(user)
  233. .OfType<Episode>()
  234. .OrderByDescending(i => i.PremiereDate ?? DateTime.MinValue)
  235. .ThenByDescending(i => i.IndexNumber ?? 0)
  236. .ToList();
  237. allEpisodes = FilterItems(request, allEpisodes).ToList();
  238. Episode lastWatched = null;
  239. var lastWatchedDate = DateTime.MinValue;
  240. Episode nextUp = null;
  241. // Go back starting with the most recent episodes
  242. foreach (var episode in allEpisodes)
  243. {
  244. var userData = _userDataManager.GetUserData(user.Id, episode.GetUserDataKey());
  245. if (userData.Played)
  246. {
  247. if (lastWatched != null || nextUp == null)
  248. {
  249. break;
  250. }
  251. lastWatched = episode;
  252. lastWatchedDate = userData.LastPlayedDate ?? DateTime.MinValue;
  253. }
  254. else
  255. {
  256. nextUp = episode;
  257. }
  258. }
  259. if (lastWatched != null)
  260. {
  261. return new Tuple<Episode, DateTime>(nextUp, lastWatchedDate);
  262. }
  263. return new Tuple<Episode, DateTime>(null, lastWatchedDate);
  264. }
  265. private IEnumerable<Episode> FilterItems(GetNextUpEpisodes request, IEnumerable<Episode> items)
  266. {
  267. // Make this configurable when needed
  268. items = items.Where(i => i.LocationType != LocationType.Virtual);
  269. return items;
  270. }
  271. private IEnumerable<Series> FilterSeries(GetNextUpEpisodes request, IEnumerable<Series> items)
  272. {
  273. if (!string.IsNullOrWhiteSpace(request.SeriesId))
  274. {
  275. var id = new Guid(request.SeriesId);
  276. items = items.Where(i => i.Id == id);
  277. }
  278. return items;
  279. }
  280. /// <summary>
  281. /// Applies the paging.
  282. /// </summary>
  283. /// <param name="request">The request.</param>
  284. /// <param name="items">The items.</param>
  285. /// <returns>IEnumerable{BaseItem}.</returns>
  286. private IEnumerable<BaseItem> ApplyPaging(GetNextUpEpisodes request, IEnumerable<BaseItem> items)
  287. {
  288. // Start at
  289. if (request.StartIndex.HasValue)
  290. {
  291. items = items.Skip(request.StartIndex.Value);
  292. }
  293. // Return limit
  294. if (request.Limit.HasValue)
  295. {
  296. items = items.Take(request.Limit.Value);
  297. }
  298. return items;
  299. }
  300. public object Get(GetSeasons request)
  301. {
  302. var user = _userManager.GetUserById(request.UserId);
  303. var series = _libraryManager.GetItemById(request.Id) as Series;
  304. if (series == null)
  305. {
  306. throw new ResourceNotFoundException("No series exists with Id " + request.Id);
  307. }
  308. var seasons = series.GetSeasons(user);
  309. if (request.IsSpecialSeason.HasValue)
  310. {
  311. var val = request.IsSpecialSeason.Value;
  312. seasons = seasons.Where(i => i.IsSpecialSeason == val);
  313. }
  314. seasons = FilterVirtualSeasons(request, seasons);
  315. // This must be the last filter
  316. if (!string.IsNullOrEmpty(request.AdjacentTo))
  317. {
  318. seasons = ItemsService.FilterForAdjacency(seasons, request.AdjacentTo)
  319. .Cast<Season>();
  320. }
  321. var fields = request.GetItemFields().ToList();
  322. var returnItems = seasons.Select(i => _dtoService.GetBaseItemDto(i, fields, user))
  323. .ToArray();
  324. return new ItemsResult
  325. {
  326. TotalRecordCount = returnItems.Length,
  327. Items = returnItems
  328. };
  329. }
  330. private IEnumerable<Season> FilterVirtualSeasons(GetSeasons request, IEnumerable<Season> items)
  331. {
  332. if (request.IsMissing.HasValue && request.IsVirtualUnaired.HasValue)
  333. {
  334. var isMissing = request.IsMissing.Value;
  335. var isVirtualUnaired = request.IsVirtualUnaired.Value;
  336. if (!isMissing && !isVirtualUnaired)
  337. {
  338. return items.Where(i => !i.IsMissingOrVirtualUnaired);
  339. }
  340. }
  341. if (request.IsMissing.HasValue)
  342. {
  343. var val = request.IsMissing.Value;
  344. items = items.Where(i => i.IsMissingSeason == val);
  345. }
  346. if (request.IsVirtualUnaired.HasValue)
  347. {
  348. var val = request.IsVirtualUnaired.Value;
  349. items = items.Where(i => i.IsVirtualUnaired == val);
  350. }
  351. return items;
  352. }
  353. public object Get(GetEpisodes request)
  354. {
  355. var user = _userManager.GetUserById(request.UserId);
  356. IEnumerable<Episode> episodes;
  357. if (string.IsNullOrEmpty(request.SeasonId))
  358. {
  359. var series = _libraryManager.GetItemById(request.Id) as Series;
  360. if (series == null)
  361. {
  362. throw new ResourceNotFoundException("No series exists with Id " + request.Id);
  363. }
  364. episodes = series.GetEpisodes(user, request.Season.Value);
  365. }
  366. else
  367. {
  368. var season = _libraryManager.GetItemById(new Guid(request.SeasonId)) as Season;
  369. if (season == null)
  370. {
  371. throw new ResourceNotFoundException("No season exists with Id " + request.SeasonId);
  372. }
  373. episodes = season.GetEpisodes(user);
  374. }
  375. // Filter after the fact in case the ui doesn't want them
  376. if (request.IsMissing.HasValue)
  377. {
  378. var val = request.IsMissing.Value;
  379. episodes = episodes.Where(i => i.IsMissingEpisode == val);
  380. }
  381. // Filter after the fact in case the ui doesn't want them
  382. if (request.IsVirtualUnaired.HasValue)
  383. {
  384. var val = request.IsVirtualUnaired.Value;
  385. episodes = episodes.Where(i => i.IsVirtualUnaired == val);
  386. }
  387. // This must be the last filter
  388. if (!string.IsNullOrEmpty(request.AdjacentTo))
  389. {
  390. episodes = ItemsService.FilterForAdjacency(episodes, request.AdjacentTo)
  391. .Cast<Episode>();
  392. }
  393. var fields = request.GetItemFields().ToList();
  394. var returnItems = episodes.Select(i => _dtoService.GetBaseItemDto(i, fields, user))
  395. .ToArray();
  396. return new ItemsResult
  397. {
  398. TotalRecordCount = returnItems.Length,
  399. Items = returnItems
  400. };
  401. }
  402. }
  403. }