ItemsService.cs 48 KB

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