ItemsService.cs 44 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107
  1. using MediaBrowser.Controller.Dto;
  2. using MediaBrowser.Controller.Entities;
  3. using MediaBrowser.Controller.Entities.Audio;
  4. using MediaBrowser.Controller.Entities.Movies;
  5. using MediaBrowser.Controller.Entities.TV;
  6. using MediaBrowser.Controller.Library;
  7. using MediaBrowser.Controller.Localization;
  8. using MediaBrowser.Model.Entities;
  9. using MediaBrowser.Model.Querying;
  10. using ServiceStack.ServiceHost;
  11. using System;
  12. using System.Collections.Generic;
  13. using System.Linq;
  14. namespace MediaBrowser.Api.UserLibrary
  15. {
  16. /// <summary>
  17. /// Class GetItems
  18. /// </summary>
  19. [Route("/Users/{UserId}/Items", "GET")]
  20. [Api(Description = "Gets items based on a query.")]
  21. public class GetItems : BaseItemsRequest, IReturn<ItemsResult>
  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 = "path", Verb = "GET")]
  28. public Guid UserId { get; set; }
  29. /// <summary>
  30. /// Limit results to items containing a specific person
  31. /// </summary>
  32. /// <value>The person.</value>
  33. [ApiMember(Name = "Person", Description = "Optional. If specified, results will be filtered to include only those containing the specified person.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  34. public string Person { get; set; }
  35. /// <summary>
  36. /// If the Person filter is used, this can also be used to restrict to a specific person type
  37. /// </summary>
  38. /// <value>The type of the person.</value>
  39. [ApiMember(Name = "PersonTypes", Description = "Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  40. public string PersonTypes { get; set; }
  41. /// <summary>
  42. /// Search characters used to find items
  43. /// </summary>
  44. /// <value>The index by.</value>
  45. [ApiMember(Name = "SearchTerm", Description = "Optional. If specified, results will be filtered based on a search term.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  46. public string SearchTerm { get; set; }
  47. /// <summary>
  48. /// The dynamic, localized index function name
  49. /// </summary>
  50. /// <value>The index by.</value>
  51. public string IndexBy { get; set; }
  52. /// <summary>
  53. /// Limit results to items containing specific genres
  54. /// </summary>
  55. /// <value>The genres.</value>
  56. [ApiMember(Name = "Genres", Description = "Optional. If specified, results will be filtered based on genre. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  57. public string Genres { get; set; }
  58. [ApiMember(Name = "AllGenres", Description = "Optional. If specified, results will be filtered based on genre. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  59. public string AllGenres { get; set; }
  60. /// <summary>
  61. /// Limit results to items containing specific studios
  62. /// </summary>
  63. /// <value>The studios.</value>
  64. [ApiMember(Name = "Studios", Description = "Optional. If specified, results will be filtered based on studio. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  65. public string Studios { get; set; }
  66. /// <summary>
  67. /// Gets or sets the studios.
  68. /// </summary>
  69. /// <value>The studios.</value>
  70. [ApiMember(Name = "Artists", Description = "Optional. If specified, results will be filtered based on artist. This allows multiple, pipe delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  71. public string Artists { get; set; }
  72. [ApiMember(Name = "Albums", Description = "Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  73. public string Albums { get; set; }
  74. /// <summary>
  75. /// Limit results to items containing specific years
  76. /// </summary>
  77. /// <value>The years.</value>
  78. [ApiMember(Name = "Years", Description = "Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  79. public string Years { get; set; }
  80. /// <summary>
  81. /// Gets or sets the item ids.
  82. /// </summary>
  83. /// <value>The item ids.</value>
  84. [ApiMember(Name = "Ids", Description = "Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  85. public string Ids { get; set; }
  86. /// <summary>
  87. /// Gets or sets the video types.
  88. /// </summary>
  89. /// <value>The video types.</value>
  90. [ApiMember(Name = "VideoTypes", Description = "Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  91. public string VideoTypes { get; set; }
  92. /// <summary>
  93. /// Gets or sets the video formats.
  94. /// </summary>
  95. /// <value>The video formats.</value>
  96. [ApiMember(Name = "Is3D", Description = "Optional filter by items that are 3D, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  97. public bool? Is3D { get; set; }
  98. /// <summary>
  99. /// Gets or sets the series status.
  100. /// </summary>
  101. /// <value>The series status.</value>
  102. [ApiMember(Name = "SeriesStatus", Description = "Optional filter by Series Status. Allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  103. public string SeriesStatus { get; set; }
  104. [ApiMember(Name = "NameStartsWithOrGreater", Description = "Optional filter by items whose name is sorted equally or greater than a given input string.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  105. public string NameStartsWithOrGreater { get; set; }
  106. [ApiMember(Name = "AlbumArtistStartsWithOrGreater", Description = "Optional filter by items whose album artist is sorted equally or greater than a given input string.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  107. public string AlbumArtistStartsWithOrGreater { get; set; }
  108. /// <summary>
  109. /// Gets or sets the air days.
  110. /// </summary>
  111. /// <value>The air days.</value>
  112. [ApiMember(Name = "AirDays", Description = "Optional filter by Series Air Days. Allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  113. public string AirDays { get; set; }
  114. /// <summary>
  115. /// Gets or sets the min offical rating.
  116. /// </summary>
  117. /// <value>The min offical rating.</value>
  118. [ApiMember(Name = "MinOfficialRating", Description = "Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  119. public string MinOfficialRating { get; set; }
  120. /// <summary>
  121. /// Gets or sets the max offical rating.
  122. /// </summary>
  123. /// <value>The max offical rating.</value>
  124. [ApiMember(Name = "MaxOfficialRating", Description = "Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  125. public string MaxOfficialRating { get; set; }
  126. [ApiMember(Name = "HasThemeSong", Description = "Optional filter by items with theme songs.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  127. public bool? HasThemeSong { get; set; }
  128. [ApiMember(Name = "HasThemeVideo", Description = "Optional filter by items with theme videos.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  129. public bool? HasThemeVideo { get; set; }
  130. [ApiMember(Name = "HasSubtitles", Description = "Optional filter by items with subtitles.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  131. public bool? HasSubtitles { get; set; }
  132. [ApiMember(Name = "HasSpecialFeature", Description = "Optional filter by items with special features.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  133. public bool? HasSpecialFeature { get; set; }
  134. [ApiMember(Name = "HasTrailer", Description = "Optional filter by items with trailers.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  135. public bool? HasTrailer { get; set; }
  136. [ApiMember(Name = "AdjacentTo", Description = "Optional. Return items that are siblings of a supplied item.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  137. public string AdjacentTo { get; set; }
  138. [ApiMember(Name = "MinIndexNumber", Description = "Optional filter by minimum index number.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  139. public int? MinIndexNumber { get; set; }
  140. [ApiMember(Name = "MinPlayers", Description = "Optional filter by minimum number of game players.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  141. public int? MinPlayers { get; set; }
  142. [ApiMember(Name = "MaxPlayers", Description = "Optional filter by maximum number of game players.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  143. public int? MaxPlayers { get; set; }
  144. [ApiMember(Name = "ParentIndexNumber", Description = "Optional filter by parent index number.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  145. public int? ParentIndexNumber { get; set; }
  146. [ApiMember(Name = "HasParentalRating", Description = "Optional filter by items that have or do not have a parental rating", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  147. public bool? HasParentalRating { get; set; }
  148. [ApiMember(Name = "IsHD", Description = "Optional filter by items that are HD or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  149. public bool? IsHD { get; set; }
  150. [ApiMember(Name = "LocationTypes", Description = "Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  151. public string LocationTypes { get; set; }
  152. [ApiMember(Name = "ExcludeLocationTypes", Description = "Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  153. public string ExcludeLocationTypes { get; set; }
  154. public bool IncludeIndexContainers { get; set; }
  155. [ApiMember(Name = "IsMissing", Description = "Optional filter by items that are missing episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  156. public bool? IsMissing { get; set; }
  157. [ApiMember(Name = "IsUnaired", Description = "Optional filter by items that are unaired episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  158. public bool? IsUnaired { get; set; }
  159. [ApiMember(Name = "IsVirtualUnaired", Description = "Optional filter by items that are virtual unaired episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  160. public bool? IsVirtualUnaired { get; set; }
  161. [ApiMember(Name = "MinCommunityRating", Description = "Optional filter by minimum community rating.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  162. public double? MinCommunityRating { get; set; }
  163. [ApiMember(Name = "MinCriticRating", Description = "Optional filter by minimum critic rating.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  164. public double? MinCriticRating { get; set; }
  165. [ApiMember(Name = "AiredDuringSeason", Description = "Gets all episodes that aired during a season, including specials.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  166. public int? AiredDuringSeason { get; set; }
  167. }
  168. /// <summary>
  169. /// Class ItemsService
  170. /// </summary>
  171. public class ItemsService : BaseApiService
  172. {
  173. /// <summary>
  174. /// The _user manager
  175. /// </summary>
  176. private readonly IUserManager _userManager;
  177. private readonly IUserDataManager _userDataRepository;
  178. /// <summary>
  179. /// The _library manager
  180. /// </summary>
  181. private readonly ILibraryManager _libraryManager;
  182. private readonly ILibrarySearchEngine _searchEngine;
  183. private readonly ILocalizationManager _localization;
  184. private readonly IDtoService _dtoService;
  185. /// <summary>
  186. /// Initializes a new instance of the <see cref="ItemsService" /> class.
  187. /// </summary>
  188. /// <param name="userManager">The user manager.</param>
  189. /// <param name="libraryManager">The library manager.</param>
  190. /// <param name="searchEngine">The search engine.</param>
  191. /// <param name="userDataRepository">The user data repository.</param>
  192. public ItemsService(IUserManager userManager, ILibraryManager libraryManager, ILibrarySearchEngine searchEngine, IUserDataManager userDataRepository, ILocalizationManager localization, IDtoService dtoService)
  193. {
  194. _userManager = userManager;
  195. _libraryManager = libraryManager;
  196. _searchEngine = searchEngine;
  197. _userDataRepository = userDataRepository;
  198. _localization = localization;
  199. _dtoService = dtoService;
  200. }
  201. /// <summary>
  202. /// Gets the specified request.
  203. /// </summary>
  204. /// <param name="request">The request.</param>
  205. /// <returns>System.Object.</returns>
  206. public object Get(GetItems request)
  207. {
  208. var result = GetItems(request);
  209. return ToOptimizedResult(result);
  210. }
  211. /// <summary>
  212. /// Gets the items.
  213. /// </summary>
  214. /// <param name="request">The request.</param>
  215. /// <returns>Task{ItemsResult}.</returns>
  216. private ItemsResult GetItems(GetItems request)
  217. {
  218. var user = _userManager.GetUserById(request.UserId);
  219. var items = GetItemsToSerialize(request, user);
  220. items = items.AsParallel();
  221. items = ApplyAdditionalFilters(request, items, user);
  222. // Apply filters
  223. // Run them starting with the ones that are likely to reduce the list the most
  224. foreach (var filter in request.GetFilters().OrderByDescending(f => (int)f))
  225. {
  226. items = ApplyFilter(items, filter, user, _userDataRepository);
  227. }
  228. items = FilterVirtualEpisodes(request, items, user);
  229. items = items.AsEnumerable();
  230. items = ApplySearchTerm(request, items);
  231. items = ApplySortOrder(request, items, user, _libraryManager);
  232. var itemsArray = items.ToList();
  233. var pagedItems = ApplyPaging(request, itemsArray);
  234. var fields = request.GetItemFields().ToList();
  235. var returnItems = pagedItems.Select(i => _dtoService.GetBaseItemDto(i, fields, user)).ToArray();
  236. return new ItemsResult
  237. {
  238. TotalRecordCount = itemsArray.Count,
  239. Items = returnItems
  240. };
  241. }
  242. /// <summary>
  243. /// Gets the items to serialize.
  244. /// </summary>
  245. /// <param name="request">The request.</param>
  246. /// <param name="user">The user.</param>
  247. /// <returns>IEnumerable{BaseItem}.</returns>
  248. /// <exception cref="System.InvalidOperationException"></exception>
  249. private IEnumerable<BaseItem> GetItemsToSerialize(GetItems request, User user)
  250. {
  251. var item = string.IsNullOrEmpty(request.ParentId) ? user.RootFolder : _dtoService.GetItemByDtoId(request.ParentId, user.Id);
  252. // Default list type = children
  253. IEnumerable<BaseItem> items;
  254. if (!string.IsNullOrEmpty(request.Ids))
  255. {
  256. var idList = request.Ids.Split(',').ToList();
  257. items = idList.Select(i => _dtoService.GetItemByDtoId(i, user.Id));
  258. }
  259. else if (request.Recursive)
  260. {
  261. items = ((Folder)item).GetRecursiveChildren(user);
  262. }
  263. else
  264. {
  265. items = ((Folder)item).GetChildren(user, true, request.IndexBy);
  266. }
  267. if (request.IncludeIndexContainers)
  268. {
  269. var list = items.ToList();
  270. var containers = list.Select(i => i.IndexContainer)
  271. .Where(i => i != null);
  272. list.AddRange(containers);
  273. return list.Distinct();
  274. }
  275. return items;
  276. }
  277. /// <summary>
  278. /// Applies sort order
  279. /// </summary>
  280. /// <param name="request">The request.</param>
  281. /// <param name="items">The items.</param>
  282. /// <param name="user">The user.</param>
  283. /// <param name="libraryManager">The library manager.</param>
  284. /// <returns>IEnumerable{BaseItem}.</returns>
  285. internal static IEnumerable<BaseItem> ApplySortOrder(BaseItemsRequest request, IEnumerable<BaseItem> items, User user, ILibraryManager libraryManager)
  286. {
  287. var orderBy = request.GetOrderBy().ToList();
  288. return orderBy.Count == 0 ? items : libraryManager.Sort(items, user, orderBy, request.SortOrder ?? SortOrder.Ascending);
  289. }
  290. /// <summary>
  291. /// Applies filtering
  292. /// </summary>
  293. /// <param name="items">The items.</param>
  294. /// <param name="filter">The filter.</param>
  295. /// <param name="user">The user.</param>
  296. /// <param name="repository">The repository.</param>
  297. /// <returns>IEnumerable{BaseItem}.</returns>
  298. internal static IEnumerable<BaseItem> ApplyFilter(IEnumerable<BaseItem> items, ItemFilter filter, User user, IUserDataManager repository)
  299. {
  300. switch (filter)
  301. {
  302. case ItemFilter.IsFavoriteOrLikes:
  303. return items.Where(item =>
  304. {
  305. var userdata = repository.GetUserData(user.Id, item.GetUserDataKey());
  306. if (userdata == null)
  307. {
  308. return false;
  309. }
  310. var likes = userdata.Likes ?? false;
  311. var favorite = userdata.IsFavorite;
  312. return likes || favorite;
  313. });
  314. case ItemFilter.Likes:
  315. return items.Where(item =>
  316. {
  317. var userdata = repository.GetUserData(user.Id, item.GetUserDataKey());
  318. return userdata != null && userdata.Likes.HasValue && userdata.Likes.Value;
  319. });
  320. case ItemFilter.Dislikes:
  321. return items.Where(item =>
  322. {
  323. var userdata = repository.GetUserData(user.Id, item.GetUserDataKey());
  324. return userdata != null && userdata.Likes.HasValue && !userdata.Likes.Value;
  325. });
  326. case ItemFilter.IsFavorite:
  327. return items.Where(item =>
  328. {
  329. var userdata = repository.GetUserData(user.Id, item.GetUserDataKey());
  330. return userdata != null && userdata.IsFavorite;
  331. });
  332. case ItemFilter.IsRecentlyAdded:
  333. return items.Where(item => item.IsRecentlyAdded());
  334. case ItemFilter.IsResumable:
  335. return items.Where(item =>
  336. {
  337. var userdata = repository.GetUserData(user.Id, item.GetUserDataKey());
  338. return userdata != null && userdata.PlaybackPositionTicks > 0;
  339. });
  340. case ItemFilter.IsPlayed:
  341. return items.Where(item =>
  342. {
  343. var userdata = repository.GetUserData(user.Id, item.GetUserDataKey());
  344. return userdata != null && userdata.Played;
  345. });
  346. case ItemFilter.IsUnplayed:
  347. return items.Where(item =>
  348. {
  349. var userdata = repository.GetUserData(user.Id, item.GetUserDataKey());
  350. return userdata == null || !userdata.Played;
  351. });
  352. case ItemFilter.IsFolder:
  353. return items.Where(item => item.IsFolder);
  354. case ItemFilter.IsNotFolder:
  355. return items.Where(item => !item.IsFolder);
  356. }
  357. return items;
  358. }
  359. private IEnumerable<BaseItem> FilterVirtualEpisodes(GetItems request, IEnumerable<BaseItem> items, User user)
  360. {
  361. items = FilterVirtualSeasons(request, items, user);
  362. if (request.IsMissing.HasValue)
  363. {
  364. var val = request.IsMissing.Value;
  365. items = items.Where(i =>
  366. {
  367. var e = i as Episode;
  368. if (e != null)
  369. {
  370. return e.IsMissingEpisode == val;
  371. }
  372. return true;
  373. });
  374. }
  375. if (request.IsUnaired.HasValue)
  376. {
  377. var val = request.IsUnaired.Value;
  378. items = items.Where(i =>
  379. {
  380. var e = i as Episode;
  381. if (e != null)
  382. {
  383. return e.IsUnaired == val;
  384. }
  385. return true;
  386. });
  387. }
  388. if (request.IsVirtualUnaired.HasValue)
  389. {
  390. var val = request.IsVirtualUnaired.Value;
  391. items = items.Where(i =>
  392. {
  393. var e = i as Episode;
  394. if (e != null)
  395. {
  396. return e.IsVirtualUnaired == val;
  397. }
  398. return true;
  399. });
  400. }
  401. return items;
  402. }
  403. private IEnumerable<BaseItem> FilterVirtualSeasons(GetItems request, IEnumerable<BaseItem> items, User user)
  404. {
  405. if (request.IsMissing.HasValue && request.IsVirtualUnaired.HasValue)
  406. {
  407. var isMissing = request.IsMissing.Value;
  408. var isVirtualUnaired = request.IsVirtualUnaired.Value;
  409. if (!isMissing && !isVirtualUnaired)
  410. {
  411. return items.Where(i =>
  412. {
  413. var e = i as Season;
  414. if (e != null)
  415. {
  416. return !e.IsMissingOrVirtualUnaired;
  417. }
  418. return true;
  419. });
  420. }
  421. }
  422. if (request.IsMissing.HasValue)
  423. {
  424. var val = request.IsMissing.Value;
  425. items = items.Where(i =>
  426. {
  427. var e = i as Season;
  428. if (e != null)
  429. {
  430. return e.IsMissingSeason == val;
  431. }
  432. return true;
  433. });
  434. }
  435. if (request.IsUnaired.HasValue)
  436. {
  437. var val = request.IsUnaired.Value;
  438. items = items.Where(i =>
  439. {
  440. var e = i as Season;
  441. if (e != null)
  442. {
  443. return e.IsUnaired == val;
  444. }
  445. return true;
  446. });
  447. }
  448. if (request.IsVirtualUnaired.HasValue)
  449. {
  450. var val = request.IsVirtualUnaired.Value;
  451. items = items.Where(i =>
  452. {
  453. var e = i as Season;
  454. if (e != null)
  455. {
  456. return e.IsVirtualUnaired == val;
  457. }
  458. return true;
  459. });
  460. }
  461. return items;
  462. }
  463. /// <summary>
  464. /// Applies the additional filters.
  465. /// </summary>
  466. /// <param name="request">The request.</param>
  467. /// <param name="items">The items.</param>
  468. /// <returns>IEnumerable{BaseItem}.</returns>
  469. private IEnumerable<BaseItem> ApplyAdditionalFilters(GetItems request, IEnumerable<BaseItem> items, User user)
  470. {
  471. if (request.MinCommunityRating.HasValue)
  472. {
  473. var val = request.MinCommunityRating.Value;
  474. items = items.Where(i => i.CommunityRating.HasValue && i.CommunityRating >= val);
  475. }
  476. if (request.MinCriticRating.HasValue)
  477. {
  478. var val = request.MinCriticRating.Value;
  479. items = items.Where(i =>
  480. {
  481. var hasCriticRating = i as IHasCriticRating;
  482. if (hasCriticRating != null)
  483. {
  484. return hasCriticRating.CriticRating.HasValue && hasCriticRating.CriticRating >= val;
  485. }
  486. return false;
  487. });
  488. }
  489. // Artists
  490. if (!string.IsNullOrEmpty(request.Artists))
  491. {
  492. var artists = request.Artists.Split('|');
  493. items = items.Where(i =>
  494. {
  495. var audio = i as IHasArtist;
  496. return audio != null && artists.Any(audio.HasArtist);
  497. });
  498. }
  499. // Albums
  500. if (!string.IsNullOrEmpty(request.Albums))
  501. {
  502. var albums = request.Albums.Split('|');
  503. items = items.Where(i =>
  504. {
  505. var audio = i as Audio;
  506. if (audio != null)
  507. {
  508. return albums.Any(a => string.Equals(a, audio.Album, StringComparison.OrdinalIgnoreCase));
  509. }
  510. var album = i as MusicAlbum;
  511. if (album != null)
  512. {
  513. return albums.Any(a => string.Equals(a, album.Name, StringComparison.OrdinalIgnoreCase));
  514. }
  515. var musicVideo = i as MusicVideo;
  516. if (musicVideo != null)
  517. {
  518. return albums.Any(a => string.Equals(a, musicVideo.Album, StringComparison.OrdinalIgnoreCase));
  519. }
  520. return false;
  521. });
  522. }
  523. if (!string.IsNullOrEmpty(request.AdjacentTo))
  524. {
  525. var item = _dtoService.GetItemByDtoId(request.AdjacentTo);
  526. var allSiblings = item.Parent.GetChildren(user, true).OrderBy(i => i.SortName).ToList();
  527. var index = allSiblings.IndexOf(item);
  528. var previousId = Guid.Empty;
  529. var nextId = Guid.Empty;
  530. if (index > 0)
  531. {
  532. previousId = allSiblings[index - 1].Id;
  533. }
  534. if (index < allSiblings.Count - 1)
  535. {
  536. nextId = allSiblings[index + 1].Id;
  537. }
  538. items = items.Where(i => i.Id == previousId || i.Id == nextId);
  539. }
  540. // Min index number
  541. if (request.MinIndexNumber.HasValue)
  542. {
  543. items = items.Where(i => i.IndexNumber.HasValue && i.IndexNumber.Value >= request.MinIndexNumber.Value);
  544. }
  545. // Min official rating
  546. if (!string.IsNullOrEmpty(request.MinOfficialRating))
  547. {
  548. var level = _localization.GetRatingLevel(request.MinOfficialRating);
  549. if (level.HasValue)
  550. {
  551. items = items.Where(i =>
  552. {
  553. var rating = i.CustomRating;
  554. if (string.IsNullOrEmpty(rating))
  555. {
  556. rating = i.OfficialRating;
  557. }
  558. if (string.IsNullOrEmpty(rating))
  559. {
  560. return true;
  561. }
  562. var itemLevel = _localization.GetRatingLevel(rating);
  563. return !itemLevel.HasValue || itemLevel.Value >= level.Value;
  564. });
  565. }
  566. }
  567. // Max official rating
  568. if (!string.IsNullOrEmpty(request.MaxOfficialRating))
  569. {
  570. var level = _localization.GetRatingLevel(request.MaxOfficialRating);
  571. if (level.HasValue)
  572. {
  573. items = items.Where(i =>
  574. {
  575. var rating = i.CustomRating;
  576. if (string.IsNullOrEmpty(rating))
  577. {
  578. rating = i.OfficialRating;
  579. }
  580. if (string.IsNullOrEmpty(rating))
  581. {
  582. return true;
  583. }
  584. var itemLevel = _localization.GetRatingLevel(rating);
  585. return !itemLevel.HasValue || itemLevel.Value <= level.Value;
  586. });
  587. }
  588. }
  589. // Exclude item types
  590. if (!string.IsNullOrEmpty(request.ExcludeItemTypes))
  591. {
  592. var vals = request.ExcludeItemTypes.Split(',');
  593. items = items.Where(f => !vals.Contains(f.GetType().Name, StringComparer.OrdinalIgnoreCase));
  594. }
  595. // Include item types
  596. if (!string.IsNullOrEmpty(request.IncludeItemTypes))
  597. {
  598. var vals = request.IncludeItemTypes.Split(',');
  599. items = items.Where(f => vals.Contains(f.GetType().Name, StringComparer.OrdinalIgnoreCase));
  600. }
  601. // LocationTypes
  602. if (!string.IsNullOrEmpty(request.LocationTypes))
  603. {
  604. var vals = request.LocationTypes.Split(',');
  605. items = items.Where(f => vals.Contains(f.LocationType.ToString(), StringComparer.OrdinalIgnoreCase));
  606. }
  607. // ExcludeLocationTypes
  608. if (!string.IsNullOrEmpty(request.ExcludeLocationTypes))
  609. {
  610. var vals = request.ExcludeLocationTypes.Split(',');
  611. items = items.Where(f => !vals.Contains(f.LocationType.ToString(), StringComparer.OrdinalIgnoreCase));
  612. }
  613. if (!string.IsNullOrEmpty(request.NameStartsWithOrGreater))
  614. {
  615. items = items.Where(i => string.Compare(request.NameStartsWithOrGreater, i.SortName, StringComparison.CurrentCultureIgnoreCase) < 1);
  616. }
  617. if (!string.IsNullOrEmpty(request.AlbumArtistStartsWithOrGreater))
  618. {
  619. items = items.OfType<IHasAlbumArtist>()
  620. .Where(i => string.Compare(request.AlbumArtistStartsWithOrGreater, i.AlbumArtist, StringComparison.CurrentCultureIgnoreCase) < 1)
  621. .Cast<BaseItem>();
  622. }
  623. // Filter by Series Status
  624. if (!string.IsNullOrEmpty(request.SeriesStatus))
  625. {
  626. var vals = request.SeriesStatus.Split(',');
  627. items = items.OfType<Series>().Where(i => i.Status.HasValue && vals.Contains(i.Status.Value.ToString(), StringComparer.OrdinalIgnoreCase));
  628. }
  629. // Filter by Series AirDays
  630. if (!string.IsNullOrEmpty(request.AirDays))
  631. {
  632. var days = request.AirDays.Split(',').Select(d => (DayOfWeek)Enum.Parse(typeof(DayOfWeek), d, true));
  633. items = items.OfType<Series>().Where(i => i.AirDays != null && days.Any(d => i.AirDays.Contains(d)));
  634. }
  635. // Filter by Video3DFormat
  636. if (request.Is3D.HasValue)
  637. {
  638. items = items.OfType<Video>().Where(i => request.Is3D.Value == i.Video3DFormat.HasValue);
  639. }
  640. // Filter by VideoType
  641. if (!string.IsNullOrEmpty(request.VideoTypes))
  642. {
  643. var types = request.VideoTypes.Split(',');
  644. items = items.OfType<Video>().Where(i => types.Contains(i.VideoType.ToString(), StringComparer.OrdinalIgnoreCase));
  645. }
  646. if (!string.IsNullOrEmpty(request.MediaTypes))
  647. {
  648. var types = request.MediaTypes.Split(',');
  649. items = items.Where(i => !string.IsNullOrEmpty(i.MediaType) && types.Contains(i.MediaType, StringComparer.OrdinalIgnoreCase));
  650. }
  651. var imageTypes = request.GetImageTypes().ToList();
  652. if (imageTypes.Count > 0)
  653. {
  654. items = items.Where(item => imageTypes.Any(imageType => HasImage(item, imageType)));
  655. }
  656. // Apply genre filter
  657. if (!string.IsNullOrEmpty(request.Genres))
  658. {
  659. var vals = request.Genres.Split(',');
  660. items = items.Where(f => vals.Any(v => f.Genres.Contains(v, StringComparer.OrdinalIgnoreCase)));
  661. }
  662. // Apply genre filter
  663. if (!string.IsNullOrEmpty(request.AllGenres))
  664. {
  665. var vals = request.AllGenres.Split(',');
  666. items = items.Where(f => vals.All(v => f.Genres.Contains(v, StringComparer.OrdinalIgnoreCase)));
  667. }
  668. // Apply studio filter
  669. if (!string.IsNullOrEmpty(request.Studios))
  670. {
  671. var vals = request.Studios.Split(',');
  672. items = items.Where(f => vals.Any(v => f.Studios.Contains(v, StringComparer.OrdinalIgnoreCase)));
  673. }
  674. // Apply year filter
  675. if (!string.IsNullOrEmpty(request.Years))
  676. {
  677. var vals = request.Years.Split(',').Select(int.Parse).ToList();
  678. items = items.Where(f => f.ProductionYear.HasValue && vals.Contains(f.ProductionYear.Value));
  679. }
  680. // Apply person filter
  681. if (!string.IsNullOrEmpty(request.Person))
  682. {
  683. var personTypes = request.PersonTypes;
  684. if (string.IsNullOrEmpty(personTypes))
  685. {
  686. items = items.Where(item => item.People.Any(p => string.Equals(p.Name, request.Person, StringComparison.OrdinalIgnoreCase)));
  687. }
  688. else
  689. {
  690. var types = personTypes.Split(',');
  691. items = items.Where(item =>
  692. item.People != null &&
  693. item.People.Any(p =>
  694. p.Name.Equals(request.Person, StringComparison.OrdinalIgnoreCase) && (types.Contains(p.Type, StringComparer.OrdinalIgnoreCase) || types.Contains(p.Role, StringComparer.OrdinalIgnoreCase))));
  695. }
  696. }
  697. if (request.HasTrailer.HasValue)
  698. {
  699. items = items.Where(i => request.HasTrailer.Value ? i.LocalTrailerIds.Count > 0 : i.LocalTrailerIds.Count == 0);
  700. }
  701. if (request.HasThemeSong.HasValue)
  702. {
  703. items = items.Where(i => request.HasThemeSong.Value ? i.ThemeSongIds.Count > 0 : i.ThemeSongIds.Count == 0);
  704. }
  705. if (request.HasThemeVideo.HasValue)
  706. {
  707. items = items.Where(i => request.HasThemeVideo.Value ? i.ThemeVideoIds.Count > 0 : i.ThemeVideoIds.Count == 0);
  708. }
  709. if (request.MinPlayers.HasValue)
  710. {
  711. var filterValue = request.MinPlayers.Value;
  712. items = items.Where(i =>
  713. {
  714. var game = i as Game;
  715. if (game != null)
  716. {
  717. var players = game.PlayersSupported ?? 1;
  718. return players >= filterValue;
  719. }
  720. return false;
  721. });
  722. }
  723. if (request.MaxPlayers.HasValue)
  724. {
  725. var filterValue = request.MaxPlayers.Value;
  726. items = items.Where(i =>
  727. {
  728. var game = i as Game;
  729. if (game != null)
  730. {
  731. var players = game.PlayersSupported ?? 1;
  732. return players <= filterValue;
  733. }
  734. return false;
  735. });
  736. }
  737. if (request.HasSpecialFeature.HasValue)
  738. {
  739. var filterValue = request.HasSpecialFeature.Value;
  740. items = items.Where(i =>
  741. {
  742. var movie = i as Movie;
  743. if (movie != null)
  744. {
  745. return filterValue
  746. ? movie.SpecialFeatureIds.Count > 0
  747. : movie.SpecialFeatureIds.Count == 0;
  748. }
  749. var series = i as Series;
  750. if (series != null)
  751. {
  752. return filterValue
  753. ? series.SpecialFeatureIds.Count > 0
  754. : series.SpecialFeatureIds.Count == 0;
  755. }
  756. return false;
  757. });
  758. }
  759. if (request.HasSubtitles.HasValue)
  760. {
  761. items = items.OfType<Video>().Where(i =>
  762. {
  763. if (request.HasSubtitles.Value)
  764. {
  765. return i.MediaStreams != null && i.MediaStreams.Any(m => m.Type == MediaStreamType.Subtitle);
  766. }
  767. return i.MediaStreams == null || i.MediaStreams.All(m => m.Type != MediaStreamType.Subtitle);
  768. });
  769. }
  770. if (request.HasParentalRating.HasValue)
  771. {
  772. items = items.Where(i =>
  773. {
  774. var rating = i.CustomRating;
  775. if (string.IsNullOrEmpty(rating))
  776. {
  777. rating = i.OfficialRating;
  778. }
  779. if (request.HasParentalRating.Value)
  780. {
  781. return !string.IsNullOrEmpty(rating);
  782. }
  783. return string.IsNullOrEmpty(rating);
  784. });
  785. }
  786. if (request.IsHD.HasValue)
  787. {
  788. var val = request.IsHD.Value;
  789. items = items.OfType<Video>().Where(i => i.IsHD == val);
  790. }
  791. if (request.ParentIndexNumber.HasValue)
  792. {
  793. var filterValue = request.ParentIndexNumber.Value;
  794. items = items.Where(i =>
  795. {
  796. var episode = i as Episode;
  797. if (episode != null)
  798. {
  799. return episode.ParentIndexNumber.HasValue && episode.ParentIndexNumber.Value == filterValue;
  800. }
  801. var song = i as Audio;
  802. if (song != null)
  803. {
  804. return song.ParentIndexNumber.HasValue && song.ParentIndexNumber.Value == filterValue;
  805. }
  806. return true;
  807. });
  808. }
  809. if (request.AiredDuringSeason.HasValue)
  810. {
  811. var val = request.AiredDuringSeason.Value;
  812. items = items.Where(i =>
  813. {
  814. var episode = i as Episode;
  815. if (episode != null)
  816. {
  817. var seasonNumber = episode.SpecialSeasonNumber ?? episode.ParentIndexNumber;
  818. return seasonNumber.HasValue && seasonNumber.Value == val;
  819. }
  820. return false;
  821. });
  822. }
  823. return items;
  824. }
  825. /// <summary>
  826. /// Determines whether the specified item has image.
  827. /// </summary>
  828. /// <param name="item">The item.</param>
  829. /// <param name="imageType">Type of the image.</param>
  830. /// <returns><c>true</c> if the specified item has image; otherwise, <c>false</c>.</returns>
  831. internal static bool HasImage(BaseItem item, ImageType imageType)
  832. {
  833. if (imageType == ImageType.Backdrop)
  834. {
  835. return item.BackdropImagePaths.Count > 0;
  836. }
  837. if (imageType == ImageType.Screenshot)
  838. {
  839. return item.ScreenshotImagePaths.Count > 0;
  840. }
  841. return item.HasImage(imageType);
  842. }
  843. /// <summary>
  844. /// Applies the search term.
  845. /// </summary>
  846. /// <param name="request">The request.</param>
  847. /// <param name="items">The items.</param>
  848. /// <returns>IEnumerable{BaseItem}.</returns>
  849. private IEnumerable<BaseItem> ApplySearchTerm(GetItems request, IEnumerable<BaseItem> items)
  850. {
  851. var term = request.SearchTerm;
  852. if (!string.IsNullOrEmpty(term))
  853. {
  854. items = _searchEngine.Search(items, request.SearchTerm);
  855. }
  856. return items;
  857. }
  858. /// <summary>
  859. /// Applies the paging.
  860. /// </summary>
  861. /// <param name="request">The request.</param>
  862. /// <param name="items">The items.</param>
  863. /// <returns>IEnumerable{BaseItem}.</returns>
  864. private IEnumerable<BaseItem> ApplyPaging(GetItems request, IEnumerable<BaseItem> items)
  865. {
  866. // Start at
  867. if (request.StartIndex.HasValue)
  868. {
  869. items = items.Skip(request.StartIndex.Value);
  870. }
  871. // Return limit
  872. if (request.Limit.HasValue)
  873. {
  874. items = items.Take(request.Limit.Value);
  875. }
  876. return items;
  877. }
  878. }
  879. /// <summary>
  880. /// Class DateCreatedComparer
  881. /// </summary>
  882. public class DateCreatedComparer : IComparer<BaseItem>
  883. {
  884. /// <summary>
  885. /// Compares the specified x.
  886. /// </summary>
  887. /// <param name="x">The x.</param>
  888. /// <param name="y">The y.</param>
  889. /// <returns>System.Int32.</returns>
  890. public int Compare(BaseItem x, BaseItem y)
  891. {
  892. return x.DateCreated.CompareTo(y.DateCreated);
  893. }
  894. }
  895. }