BaseItemsRequest.cs 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479
  1. using System;
  2. using System.Linq;
  3. using Jellyfin.Data.Enums;
  4. using MediaBrowser.Model.Entities;
  5. using MediaBrowser.Model.Querying;
  6. using MediaBrowser.Model.Services;
  7. namespace MediaBrowser.Api.UserLibrary
  8. {
  9. public abstract class BaseItemsRequest : IHasDtoOptions
  10. {
  11. protected BaseItemsRequest()
  12. {
  13. EnableImages = true;
  14. EnableTotalRecordCount = true;
  15. }
  16. /// <summary>
  17. /// Gets or sets the max offical rating.
  18. /// </summary>
  19. /// <value>The max offical rating.</value>
  20. [ApiMember(Name = "MaxOfficialRating", Description = "Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  21. public string MaxOfficialRating { get; set; }
  22. [ApiMember(Name = "HasThemeSong", Description = "Optional filter by items with theme songs.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  23. public bool? HasThemeSong { get; set; }
  24. [ApiMember(Name = "HasThemeVideo", Description = "Optional filter by items with theme videos.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  25. public bool? HasThemeVideo { get; set; }
  26. [ApiMember(Name = "HasSubtitles", Description = "Optional filter by items with subtitles.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  27. public bool? HasSubtitles { get; set; }
  28. [ApiMember(Name = "HasSpecialFeature", Description = "Optional filter by items with special features.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  29. public bool? HasSpecialFeature { get; set; }
  30. [ApiMember(Name = "HasTrailer", Description = "Optional filter by items with trailers.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  31. public bool? HasTrailer { get; set; }
  32. [ApiMember(Name = "AdjacentTo", Description = "Optional. Return items that are siblings of a supplied item.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  33. public string AdjacentTo { get; set; }
  34. [ApiMember(Name = "MinIndexNumber", Description = "Optional filter by minimum index number.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  35. public int? MinIndexNumber { get; set; }
  36. [ApiMember(Name = "ParentIndexNumber", Description = "Optional filter by parent index number.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  37. public int? ParentIndexNumber { get; set; }
  38. [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")]
  39. public bool? HasParentalRating { get; set; }
  40. [ApiMember(Name = "IsHD", Description = "Optional filter by items that are HD or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  41. public bool? IsHD { get; set; }
  42. public bool? Is4K { get; set; }
  43. [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)]
  44. public string LocationTypes { get; set; }
  45. [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)]
  46. public string ExcludeLocationTypes { get; set; }
  47. [ApiMember(Name = "IsMissing", Description = "Optional filter by items that are missing episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  48. public bool? IsMissing { get; set; }
  49. [ApiMember(Name = "IsUnaired", Description = "Optional filter by items that are unaired episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  50. public bool? IsUnaired { get; set; }
  51. [ApiMember(Name = "MinCommunityRating", Description = "Optional filter by minimum community rating.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  52. public double? MinCommunityRating { get; set; }
  53. [ApiMember(Name = "MinCriticRating", Description = "Optional filter by minimum critic rating.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  54. public double? MinCriticRating { get; set; }
  55. [ApiMember(Name = "AiredDuringSeason", Description = "Gets all episodes that aired during a season, including specials.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  56. public int? AiredDuringSeason { get; set; }
  57. [ApiMember(Name = "MinPremiereDate", Description = "Optional. The minimum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  58. public string MinPremiereDate { get; set; }
  59. [ApiMember(Name = "MinDateLastSaved", Description = "Optional. The minimum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  60. public string MinDateLastSaved { get; set; }
  61. [ApiMember(Name = "MinDateLastSavedForUser", Description = "Optional. The minimum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  62. public string MinDateLastSavedForUser { get; set; }
  63. [ApiMember(Name = "MaxPremiereDate", Description = "Optional. The maximum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  64. public string MaxPremiereDate { get; set; }
  65. [ApiMember(Name = "HasOverview", Description = "Optional filter by items that have an overview or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  66. public bool? HasOverview { get; set; }
  67. [ApiMember(Name = "HasImdbId", Description = "Optional filter by items that have an imdb id or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  68. public bool? HasImdbId { get; set; }
  69. [ApiMember(Name = "HasTmdbId", Description = "Optional filter by items that have a tmdb id or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  70. public bool? HasTmdbId { get; set; }
  71. [ApiMember(Name = "HasTvdbId", Description = "Optional filter by items that have a tvdb id or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  72. public bool? HasTvdbId { get; set; }
  73. [ApiMember(Name = "ExcludeItemIds", Description = "Optional. If specified, results will be filtered by exxcluding item ids. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  74. public string ExcludeItemIds { get; set; }
  75. public bool EnableTotalRecordCount { get; set; }
  76. /// <summary>
  77. /// Skips over a given number of items within the results. Use for paging.
  78. /// </summary>
  79. /// <value>The start index.</value>
  80. [ApiMember(Name = "StartIndex", Description = "Optional. The record index to start at. All items with a lower index will be dropped from the results.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  81. public int? StartIndex { get; set; }
  82. /// <summary>
  83. /// The maximum number of items to return.
  84. /// </summary>
  85. /// <value>The limit.</value>
  86. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  87. public int? Limit { get; set; }
  88. /// <summary>
  89. /// Whether or not to perform the query recursively.
  90. /// </summary>
  91. /// <value><c>true</c> if recursive; otherwise, <c>false</c>.</value>
  92. [ApiMember(Name = "Recursive", Description = "When searching within folders, this determines whether or not the search will be recursive. true/false", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  93. public bool Recursive { get; set; }
  94. public string SearchTerm { get; set; }
  95. /// <summary>
  96. /// Gets or sets the sort order.
  97. /// </summary>
  98. /// <value>The sort order.</value>
  99. [ApiMember(Name = "SortOrder", Description = "Sort Order - Ascending,Descending", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  100. public string SortOrder { get; set; }
  101. /// <summary>
  102. /// Specify this to localize the search to a specific item or folder. Omit to use the root.
  103. /// </summary>
  104. /// <value>The parent id.</value>
  105. [ApiMember(Name = "ParentId", Description = "Specify this to localize the search to a specific item or folder. Omit to use the root", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  106. public string ParentId { get; set; }
  107. /// <summary>
  108. /// Fields to return within the items, in addition to basic information.
  109. /// </summary>
  110. /// <value>The fields.</value>
  111. [ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  112. public string Fields { get; set; }
  113. /// <summary>
  114. /// Gets or sets the exclude item types.
  115. /// </summary>
  116. /// <value>The exclude item types.</value>
  117. [ApiMember(Name = "ExcludeItemTypes", Description = "Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  118. public string ExcludeItemTypes { get; set; }
  119. /// <summary>
  120. /// Gets or sets the include item types.
  121. /// </summary>
  122. /// <value>The include item types.</value>
  123. [ApiMember(Name = "IncludeItemTypes", Description = "Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  124. public string IncludeItemTypes { get; set; }
  125. /// <summary>
  126. /// Filters to apply to the results.
  127. /// </summary>
  128. /// <value>The filters.</value>
  129. [ApiMember(Name = "Filters", Description = "Optional. Specify additional filters to apply. This allows multiple, comma delimeted. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  130. public string Filters { get; set; }
  131. /// <summary>
  132. /// Gets or sets the Isfavorite option.
  133. /// </summary>
  134. /// <value>IsFavorite</value>
  135. [ApiMember(Name = "IsFavorite", Description = "Optional filter by items that are marked as favorite, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  136. public bool? IsFavorite { get; set; }
  137. /// <summary>
  138. /// Gets or sets the media types.
  139. /// </summary>
  140. /// <value>The media types.</value>
  141. [ApiMember(Name = "MediaTypes", Description = "Optional filter by MediaType. Allows multiple, comma delimited.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  142. public string MediaTypes { get; set; }
  143. /// <summary>
  144. /// Gets or sets the image types.
  145. /// </summary>
  146. /// <value>The image types.</value>
  147. [ApiMember(Name = "ImageTypes", Description = "Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  148. public string ImageTypes { get; set; }
  149. /// <summary>
  150. /// What to sort the results by.
  151. /// </summary>
  152. /// <value>The sort by.</value>
  153. [ApiMember(Name = "SortBy", Description = "Optional. Specify one or more sort orders, comma delimeted. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  154. public string SortBy { get; set; }
  155. [ApiMember(Name = "IsPlayed", Description = "Optional filter by items that are played, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  156. public bool? IsPlayed { get; set; }
  157. /// <summary>
  158. /// Limit results to items containing specific genres.
  159. /// </summary>
  160. /// <value>The genres.</value>
  161. [ApiMember(Name = "Genres", Description = "Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  162. public string Genres { get; set; }
  163. public string GenreIds { get; set; }
  164. [ApiMember(Name = "OfficialRatings", Description = "Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  165. public string OfficialRatings { get; set; }
  166. [ApiMember(Name = "Tags", Description = "Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  167. public string Tags { get; set; }
  168. /// <summary>
  169. /// Limit results to items containing specific years.
  170. /// </summary>
  171. /// <value>The years.</value>
  172. [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)]
  173. public string Years { get; set; }
  174. [ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  175. public bool? EnableImages { get; set; }
  176. [ApiMember(Name = "EnableUserData", Description = "Optional, include user data", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  177. public bool? EnableUserData { get; set; }
  178. [ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  179. public int? ImageTypeLimit { get; set; }
  180. [ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  181. public string EnableImageTypes { get; set; }
  182. /// <summary>
  183. /// Limit results to items containing a specific person.
  184. /// </summary>
  185. /// <value>The person.</value>
  186. [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")]
  187. public string Person { get; set; }
  188. [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")]
  189. public string PersonIds { get; set; }
  190. /// <summary>
  191. /// If the Person filter is used, this can also be used to restrict to a specific person type.
  192. /// </summary>
  193. /// <value>The type of the person.</value>
  194. [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")]
  195. public string PersonTypes { get; set; }
  196. /// <summary>
  197. /// Limit results to items containing specific studios.
  198. /// </summary>
  199. /// <value>The studios.</value>
  200. [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)]
  201. public string Studios { get; set; }
  202. [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)]
  203. public string StudioIds { get; set; }
  204. /// <summary>
  205. /// Gets or sets the studios.
  206. /// </summary>
  207. /// <value>The studios.</value>
  208. [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)]
  209. public string Artists { get; set; }
  210. public string ExcludeArtistIds { get; set; }
  211. [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)]
  212. public string ArtistIds { get; set; }
  213. public string AlbumArtistIds { get; set; }
  214. public string ContributingArtistIds { get; set; }
  215. [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)]
  216. public string Albums { get; set; }
  217. public string AlbumIds { get; set; }
  218. /// <summary>
  219. /// Gets or sets the item ids.
  220. /// </summary>
  221. /// <value>The item ids.</value>
  222. [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)]
  223. public string Ids { get; set; }
  224. /// <summary>
  225. /// Gets or sets the video types.
  226. /// </summary>
  227. /// <value>The video types.</value>
  228. [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)]
  229. public string VideoTypes { get; set; }
  230. /// <summary>
  231. /// Gets or sets the user id.
  232. /// </summary>
  233. /// <value>The user id.</value>
  234. [ApiMember(Name = "UserId", Description = "User Id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  235. public Guid UserId { get; set; }
  236. /// <summary>
  237. /// Gets or sets the min offical rating.
  238. /// </summary>
  239. /// <value>The min offical rating.</value>
  240. [ApiMember(Name = "MinOfficialRating", Description = "Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  241. public string MinOfficialRating { get; set; }
  242. [ApiMember(Name = "IsLocked", Description = "Optional filter by items that are locked.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  243. public bool? IsLocked { get; set; }
  244. [ApiMember(Name = "IsPlaceHolder", Description = "Optional filter by items that are placeholders", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  245. public bool? IsPlaceHolder { get; set; }
  246. [ApiMember(Name = "HasOfficialRating", Description = "Optional filter by items that have official ratings", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  247. public bool? HasOfficialRating { get; set; }
  248. [ApiMember(Name = "CollapseBoxSetItems", Description = "Whether or not to hide items behind their boxsets.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  249. public bool? CollapseBoxSetItems { get; set; }
  250. public int? MinWidth { get; set; }
  251. public int? MinHeight { get; set; }
  252. public int? MaxWidth { get; set; }
  253. public int? MaxHeight { get; set; }
  254. /// <summary>
  255. /// Gets or sets the video formats.
  256. /// </summary>
  257. /// <value>The video formats.</value>
  258. [ApiMember(Name = "Is3D", Description = "Optional filter by items that are 3D, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  259. public bool? Is3D { get; set; }
  260. /// <summary>
  261. /// Gets or sets the series status.
  262. /// </summary>
  263. /// <value>The series status.</value>
  264. [ApiMember(Name = "SeriesStatus", Description = "Optional filter by Series Status. Allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  265. public string SeriesStatus { get; set; }
  266. [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")]
  267. public string NameStartsWithOrGreater { get; set; }
  268. [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")]
  269. public string NameStartsWith { get; set; }
  270. [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")]
  271. public string NameLessThan { get; set; }
  272. public string[] GetGenres()
  273. {
  274. return (Genres ?? string.Empty).Split(new[] { '|' }, StringSplitOptions.RemoveEmptyEntries);
  275. }
  276. public string[] GetTags()
  277. {
  278. return (Tags ?? string.Empty).Split(new[] { '|' }, StringSplitOptions.RemoveEmptyEntries);
  279. }
  280. public string[] GetOfficialRatings()
  281. {
  282. return (OfficialRatings ?? string.Empty).Split(new[] { '|' }, StringSplitOptions.RemoveEmptyEntries);
  283. }
  284. public string[] GetMediaTypes()
  285. {
  286. return (MediaTypes ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
  287. }
  288. public string[] GetIncludeItemTypes()
  289. {
  290. return (IncludeItemTypes ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
  291. }
  292. public string[] GetExcludeItemTypes()
  293. {
  294. return (ExcludeItemTypes ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
  295. }
  296. public int[] GetYears()
  297. {
  298. return (Years ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries).Select(int.Parse).ToArray();
  299. }
  300. public string[] GetStudios()
  301. {
  302. return (Studios ?? string.Empty).Split(new[] { '|' }, StringSplitOptions.RemoveEmptyEntries);
  303. }
  304. public string[] GetPersonTypes()
  305. {
  306. return (PersonTypes ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
  307. }
  308. public VideoType[] GetVideoTypes()
  309. {
  310. return string.IsNullOrEmpty(VideoTypes)
  311. ? Array.Empty<VideoType>()
  312. : VideoTypes.Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries)
  313. .Select(v => Enum.Parse<VideoType>(v, true)).ToArray();
  314. }
  315. /// <summary>
  316. /// Gets the filters.
  317. /// </summary>
  318. /// <returns>IEnumerable{ItemFilter}.</returns>
  319. public ItemFilter[] GetFilters()
  320. {
  321. var val = Filters;
  322. return string.IsNullOrEmpty(val)
  323. ? Array.Empty<ItemFilter>()
  324. : val.Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries)
  325. .Select(v => Enum.Parse<ItemFilter>(v, true)).ToArray();
  326. }
  327. /// <summary>
  328. /// Gets the image types.
  329. /// </summary>
  330. /// <returns>IEnumerable{ImageType}.</returns>
  331. public ImageType[] GetImageTypes()
  332. {
  333. var val = ImageTypes;
  334. return string.IsNullOrEmpty(val)
  335. ? Array.Empty<ImageType>()
  336. : val.Split(',').Select(v => Enum.Parse<ImageType>(v, true)).ToArray();
  337. }
  338. /// <summary>
  339. /// Gets the order by.
  340. /// </summary>
  341. /// <returns>IEnumerable{ItemSortBy}.</returns>
  342. public ValueTuple<string, SortOrder>[] GetOrderBy()
  343. {
  344. return GetOrderBy(SortBy, SortOrder);
  345. }
  346. public static ValueTuple<string, SortOrder>[] GetOrderBy(string sortBy, string requestedSortOrder)
  347. {
  348. var val = sortBy;
  349. if (string.IsNullOrEmpty(val))
  350. {
  351. return Array.Empty<ValueTuple<string, SortOrder>>();
  352. }
  353. var vals = val.Split(',');
  354. if (string.IsNullOrWhiteSpace(requestedSortOrder))
  355. {
  356. requestedSortOrder = "Ascending";
  357. }
  358. var sortOrders = requestedSortOrder.Split(',');
  359. var result = new ValueTuple<string, SortOrder>[vals.Length];
  360. for (var i = 0; i < vals.Length; i++)
  361. {
  362. var sortOrderIndex = sortOrders.Length > i ? i : 0;
  363. var sortOrderValue = sortOrders.Length > sortOrderIndex ? sortOrders[sortOrderIndex] : null;
  364. var sortOrder = string.Equals(sortOrderValue, "Descending", StringComparison.OrdinalIgnoreCase)
  365. ? Jellyfin.Data.Enums.SortOrder.Descending
  366. : Jellyfin.Data.Enums.SortOrder.Ascending;
  367. result[i] = new ValueTuple<string, SortOrder>(vals[i], sortOrder);
  368. }
  369. return result;
  370. }
  371. }
  372. }