LibraryService.cs 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113
  1. using System;
  2. using System.Collections.Generic;
  3. using System.IO;
  4. using System.Linq;
  5. using System.Net;
  6. using System.Text.RegularExpressions;
  7. using System.Threading;
  8. using System.Threading.Tasks;
  9. using Jellyfin.Data.Entities;
  10. using MediaBrowser.Api.Movies;
  11. using MediaBrowser.Common.Extensions;
  12. using MediaBrowser.Common.Progress;
  13. using MediaBrowser.Controller.Configuration;
  14. using MediaBrowser.Controller.Dto;
  15. using MediaBrowser.Controller.Entities;
  16. using MediaBrowser.Controller.Entities.Audio;
  17. using MediaBrowser.Controller.Entities.Movies;
  18. using MediaBrowser.Controller.Library;
  19. using MediaBrowser.Controller.Net;
  20. using MediaBrowser.Controller.Providers;
  21. using MediaBrowser.Model.Activity;
  22. using MediaBrowser.Model.Configuration;
  23. using MediaBrowser.Model.Dto;
  24. using MediaBrowser.Model.Entities;
  25. using MediaBrowser.Model.Globalization;
  26. using MediaBrowser.Model.Querying;
  27. using MediaBrowser.Model.Services;
  28. using Microsoft.Extensions.Logging;
  29. using Microsoft.Net.Http.Headers;
  30. using Book = MediaBrowser.Controller.Entities.Book;
  31. using Episode = MediaBrowser.Controller.Entities.TV.Episode;
  32. using MetadataProvider = MediaBrowser.Model.Entities.MetadataProvider;
  33. using Movie = MediaBrowser.Controller.Entities.Movies.Movie;
  34. using MusicAlbum = MediaBrowser.Controller.Entities.Audio.MusicAlbum;
  35. using Series = MediaBrowser.Controller.Entities.TV.Series;
  36. namespace MediaBrowser.Api.Library
  37. {
  38. [Route("/Items/{Id}/File", "GET", Summary = "Gets the original file of an item")]
  39. [Authenticated]
  40. public class GetFile
  41. {
  42. /// <summary>
  43. /// Gets or sets the id.
  44. /// </summary>
  45. /// <value>The id.</value>
  46. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  47. public string Id { get; set; }
  48. }
  49. /// <summary>
  50. /// Class GetCriticReviews
  51. /// </summary>
  52. [Route("/Items/{Id}/CriticReviews", "GET", Summary = "Gets critic reviews for an item")]
  53. [Authenticated]
  54. public class GetCriticReviews : IReturn<QueryResult<BaseItemDto>>
  55. {
  56. /// <summary>
  57. /// Gets or sets the id.
  58. /// </summary>
  59. /// <value>The id.</value>
  60. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  61. public string Id { get; set; }
  62. /// <summary>
  63. /// Skips over a given number of items within the results. Use for paging.
  64. /// </summary>
  65. /// <value>The start index.</value>
  66. [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")]
  67. public int? StartIndex { get; set; }
  68. /// <summary>
  69. /// The maximum number of items to return
  70. /// </summary>
  71. /// <value>The limit.</value>
  72. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  73. public int? Limit { get; set; }
  74. }
  75. /// <summary>
  76. /// Class GetThemeSongs
  77. /// </summary>
  78. [Route("/Items/{Id}/ThemeSongs", "GET", Summary = "Gets theme songs for an item")]
  79. [Authenticated]
  80. public class GetThemeSongs : IReturn<ThemeMediaResult>
  81. {
  82. /// <summary>
  83. /// Gets or sets the user id.
  84. /// </summary>
  85. /// <value>The user id.</value>
  86. [ApiMember(Name = "UserId", Description = "Optional. Filter by user id, and attach user data", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  87. public Guid UserId { get; set; }
  88. /// <summary>
  89. /// Gets or sets the id.
  90. /// </summary>
  91. /// <value>The id.</value>
  92. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  93. public string Id { get; set; }
  94. [ApiMember(Name = "InheritFromParent", Description = "Determines whether or not parent items should be searched for theme media.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  95. public bool InheritFromParent { get; set; }
  96. }
  97. /// <summary>
  98. /// Class GetThemeVideos
  99. /// </summary>
  100. [Route("/Items/{Id}/ThemeVideos", "GET", Summary = "Gets theme videos for an item")]
  101. [Authenticated]
  102. public class GetThemeVideos : IReturn<ThemeMediaResult>
  103. {
  104. /// <summary>
  105. /// Gets or sets the user id.
  106. /// </summary>
  107. /// <value>The user id.</value>
  108. [ApiMember(Name = "UserId", Description = "Optional. Filter by user id, and attach user data", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  109. public Guid UserId { get; set; }
  110. /// <summary>
  111. /// Gets or sets the id.
  112. /// </summary>
  113. /// <value>The id.</value>
  114. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  115. public string Id { get; set; }
  116. [ApiMember(Name = "InheritFromParent", Description = "Determines whether or not parent items should be searched for theme media.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  117. public bool InheritFromParent { get; set; }
  118. }
  119. /// <summary>
  120. /// Class GetThemeVideos
  121. /// </summary>
  122. [Route("/Items/{Id}/ThemeMedia", "GET", Summary = "Gets theme videos and songs for an item")]
  123. [Authenticated]
  124. public class GetThemeMedia : IReturn<AllThemeMediaResult>
  125. {
  126. /// <summary>
  127. /// Gets or sets the user id.
  128. /// </summary>
  129. /// <value>The user id.</value>
  130. [ApiMember(Name = "UserId", Description = "Optional. Filter by user id, and attach user data", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  131. public Guid UserId { get; set; }
  132. /// <summary>
  133. /// Gets or sets the id.
  134. /// </summary>
  135. /// <value>The id.</value>
  136. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  137. public string Id { get; set; }
  138. [ApiMember(Name = "InheritFromParent", Description = "Determines whether or not parent items should be searched for theme media.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  139. public bool InheritFromParent { get; set; }
  140. }
  141. [Route("/Library/Refresh", "POST", Summary = "Starts a library scan")]
  142. [Authenticated(Roles = "Admin")]
  143. public class RefreshLibrary : IReturnVoid
  144. {
  145. }
  146. [Route("/Items/{Id}", "DELETE", Summary = "Deletes an item from the library and file system")]
  147. [Authenticated]
  148. public class DeleteItem : IReturnVoid
  149. {
  150. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
  151. public string Id { get; set; }
  152. }
  153. [Route("/Items", "DELETE", Summary = "Deletes an item from the library and file system")]
  154. [Authenticated]
  155. public class DeleteItems : IReturnVoid
  156. {
  157. [ApiMember(Name = "Ids", Description = "Ids", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "DELETE")]
  158. public string Ids { get; set; }
  159. }
  160. [Route("/Items/Counts", "GET")]
  161. [Authenticated]
  162. public class GetItemCounts : IReturn<ItemCounts>
  163. {
  164. [ApiMember(Name = "UserId", Description = "Optional. Get counts from a specific user's library.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  165. public Guid UserId { get; set; }
  166. [ApiMember(Name = "IsFavorite", Description = "Optional. Get counts of favorite items", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  167. public bool? IsFavorite { get; set; }
  168. }
  169. [Route("/Items/{Id}/Ancestors", "GET", Summary = "Gets all parents of an item")]
  170. [Authenticated]
  171. public class GetAncestors : IReturn<BaseItemDto[]>
  172. {
  173. /// <summary>
  174. /// Gets or sets the user id.
  175. /// </summary>
  176. /// <value>The user id.</value>
  177. [ApiMember(Name = "UserId", Description = "Optional. Filter by user id, and attach user data", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  178. public Guid UserId { get; set; }
  179. /// <summary>
  180. /// Gets or sets the id.
  181. /// </summary>
  182. /// <value>The id.</value>
  183. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  184. public string Id { get; set; }
  185. }
  186. /// <summary>
  187. /// Class GetPhyscialPaths
  188. /// </summary>
  189. [Route("/Library/PhysicalPaths", "GET", Summary = "Gets a list of physical paths from virtual folders")]
  190. [Authenticated(Roles = "Admin")]
  191. public class GetPhyscialPaths : IReturn<List<string>>
  192. {
  193. }
  194. [Route("/Library/MediaFolders", "GET", Summary = "Gets all user media folders.")]
  195. [Authenticated]
  196. public class GetMediaFolders : IReturn<QueryResult<BaseItemDto>>
  197. {
  198. [ApiMember(Name = "IsHidden", Description = "Optional. Filter by folders that are marked hidden, or not.", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  199. public bool? IsHidden { get; set; }
  200. }
  201. [Route("/Library/Series/Added", "POST", Summary = "Reports that new episodes of a series have been added by an external source")]
  202. [Route("/Library/Series/Updated", "POST", Summary = "Reports that new episodes of a series have been added by an external source")]
  203. [Authenticated]
  204. public class PostUpdatedSeries : IReturnVoid
  205. {
  206. [ApiMember(Name = "TvdbId", Description = "Tvdb Id", IsRequired = false, DataType = "string", ParameterType = "path", Verb = "POST")]
  207. public string TvdbId { get; set; }
  208. }
  209. [Route("/Library/Movies/Added", "POST", Summary = "Reports that new movies have been added by an external source")]
  210. [Route("/Library/Movies/Updated", "POST", Summary = "Reports that new movies have been added by an external source")]
  211. [Authenticated]
  212. public class PostUpdatedMovies : IReturnVoid
  213. {
  214. [ApiMember(Name = "TmdbId", Description = "Tmdb Id", IsRequired = false, DataType = "string", ParameterType = "path", Verb = "POST")]
  215. public string TmdbId { get; set; }
  216. [ApiMember(Name = "ImdbId", Description = "Imdb Id", IsRequired = false, DataType = "string", ParameterType = "path", Verb = "POST")]
  217. public string ImdbId { get; set; }
  218. }
  219. public class MediaUpdateInfo
  220. {
  221. public string Path { get; set; }
  222. // Created, Modified, Deleted
  223. public string UpdateType { get; set; }
  224. }
  225. [Route("/Library/Media/Updated", "POST", Summary = "Reports that new movies have been added by an external source")]
  226. [Authenticated]
  227. public class PostUpdatedMedia : IReturnVoid
  228. {
  229. [ApiMember(Name = "Updates", Description = "A list of updated media paths", IsRequired = false, DataType = "string", ParameterType = "body", Verb = "POST")]
  230. public List<MediaUpdateInfo> Updates { get; set; }
  231. }
  232. [Route("/Items/{Id}/Download", "GET", Summary = "Downloads item media")]
  233. [Authenticated(Roles = "download")]
  234. public class GetDownload
  235. {
  236. /// <summary>
  237. /// Gets or sets the id.
  238. /// </summary>
  239. /// <value>The id.</value>
  240. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  241. public string Id { get; set; }
  242. }
  243. [Route("/Artists/{Id}/Similar", "GET", Summary = "Finds albums similar to a given album.")]
  244. [Route("/Items/{Id}/Similar", "GET", Summary = "Gets similar items")]
  245. [Route("/Albums/{Id}/Similar", "GET", Summary = "Finds albums similar to a given album.")]
  246. [Route("/Shows/{Id}/Similar", "GET", Summary = "Finds tv shows similar to a given one.")]
  247. [Route("/Movies/{Id}/Similar", "GET", Summary = "Finds movies and trailers similar to a given movie.")]
  248. [Route("/Trailers/{Id}/Similar", "GET", Summary = "Finds movies and trailers similar to a given trailer.")]
  249. [Authenticated]
  250. public class GetSimilarItems : BaseGetSimilarItemsFromItem
  251. {
  252. }
  253. [Route("/Libraries/AvailableOptions", "GET")]
  254. [Authenticated(AllowBeforeStartupWizard = true)]
  255. public class GetLibraryOptionsInfo : IReturn<LibraryOptionsResult>
  256. {
  257. public string LibraryContentType { get; set; }
  258. public bool IsNewLibrary { get; set; }
  259. }
  260. public class LibraryOptionInfo
  261. {
  262. public string Name { get; set; }
  263. public bool DefaultEnabled { get; set; }
  264. }
  265. public class LibraryOptionsResult
  266. {
  267. public LibraryOptionInfo[] MetadataSavers { get; set; }
  268. public LibraryOptionInfo[] MetadataReaders { get; set; }
  269. public LibraryOptionInfo[] SubtitleFetchers { get; set; }
  270. public LibraryTypeOptions[] TypeOptions { get; set; }
  271. }
  272. public class LibraryTypeOptions
  273. {
  274. public string Type { get; set; }
  275. public LibraryOptionInfo[] MetadataFetchers { get; set; }
  276. public LibraryOptionInfo[] ImageFetchers { get; set; }
  277. public ImageType[] SupportedImageTypes { get; set; }
  278. public ImageOption[] DefaultImageOptions { get; set; }
  279. }
  280. /// <summary>
  281. /// Class LibraryService
  282. /// </summary>
  283. public class LibraryService : BaseApiService
  284. {
  285. private readonly IProviderManager _providerManager;
  286. private readonly ILibraryManager _libraryManager;
  287. private readonly IUserManager _userManager;
  288. private readonly IDtoService _dtoService;
  289. private readonly IAuthorizationContext _authContext;
  290. private readonly IActivityManager _activityManager;
  291. private readonly ILocalizationManager _localization;
  292. private readonly ILibraryMonitor _libraryMonitor;
  293. private readonly ILogger<MoviesService> _moviesServiceLogger;
  294. /// <summary>
  295. /// Initializes a new instance of the <see cref="LibraryService" /> class.
  296. /// </summary>
  297. public LibraryService(
  298. ILogger<LibraryService> logger,
  299. ILogger<MoviesService> moviesServiceLogger,
  300. IServerConfigurationManager serverConfigurationManager,
  301. IHttpResultFactory httpResultFactory,
  302. IProviderManager providerManager,
  303. ILibraryManager libraryManager,
  304. IUserManager userManager,
  305. IDtoService dtoService,
  306. IAuthorizationContext authContext,
  307. IActivityManager activityManager,
  308. ILocalizationManager localization,
  309. ILibraryMonitor libraryMonitor)
  310. : base(logger, serverConfigurationManager, httpResultFactory)
  311. {
  312. _providerManager = providerManager;
  313. _libraryManager = libraryManager;
  314. _userManager = userManager;
  315. _dtoService = dtoService;
  316. _authContext = authContext;
  317. _activityManager = activityManager;
  318. _localization = localization;
  319. _libraryMonitor = libraryMonitor;
  320. _moviesServiceLogger = moviesServiceLogger;
  321. }
  322. private string[] GetRepresentativeItemTypes(string contentType)
  323. {
  324. return contentType switch
  325. {
  326. CollectionType.BoxSets => new[] {"BoxSet"},
  327. CollectionType.Playlists => new[] {"Playlist"},
  328. CollectionType.Movies => new[] {"Movie"},
  329. CollectionType.TvShows => new[] {"Series", "Season", "Episode"},
  330. CollectionType.Books => new[] {"Book"},
  331. CollectionType.Music => new[] {"MusicAlbum", "MusicArtist", "Audio", "MusicVideo"},
  332. CollectionType.HomeVideos => new[] {"Video", "Photo"},
  333. CollectionType.Photos => new[] {"Video", "Photo"},
  334. CollectionType.MusicVideos => new[] {"MusicVideo"},
  335. _ => new[] {"Series", "Season", "Episode", "Movie"}
  336. };
  337. }
  338. private bool IsSaverEnabledByDefault(string name, string[] itemTypes, bool isNewLibrary)
  339. {
  340. if (isNewLibrary)
  341. {
  342. return false;
  343. }
  344. var metadataOptions = ServerConfigurationManager.Configuration.MetadataOptions
  345. .Where(i => itemTypes.Contains(i.ItemType ?? string.Empty, StringComparer.OrdinalIgnoreCase))
  346. .ToArray();
  347. if (metadataOptions.Length == 0)
  348. {
  349. return true;
  350. }
  351. return metadataOptions.Any(i => !i.DisabledMetadataSavers.Contains(name, StringComparer.OrdinalIgnoreCase));
  352. }
  353. private bool IsMetadataFetcherEnabledByDefault(string name, string type, bool isNewLibrary)
  354. {
  355. if (isNewLibrary)
  356. {
  357. if (string.Equals(name, "TheMovieDb", StringComparison.OrdinalIgnoreCase))
  358. {
  359. return !(string.Equals(type, "Season", StringComparison.OrdinalIgnoreCase)
  360. || string.Equals(type, "Episode", StringComparison.OrdinalIgnoreCase)
  361. || string.Equals(type, "MusicVideo", StringComparison.OrdinalIgnoreCase));
  362. }
  363. return string.Equals(name, "TheTVDB", StringComparison.OrdinalIgnoreCase)
  364. || string.Equals(name, "TheAudioDB", StringComparison.OrdinalIgnoreCase)
  365. || string.Equals(name, "MusicBrainz", StringComparison.OrdinalIgnoreCase);
  366. }
  367. var metadataOptions = ServerConfigurationManager.Configuration.MetadataOptions
  368. .Where(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase))
  369. .ToArray();
  370. return metadataOptions.Length == 0
  371. || metadataOptions.Any(i => !i.DisabledMetadataFetchers.Contains(name, StringComparer.OrdinalIgnoreCase));
  372. }
  373. private bool IsImageFetcherEnabledByDefault(string name, string type, bool isNewLibrary)
  374. {
  375. if (isNewLibrary)
  376. {
  377. if (string.Equals(name, "TheMovieDb", StringComparison.OrdinalIgnoreCase))
  378. {
  379. return !string.Equals(type, "Series", StringComparison.OrdinalIgnoreCase)
  380. && !string.Equals(type, "Season", StringComparison.OrdinalIgnoreCase)
  381. && !string.Equals(type, "Episode", StringComparison.OrdinalIgnoreCase)
  382. && !string.Equals(type, "MusicVideo", StringComparison.OrdinalIgnoreCase);
  383. }
  384. return string.Equals(name, "TheTVDB", StringComparison.OrdinalIgnoreCase)
  385. || string.Equals(name, "Screen Grabber", StringComparison.OrdinalIgnoreCase)
  386. || string.Equals(name, "TheAudioDB", StringComparison.OrdinalIgnoreCase)
  387. || string.Equals(name, "Emby Designs", StringComparison.OrdinalIgnoreCase)
  388. || string.Equals(name, "Image Extractor", StringComparison.OrdinalIgnoreCase);
  389. }
  390. var metadataOptions = ServerConfigurationManager.Configuration.MetadataOptions
  391. .Where(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase))
  392. .ToArray();
  393. if (metadataOptions.Length == 0)
  394. {
  395. return true;
  396. }
  397. return metadataOptions.Any(i => !i.DisabledImageFetchers.Contains(name, StringComparer.OrdinalIgnoreCase));
  398. }
  399. public object Get(GetLibraryOptionsInfo request)
  400. {
  401. var result = new LibraryOptionsResult();
  402. var types = GetRepresentativeItemTypes(request.LibraryContentType);
  403. var isNewLibrary = request.IsNewLibrary;
  404. var typesList = types.ToList();
  405. var plugins = _providerManager.GetAllMetadataPlugins()
  406. .Where(i => types.Contains(i.ItemType, StringComparer.OrdinalIgnoreCase))
  407. .OrderBy(i => typesList.IndexOf(i.ItemType))
  408. .ToList();
  409. result.MetadataSavers = plugins
  410. .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.MetadataSaver))
  411. .Select(i => new LibraryOptionInfo
  412. {
  413. Name = i.Name,
  414. DefaultEnabled = IsSaverEnabledByDefault(i.Name, types, isNewLibrary)
  415. })
  416. .GroupBy(i => i.Name, StringComparer.OrdinalIgnoreCase)
  417. .Select(x => x.First())
  418. .ToArray();
  419. result.MetadataReaders = plugins
  420. .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.LocalMetadataProvider))
  421. .Select(i => new LibraryOptionInfo
  422. {
  423. Name = i.Name,
  424. DefaultEnabled = true
  425. })
  426. .GroupBy(i => i.Name, StringComparer.OrdinalIgnoreCase)
  427. .Select(x => x.First())
  428. .ToArray();
  429. result.SubtitleFetchers = plugins
  430. .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.SubtitleFetcher))
  431. .Select(i => new LibraryOptionInfo
  432. {
  433. Name = i.Name,
  434. DefaultEnabled = true
  435. })
  436. .GroupBy(i => i.Name, StringComparer.OrdinalIgnoreCase)
  437. .Select(x => x.First())
  438. .ToArray();
  439. var typeOptions = new List<LibraryTypeOptions>();
  440. foreach (var type in types)
  441. {
  442. TypeOptions.DefaultImageOptions.TryGetValue(type, out var defaultImageOptions);
  443. typeOptions.Add(new LibraryTypeOptions
  444. {
  445. Type = type,
  446. MetadataFetchers = plugins
  447. .Where(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase))
  448. .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.MetadataFetcher))
  449. .Select(i => new LibraryOptionInfo
  450. {
  451. Name = i.Name,
  452. DefaultEnabled = IsMetadataFetcherEnabledByDefault(i.Name, type, isNewLibrary)
  453. })
  454. .GroupBy(i => i.Name, StringComparer.OrdinalIgnoreCase)
  455. .Select(x => x.First())
  456. .ToArray(),
  457. ImageFetchers = plugins
  458. .Where(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase))
  459. .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.ImageFetcher))
  460. .Select(i => new LibraryOptionInfo
  461. {
  462. Name = i.Name,
  463. DefaultEnabled = IsImageFetcherEnabledByDefault(i.Name, type, isNewLibrary)
  464. })
  465. .GroupBy(i => i.Name, StringComparer.OrdinalIgnoreCase)
  466. .Select(x => x.First())
  467. .ToArray(),
  468. SupportedImageTypes = plugins
  469. .Where(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase))
  470. .SelectMany(i => i.SupportedImageTypes ?? Array.Empty<ImageType>())
  471. .Distinct()
  472. .ToArray(),
  473. DefaultImageOptions = defaultImageOptions ?? Array.Empty<ImageOption>()
  474. });
  475. }
  476. result.TypeOptions = typeOptions.ToArray();
  477. return result;
  478. }
  479. public object Get(GetSimilarItems request)
  480. {
  481. var item = string.IsNullOrEmpty(request.Id) ?
  482. (!request.UserId.Equals(Guid.Empty) ? _libraryManager.GetUserRootFolder() :
  483. _libraryManager.RootFolder) : _libraryManager.GetItemById(request.Id);
  484. var program = item as IHasProgramAttributes;
  485. if (item is Movie || (program != null && program.IsMovie) || item is Trailer)
  486. {
  487. return new MoviesService(
  488. _moviesServiceLogger,
  489. ServerConfigurationManager,
  490. ResultFactory,
  491. _userManager,
  492. _libraryManager,
  493. _dtoService,
  494. _authContext)
  495. {
  496. Request = Request,
  497. }.GetSimilarItemsResult(request);
  498. }
  499. if (program != null && program.IsSeries)
  500. {
  501. return GetSimilarItemsResult(request, new[] { typeof(Series).Name });
  502. }
  503. if (item is Episode || (item is IItemByName && !(item is MusicArtist)))
  504. {
  505. return new QueryResult<BaseItemDto>();
  506. }
  507. return GetSimilarItemsResult(request, new[] { item.GetType().Name });
  508. }
  509. private QueryResult<BaseItemDto> GetSimilarItemsResult(BaseGetSimilarItemsFromItem request, string[] includeItemTypes)
  510. {
  511. var user = !request.UserId.Equals(Guid.Empty) ? _userManager.GetUserById(request.UserId) : null;
  512. var item = string.IsNullOrEmpty(request.Id) ?
  513. (!request.UserId.Equals(Guid.Empty) ? _libraryManager.GetUserRootFolder() :
  514. _libraryManager.RootFolder) : _libraryManager.GetItemById(request.Id);
  515. var dtoOptions = GetDtoOptions(_authContext, request);
  516. var query = new InternalItemsQuery(user)
  517. {
  518. Limit = request.Limit,
  519. IncludeItemTypes = includeItemTypes,
  520. SimilarTo = item,
  521. DtoOptions = dtoOptions,
  522. EnableTotalRecordCount = false
  523. };
  524. // ExcludeArtistIds
  525. if (!string.IsNullOrEmpty(request.ExcludeArtistIds))
  526. {
  527. query.ExcludeArtistIds = GetGuids(request.ExcludeArtistIds);
  528. }
  529. List<BaseItem> itemsResult;
  530. if (item is MusicArtist)
  531. {
  532. query.IncludeItemTypes = Array.Empty<string>();
  533. itemsResult = _libraryManager.GetArtists(query).Items.Select(i => i.Item1).ToList();
  534. }
  535. else
  536. {
  537. itemsResult = _libraryManager.GetItemList(query);
  538. }
  539. var returnList = _dtoService.GetBaseItemDtos(itemsResult, dtoOptions, user);
  540. var result = new QueryResult<BaseItemDto>
  541. {
  542. Items = returnList,
  543. TotalRecordCount = itemsResult.Count
  544. };
  545. return result;
  546. }
  547. public object Get(GetMediaFolders request)
  548. {
  549. var items = _libraryManager.GetUserRootFolder().Children.Concat(_libraryManager.RootFolder.VirtualChildren).OrderBy(i => i.SortName).ToList();
  550. if (request.IsHidden.HasValue)
  551. {
  552. var val = request.IsHidden.Value;
  553. items = items.Where(i => i.IsHidden == val).ToList();
  554. }
  555. var dtoOptions = GetDtoOptions(_authContext, request);
  556. var result = new QueryResult<BaseItemDto>
  557. {
  558. TotalRecordCount = items.Count,
  559. Items = items.Select(i => _dtoService.GetBaseItemDto(i, dtoOptions)).ToArray()
  560. };
  561. return result;
  562. }
  563. public void Post(PostUpdatedSeries request)
  564. {
  565. var series = _libraryManager.GetItemList(new InternalItemsQuery
  566. {
  567. IncludeItemTypes = new[] { typeof(Series).Name },
  568. DtoOptions = new DtoOptions(false)
  569. {
  570. EnableImages = false
  571. }
  572. }).Where(i => string.Equals(request.TvdbId, i.GetProviderId(MetadataProvider.Tvdb), StringComparison.OrdinalIgnoreCase)).ToArray();
  573. foreach (var item in series)
  574. {
  575. _libraryMonitor.ReportFileSystemChanged(item.Path);
  576. }
  577. }
  578. public void Post(PostUpdatedMedia request)
  579. {
  580. if (request.Updates != null)
  581. {
  582. foreach (var item in request.Updates)
  583. {
  584. _libraryMonitor.ReportFileSystemChanged(item.Path);
  585. }
  586. }
  587. }
  588. public void Post(PostUpdatedMovies request)
  589. {
  590. var movies = _libraryManager.GetItemList(new InternalItemsQuery
  591. {
  592. IncludeItemTypes = new[] { typeof(Movie).Name },
  593. DtoOptions = new DtoOptions(false)
  594. {
  595. EnableImages = false
  596. }
  597. });
  598. if (!string.IsNullOrWhiteSpace(request.ImdbId))
  599. {
  600. movies = movies.Where(i => string.Equals(request.ImdbId, i.GetProviderId(MetadataProvider.Imdb), StringComparison.OrdinalIgnoreCase)).ToList();
  601. }
  602. else if (!string.IsNullOrWhiteSpace(request.TmdbId))
  603. {
  604. movies = movies.Where(i => string.Equals(request.TmdbId, i.GetProviderId(MetadataProvider.Tmdb), StringComparison.OrdinalIgnoreCase)).ToList();
  605. }
  606. else
  607. {
  608. movies = new List<BaseItem>();
  609. }
  610. foreach (var item in movies)
  611. {
  612. _libraryMonitor.ReportFileSystemChanged(item.Path);
  613. }
  614. }
  615. public Task<object> Get(GetDownload request)
  616. {
  617. var item = _libraryManager.GetItemById(request.Id);
  618. var auth = _authContext.GetAuthorizationInfo(Request);
  619. var user = auth.User;
  620. if (user != null)
  621. {
  622. if (!item.CanDownload(user))
  623. {
  624. throw new ArgumentException("Item does not support downloading");
  625. }
  626. }
  627. else
  628. {
  629. if (!item.CanDownload())
  630. {
  631. throw new ArgumentException("Item does not support downloading");
  632. }
  633. }
  634. var headers = new Dictionary<string, string>();
  635. if (user != null)
  636. {
  637. LogDownload(item, user, auth);
  638. }
  639. var path = item.Path;
  640. // Quotes are valid in linux. They'll possibly cause issues here
  641. var filename = (Path.GetFileName(path) ?? string.Empty).Replace("\"", string.Empty);
  642. if (!string.IsNullOrWhiteSpace(filename))
  643. {
  644. // Kestrel doesn't support non-ASCII characters in headers
  645. if (Regex.IsMatch(filename, @"[^\p{IsBasicLatin}]"))
  646. {
  647. // Manually encoding non-ASCII characters, following https://tools.ietf.org/html/rfc5987#section-3.2.2
  648. headers[HeaderNames.ContentDisposition] = "attachment; filename*=UTF-8''" + WebUtility.UrlEncode(filename);
  649. }
  650. else
  651. {
  652. headers[HeaderNames.ContentDisposition] = "attachment; filename=\"" + filename + "\"";
  653. }
  654. }
  655. return ResultFactory.GetStaticFileResult(Request, new StaticFileResultOptions
  656. {
  657. Path = path,
  658. ResponseHeaders = headers
  659. });
  660. }
  661. private void LogDownload(BaseItem item, User user, AuthorizationInfo auth)
  662. {
  663. try
  664. {
  665. _activityManager.Create(new ActivityLog(
  666. string.Format(_localization.GetLocalizedString("UserDownloadingItemWithValues"), user.Username, item.Name),
  667. "UserDownloadingContent",
  668. auth.UserId)
  669. {
  670. ShortOverview = string.Format(_localization.GetLocalizedString("AppDeviceValues"), auth.Client, auth.Device),
  671. });
  672. }
  673. catch
  674. {
  675. // Logged at lower levels
  676. }
  677. }
  678. public Task<object> Get(GetFile request)
  679. {
  680. var item = _libraryManager.GetItemById(request.Id);
  681. return ResultFactory.GetStaticFileResult(Request, item.Path);
  682. }
  683. /// <summary>
  684. /// Gets the specified request.
  685. /// </summary>
  686. /// <param name="request">The request.</param>
  687. /// <returns>System.Object.</returns>
  688. public object Get(GetPhyscialPaths request)
  689. {
  690. var result = _libraryManager.RootFolder.Children
  691. .SelectMany(c => c.PhysicalLocations)
  692. .ToList();
  693. return ToOptimizedResult(result);
  694. }
  695. /// <summary>
  696. /// Gets the specified request.
  697. /// </summary>
  698. /// <param name="request">The request.</param>
  699. /// <returns>System.Object.</returns>
  700. public object Get(GetAncestors request)
  701. {
  702. var result = GetAncestors(request);
  703. return ToOptimizedResult(result);
  704. }
  705. /// <summary>
  706. /// Gets the ancestors.
  707. /// </summary>
  708. /// <param name="request">The request.</param>
  709. /// <returns>Task{BaseItemDto[]}.</returns>
  710. public List<BaseItemDto> GetAncestors(GetAncestors request)
  711. {
  712. var item = _libraryManager.GetItemById(request.Id);
  713. var baseItemDtos = new List<BaseItemDto>();
  714. var user = !request.UserId.Equals(Guid.Empty) ? _userManager.GetUserById(request.UserId) : null;
  715. var dtoOptions = GetDtoOptions(_authContext, request);
  716. BaseItem parent = item.GetParent();
  717. while (parent != null)
  718. {
  719. if (user != null)
  720. {
  721. parent = TranslateParentItem(parent, user);
  722. }
  723. baseItemDtos.Add(_dtoService.GetBaseItemDto(parent, dtoOptions, user));
  724. parent = parent.GetParent();
  725. }
  726. return baseItemDtos;
  727. }
  728. private BaseItem TranslateParentItem(BaseItem item, User user)
  729. {
  730. return item.GetParent() is AggregateFolder
  731. ? _libraryManager.GetUserRootFolder().GetChildren(user, true)
  732. .FirstOrDefault(i => i.PhysicalLocations.Contains(item.Path))
  733. : item;
  734. }
  735. /// <summary>
  736. /// Gets the specified request.
  737. /// </summary>
  738. /// <param name="request">The request.</param>
  739. /// <returns>System.Object.</returns>
  740. public object Get(GetCriticReviews request)
  741. {
  742. return new QueryResult<BaseItemDto>();
  743. }
  744. /// <summary>
  745. /// Gets the specified request.
  746. /// </summary>
  747. /// <param name="request">The request.</param>
  748. /// <returns>System.Object.</returns>
  749. public object Get(GetItemCounts request)
  750. {
  751. var user = request.UserId.Equals(Guid.Empty) ? null : _userManager.GetUserById(request.UserId);
  752. var counts = new ItemCounts
  753. {
  754. AlbumCount = GetCount(typeof(MusicAlbum), user, request),
  755. EpisodeCount = GetCount(typeof(Episode), user, request),
  756. MovieCount = GetCount(typeof(Movie), user, request),
  757. SeriesCount = GetCount(typeof(Series), user, request),
  758. SongCount = GetCount(typeof(Audio), user, request),
  759. MusicVideoCount = GetCount(typeof(MusicVideo), user, request),
  760. BoxSetCount = GetCount(typeof(BoxSet), user, request),
  761. BookCount = GetCount(typeof(Book), user, request)
  762. };
  763. return ToOptimizedResult(counts);
  764. }
  765. private int GetCount(Type type, User user, GetItemCounts request)
  766. {
  767. var query = new InternalItemsQuery(user)
  768. {
  769. IncludeItemTypes = new[] { type.Name },
  770. Limit = 0,
  771. Recursive = true,
  772. IsVirtualItem = false,
  773. IsFavorite = request.IsFavorite,
  774. DtoOptions = new DtoOptions(false)
  775. {
  776. EnableImages = false
  777. }
  778. };
  779. return _libraryManager.GetItemsResult(query).TotalRecordCount;
  780. }
  781. /// <summary>
  782. /// Posts the specified request.
  783. /// </summary>
  784. /// <param name="request">The request.</param>
  785. public async Task Post(RefreshLibrary request)
  786. {
  787. try
  788. {
  789. await _libraryManager.ValidateMediaLibrary(new SimpleProgress<double>(), CancellationToken.None).ConfigureAwait(false);
  790. }
  791. catch (Exception ex)
  792. {
  793. Logger.LogError(ex, "Error refreshing library");
  794. }
  795. }
  796. /// <summary>
  797. /// Deletes the specified request.
  798. /// </summary>
  799. /// <param name="request">The request.</param>
  800. public void Delete(DeleteItems request)
  801. {
  802. var ids = string.IsNullOrWhiteSpace(request.Ids)
  803. ? Array.Empty<string>()
  804. : request.Ids.Split(',');
  805. foreach (var i in ids)
  806. {
  807. var item = _libraryManager.GetItemById(i);
  808. var auth = _authContext.GetAuthorizationInfo(Request);
  809. var user = auth.User;
  810. if (!item.CanDelete(user))
  811. {
  812. if (ids.Length > 1)
  813. {
  814. throw new SecurityException("Unauthorized access");
  815. }
  816. continue;
  817. }
  818. _libraryManager.DeleteItem(item, new DeleteOptions
  819. {
  820. DeleteFileLocation = true
  821. }, true);
  822. }
  823. }
  824. /// <summary>
  825. /// Deletes the specified request.
  826. /// </summary>
  827. /// <param name="request">The request.</param>
  828. public void Delete(DeleteItem request)
  829. {
  830. Delete(new DeleteItems
  831. {
  832. Ids = request.Id
  833. });
  834. }
  835. public object Get(GetThemeMedia request)
  836. {
  837. var themeSongs = GetThemeSongs(new GetThemeSongs
  838. {
  839. InheritFromParent = request.InheritFromParent,
  840. Id = request.Id,
  841. UserId = request.UserId
  842. });
  843. var themeVideos = GetThemeVideos(new GetThemeVideos
  844. {
  845. InheritFromParent = request.InheritFromParent,
  846. Id = request.Id,
  847. UserId = request.UserId
  848. });
  849. return ToOptimizedResult(new AllThemeMediaResult
  850. {
  851. ThemeSongsResult = themeSongs,
  852. ThemeVideosResult = themeVideos,
  853. SoundtrackSongsResult = new ThemeMediaResult()
  854. });
  855. }
  856. /// <summary>
  857. /// Gets the specified request.
  858. /// </summary>
  859. /// <param name="request">The request.</param>
  860. /// <returns>System.Object.</returns>
  861. public object Get(GetThemeSongs request)
  862. {
  863. var result = GetThemeSongs(request);
  864. return ToOptimizedResult(result);
  865. }
  866. private ThemeMediaResult GetThemeSongs(GetThemeSongs request)
  867. {
  868. var user = !request.UserId.Equals(Guid.Empty) ? _userManager.GetUserById(request.UserId) : null;
  869. var item = string.IsNullOrEmpty(request.Id)
  870. ? (!request.UserId.Equals(Guid.Empty)
  871. ? _libraryManager.GetUserRootFolder()
  872. : _libraryManager.RootFolder)
  873. : _libraryManager.GetItemById(request.Id);
  874. if (item == null)
  875. {
  876. throw new ResourceNotFoundException("Item not found.");
  877. }
  878. IEnumerable<BaseItem> themeItems;
  879. while (true)
  880. {
  881. themeItems = item.GetThemeSongs();
  882. if (themeItems.Any() || !request.InheritFromParent)
  883. {
  884. break;
  885. }
  886. var parent = item.GetParent();
  887. if (parent == null)
  888. {
  889. break;
  890. }
  891. item = parent;
  892. }
  893. var dtoOptions = GetDtoOptions(_authContext, request);
  894. var items = themeItems
  895. .Select(i => _dtoService.GetBaseItemDto(i, dtoOptions, user, item))
  896. .ToArray();
  897. return new ThemeMediaResult
  898. {
  899. Items = items,
  900. TotalRecordCount = items.Length,
  901. OwnerId = item.Id
  902. };
  903. }
  904. /// <summary>
  905. /// Gets the specified request.
  906. /// </summary>
  907. /// <param name="request">The request.</param>
  908. /// <returns>System.Object.</returns>
  909. public object Get(GetThemeVideos request)
  910. {
  911. return ToOptimizedResult(GetThemeVideos(request));
  912. }
  913. public ThemeMediaResult GetThemeVideos(GetThemeVideos request)
  914. {
  915. var user = !request.UserId.Equals(Guid.Empty) ? _userManager.GetUserById(request.UserId) : null;
  916. var item = string.IsNullOrEmpty(request.Id)
  917. ? (!request.UserId.Equals(Guid.Empty)
  918. ? _libraryManager.GetUserRootFolder()
  919. : _libraryManager.RootFolder)
  920. : _libraryManager.GetItemById(request.Id);
  921. if (item == null)
  922. {
  923. throw new ResourceNotFoundException("Item not found.");
  924. }
  925. IEnumerable<BaseItem> themeItems;
  926. while (true)
  927. {
  928. themeItems = item.GetThemeVideos();
  929. if (themeItems.Any() || !request.InheritFromParent)
  930. {
  931. break;
  932. }
  933. var parent = item.GetParent();
  934. if (parent == null)
  935. {
  936. break;
  937. }
  938. item = parent;
  939. }
  940. var dtoOptions = GetDtoOptions(_authContext, request);
  941. var items = themeItems
  942. .Select(i => _dtoService.GetBaseItemDto(i, dtoOptions, user, item))
  943. .ToArray();
  944. return new ThemeMediaResult
  945. {
  946. Items = items,
  947. TotalRecordCount = items.Length,
  948. OwnerId = item.Id
  949. };
  950. }
  951. }
  952. }