ItemsService.cs 49 KB

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