ItemsService.cs 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859
  1. using MediaBrowser.Controller.Collections;
  2. using MediaBrowser.Controller.Dto;
  3. using MediaBrowser.Controller.Entities;
  4. using MediaBrowser.Controller.Entities.Audio;
  5. using MediaBrowser.Controller.Entities.Movies;
  6. using MediaBrowser.Controller.Entities.TV;
  7. using MediaBrowser.Controller.Library;
  8. using MediaBrowser.Controller.Localization;
  9. using MediaBrowser.Controller.Net;
  10. using MediaBrowser.Model.Entities;
  11. using MediaBrowser.Model.Querying;
  12. using ServiceStack;
  13. using System;
  14. using System.Collections.Generic;
  15. using System.Globalization;
  16. using System.Linq;
  17. using System.Threading.Tasks;
  18. namespace MediaBrowser.Api.UserLibrary
  19. {
  20. /// <summary>
  21. /// Class GetItems
  22. /// </summary>
  23. [Route("/Items", "GET", Summary = "Gets items based on a query.")]
  24. [Route("/Users/{UserId}/Items", "GET", Summary = "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 string 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. [ApiMember(Name = "PersonIds", Description = "Optional. If specified, results will be filtered to include only those containing the specified person.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  40. public string PersonIds { get; set; }
  41. /// <summary>
  42. /// If the Person filter is used, this can also be used to restrict to a specific person type
  43. /// </summary>
  44. /// <value>The type of the person.</value>
  45. [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")]
  46. public string PersonTypes { get; set; }
  47. /// <summary>
  48. /// Limit results to items containing specific studios
  49. /// </summary>
  50. /// <value>The studios.</value>
  51. [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)]
  52. public string Studios { get; set; }
  53. [ApiMember(Name = "StudioIds", 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)]
  54. public string StudioIds { get; set; }
  55. /// <summary>
  56. /// Gets or sets the studios.
  57. /// </summary>
  58. /// <value>The studios.</value>
  59. [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)]
  60. public string Artists { get; set; }
  61. [ApiMember(Name = "ArtistIds", 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)]
  62. public string ArtistIds { get; set; }
  63. [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)]
  64. public string Albums { get; set; }
  65. /// <summary>
  66. /// Gets or sets the item ids.
  67. /// </summary>
  68. /// <value>The item ids.</value>
  69. [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)]
  70. public string Ids { get; set; }
  71. /// <summary>
  72. /// Gets or sets the video types.
  73. /// </summary>
  74. /// <value>The video types.</value>
  75. [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)]
  76. public string VideoTypes { get; set; }
  77. /// <summary>
  78. /// Gets or sets the video formats.
  79. /// </summary>
  80. /// <value>The video formats.</value>
  81. [ApiMember(Name = "Is3D", Description = "Optional filter by items that are 3D, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  82. public bool? Is3D { get; set; }
  83. /// <summary>
  84. /// Gets or sets the series status.
  85. /// </summary>
  86. /// <value>The series status.</value>
  87. [ApiMember(Name = "SeriesStatus", Description = "Optional filter by Series Status. Allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  88. public string SeriesStatus { get; set; }
  89. [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")]
  90. public string NameStartsWithOrGreater { get; set; }
  91. [ApiMember(Name = "NameStartsWith", Description = "Optional filter by items whose name is sorted equally than a given input string.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  92. public string NameStartsWith { get; set; }
  93. [ApiMember(Name = "NameLessThan", Description = "Optional filter by items whose name is equally or lesser than a given input string.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  94. public string NameLessThan { get; set; }
  95. [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")]
  96. public string AlbumArtistStartsWithOrGreater { get; set; }
  97. /// <summary>
  98. /// Gets or sets the air days.
  99. /// </summary>
  100. /// <value>The air days.</value>
  101. [ApiMember(Name = "AirDays", Description = "Optional filter by Series Air Days. Allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  102. public string AirDays { get; set; }
  103. /// <summary>
  104. /// Gets or sets the min offical rating.
  105. /// </summary>
  106. /// <value>The min offical rating.</value>
  107. [ApiMember(Name = "MinOfficialRating", Description = "Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  108. public string MinOfficialRating { get; set; }
  109. /// <summary>
  110. /// Gets or sets the max offical rating.
  111. /// </summary>
  112. /// <value>The max offical rating.</value>
  113. [ApiMember(Name = "MaxOfficialRating", Description = "Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  114. public string MaxOfficialRating { get; set; }
  115. [ApiMember(Name = "HasThemeSong", Description = "Optional filter by items with theme songs.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  116. public bool? HasThemeSong { get; set; }
  117. [ApiMember(Name = "HasThemeVideo", Description = "Optional filter by items with theme videos.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  118. public bool? HasThemeVideo { get; set; }
  119. [ApiMember(Name = "HasSubtitles", Description = "Optional filter by items with subtitles.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  120. public bool? HasSubtitles { get; set; }
  121. [ApiMember(Name = "HasSpecialFeature", Description = "Optional filter by items with special features.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  122. public bool? HasSpecialFeature { get; set; }
  123. [ApiMember(Name = "HasTrailer", Description = "Optional filter by items with trailers.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  124. public bool? HasTrailer { get; set; }
  125. [ApiMember(Name = "AdjacentTo", Description = "Optional. Return items that are siblings of a supplied item.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  126. public string AdjacentTo { get; set; }
  127. [ApiMember(Name = "MinIndexNumber", Description = "Optional filter by minimum index number.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  128. public int? MinIndexNumber { get; set; }
  129. [ApiMember(Name = "MinPlayers", Description = "Optional filter by minimum number of game players.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  130. public int? MinPlayers { get; set; }
  131. [ApiMember(Name = "MaxPlayers", Description = "Optional filter by maximum number of game players.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  132. public int? MaxPlayers { get; set; }
  133. [ApiMember(Name = "ParentIndexNumber", Description = "Optional filter by parent index number.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  134. public int? ParentIndexNumber { get; set; }
  135. [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")]
  136. public bool? HasParentalRating { get; set; }
  137. [ApiMember(Name = "IsHD", Description = "Optional filter by items that are HD or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  138. public bool? IsHD { get; set; }
  139. [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)]
  140. public string LocationTypes { get; set; }
  141. [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)]
  142. public string ExcludeLocationTypes { get; set; }
  143. [ApiMember(Name = "IsMissing", Description = "Optional filter by items that are missing episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  144. public bool? IsMissing { get; set; }
  145. [ApiMember(Name = "IsUnaired", Description = "Optional filter by items that are unaired episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  146. public bool? IsUnaired { get; set; }
  147. [ApiMember(Name = "IsVirtualUnaired", Description = "Optional filter by items that are virtual unaired episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  148. public bool? IsVirtualUnaired { get; set; }
  149. [ApiMember(Name = "MinCommunityRating", Description = "Optional filter by minimum community rating.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  150. public double? MinCommunityRating { get; set; }
  151. [ApiMember(Name = "MinCriticRating", Description = "Optional filter by minimum critic rating.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  152. public double? MinCriticRating { get; set; }
  153. [ApiMember(Name = "AiredDuringSeason", Description = "Gets all episodes that aired during a season, including specials.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  154. public int? AiredDuringSeason { get; set; }
  155. [ApiMember(Name = "MinPremiereDate", Description = "Optional. The minimum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
  156. public string MinPremiereDate { get; set; }
  157. [ApiMember(Name = "MaxPremiereDate", Description = "Optional. The maximum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
  158. public string MaxPremiereDate { get; set; }
  159. [ApiMember(Name = "HasOverview", Description = "Optional filter by items that have an overview or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  160. public bool? HasOverview { get; set; }
  161. [ApiMember(Name = "HasImdbId", Description = "Optional filter by items that have an imdb id or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  162. public bool? HasImdbId { get; set; }
  163. [ApiMember(Name = "HasTmdbId", Description = "Optional filter by items that have a tmdb id or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  164. public bool? HasTmdbId { get; set; }
  165. [ApiMember(Name = "HasTvdbId", Description = "Optional filter by items that have a tvdb id or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  166. public bool? HasTvdbId { get; set; }
  167. [ApiMember(Name = "IsYearMismatched", Description = "Optional filter by items that are potentially misidentified.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  168. public bool? IsYearMismatched { get; set; }
  169. [ApiMember(Name = "IsInBoxSet", Description = "Optional filter by items that are in boxsets, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  170. public bool? IsInBoxSet { get; set; }
  171. [ApiMember(Name = "IsLocked", Description = "Optional filter by items that are locked.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  172. public bool? IsLocked { get; set; }
  173. [ApiMember(Name = "IsUnidentified", Description = "Optional filter by items that are unidentified by internet metadata providers.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  174. public bool? IsUnidentified { get; set; }
  175. [ApiMember(Name = "IsPlaceHolder", Description = "Optional filter by items that are placeholders", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  176. public bool? IsPlaceHolder { get; set; }
  177. [ApiMember(Name = "HasOfficialRating", Description = "Optional filter by items that have official ratings", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  178. public bool? HasOfficialRating { get; set; }
  179. [ApiMember(Name = "CollapseBoxSetItems", Description = "Whether or not to hide items behind their boxsets.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  180. public bool? CollapseBoxSetItems { get; set; }
  181. public string[] GetStudios()
  182. {
  183. return (Studios ?? string.Empty).Split(new[] { '|' }, StringSplitOptions.RemoveEmptyEntries);
  184. }
  185. public string[] GetStudioIds()
  186. {
  187. return (StudioIds ?? string.Empty).Split(new[] { '|' }, StringSplitOptions.RemoveEmptyEntries);
  188. }
  189. public string[] GetPersonTypes()
  190. {
  191. return (PersonTypes ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
  192. }
  193. public string[] GetPersonIds()
  194. {
  195. return (PersonIds ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
  196. }
  197. public string[] GetItemIds()
  198. {
  199. return (Ids ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
  200. }
  201. public VideoType[] GetVideoTypes()
  202. {
  203. var val = VideoTypes;
  204. if (string.IsNullOrEmpty(val))
  205. {
  206. return new VideoType[] { };
  207. }
  208. return val.Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries).Select(v => (VideoType)Enum.Parse(typeof(VideoType), v, true)).ToArray();
  209. }
  210. }
  211. /// <summary>
  212. /// Class ItemsService
  213. /// </summary>
  214. [Authenticated]
  215. public class ItemsService : BaseApiService
  216. {
  217. /// <summary>
  218. /// The _user manager
  219. /// </summary>
  220. private readonly IUserManager _userManager;
  221. private readonly IUserDataManager _userDataRepository;
  222. /// <summary>
  223. /// The _library manager
  224. /// </summary>
  225. private readonly ILibraryManager _libraryManager;
  226. private readonly ILocalizationManager _localization;
  227. private readonly IDtoService _dtoService;
  228. private readonly ICollectionManager _collectionManager;
  229. /// <summary>
  230. /// Initializes a new instance of the <see cref="ItemsService" /> class.
  231. /// </summary>
  232. /// <param name="userManager">The user manager.</param>
  233. /// <param name="libraryManager">The library manager.</param>
  234. /// <param name="userDataRepository">The user data repository.</param>
  235. /// <param name="localization">The localization.</param>
  236. /// <param name="dtoService">The dto service.</param>
  237. /// <param name="collectionManager">The collection manager.</param>
  238. public ItemsService(IUserManager userManager, ILibraryManager libraryManager, IUserDataManager userDataRepository, ILocalizationManager localization, IDtoService dtoService, ICollectionManager collectionManager)
  239. {
  240. _userManager = userManager;
  241. _libraryManager = libraryManager;
  242. _userDataRepository = userDataRepository;
  243. _localization = localization;
  244. _dtoService = dtoService;
  245. _collectionManager = collectionManager;
  246. }
  247. /// <summary>
  248. /// Gets the specified request.
  249. /// </summary>
  250. /// <param name="request">The request.</param>
  251. /// <returns>System.Object.</returns>
  252. public async Task<object> Get(GetItems request)
  253. {
  254. var result = await GetItems(request).ConfigureAwait(false);
  255. return ToOptimizedSerializedResultUsingCache(result);
  256. }
  257. /// <summary>
  258. /// Gets the items.
  259. /// </summary>
  260. /// <param name="request">The request.</param>
  261. /// <returns>Task{ItemsResult}.</returns>
  262. private async Task<ItemsResult> GetItems(GetItems request)
  263. {
  264. var parentItem = string.IsNullOrEmpty(request.ParentId) ? null : _libraryManager.GetItemById(request.ParentId);
  265. var user = !string.IsNullOrWhiteSpace(request.UserId) ? _userManager.GetUserById(request.UserId) : null;
  266. var result = await GetItemsToSerialize(request, user, parentItem).ConfigureAwait(false);
  267. var dtoOptions = GetDtoOptions(request);
  268. return new ItemsResult
  269. {
  270. TotalRecordCount = result.Item1.TotalRecordCount,
  271. Items = _dtoService.GetBaseItemDtos(result.Item1.Items, dtoOptions, user).ToArray()
  272. };
  273. }
  274. /// <summary>
  275. /// Gets the items to serialize.
  276. /// </summary>
  277. /// <param name="request">The request.</param>
  278. /// <param name="user">The user.</param>
  279. /// <param name="parentItem">The parent item.</param>
  280. /// <returns>IEnumerable{BaseItem}.</returns>
  281. private async Task<Tuple<QueryResult<BaseItem>, bool>> GetItemsToSerialize(GetItems request, User user, BaseItem parentItem)
  282. {
  283. var item = string.IsNullOrEmpty(request.ParentId) ?
  284. user == null ? _libraryManager.RootFolder : user.RootFolder :
  285. parentItem;
  286. // Default list type = children
  287. if (!string.IsNullOrEmpty(request.Ids))
  288. {
  289. request.Recursive = true;
  290. var result = await ((Folder)item).GetItems(GetItemsQuery(request, user)).ConfigureAwait(false);
  291. return new Tuple<QueryResult<BaseItem>, bool>(result, true);
  292. }
  293. if (request.Recursive)
  294. {
  295. var result = await ((Folder)item).GetItems(GetItemsQuery(request, user)).ConfigureAwait(false);
  296. return new Tuple<QueryResult<BaseItem>, bool>(result, true);
  297. }
  298. if (user == null)
  299. {
  300. var result = await ((Folder)item).GetItems(GetItemsQuery(request, null)).ConfigureAwait(false);
  301. return new Tuple<QueryResult<BaseItem>, bool>(result, true);
  302. }
  303. var userRoot = item as UserRootFolder;
  304. if (userRoot == null)
  305. {
  306. var result = await ((Folder)item).GetItems(GetItemsQuery(request, user)).ConfigureAwait(false);
  307. return new Tuple<QueryResult<BaseItem>, bool>(result, true);
  308. }
  309. IEnumerable<BaseItem> items = ((Folder)item).GetChildren(user, true);
  310. var itemsArray = items.ToArray();
  311. return new Tuple<QueryResult<BaseItem>, bool>(new QueryResult<BaseItem>
  312. {
  313. Items = itemsArray,
  314. TotalRecordCount = itemsArray.Length
  315. }, false);
  316. }
  317. private InternalItemsQuery GetItemsQuery(GetItems request, User user)
  318. {
  319. var query = new InternalItemsQuery
  320. {
  321. User = user,
  322. IsPlayed = request.IsPlayed,
  323. MediaTypes = request.GetMediaTypes(),
  324. IncludeItemTypes = request.GetIncludeItemTypes(),
  325. ExcludeItemTypes = request.GetExcludeItemTypes(),
  326. Recursive = request.Recursive,
  327. SortBy = request.GetOrderBy(),
  328. SortOrder = request.SortOrder ?? SortOrder.Ascending,
  329. Filter = i => ApplyAdditionalFilters(request, i, user, _libraryManager),
  330. Limit = request.Limit,
  331. StartIndex = request.StartIndex,
  332. IsMissing = request.IsMissing,
  333. IsVirtualUnaired = request.IsVirtualUnaired,
  334. IsUnaired = request.IsUnaired,
  335. CollapseBoxSetItems = request.CollapseBoxSetItems,
  336. NameLessThan = request.NameLessThan,
  337. NameStartsWith = request.NameStartsWith,
  338. NameStartsWithOrGreater = request.NameStartsWithOrGreater,
  339. HasImdbId = request.HasImdbId,
  340. IsYearMismatched = request.IsYearMismatched,
  341. IsUnidentified = request.IsUnidentified,
  342. IsPlaceHolder = request.IsPlaceHolder,
  343. IsLocked = request.IsLocked,
  344. IsInBoxSet = request.IsInBoxSet,
  345. IsHD = request.IsHD,
  346. Is3D = request.Is3D,
  347. HasTvdbId = request.HasTvdbId,
  348. HasTmdbId = request.HasTmdbId,
  349. HasOverview = request.HasOverview,
  350. HasOfficialRating = request.HasOfficialRating,
  351. HasParentalRating = request.HasParentalRating,
  352. HasSpecialFeature = request.HasSpecialFeature,
  353. HasSubtitles = request.HasSubtitles,
  354. HasThemeSong = request.HasThemeSong,
  355. HasThemeVideo = request.HasThemeVideo,
  356. HasTrailer = request.HasTrailer,
  357. Tags = request.GetTags(),
  358. OfficialRatings = request.GetOfficialRatings(),
  359. Genres = request.GetGenres(),
  360. Studios = request.GetStudios(),
  361. StudioIds = request.GetStudioIds(),
  362. Person = request.Person,
  363. PersonIds = request.GetPersonIds(),
  364. PersonTypes = request.GetPersonTypes(),
  365. Years = request.GetYears(),
  366. ImageTypes = request.GetImageTypes().ToArray(),
  367. VideoTypes = request.GetVideoTypes().ToArray(),
  368. AdjacentTo = request.AdjacentTo,
  369. ItemIds = request.GetItemIds(),
  370. MinPlayers = request.MinPlayers,
  371. MaxPlayers = request.MaxPlayers,
  372. MinCommunityRating = request.MinCommunityRating,
  373. MinCriticRating = request.MinCriticRating
  374. };
  375. if (!string.IsNullOrWhiteSpace(request.Ids))
  376. {
  377. query.CollapseBoxSetItems = false;
  378. }
  379. foreach (var filter in request.GetFilters())
  380. {
  381. switch (filter)
  382. {
  383. case ItemFilter.Dislikes:
  384. query.IsLiked = false;
  385. break;
  386. case ItemFilter.IsFavorite:
  387. query.IsFavorite = true;
  388. break;
  389. case ItemFilter.IsFavoriteOrLikes:
  390. query.IsFavoriteOrLiked = true;
  391. break;
  392. case ItemFilter.IsFolder:
  393. query.IsFolder = true;
  394. break;
  395. case ItemFilter.IsNotFolder:
  396. query.IsFolder = false;
  397. break;
  398. case ItemFilter.IsPlayed:
  399. query.IsPlayed = true;
  400. break;
  401. case ItemFilter.IsRecentlyAdded:
  402. break;
  403. case ItemFilter.IsResumable:
  404. query.IsResumable = true;
  405. break;
  406. case ItemFilter.IsUnplayed:
  407. query.IsPlayed = false;
  408. break;
  409. case ItemFilter.Likes:
  410. query.IsLiked = true;
  411. break;
  412. }
  413. }
  414. return query;
  415. }
  416. /// <summary>
  417. /// Applies filtering
  418. /// </summary>
  419. /// <param name="items">The items.</param>
  420. /// <param name="filter">The filter.</param>
  421. /// <param name="user">The user.</param>
  422. /// <param name="repository">The repository.</param>
  423. /// <returns>IEnumerable{BaseItem}.</returns>
  424. internal static IEnumerable<BaseItem> ApplyFilter(IEnumerable<BaseItem> items, ItemFilter filter, User user, IUserDataManager repository)
  425. {
  426. // Avoid implicitly captured closure
  427. var currentUser = user;
  428. switch (filter)
  429. {
  430. case ItemFilter.IsFavoriteOrLikes:
  431. return items.Where(item =>
  432. {
  433. var userdata = repository.GetUserData(user.Id, item.GetUserDataKey());
  434. if (userdata == null)
  435. {
  436. return false;
  437. }
  438. var likes = userdata.Likes ?? false;
  439. var favorite = userdata.IsFavorite;
  440. return likes || favorite;
  441. });
  442. case ItemFilter.Likes:
  443. return items.Where(item =>
  444. {
  445. var userdata = repository.GetUserData(user.Id, item.GetUserDataKey());
  446. return userdata != null && userdata.Likes.HasValue && userdata.Likes.Value;
  447. });
  448. case ItemFilter.Dislikes:
  449. return items.Where(item =>
  450. {
  451. var userdata = repository.GetUserData(user.Id, item.GetUserDataKey());
  452. return userdata != null && userdata.Likes.HasValue && !userdata.Likes.Value;
  453. });
  454. case ItemFilter.IsFavorite:
  455. return items.Where(item =>
  456. {
  457. var userdata = repository.GetUserData(user.Id, item.GetUserDataKey());
  458. return userdata != null && userdata.IsFavorite;
  459. });
  460. case ItemFilter.IsResumable:
  461. return items.Where(item =>
  462. {
  463. var userdata = repository.GetUserData(user.Id, item.GetUserDataKey());
  464. return userdata != null && userdata.PlaybackPositionTicks > 0;
  465. });
  466. case ItemFilter.IsPlayed:
  467. return items.Where(item => item.IsPlayed(currentUser));
  468. case ItemFilter.IsUnplayed:
  469. return items.Where(item => item.IsUnplayed(currentUser));
  470. case ItemFilter.IsFolder:
  471. return items.Where(item => item.IsFolder);
  472. case ItemFilter.IsNotFolder:
  473. return items.Where(item => !item.IsFolder);
  474. case ItemFilter.IsRecentlyAdded:
  475. return items.Where(item => (DateTime.UtcNow - item.DateCreated).TotalDays <= 10);
  476. }
  477. return items;
  478. }
  479. private bool ApplyAdditionalFilters(GetItems request, BaseItem i, User user, ILibraryManager libraryManager)
  480. {
  481. // Artists
  482. if (!string.IsNullOrEmpty(request.ArtistIds))
  483. {
  484. var artistIds = request.ArtistIds.Split(new[] { '|', ',' });
  485. var audio = i as IHasArtist;
  486. if (!(audio != null && artistIds.Any(id =>
  487. {
  488. var artistItem = libraryManager.GetItemById(id);
  489. return artistItem != null && audio.HasAnyArtist(artistItem.Name);
  490. })))
  491. {
  492. return false;
  493. }
  494. }
  495. // Artists
  496. if (!string.IsNullOrEmpty(request.Artists))
  497. {
  498. var artists = request.Artists.Split('|');
  499. var audio = i as IHasArtist;
  500. if (!(audio != null && artists.Any(audio.HasAnyArtist)))
  501. {
  502. return false;
  503. }
  504. }
  505. // Albums
  506. if (!string.IsNullOrEmpty(request.Albums))
  507. {
  508. var albums = request.Albums.Split('|');
  509. var audio = i as Audio;
  510. if (audio != null)
  511. {
  512. if (!albums.Any(a => string.Equals(a, audio.Album, StringComparison.OrdinalIgnoreCase)))
  513. {
  514. return false;
  515. }
  516. }
  517. var album = i as MusicAlbum;
  518. if (album != null)
  519. {
  520. if (!albums.Any(a => string.Equals(a, album.Name, StringComparison.OrdinalIgnoreCase)))
  521. {
  522. return false;
  523. }
  524. }
  525. var musicVideo = i as MusicVideo;
  526. if (musicVideo != null)
  527. {
  528. if (!albums.Any(a => string.Equals(a, musicVideo.Album, StringComparison.OrdinalIgnoreCase)))
  529. {
  530. return false;
  531. }
  532. }
  533. return false;
  534. }
  535. // Min index number
  536. if (request.MinIndexNumber.HasValue)
  537. {
  538. if (!(i.IndexNumber.HasValue && i.IndexNumber.Value >= request.MinIndexNumber.Value))
  539. {
  540. return false;
  541. }
  542. }
  543. // Min official rating
  544. if (!string.IsNullOrEmpty(request.MinOfficialRating))
  545. {
  546. var level = _localization.GetRatingLevel(request.MinOfficialRating);
  547. if (level.HasValue)
  548. {
  549. var rating = i.CustomRating;
  550. if (string.IsNullOrEmpty(rating))
  551. {
  552. rating = i.OfficialRating;
  553. }
  554. if (!string.IsNullOrEmpty(rating))
  555. {
  556. var itemLevel = _localization.GetRatingLevel(rating);
  557. if (!(!itemLevel.HasValue || itemLevel.Value >= level.Value))
  558. {
  559. return false;
  560. }
  561. }
  562. }
  563. }
  564. // Max official rating
  565. if (!string.IsNullOrEmpty(request.MaxOfficialRating))
  566. {
  567. var level = _localization.GetRatingLevel(request.MaxOfficialRating);
  568. if (level.HasValue)
  569. {
  570. var rating = i.CustomRating;
  571. if (string.IsNullOrEmpty(rating))
  572. {
  573. rating = i.OfficialRating;
  574. }
  575. if (!string.IsNullOrEmpty(rating))
  576. {
  577. var itemLevel = _localization.GetRatingLevel(rating);
  578. if (!(!itemLevel.HasValue || itemLevel.Value <= level.Value))
  579. {
  580. return false;
  581. }
  582. }
  583. }
  584. }
  585. // LocationTypes
  586. if (!string.IsNullOrEmpty(request.LocationTypes))
  587. {
  588. var vals = request.LocationTypes.Split(',');
  589. if (!vals.Contains(i.LocationType.ToString(), StringComparer.OrdinalIgnoreCase))
  590. {
  591. return false;
  592. }
  593. }
  594. // ExcludeLocationTypes
  595. if (!string.IsNullOrEmpty(request.ExcludeLocationTypes))
  596. {
  597. var vals = request.ExcludeLocationTypes.Split(',');
  598. if (vals.Contains(i.LocationType.ToString(), StringComparer.OrdinalIgnoreCase))
  599. {
  600. return false;
  601. }
  602. }
  603. if (!string.IsNullOrEmpty(request.AlbumArtistStartsWithOrGreater))
  604. {
  605. var ok = new[] { i }.OfType<IHasAlbumArtist>()
  606. .Any(p => string.Compare(request.AlbumArtistStartsWithOrGreater, p.AlbumArtists.FirstOrDefault(), StringComparison.CurrentCultureIgnoreCase) < 1);
  607. if (!ok)
  608. {
  609. return false;
  610. }
  611. }
  612. // Filter by Series Status
  613. if (!string.IsNullOrEmpty(request.SeriesStatus))
  614. {
  615. var vals = request.SeriesStatus.Split(',');
  616. var ok = new[] { i }.OfType<Series>().Any(p => p.Status.HasValue && vals.Contains(p.Status.Value.ToString(), StringComparer.OrdinalIgnoreCase));
  617. if (!ok)
  618. {
  619. return false;
  620. }
  621. }
  622. // Filter by Series AirDays
  623. if (!string.IsNullOrEmpty(request.AirDays))
  624. {
  625. var days = request.AirDays.Split(',').Select(d => (DayOfWeek)Enum.Parse(typeof(DayOfWeek), d, true));
  626. var ok = new[] { i }.OfType<Series>().Any(p => p.AirDays != null && days.Any(d => p.AirDays.Contains(d)));
  627. if (!ok)
  628. {
  629. return false;
  630. }
  631. }
  632. if (request.ParentIndexNumber.HasValue)
  633. {
  634. var filterValue = request.ParentIndexNumber.Value;
  635. var episode = i as Episode;
  636. if (episode != null)
  637. {
  638. if (episode.ParentIndexNumber.HasValue && episode.ParentIndexNumber.Value != filterValue)
  639. {
  640. return false;
  641. }
  642. }
  643. var song = i as Audio;
  644. if (song != null)
  645. {
  646. if (song.ParentIndexNumber.HasValue && song.ParentIndexNumber.Value != filterValue)
  647. {
  648. return false;
  649. }
  650. }
  651. }
  652. if (request.AiredDuringSeason.HasValue)
  653. {
  654. var episode = i as Episode;
  655. if (episode == null)
  656. {
  657. return false;
  658. }
  659. if (!Series.FilterEpisodesBySeason(new[] { episode }, request.AiredDuringSeason.Value, true).Any())
  660. {
  661. return false;
  662. }
  663. }
  664. if (!string.IsNullOrEmpty(request.MinPremiereDate))
  665. {
  666. var date = DateTime.Parse(request.MinPremiereDate, null, DateTimeStyles.RoundtripKind).ToUniversalTime();
  667. if (!(i.PremiereDate.HasValue && i.PremiereDate.Value >= date))
  668. {
  669. return false;
  670. }
  671. }
  672. if (!string.IsNullOrEmpty(request.MaxPremiereDate))
  673. {
  674. var date = DateTime.Parse(request.MaxPremiereDate, null, DateTimeStyles.RoundtripKind).ToUniversalTime();
  675. if (!(i.PremiereDate.HasValue && i.PremiereDate.Value <= date))
  676. {
  677. return false;
  678. }
  679. }
  680. return true;
  681. }
  682. }
  683. /// <summary>
  684. /// Class DateCreatedComparer
  685. /// </summary>
  686. public class DateCreatedComparer : IComparer<BaseItem>
  687. {
  688. /// <summary>
  689. /// Compares the specified x.
  690. /// </summary>
  691. /// <param name="x">The x.</param>
  692. /// <param name="y">The y.</param>
  693. /// <returns>System.Int32.</returns>
  694. public int Compare(BaseItem x, BaseItem y)
  695. {
  696. return x.DateCreated.CompareTo(y.DateCreated);
  697. }
  698. }
  699. }