2
0

LibraryService.cs 43 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142
  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. if (string.Equals(type, "Series", StringComparison.OrdinalIgnoreCase))
  351. {
  352. return true;
  353. }
  354. if (string.Equals(type, "Season", StringComparison.OrdinalIgnoreCase)
  355. || string.Equals(type, "Episode", StringComparison.OrdinalIgnoreCase)
  356. || string.Equals(type, "MusicVideo", StringComparison.OrdinalIgnoreCase))
  357. {
  358. return false;
  359. }
  360. return true;
  361. }
  362. else if (string.Equals(name, "TheTVDB", StringComparison.OrdinalIgnoreCase))
  363. {
  364. return true;
  365. }
  366. else if (string.Equals(name, "The Open Movie Database", StringComparison.OrdinalIgnoreCase))
  367. {
  368. return false;
  369. }
  370. else if (string.Equals(name, "TheAudioDB", StringComparison.OrdinalIgnoreCase))
  371. {
  372. return true;
  373. }
  374. else if (string.Equals(name, "MusicBrainz", StringComparison.OrdinalIgnoreCase))
  375. {
  376. return true;
  377. }
  378. return false;
  379. }
  380. var metadataOptions = ServerConfigurationManager.Configuration.MetadataOptions
  381. .Where(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase))
  382. .ToArray();
  383. return metadataOptions.Length == 0
  384. || metadataOptions.Any(i => !i.DisabledMetadataFetchers.Contains(name, StringComparer.OrdinalIgnoreCase));
  385. }
  386. private bool IsImageFetcherEnabledByDefault(string name, string type, bool isNewLibrary)
  387. {
  388. if (isNewLibrary)
  389. {
  390. if (string.Equals(name, "TheMovieDb", StringComparison.OrdinalIgnoreCase))
  391. {
  392. if (string.Equals(type, "Series", StringComparison.OrdinalIgnoreCase))
  393. {
  394. return false;
  395. }
  396. if (string.Equals(type, "Season", StringComparison.OrdinalIgnoreCase))
  397. {
  398. return false;
  399. }
  400. if (string.Equals(type, "Episode", StringComparison.OrdinalIgnoreCase))
  401. {
  402. return false;
  403. }
  404. if (string.Equals(type, "MusicVideo", StringComparison.OrdinalIgnoreCase))
  405. {
  406. return false;
  407. }
  408. return true;
  409. }
  410. else if (string.Equals(name, "TheTVDB", StringComparison.OrdinalIgnoreCase))
  411. {
  412. return true;
  413. }
  414. else if (string.Equals(name, "The Open Movie Database", StringComparison.OrdinalIgnoreCase))
  415. {
  416. return false;
  417. }
  418. else if (string.Equals(name, "TheAudioDB", StringComparison.OrdinalIgnoreCase))
  419. {
  420. return true;
  421. }
  422. else if (string.Equals(name, "Emby Designs", StringComparison.OrdinalIgnoreCase))
  423. {
  424. return true;
  425. }
  426. else if (string.Equals(name, "Screen Grabber", StringComparison.OrdinalIgnoreCase))
  427. {
  428. return true;
  429. }
  430. else if (string.Equals(name, "Image Extractor", StringComparison.OrdinalIgnoreCase))
  431. {
  432. return true;
  433. }
  434. return false;
  435. }
  436. var metadataOptions = ServerConfigurationManager.Configuration.MetadataOptions
  437. .Where(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase))
  438. .ToArray();
  439. if (metadataOptions.Length == 0)
  440. {
  441. return true;
  442. }
  443. return metadataOptions.Any(i => !i.DisabledImageFetchers.Contains(name, StringComparer.OrdinalIgnoreCase));
  444. }
  445. public object Get(GetLibraryOptionsInfo request)
  446. {
  447. var result = new LibraryOptionsResult();
  448. var types = GetRepresentativeItemTypes(request.LibraryContentType);
  449. var isNewLibrary = request.IsNewLibrary;
  450. var typesList = types.ToList();
  451. var plugins = _providerManager.GetAllMetadataPlugins()
  452. .Where(i => types.Contains(i.ItemType, StringComparer.OrdinalIgnoreCase))
  453. .OrderBy(i => typesList.IndexOf(i.ItemType))
  454. .ToList();
  455. result.MetadataSavers = plugins
  456. .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.MetadataSaver))
  457. .Select(i => new LibraryOptionInfo
  458. {
  459. Name = i.Name,
  460. DefaultEnabled = IsSaverEnabledByDefault(i.Name, types, isNewLibrary)
  461. })
  462. .GroupBy(i => i.Name, StringComparer.OrdinalIgnoreCase)
  463. .Select(x => x.First())
  464. .ToArray();
  465. result.MetadataReaders = plugins
  466. .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.LocalMetadataProvider))
  467. .Select(i => new LibraryOptionInfo
  468. {
  469. Name = i.Name,
  470. DefaultEnabled = true
  471. })
  472. .GroupBy(i => i.Name, StringComparer.OrdinalIgnoreCase)
  473. .Select(x => x.First())
  474. .ToArray();
  475. result.SubtitleFetchers = plugins
  476. .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.SubtitleFetcher))
  477. .Select(i => new LibraryOptionInfo
  478. {
  479. Name = i.Name,
  480. DefaultEnabled = true
  481. })
  482. .GroupBy(i => i.Name, StringComparer.OrdinalIgnoreCase)
  483. .Select(x => x.First())
  484. .ToArray();
  485. var typeOptions = new List<LibraryTypeOptions>();
  486. foreach (var type in types)
  487. {
  488. TypeOptions.DefaultImageOptions.TryGetValue(type, out var defaultImageOptions);
  489. typeOptions.Add(new LibraryTypeOptions
  490. {
  491. Type = type,
  492. MetadataFetchers = plugins
  493. .Where(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase))
  494. .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.MetadataFetcher))
  495. .Select(i => new LibraryOptionInfo
  496. {
  497. Name = i.Name,
  498. DefaultEnabled = IsMetadataFetcherEnabledByDefault(i.Name, type, isNewLibrary)
  499. })
  500. .GroupBy(i => i.Name, StringComparer.OrdinalIgnoreCase)
  501. .Select(x => x.First())
  502. .ToArray(),
  503. ImageFetchers = plugins
  504. .Where(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase))
  505. .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.ImageFetcher))
  506. .Select(i => new LibraryOptionInfo
  507. {
  508. Name = i.Name,
  509. DefaultEnabled = IsImageFetcherEnabledByDefault(i.Name, type, isNewLibrary)
  510. })
  511. .GroupBy(i => i.Name, StringComparer.OrdinalIgnoreCase)
  512. .Select(x => x.First())
  513. .ToArray(),
  514. SupportedImageTypes = plugins
  515. .Where(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase))
  516. .SelectMany(i => i.SupportedImageTypes ?? Array.Empty<ImageType>())
  517. .Distinct()
  518. .ToArray(),
  519. DefaultImageOptions = defaultImageOptions ?? Array.Empty<ImageOption>()
  520. });
  521. }
  522. result.TypeOptions = typeOptions.ToArray();
  523. return result;
  524. }
  525. public object Get(GetSimilarItems request)
  526. {
  527. var item = string.IsNullOrEmpty(request.Id) ?
  528. (!request.UserId.Equals(Guid.Empty) ? _libraryManager.GetUserRootFolder() :
  529. _libraryManager.RootFolder) : _libraryManager.GetItemById(request.Id);
  530. var program = item as IHasProgramAttributes;
  531. if (item is Movie || (program != null && program.IsMovie) || item is Trailer)
  532. {
  533. return new MoviesService(
  534. Logger,
  535. ServerConfigurationManager,
  536. ResultFactory,
  537. _userManager,
  538. _libraryManager,
  539. _dtoService,
  540. _authContext)
  541. {
  542. Request = Request,
  543. }.GetSimilarItemsResult(request);
  544. }
  545. if (program != null && program.IsSeries)
  546. {
  547. return GetSimilarItemsResult(request, new[] { typeof(Series).Name });
  548. }
  549. if (item is Episode || (item is IItemByName && !(item is MusicArtist)))
  550. {
  551. return new QueryResult<BaseItemDto>();
  552. }
  553. return GetSimilarItemsResult(request, new[] { item.GetType().Name });
  554. }
  555. private QueryResult<BaseItemDto> GetSimilarItemsResult(BaseGetSimilarItemsFromItem request, string[] includeItemTypes)
  556. {
  557. var user = !request.UserId.Equals(Guid.Empty) ? _userManager.GetUserById(request.UserId) : null;
  558. var item = string.IsNullOrEmpty(request.Id) ?
  559. (!request.UserId.Equals(Guid.Empty) ? _libraryManager.GetUserRootFolder() :
  560. _libraryManager.RootFolder) : _libraryManager.GetItemById(request.Id);
  561. var dtoOptions = GetDtoOptions(_authContext, request);
  562. var query = new InternalItemsQuery(user)
  563. {
  564. Limit = request.Limit,
  565. IncludeItemTypes = includeItemTypes,
  566. SimilarTo = item,
  567. DtoOptions = dtoOptions,
  568. EnableTotalRecordCount = false
  569. };
  570. // ExcludeArtistIds
  571. if (!string.IsNullOrEmpty(request.ExcludeArtistIds))
  572. {
  573. query.ExcludeArtistIds = GetGuids(request.ExcludeArtistIds);
  574. }
  575. List<BaseItem> itemsResult;
  576. if (item is MusicArtist)
  577. {
  578. query.IncludeItemTypes = Array.Empty<string>();
  579. itemsResult = _libraryManager.GetArtists(query).Items.Select(i => i.Item1).ToList();
  580. }
  581. else
  582. {
  583. itemsResult = _libraryManager.GetItemList(query);
  584. }
  585. var returnList = _dtoService.GetBaseItemDtos(itemsResult, dtoOptions, user);
  586. var result = new QueryResult<BaseItemDto>
  587. {
  588. Items = returnList,
  589. TotalRecordCount = itemsResult.Count
  590. };
  591. return result;
  592. }
  593. public object Get(GetMediaFolders request)
  594. {
  595. var items = _libraryManager.GetUserRootFolder().Children.Concat(_libraryManager.RootFolder.VirtualChildren).OrderBy(i => i.SortName).ToList();
  596. if (request.IsHidden.HasValue)
  597. {
  598. var val = request.IsHidden.Value;
  599. items = items.Where(i => i.IsHidden == val).ToList();
  600. }
  601. var dtoOptions = GetDtoOptions(_authContext, request);
  602. var result = new QueryResult<BaseItemDto>
  603. {
  604. TotalRecordCount = items.Count,
  605. Items = items.Select(i => _dtoService.GetBaseItemDto(i, dtoOptions)).ToArray()
  606. };
  607. return result;
  608. }
  609. public void Post(PostUpdatedSeries request)
  610. {
  611. var series = _libraryManager.GetItemList(new InternalItemsQuery
  612. {
  613. IncludeItemTypes = new[] { typeof(Series).Name },
  614. DtoOptions = new DtoOptions(false)
  615. {
  616. EnableImages = false
  617. }
  618. }).Where(i => string.Equals(request.TvdbId, i.GetProviderId(MetadataProviders.Tvdb), StringComparison.OrdinalIgnoreCase)).ToArray();
  619. foreach (var item in series)
  620. {
  621. _libraryMonitor.ReportFileSystemChanged(item.Path);
  622. }
  623. }
  624. public void Post(PostUpdatedMedia request)
  625. {
  626. if (request.Updates != null)
  627. {
  628. foreach (var item in request.Updates)
  629. {
  630. _libraryMonitor.ReportFileSystemChanged(item.Path);
  631. }
  632. }
  633. }
  634. public void Post(PostUpdatedMovies request)
  635. {
  636. var movies = _libraryManager.GetItemList(new InternalItemsQuery
  637. {
  638. IncludeItemTypes = new[] { typeof(Movie).Name },
  639. DtoOptions = new DtoOptions(false)
  640. {
  641. EnableImages = false
  642. }
  643. });
  644. if (!string.IsNullOrWhiteSpace(request.ImdbId))
  645. {
  646. movies = movies.Where(i => string.Equals(request.ImdbId, i.GetProviderId(MetadataProviders.Imdb), StringComparison.OrdinalIgnoreCase)).ToList();
  647. }
  648. else if (!string.IsNullOrWhiteSpace(request.TmdbId))
  649. {
  650. movies = movies.Where(i => string.Equals(request.TmdbId, i.GetProviderId(MetadataProviders.Tmdb), StringComparison.OrdinalIgnoreCase)).ToList();
  651. }
  652. else
  653. {
  654. movies = new List<BaseItem>();
  655. }
  656. foreach (var item in movies)
  657. {
  658. _libraryMonitor.ReportFileSystemChanged(item.Path);
  659. }
  660. }
  661. public Task<object> Get(GetDownload request)
  662. {
  663. var item = _libraryManager.GetItemById(request.Id);
  664. var auth = _authContext.GetAuthorizationInfo(Request);
  665. var user = auth.User;
  666. if (user != null)
  667. {
  668. if (!item.CanDownload(user))
  669. {
  670. throw new ArgumentException("Item does not support downloading");
  671. }
  672. }
  673. else
  674. {
  675. if (!item.CanDownload())
  676. {
  677. throw new ArgumentException("Item does not support downloading");
  678. }
  679. }
  680. var headers = new Dictionary<string, string>();
  681. if (user != null)
  682. {
  683. LogDownload(item, user, auth);
  684. }
  685. var path = item.Path;
  686. // Quotes are valid in linux. They'll possibly cause issues here
  687. var filename = (Path.GetFileName(path) ?? string.Empty).Replace("\"", string.Empty);
  688. if (!string.IsNullOrWhiteSpace(filename))
  689. {
  690. // Kestrel doesn't support non-ASCII characters in headers
  691. if (Regex.IsMatch(filename, @"[^\p{IsBasicLatin}]"))
  692. {
  693. // Manually encoding non-ASCII characters, following https://tools.ietf.org/html/rfc5987#section-3.2.2
  694. headers[HeaderNames.ContentDisposition] = "attachment; filename*=UTF-8''" + WebUtility.UrlEncode(filename);
  695. }
  696. else
  697. {
  698. headers[HeaderNames.ContentDisposition] = "attachment; filename=\"" + filename + "\"";
  699. }
  700. }
  701. return ResultFactory.GetStaticFileResult(Request, new StaticFileResultOptions
  702. {
  703. Path = path,
  704. ResponseHeaders = headers
  705. });
  706. }
  707. private void LogDownload(BaseItem item, User user, AuthorizationInfo auth)
  708. {
  709. try
  710. {
  711. _activityManager.Create(new ActivityLogEntry
  712. {
  713. Name = string.Format(_localization.GetLocalizedString("UserDownloadingItemWithValues"), user.Name, item.Name),
  714. Type = "UserDownloadingContent",
  715. ShortOverview = string.Format(_localization.GetLocalizedString("AppDeviceValues"), auth.Client, auth.Device),
  716. UserId = auth.UserId
  717. });
  718. }
  719. catch
  720. {
  721. // Logged at lower levels
  722. }
  723. }
  724. public Task<object> Get(GetFile request)
  725. {
  726. var item = _libraryManager.GetItemById(request.Id);
  727. return ResultFactory.GetStaticFileResult(Request, item.Path);
  728. }
  729. /// <summary>
  730. /// Gets the specified request.
  731. /// </summary>
  732. /// <param name="request">The request.</param>
  733. /// <returns>System.Object.</returns>
  734. public object Get(GetPhyscialPaths request)
  735. {
  736. var result = _libraryManager.RootFolder.Children
  737. .SelectMany(c => c.PhysicalLocations)
  738. .ToList();
  739. return ToOptimizedResult(result);
  740. }
  741. /// <summary>
  742. /// Gets the specified request.
  743. /// </summary>
  744. /// <param name="request">The request.</param>
  745. /// <returns>System.Object.</returns>
  746. public object Get(GetAncestors request)
  747. {
  748. var result = GetAncestors(request);
  749. return ToOptimizedResult(result);
  750. }
  751. /// <summary>
  752. /// Gets the ancestors.
  753. /// </summary>
  754. /// <param name="request">The request.</param>
  755. /// <returns>Task{BaseItemDto[]}.</returns>
  756. public List<BaseItemDto> GetAncestors(GetAncestors request)
  757. {
  758. var item = _libraryManager.GetItemById(request.Id);
  759. var baseItemDtos = new List<BaseItemDto>();
  760. var user = !request.UserId.Equals(Guid.Empty) ? _userManager.GetUserById(request.UserId) : null;
  761. var dtoOptions = GetDtoOptions(_authContext, request);
  762. BaseItem parent = item.GetParent();
  763. while (parent != null)
  764. {
  765. if (user != null)
  766. {
  767. parent = TranslateParentItem(parent, user);
  768. }
  769. baseItemDtos.Add(_dtoService.GetBaseItemDto(parent, dtoOptions, user));
  770. parent = parent.GetParent();
  771. }
  772. return baseItemDtos;
  773. }
  774. private BaseItem TranslateParentItem(BaseItem item, User user)
  775. {
  776. return item.GetParent() is AggregateFolder
  777. ? _libraryManager.GetUserRootFolder().GetChildren(user, true)
  778. .FirstOrDefault(i => i.PhysicalLocations.Contains(item.Path))
  779. : item;
  780. }
  781. /// <summary>
  782. /// Gets the specified request.
  783. /// </summary>
  784. /// <param name="request">The request.</param>
  785. /// <returns>System.Object.</returns>
  786. public object Get(GetCriticReviews request)
  787. {
  788. return new QueryResult<BaseItemDto>();
  789. }
  790. /// <summary>
  791. /// Gets the specified request.
  792. /// </summary>
  793. /// <param name="request">The request.</param>
  794. /// <returns>System.Object.</returns>
  795. public object Get(GetItemCounts request)
  796. {
  797. var user = request.UserId.Equals(Guid.Empty) ? null : _userManager.GetUserById(request.UserId);
  798. var counts = new ItemCounts
  799. {
  800. AlbumCount = GetCount(typeof(MusicAlbum), user, request),
  801. EpisodeCount = GetCount(typeof(Episode), user, request),
  802. MovieCount = GetCount(typeof(Movie), user, request),
  803. SeriesCount = GetCount(typeof(Series), user, request),
  804. SongCount = GetCount(typeof(Audio), user, request),
  805. MusicVideoCount = GetCount(typeof(MusicVideo), user, request),
  806. BoxSetCount = GetCount(typeof(BoxSet), user, request),
  807. BookCount = GetCount(typeof(Book), user, request)
  808. };
  809. return ToOptimizedResult(counts);
  810. }
  811. private int GetCount(Type type, User user, GetItemCounts request)
  812. {
  813. var query = new InternalItemsQuery(user)
  814. {
  815. IncludeItemTypes = new[] { type.Name },
  816. Limit = 0,
  817. Recursive = true,
  818. IsVirtualItem = false,
  819. IsFavorite = request.IsFavorite,
  820. DtoOptions = new DtoOptions(false)
  821. {
  822. EnableImages = false
  823. }
  824. };
  825. return _libraryManager.GetItemsResult(query).TotalRecordCount;
  826. }
  827. /// <summary>
  828. /// Posts the specified request.
  829. /// </summary>
  830. /// <param name="request">The request.</param>
  831. public async Task Post(RefreshLibrary request)
  832. {
  833. try
  834. {
  835. await _libraryManager.ValidateMediaLibrary(new SimpleProgress<double>(), CancellationToken.None).ConfigureAwait(false);
  836. }
  837. catch (Exception ex)
  838. {
  839. Logger.LogError(ex, "Error refreshing library");
  840. }
  841. }
  842. /// <summary>
  843. /// Deletes the specified request.
  844. /// </summary>
  845. /// <param name="request">The request.</param>
  846. public void Delete(DeleteItems request)
  847. {
  848. var ids = string.IsNullOrWhiteSpace(request.Ids)
  849. ? Array.Empty<string>()
  850. : request.Ids.Split(',');
  851. foreach (var i in ids)
  852. {
  853. var item = _libraryManager.GetItemById(i);
  854. var auth = _authContext.GetAuthorizationInfo(Request);
  855. var user = auth.User;
  856. if (!item.CanDelete(user))
  857. {
  858. if (ids.Length > 1)
  859. {
  860. throw new SecurityException("Unauthorized access");
  861. }
  862. continue;
  863. }
  864. _libraryManager.DeleteItem(item, new DeleteOptions
  865. {
  866. DeleteFileLocation = true
  867. }, true);
  868. }
  869. }
  870. /// <summary>
  871. /// Deletes the specified request.
  872. /// </summary>
  873. /// <param name="request">The request.</param>
  874. public void Delete(DeleteItem request)
  875. {
  876. Delete(new DeleteItems
  877. {
  878. Ids = request.Id
  879. });
  880. }
  881. public object Get(GetThemeMedia request)
  882. {
  883. var themeSongs = GetThemeSongs(new GetThemeSongs
  884. {
  885. InheritFromParent = request.InheritFromParent,
  886. Id = request.Id,
  887. UserId = request.UserId
  888. });
  889. var themeVideos = GetThemeVideos(new GetThemeVideos
  890. {
  891. InheritFromParent = request.InheritFromParent,
  892. Id = request.Id,
  893. UserId = request.UserId
  894. });
  895. return ToOptimizedResult(new AllThemeMediaResult
  896. {
  897. ThemeSongsResult = themeSongs,
  898. ThemeVideosResult = themeVideos,
  899. SoundtrackSongsResult = new ThemeMediaResult()
  900. });
  901. }
  902. /// <summary>
  903. /// Gets the specified request.
  904. /// </summary>
  905. /// <param name="request">The request.</param>
  906. /// <returns>System.Object.</returns>
  907. public object Get(GetThemeSongs request)
  908. {
  909. var result = GetThemeSongs(request);
  910. return ToOptimizedResult(result);
  911. }
  912. private ThemeMediaResult GetThemeSongs(GetThemeSongs 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 = item.GetThemeSongs();
  925. while (!themeItems.Any() && request.InheritFromParent && item.GetParent() != null)
  926. {
  927. item = item.GetParent();
  928. themeItems = item.GetThemeSongs();
  929. }
  930. var dtoOptions = GetDtoOptions(_authContext, request);
  931. var items = themeItems
  932. .Select(i => _dtoService.GetBaseItemDto(i, dtoOptions, user, item))
  933. .ToArray();
  934. return new ThemeMediaResult
  935. {
  936. Items = items,
  937. TotalRecordCount = items.Length,
  938. OwnerId = item.Id
  939. };
  940. }
  941. /// <summary>
  942. /// Gets the specified request.
  943. /// </summary>
  944. /// <param name="request">The request.</param>
  945. /// <returns>System.Object.</returns>
  946. public object Get(GetThemeVideos request)
  947. {
  948. return ToOptimizedResult(GetThemeVideos(request));
  949. }
  950. public ThemeMediaResult GetThemeVideos(GetThemeVideos request)
  951. {
  952. var user = !request.UserId.Equals(Guid.Empty) ? _userManager.GetUserById(request.UserId) : null;
  953. var item = string.IsNullOrEmpty(request.Id)
  954. ? (!request.UserId.Equals(Guid.Empty)
  955. ? _libraryManager.GetUserRootFolder()
  956. : _libraryManager.RootFolder)
  957. : _libraryManager.GetItemById(request.Id);
  958. if (item == null)
  959. {
  960. throw new ResourceNotFoundException("Item not found.");
  961. }
  962. IEnumerable<BaseItem> themeItems = item.GetThemeVideos();
  963. while (!themeItems.Any() && request.InheritFromParent && item.GetParent() != null)
  964. {
  965. item = item.GetParent();
  966. themeItems = item.GetThemeVideos();
  967. }
  968. var dtoOptions = GetDtoOptions(_authContext, request);
  969. var items = themeItems
  970. .Select(i => _dtoService.GetBaseItemDto(i, dtoOptions, user, item))
  971. .ToArray();
  972. return new ThemeMediaResult
  973. {
  974. Items = items,
  975. TotalRecordCount = items.Length,
  976. OwnerId = item.Id
  977. };
  978. }
  979. }
  980. }