ItemsService.cs 48 KB

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