LibraryService.cs 42 KB

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