ProviderManager.cs 48 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211
  1. using System;
  2. using System.Collections.Concurrent;
  3. using System.Collections.Generic;
  4. using System.Globalization;
  5. using System.IO;
  6. using System.Linq;
  7. using System.Net;
  8. using System.Net.Http;
  9. using System.Net.Mime;
  10. using System.Runtime.ExceptionServices;
  11. using System.Threading;
  12. using System.Threading.Tasks;
  13. using AsyncKeyedLock;
  14. using Jellyfin.Data.Enums;
  15. using Jellyfin.Data.Events;
  16. using Jellyfin.Extensions;
  17. using MediaBrowser.Common.Net;
  18. using MediaBrowser.Controller;
  19. using MediaBrowser.Controller.BaseItemManager;
  20. using MediaBrowser.Controller.Configuration;
  21. using MediaBrowser.Controller.Dto;
  22. using MediaBrowser.Controller.Entities;
  23. using MediaBrowser.Controller.Entities.Audio;
  24. using MediaBrowser.Controller.Entities.Movies;
  25. using MediaBrowser.Controller.Library;
  26. using MediaBrowser.Controller.Lyrics;
  27. using MediaBrowser.Controller.Providers;
  28. using MediaBrowser.Controller.Subtitles;
  29. using MediaBrowser.Model.Configuration;
  30. using MediaBrowser.Model.Entities;
  31. using MediaBrowser.Model.Extensions;
  32. using MediaBrowser.Model.IO;
  33. using MediaBrowser.Model.Net;
  34. using MediaBrowser.Model.Providers;
  35. using Microsoft.Extensions.Caching.Memory;
  36. using Microsoft.Extensions.Logging;
  37. using Book = MediaBrowser.Controller.Entities.Book;
  38. using Episode = MediaBrowser.Controller.Entities.TV.Episode;
  39. using Movie = MediaBrowser.Controller.Entities.Movies.Movie;
  40. using MusicAlbum = MediaBrowser.Controller.Entities.Audio.MusicAlbum;
  41. using Season = MediaBrowser.Controller.Entities.TV.Season;
  42. using Series = MediaBrowser.Controller.Entities.TV.Series;
  43. namespace MediaBrowser.Providers.Manager
  44. {
  45. /// <summary>
  46. /// Class ProviderManager.
  47. /// </summary>
  48. public class ProviderManager : IProviderManager, IDisposable
  49. {
  50. private readonly object _refreshQueueLock = new();
  51. private readonly ILogger<ProviderManager> _logger;
  52. private readonly IHttpClientFactory _httpClientFactory;
  53. private readonly ILibraryMonitor _libraryMonitor;
  54. private readonly IFileSystem _fileSystem;
  55. private readonly IServerApplicationPaths _appPaths;
  56. private readonly ILibraryManager _libraryManager;
  57. private readonly ISubtitleManager _subtitleManager;
  58. private readonly ILyricManager _lyricManager;
  59. private readonly IServerConfigurationManager _configurationManager;
  60. private readonly IBaseItemManager _baseItemManager;
  61. private readonly ConcurrentDictionary<Guid, double> _activeRefreshes = new();
  62. private readonly CancellationTokenSource _disposeCancellationTokenSource = new();
  63. private readonly PriorityQueue<(Guid ItemId, MetadataRefreshOptions RefreshOptions), RefreshPriority> _refreshQueue = new();
  64. private readonly IMemoryCache _memoryCache;
  65. private readonly IMediaSegmentManager _mediaSegmentManager;
  66. private readonly AsyncKeyedLocker<string> _imageSaveLock = new(o =>
  67. {
  68. o.PoolSize = 20;
  69. o.PoolInitialFill = 1;
  70. });
  71. private IImageProvider[] _imageProviders = [];
  72. private IMetadataService[] _metadataServices = [];
  73. private IMetadataProvider[] _metadataProviders = [];
  74. private IMetadataSaver[] _savers = [];
  75. private IExternalId[] _externalIds = [];
  76. private IExternalUrlProvider[] _externalUrlProviders = [];
  77. private bool _isProcessingRefreshQueue;
  78. private bool _disposed;
  79. /// <summary>
  80. /// Initializes a new instance of the <see cref="ProviderManager"/> class.
  81. /// </summary>
  82. /// <param name="httpClientFactory">The Http client factory.</param>
  83. /// <param name="subtitleManager">The subtitle manager.</param>
  84. /// <param name="configurationManager">The configuration manager.</param>
  85. /// <param name="libraryMonitor">The library monitor.</param>
  86. /// <param name="logger">The logger.</param>
  87. /// <param name="fileSystem">The filesystem.</param>
  88. /// <param name="appPaths">The server application paths.</param>
  89. /// <param name="libraryManager">The library manager.</param>
  90. /// <param name="baseItemManager">The BaseItem manager.</param>
  91. /// <param name="lyricManager">The lyric manager.</param>
  92. /// <param name="memoryCache">The memory cache.</param>
  93. /// <param name="mediaSegmentManager">The media segment manager.</param>
  94. public ProviderManager(
  95. IHttpClientFactory httpClientFactory,
  96. ISubtitleManager subtitleManager,
  97. IServerConfigurationManager configurationManager,
  98. ILibraryMonitor libraryMonitor,
  99. ILogger<ProviderManager> logger,
  100. IFileSystem fileSystem,
  101. IServerApplicationPaths appPaths,
  102. ILibraryManager libraryManager,
  103. IBaseItemManager baseItemManager,
  104. ILyricManager lyricManager,
  105. IMemoryCache memoryCache,
  106. IMediaSegmentManager mediaSegmentManager)
  107. {
  108. _logger = logger;
  109. _httpClientFactory = httpClientFactory;
  110. _configurationManager = configurationManager;
  111. _libraryMonitor = libraryMonitor;
  112. _fileSystem = fileSystem;
  113. _appPaths = appPaths;
  114. _libraryManager = libraryManager;
  115. _subtitleManager = subtitleManager;
  116. _baseItemManager = baseItemManager;
  117. _lyricManager = lyricManager;
  118. _memoryCache = memoryCache;
  119. _mediaSegmentManager = mediaSegmentManager;
  120. }
  121. /// <inheritdoc/>
  122. public event EventHandler<GenericEventArgs<BaseItem>>? RefreshStarted;
  123. /// <inheritdoc/>
  124. public event EventHandler<GenericEventArgs<BaseItem>>? RefreshCompleted;
  125. /// <inheritdoc/>
  126. public event EventHandler<GenericEventArgs<Tuple<BaseItem, double>>>? RefreshProgress;
  127. /// <inheritdoc/>
  128. public void AddParts(
  129. IEnumerable<IImageProvider> imageProviders,
  130. IEnumerable<IMetadataService> metadataServices,
  131. IEnumerable<IMetadataProvider> metadataProviders,
  132. IEnumerable<IMetadataSaver> metadataSavers,
  133. IEnumerable<IExternalId> externalIds,
  134. IEnumerable<IExternalUrlProvider> externalUrlProviders)
  135. {
  136. _imageProviders = imageProviders.ToArray();
  137. _metadataServices = metadataServices.OrderBy(i => i.Order).ToArray();
  138. _metadataProviders = metadataProviders.ToArray();
  139. _externalIds = externalIds.OrderBy(i => i.ProviderName).ToArray();
  140. _externalUrlProviders = externalUrlProviders.OrderBy(i => i.Name).ToArray();
  141. _savers = metadataSavers.ToArray();
  142. }
  143. /// <inheritdoc/>
  144. public Task<ItemUpdateType> RefreshSingleItem(BaseItem item, MetadataRefreshOptions options, CancellationToken cancellationToken)
  145. {
  146. var type = item.GetType();
  147. var service = _metadataServices.FirstOrDefault(current => current.CanRefreshPrimary(type))
  148. ?? _metadataServices.FirstOrDefault(current => current.CanRefresh(item));
  149. if (service is null)
  150. {
  151. _logger.LogError("Unable to find a metadata service for item of type {TypeName}", type.Name);
  152. return Task.FromResult(ItemUpdateType.None);
  153. }
  154. return service.RefreshMetadata(item, options, cancellationToken);
  155. }
  156. /// <inheritdoc/>
  157. public async Task SaveImage(BaseItem item, string url, ImageType type, int? imageIndex, CancellationToken cancellationToken)
  158. {
  159. using (await _imageSaveLock.LockAsync(url, cancellationToken).ConfigureAwait(false))
  160. {
  161. if (_memoryCache.TryGetValue(url, out (string ContentType, byte[] ImageContents)? cachedValue)
  162. && cachedValue is not null)
  163. {
  164. var imageContents = cachedValue.Value.ImageContents;
  165. var cacheStream = new MemoryStream(imageContents, 0, imageContents.Length, false);
  166. await using (cacheStream.ConfigureAwait(false))
  167. {
  168. await SaveImage(
  169. item,
  170. cacheStream,
  171. cachedValue.Value.ContentType,
  172. type,
  173. imageIndex,
  174. cancellationToken).ConfigureAwait(false);
  175. return;
  176. }
  177. }
  178. var httpClient = _httpClientFactory.CreateClient(NamedClient.Default);
  179. using var response = await httpClient.GetAsync(url, cancellationToken).ConfigureAwait(false);
  180. response.EnsureSuccessStatusCode();
  181. var contentType = response.Content.Headers.ContentType?.MediaType;
  182. // Workaround for tvheadend channel icons
  183. // TODO: Isolate this hack into the tvh plugin
  184. if (string.IsNullOrEmpty(contentType))
  185. {
  186. // Special case for imagecache
  187. if (url.Contains("/imagecache/", StringComparison.OrdinalIgnoreCase))
  188. {
  189. contentType = MediaTypeNames.Image.Png;
  190. }
  191. else
  192. {
  193. // Deduce content type from file extension
  194. contentType = MimeTypes.GetMimeType(new Uri(url).GetLeftPart(UriPartial.Path));
  195. }
  196. // Throw if we still can't determine the content type
  197. if (string.IsNullOrEmpty(contentType))
  198. {
  199. throw new HttpRequestException("Invalid image received: contentType not set.", null, response.StatusCode);
  200. }
  201. }
  202. // TVDb will sometimes serve a rubbish 404 html page with a 200 OK code, because reasons...
  203. if (contentType.Equals(MediaTypeNames.Text.Html, StringComparison.OrdinalIgnoreCase))
  204. {
  205. throw new HttpRequestException("Invalid image received.", null, HttpStatusCode.NotFound);
  206. }
  207. // some iptv/epg providers don't correctly report media type, extract from url if no extension found
  208. if (string.IsNullOrWhiteSpace(MimeTypes.ToExtension(contentType)))
  209. {
  210. // Strip query parameters from url to get actual path.
  211. contentType = MimeTypes.GetMimeType(new Uri(url).GetLeftPart(UriPartial.Path));
  212. }
  213. if (!contentType.StartsWith("image/", StringComparison.OrdinalIgnoreCase))
  214. {
  215. throw new HttpRequestException($"Request returned {contentType} instead of an image type", null, HttpStatusCode.NotFound);
  216. }
  217. var responseBytes = await response.Content.ReadAsByteArrayAsync(cancellationToken).ConfigureAwait(false);
  218. var stream = new MemoryStream(responseBytes, 0, responseBytes.Length, false);
  219. await using (stream.ConfigureAwait(false))
  220. {
  221. _memoryCache.Set(url, (contentType, responseBytes), TimeSpan.FromSeconds(10));
  222. await SaveImage(
  223. item,
  224. stream,
  225. contentType,
  226. type,
  227. imageIndex,
  228. cancellationToken).ConfigureAwait(false);
  229. }
  230. }
  231. }
  232. /// <inheritdoc/>
  233. public Task SaveImage(BaseItem item, Stream source, string mimeType, ImageType type, int? imageIndex, CancellationToken cancellationToken)
  234. {
  235. return new ImageSaver(_configurationManager, _libraryMonitor, _fileSystem, _logger).SaveImage(item, source, mimeType, type, imageIndex, cancellationToken);
  236. }
  237. /// <inheritdoc/>
  238. public async Task SaveImage(BaseItem item, string source, string mimeType, ImageType type, int? imageIndex, bool? saveLocallyWithMedia, CancellationToken cancellationToken)
  239. {
  240. if (string.IsNullOrWhiteSpace(source))
  241. {
  242. throw new ArgumentNullException(nameof(source));
  243. }
  244. try
  245. {
  246. var fileStream = AsyncFile.OpenRead(source);
  247. await new ImageSaver(_configurationManager, _libraryMonitor, _fileSystem, _logger)
  248. .SaveImage(item, fileStream, mimeType, type, imageIndex, saveLocallyWithMedia, cancellationToken)
  249. .ConfigureAwait(false);
  250. }
  251. finally
  252. {
  253. try
  254. {
  255. File.Delete(source);
  256. }
  257. catch (Exception ex)
  258. {
  259. _logger.LogError(ex, "Source file {Source} not found or in use, skip removing", source);
  260. }
  261. }
  262. }
  263. /// <inheritdoc/>
  264. public Task SaveImage(Stream source, string mimeType, string path)
  265. {
  266. return new ImageSaver(_configurationManager, _libraryMonitor, _fileSystem, _logger)
  267. .SaveImage(source, path);
  268. }
  269. /// <inheritdoc/>
  270. public async Task<IEnumerable<RemoteImageInfo>> GetAvailableRemoteImages(BaseItem item, RemoteImageQuery query, CancellationToken cancellationToken)
  271. {
  272. var providers = GetRemoteImageProviders(item, query.IncludeDisabledProviders);
  273. if (!string.IsNullOrEmpty(query.ProviderName))
  274. {
  275. var providerName = query.ProviderName;
  276. providers = providers.Where(i => string.Equals(i.Name, providerName, StringComparison.OrdinalIgnoreCase));
  277. }
  278. if (query.ImageType is not null)
  279. {
  280. providers = providers.Where(i => i.GetSupportedImages(item).Contains(query.ImageType.Value));
  281. }
  282. var preferredLanguage = item.GetPreferredMetadataLanguage();
  283. var tasks = providers.Select(i => GetImages(item, i, preferredLanguage, query.IncludeAllLanguages, cancellationToken, query.ImageType));
  284. var results = await Task.WhenAll(tasks).ConfigureAwait(false);
  285. return results.SelectMany(i => i);
  286. }
  287. /// <summary>
  288. /// Gets the images.
  289. /// </summary>
  290. /// <param name="item">The item.</param>
  291. /// <param name="provider">The provider.</param>
  292. /// <param name="preferredLanguage">The preferred language.</param>
  293. /// <param name="includeAllLanguages">Whether to include all languages in results.</param>
  294. /// <param name="cancellationToken">The cancellation token.</param>
  295. /// <param name="type">The type.</param>
  296. /// <returns>Task{IEnumerable{RemoteImageInfo}}.</returns>
  297. private async Task<IEnumerable<RemoteImageInfo>> GetImages(
  298. BaseItem item,
  299. IRemoteImageProvider provider,
  300. string preferredLanguage,
  301. bool includeAllLanguages,
  302. CancellationToken cancellationToken,
  303. ImageType? type = null)
  304. {
  305. bool hasPreferredLanguage = !string.IsNullOrWhiteSpace(preferredLanguage);
  306. try
  307. {
  308. var result = await provider.GetImages(item, cancellationToken).ConfigureAwait(false);
  309. if (type.HasValue)
  310. {
  311. result = result.Where(i => i.Type == type.Value);
  312. }
  313. if (!includeAllLanguages && hasPreferredLanguage)
  314. {
  315. // Filter out languages that do not match the preferred languages.
  316. //
  317. // TODO: should exception case of "en" (English) eventually be removed?
  318. result = result.Where(i => string.IsNullOrWhiteSpace(i.Language) ||
  319. string.Equals(preferredLanguage, i.Language, StringComparison.OrdinalIgnoreCase) ||
  320. string.Equals(i.Language, "en", StringComparison.OrdinalIgnoreCase));
  321. }
  322. return result.OrderByLanguageDescending(preferredLanguage);
  323. }
  324. catch (OperationCanceledException)
  325. {
  326. return Enumerable.Empty<RemoteImageInfo>();
  327. }
  328. catch (Exception ex)
  329. {
  330. _logger.LogError(ex, "{ProviderName} failed in GetImageInfos for type {ItemType} at {ItemPath}", provider.GetType().Name, item.GetType().Name, item.Path);
  331. return Enumerable.Empty<RemoteImageInfo>();
  332. }
  333. }
  334. /// <inheritdoc/>
  335. public IEnumerable<ImageProviderInfo> GetRemoteImageProviderInfo(BaseItem item)
  336. {
  337. return GetRemoteImageProviders(item, true).Select(i => new ImageProviderInfo(i.Name, i.GetSupportedImages(item).ToArray()));
  338. }
  339. private IEnumerable<IRemoteImageProvider> GetRemoteImageProviders(BaseItem item, bool includeDisabled)
  340. {
  341. var options = GetMetadataOptions(item);
  342. var libraryOptions = _libraryManager.GetLibraryOptions(item);
  343. return GetImageProvidersInternal(
  344. item,
  345. libraryOptions,
  346. options,
  347. new ImageRefreshOptions(new DirectoryService(_fileSystem)),
  348. includeDisabled).OfType<IRemoteImageProvider>();
  349. }
  350. /// <inheritdoc/>
  351. public IEnumerable<IImageProvider> GetImageProviders(BaseItem item, ImageRefreshOptions refreshOptions)
  352. {
  353. return GetImageProvidersInternal(item, _libraryManager.GetLibraryOptions(item), GetMetadataOptions(item), refreshOptions, false);
  354. }
  355. private IEnumerable<IImageProvider> GetImageProvidersInternal(BaseItem item, LibraryOptions libraryOptions, MetadataOptions options, ImageRefreshOptions refreshOptions, bool includeDisabled)
  356. {
  357. var typeOptions = libraryOptions.GetTypeOptions(item.GetType().Name);
  358. var fetcherOrder = typeOptions?.ImageFetcherOrder ?? options.ImageFetcherOrder;
  359. return _imageProviders.Where(i => CanRefreshImages(i, item, typeOptions, refreshOptions, includeDisabled))
  360. .OrderBy(i => GetConfiguredOrder(fetcherOrder, i.Name))
  361. .ThenBy(GetDefaultOrder);
  362. }
  363. private bool CanRefreshImages(
  364. IImageProvider provider,
  365. BaseItem item,
  366. TypeOptions? libraryTypeOptions,
  367. ImageRefreshOptions refreshOptions,
  368. bool includeDisabled)
  369. {
  370. try
  371. {
  372. if (!provider.Supports(item))
  373. {
  374. return false;
  375. }
  376. }
  377. catch (Exception ex)
  378. {
  379. _logger.LogError(ex, "{ProviderName} failed in Supports for type {ItemType} at {ItemPath}", provider.GetType().Name, item.GetType().Name, item.Path);
  380. return false;
  381. }
  382. if (includeDisabled || provider is ILocalImageProvider)
  383. {
  384. return true;
  385. }
  386. if (item.IsLocked && refreshOptions.ImageRefreshMode != MetadataRefreshMode.FullRefresh)
  387. {
  388. return false;
  389. }
  390. return _baseItemManager.IsImageFetcherEnabled(item, libraryTypeOptions, provider.Name);
  391. }
  392. /// <inheritdoc />
  393. public IEnumerable<IMetadataProvider<T>> GetMetadataProviders<T>(BaseItem item, LibraryOptions libraryOptions)
  394. where T : BaseItem
  395. {
  396. var globalMetadataOptions = GetMetadataOptions(item);
  397. return GetMetadataProvidersInternal<T>(item, libraryOptions, globalMetadataOptions, false, false);
  398. }
  399. /// <inheritdoc />
  400. public IEnumerable<IMetadataSaver> GetMetadataSavers(BaseItem item, LibraryOptions libraryOptions)
  401. {
  402. return _savers.Where(i => IsSaverEnabledForItem(i, item, libraryOptions, ItemUpdateType.MetadataEdit, false));
  403. }
  404. private IEnumerable<IMetadataProvider<T>> GetMetadataProvidersInternal<T>(BaseItem item, LibraryOptions libraryOptions, MetadataOptions globalMetadataOptions, bool includeDisabled, bool forceEnableInternetMetadata)
  405. where T : BaseItem
  406. {
  407. var localMetadataReaderOrder = libraryOptions.LocalMetadataReaderOrder ?? globalMetadataOptions.LocalMetadataReaderOrder;
  408. var typeOptions = libraryOptions.GetTypeOptions(item.GetType().Name);
  409. var metadataFetcherOrder = typeOptions?.MetadataFetcherOrder ?? globalMetadataOptions.MetadataFetcherOrder;
  410. return _metadataProviders.OfType<IMetadataProvider<T>>()
  411. .Where(i => CanRefreshMetadata(i, item, typeOptions, includeDisabled, forceEnableInternetMetadata))
  412. .OrderBy(i =>
  413. // local and remote providers will be interleaved in the final order
  414. // only relative order within a type matters: consumers of the list filter to one or the other
  415. i switch
  416. {
  417. ILocalMetadataProvider => GetConfiguredOrder(localMetadataReaderOrder, i.Name),
  418. IRemoteMetadataProvider => GetConfiguredOrder(metadataFetcherOrder, i.Name),
  419. // Default to end
  420. _ => int.MaxValue
  421. })
  422. .ThenBy(GetDefaultOrder);
  423. }
  424. private bool CanRefreshMetadata(
  425. IMetadataProvider provider,
  426. BaseItem item,
  427. TypeOptions? libraryTypeOptions,
  428. bool includeDisabled,
  429. bool forceEnableInternetMetadata)
  430. {
  431. if (!item.SupportsLocalMetadata && provider is ILocalMetadataProvider)
  432. {
  433. return false;
  434. }
  435. if (includeDisabled)
  436. {
  437. return true;
  438. }
  439. // If locked only allow local providers
  440. if (item.IsLocked && provider is not ILocalMetadataProvider && provider is not IForcedProvider)
  441. {
  442. return false;
  443. }
  444. if (forceEnableInternetMetadata || provider is not IRemoteMetadataProvider)
  445. {
  446. return true;
  447. }
  448. return _baseItemManager.IsMetadataFetcherEnabled(item, libraryTypeOptions, provider.Name);
  449. }
  450. private static int GetConfiguredOrder(string[] order, string providerName)
  451. {
  452. var index = Array.IndexOf(order, providerName);
  453. if (index != -1)
  454. {
  455. return index;
  456. }
  457. // default to end
  458. return int.MaxValue;
  459. }
  460. private static int GetDefaultOrder(object provider)
  461. {
  462. if (provider is IHasOrder hasOrder)
  463. {
  464. return hasOrder.Order;
  465. }
  466. // after items that want to be first (~0) but before items that want to be last (~100)
  467. return 50;
  468. }
  469. /// <inheritdoc/>
  470. public MetadataPluginSummary[] GetAllMetadataPlugins()
  471. {
  472. return new[]
  473. {
  474. GetPluginSummary<Movie>(),
  475. GetPluginSummary<BoxSet>(),
  476. GetPluginSummary<Book>(),
  477. GetPluginSummary<Series>(),
  478. GetPluginSummary<Season>(),
  479. GetPluginSummary<Episode>(),
  480. GetPluginSummary<MusicAlbum>(),
  481. GetPluginSummary<MusicArtist>(),
  482. GetPluginSummary<Audio>(),
  483. GetPluginSummary<AudioBook>(),
  484. GetPluginSummary<Studio>(),
  485. GetPluginSummary<MusicVideo>(),
  486. GetPluginSummary<Video>()
  487. };
  488. }
  489. private MetadataPluginSummary GetPluginSummary<T>()
  490. where T : BaseItem, new()
  491. {
  492. // Give it a dummy path just so that it looks like a file system item
  493. var dummy = new T
  494. {
  495. Path = Path.Combine(_appPaths.InternalMetadataPath, "dummy"),
  496. ParentId = Guid.NewGuid()
  497. };
  498. var options = GetMetadataOptions(dummy);
  499. var summary = new MetadataPluginSummary
  500. {
  501. ItemType = typeof(T).Name
  502. };
  503. var libraryOptions = new LibraryOptions();
  504. var imageProviders = GetImageProvidersInternal(
  505. dummy,
  506. libraryOptions,
  507. options,
  508. new ImageRefreshOptions(new DirectoryService(_fileSystem)),
  509. true).ToList();
  510. var pluginList = summary.Plugins.ToList();
  511. AddMetadataPlugins(pluginList, dummy, libraryOptions, options);
  512. AddImagePlugins(pluginList, imageProviders);
  513. // Subtitle fetchers
  514. var subtitleProviders = _subtitleManager.GetSupportedProviders(dummy);
  515. pluginList.AddRange(subtitleProviders.Select(i => new MetadataPlugin
  516. {
  517. Name = i.Name,
  518. Type = MetadataPluginType.SubtitleFetcher
  519. }));
  520. // Lyric fetchers
  521. var lyricProviders = _lyricManager.GetSupportedProviders(dummy);
  522. pluginList.AddRange(lyricProviders.Select(i => new MetadataPlugin
  523. {
  524. Name = i.Name,
  525. Type = MetadataPluginType.LyricFetcher
  526. }));
  527. // Media segment providers
  528. var mediaSegmentProviders = _mediaSegmentManager.GetSupportedProviders(dummy);
  529. pluginList.AddRange(mediaSegmentProviders.Select(i => new MetadataPlugin
  530. {
  531. Name = i.Name,
  532. Type = MetadataPluginType.MediaSegmentProvider
  533. }));
  534. summary.Plugins = pluginList.ToArray();
  535. var supportedImageTypes = imageProviders.OfType<IRemoteImageProvider>()
  536. .SelectMany(i => i.GetSupportedImages(dummy))
  537. .ToList();
  538. supportedImageTypes.AddRange(imageProviders.OfType<IDynamicImageProvider>()
  539. .SelectMany(i => i.GetSupportedImages(dummy)));
  540. summary.SupportedImageTypes = supportedImageTypes.Distinct().ToArray();
  541. return summary;
  542. }
  543. private void AddMetadataPlugins<T>(List<MetadataPlugin> list, T item, LibraryOptions libraryOptions, MetadataOptions options)
  544. where T : BaseItem
  545. {
  546. var providers = GetMetadataProvidersInternal<T>(item, libraryOptions, options, true, true).ToList();
  547. // Locals
  548. list.AddRange(providers.Where(i => i is ILocalMetadataProvider).Select(i => new MetadataPlugin
  549. {
  550. Name = i.Name,
  551. Type = MetadataPluginType.LocalMetadataProvider
  552. }));
  553. // Fetchers
  554. list.AddRange(providers.Where(i => i is IRemoteMetadataProvider).Select(i => new MetadataPlugin
  555. {
  556. Name = i.Name,
  557. Type = MetadataPluginType.MetadataFetcher
  558. }));
  559. // Savers
  560. list.AddRange(_savers.Where(i => IsSaverEnabledForItem(i, item, libraryOptions, ItemUpdateType.MetadataEdit, true)).OrderBy(i => i.Name).Select(i => new MetadataPlugin
  561. {
  562. Name = i.Name,
  563. Type = MetadataPluginType.MetadataSaver
  564. }));
  565. }
  566. private void AddImagePlugins(List<MetadataPlugin> list, List<IImageProvider> imageProviders)
  567. {
  568. // Locals
  569. list.AddRange(imageProviders.Where(i => i is ILocalImageProvider).Select(i => new MetadataPlugin
  570. {
  571. Name = i.Name,
  572. Type = MetadataPluginType.LocalImageProvider
  573. }));
  574. // Fetchers
  575. list.AddRange(imageProviders.Where(i => i is IDynamicImageProvider || (i is IRemoteImageProvider)).Select(i => new MetadataPlugin
  576. {
  577. Name = i.Name,
  578. Type = MetadataPluginType.ImageFetcher
  579. }));
  580. }
  581. /// <inheritdoc/>
  582. public MetadataOptions GetMetadataOptions(BaseItem item)
  583. => _configurationManager.GetMetadataOptionsForType(item.GetType().Name) ?? new MetadataOptions();
  584. /// <inheritdoc/>
  585. public Task SaveMetadataAsync(BaseItem item, ItemUpdateType updateType)
  586. => SaveMetadataAsync(item, updateType, _savers);
  587. /// <inheritdoc/>
  588. public Task SaveMetadataAsync(BaseItem item, ItemUpdateType updateType, IEnumerable<string> savers)
  589. => SaveMetadataAsync(item, updateType, _savers.Where(i => savers.Contains(i.Name, StringComparison.OrdinalIgnoreCase)));
  590. /// <summary>
  591. /// Saves the metadata.
  592. /// </summary>
  593. /// <param name="item">The item.</param>
  594. /// <param name="updateType">Type of the update.</param>
  595. /// <param name="savers">The savers.</param>
  596. private async Task SaveMetadataAsync(BaseItem item, ItemUpdateType updateType, IEnumerable<IMetadataSaver> savers)
  597. {
  598. var libraryOptions = _libraryManager.GetLibraryOptions(item);
  599. foreach (var saver in savers.Where(i => IsSaverEnabledForItem(i, item, libraryOptions, updateType, false)))
  600. {
  601. _logger.LogDebug("Saving {Item} to {Saver}", item.Path ?? item.Name, saver.Name);
  602. if (saver is IMetadataFileSaver fileSaver)
  603. {
  604. string path;
  605. try
  606. {
  607. path = fileSaver.GetSavePath(item);
  608. }
  609. catch (Exception ex)
  610. {
  611. _logger.LogError(ex, "Error in {Saver} GetSavePath", saver.Name);
  612. continue;
  613. }
  614. try
  615. {
  616. _libraryMonitor.ReportFileSystemChangeBeginning(path);
  617. await saver.SaveAsync(item, CancellationToken.None).ConfigureAwait(false);
  618. }
  619. catch (Exception ex)
  620. {
  621. _logger.LogError(ex, "Error in metadata saver");
  622. }
  623. finally
  624. {
  625. _libraryMonitor.ReportFileSystemChangeComplete(path, false);
  626. }
  627. }
  628. else
  629. {
  630. try
  631. {
  632. await saver.SaveAsync(item, CancellationToken.None).ConfigureAwait(false);
  633. }
  634. catch (Exception ex)
  635. {
  636. _logger.LogError(ex, "Error in metadata saver");
  637. }
  638. }
  639. }
  640. }
  641. /// <summary>
  642. /// Determines whether [is saver enabled for item] [the specified saver].
  643. /// </summary>
  644. private bool IsSaverEnabledForItem(IMetadataSaver saver, BaseItem item, LibraryOptions libraryOptions, ItemUpdateType updateType, bool includeDisabled)
  645. {
  646. var options = GetMetadataOptions(item);
  647. try
  648. {
  649. if (!saver.IsEnabledFor(item, updateType))
  650. {
  651. return false;
  652. }
  653. if (!includeDisabled)
  654. {
  655. if (libraryOptions.MetadataSavers is null)
  656. {
  657. if (options.DisabledMetadataSavers.Contains(saver.Name, StringComparison.OrdinalIgnoreCase))
  658. {
  659. return false;
  660. }
  661. if (!item.IsSaveLocalMetadataEnabled())
  662. {
  663. if (updateType >= ItemUpdateType.MetadataEdit)
  664. {
  665. // Manual edit occurred
  666. // Even if save local is off, save locally anyway if the metadata file already exists
  667. if (saver is not IMetadataFileSaver fileSaver || !File.Exists(fileSaver.GetSavePath(item)))
  668. {
  669. return false;
  670. }
  671. }
  672. else
  673. {
  674. // Manual edit did not occur
  675. // Since local metadata saving is disabled, consider it disabled
  676. return false;
  677. }
  678. }
  679. }
  680. else
  681. {
  682. if (!libraryOptions.MetadataSavers.Contains(saver.Name, StringComparison.OrdinalIgnoreCase))
  683. {
  684. return false;
  685. }
  686. }
  687. }
  688. return true;
  689. }
  690. catch (Exception ex)
  691. {
  692. _logger.LogError(ex, "Error in {Saver}.IsEnabledFor", saver.Name);
  693. return false;
  694. }
  695. }
  696. /// <inheritdoc/>
  697. public Task<IEnumerable<RemoteSearchResult>> GetRemoteSearchResults<TItemType, TLookupType>(RemoteSearchQuery<TLookupType> searchInfo, CancellationToken cancellationToken)
  698. where TItemType : BaseItem, new()
  699. where TLookupType : ItemLookupInfo
  700. {
  701. BaseItem? referenceItem = null;
  702. if (!searchInfo.ItemId.IsEmpty())
  703. {
  704. referenceItem = _libraryManager.GetItemById(searchInfo.ItemId);
  705. }
  706. return GetRemoteSearchResults<TItemType, TLookupType>(searchInfo, referenceItem, cancellationToken);
  707. }
  708. private async Task<IEnumerable<RemoteSearchResult>> GetRemoteSearchResults<TItemType, TLookupType>(RemoteSearchQuery<TLookupType> searchInfo, BaseItem? referenceItem, CancellationToken cancellationToken)
  709. where TItemType : BaseItem, new()
  710. where TLookupType : ItemLookupInfo
  711. {
  712. LibraryOptions libraryOptions;
  713. if (referenceItem is null)
  714. {
  715. // Give it a dummy path just so that it looks like a file system item
  716. var dummy = new TItemType
  717. {
  718. Path = Path.Combine(_appPaths.InternalMetadataPath, "dummy"),
  719. ParentId = Guid.NewGuid()
  720. };
  721. dummy.SetParent(new Folder());
  722. referenceItem = dummy;
  723. libraryOptions = new LibraryOptions();
  724. }
  725. else
  726. {
  727. libraryOptions = _libraryManager.GetLibraryOptions(referenceItem);
  728. }
  729. var options = GetMetadataOptions(referenceItem);
  730. var providers = GetMetadataProvidersInternal<TItemType>(referenceItem, libraryOptions, options, searchInfo.IncludeDisabledProviders, false)
  731. .OfType<IRemoteSearchProvider<TLookupType>>();
  732. if (!string.IsNullOrEmpty(searchInfo.SearchProviderName))
  733. {
  734. providers = providers.Where(i => string.Equals(i.Name, searchInfo.SearchProviderName, StringComparison.OrdinalIgnoreCase));
  735. }
  736. if (string.IsNullOrWhiteSpace(searchInfo.SearchInfo.MetadataLanguage))
  737. {
  738. searchInfo.SearchInfo.MetadataLanguage = _configurationManager.Configuration.PreferredMetadataLanguage;
  739. }
  740. if (string.IsNullOrWhiteSpace(searchInfo.SearchInfo.MetadataCountryCode))
  741. {
  742. searchInfo.SearchInfo.MetadataCountryCode = _configurationManager.Configuration.MetadataCountryCode;
  743. }
  744. var resultList = new List<RemoteSearchResult>();
  745. foreach (var provider in providers)
  746. {
  747. try
  748. {
  749. var results = await provider.GetSearchResults(searchInfo.SearchInfo, cancellationToken).ConfigureAwait(false);
  750. foreach (var result in results)
  751. {
  752. result.SearchProviderName = provider.Name;
  753. var existingMatch = resultList.FirstOrDefault(i => i.ProviderIds.Any(p => string.Equals(result.GetProviderId(p.Key), p.Value, StringComparison.OrdinalIgnoreCase)));
  754. if (existingMatch is null)
  755. {
  756. resultList.Add(result);
  757. }
  758. else
  759. {
  760. foreach (var providerId in result.ProviderIds)
  761. {
  762. existingMatch.ProviderIds.TryAdd(providerId.Key, providerId.Value);
  763. }
  764. if (string.IsNullOrWhiteSpace(existingMatch.ImageUrl))
  765. {
  766. existingMatch.ImageUrl = result.ImageUrl;
  767. }
  768. }
  769. }
  770. }
  771. #pragma warning disable CA1031 // do not catch general exception types
  772. catch (Exception ex)
  773. #pragma warning restore CA1031 // do not catch general exception types
  774. {
  775. _logger.LogError(ex, "Provider {ProviderName} failed to retrieve search results", provider.Name);
  776. }
  777. }
  778. return resultList;
  779. }
  780. private IEnumerable<IExternalId> GetExternalIds(IHasProviderIds item)
  781. {
  782. return _externalIds.Where(i =>
  783. {
  784. try
  785. {
  786. return i.Supports(item);
  787. }
  788. catch (Exception ex)
  789. {
  790. _logger.LogError(ex, "Error in {Type}.Supports", i.GetType().Name);
  791. return false;
  792. }
  793. });
  794. }
  795. /// <inheritdoc/>
  796. public IEnumerable<ExternalUrl> GetExternalUrls(BaseItem item)
  797. {
  798. #pragma warning disable CS0618 // Type or member is obsolete - Remove 10.11
  799. var legacyExternalIdUrls = GetExternalIds(item)
  800. .Select(i =>
  801. {
  802. var urlFormatString = i.UrlFormatString;
  803. if (string.IsNullOrEmpty(urlFormatString)
  804. || !item.TryGetProviderId(i.Key, out var providerId))
  805. {
  806. return null;
  807. }
  808. return new ExternalUrl
  809. {
  810. Name = i.ProviderName,
  811. Url = string.Format(
  812. CultureInfo.InvariantCulture,
  813. urlFormatString,
  814. providerId)
  815. };
  816. })
  817. .OfType<ExternalUrl>();
  818. #pragma warning restore CS0618 // Type or member is obsolete
  819. var externalUrls = _externalUrlProviders
  820. .SelectMany(p => p
  821. .GetExternalUrls(item)
  822. .Select(externalUrl => new ExternalUrl { Name = p.Name, Url = externalUrl }));
  823. return legacyExternalIdUrls.Concat(externalUrls).OrderBy(u => u.Name);
  824. }
  825. /// <inheritdoc/>
  826. public IEnumerable<ExternalIdInfo> GetExternalIdInfos(IHasProviderIds item)
  827. {
  828. return GetExternalIds(item)
  829. .Select(i => new ExternalIdInfo(
  830. name: i.ProviderName,
  831. key: i.Key,
  832. type: i.Type,
  833. #pragma warning disable CS0618 // Type or member is obsolete - Remove 10.11
  834. urlFormatString: i.UrlFormatString));
  835. #pragma warning restore CS0618 // Type or member is obsolete
  836. }
  837. /// <inheritdoc/>
  838. public HashSet<Guid> GetRefreshQueue()
  839. {
  840. lock (_refreshQueueLock)
  841. {
  842. return _refreshQueue.UnorderedItems.Select(x => x.Element.ItemId).ToHashSet();
  843. }
  844. }
  845. /// <inheritdoc/>
  846. public void OnRefreshStart(BaseItem item)
  847. {
  848. _logger.LogDebug("OnRefreshStart {Item:N}", item.Id);
  849. _activeRefreshes[item.Id] = 0;
  850. try
  851. {
  852. RefreshStarted?.Invoke(this, new GenericEventArgs<BaseItem>(item));
  853. }
  854. catch (Exception ex)
  855. {
  856. // EventHandlers should never propagate exceptions, but we have little control over plugins...
  857. _logger.LogError(ex, "Invoking {RefreshEvent} event handlers failed", nameof(RefreshStarted));
  858. }
  859. }
  860. /// <inheritdoc/>
  861. public void OnRefreshComplete(BaseItem item)
  862. {
  863. _logger.LogDebug("OnRefreshComplete {Item:N}", item.Id);
  864. _activeRefreshes.TryRemove(item.Id, out _);
  865. try
  866. {
  867. RefreshCompleted?.Invoke(this, new GenericEventArgs<BaseItem>(item));
  868. }
  869. catch (Exception ex)
  870. {
  871. // EventHandlers should never propagate exceptions, but we have little control over plugins...
  872. _logger.LogError(ex, "Invoking {RefreshEvent} event handlers failed", nameof(RefreshCompleted));
  873. }
  874. }
  875. /// <inheritdoc/>
  876. public double? GetRefreshProgress(Guid id)
  877. {
  878. if (_activeRefreshes.TryGetValue(id, out double value))
  879. {
  880. return value;
  881. }
  882. return null;
  883. }
  884. /// <inheritdoc/>
  885. public void OnRefreshProgress(BaseItem item, double progress)
  886. {
  887. var id = item.Id;
  888. _logger.LogDebug("OnRefreshProgress {Id:N} {Progress}", id, progress);
  889. if (!_activeRefreshes.TryGetValue(id, out var current)
  890. || progress <= current
  891. || !_activeRefreshes.TryUpdate(id, progress, current))
  892. {
  893. // Item isn't currently refreshing, or update was received out-of-order, so don't trigger event.
  894. return;
  895. }
  896. try
  897. {
  898. RefreshProgress?.Invoke(this, new GenericEventArgs<Tuple<BaseItem, double>>(new Tuple<BaseItem, double>(item, progress)));
  899. }
  900. catch (Exception ex)
  901. {
  902. // EventHandlers should never propagate exceptions, but we have little control over plugins...
  903. _logger.LogError(ex, "Invoking {RefreshEvent} event handlers failed", nameof(RefreshProgress));
  904. }
  905. }
  906. /// <inheritdoc/>
  907. public void QueueRefresh(Guid itemId, MetadataRefreshOptions options, RefreshPriority priority)
  908. {
  909. if (itemId.IsEmpty())
  910. {
  911. throw new ArgumentException("Guid can't be empty", nameof(itemId));
  912. }
  913. if (_disposed)
  914. {
  915. return;
  916. }
  917. _refreshQueue.Enqueue((itemId, options), priority);
  918. lock (_refreshQueueLock)
  919. {
  920. if (!_isProcessingRefreshQueue)
  921. {
  922. _isProcessingRefreshQueue = true;
  923. Task.Run(StartProcessingRefreshQueue);
  924. }
  925. }
  926. }
  927. private async Task StartProcessingRefreshQueue()
  928. {
  929. var libraryManager = _libraryManager;
  930. if (_disposed)
  931. {
  932. return;
  933. }
  934. var cancellationToken = _disposeCancellationTokenSource.Token;
  935. while (_refreshQueue.TryDequeue(out var refreshItem, out _))
  936. {
  937. if (_disposed)
  938. {
  939. return;
  940. }
  941. try
  942. {
  943. var item = libraryManager.GetItemById(refreshItem.ItemId);
  944. if (item is null)
  945. {
  946. continue;
  947. }
  948. var task = item is MusicArtist artist
  949. ? RefreshArtist(artist, refreshItem.RefreshOptions, cancellationToken)
  950. : RefreshItem(item, refreshItem.RefreshOptions, cancellationToken);
  951. await task.ConfigureAwait(false);
  952. }
  953. catch (OperationCanceledException)
  954. {
  955. break;
  956. }
  957. catch (Exception ex)
  958. {
  959. _logger.LogError(ex, "Error refreshing item");
  960. }
  961. }
  962. lock (_refreshQueueLock)
  963. {
  964. _isProcessingRefreshQueue = false;
  965. }
  966. }
  967. private async Task RefreshItem(BaseItem item, MetadataRefreshOptions options, CancellationToken cancellationToken)
  968. {
  969. await item.RefreshMetadata(options, cancellationToken).ConfigureAwait(false);
  970. // Collection folders don't validate their children so we'll have to simulate that here
  971. switch (item)
  972. {
  973. case CollectionFolder collectionFolder:
  974. await RefreshCollectionFolderChildren(options, collectionFolder, cancellationToken).ConfigureAwait(false);
  975. break;
  976. case Folder folder:
  977. await folder.ValidateChildren(new Progress<double>(), options, cancellationToken: cancellationToken).ConfigureAwait(false);
  978. break;
  979. }
  980. }
  981. private async Task RefreshCollectionFolderChildren(MetadataRefreshOptions options, CollectionFolder collectionFolder, CancellationToken cancellationToken)
  982. {
  983. foreach (var child in collectionFolder.GetPhysicalFolders())
  984. {
  985. await child.RefreshMetadata(options, cancellationToken).ConfigureAwait(false);
  986. await child.ValidateChildren(new Progress<double>(), options, cancellationToken: cancellationToken).ConfigureAwait(false);
  987. }
  988. }
  989. private async Task RefreshArtist(MusicArtist item, MetadataRefreshOptions options, CancellationToken cancellationToken)
  990. {
  991. var albums = _libraryManager
  992. .GetItemList(new InternalItemsQuery
  993. {
  994. IncludeItemTypes = new[] { BaseItemKind.MusicAlbum },
  995. ArtistIds = new[] { item.Id },
  996. DtoOptions = new DtoOptions(false)
  997. {
  998. EnableImages = false
  999. }
  1000. })
  1001. .OfType<MusicAlbum>();
  1002. var musicArtists = albums
  1003. .Select(i => i.MusicArtist)
  1004. .Where(i => i is not null)
  1005. .Distinct();
  1006. var musicArtistRefreshTasks = musicArtists.Select(i => i.ValidateChildren(new Progress<double>(), options, true, false, cancellationToken));
  1007. await Task.WhenAll(musicArtistRefreshTasks).ConfigureAwait(false);
  1008. try
  1009. {
  1010. await item.RefreshMetadata(options, cancellationToken).ConfigureAwait(false);
  1011. }
  1012. catch (Exception ex)
  1013. {
  1014. _logger.LogError(ex, "Error refreshing library");
  1015. }
  1016. }
  1017. /// <inheritdoc/>
  1018. public Task RefreshFullItem(BaseItem item, MetadataRefreshOptions options, CancellationToken cancellationToken)
  1019. {
  1020. return RefreshItem(item, options, cancellationToken);
  1021. }
  1022. /// <inheritdoc/>
  1023. public void Dispose()
  1024. {
  1025. Dispose(true);
  1026. GC.SuppressFinalize(this);
  1027. }
  1028. /// <summary>
  1029. /// Releases unmanaged and optionally managed resources.
  1030. /// </summary>
  1031. /// <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
  1032. protected virtual void Dispose(bool disposing)
  1033. {
  1034. if (_disposed)
  1035. {
  1036. return;
  1037. }
  1038. if (disposing)
  1039. {
  1040. if (!_disposeCancellationTokenSource.IsCancellationRequested)
  1041. {
  1042. _disposeCancellationTokenSource.Cancel();
  1043. }
  1044. _disposeCancellationTokenSource.Dispose();
  1045. _imageSaveLock.Dispose();
  1046. }
  1047. _disposed = true;
  1048. }
  1049. }
  1050. }