ItemsService.cs 48 KB

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