using MediaBrowser.Common.Extensions; using MediaBrowser.Common.IO; using MediaBrowser.Common.Kernel; using MediaBrowser.Controller.Entities; using MediaBrowser.Model.Logging; using System; using System.Collections.Concurrent; using System.Collections.Generic; using System.IO; using System.Linq; using System.Threading; using System.Threading.Tasks; namespace MediaBrowser.Controller.Providers { /// /// Class ProviderManager /// public class ProviderManager : BaseManager { /// /// The remote image cache /// private readonly FileSystemRepository _remoteImageCache; /// /// The currently running metadata providers /// private readonly ConcurrentDictionary> _currentlyRunningProviders = new ConcurrentDictionary>(); /// /// The _logger /// private readonly ILogger _logger; /// /// Initializes a new instance of the class. /// /// The kernel. /// The logger. public ProviderManager(Kernel kernel, ILogger logger) : base(kernel) { _logger = logger; _remoteImageCache = new FileSystemRepository(ImagesDataPath); } /// /// The _images data path /// private string _imagesDataPath; /// /// Gets the images data path. /// /// The images data path. public string ImagesDataPath { get { if (_imagesDataPath == null) { _imagesDataPath = Path.Combine(Kernel.ApplicationPaths.DataPath, "remote-images"); if (!Directory.Exists(_imagesDataPath)) { Directory.CreateDirectory(_imagesDataPath); } } return _imagesDataPath; } } /// /// Gets or sets the supported providers key. /// /// The supported providers key. private Guid SupportedProvidersKey { get; set; } /// /// Runs all metadata providers for an entity, and returns true or false indicating if at least one was refreshed and requires persistence /// /// The item. /// The cancellation token. /// if set to true [force]. /// if set to true [allow slow providers]. /// Task{System.Boolean}. internal async Task ExecuteMetadataProviders(BaseItem item, CancellationToken cancellationToken, bool force = false, bool allowSlowProviders = true) { // Allow providers of the same priority to execute in parallel MetadataProviderPriority? currentPriority = null; var currentTasks = new List>(); var result = false; cancellationToken.ThrowIfCancellationRequested(); // Determine if supported providers have changed var supportedProviders = Kernel.MetadataProviders.Where(p => p.Supports(item)).ToList(); BaseProviderInfo supportedProvidersInfo; if (SupportedProvidersKey == Guid.Empty) { SupportedProvidersKey = "SupportedProviders".GetMD5(); } var supportedProvidersHash = string.Join("+", supportedProviders.Select(i => i.GetType().Name)).GetMD5(); bool providersChanged; item.ProviderData.TryGetValue(SupportedProvidersKey, out supportedProvidersInfo); if (supportedProvidersInfo == null) { // First time supportedProvidersInfo = new BaseProviderInfo { ProviderId = SupportedProvidersKey, FileSystemStamp = supportedProvidersHash }; providersChanged = force = true; } else { // Force refresh if the supported providers have changed providersChanged = force = force || supportedProvidersInfo.FileSystemStamp != supportedProvidersHash; } // If providers have changed, clear provider info and update the supported providers hash if (providersChanged) { _logger.Debug("Providers changed for {0}. Clearing and forcing refresh.", item.Name); item.ProviderData.Clear(); supportedProvidersInfo.FileSystemStamp = supportedProvidersHash; } if (force) item.ClearMetaValues(); // Run the normal providers sequentially in order of priority foreach (var provider in supportedProviders) { cancellationToken.ThrowIfCancellationRequested(); // Skip if internet providers are currently disabled if (provider.RequiresInternet && !Kernel.Configuration.EnableInternetProviders) { continue; } // Skip if is slow and we aren't allowing slow ones if (provider.IsSlow && !allowSlowProviders) { continue; } // Skip if internet provider and this type is not allowed if (provider.RequiresInternet && Kernel.Configuration.EnableInternetProviders && Kernel.Configuration.InternetProviderExcludeTypes.Contains(item.GetType().Name, StringComparer.OrdinalIgnoreCase)) { continue; } // When a new priority is reached, await the ones that are currently running and clear the list if (currentPriority.HasValue && currentPriority.Value != provider.Priority && currentTasks.Count > 0) { var results = await Task.WhenAll(currentTasks).ConfigureAwait(false); result |= results.Contains(true); currentTasks.Clear(); } // Put this check below the await because the needs refresh of the next tier of providers may depend on the previous ones running // This is the case for the fan art provider which depends on the movie and tv providers having run before them if (!force && !provider.NeedsRefresh(item)) { continue; } currentTasks.Add(provider.FetchAsync(item, force, cancellationToken)); currentPriority = provider.Priority; } if (currentTasks.Count > 0) { var results = await Task.WhenAll(currentTasks).ConfigureAwait(false); result |= results.Contains(true); } if (providersChanged) { item.ProviderData[SupportedProvidersKey] = supportedProvidersInfo; } return result || providersChanged; } /// /// Notifies the kernal that a provider has begun refreshing /// /// The provider. /// The item. /// The cancellation token source. internal void OnProviderRefreshBeginning(BaseMetadataProvider provider, BaseItem item, CancellationTokenSource cancellationTokenSource) { var key = item.Id + provider.GetType().Name; Tuple current; if (_currentlyRunningProviders.TryGetValue(key, out current)) { try { current.Item3.Cancel(); } catch (ObjectDisposedException) { } } var tuple = new Tuple(provider, item, cancellationTokenSource); _currentlyRunningProviders.AddOrUpdate(key, tuple, (k, v) => tuple); } /// /// Notifies the kernal that a provider has completed refreshing /// /// The provider. /// The item. internal void OnProviderRefreshCompleted(BaseMetadataProvider provider, BaseItem item) { var key = item.Id + provider.GetType().Name; Tuple current; if (_currentlyRunningProviders.TryRemove(key, out current)) { current.Item3.Dispose(); } } /// /// Validates the currently running providers and cancels any that should not be run due to configuration changes /// internal void ValidateCurrentlyRunningProviders() { _logger.Info("Validing currently running providers"); var enableInternetProviders = Kernel.Configuration.EnableInternetProviders; var internetProviderExcludeTypes = Kernel.Configuration.InternetProviderExcludeTypes; foreach (var tuple in _currentlyRunningProviders.Values .Where(p => p.Item1.RequiresInternet && (!enableInternetProviders || internetProviderExcludeTypes.Contains(p.Item2.GetType().Name, StringComparer.OrdinalIgnoreCase))) .ToList()) { tuple.Item3.Cancel(); } } /// /// Downloads the and save image. /// /// The item. /// The source. /// Name of the target. /// The resource pool. /// The cancellation token. /// Task{System.String}. /// item public async Task DownloadAndSaveImage(BaseItem item, string source, string targetName, SemaphoreSlim resourcePool, CancellationToken cancellationToken) { if (item == null) { throw new ArgumentNullException("item"); } if (string.IsNullOrEmpty(source)) { throw new ArgumentNullException("source"); } if (string.IsNullOrEmpty(targetName)) { throw new ArgumentNullException("targetName"); } if (resourcePool == null) { throw new ArgumentNullException("resourcePool"); } //download and save locally var localPath = Kernel.Configuration.SaveLocalMeta ? Path.Combine(item.MetaLocation, targetName) : _remoteImageCache.GetResourcePath(item.GetType().FullName + item.Path.ToLower(), targetName); var img = await Kernel.HttpManager.FetchToMemoryStream(source, resourcePool, cancellationToken).ConfigureAwait(false); if (Kernel.Configuration.SaveLocalMeta) // queue to media directories { await Kernel.FileSystemManager.SaveToLibraryFilesystem(item, localPath, img, cancellationToken).ConfigureAwait(false); } else { // we can write directly here because it won't affect the watchers try { using (var fs = new FileStream(localPath, FileMode.Create, FileAccess.Write, FileShare.Read, StreamDefaults.DefaultFileStreamBufferSize, FileOptions.Asynchronous)) { await img.CopyToAsync(fs, StreamDefaults.DefaultCopyToBufferSize, cancellationToken).ConfigureAwait(false); } } catch (OperationCanceledException) { throw; } catch (Exception e) { _logger.ErrorException("Error downloading and saving image " + localPath, e); throw; } finally { img.Dispose(); } } return localPath; } /// /// Releases unmanaged and - optionally - managed resources. /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. protected override void Dispose(bool dispose) { if (dispose) { _remoteImageCache.Dispose(); } base.Dispose(dispose); } } }