using MediaBrowser.Common.Extensions; using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Library; using MediaBrowser.Controller.Providers; using MediaBrowser.Model.Entities; using MediaBrowser.Model.Logging; using System; using System.Collections.Generic; using System.Linq; using System.Threading; using System.Threading.Tasks; namespace MediaBrowser.Providers.Manager { public abstract class MetadataService : IMetadataService where TItemType : IHasMetadata { protected readonly IServerConfigurationManager ServerConfigurationManager; protected readonly ILogger Logger; protected readonly IProviderManager ProviderManager; private readonly IProviderRepository _providerRepo; private IMetadataProvider[] _providers = { }; private IImageProvider[] _imageProviders = { }; protected MetadataService(IServerConfigurationManager serverConfigurationManager, ILogger logger, IProviderManager providerManager, IProviderRepository providerRepo) { ServerConfigurationManager = serverConfigurationManager; Logger = logger; ProviderManager = providerManager; _providerRepo = providerRepo; } /// /// Adds the parts. /// /// The providers. /// The image providers. public void AddParts(IEnumerable providers, IEnumerable imageProviders) { _providers = providers.OfType>() .ToArray(); _imageProviders = imageProviders.OrderBy(i => i.Order).ToArray(); } /// /// Saves the provider result. /// /// The result. /// Task. protected Task SaveProviderResult(MetadataStatus result) { return _providerRepo.SaveMetadataStatus(result, CancellationToken.None); } /// /// Gets the last result. /// /// The item identifier. /// ProviderResult. protected MetadataStatus GetLastResult(Guid itemId) { return _providerRepo.GetMetadataStatus(itemId) ?? new MetadataStatus { ItemId = itemId }; } public async Task RefreshMetadata(IHasMetadata item, MetadataRefreshOptions options, CancellationToken cancellationToken) { var itemOfType = (TItemType)item; var updateType = ItemUpdateType.Unspecified; var lastResult = GetLastResult(item.Id); var refreshResult = lastResult; refreshResult.LastErrorMessage = string.Empty; refreshResult.LastStatus = ProviderRefreshStatus.Success; var itemImageProvider = new ItemImageProvider(Logger, ProviderManager, ServerConfigurationManager); var localImagesFailed = false; // Start by validating images try { // Always validate images and check for new locally stored ones. if (itemImageProvider.ValidateImages(item, GetLocalImageProviders(item))) { updateType = updateType | ItemUpdateType.ImageUpdate; } } catch (Exception ex) { localImagesFailed = true; Logger.ErrorException("Error validating images for {0}", ex, item.Path ?? item.Name); refreshResult.AddStatus(ProviderRefreshStatus.Failure, ex.Message); } // Next run metadata providers if (options.MetadataRefreshMode != MetadataRefreshMode.None) { var providers = GetProviders(item, lastResult.DateLastMetadataRefresh.HasValue, options).ToList(); if (providers.Count > 0) { var result = await RefreshWithProviders(itemOfType, options, providers, cancellationToken).ConfigureAwait(false); updateType = updateType | result.UpdateType; refreshResult.AddStatus(result.Status, result.ErrorMessage); refreshResult.SetDateLastMetadataRefresh(DateTime.UtcNow); refreshResult.AddImageProvidersRefreshed(result.Providers); } } // Next run remote image providers, but only if local image providers didn't throw an exception if (!localImagesFailed && options.ImageRefreshMode != ImageRefreshMode.ValidationOnly) { var providers = GetNonLocalImageProviders(item, lastResult.DateLastImagesRefresh.HasValue, options).ToList(); if (providers.Count > 0) { var result = await itemImageProvider.RefreshImages(itemOfType, providers, options, cancellationToken).ConfigureAwait(false); updateType = updateType | result.UpdateType; refreshResult.AddStatus(result.Status, result.ErrorMessage); refreshResult.SetDateLastImagesRefresh(DateTime.UtcNow); refreshResult.AddImageProvidersRefreshed(result.Providers); } updateType = updateType | AfterMetadataRefresh(itemOfType); } var providersHadChanges = updateType > ItemUpdateType.Unspecified; if (options.ForceSave || providersHadChanges) { if (string.IsNullOrEmpty(item.Name)) { throw new InvalidOperationException("Item has no name"); } // Save to database await SaveItem(itemOfType, updateType, cancellationToken); } if (providersHadChanges || refreshResult.IsDirty) { await SaveProviderResult(refreshResult).ConfigureAwait(false); } } /// /// Afters the metadata refresh. /// /// The item. protected virtual ItemUpdateType AfterMetadataRefresh(TItemType item) { return ItemUpdateType.Unspecified; } /// /// Gets the providers. /// /// The item. /// if set to true [has refreshed metadata]. /// The options. /// IEnumerable{`0}. protected virtual IEnumerable GetProviders(IHasMetadata item, bool hasRefreshedMetadata, MetadataRefreshOptions options) { // Get providers to refresh var providers = _providers.Where(i => CanRefresh(i, item)).ToList(); // Run all if either of these flags are true var runAllProviders = options.ReplaceAllMetadata || options.MetadataRefreshMode == MetadataRefreshMode.FullRefresh || !hasRefreshedMetadata; if (!runAllProviders) { // Avoid implicitly captured closure var currentItem = item; var providersWithChanges = providers.OfType() .Where(i => i.HasChanged(currentItem, currentItem.DateLastSaved)) .ToList(); // If local providers are the only ones with changes, then just run those if (providersWithChanges.All(i => i is ILocalMetadataProvider)) { providers = providersWithChanges.Count == 0 ? new List>() : providers.Where(i => i is ILocalMetadataProvider).ToList(); } } return providers; } protected virtual IEnumerable GetNonLocalImageProviders(IHasMetadata item, bool hasRefreshedImages, ImageRefreshOptions options) { // Get providers to refresh var providers = _imageProviders.Where(i => { try { return !(i is ILocalImageProvider) && i.Supports(item); } catch (Exception ex) { Logger.ErrorException("Error in ImageProvider.Supports", ex, i.Name); return false; } }).ToList(); // Run all if either of these flags are true var runAllProviders = options.ImageRefreshMode == ImageRefreshMode.FullRefresh || !hasRefreshedImages; if (!runAllProviders) { // Avoid implicitly captured closure var currentItem = item; providers = providers.OfType() .Where(i => i.HasChanged(currentItem, currentItem.DateLastSaved)) .Cast() .ToList(); } return providers; } /// /// Determines whether this instance can refresh the specified provider. /// /// The provider. /// The item. /// true if this instance can refresh the specified provider; otherwise, false. protected bool CanRefresh(IMetadataProvider provider, IHasMetadata item) { if (!ServerConfigurationManager.Configuration.EnableInternetProviders && provider is IRemoteMetadataProvider) { return false; } if (item.LocationType != LocationType.FileSystem && provider is ILocalMetadataProvider) { return false; } return true; } protected abstract Task SaveItem(TItemType item, ItemUpdateType reason, CancellationToken cancellationToken); protected virtual ItemId GetId(IHasMetadata item) { return new ItemId { MetadataCountryCode = item.GetPreferredMetadataCountryCode(), MetadataLanguage = item.GetPreferredMetadataLanguage(), Name = item.Name, ProviderIds = item.ProviderIds }; } public bool CanRefresh(IHasMetadata item) { return item is TItemType; } protected virtual async Task RefreshWithProviders(TItemType item, MetadataRefreshOptions options, List providers, CancellationToken cancellationToken) { var refreshResult = new RefreshResult { UpdateType = ItemUpdateType.Unspecified, Providers = providers.Select(i => i.GetType().FullName.GetMD5()).ToList() }; var temp = CreateNew(); // If replacing all metadata, run internet providers first if (options.ReplaceAllMetadata) { await ExecuteRemoteProviders(item, temp, providers.OfType>(), refreshResult, cancellationToken).ConfigureAwait(false); } var hasLocalMetadata = false; foreach (var provider in providers.OfType>()) { Logger.Debug("Running {0} for {1}", provider.GetType().Name, item.Path ?? item.Name); try { var localItem = await provider.GetMetadata(item.Path, cancellationToken).ConfigureAwait(false); if (localItem.HasMetadata) { MergeData(localItem.Item, temp, new List(), false, true); refreshResult.UpdateType = refreshResult.UpdateType | ItemUpdateType.MetadataImport; // Only one local provider allowed per item hasLocalMetadata = true; break; } } catch (OperationCanceledException) { throw; } catch (Exception ex) { // If a local provider fails, consider that a failure refreshResult.Status = ProviderRefreshStatus.Failure; refreshResult.ErrorMessage = ex.Message; Logger.ErrorException("Error in {0}", ex, provider.Name); // If the local provider fails don't continue with remote providers because the user's saved metadata could be lost return refreshResult; } } if (!options.ReplaceAllMetadata && !hasLocalMetadata) { await ExecuteRemoteProviders(item, temp, providers.OfType>(), refreshResult, cancellationToken).ConfigureAwait(false); } MergeData(temp, item, item.LockedFields, true, true); return refreshResult; } protected abstract TItemType CreateNew(); private async Task ExecuteRemoteProviders(TItemType item, TItemType temp, IEnumerable> providers, RefreshResult refreshResult, CancellationToken cancellationToken) { var id = GetId(item); foreach (var provider in providers) { Logger.Debug("Running {0} for {1}", provider.GetType().Name, item.Path ?? item.Name); try { var result = await provider.GetMetadata(id, cancellationToken).ConfigureAwait(false); if (result.HasMetadata) { MergeData(result.Item, temp, new List(), false, false); refreshResult.UpdateType = refreshResult.UpdateType | ItemUpdateType.MetadataDownload; } } catch (OperationCanceledException) { throw; } catch (Exception ex) { refreshResult.Status = ProviderRefreshStatus.CompletedWithErrors; refreshResult.ErrorMessage = ex.Message; Logger.ErrorException("Error in {0}", ex, provider.Name); } } } protected abstract void MergeData(TItemType source, TItemType target, List lockedFields, bool replaceData, bool mergeMetadataSettings); public virtual int Order { get { return 0; } } private IEnumerable GetLocalImageProviders(IHasImages item) { return _imageProviders.OfType().Where(i => { try { return i.Supports(item); } catch (Exception ex) { Logger.ErrorException("Error in ImageProvider.Supports", ex, i.Name); return false; } }); } } public class RefreshResult { public ItemUpdateType UpdateType { get; set; } public ProviderRefreshStatus Status { get; set; } public string ErrorMessage { get; set; } public List Providers { get; set; } } }