LibraryService.cs 42 KB

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