#pragma warning disable CS1591 using System; using System.Collections.Concurrent; using System.Collections.Generic; using System.Globalization; using System.IO; using System.Linq; using System.Threading; using System.Threading.Tasks; using MediaBrowser.Common.Net; using MediaBrowser.Common.Progress; using MediaBrowser.Controller; using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Dto; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities.Audio; using MediaBrowser.Controller.Entities.Movies; using MediaBrowser.Controller.Entities.TV; using MediaBrowser.Controller.Library; using MediaBrowser.Controller.Providers; using MediaBrowser.Controller.Subtitles; using MediaBrowser.Model.Configuration; using MediaBrowser.Model.Entities; using MediaBrowser.Model.Events; using MediaBrowser.Model.IO; using MediaBrowser.Model.Providers; using MediaBrowser.Model.Serialization; using Microsoft.Extensions.Logging; using Priority_Queue; namespace MediaBrowser.Providers.Manager { /// <summary> /// Class ProviderManager /// </summary> public class ProviderManager : IProviderManager, IDisposable { private readonly ILogger _logger; private readonly IHttpClient _httpClient; private readonly ILibraryMonitor _libraryMonitor; private readonly IFileSystem _fileSystem; private readonly IServerApplicationPaths _appPaths; private readonly IJsonSerializer _json; private readonly ILibraryManager _libraryManager; private readonly ISubtitleManager _subtitleManager; private readonly IServerConfigurationManager _configurationManager; private IImageProvider[] ImageProviders { get; set; } private IMetadataService[] _metadataServices = { }; private IMetadataProvider[] _metadataProviders = { }; private IEnumerable<IMetadataSaver> _savers; private IExternalId[] _externalIds; private CancellationTokenSource _disposeCancellationTokenSource = new CancellationTokenSource(); public event EventHandler<GenericEventArgs<BaseItem>> RefreshStarted; public event EventHandler<GenericEventArgs<BaseItem>> RefreshCompleted; public event EventHandler<GenericEventArgs<Tuple<BaseItem, double>>> RefreshProgress; /// <summary> /// Initializes a new instance of the <see cref="ProviderManager" /> class. /// </summary> public ProviderManager( IHttpClient httpClient, ISubtitleManager subtitleManager, IServerConfigurationManager configurationManager, ILibraryMonitor libraryMonitor, ILogger<ProviderManager> logger, IFileSystem fileSystem, IServerApplicationPaths appPaths, ILibraryManager libraryManager, IJsonSerializer json) { _logger = logger; _httpClient = httpClient; _configurationManager = configurationManager; _libraryMonitor = libraryMonitor; _fileSystem = fileSystem; _appPaths = appPaths; _libraryManager = libraryManager; _json = json; _subtitleManager = subtitleManager; } /// <summary> /// Adds the metadata providers. /// </summary> public void AddParts(IEnumerable<IImageProvider> imageProviders, IEnumerable<IMetadataService> metadataServices, IEnumerable<IMetadataProvider> metadataProviders, IEnumerable<IMetadataSaver> metadataSavers, IEnumerable<IExternalId> externalIds) { ImageProviders = imageProviders.ToArray(); _metadataServices = metadataServices.OrderBy(i => i.Order).ToArray(); _metadataProviders = metadataProviders.ToArray(); _externalIds = externalIds.OrderBy(i => i.Name).ToArray(); _savers = metadataSavers.Where(i => { var configurable = i as IConfigurableProvider; return configurable == null || configurable.IsEnabled; }).ToArray(); } public Task<ItemUpdateType> RefreshSingleItem(BaseItem item, MetadataRefreshOptions options, CancellationToken cancellationToken) { IMetadataService service = null; var type = item.GetType(); foreach (var current in _metadataServices) { if (current.CanRefreshPrimary(type)) { service = current; break; } } if (service == null) { foreach (var current in _metadataServices) { if (current.CanRefresh(item)) { service = current; break; } } } if (service != null) { return service.RefreshMetadata(item, options, cancellationToken); } _logger.LogError("Unable to find a metadata service for item of type {TypeName}", item.GetType().Name); return Task.FromResult(ItemUpdateType.None); } public async Task SaveImage(BaseItem item, string url, ImageType type, int? imageIndex, CancellationToken cancellationToken) { using (var response = await _httpClient.GetResponse(new HttpRequestOptions { CancellationToken = cancellationToken, Url = url, BufferContent = false }).ConfigureAwait(false)) { // Workaround for tvheadend channel icons // TODO: Isolate this hack into the tvh plugin if (string.IsNullOrEmpty(response.ContentType)) { if (url.IndexOf("/imagecache/", StringComparison.OrdinalIgnoreCase) != -1) { response.ContentType = "image/png"; } } await SaveImage(item, response.Content, response.ContentType, type, imageIndex, cancellationToken).ConfigureAwait(false); } } public Task SaveImage(BaseItem item, Stream source, string mimeType, ImageType type, int? imageIndex, CancellationToken cancellationToken) { return new ImageSaver(_configurationManager, _libraryMonitor, _fileSystem, _logger).SaveImage(item, source, mimeType, type, imageIndex, cancellationToken); } public Task SaveImage(BaseItem item, string source, string mimeType, ImageType type, int? imageIndex, bool? saveLocallyWithMedia, CancellationToken cancellationToken) { if (string.IsNullOrWhiteSpace(source)) { throw new ArgumentNullException(nameof(source)); } var fileStream = new FileStream(source, FileMode.Open, FileAccess.Read, FileShare.ReadWrite, IODefaults.FileStreamBufferSize, true); return new ImageSaver(_configurationManager, _libraryMonitor, _fileSystem, _logger).SaveImage(item, fileStream, mimeType, type, imageIndex, saveLocallyWithMedia, cancellationToken); } public async Task<IEnumerable<RemoteImageInfo>> GetAvailableRemoteImages(BaseItem item, RemoteImageQuery query, CancellationToken cancellationToken) { var providers = GetRemoteImageProviders(item, query.IncludeDisabledProviders); if (!string.IsNullOrEmpty(query.ProviderName)) { var providerName = query.ProviderName; providers = providers.Where(i => string.Equals(i.Name, providerName, StringComparison.OrdinalIgnoreCase)); } var preferredLanguage = item.GetPreferredMetadataLanguage(); var languages = new List<string>(); if (!query.IncludeAllLanguages && !string.IsNullOrWhiteSpace(preferredLanguage)) { languages.Add(preferredLanguage); } var tasks = providers.Select(i => GetImages(item, cancellationToken, i, languages, query.ImageType)); var results = await Task.WhenAll(tasks).ConfigureAwait(false); return results.SelectMany(i => i.ToList()); } /// <summary> /// Gets the images. /// </summary> /// <param name="item">The item.</param> /// <param name="cancellationToken">The cancellation token.</param> /// <param name="provider">The provider.</param> /// <param name="preferredLanguages">The preferred languages.</param> /// <param name="type">The type.</param> /// <returns>Task{IEnumerable{RemoteImageInfo}}.</returns> private async Task<IEnumerable<RemoteImageInfo>> GetImages(BaseItem item, CancellationToken cancellationToken, IRemoteImageProvider provider, List<string> preferredLanguages, ImageType? type = null) { try { var result = await provider.GetImages(item, cancellationToken).ConfigureAwait(false); if (type.HasValue) { result = result.Where(i => i.Type == type.Value); } if (preferredLanguages.Count > 0) { result = result.Where(i => string.IsNullOrEmpty(i.Language) || preferredLanguages.Contains(i.Language, StringComparer.OrdinalIgnoreCase) || string.Equals(i.Language, "en", StringComparison.OrdinalIgnoreCase)); } return result; } catch (OperationCanceledException) { return new List<RemoteImageInfo>(); } catch (Exception ex) { _logger.LogError(ex, "{0} failed in GetImageInfos for type {1}", provider.GetType().Name, item.GetType().Name); return new List<RemoteImageInfo>(); } } /// <summary> /// Gets the supported image providers. /// </summary> /// <param name="item">The item.</param> /// <returns>IEnumerable{IImageProvider}.</returns> public IEnumerable<ImageProviderInfo> GetRemoteImageProviderInfo(BaseItem item) { return GetRemoteImageProviders(item, true).Select(i => new ImageProviderInfo(i.Name, i.GetSupportedImages(item).ToArray())); } public IEnumerable<IImageProvider> GetImageProviders(BaseItem item, ImageRefreshOptions refreshOptions) { return GetImageProviders(item, _libraryManager.GetLibraryOptions(item), GetMetadataOptions(item), refreshOptions, false); } private IEnumerable<IImageProvider> GetImageProviders(BaseItem item, LibraryOptions libraryOptions, MetadataOptions options, ImageRefreshOptions refreshOptions, bool includeDisabled) { // Avoid implicitly captured closure var currentOptions = options; var typeOptions = libraryOptions.GetTypeOptions(item.GetType().Name); var typeFetcherOrder = typeOptions?.ImageFetcherOrder; return ImageProviders.Where(i => CanRefresh(i, item, libraryOptions, options, refreshOptions, includeDisabled)) .OrderBy(i => { // See if there's a user-defined order if (!(i is ILocalImageProvider)) { var fetcherOrder = typeFetcherOrder ?? currentOptions.ImageFetcherOrder; var index = Array.IndexOf(fetcherOrder, i.Name); if (index != -1) { return index; } } // Not configured. Just return some high number to put it at the end. return 100; }) .ThenBy(GetOrder); } public IEnumerable<IMetadataProvider<T>> GetMetadataProviders<T>(BaseItem item, LibraryOptions libraryOptions) where T : BaseItem { var globalMetadataOptions = GetMetadataOptions(item); return GetMetadataProvidersInternal<T>(item, libraryOptions, globalMetadataOptions, false, false); } private IEnumerable<IMetadataProvider<T>> GetMetadataProvidersInternal<T>(BaseItem item, LibraryOptions libraryOptions, MetadataOptions globalMetadataOptions, bool includeDisabled, bool forceEnableInternetMetadata) where T : BaseItem { // Avoid implicitly captured closure var currentOptions = globalMetadataOptions; return _metadataProviders.OfType<IMetadataProvider<T>>() .Where(i => CanRefresh(i, item, libraryOptions, currentOptions, includeDisabled, forceEnableInternetMetadata)) .OrderBy(i => GetConfiguredOrder(item, i, libraryOptions, globalMetadataOptions)) .ThenBy(GetDefaultOrder); } private IEnumerable<IRemoteImageProvider> GetRemoteImageProviders(BaseItem item, bool includeDisabled) { var options = GetMetadataOptions(item); var libraryOptions = _libraryManager.GetLibraryOptions(item); return GetImageProviders(item, libraryOptions, options, new ImageRefreshOptions( new DirectoryService(_fileSystem)), includeDisabled) .OfType<IRemoteImageProvider>(); } private bool CanRefresh(IMetadataProvider provider, BaseItem item, LibraryOptions libraryOptions, MetadataOptions options, bool includeDisabled, bool forceEnableInternetMetadata) { if (!includeDisabled) { // If locked only allow local providers if (item.IsLocked && !(provider is ILocalMetadataProvider) && !(provider is IForcedProvider)) { return false; } if (provider is IRemoteMetadataProvider) { if (!forceEnableInternetMetadata && !item.IsMetadataFetcherEnabled(libraryOptions, provider.Name)) { return false; } } } if (!item.SupportsLocalMetadata && provider is ILocalMetadataProvider) { return false; } // If this restriction is ever lifted, movie xml providers will have to be updated to prevent owned items like trailers from reading those files if (!item.OwnerId.Equals(Guid.Empty)) { if (provider is ILocalMetadataProvider || provider is IRemoteMetadataProvider) { return false; } } return true; } private bool CanRefresh(IImageProvider provider, BaseItem item, LibraryOptions libraryOptions, MetadataOptions options, ImageRefreshOptions refreshOptions, bool includeDisabled) { if (!includeDisabled) { // If locked only allow local providers if (item.IsLocked && !(provider is ILocalImageProvider)) { if (refreshOptions.ImageRefreshMode != MetadataRefreshMode.FullRefresh) { return false; } } if (provider is IRemoteImageProvider || provider is IDynamicImageProvider) { if (!item.IsImageFetcherEnabled(libraryOptions, provider.Name)) { return false; } } } try { return provider.Supports(item); } catch (Exception ex) { _logger.LogError(ex, "{0} failed in Supports for type {1}", provider.GetType().Name, item.GetType().Name); return false; } } /// <summary> /// Gets the order. /// </summary> /// <param name="provider">The provider.</param> /// <returns>System.Int32.</returns> private int GetOrder(IImageProvider provider) { var hasOrder = provider as IHasOrder; if (hasOrder == null) { return 0; } return hasOrder.Order; } private int GetConfiguredOrder(BaseItem item, IMetadataProvider provider, LibraryOptions libraryOptions, MetadataOptions globalMetadataOptions) { // See if there's a user-defined order if (provider is ILocalMetadataProvider) { var configuredOrder = libraryOptions.LocalMetadataReaderOrder ?? globalMetadataOptions.LocalMetadataReaderOrder; var index = Array.IndexOf(configuredOrder, provider.Name); if (index != -1) { return index; } } // See if there's a user-defined order if (provider is IRemoteMetadataProvider) { var typeOptions = libraryOptions.GetTypeOptions(item.GetType().Name); var typeFetcherOrder = typeOptions == null ? null : typeOptions.MetadataFetcherOrder; var fetcherOrder = typeFetcherOrder ?? globalMetadataOptions.MetadataFetcherOrder; var index = Array.IndexOf(fetcherOrder, provider.Name); if (index != -1) { return index; } } // Not configured. Just return some high number to put it at the end. return 100; } private int GetDefaultOrder(IMetadataProvider provider) { var hasOrder = provider as IHasOrder; if (hasOrder != null) { return hasOrder.Order; } return 0; } public MetadataPluginSummary[] GetAllMetadataPlugins() { return new MetadataPluginSummary[] { GetPluginSummary<Movie>(), GetPluginSummary<BoxSet>(), GetPluginSummary<Book>(), GetPluginSummary<Series>(), GetPluginSummary<Season>(), GetPluginSummary<Episode>(), GetPluginSummary<MusicAlbum>(), GetPluginSummary<MusicArtist>(), GetPluginSummary<Audio>(), GetPluginSummary<AudioBook>(), GetPluginSummary<Studio>(), GetPluginSummary<MusicVideo>(), GetPluginSummary<Video>() }; } private MetadataPluginSummary GetPluginSummary<T>() where T : BaseItem, new() { // Give it a dummy path just so that it looks like a file system item var dummy = new T() { Path = Path.Combine(_appPaths.InternalMetadataPath, "dummy"), ParentId = Guid.NewGuid() }; var options = GetMetadataOptions(dummy); var summary = new MetadataPluginSummary { ItemType = typeof(T).Name }; var libraryOptions = new LibraryOptions(); var imageProviders = GetImageProviders(dummy, libraryOptions, options, new ImageRefreshOptions( new DirectoryService(_fileSystem)), true) .ToList(); var pluginList = summary.Plugins.ToList(); AddMetadataPlugins(pluginList, dummy, libraryOptions, options); AddImagePlugins(pluginList, dummy, imageProviders); var subtitleProviders = _subtitleManager.GetSupportedProviders(dummy); // Subtitle fetchers pluginList.AddRange(subtitleProviders.Select(i => new MetadataPlugin { Name = i.Name, Type = MetadataPluginType.SubtitleFetcher })); summary.Plugins = pluginList.ToArray(); var supportedImageTypes = imageProviders.OfType<IRemoteImageProvider>() .SelectMany(i => i.GetSupportedImages(dummy)) .ToList(); supportedImageTypes.AddRange(imageProviders.OfType<IDynamicImageProvider>() .SelectMany(i => i.GetSupportedImages(dummy))); summary.SupportedImageTypes = supportedImageTypes.Distinct().ToArray(); return summary; } private void AddMetadataPlugins<T>(List<MetadataPlugin> list, T item, LibraryOptions libraryOptions, MetadataOptions options) where T : BaseItem { var providers = GetMetadataProvidersInternal<T>(item, libraryOptions, options, true, true).ToList(); // Locals list.AddRange(providers.Where(i => (i is ILocalMetadataProvider)).Select(i => new MetadataPlugin { Name = i.Name, Type = MetadataPluginType.LocalMetadataProvider })); // Fetchers list.AddRange(providers.Where(i => (i is IRemoteMetadataProvider)).Select(i => new MetadataPlugin { Name = i.Name, Type = MetadataPluginType.MetadataFetcher })); // Savers list.AddRange(_savers.Where(i => IsSaverEnabledForItem(i, item, libraryOptions, ItemUpdateType.MetadataEdit, true)).OrderBy(i => i.Name).Select(i => new MetadataPlugin { Name = i.Name, Type = MetadataPluginType.MetadataSaver })); } private void AddImagePlugins<T>(List<MetadataPlugin> list, T item, List<IImageProvider> imageProviders) where T : BaseItem { // Locals list.AddRange(imageProviders.Where(i => (i is ILocalImageProvider)).Select(i => new MetadataPlugin { Name = i.Name, Type = MetadataPluginType.LocalImageProvider })); // Fetchers list.AddRange(imageProviders.Where(i => i is IDynamicImageProvider || (i is IRemoteImageProvider)).Select(i => new MetadataPlugin { Name = i.Name, Type = MetadataPluginType.ImageFetcher })); } public MetadataOptions GetMetadataOptions(BaseItem item) { var type = item.GetType().Name; return _configurationManager.Configuration.MetadataOptions .FirstOrDefault(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase)) ?? new MetadataOptions(); } /// <summary> /// Saves the metadata. /// </summary> public void SaveMetadata(BaseItem item, ItemUpdateType updateType) { SaveMetadata(item, updateType, _savers); } /// <summary> /// Saves the metadata. /// </summary> public void SaveMetadata(BaseItem item, ItemUpdateType updateType, IEnumerable<string> savers) { SaveMetadata(item, updateType, _savers.Where(i => savers.Contains(i.Name, StringComparer.OrdinalIgnoreCase))); } /// <summary> /// Saves the metadata. /// </summary> /// <param name="item">The item.</param> /// <param name="updateType">Type of the update.</param> /// <param name="savers">The savers.</param> /// <returns>Task.</returns> private void SaveMetadata(BaseItem item, ItemUpdateType updateType, IEnumerable<IMetadataSaver> savers) { var libraryOptions = _libraryManager.GetLibraryOptions(item); foreach (var saver in savers.Where(i => IsSaverEnabledForItem(i, item, libraryOptions, updateType, false))) { _logger.LogDebug("Saving {0} to {1}.", item.Path ?? item.Name, saver.Name); var fileSaver = saver as IMetadataFileSaver; if (fileSaver != null) { string path = null; try { path = fileSaver.GetSavePath(item); } catch (Exception ex) { _logger.LogError(ex, "Error in {0} GetSavePath", saver.Name); continue; } try { _libraryMonitor.ReportFileSystemChangeBeginning(path); saver.Save(item, CancellationToken.None); } catch (Exception ex) { _logger.LogError(ex, "Error in metadata saver"); } finally { _libraryMonitor.ReportFileSystemChangeComplete(path, false); } } else { try { saver.Save(item, CancellationToken.None); } catch (Exception ex) { _logger.LogError(ex, "Error in metadata saver"); } } } } /// <summary> /// Determines whether [is saver enabled for item] [the specified saver]. /// </summary> private bool IsSaverEnabledForItem(IMetadataSaver saver, BaseItem item, LibraryOptions libraryOptions, ItemUpdateType updateType, bool includeDisabled) { var options = GetMetadataOptions(item); try { if (!saver.IsEnabledFor(item, updateType)) { return false; } if (!includeDisabled) { if (libraryOptions.MetadataSavers == null) { if (options.DisabledMetadataSavers.Contains(saver.Name, StringComparer.OrdinalIgnoreCase)) { return false; } if (!item.IsSaveLocalMetadataEnabled()) { if (updateType >= ItemUpdateType.MetadataEdit) { var fileSaver = saver as IMetadataFileSaver; // Manual edit occurred // Even if save local is off, save locally anyway if the metadata file already exists if (fileSaver == null || !File.Exists(fileSaver.GetSavePath(item))) { return false; } } else { // Manual edit did not occur // Since local metadata saving is disabled, consider it disabled return false; } } } else { if (!libraryOptions.MetadataSavers.Contains(saver.Name, StringComparer.OrdinalIgnoreCase)) { return false; } } } return true; } catch (Exception ex) { _logger.LogError(ex, "Error in {0}.IsEnabledFor", saver.Name); return false; } } public Task<IEnumerable<RemoteSearchResult>> GetRemoteSearchResults<TItemType, TLookupType>(RemoteSearchQuery<TLookupType> searchInfo, CancellationToken cancellationToken) where TItemType : BaseItem, new() where TLookupType : ItemLookupInfo { BaseItem referenceItem = null; if (!searchInfo.ItemId.Equals(Guid.Empty)) { referenceItem = _libraryManager.GetItemById(searchInfo.ItemId); } return GetRemoteSearchResults<TItemType, TLookupType>(searchInfo, referenceItem, cancellationToken); } public async Task<IEnumerable<RemoteSearchResult>> GetRemoteSearchResults<TItemType, TLookupType>(RemoteSearchQuery<TLookupType> searchInfo, BaseItem referenceItem, CancellationToken cancellationToken) where TItemType : BaseItem, new() where TLookupType : ItemLookupInfo { LibraryOptions libraryOptions; if (referenceItem == null) { // Give it a dummy path just so that it looks like a file system item var dummy = new TItemType { Path = Path.Combine(_appPaths.InternalMetadataPath, "dummy"), ParentId = Guid.NewGuid() }; dummy.SetParent(new Folder()); referenceItem = dummy; libraryOptions = new LibraryOptions(); } else { libraryOptions = _libraryManager.GetLibraryOptions(referenceItem); } var options = GetMetadataOptions(referenceItem); var providers = GetMetadataProvidersInternal<TItemType>(referenceItem, libraryOptions, options, searchInfo.IncludeDisabledProviders, false) .OfType<IRemoteSearchProvider<TLookupType>>(); if (!string.IsNullOrEmpty(searchInfo.SearchProviderName)) { providers = providers.Where(i => string.Equals(i.Name, searchInfo.SearchProviderName, StringComparison.OrdinalIgnoreCase)); } if (string.IsNullOrWhiteSpace(searchInfo.SearchInfo.MetadataLanguage)) { searchInfo.SearchInfo.MetadataLanguage = _configurationManager.Configuration.PreferredMetadataLanguage; } if (string.IsNullOrWhiteSpace(searchInfo.SearchInfo.MetadataCountryCode)) { searchInfo.SearchInfo.MetadataCountryCode = _configurationManager.Configuration.MetadataCountryCode; } var resultList = new List<RemoteSearchResult>(); foreach (var provider in providers) { try { var results = await GetSearchResults(provider, searchInfo.SearchInfo, cancellationToken).ConfigureAwait(false); foreach (var result in results) { var existingMatch = resultList.FirstOrDefault(i => i.ProviderIds.Any(p => string.Equals(result.GetProviderId(p.Key), p.Value, StringComparison.OrdinalIgnoreCase))); if (existingMatch == null) { resultList.Add(result); } else { foreach (var providerId in result.ProviderIds) { if (!existingMatch.ProviderIds.ContainsKey(providerId.Key)) { existingMatch.ProviderIds.Add(providerId.Key, providerId.Value); } } if (string.IsNullOrWhiteSpace(existingMatch.ImageUrl)) { existingMatch.ImageUrl = result.ImageUrl; } } } } catch (Exception) { // Logged at lower levels } } //_logger.LogDebug("Returning search results {0}", _json.SerializeToString(resultList)); return resultList; } private async Task<IEnumerable<RemoteSearchResult>> GetSearchResults<TLookupType>(IRemoteSearchProvider<TLookupType> provider, TLookupType searchInfo, CancellationToken cancellationToken) where TLookupType : ItemLookupInfo { var results = await provider.GetSearchResults(searchInfo, cancellationToken).ConfigureAwait(false); var list = results.ToList(); foreach (var item in list) { item.SearchProviderName = provider.Name; } return list; } public Task<HttpResponseInfo> GetSearchImage(string providerName, string url, CancellationToken cancellationToken) { var provider = _metadataProviders.OfType<IRemoteSearchProvider>().FirstOrDefault(i => string.Equals(i.Name, providerName, StringComparison.OrdinalIgnoreCase)); if (provider == null) { throw new ArgumentException("Search provider not found."); } return provider.GetImageResponse(url, cancellationToken); } public IEnumerable<IExternalId> GetExternalIds(IHasProviderIds item) { return _externalIds.Where(i => { try { return i.Supports(item); } catch (Exception ex) { _logger.LogError(ex, "Error in {0}.Suports", i.GetType().Name); return false; } }); } public IEnumerable<ExternalUrl> GetExternalUrls(BaseItem item) { return GetExternalIds(item) .Select(i => { if (string.IsNullOrEmpty(i.UrlFormatString)) { return null; } var value = item.GetProviderId(i.Key); if (string.IsNullOrEmpty(value)) { return null; } return new ExternalUrl { Name = i.Name, Url = string.Format( CultureInfo.InvariantCulture, i.UrlFormatString, value) }; }).Where(i => i != null).Concat(item.GetRelatedUrls()); } public IEnumerable<ExternalIdInfo> GetExternalIdInfos(IHasProviderIds item) { return GetExternalIds(item) .Select(i => new ExternalIdInfo { Name = i.Name, Key = i.Key, UrlFormatString = i.UrlFormatString }); } private ConcurrentDictionary<Guid, double> _activeRefreshes = new ConcurrentDictionary<Guid, double>(); public Dictionary<Guid, Guid> GetRefreshQueue() { lock (_refreshQueueLock) { var dict = new Dictionary<Guid, Guid>(); foreach (var item in _refreshQueue) { dict[item.Item1] = item.Item1; } return dict; } } public void OnRefreshStart(BaseItem item) { _logger.LogInformation("OnRefreshStart {0}", item.Id.ToString("N", CultureInfo.InvariantCulture)); _activeRefreshes[item.Id] = 0; RefreshStarted?.Invoke(this, new GenericEventArgs<BaseItem>(item)); } public void OnRefreshComplete(BaseItem item) { _logger.LogInformation("OnRefreshComplete {0}", item.Id.ToString("N", CultureInfo.InvariantCulture)); _activeRefreshes.Remove(item.Id, out _); RefreshCompleted?.Invoke(this, new GenericEventArgs<BaseItem>(item)); } public double? GetRefreshProgress(Guid id) { if (_activeRefreshes.TryGetValue(id, out double value)) { return value; } return null; } public void OnRefreshProgress(BaseItem item, double progress) { var id = item.Id; _logger.LogDebug("OnRefreshProgress {0} {1}", id.ToString("N", CultureInfo.InvariantCulture), progress); // TODO: Need to hunt down the conditions for this happening _activeRefreshes.AddOrUpdate( id, (_) => throw new Exception( string.Format( CultureInfo.InvariantCulture, "Cannot update refresh progress of item '{0}' ({1}) because a refresh for this item is not running", item.GetType().Name, item.Id.ToString("N", CultureInfo.InvariantCulture))), (_, __) => progress); RefreshProgress?.Invoke(this, new GenericEventArgs<Tuple<BaseItem, double>>(new Tuple<BaseItem, double>(item, progress))); } private readonly SimplePriorityQueue<Tuple<Guid, MetadataRefreshOptions>> _refreshQueue = new SimplePriorityQueue<Tuple<Guid, MetadataRefreshOptions>>(); private readonly object _refreshQueueLock = new object(); private bool _isProcessingRefreshQueue; public void QueueRefresh(Guid id, MetadataRefreshOptions options, RefreshPriority priority) { if (_disposed) { return; } _refreshQueue.Enqueue(new Tuple<Guid, MetadataRefreshOptions>(id, options), (int)priority); lock (_refreshQueueLock) { if (!_isProcessingRefreshQueue) { _isProcessingRefreshQueue = true; Task.Run(StartProcessingRefreshQueue); } } } private async Task StartProcessingRefreshQueue() { var libraryManager = _libraryManager; if (_disposed) { return; } var cancellationToken = _disposeCancellationTokenSource.Token; while (_refreshQueue.TryDequeue(out Tuple<Guid, MetadataRefreshOptions> refreshItem)) { if (_disposed) { return; } try { var item = libraryManager.GetItemById(refreshItem.Item1); if (item != null) { // Try to throttle this a little bit. await Task.Delay(100).ConfigureAwait(false); var task = item is MusicArtist artist ? RefreshArtist(artist, refreshItem.Item2, cancellationToken) : RefreshItem(item, refreshItem.Item2, cancellationToken); await task.ConfigureAwait(false); } } catch (OperationCanceledException) { break; } catch (Exception ex) { _logger.LogError(ex, "Error refreshing item"); } } lock (_refreshQueueLock) { _isProcessingRefreshQueue = false; } } private async Task RefreshItem(BaseItem item, MetadataRefreshOptions options, CancellationToken cancellationToken) { await item.RefreshMetadata(options, cancellationToken).ConfigureAwait(false); // Collection folders don't validate their children so we'll have to simulate that here if (item is CollectionFolder collectionFolder) { await RefreshCollectionFolderChildren(options, collectionFolder, cancellationToken).ConfigureAwait(false); } else { if (item is Folder folder) { await folder.ValidateChildren(new SimpleProgress<double>(), cancellationToken, options).ConfigureAwait(false); } } } private async Task RefreshCollectionFolderChildren(MetadataRefreshOptions options, CollectionFolder collectionFolder, CancellationToken cancellationToken) { foreach (var child in collectionFolder.GetPhysicalFolders()) { await child.RefreshMetadata(options, cancellationToken).ConfigureAwait(false); await child.ValidateChildren(new SimpleProgress<double>(), cancellationToken, options, true).ConfigureAwait(false); } } private async Task RefreshArtist(MusicArtist item, MetadataRefreshOptions options, CancellationToken cancellationToken) { var albums = _libraryManager .GetItemList(new InternalItemsQuery { IncludeItemTypes = new[] { nameof(MusicAlbum) }, ArtistIds = new[] { item.Id }, DtoOptions = new DtoOptions(false) { EnableImages = false } }) .OfType<MusicAlbum>(); var musicArtists = albums .Select(i => i.MusicArtist) .Where(i => i != null); var musicArtistRefreshTasks = musicArtists.Select(i => i.ValidateChildren(new SimpleProgress<double>(), cancellationToken, options, true)); await Task.WhenAll(musicArtistRefreshTasks).ConfigureAwait(false); try { await item.RefreshMetadata(options, cancellationToken).ConfigureAwait(false); } catch (Exception ex) { _logger.LogError(ex, "Error refreshing library"); } } public Task RefreshFullItem(BaseItem item, MetadataRefreshOptions options, CancellationToken cancellationToken) { return RefreshItem(item, options, cancellationToken); } private bool _disposed; public void Dispose() { _disposed = true; if (!_disposeCancellationTokenSource.IsCancellationRequested) { _disposeCancellationTokenSource.Cancel(); } } } }