ItemsService.cs 48 KB

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