ItemsService.cs 42 KB

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