diff options
| author | Luke Pulverenti <luke.pulverenti@gmail.com> | 2014-01-28 13:37:01 -0500 |
|---|---|---|
| committer | Luke Pulverenti <luke.pulverenti@gmail.com> | 2014-01-28 13:37:01 -0500 |
| commit | ad82c9f5e95e2b1f94ba7adda047dbfbc38004ea (patch) | |
| tree | 52ab08873cb353faff048edecf8d97d49114b4db /MediaBrowser.Providers | |
| parent | d748967c5de99ba20a788c2448b066fc3fc4fecb (diff) | |
New provider system. Only for people right now
Diffstat (limited to 'MediaBrowser.Providers')
42 files changed, 3396 insertions, 1585 deletions
diff --git a/MediaBrowser.Providers/All/LocalImageProvider.cs b/MediaBrowser.Providers/All/LocalImageProvider.cs new file mode 100644 index 000000000..88a68bc15 --- /dev/null +++ b/MediaBrowser.Providers/All/LocalImageProvider.cs @@ -0,0 +1,327 @@ +using MediaBrowser.Common.IO; +using MediaBrowser.Controller.Entities; +using MediaBrowser.Controller.Entities.Movies; +using MediaBrowser.Controller.Entities.TV; +using MediaBrowser.Controller.Providers; +using MediaBrowser.Model.Entities; +using System; +using System.Collections.Generic; +using System.Globalization; +using System.IO; +using System.Linq; + +namespace MediaBrowser.Providers.All +{ + public class LocalImageProvider : IImageFileProvider + { + private readonly IFileSystem _fileSystem; + + public LocalImageProvider(IFileSystem fileSystem) + { + _fileSystem = fileSystem; + } + + public string Name + { + get { return "Local Images"; } + } + + public int Order + { + get { return 0; } + } + + public bool Supports(IHasImages item) + { + var locationType = item.LocationType; + + if (locationType == LocationType.FileSystem) + { + // Episode has it's own provider + if (item is Episode) + { + return false; + } + + return true; + } + if (locationType == LocationType.Virtual) + { + var season = item as Season; + + if (season != null) + { + var series = season.Series; + + if (series != null && series.LocationType == LocationType.FileSystem) + { + return true; + } + } + } + + return false; + } + + private IEnumerable<string> GetFiles(IHasImages item, bool includeDirectories) + { + if (item.LocationType != LocationType.FileSystem) + { + return new List<string>(); + } + + var path = item.Path; + var fileInfo = _fileSystem.GetFileSystemInfo(path) as DirectoryInfo; + + if (fileInfo == null) + { + path = Path.GetDirectoryName(path); + } + + if (includeDirectories) + { + return Directory.EnumerateFileSystemEntries(path, "*", SearchOption.TopDirectoryOnly); + } + return Directory.EnumerateFiles(path, "*", SearchOption.TopDirectoryOnly); + } + + public List<LocalImageInfo> GetImages(IHasImages item) + { + var files = GetFileDictionary(GetFiles(item, true)); + + var list = new List<LocalImageInfo>(); + + PopulateImages(item, list, files); + + return list; + } + + private void PopulateImages(IHasImages item, List<LocalImageInfo> images, Dictionary<string, string> files) + { + var imagePrefix = string.Empty; + + var baseItem = item as BaseItem; + if (baseItem != null && baseItem.IsInMixedFolder) + { + imagePrefix = Path.GetFileNameWithoutExtension(item.Path) + "-"; + } + + PopulatePrimaryImages(item, images, files, imagePrefix); + PopulateBackdrops(item, images, files, imagePrefix); + PopulateScreenshots(images, files, imagePrefix); + + AddImage(files, images, imagePrefix + "logo", ImageType.Logo); + AddImage(files, images, imagePrefix + "clearart", ImageType.Art); + AddImage(files, images, imagePrefix + "disc", ImageType.Disc); + AddImage(files, images, imagePrefix + "cdart", ImageType.Disc); + AddImage(files, images, imagePrefix + "box", ImageType.Box); + AddImage(files, images, imagePrefix + "back", ImageType.BoxRear); + AddImage(files, images, imagePrefix + "boxrear", ImageType.BoxRear); + AddImage(files, images, imagePrefix + "menu", ImageType.Menu); + + // Banner + AddImage(files, images, imagePrefix + "banner", ImageType.Banner); + + // Thumb + AddImage(files, images, imagePrefix + "thumb", ImageType.Thumb); + AddImage(files, images, imagePrefix + "landscape", ImageType.Thumb); + + var season = item as Season; + + if (season != null) + { + PopulateSeasonImagesFromSeriesFolder(season, images); + } + } + + private void PopulatePrimaryImages(IHasImages item, List<LocalImageInfo> images, Dictionary<string, string> files, string imagePrefix) + { + AddImage(files, images, imagePrefix + "folder", ImageType.Primary); + AddImage(files, images, imagePrefix + "cover", ImageType.Primary); + AddImage(files, images, imagePrefix + "poster", ImageType.Primary); + AddImage(files, images, imagePrefix + "default", ImageType.Primary); + + // Support plex/xbmc convention + if (item is Series) + { + AddImage(files, images, imagePrefix + "show", ImageType.Primary); + } + + // Support plex/xbmc convention + if (item is Movie || item is MusicVideo || item is AdultVideo) + { + AddImage(files, images, imagePrefix + "movie", ImageType.Primary); + } + + if (string.IsNullOrEmpty(item.Path)) + { + var name = Path.GetFileNameWithoutExtension(item.Path); + + if (!string.IsNullOrEmpty(name)) + { + AddImage(files, images, name, ImageType.Primary); + AddImage(files, images, name + "-poster", ImageType.Primary); + } + } + } + + private void PopulateBackdrops(IHasImages item, List<LocalImageInfo> images, Dictionary<string, string> files, string imagePrefix) + { + PopulateBackdrops(images, files, imagePrefix, "backdrop", "backdrop", ImageType.Backdrop); + + if (string.IsNullOrEmpty(item.Path)) + { + var name = Path.GetFileNameWithoutExtension(item.Path); + + if (!string.IsNullOrEmpty(name)) + { + AddImage(files, images, imagePrefix + name + "-fanart", ImageType.Backdrop); + } + } + + PopulateBackdrops(images, files, imagePrefix, "fanart", "fanart-", ImageType.Backdrop); + PopulateBackdrops(images, files, imagePrefix, "background", "background-", ImageType.Backdrop); + PopulateBackdrops(images, files, imagePrefix, "art", "art-", ImageType.Backdrop); + + string extraFanartFolder; + if (files.TryGetValue("extrafanart", out extraFanartFolder)) + { + PopulateBackdropsFromExtraFanart(extraFanartFolder, images); + } + } + + private void PopulateBackdropsFromExtraFanart(string path, List<LocalImageInfo> images) + { + var imageFiles = Directory.EnumerateFiles(path, "*", SearchOption.TopDirectoryOnly) + .Where(i => + { + var extension = Path.GetExtension(i); + + if (string.IsNullOrEmpty(extension)) + { + return false; + } + + return BaseItem.SupportedImageExtensions.Contains(extension, StringComparer.OrdinalIgnoreCase); + }); + + images.AddRange(imageFiles.Select(i => new LocalImageInfo + { + Path = i, + Type = ImageType.Backdrop + })); + } + + private void PopulateScreenshots(List<LocalImageInfo> images, Dictionary<string, string> files, string imagePrefix) + { + PopulateBackdrops(images, files, imagePrefix, "screenshot", "screenshot", ImageType.Screenshot); + } + + private void PopulateBackdrops(List<LocalImageInfo> images, Dictionary<string, string> files, string imagePrefix, string firstFileName, string subsequentFileNamePrefix, ImageType type) + { + AddImage(files, images, imagePrefix + firstFileName, type); + + var unfound = 0; + for (var i = 1; i <= 20; i++) + { + // Screenshot Image + var found = AddImage(files, images, imagePrefix + subsequentFileNamePrefix + i, type); + + if (!found) + { + unfound++; + + if (unfound >= 3) + { + break; + } + } + } + } + + private readonly CultureInfo _usCulture = new CultureInfo("en-US"); + private void PopulateSeasonImagesFromSeriesFolder(Season season, List<LocalImageInfo> images) + { + var seasonNumber = season.IndexNumber; + + var series = season.Series; + if (!seasonNumber.HasValue || series.LocationType != LocationType.FileSystem) + { + return; + } + + var files = GetFileDictionary(GetFiles(series, false)); + + // Try using the season name + var prefix = season.Name.ToLower().Replace(" ", string.Empty); + + var filenamePrefixes = new List<string> { prefix }; + + var seasonMarker = seasonNumber.Value == 0 + ? "-specials" + : seasonNumber.Value.ToString("00", _usCulture); + + // Get this one directly from the file system since we have to go up a level + if (!string.Equals(prefix, seasonMarker, StringComparison.OrdinalIgnoreCase)) + { + filenamePrefixes.Add("season" + seasonMarker); + } + + foreach (var filename in filenamePrefixes) + { + AddImage(files, images, filename + "-poster", ImageType.Primary); + AddImage(files, images, filename + "-fanart", ImageType.Backdrop); + AddImage(files, images, filename + "-banner", ImageType.Banner); + AddImage(files, images, filename + "-landscape", ImageType.Thumb); + } + } + + private Dictionary<string, string> GetFileDictionary(IEnumerable<string> paths) + { + var dict = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase); + + foreach (var path in paths) + { + var filename = Path.GetFileName(path); + + if (!string.IsNullOrEmpty(filename)) + { + dict[filename] = path; + } + } + + return dict; + } + + private bool AddImage(Dictionary<string, string> dict, List<LocalImageInfo> images, string name, ImageType type) + { + var image = GetImage(dict, name); + + if (image != null) + { + images.Add(new LocalImageInfo + { + Path = image, + Type = type + }); + + return true; + } + + return false; + } + + private string GetImage(Dictionary<string, string> dict, string name) + { + return BaseItem.SupportedImageExtensions + .Select(i => + { + var filename = name + i; + string path; + + return dict.TryGetValue(filename, out path) ? path : null; + }) + .FirstOrDefault(i => i != null); + } + } +} diff --git a/MediaBrowser.Providers/BaseXmlProvider.cs b/MediaBrowser.Providers/BaseXmlProvider.cs new file mode 100644 index 000000000..71043df51 --- /dev/null +++ b/MediaBrowser.Providers/BaseXmlProvider.cs @@ -0,0 +1,28 @@ +using MediaBrowser.Common.IO; +using MediaBrowser.Controller.Providers; +using System; +using System.Threading; + +namespace MediaBrowser.Providers +{ + public abstract class BaseXmlProvider: IHasChangeMonitor + { + protected static readonly SemaphoreSlim XmlParsingResourcePool = new SemaphoreSlim(4, 4); + + protected IFileSystem FileSystem; + + protected BaseXmlProvider(IFileSystem fileSystem) + { + FileSystem = fileSystem; + } + + protected abstract string GetXmlPath(string path); + + public bool HasChanged(IHasMetadata item, DateTime date) + { + var path = GetXmlPath(item.Path); + + return FileSystem.GetLastWriteTimeUtc(path) > date; + } + } +} diff --git a/MediaBrowser.Providers/CollectionFolderImageProvider.cs b/MediaBrowser.Providers/CollectionFolderImageProvider.cs index 6c36dbf7e..12f13262d 100644 --- a/MediaBrowser.Providers/CollectionFolderImageProvider.cs +++ b/MediaBrowser.Providers/CollectionFolderImageProvider.cs @@ -1,5 +1,4 @@ -using System.Collections.Generic; -using MediaBrowser.Common.IO; +using MediaBrowser.Common.IO; using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Library; @@ -7,6 +6,7 @@ using MediaBrowser.Controller.Providers; using MediaBrowser.Model.Entities; using MediaBrowser.Model.Logging; using System; +using System.Collections.Generic; using System.IO; using System.Linq; diff --git a/MediaBrowser.Providers/ImagesByName/GameGenresManualImageProvider.cs b/MediaBrowser.Providers/GameGenres/GameGenreImageProvider.cs index 8207bb042..0dbf11450 100644 --- a/MediaBrowser.Providers/ImagesByName/GameGenresManualImageProvider.cs +++ b/MediaBrowser.Providers/GameGenres/GameGenreImageProvider.cs @@ -5,15 +5,17 @@ using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Providers; using MediaBrowser.Model.Entities; using MediaBrowser.Model.Providers; +using MediaBrowser.Providers.Genres; +using MediaBrowser.Providers.ImagesByName; using System.Collections.Generic; using System.IO; using System.Linq; using System.Threading; using System.Threading.Tasks; -namespace MediaBrowser.Providers.ImagesByName +namespace MediaBrowser.Providers.GameGenres { - public class GameGenresManualImageProvider : IImageProvider + public class GameGenreImageProvider : IRemoteImageProvider { private readonly IServerConfigurationManager _config; private readonly IHttpClient _httpClient; @@ -21,7 +23,7 @@ namespace MediaBrowser.Providers.ImagesByName private readonly SemaphoreSlim _listResourcePool = new SemaphoreSlim(1, 1); - public GameGenresManualImageProvider(IServerConfigurationManager config, IHttpClient httpClient, IFileSystem fileSystem) + public GameGenreImageProvider(IServerConfigurationManager config, IHttpClient httpClient, IFileSystem fileSystem) { _config = config; _httpClient = httpClient; @@ -43,6 +45,15 @@ namespace MediaBrowser.Providers.ImagesByName return item is GameGenre; } + public IEnumerable<ImageType> GetSupportedImages(IHasImages item) + { + return new List<ImageType> + { + ImageType.Primary, + ImageType.Thumb + }; + } + public Task<IEnumerable<RemoteImageInfo>> GetImages(IHasImages item, ImageType imageType, CancellationToken cancellationToken) { return GetImages(item, imageType == ImageType.Primary, imageType == ImageType.Thumb, cancellationToken); @@ -120,9 +131,19 @@ namespace MediaBrowser.Providers.ImagesByName return ImageUtils.EnsureList(url, file, _httpClient, _fileSystem, _listResourcePool, cancellationToken); } - public int Priority + public int Order { get { return 0; } } + + public Task<HttpResponseInfo> GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url, + ResourcePool = GenreImageProvider.ImageDownloadResourcePool + }); + } } } diff --git a/MediaBrowser.Providers/GameGenres/GameGenreMetadataService.cs b/MediaBrowser.Providers/GameGenres/GameGenreMetadataService.cs new file mode 100644 index 000000000..7625cdd5a --- /dev/null +++ b/MediaBrowser.Providers/GameGenres/GameGenreMetadataService.cs @@ -0,0 +1,42 @@ +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 MediaBrowser.Providers.Manager; +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; + +namespace MediaBrowser.Providers.GameGenres +{ + public class GameGenreMetadataService : MetadataService<GameGenre> + { + private readonly ILibraryManager _libraryManager; + + public GameGenreMetadataService(IServerConfigurationManager serverConfigurationManager, ILogger logger, IProviderManager providerManager, ILibraryManager libraryManager) + : base(serverConfigurationManager, logger, providerManager) + { + _libraryManager = libraryManager; + } + + /// <summary> + /// Merges the specified source. + /// </summary> + /// <param name="source">The source.</param> + /// <param name="target">The target.</param> + /// <param name="lockedFields">The locked fields.</param> + /// <param name="replaceData">if set to <c>true</c> [replace data].</param> + /// <param name="mergeMetadataSettings">if set to <c>true</c> [merge metadata settings].</param> + protected override void MergeData(GameGenre source, GameGenre target, List<MetadataFields> lockedFields, bool replaceData, bool mergeMetadataSettings) + { + ProviderUtils.MergeBaseItemData(source, target, lockedFields, replaceData, mergeMetadataSettings); + } + + protected override Task SaveItem(GameGenre item, ItemUpdateType reason, CancellationToken cancellationToken) + { + return _libraryManager.UpdateItem(item, reason, cancellationToken); + } + } +} diff --git a/MediaBrowser.Providers/ImagesByName/GenresManualImageProvider.cs b/MediaBrowser.Providers/Genres/GenreImageProvider.cs index 469e133d0..189cc8cde 100644 --- a/MediaBrowser.Providers/ImagesByName/GenresManualImageProvider.cs +++ b/MediaBrowser.Providers/Genres/GenreImageProvider.cs @@ -5,15 +5,16 @@ using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Providers; using MediaBrowser.Model.Entities; using MediaBrowser.Model.Providers; +using MediaBrowser.Providers.ImagesByName; using System.Collections.Generic; using System.IO; using System.Linq; using System.Threading; using System.Threading.Tasks; -namespace MediaBrowser.Providers.ImagesByName +namespace MediaBrowser.Providers.Genres { - public class GenresManualImageProvider : IImageProvider + public class GenreImageProvider : IRemoteImageProvider { private readonly IServerConfigurationManager _config; private readonly IHttpClient _httpClient; @@ -21,7 +22,9 @@ namespace MediaBrowser.Providers.ImagesByName private readonly SemaphoreSlim _listResourcePool = new SemaphoreSlim(1, 1); - public GenresManualImageProvider(IServerConfigurationManager config, IHttpClient httpClient, IFileSystem fileSystem) + public static SemaphoreSlim ImageDownloadResourcePool = new SemaphoreSlim(5, 5); + + public GenreImageProvider(IServerConfigurationManager config, IHttpClient httpClient, IFileSystem fileSystem) { _config = config; _httpClient = httpClient; @@ -43,6 +46,15 @@ namespace MediaBrowser.Providers.ImagesByName return item is Genre; } + public IEnumerable<ImageType> GetSupportedImages(IHasImages item) + { + return new List<ImageType> + { + ImageType.Primary, + ImageType.Thumb + }; + } + public Task<IEnumerable<RemoteImageInfo>> GetImages(IHasImages item, ImageType imageType, CancellationToken cancellationToken) { return GetImages(item, imageType == ImageType.Primary, imageType == ImageType.Thumb, cancellationToken); @@ -120,9 +132,19 @@ namespace MediaBrowser.Providers.ImagesByName return ImageUtils.EnsureList(url, file, _httpClient, _fileSystem, _listResourcePool, cancellationToken); } - public int Priority + public int Order { get { return 0; } } + + public Task<HttpResponseInfo> GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url, + ResourcePool = ImageDownloadResourcePool + }); + } } } diff --git a/MediaBrowser.Providers/Genres/GenreMetadataService.cs b/MediaBrowser.Providers/Genres/GenreMetadataService.cs new file mode 100644 index 000000000..7a8ffa5d4 --- /dev/null +++ b/MediaBrowser.Providers/Genres/GenreMetadataService.cs @@ -0,0 +1,42 @@ +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 MediaBrowser.Providers.Manager; +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; + +namespace MediaBrowser.Providers.Genres +{ + public class GenreMetadataService : MetadataService<Genre> + { + private readonly ILibraryManager _libraryManager; + + public GenreMetadataService(IServerConfigurationManager serverConfigurationManager, ILogger logger, IProviderManager providerManager, ILibraryManager libraryManager) + : base(serverConfigurationManager, logger, providerManager) + { + _libraryManager = libraryManager; + } + + /// <summary> + /// Merges the specified source. + /// </summary> + /// <param name="source">The source.</param> + /// <param name="target">The target.</param> + /// <param name="lockedFields">The locked fields.</param> + /// <param name="replaceData">if set to <c>true</c> [replace data].</param> + /// <param name="mergeMetadataSettings">if set to <c>true</c> [merge metadata settings].</param> + protected override void MergeData(Genre source, Genre target, List<MetadataFields> lockedFields, bool replaceData, bool mergeMetadataSettings) + { + ProviderUtils.MergeBaseItemData(source, target, lockedFields, replaceData, mergeMetadataSettings); + } + + protected override Task SaveItem(Genre item, ItemUpdateType reason, CancellationToken cancellationToken) + { + return _libraryManager.UpdateItem(item, reason, cancellationToken); + } + } +} diff --git a/MediaBrowser.Providers/ImageFromMediaLocationProvider.cs b/MediaBrowser.Providers/ImageFromMediaLocationProvider.cs index 2146d927b..bc58f3178 100644 --- a/MediaBrowser.Providers/ImageFromMediaLocationProvider.cs +++ b/MediaBrowser.Providers/ImageFromMediaLocationProvider.cs @@ -145,17 +145,6 @@ namespace MediaBrowser.Providers cancellationToken.ThrowIfCancellationRequested(); - // Make sure current backdrop paths still exist - item.ValidateBackdrops(); - - var hasScreenshots = item as IHasScreenshots; - if (hasScreenshots != null) - { - hasScreenshots.ValidateScreenshots(); - } - - cancellationToken.ThrowIfCancellationRequested(); - var args = GetResolveArgsContainingImages(item); PopulateBaseItemImages(item, args); diff --git a/MediaBrowser.Providers/ImagesByName/GameGenreImageProvider.cs b/MediaBrowser.Providers/ImagesByName/GameGenreImageProvider.cs deleted file mode 100644 index a0dbb83dc..000000000 --- a/MediaBrowser.Providers/ImagesByName/GameGenreImageProvider.cs +++ /dev/null @@ -1,160 +0,0 @@ -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 MediaBrowser.Model.Net; -using MediaBrowser.Model.Providers; -using System; -using System.Collections.Generic; -using System.Linq; -using System.Net; -using System.Threading; -using System.Threading.Tasks; - -namespace MediaBrowser.Providers.ImagesByName -{ - public class GameGenreImageProvider : BaseMetadataProvider - { - private readonly IProviderManager _providerManager; - private readonly SemaphoreSlim _resourcePool = new SemaphoreSlim(5, 5); - - public GameGenreImageProvider(ILogManager logManager, IServerConfigurationManager configurationManager, IProviderManager providerManager) - : base(logManager, configurationManager) - { - _providerManager = providerManager; - } - - public override bool Supports(BaseItem item) - { - return item is GameGenre; - } - - public override bool RequiresInternet - { - get - { - return true; - } - } - - public override ItemUpdateType ItemUpdateType - { - get - { - return ItemUpdateType.ImageUpdate; - } - } - - protected override bool NeedsRefreshInternal(BaseItem item, BaseProviderInfo providerInfo) - { - if (item.HasImage(ImageType.Primary) && item.HasImage(ImageType.Thumb)) - { - return false; - } - - // Try again periodically in case new images were added - if ((DateTime.UtcNow - providerInfo.LastRefreshed).TotalDays > 7) - { - return true; - } - - return base.NeedsRefreshInternal(item, providerInfo); - } - - protected override bool RefreshOnVersionChange - { - get - { - return true; - } - } - - protected override string ProviderVersion - { - get - { - return "8"; - } - } - - public override async Task<bool> FetchAsync(BaseItem item, bool force, BaseProviderInfo providerInfo, CancellationToken cancellationToken) - { - if (item.HasImage(ImageType.Primary) && item.HasImage(ImageType.Thumb)) - { - SetLastRefreshed(item, DateTime.UtcNow, providerInfo); - return true; - } - - var images = await _providerManager.GetAvailableRemoteImages(item, cancellationToken, GameGenresManualImageProvider.ProviderName).ConfigureAwait(false); - - await DownloadImages(item, images.ToList(), cancellationToken).ConfigureAwait(false); - - SetLastRefreshed(item, DateTime.UtcNow, providerInfo); - return true; - } - - private async Task DownloadImages(BaseItem item, List<RemoteImageInfo> images, CancellationToken cancellationToken) - { - if (!item.LockedFields.Contains(MetadataFields.Images)) - { - cancellationToken.ThrowIfCancellationRequested(); - - if (!item.HasImage(ImageType.Primary)) - { - await SaveImage(item, images, ImageType.Primary, cancellationToken).ConfigureAwait(false); - } - cancellationToken.ThrowIfCancellationRequested(); - - if (!item.HasImage(ImageType.Thumb)) - { - await SaveImage(item, images, ImageType.Thumb, cancellationToken).ConfigureAwait(false); - } - } - - if (!item.LockedFields.Contains(MetadataFields.Backdrops)) - { - cancellationToken.ThrowIfCancellationRequested(); - - if (item.BackdropImagePaths.Count == 0) - { - foreach (var image in images.Where(i => i.Type == ImageType.Backdrop)) - { - await _providerManager.SaveImage(item, image.Url, _resourcePool, ImageType.Backdrop, null, cancellationToken) - .ConfigureAwait(false); - - break; - } - } - } - } - - - private async Task SaveImage(BaseItem item, IEnumerable<RemoteImageInfo> images, ImageType type, CancellationToken cancellationToken) - { - foreach (var image in images.Where(i => i.Type == type)) - { - try - { - await _providerManager.SaveImage(item, image.Url, _resourcePool, type, null, cancellationToken).ConfigureAwait(false); - break; - } - catch (HttpException ex) - { - // Sometimes fanart has bad url's in their xml - if (ex.StatusCode.HasValue && ex.StatusCode.Value == HttpStatusCode.NotFound) - { - continue; - } - break; - } - } - } - - public override MetadataProviderPriority Priority - { - get { return MetadataProviderPriority.Third; } - } - } -} diff --git a/MediaBrowser.Providers/ImagesByName/GenreImageProvider.cs b/MediaBrowser.Providers/ImagesByName/GenreImageProvider.cs deleted file mode 100644 index 5744ef5fa..000000000 --- a/MediaBrowser.Providers/ImagesByName/GenreImageProvider.cs +++ /dev/null @@ -1,160 +0,0 @@ -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 MediaBrowser.Model.Net; -using MediaBrowser.Model.Providers; -using System; -using System.Collections.Generic; -using System.Linq; -using System.Net; -using System.Threading; -using System.Threading.Tasks; - -namespace MediaBrowser.Providers.ImagesByName -{ - public class GenreImageProvider : BaseMetadataProvider - { - private readonly IProviderManager _providerManager; - private readonly SemaphoreSlim _resourcePool = new SemaphoreSlim(5, 5); - - public GenreImageProvider(ILogManager logManager, IServerConfigurationManager configurationManager, IProviderManager providerManager) - : base(logManager, configurationManager) - { - _providerManager = providerManager; - } - - public override bool Supports(BaseItem item) - { - return item is Genre; - } - - public override bool RequiresInternet - { - get - { - return true; - } - } - - public override ItemUpdateType ItemUpdateType - { - get - { - return ItemUpdateType.ImageUpdate; - } - } - - protected override bool NeedsRefreshInternal(BaseItem item, BaseProviderInfo providerInfo) - { - if (item.HasImage(ImageType.Primary) && item.HasImage(ImageType.Thumb)) - { - return false; - } - - // Try again periodically in case new images were added - if ((DateTime.UtcNow - providerInfo.LastRefreshed).TotalDays > 7) - { - return true; - } - - return base.NeedsRefreshInternal(item, providerInfo); - } - - protected override bool RefreshOnVersionChange - { - get - { - return true; - } - } - - protected override string ProviderVersion - { - get - { - return "8"; - } - } - - public override async Task<bool> FetchAsync(BaseItem item, bool force, BaseProviderInfo providerInfo, CancellationToken cancellationToken) - { - if (item.HasImage(ImageType.Primary) && item.HasImage(ImageType.Thumb)) - { - SetLastRefreshed(item, DateTime.UtcNow, providerInfo); - return true; - } - - var images = await _providerManager.GetAvailableRemoteImages(item, cancellationToken, GenresManualImageProvider.ProviderName).ConfigureAwait(false); - - await DownloadImages(item, images.ToList(), cancellationToken).ConfigureAwait(false); - - SetLastRefreshed(item, DateTime.UtcNow, providerInfo); - return true; - } - - private async Task DownloadImages(BaseItem item, List<RemoteImageInfo> images, CancellationToken cancellationToken) - { - if (!item.LockedFields.Contains(MetadataFields.Images)) - { - cancellationToken.ThrowIfCancellationRequested(); - - if (!item.HasImage(ImageType.Primary)) - { - await SaveImage(item, images, ImageType.Primary, cancellationToken).ConfigureAwait(false); - } - cancellationToken.ThrowIfCancellationRequested(); - - if (!item.HasImage(ImageType.Thumb)) - { - await SaveImage(item, images, ImageType.Thumb, cancellationToken).ConfigureAwait(false); - } - } - - if (!item.LockedFields.Contains(MetadataFields.Backdrops)) - { - cancellationToken.ThrowIfCancellationRequested(); - - if (item.BackdropImagePaths.Count == 0) - { - foreach (var image in images.Where(i => i.Type == ImageType.Backdrop)) - { - await _providerManager.SaveImage(item, image.Url, _resourcePool, ImageType.Backdrop, null, cancellationToken) - .ConfigureAwait(false); - - break; - } - } - } - } - - - private async Task SaveImage(BaseItem item, IEnumerable<RemoteImageInfo> images, ImageType type, CancellationToken cancellationToken) - { - foreach (var image in images.Where(i => i.Type == type)) - { - try - { - await _providerManager.SaveImage(item, image.Url, _resourcePool, type, null, cancellationToken).ConfigureAwait(false); - break; - } - catch (HttpException ex) - { - // Sometimes fanart has bad url's in their xml - if (ex.StatusCode.HasValue && ex.StatusCode.Value == HttpStatusCode.NotFound) - { - continue; - } - break; - } - } - } - - public override MetadataProviderPriority Priority - { - get { return MetadataProviderPriority.Third; } - } - } -} diff --git a/MediaBrowser.Providers/ImagesByName/MusicGenreImageProvider.cs b/MediaBrowser.Providers/ImagesByName/MusicGenreImageProvider.cs deleted file mode 100644 index 5b05a7b63..000000000 --- a/MediaBrowser.Providers/ImagesByName/MusicGenreImageProvider.cs +++ /dev/null @@ -1,161 +0,0 @@ -using MediaBrowser.Controller.Configuration; -using MediaBrowser.Controller.Entities; -using MediaBrowser.Controller.Entities.Audio; -using MediaBrowser.Controller.Library; -using MediaBrowser.Controller.Providers; -using MediaBrowser.Model.Entities; -using MediaBrowser.Model.Logging; -using MediaBrowser.Model.Net; -using MediaBrowser.Model.Providers; -using System; -using System.Collections.Generic; -using System.Linq; -using System.Net; -using System.Threading; -using System.Threading.Tasks; - -namespace MediaBrowser.Providers.ImagesByName -{ - public class MusicGenreImageProvider : BaseMetadataProvider - { - private readonly IProviderManager _providerManager; - private readonly SemaphoreSlim _resourcePool = new SemaphoreSlim(5, 5); - - public MusicGenreImageProvider(ILogManager logManager, IServerConfigurationManager configurationManager, IProviderManager providerManager) - : base(logManager, configurationManager) - { - _providerManager = providerManager; - } - - public override bool Supports(BaseItem item) - { - return item is MusicGenre; - } - - public override bool RequiresInternet - { - get - { - return true; - } - } - - public override ItemUpdateType ItemUpdateType - { - get - { - return ItemUpdateType.ImageUpdate; - } - } - - protected override bool NeedsRefreshInternal(BaseItem item, BaseProviderInfo providerInfo) - { - if (item.HasImage(ImageType.Primary) && item.HasImage(ImageType.Thumb)) - { - return false; - } - - // Try again periodically in case new images were added - if ((DateTime.UtcNow - providerInfo.LastRefreshed).TotalDays > 7) - { - return true; - } - - return base.NeedsRefreshInternal(item, providerInfo); - } - - protected override bool RefreshOnVersionChange - { - get - { - return true; - } - } - - protected override string ProviderVersion - { - get - { - return "8"; - } - } - - public override async Task<bool> FetchAsync(BaseItem item, bool force, BaseProviderInfo providerInfo, CancellationToken cancellationToken) - { - if (item.HasImage(ImageType.Primary) && item.HasImage(ImageType.Thumb)) - { - SetLastRefreshed(item, DateTime.UtcNow, providerInfo); - return true; - } - - var images = await _providerManager.GetAvailableRemoteImages(item, cancellationToken, MusicGenresManualImageProvider.ProviderName).ConfigureAwait(false); - - await DownloadImages(item, images.ToList(), cancellationToken).ConfigureAwait(false); - - SetLastRefreshed(item, DateTime.UtcNow, providerInfo); - return true; - } - - private async Task DownloadImages(BaseItem item, List<RemoteImageInfo> images, CancellationToken cancellationToken) - { - if (!item.LockedFields.Contains(MetadataFields.Images)) - { - cancellationToken.ThrowIfCancellationRequested(); - - if (!item.HasImage(ImageType.Primary)) - { - await SaveImage(item, images, ImageType.Primary, cancellationToken).ConfigureAwait(false); - } - cancellationToken.ThrowIfCancellationRequested(); - - if (!item.HasImage(ImageType.Thumb)) - { - await SaveImage(item, images, ImageType.Thumb, cancellationToken).ConfigureAwait(false); - } - } - - if (!item.LockedFields.Contains(MetadataFields.Backdrops)) - { - cancellationToken.ThrowIfCancellationRequested(); - - if (item.BackdropImagePaths.Count == 0) - { - foreach (var image in images.Where(i => i.Type == ImageType.Backdrop)) - { - await _providerManager.SaveImage(item, image.Url, _resourcePool, ImageType.Backdrop, null, cancellationToken) - .ConfigureAwait(false); - - break; - } - } - } - } - - - private async Task SaveImage(BaseItem item, IEnumerable<RemoteImageInfo> images, ImageType type, CancellationToken cancellationToken) - { - foreach (var image in images.Where(i => i.Type == type)) - { - try - { - await _providerManager.SaveImage(item, image.Url, _resourcePool, type, null, cancellationToken).ConfigureAwait(false); - break; - } - catch (HttpException ex) - { - // Sometimes fanart has bad url's in their xml - if (ex.StatusCode.HasValue && ex.StatusCode.Value == HttpStatusCode.NotFound) - { - continue; - } - break; - } - } - } - - public override MetadataProviderPriority Priority - { - get { return MetadataProviderPriority.Third; } - } - } -} diff --git a/MediaBrowser.Providers/ImagesByName/StudioImageProvider.cs b/MediaBrowser.Providers/ImagesByName/StudioImageProvider.cs deleted file mode 100644 index 3035b6014..000000000 --- a/MediaBrowser.Providers/ImagesByName/StudioImageProvider.cs +++ /dev/null @@ -1,160 +0,0 @@ -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 MediaBrowser.Model.Net; -using MediaBrowser.Model.Providers; -using System; -using System.Collections.Generic; -using System.Linq; -using System.Net; -using System.Threading; -using System.Threading.Tasks; - -namespace MediaBrowser.Providers.ImagesByName -{ - public class StudioImageProvider : BaseMetadataProvider - { - private readonly IProviderManager _providerManager; - private readonly SemaphoreSlim _resourcePool = new SemaphoreSlim(5, 5); - - public StudioImageProvider(ILogManager logManager, IServerConfigurationManager configurationManager, IProviderManager providerManager) - : base(logManager, configurationManager) - { - _providerManager = providerManager; - } - - public override bool Supports(BaseItem item) - { - return item is Studio; - } - - public override bool RequiresInternet - { - get - { - return true; - } - } - - public override ItemUpdateType ItemUpdateType - { - get - { - return ItemUpdateType.ImageUpdate; - } - } - - protected override bool NeedsRefreshInternal(BaseItem item, BaseProviderInfo providerInfo) - { - if (item.HasImage(ImageType.Primary) && item.HasImage(ImageType.Thumb)) - { - return false; - } - - // Try again periodically in case new images were added - if ((DateTime.UtcNow - providerInfo.LastRefreshed).TotalDays > 7) - { - return true; - } - - return base.NeedsRefreshInternal(item, providerInfo); - } - - protected override bool RefreshOnVersionChange - { - get - { - return true; - } - } - - protected override string ProviderVersion - { - get - { - return "6"; - } - } - - public override async Task<bool> FetchAsync(BaseItem item, bool force, BaseProviderInfo providerInfo, CancellationToken cancellationToken) - { - if (item.HasImage(ImageType.Primary) && item.HasImage(ImageType.Thumb)) - { - SetLastRefreshed(item, DateTime.UtcNow, providerInfo); - return true; - } - - var images = await _providerManager.GetAvailableRemoteImages(item, cancellationToken, StudiosManualImageProvider.ProviderName).ConfigureAwait(false); - - await DownloadImages(item, images.ToList(), cancellationToken).ConfigureAwait(false); - - SetLastRefreshed(item, DateTime.UtcNow, providerInfo); - return true; - } - - private async Task DownloadImages(BaseItem item, List<RemoteImageInfo> images, CancellationToken cancellationToken) - { - if (!item.LockedFields.Contains(MetadataFields.Images)) - { - cancellationToken.ThrowIfCancellationRequested(); - - if (!item.HasImage(ImageType.Primary)) - { - await SaveImage(item, images, ImageType.Primary, cancellationToken).ConfigureAwait(false); - } - cancellationToken.ThrowIfCancellationRequested(); - - if (!item.HasImage(ImageType.Thumb)) - { - await SaveImage(item, images, ImageType.Thumb, cancellationToken).ConfigureAwait(false); - } - } - - if (!item.LockedFields.Contains(MetadataFields.Backdrops)) - { - cancellationToken.ThrowIfCancellationRequested(); - - if (item.BackdropImagePaths.Count == 0) - { - foreach (var image in images.Where(i => i.Type == ImageType.Backdrop)) - { - await _providerManager.SaveImage(item, image.Url, _resourcePool, ImageType.Backdrop, null, cancellationToken) - .ConfigureAwait(false); - - break; - } - } - } - } - - - private async Task SaveImage(BaseItem item, IEnumerable<RemoteImageInfo> images, ImageType type, CancellationToken cancellationToken) - { - foreach (var image in images.Where(i => i.Type == type)) - { - try - { - await _providerManager.SaveImage(item, image.Url, _resourcePool, type, null, cancellationToken).ConfigureAwait(false); - break; - } - catch (HttpException ex) - { - // Sometimes fanart has bad url's in their xml - if (ex.StatusCode.HasValue && ex.StatusCode.Value == HttpStatusCode.NotFound) - { - continue; - } - break; - } - } - } - - public override MetadataProviderPriority Priority - { - get { return MetadataProviderPriority.Third; } - } - } -} diff --git a/MediaBrowser.Providers/Manager/ImageSaver.cs b/MediaBrowser.Providers/Manager/ImageSaver.cs new file mode 100644 index 000000000..a75ce88ae --- /dev/null +++ b/MediaBrowser.Providers/Manager/ImageSaver.cs @@ -0,0 +1,598 @@ +using MediaBrowser.Common.IO; +using MediaBrowser.Controller.Configuration; +using MediaBrowser.Controller.Entities; +using MediaBrowser.Controller.Entities.Audio; +using MediaBrowser.Controller.Entities.TV; +using MediaBrowser.Controller.IO; +using MediaBrowser.Model.Configuration; +using MediaBrowser.Model.Entities; +using MediaBrowser.Model.Logging; +using System; +using System.Collections.Generic; +using System.Globalization; +using System.IO; +using System.Linq; +using System.Threading; +using System.Threading.Tasks; + +namespace MediaBrowser.Providers.Manager +{ + /// <summary> + /// Class ImageSaver + /// </summary> + public class ImageSaver + { + private static readonly CultureInfo UsCulture = new CultureInfo("en-US"); + + /// <summary> + /// The _config + /// </summary> + private readonly IServerConfigurationManager _config; + + /// <summary> + /// The remote image cache + /// </summary> + private readonly FileSystemRepository _remoteImageCache; + /// <summary> + /// The _directory watchers + /// </summary> + private readonly IDirectoryWatchers _directoryWatchers; + private readonly IFileSystem _fileSystem; + private readonly ILogger _logger; + + /// <summary> + /// Initializes a new instance of the <see cref="ImageSaver"/> class. + /// </summary> + /// <param name="config">The config.</param> + /// <param name="directoryWatchers">The directory watchers.</param> + public ImageSaver(IServerConfigurationManager config, IDirectoryWatchers directoryWatchers, IFileSystem fileSystem, ILogger logger) + { + _config = config; + _directoryWatchers = directoryWatchers; + _fileSystem = fileSystem; + _logger = logger; + _remoteImageCache = new FileSystemRepository(config.ApplicationPaths.DownloadedImagesDataPath); + } + + /// <summary> + /// Saves the image. + /// </summary> + /// <param name="item">The item.</param> + /// <param name="source">The source.</param> + /// <param name="mimeType">Type of the MIME.</param> + /// <param name="type">The type.</param> + /// <param name="imageIndex">Index of the image.</param> + /// <param name="sourceUrl">The source URL.</param> + /// <param name="cancellationToken">The cancellation token.</param> + /// <returns>Task.</returns> + /// <exception cref="System.ArgumentNullException">mimeType</exception> + public async Task SaveImage(BaseItem item, Stream source, string mimeType, ImageType type, int? imageIndex, string sourceUrl, CancellationToken cancellationToken) + { + if (string.IsNullOrEmpty(mimeType)) + { + throw new ArgumentNullException("mimeType"); + } + + var saveLocally = item.IsSaveLocalMetadataEnabled() && item.Parent != null && !(item is Audio); + + if (item is IItemByName || item is User) + { + saveLocally = true; + } + + if (type != ImageType.Primary && item is Episode) + { + saveLocally = false; + } + + var locationType = item.LocationType; + if (locationType == LocationType.Remote || locationType == LocationType.Virtual) + { + saveLocally = false; + + var season = item as Season; + + // If season is virtual under a physical series, save locally if using compatible convention + if (season != null && _config.Configuration.ImageSavingConvention == ImageSavingConvention.Compatible) + { + var series = season.Series; + + if (series != null) + { + var seriesLocationType = series.LocationType; + if (seriesLocationType == LocationType.FileSystem || seriesLocationType == LocationType.Offline) + { + saveLocally = true; + } + } + } + } + + if (type == ImageType.Backdrop && imageIndex == null) + { + imageIndex = item.BackdropImagePaths.Count; + } + else if (type == ImageType.Screenshot && imageIndex == null) + { + var hasScreenshots = (IHasScreenshots)item; + imageIndex = hasScreenshots.ScreenshotImagePaths.Count; + } + + var index = imageIndex ?? 0; + + var paths = GetSavePaths(item, type, imageIndex, mimeType, saveLocally); + + // If there are more than one output paths, the stream will need to be seekable + if (paths.Length > 1 && !source.CanSeek) + { + var memoryStream = new MemoryStream(); + using (source) + { + await source.CopyToAsync(memoryStream).ConfigureAwait(false); + } + memoryStream.Position = 0; + source = memoryStream; + } + + var currentPath = GetCurrentImagePath(item, type, index); + + using (source) + { + var isFirst = true; + + foreach (var path in paths) + { + // Seek back to the beginning + if (!isFirst) + { + source.Position = 0; + } + + await SaveImageToLocation(source, path, cancellationToken).ConfigureAwait(false); + + isFirst = false; + } + } + + // Set the path into the item + SetImagePath(item, type, imageIndex, paths[0], sourceUrl); + + // Delete the current path + if (!string.IsNullOrEmpty(currentPath) && !paths.Contains(currentPath, StringComparer.OrdinalIgnoreCase)) + { + _directoryWatchers.TemporarilyIgnore(currentPath); + + try + { + var currentFile = new FileInfo(currentPath); + + // This will fail if the file is hidden + if (currentFile.Exists) + { + if ((currentFile.Attributes & FileAttributes.Hidden) == FileAttributes.Hidden) + { + currentFile.Attributes &= ~FileAttributes.Hidden; + } + + currentFile.Delete(); + } + } + finally + { + _directoryWatchers.RemoveTempIgnore(currentPath); + } + } + } + + /// <summary> + /// Saves the image to location. + /// </summary> + /// <param name="source">The source.</param> + /// <param name="path">The path.</param> + /// <param name="cancellationToken">The cancellation token.</param> + /// <returns>Task.</returns> + private async Task SaveImageToLocation(Stream source, string path, CancellationToken cancellationToken) + { + _logger.Debug("Saving image to {0}", path); + + var parentFolder = Path.GetDirectoryName(path); + + _directoryWatchers.TemporarilyIgnore(path); + _directoryWatchers.TemporarilyIgnore(parentFolder); + + try + { + Directory.CreateDirectory(Path.GetDirectoryName(path)); + + // If the file is currently hidden we'll have to remove that or the save will fail + var file = new FileInfo(path); + + // This will fail if the file is hidden + if (file.Exists) + { + if ((file.Attributes & FileAttributes.Hidden) == FileAttributes.Hidden) + { + file.Attributes &= ~FileAttributes.Hidden; + } + } + + using (var fs = _fileSystem.GetFileStream(path, FileMode.Create, FileAccess.Write, FileShare.Read, true)) + { + await source.CopyToAsync(fs, StreamDefaults.DefaultCopyToBufferSize, cancellationToken).ConfigureAwait(false); + } + } + finally + { + _directoryWatchers.RemoveTempIgnore(path); + _directoryWatchers.RemoveTempIgnore(parentFolder); + } + } + + /// <summary> + /// Gets the save paths. + /// </summary> + /// <param name="item">The item.</param> + /// <param name="type">The type.</param> + /// <param name="imageIndex">Index of the image.</param> + /// <param name="mimeType">Type of the MIME.</param> + /// <param name="saveLocally">if set to <c>true</c> [save locally].</param> + /// <returns>IEnumerable{System.String}.</returns> + private string[] GetSavePaths(BaseItem item, ImageType type, int? imageIndex, string mimeType, bool saveLocally) + { + if (_config.Configuration.ImageSavingConvention == ImageSavingConvention.Legacy || !saveLocally) + { + return new[] { GetStandardSavePath(item, type, imageIndex, mimeType, saveLocally) }; + } + + return GetCompatibleSavePaths(item, type, imageIndex, mimeType); + } + + /// <summary> + /// Gets the current image path. + /// </summary> + /// <param name="item">The item.</param> + /// <param name="type">The type.</param> + /// <param name="imageIndex">Index of the image.</param> + /// <returns>System.String.</returns> + /// <exception cref="System.ArgumentNullException"> + /// imageIndex + /// or + /// imageIndex + /// </exception> + private string GetCurrentImagePath(IHasImages item, ImageType type, int imageIndex) + { + return item.GetImagePath(type, imageIndex); + } + + /// <summary> + /// Sets the image path. + /// </summary> + /// <param name="item">The item.</param> + /// <param name="type">The type.</param> + /// <param name="imageIndex">Index of the image.</param> + /// <param name="path">The path.</param> + /// <param name="sourceUrl">The source URL.</param> + /// <exception cref="System.ArgumentNullException">imageIndex + /// or + /// imageIndex</exception> + private void SetImagePath(BaseItem item, ImageType type, int? imageIndex, string path, string sourceUrl) + { + switch (type) + { + case ImageType.Screenshot: + + if (!imageIndex.HasValue) + { + throw new ArgumentNullException("imageIndex"); + } + + var hasScreenshots = (IHasScreenshots)item; + if (hasScreenshots.ScreenshotImagePaths.Count > imageIndex.Value) + { + hasScreenshots.ScreenshotImagePaths[imageIndex.Value] = path; + } + else if (!hasScreenshots.ScreenshotImagePaths.Contains(path, StringComparer.OrdinalIgnoreCase)) + { + hasScreenshots.ScreenshotImagePaths.Add(path); + } + break; + case ImageType.Backdrop: + if (!imageIndex.HasValue) + { + throw new ArgumentNullException("imageIndex"); + } + if (item.BackdropImagePaths.Count > imageIndex.Value) + { + item.BackdropImagePaths[imageIndex.Value] = path; + } + else if (!item.BackdropImagePaths.Contains(path, StringComparer.OrdinalIgnoreCase)) + { + item.BackdropImagePaths.Add(path); + } + + if (string.IsNullOrEmpty(sourceUrl)) + { + item.RemoveImageSourceForPath(path); + } + else + { + item.AddImageSource(path, sourceUrl); + } + break; + default: + item.SetImagePath(type, path); + break; + } + } + + /// <summary> + /// Gets the save path. + /// </summary> + /// <param name="item">The item.</param> + /// <param name="type">The type.</param> + /// <param name="imageIndex">Index of the image.</param> + /// <param name="mimeType">Type of the MIME.</param> + /// <param name="saveLocally">if set to <c>true</c> [save locally].</param> + /// <returns>System.String.</returns> + /// <exception cref="System.ArgumentNullException"> + /// imageIndex + /// or + /// imageIndex + /// </exception> + private string GetStandardSavePath(BaseItem item, ImageType type, int? imageIndex, string mimeType, bool saveLocally) + { + string filename; + + switch (type) + { + case ImageType.Art: + filename = "clearart"; + break; + case ImageType.Disc: + filename = item is MusicAlbum ? "cdart" : "disc"; + break; + case ImageType.Primary: + filename = item is Episode ? Path.GetFileNameWithoutExtension(item.Path) : "folder"; + break; + case ImageType.Backdrop: + if (!imageIndex.HasValue) + { + throw new ArgumentNullException("imageIndex"); + } + filename = GetBackdropSaveFilename(item.BackdropImagePaths, "backdrop", "backdrop", imageIndex.Value); + break; + case ImageType.Screenshot: + if (!imageIndex.HasValue) + { + throw new ArgumentNullException("imageIndex"); + } + var hasScreenshots = (IHasScreenshots)item; + filename = GetBackdropSaveFilename(hasScreenshots.ScreenshotImagePaths, "screenshot", "screenshot", imageIndex.Value); + break; + default: + filename = type.ToString().ToLower(); + break; + } + + var extension = mimeType.Split('/').Last(); + + if (string.Equals(extension, "jpeg", StringComparison.OrdinalIgnoreCase)) + { + extension = "jpg"; + } + + extension = "." + extension.ToLower(); + + string path = null; + + if (saveLocally) + { + if (item.IsInMixedFolder && !(item is Episode)) + { + path = GetSavePathForItemInMixedFolder(item, type, filename, extension); + } + + if (string.IsNullOrEmpty(path)) + { + path = Path.Combine(item.MetaLocation, filename + extension); + } + } + + // None of the save local conditions passed, so store it in our internal folders + if (string.IsNullOrEmpty(path)) + { + path = _remoteImageCache.GetResourcePath(item.GetType().FullName + item.Id, filename + extension); + } + + return path; + } + + private string GetBackdropSaveFilename(IEnumerable<string> images, string zeroIndexFilename, string numberedIndexPrefix, int index) + { + if (index == 0) + { + return zeroIndexFilename; + } + + var filenames = images.Select(Path.GetFileNameWithoutExtension).ToList(); + + var current = index; + while (filenames.Contains(numberedIndexPrefix + current.ToString(UsCulture), StringComparer.OrdinalIgnoreCase)) + { + current++; + } + + return numberedIndexPrefix + current.ToString(UsCulture); + } + + /// <summary> + /// Gets the compatible save paths. + /// </summary> + /// <param name="item">The item.</param> + /// <param name="type">The type.</param> + /// <param name="imageIndex">Index of the image.</param> + /// <param name="mimeType">Type of the MIME.</param> + /// <returns>IEnumerable{System.String}.</returns> + /// <exception cref="System.ArgumentNullException">imageIndex</exception> + private string[] GetCompatibleSavePaths(BaseItem item, ImageType type, int? imageIndex, string mimeType) + { + var season = item as Season; + + var extension = mimeType.Split('/').Last(); + + if (string.Equals(extension, "jpeg", StringComparison.OrdinalIgnoreCase)) + { + extension = "jpg"; + } + extension = "." + extension.ToLower(); + + // Backdrop paths + if (type == ImageType.Backdrop) + { + if (!imageIndex.HasValue) + { + throw new ArgumentNullException("imageIndex"); + } + + if (imageIndex.Value == 0) + { + if (item.IsInMixedFolder) + { + return new[] { GetSavePathForItemInMixedFolder(item, type, "fanart", extension) }; + } + + if (season != null && item.IndexNumber.HasValue) + { + var seriesFolder = season.SeriesPath; + + var seasonMarker = item.IndexNumber.Value == 0 + ? "-specials" + : item.IndexNumber.Value.ToString("00", UsCulture); + + var imageFilename = "season" + seasonMarker + "-fanart" + extension; + + return new[] { Path.Combine(seriesFolder, imageFilename) }; + } + + return new[] + { + Path.Combine(item.MetaLocation, "fanart" + extension) + }; + } + + var outputIndex = imageIndex.Value; + + if (item.IsInMixedFolder) + { + return new[] { GetSavePathForItemInMixedFolder(item, type, "fanart" + outputIndex.ToString(UsCulture), extension) }; + } + + var extraFanartFilename = GetBackdropSaveFilename(item.BackdropImagePaths, "fanart", "fanart", outputIndex); + + return new[] + { + Path.Combine(item.MetaLocation, "extrafanart", extraFanartFilename + extension), + Path.Combine(item.MetaLocation, "extrathumbs", "thumb" + outputIndex.ToString(UsCulture) + extension) + }; + } + + if (type == ImageType.Primary) + { + if (season != null && item.IndexNumber.HasValue) + { + var seriesFolder = season.SeriesPath; + + var seasonMarker = item.IndexNumber.Value == 0 + ? "-specials" + : item.IndexNumber.Value.ToString("00", UsCulture); + + var imageFilename = "season" + seasonMarker + "-poster" + extension; + + return new[] { Path.Combine(seriesFolder, imageFilename) }; + } + + if (item is Episode) + { + var seasonFolder = Path.GetDirectoryName(item.Path); + + var imageFilename = Path.GetFileNameWithoutExtension(item.Path) + "-thumb" + extension; + + return new[] { Path.Combine(seasonFolder, imageFilename) }; + } + + if (item.IsInMixedFolder || item is MusicVideo) + { + return new[] { GetSavePathForItemInMixedFolder(item, type, string.Empty, extension) }; + } + + if (item is MusicAlbum || item is MusicArtist) + { + return new[] { Path.Combine(item.MetaLocation, "folder" + extension) }; + } + + return new[] { Path.Combine(item.MetaLocation, "poster" + extension) }; + } + + if (type == ImageType.Banner) + { + if (season != null && item.IndexNumber.HasValue) + { + var seriesFolder = season.SeriesPath; + + var seasonMarker = item.IndexNumber.Value == 0 + ? "-specials" + : item.IndexNumber.Value.ToString("00", UsCulture); + + var imageFilename = "season" + seasonMarker + "-banner" + extension; + + return new[] { Path.Combine(seriesFolder, imageFilename) }; + } + } + + if (type == ImageType.Thumb) + { + if (season != null && item.IndexNumber.HasValue) + { + var seriesFolder = season.SeriesPath; + + var seasonMarker = item.IndexNumber.Value == 0 + ? "-specials" + : item.IndexNumber.Value.ToString("00", UsCulture); + + var imageFilename = "season" + seasonMarker + "-landscape" + extension; + + return new[] { Path.Combine(seriesFolder, imageFilename) }; + } + + if (item.IsInMixedFolder) + { + return new[] { GetSavePathForItemInMixedFolder(item, type, "landscape", extension) }; + } + + return new[] { Path.Combine(item.MetaLocation, "landscape" + extension) }; + } + + // All other paths are the same + return new[] { GetStandardSavePath(item, type, imageIndex, mimeType, true) }; + } + + /// <summary> + /// Gets the save path for item in mixed folder. + /// </summary> + /// <param name="item">The item.</param> + /// <param name="type">The type.</param> + /// <param name="imageFilename">The image filename.</param> + /// <param name="extension">The extension.</param> + /// <returns>System.String.</returns> + private string GetSavePathForItemInMixedFolder(IHasImages item, ImageType type, string imageFilename, string extension) + { + if (type == ImageType.Primary) + { + imageFilename = "poster"; + } + var folder = Path.GetDirectoryName(item.Path); + + return Path.Combine(folder, Path.GetFileNameWithoutExtension(item.Path) + "-" + imageFilename + extension); + } + } +} diff --git a/MediaBrowser.Providers/Manager/ItemImageProvider.cs b/MediaBrowser.Providers/Manager/ItemImageProvider.cs new file mode 100644 index 000000000..5358506f0 --- /dev/null +++ b/MediaBrowser.Providers/Manager/ItemImageProvider.cs @@ -0,0 +1,431 @@ +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 MediaBrowser.Model.Net; +using MediaBrowser.Model.Providers; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Net; +using System.Threading; +using System.Threading.Tasks; + +namespace MediaBrowser.Providers.Manager +{ + public class ItemImageProvider + { + private readonly ILogger _logger; + private readonly IProviderManager _providerManager; + private readonly IServerConfigurationManager _config; + + public ItemImageProvider(ILogger logger, IProviderManager providerManager, IServerConfigurationManager config) + { + _logger = logger; + _providerManager = providerManager; + _config = config; + } + + public bool ValidateImages(IHasImages item, IEnumerable<IImageProvider> providers) + { + var hasChanges = item.ValidateImages(); + + foreach (var provider in providers.OfType<IImageFileProvider>()) + { + var images = provider.GetImages(item); + + if (MergeImages(item, images)) + { + hasChanges = true; + } + } + + return hasChanges; + } + + public async Task<RefreshResult> RefreshImages(IHasImages item, IEnumerable<IImageProvider> imageProviders, ImageRefreshOptions options, CancellationToken cancellationToken) + { + var result = new RefreshResult { UpdateType = ItemUpdateType.Unspecified }; + + var providers = GetImageProviders(item, imageProviders).ToList(); + + foreach (var provider in providers.OfType<IRemoteImageProvider>()) + { + await RefreshFromProvider(item, provider, options, result, cancellationToken).ConfigureAwait(false); + } + + foreach (var provider in providers.OfType<IDynamicImageProvider>()) + { + await RefreshFromProvider(item, provider, result, cancellationToken).ConfigureAwait(false); + } + + return result; + } + + /// <summary> + /// Refreshes from provider. + /// </summary> + /// <param name="item">The item.</param> + /// <param name="provider">The provider.</param> + /// <param name="result">The result.</param> + /// <param name="cancellationToken">The cancellation token.</param> + /// <returns>Task.</returns> + private async Task RefreshFromProvider(IHasImages item, IDynamicImageProvider provider, RefreshResult result, CancellationToken cancellationToken) + { + _logger.Debug("Running {0} for {1}", provider.GetType().Name, item.Path ?? item.Name); + + try + { + var images = provider.GetImageInfos(item); + + foreach (var image in images) + { + if (!item.HasImage(image.Type)) + { + var imageSource = await provider.GetImage(item, image).ConfigureAwait(false); + + // See if the provider returned an image path or a stream + if (!string.IsNullOrEmpty(imageSource.Path)) + { + item.SetImagePath(image.Type, imageSource.Path); + } + else + { + var mimeType = "image/" + imageSource.Format.ToString().ToLower(); + + await _providerManager.SaveImage((BaseItem)item, imageSource.Stream, mimeType, image.Type, null, Guid.NewGuid().ToString(), cancellationToken).ConfigureAwait(false); + } + + result.UpdateType = result.UpdateType | ItemUpdateType.ImageUpdate; + } + } + } + catch (OperationCanceledException) + { + throw; + } + catch (Exception ex) + { + result.ErrorMessage = ex.Message; + result.Status = ProviderRefreshStatus.CompletedWithErrors; + _logger.ErrorException("Error in {0}", ex, provider.Name); + } + } + + /// <summary> + /// Image types that are only one per item + /// </summary> + private readonly ImageType[] _singularImages = + { + ImageType.Primary, + ImageType.Art, + ImageType.Banner, + ImageType.Box, + ImageType.BoxRear, + ImageType.Disc, + ImageType.Logo, + ImageType.Menu, + ImageType.Thumb + }; + + /// <summary> + /// Determines if an item already contains the given images + /// </summary> + /// <param name="item"></param> + /// <param name="images"></param> + /// <returns></returns> + private bool ContainsImages(IHasImages item, List<ImageType> images) + { + if (_singularImages.Any(i => images.Contains(i) && !item.HasImage(i))) + { + return false; + } + + if (images.Contains(ImageType.Backdrop) && item.BackdropImagePaths.Count < GetMaxBackdropCount(item)) + { + return false; + } + + if (images.Contains(ImageType.Screenshot)) + { + var hasScreenshots = item as IHasScreenshots; + if (hasScreenshots != null) + { + if (hasScreenshots.ScreenshotImagePaths.Count < GetMaxBackdropCount(item)) + { + return false; + } + } + } + + return true; + } + + /// <summary> + /// Refreshes from provider. + /// </summary> + /// <param name="item">The item.</param> + /// <param name="provider">The provider.</param> + /// <param name="options">The options.</param> + /// <param name="result">The result.</param> + /// <param name="cancellationToken">The cancellation token.</param> + /// <returns>Task.</returns> + private async Task RefreshFromProvider(IHasImages item, IRemoteImageProvider provider, ImageRefreshOptions options, RefreshResult result, CancellationToken cancellationToken) + { + try + { + // TODO: Also factor in IsConfiguredToDownloadImage + if (ContainsImages(item, provider.GetSupportedImages(item).ToList())) + { + return; + } + + _logger.Debug("Running {0} for {1}", provider.GetType().Name, item.Path ?? item.Name); + + var images = await provider.GetAllImages(item, cancellationToken).ConfigureAwait(false); + var list = images.ToList(); + + foreach (var type in _singularImages) + { + if (IsConfiguredToDownloadImage(item, type) && !item.HasImage(type)) + { + await DownloadImage(item, provider, result, list, type, cancellationToken).ConfigureAwait(false); + } + } + + await DownloadBackdrops(item, provider, result, list, cancellationToken).ConfigureAwait(false); + + var hasScreenshots = item as IHasScreenshots; + if (hasScreenshots != null) + { + await DownloadScreenshots(hasScreenshots, provider, result, list, cancellationToken).ConfigureAwait(false); + } + } + catch (OperationCanceledException) + { + throw; + } + catch (Exception ex) + { + result.ErrorMessage = ex.Message; + result.Status = ProviderRefreshStatus.CompletedWithErrors; + _logger.ErrorException("Error in {0}", ex, provider.Name); + } + } + + /// <summary> + /// Gets the image providers. + /// </summary> + /// <param name="item">The item.</param> + /// <param name="imageProviders">The image providers.</param> + /// <returns>IEnumerable{IImageProvider}.</returns> + private IEnumerable<IImageProvider> GetImageProviders(IHasImages item, IEnumerable<IImageProvider> imageProviders) + { + var providers = imageProviders.Where(i => + { + try + { + return i.Supports(item); + } + catch (Exception ex) + { + _logger.ErrorException("Error in ImageProvider.Supports", ex, i.Name); + + return false; + } + }); + + if (!_config.Configuration.EnableInternetProviders) + { + providers = providers.Where(i => !(i is IRemoteImageProvider)); + } + + return providers.OrderBy(i => i.Order); + } + + private bool MergeImages(IHasImages item, List<LocalImageInfo> images) + { + var changed = false; + + foreach (var type in _singularImages) + { + var image = images.FirstOrDefault(i => i.Type == type); + + if (image != null) + { + var oldPath = item.GetImagePath(type); + + item.SetImagePath(type, image.Path); + + if (!string.Equals(oldPath, image.Path, StringComparison.OrdinalIgnoreCase)) + { + changed = true; + } + } + } + + // The change reporting will only be accurate at the count level + // Improve this if/when needed + var backdrops = images.Where(i => i.Type == ImageType.Backdrop).ToList(); + if (backdrops.Count > 0) + { + var oldCount = item.BackdropImagePaths.Count; + + item.BackdropImagePaths = item.BackdropImagePaths + .Concat(backdrops.Select(i => i.Path)) + .Distinct(StringComparer.OrdinalIgnoreCase) + .ToList(); + + if (oldCount != item.BackdropImagePaths.Count) + { + changed = true; + } + } + + var hasScreenshots = item as IHasScreenshots; + if (hasScreenshots != null) + { + var screenshots = images.Where(i => i.Type == ImageType.Screenshot).ToList(); + + if (screenshots.Count > 0) + { + var oldCount = hasScreenshots.ScreenshotImagePaths.Count; + + hasScreenshots.ScreenshotImagePaths = hasScreenshots.ScreenshotImagePaths + .Concat(screenshots.Select(i => i.Path)) + .Distinct(StringComparer.OrdinalIgnoreCase) + .ToList(); + + if (oldCount != hasScreenshots.ScreenshotImagePaths.Count) + { + changed = true; + } + } + } + + return changed; + } + + private async Task DownloadImage(IHasImages item, IRemoteImageProvider provider, RefreshResult result, IEnumerable<RemoteImageInfo> images, ImageType type, CancellationToken cancellationToken) + { + foreach (var image in images.Where(i => i.Type == type)) + { + var url = image.Url; + + try + { + var response = await provider.GetImageResponse(url, cancellationToken).ConfigureAwait(false); + + await _providerManager.SaveImage((BaseItem)item, response.Content, response.ContentType, type, null, url, cancellationToken).ConfigureAwait(false); + + result.UpdateType = result.UpdateType | ItemUpdateType.ImageUpdate; + break; + } + catch (HttpException ex) + { + // Sometimes providers send back bad url's. Just move onto the next image + if (ex.StatusCode.HasValue && ex.StatusCode.Value == HttpStatusCode.NotFound) + { + continue; + } + break; + } + } + } + + private async Task DownloadBackdrops(IHasImages item, IRemoteImageProvider provider, RefreshResult result, IEnumerable<RemoteImageInfo> images, CancellationToken cancellationToken) + { + const ImageType imageType = ImageType.Backdrop; + var maxCount = GetMaxBackdropCount(item); + + foreach (var image in images.Where(i => i.Type == imageType)) + { + if (item.BackdropImagePaths.Count >= maxCount) + { + break; + } + + var url = image.Url; + + if (item.ContainsImageWithSourceUrl(url)) + { + continue; + } + + try + { + var response = await provider.GetImageResponse(url, cancellationToken).ConfigureAwait(false); + + await _providerManager.SaveImage((BaseItem)item, response.Content, response.ContentType, imageType, null, url, cancellationToken).ConfigureAwait(false); + result.UpdateType = result.UpdateType | ItemUpdateType.ImageUpdate; + break; + } + catch (HttpException ex) + { + // Sometimes providers send back bad url's. Just move onto the next image + if (ex.StatusCode.HasValue && ex.StatusCode.Value == HttpStatusCode.NotFound) + { + continue; + } + break; + } + } + } + + private async Task DownloadScreenshots(IHasScreenshots item, IRemoteImageProvider provider, RefreshResult result, IEnumerable<RemoteImageInfo> images, CancellationToken cancellationToken) + { + const ImageType imageType = ImageType.Screenshot; + var maxCount = GetMaxScreenshotCount(item); + + foreach (var image in images.Where(i => i.Type == imageType)) + { + if (item.ScreenshotImagePaths.Count >= maxCount) + { + break; + } + + var url = image.Url; + + if (item.ContainsImageWithSourceUrl(url)) + { + continue; + } + + try + { + var response = await provider.GetImageResponse(url, cancellationToken).ConfigureAwait(false); + + await _providerManager.SaveImage((BaseItem)item, response.Content, response.ContentType, imageType, null, url, cancellationToken).ConfigureAwait(false); + result.UpdateType = result.UpdateType | ItemUpdateType.ImageUpdate; + break; + } + catch (HttpException ex) + { + // Sometimes providers send back bad url's. Just move onto the next image + if (ex.StatusCode.HasValue && ex.StatusCode.Value == HttpStatusCode.NotFound) + { + continue; + } + break; + } + } + } + + private bool IsConfiguredToDownloadImage(IHasImages item, ImageType type) + { + return true; + } + + private int GetMaxBackdropCount(IHasImages item) + { + return 1; + } + + private int GetMaxScreenshotCount(IHasScreenshots item) + { + return 1; + } + } +} diff --git a/MediaBrowser.Providers/Manager/MetadataService.cs b/MediaBrowser.Providers/Manager/MetadataService.cs new file mode 100644 index 000000000..dbe70b93d --- /dev/null +++ b/MediaBrowser.Providers/Manager/MetadataService.cs @@ -0,0 +1,367 @@ +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<TItemType> : IMetadataService + where TItemType : IHasMetadata, new() + { + protected readonly IServerConfigurationManager ServerConfigurationManager; + protected readonly ILogger Logger; + protected readonly IProviderManager ProviderManager; + + private IMetadataProvider<TItemType>[] _providers = { }; + + private IImageProvider[] _imageProviders = { }; + + protected MetadataService(IServerConfigurationManager serverConfigurationManager, ILogger logger, IProviderManager providerManager) + { + ServerConfigurationManager = serverConfigurationManager; + Logger = logger; + ProviderManager = providerManager; + } + + /// <summary> + /// Adds the parts. + /// </summary> + /// <param name="providers">The providers.</param> + /// <param name="imageProviders">The image providers.</param> + public void AddParts(IEnumerable<IMetadataProvider> providers, IEnumerable<IImageProvider> imageProviders) + { + _providers = providers.OfType<IMetadataProvider<TItemType>>() + .OrderBy(GetSortOrder) + .ToArray(); + + _imageProviders = imageProviders.OrderBy(i => i.Order).ToArray(); + } + + /// <summary> + /// Saves the provider result. + /// </summary> + /// <param name="result">The result.</param> + /// <returns>Task.</returns> + protected Task SaveProviderResult(ProviderResult result) + { + return Task.FromResult(true); + } + + /// <summary> + /// Gets the last result. + /// </summary> + /// <param name="itemId">The item identifier.</param> + /// <returns>ProviderResult.</returns> + protected ProviderResult GetLastResult(Guid itemId) + { + return new ProviderResult + { + 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 = new ProviderResult { ItemId = item.Id }; + + var imageProviders = GetImageProviders(item).ToList(); + 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, imageProviders)) + { + 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.HasRefreshedMetadata, 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.HasRefreshedMetadata = true; + } + + // Next run remote image providers, but only if local image providers didn't throw an exception + if (!localImagesFailed) + { + if ((options.ImageRefreshMode == MetadataRefreshMode.EnsureMetadata && !lastResult.HasRefreshedImages) || + options.ImageRefreshMode == MetadataRefreshMode.FullRefresh) + { + var imagesReult = await itemImageProvider.RefreshImages(itemOfType, imageProviders, options, cancellationToken).ConfigureAwait(false); + + updateType = updateType | imagesReult.UpdateType; + refreshResult.AddStatus(imagesReult.Status, imagesReult.ErrorMessage); + refreshResult.HasRefreshedImages = true; + } + } + + 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.DateLastRefreshed = DateTime.UtcNow; + await SaveProviderResult(refreshResult).ConfigureAwait(false); + } + } + + /// <summary> + /// Gets the providers. + /// </summary> + /// <param name="item">The item.</param> + /// <param name="hasRefreshedMetadata">if set to <c>true</c> [has refreshed metadata].</param> + /// <param name="options">The options.</param> + /// <returns>IEnumerable{`0}.</returns> + protected virtual IEnumerable<IMetadataProvider> 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<IHasChangeMonitor>() + .Where(i => i.HasChanged(currentItem, item.DateLastSaved)) + .ToList(); + + // If local providers are the only ones with changes, then just run those + if (providersWithChanges.All(i => i is ILocalMetadataProvider)) + { + providers = providers.Where(i => i is ILocalMetadataProvider).ToList(); + } + } + + return providers; + } + + /// <summary> + /// Gets the sort order. + /// </summary> + /// <param name="provider">The provider.</param> + /// <returns>System.Int32.</returns> + protected virtual int GetSortOrder(IMetadataProvider<TItemType> provider) + { + if (provider is IRemoteMetadataProvider) + { + return 1; + } + + return 0; + } + + /// <summary> + /// Determines whether this instance can refresh the specified provider. + /// </summary> + /// <param name="provider">The provider.</param> + /// <param name="item">The item.</param> + /// <returns><c>true</c> if this instance can refresh the specified provider; otherwise, <c>false</c>.</returns> + 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(TItemType 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<RefreshResult> RefreshWithProviders(TItemType item, MetadataRefreshOptions options, List<IMetadataProvider> providers, CancellationToken cancellationToken) + { + var refreshResult = new RefreshResult { UpdateType = ItemUpdateType.Unspecified }; + + var temp = new TItemType(); + + // If replacing all metadata, run internet providers first + if (options.ReplaceAllMetadata) + { + await ExecuteRemoteProviders(item, temp, providers.OfType<IRemoteMetadataProvider<TItemType>>(), refreshResult, cancellationToken).ConfigureAwait(false); + } + + var hasLocalMetadata = false; + + foreach (var provider in providers.OfType<ILocalMetadataProvider<TItemType>>()) + { + 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<MetadataFields>(), 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<IRemoteMetadataProvider<TItemType>>(), refreshResult, cancellationToken).ConfigureAwait(false); + } + + MergeData(temp, item, item.LockedFields, true, true); + + return refreshResult; + } + + private async Task ExecuteRemoteProviders(TItemType item, TItemType temp, IEnumerable<IRemoteMetadataProvider<TItemType>> 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<MetadataFields>(), 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<MetadataFields> lockedFields, bool replaceData, bool mergeMetadataSettings); + + public virtual int Order + { + get + { + return 0; + } + } + + private IEnumerable<IImageProvider> GetImageProviders(IHasImages item) + { + var providers = _imageProviders.Where(i => + { + try + { + return i.Supports(item); + } + catch (Exception ex) + { + Logger.ErrorException("Error in ImageProvider.Supports", ex, i.Name); + + return false; + } + }); + + if (!ServerConfigurationManager.Configuration.EnableInternetProviders) + { + providers = providers.Where(i => !(i is IRemoteImageProvider)); + } + + return providers.OrderBy(i => i.Order); + } + } + + public class RefreshResult + { + public ItemUpdateType UpdateType { get; set; } + public ProviderRefreshStatus Status { get; set; } + public string ErrorMessage { get; set; } + } +} diff --git a/MediaBrowser.Providers/Manager/ProviderManager.cs b/MediaBrowser.Providers/Manager/ProviderManager.cs new file mode 100644 index 000000000..ebad2e6e0 --- /dev/null +++ b/MediaBrowser.Providers/Manager/ProviderManager.cs @@ -0,0 +1,487 @@ +using MediaBrowser.Common.IO; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Configuration; +using MediaBrowser.Controller.Entities; +using MediaBrowser.Controller.IO; +using MediaBrowser.Controller.Library; +using MediaBrowser.Controller.Persistence; +using MediaBrowser.Controller.Providers; +using MediaBrowser.Model.Entities; +using MediaBrowser.Model.Logging; +using MediaBrowser.Model.Providers; +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Threading; +using System.Threading.Tasks; + +namespace MediaBrowser.Providers.Manager +{ + /// <summary> + /// Class ProviderManager + /// </summary> + public class ProviderManager : IProviderManager + { + /// <summary> + /// The _logger + /// </summary> + private readonly ILogger _logger; + + /// <summary> + /// The _HTTP client + /// </summary> + private readonly IHttpClient _httpClient; + + /// <summary> + /// The _directory watchers + /// </summary> + private readonly IDirectoryWatchers _directoryWatchers; + + /// <summary> + /// Gets or sets the configuration manager. + /// </summary> + /// <value>The configuration manager.</value> + private IServerConfigurationManager ConfigurationManager { get; set; } + + /// <summary> + /// Gets the list of currently registered metadata prvoiders + /// </summary> + /// <value>The metadata providers enumerable.</value> + private BaseMetadataProvider[] MetadataProviders { get; set; } + + private IRemoteImageProvider[] RemoteImageProviders { get; set; } + private IImageProvider[] ImageProviders { get; set; } + + private readonly IFileSystem _fileSystem; + + private readonly IItemRepository _itemRepo; + + private IMetadataService[] _metadataServices = {}; + + /// <summary> + /// Initializes a new instance of the <see cref="ProviderManager" /> class. + /// </summary> + /// <param name="httpClient">The HTTP client.</param> + /// <param name="configurationManager">The configuration manager.</param> + /// <param name="directoryWatchers">The directory watchers.</param> + /// <param name="logManager">The log manager.</param> + /// <param name="fileSystem">The file system.</param> + /// <param name="itemRepo">The item repo.</param> + public ProviderManager(IHttpClient httpClient, IServerConfigurationManager configurationManager, IDirectoryWatchers directoryWatchers, ILogManager logManager, IFileSystem fileSystem, IItemRepository itemRepo) + { + _logger = logManager.GetLogger("ProviderManager"); + _httpClient = httpClient; + ConfigurationManager = configurationManager; + _directoryWatchers = directoryWatchers; + _fileSystem = fileSystem; + _itemRepo = itemRepo; + } + + /// <summary> + /// Adds the metadata providers. + /// </summary> + /// <param name="providers">The providers.</param> + /// <param name="imageProviders">The image providers.</param> + /// <param name="metadataServices">The metadata services.</param> + /// <param name="metadataProviders">The metadata providers.</param> + public void AddParts(IEnumerable<BaseMetadataProvider> providers, IEnumerable<IImageProvider> imageProviders, IEnumerable<IMetadataService> metadataServices, IEnumerable<IMetadataProvider> metadataProviders) + { + MetadataProviders = providers.OrderBy(e => e.Priority).ToArray(); + + ImageProviders = imageProviders.OrderBy(i => i.Order).ToArray(); + RemoteImageProviders = ImageProviders.OfType<IRemoteImageProvider>().ToArray(); + + _metadataServices = metadataServices.OrderBy(i => i.Order).ToArray(); + + var providerList = metadataProviders.ToList(); + foreach (var service in _metadataServices) + { + service.AddParts(providerList, ImageProviders); + } + } + + public Task RefreshMetadata(IHasMetadata item, MetadataRefreshOptions options, CancellationToken cancellationToken) + { + var service = _metadataServices.FirstOrDefault(i => i.CanRefresh(item)); + + if (service != null) + { + return service.RefreshMetadata(item, options, cancellationToken); + } + + return ((BaseItem)item).RefreshMetadataDirect(cancellationToken, options.ForceSave, options.ReplaceAllMetadata); + } + + /// <summary> + /// Runs all metadata providers for an entity, and returns true or false indicating if at least one was refreshed and requires persistence + /// </summary> + /// <param name="item">The item.</param> + /// <param name="cancellationToken">The cancellation token.</param> + /// <param name="force">if set to <c>true</c> [force].</param> + /// <returns>Task{System.Boolean}.</returns> + /// <exception cref="System.ArgumentNullException">item</exception> + public async Task<ItemUpdateType?> ExecuteMetadataProviders(BaseItem item, CancellationToken cancellationToken, bool force = false) + { + if (item == null) + { + throw new ArgumentNullException("item"); + } + + ItemUpdateType? result = null; + + cancellationToken.ThrowIfCancellationRequested(); + + var enableInternetProviders = ConfigurationManager.Configuration.EnableInternetProviders; + + var providerHistories = item.DateLastSaved == default(DateTime) ? + new List<BaseProviderInfo>() : + _itemRepo.GetProviderHistory(item.Id).ToList(); + + // Run the normal providers sequentially in order of priority + foreach (var provider in MetadataProviders) + { + cancellationToken.ThrowIfCancellationRequested(); + + if (!ProviderSupportsItem(provider, item)) + { + continue; + } + + // Skip if internet providers are currently disabled + if (provider.RequiresInternet && !enableInternetProviders) + { + continue; + } + + // 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 (provider.RequiresInternet && item.DontFetchMeta && provider.EnforceDontFetchMetadata) + { + continue; + } + + var providerInfo = providerHistories.FirstOrDefault(i => i.ProviderId == provider.Id); + + if (providerInfo == null) + { + providerInfo = new BaseProviderInfo + { + ProviderId = provider.Id + }; + providerHistories.Add(providerInfo); + } + + try + { + if (!force && !provider.NeedsRefresh(item, providerInfo)) + { + continue; + } + } + catch (Exception ex) + { + _logger.Error("Error determining NeedsRefresh for {0}", ex, item.Path); + } + + var updateType = await FetchAsync(provider, item, providerInfo, force, cancellationToken).ConfigureAwait(false); + + if (updateType.HasValue) + { + if (result.HasValue) + { + result = result.Value | updateType.Value; + } + else + { + result = updateType; + } + } + } + + if (result.HasValue || force) + { + await _itemRepo.SaveProviderHistory(item.Id, providerHistories, cancellationToken); + } + + return result; + } + + /// <summary> + /// Providers the supports item. + /// </summary> + /// <param name="provider">The provider.</param> + /// <param name="item">The item.</param> + /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns> + private bool ProviderSupportsItem(BaseMetadataProvider provider, BaseItem item) + { + try + { + return provider.Supports(item); + } + catch (Exception ex) + { + _logger.ErrorException("{0} failed in Supports for type {1}", ex, provider.GetType().Name, item.GetType().Name); + return false; + } + } + + /// <summary> + /// Fetches metadata and returns true or false indicating if any work that requires persistence was done + /// </summary> + /// <param name="provider">The provider.</param> + /// <param name="item">The item.</param> + /// <param name="providerInfo">The provider information.</param> + /// <param name="force">if set to <c>true</c> [force].</param> + /// <param name="cancellationToken">The cancellation token.</param> + /// <returns>Task{System.Boolean}.</returns> + /// <exception cref="System.ArgumentNullException">item</exception> + private async Task<ItemUpdateType?> FetchAsync(BaseMetadataProvider provider, BaseItem item, BaseProviderInfo providerInfo, bool force, CancellationToken cancellationToken) + { + if (item == null) + { + throw new ArgumentNullException("item"); + } + + cancellationToken.ThrowIfCancellationRequested(); + + // Don't clog up the log with these providers + if (!(provider is IDynamicInfoProvider)) + { + _logger.Debug("Running {0} for {1}", provider.GetType().Name, item.Path ?? item.Name ?? "--Unknown--"); + } + + try + { + var changed = await provider.FetchAsync(item, force, providerInfo, cancellationToken).ConfigureAwait(false); + + if (changed) + { + return provider.ItemUpdateType; + } + + return null; + } + catch (OperationCanceledException ex) + { + _logger.Debug("{0} canceled for {1}", provider.GetType().Name, item.Name); + + // If the outer cancellation token is the one that caused the cancellation, throw it + if (cancellationToken.IsCancellationRequested && ex.CancellationToken == cancellationToken) + { + throw; + } + + return null; + } + catch (Exception ex) + { + _logger.ErrorException("{0} failed refreshing {1} {2}", ex, provider.GetType().Name, item.Name, item.Path ?? string.Empty); + + provider.SetLastRefreshed(item, DateTime.UtcNow, providerInfo, ProviderRefreshStatus.Failure); + + return ItemUpdateType.Unspecified; + } + } + + /// <summary> + /// Saves to library filesystem. + /// </summary> + /// <param name="item">The item.</param> + /// <param name="path">The path.</param> + /// <param name="dataToSave">The data to save.</param> + /// <param name="cancellationToken">The cancellation token.</param> + /// <returns>Task.</returns> + /// <exception cref="System.ArgumentNullException"></exception> + public async Task SaveToLibraryFilesystem(BaseItem item, string path, Stream dataToSave, CancellationToken cancellationToken) + { + if (item == null) + { + throw new ArgumentNullException(); + } + if (string.IsNullOrEmpty(path)) + { + throw new ArgumentNullException(); + } + if (dataToSave == null) + { + throw new ArgumentNullException(); + } + + if (cancellationToken.IsCancellationRequested) + { + dataToSave.Dispose(); + cancellationToken.ThrowIfCancellationRequested(); + } + + //Tell the watchers to ignore + _directoryWatchers.TemporarilyIgnore(path); + + if (dataToSave.CanSeek) + { + dataToSave.Position = 0; + } + + try + { + using (dataToSave) + { + using (var fs = _fileSystem.GetFileStream(path, FileMode.Create, FileAccess.Write, FileShare.Read, true)) + { + await dataToSave.CopyToAsync(fs, StreamDefaults.DefaultCopyToBufferSize, cancellationToken).ConfigureAwait(false); + } + } + + // If this is ever used for something other than metadata we can add a file type param + item.ResolveArgs.AddMetadataFile(path); + } + finally + { + //Remove the ignore + _directoryWatchers.RemoveTempIgnore(path); + } + } + + + /// <summary> + /// Saves the image. + /// </summary> + /// <param name="item">The item.</param> + /// <param name="url">The URL.</param> + /// <param name="resourcePool">The resource pool.</param> + /// <param name="type">The type.</param> + /// <param name="imageIndex">Index of the image.</param> + /// <param name="cancellationToken">The cancellation token.</param> + /// <returns>Task.</returns> + public async Task SaveImage(BaseItem item, string url, SemaphoreSlim resourcePool, ImageType type, int? imageIndex, CancellationToken cancellationToken) + { + var response = await _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + ResourcePool = resourcePool, + Url = url + + }).ConfigureAwait(false); + + await SaveImage(item, response.Content, response.ContentType, type, imageIndex, url, cancellationToken) + .ConfigureAwait(false); + } + + /// <summary> + /// Saves the image. + /// </summary> + /// <param name="item">The item.</param> + /// <param name="source">The source.</param> + /// <param name="mimeType">Type of the MIME.</param> + /// <param name="type">The type.</param> + /// <param name="imageIndex">Index of the image.</param> + /// <param name="sourceUrl">The source URL.</param> + /// <param name="cancellationToken">The cancellation token.</param> + /// <returns>Task.</returns> + public Task SaveImage(BaseItem item, Stream source, string mimeType, ImageType type, int? imageIndex, string sourceUrl, CancellationToken cancellationToken) + { + return new ImageSaver(ConfigurationManager, _directoryWatchers, _fileSystem, _logger).SaveImage(item, source, mimeType, type, imageIndex, sourceUrl, cancellationToken); + } + + /// <summary> + /// Gets the available remote images. + /// </summary> + /// <param name="item">The item.</param> + /// <param name="cancellationToken">The cancellation token.</param> + /// <param name="providerName">Name of the provider.</param> + /// <param name="type">The type.</param> + /// <returns>Task{IEnumerable{RemoteImageInfo}}.</returns> + public async Task<IEnumerable<RemoteImageInfo>> GetAvailableRemoteImages(BaseItem item, CancellationToken cancellationToken, string providerName = null, ImageType? type = null) + { + var providers = GetRemoteImageProviders(item); + + if (!string.IsNullOrEmpty(providerName)) + { + providers = providers.Where(i => string.Equals(i.Name, providerName, StringComparison.OrdinalIgnoreCase)); + } + + var preferredLanguage = item.GetPreferredMetadataLanguage(); + + var tasks = providers.Select(i => GetImages(item, cancellationToken, i, preferredLanguage, type)); + + var results = await Task.WhenAll(tasks).ConfigureAwait(false); + + return results.SelectMany(i => i); + } + + /// <summary> + /// Gets the images. + /// </summary> + /// <param name="item">The item.</param> + /// <param name="cancellationToken">The cancellation token.</param> + /// <param name="i">The i.</param> + /// <param name="preferredLanguage">The preferred language.</param> + /// <param name="type">The type.</param> + /// <returns>Task{IEnumerable{RemoteImageInfo}}.</returns> + private async Task<IEnumerable<RemoteImageInfo>> GetImages(BaseItem item, CancellationToken cancellationToken, IRemoteImageProvider i, string preferredLanguage, ImageType? type = null) + { + try + { + if (type.HasValue) + { + var result = await i.GetImages(item, type.Value, cancellationToken).ConfigureAwait(false); + + return FilterImages(result, preferredLanguage); + } + else + { + var result = await i.GetAllImages(item, cancellationToken).ConfigureAwait(false); + return FilterImages(result, preferredLanguage); + } + } + catch (Exception ex) + { + _logger.ErrorException("{0} failed in GetImageInfos for type {1}", ex, i.GetType().Name, item.GetType().Name); + return new List<RemoteImageInfo>(); + } + } + + private IEnumerable<RemoteImageInfo> FilterImages(IEnumerable<RemoteImageInfo> images, string preferredLanguage) + { + if (string.Equals(preferredLanguage, "en", StringComparison.OrdinalIgnoreCase)) + { + images = images.Where(i => string.IsNullOrEmpty(i.Language) || + string.Equals(i.Language, "en", StringComparison.OrdinalIgnoreCase)); + } + + return images; + } + + private IEnumerable<IRemoteImageProvider> GetRemoteImageProviders(BaseItem item) + { + return RemoteImageProviders.Where(i => + { + try + { + return i.Supports(item); + } + catch (Exception ex) + { + _logger.ErrorException("{0} failed in Supports for type {1}", ex, i.GetType().Name, item.GetType().Name); + return false; + } + + }); + } + + /// <summary> + /// Gets the supported image providers. + /// </summary> + /// <param name="item">The item.</param> + /// <returns>IEnumerable{IImageProvider}.</returns> + public IEnumerable<ImageProviderInfo> GetImageProviderInfo(BaseItem item) + { + return GetRemoteImageProviders(item).Select(i => new ImageProviderInfo + { + Name = i.Name, + Order = i.Order + + }); + } + } +} diff --git a/MediaBrowser.Providers/MediaBrowser.Providers.csproj b/MediaBrowser.Providers/MediaBrowser.Providers.csproj index e686e7eda..db8de8a16 100644 --- a/MediaBrowser.Providers/MediaBrowser.Providers.csproj +++ b/MediaBrowser.Providers/MediaBrowser.Providers.csproj @@ -64,6 +64,14 @@ </Reference> </ItemGroup> <ItemGroup> + <Compile Include="All\LocalImageProvider.cs" /> + <Compile Include="GameGenres\GameGenreMetadataService.cs" /> + <Compile Include="Genres\GenreMetadataService.cs" /> + <Compile Include="Manager\ImageSaver.cs" /> + <Compile Include="Manager\ItemImageProvider.cs" /> + <Compile Include="Manager\ProviderManager.cs" /> + <Compile Include="Manager\MetadataService.cs" /> + <Compile Include="BaseXmlProvider.cs" /> <Compile Include="CollectionFolderImageProvider.cs" /> <Compile Include="FanartBaseProvider.cs" /> <Compile Include="FolderProviderFromXml.cs" /> @@ -72,12 +80,9 @@ <Compile Include="Games\GameSystemProviderFromXml.cs" /> <Compile Include="ImageFromMediaLocationProvider.cs" /> <Compile Include="ImagesByNameProvider.cs" /> - <Compile Include="ImagesByName\MusicGenreImageProvider.cs" /> - <Compile Include="ImagesByName\MusicGenresManualImageProvider.cs" /> - <Compile Include="ImagesByName\GameGenreImageProvider.cs" /> - <Compile Include="ImagesByName\GameGenresManualImageProvider.cs" /> - <Compile Include="ImagesByName\GenreImageProvider.cs" /> - <Compile Include="ImagesByName\GenresManualImageProvider.cs" /> + <Compile Include="MusicGenres\MusicGenreImageProvider.cs" /> + <Compile Include="GameGenres\GameGenreImageProvider.cs" /> + <Compile Include="Genres\GenreImageProvider.cs" /> <Compile Include="ImagesByName\ImageUtils.cs" /> <Compile Include="LiveTv\ChannelProviderFromXml.cs" /> <Compile Include="MediaInfo\AudioImageProvider.cs" /> @@ -88,8 +93,8 @@ <Compile Include="Movies\BoxSetProviderFromXml.cs" /> <Compile Include="Movies\ManualMovieDbImageProvider.cs" /> <Compile Include="Movies\ManualFanartMovieImageProvider.cs" /> - <Compile Include="Movies\ManualMovieDbPersonImageProvider.cs" /> - <Compile Include="Movies\MovieDbPersonImageProvider.cs" /> + <Compile Include="MusicGenres\MusicGenreMetadataService.cs" /> + <Compile Include="People\MovieDbPersonImageProvider.cs" /> <Compile Include="Movies\MovieUpdatesPrescanTask.cs" /> <Compile Include="Movies\MovieXmlParser.cs" /> <Compile Include="Movies\FanArtMovieProvider.cs" /> @@ -98,8 +103,6 @@ <Compile Include="Movies\MovieDbProvider.cs" /> <Compile Include="Movies\MovieProviderFromXml.cs" /> <Compile Include="Movies\OpenMovieDatabaseProvider.cs" /> - <Compile Include="Movies\PersonProviderFromXml.cs" /> - <Compile Include="Movies\MovieDbPersonProvider.cs" /> <Compile Include="Music\AlbumInfoFromSongProvider.cs" /> <Compile Include="Music\AlbumProviderFromXml.cs" /> <Compile Include="Music\ArtistInfoFromSongProvider.cs" /> @@ -118,7 +121,11 @@ <Compile Include="Music\MusicBrainzAlbumProvider.cs" /> <Compile Include="Music\MusicVideoXmlParser.cs" /> <Compile Include="Music\SoundtrackPostScanTask.cs" /> + <Compile Include="People\PersonMetadataService.cs" /> + <Compile Include="People\PersonXmlProvider.cs" /> + <Compile Include="People\MovieDbPersonProvider.cs" /> <Compile Include="Properties\AssemblyInfo.cs" /> + <Compile Include="ProviderUtils.cs" /> <Compile Include="RefreshIntrosTask.cs" /> <Compile Include="Savers\AlbumXmlSaver.cs" /> <Compile Include="Savers\ArtistXmlSaver.cs" /> @@ -133,8 +140,8 @@ <Compile Include="Savers\SeasonXmlSaver.cs" /> <Compile Include="Savers\SeriesXmlSaver.cs" /> <Compile Include="Savers\XmlSaverHelpers.cs" /> - <Compile Include="ImagesByName\StudioImageProvider.cs" /> - <Compile Include="ImagesByName\StudiosManualImageProvider.cs" /> + <Compile Include="Studios\StudiosImageProvider.cs" /> + <Compile Include="Studios\StudioMetadataService.cs" /> <Compile Include="TV\EpisodeImageFromMediaLocationProvider.cs" /> <Compile Include="TV\EpisodeIndexNumberProvider.cs" /> <Compile Include="TV\EpisodeProviderFromXml.cs" /> @@ -145,7 +152,7 @@ <Compile Include="TV\ManualFanartSeasonProvider.cs" /> <Compile Include="TV\ManualFanartSeriesProvider.cs" /> <Compile Include="TV\ManualTvdbEpisodeImageProvider.cs" /> - <Compile Include="TV\ManualTvdbPersonImageProvider.cs" /> + <Compile Include="People\TvdbPersonImageProvider.cs" /> <Compile Include="TV\ManualTvdbSeasonImageProvider.cs" /> <Compile Include="TV\ManualTvdbSeriesImageProvider.cs" /> <Compile Include="TV\SeasonIndexNumberProvider.cs" /> @@ -157,7 +164,6 @@ <Compile Include="TV\SeriesPostScanTask.cs" /> <Compile Include="TV\SeriesProviderFromXml.cs" /> <Compile Include="TV\SeriesXmlParser.cs" /> - <Compile Include="TV\TvdbPersonImageProvider.cs" /> <Compile Include="TV\TvdbPrescanTask.cs" /> <Compile Include="TV\TvdbSeriesImageProvider.cs" /> <Compile Include="UserRootFolderNameProvider.cs" /> @@ -180,6 +186,7 @@ <ItemGroup> <None Include="packages.config" /> </ItemGroup> + <ItemGroup /> <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" /> <Import Project="$(SolutionDir)\.nuget\NuGet.targets" Condition=" '$(ConfigurationName)' != 'Release Mono' " /> <!-- To modify your build process, add your task inside one of the targets below and uncomment it. diff --git a/MediaBrowser.Providers/Movies/ManualFanartMovieImageProvider.cs b/MediaBrowser.Providers/Movies/ManualFanartMovieImageProvider.cs index fae8cd591..c34bd47d7 100644 --- a/MediaBrowser.Providers/Movies/ManualFanartMovieImageProvider.cs +++ b/MediaBrowser.Providers/Movies/ManualFanartMovieImageProvider.cs @@ -1,4 +1,5 @@ -using MediaBrowser.Controller.Configuration; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Providers; using MediaBrowser.Model.Dto; @@ -16,14 +17,16 @@ using System.Xml; namespace MediaBrowser.Providers.Movies { - public class ManualFanartMovieImageProvider : IImageProvider + public class ManualFanartMovieImageProvider : IRemoteImageProvider { private readonly CultureInfo _usCulture = new CultureInfo("en-US"); private readonly IServerConfigurationManager _config; + private readonly IHttpClient _httpClient; - public ManualFanartMovieImageProvider(IServerConfigurationManager config) + public ManualFanartMovieImageProvider(IServerConfigurationManager config, IHttpClient httpClient) { _config = config; + _httpClient = httpClient; } public string Name @@ -41,6 +44,20 @@ namespace MediaBrowser.Providers.Movies return FanArtMovieProvider.SupportsItem(item); } + public IEnumerable<ImageType> GetSupportedImages(IHasImages item) + { + return new List<ImageType> + { + ImageType.Primary, + ImageType.Thumb, + ImageType.Art, + ImageType.Logo, + ImageType.Disc, + ImageType.Banner, + ImageType.Backdrop + }; + } + public async Task<IEnumerable<RemoteImageInfo>> GetImages(IHasImages item, ImageType imageType, CancellationToken cancellationToken) { var images = await GetAllImages(item, cancellationToken).ConfigureAwait(false); @@ -294,9 +311,19 @@ namespace MediaBrowser.Providers.Movies } } - public int Priority + public int Order { get { return 1; } } + + public Task<HttpResponseInfo> GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url, + ResourcePool = FanartBaseProvider.FanArtResourcePool + }); + } } } diff --git a/MediaBrowser.Providers/Movies/ManualMovieDbImageProvider.cs b/MediaBrowser.Providers/Movies/ManualMovieDbImageProvider.cs index 21e50f400..ee1f14e09 100644 --- a/MediaBrowser.Providers/Movies/ManualMovieDbImageProvider.cs +++ b/MediaBrowser.Providers/Movies/ManualMovieDbImageProvider.cs @@ -1,4 +1,5 @@ -using MediaBrowser.Controller.Configuration; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Providers; using MediaBrowser.Model.Dto; @@ -14,15 +15,17 @@ using System.Threading.Tasks; namespace MediaBrowser.Providers.Movies { - class ManualMovieDbImageProvider : IImageProvider + class ManualMovieDbImageProvider : IRemoteImageProvider { private readonly IJsonSerializer _jsonSerializer; private readonly IServerConfigurationManager _config; + private readonly IHttpClient _httpClient; - public ManualMovieDbImageProvider(IJsonSerializer jsonSerializer, IServerConfigurationManager config) + public ManualMovieDbImageProvider(IJsonSerializer jsonSerializer, IServerConfigurationManager config, IHttpClient httpClient) { _jsonSerializer = jsonSerializer; _config = config; + _httpClient = httpClient; } public string Name @@ -40,6 +43,15 @@ namespace MediaBrowser.Providers.Movies return MovieDbImagesProvider.SupportsItem(item); } + public IEnumerable<ImageType> GetSupportedImages(IHasImages item) + { + return new List<ImageType> + { + ImageType.Primary, + ImageType.Backdrop + }; + } + public async Task<IEnumerable<RemoteImageInfo>> GetImages(IHasImages item, ImageType imageType, CancellationToken cancellationToken) { var images = await GetAllImages(item, cancellationToken).ConfigureAwait(false); @@ -167,9 +179,19 @@ namespace MediaBrowser.Providers.Movies return null; } - public int Priority + public int Order { - get { return 2; } + get { return 0; } + } + + public Task<HttpResponseInfo> GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url, + ResourcePool = MovieDbProvider.Current.MovieDbResourcePool + }); } } } diff --git a/MediaBrowser.Providers/Movies/MovieDbPersonImageProvider.cs b/MediaBrowser.Providers/Movies/MovieDbPersonImageProvider.cs deleted file mode 100644 index f6c908a7c..000000000 --- a/MediaBrowser.Providers/Movies/MovieDbPersonImageProvider.cs +++ /dev/null @@ -1,207 +0,0 @@ -using MediaBrowser.Common.IO; -using MediaBrowser.Common.Net; -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 MediaBrowser.Model.Providers; -using System; -using System.Collections.Generic; -using System.IO; -using System.Linq; -using System.Threading; -using System.Threading.Tasks; - -namespace MediaBrowser.Providers.Movies -{ - /// <summary> - /// Class MovieDbPersonImageProvider. - /// </summary> - public class MovieDbPersonImageProvider : BaseMetadataProvider - { - /// <summary> - /// The _provider manager - /// </summary> - private readonly IProviderManager _providerManager; - - private readonly IFileSystem _fileSystem; - - /// <summary> - /// Initializes a new instance of the <see cref="MediaBrowser.Providers.Movies.MovieDbImagesProvider"/> class. - /// </summary> - /// <param name="logManager">The log manager.</param> - /// <param name="configurationManager">The configuration manager.</param> - /// <param name="providerManager">The provider manager.</param> - public MovieDbPersonImageProvider(ILogManager logManager, IServerConfigurationManager configurationManager, IProviderManager providerManager, IFileSystem fileSystem) - : base(logManager, configurationManager) - { - _providerManager = providerManager; - _fileSystem = fileSystem; - } - - /// <summary> - /// Gets the priority. - /// </summary> - /// <value>The priority.</value> - public override MetadataProviderPriority Priority - { - get { return MetadataProviderPriority.Third; } - } - - /// <summary> - /// Supports the specified item. - /// </summary> - /// <param name="item">The item.</param> - /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns> - public override bool Supports(BaseItem item) - { - return item is Person; - } - - public override ItemUpdateType ItemUpdateType - { - get - { - return ItemUpdateType.ImageUpdate; - } - } - - /// <summary> - /// Gets a value indicating whether [requires internet]. - /// </summary> - /// <value><c>true</c> if [requires internet]; otherwise, <c>false</c>.</value> - public override bool RequiresInternet - { - get - { - return true; - } - } - - /// <summary> - /// Gets a value indicating whether [refresh on version change]. - /// </summary> - /// <value><c>true</c> if [refresh on version change]; otherwise, <c>false</c>.</value> - protected override bool RefreshOnVersionChange - { - get - { - return true; - } - } - - /// <summary> - /// Gets the provider version. - /// </summary> - /// <value>The provider version.</value> - protected override string ProviderVersion - { - get - { - return "3"; - } - } - - /// <summary> - /// Needses the refresh internal. - /// </summary> - /// <param name="item">The item.</param> - /// <param name="providerInfo">The provider info.</param> - /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns> - protected override bool NeedsRefreshInternal(BaseItem item, BaseProviderInfo providerInfo) - { - if (string.IsNullOrEmpty(item.GetProviderId(MetadataProviders.Tmdb))) - { - return false; - } - - // Don't refresh if we already have both poster and backdrop and we're not refreshing images - if (item.HasImage(ImageType.Primary)) - { - return false; - } - - return base.NeedsRefreshInternal(item, providerInfo); - } - - /// <summary> - /// Needses the refresh based on compare date. - /// </summary> - /// <param name="item">The item.</param> - /// <param name="providerInfo">The provider info.</param> - /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns> - protected override bool NeedsRefreshBasedOnCompareDate(BaseItem item, BaseProviderInfo providerInfo) - { - var provderId = item.GetProviderId(MetadataProviders.Tmdb); - - if (!string.IsNullOrEmpty(provderId)) - { - // Process images - var path = MovieDbPersonProvider.GetPersonDataFilePath(ConfigurationManager.ApplicationPaths, provderId); - - var fileInfo = new FileInfo(path); - - if (fileInfo.Exists) - { - return _fileSystem.GetLastWriteTimeUtc(fileInfo) > providerInfo.LastRefreshed; - } - - return false; - } - - return false; - } - - /// <summary> - /// Fetches metadata and returns true or false indicating if any work that requires persistence was done - /// </summary> - /// <param name="item">The item.</param> - /// <param name="force">if set to <c>true</c> [force].</param> - /// <param name="cancellationToken">The cancellation token</param> - /// <returns>Task{System.Boolean}.</returns> - public override async Task<bool> FetchAsync(BaseItem item, bool force, BaseProviderInfo providerInfo, CancellationToken cancellationToken) - { - var images = await _providerManager.GetAvailableRemoteImages(item, cancellationToken, ManualMovieDbPersonImageProvider.ProviderName).ConfigureAwait(false); - await ProcessImages(item, images.ToList(), cancellationToken).ConfigureAwait(false); - - SetLastRefreshed(item, DateTime.UtcNow, providerInfo); - return true; - } - - /// <summary> - /// Processes the images. - /// </summary> - /// <param name="item">The item.</param> - /// <param name="images">The images.</param> - /// <param name="cancellationToken">The cancellation token</param> - /// <returns>Task.</returns> - private async Task ProcessImages(BaseItem item, List<RemoteImageInfo> images, CancellationToken cancellationToken) - { - cancellationToken.ThrowIfCancellationRequested(); - - var eligiblePosters = images - .Where(i => i.Type == ImageType.Primary) - .ToList(); - - // poster - if (eligiblePosters.Count > 0 && !item.HasImage(ImageType.Primary) && !item.LockedFields.Contains(MetadataFields.Images)) - { - var poster = eligiblePosters[0]; - - var url = poster.Url; - - var img = await MovieDbProvider.Current.GetMovieDbResponse(new HttpRequestOptions - { - Url = url, - CancellationToken = cancellationToken - - }).ConfigureAwait(false); - - await _providerManager.SaveImage(item, img, MimeTypes.GetMimeType(url), ImageType.Primary, null, url, cancellationToken) - .ConfigureAwait(false); - } - } - } -} diff --git a/MediaBrowser.Providers/Movies/MovieDbPersonProvider.cs b/MediaBrowser.Providers/Movies/MovieDbPersonProvider.cs deleted file mode 100644 index 70ad6611a..000000000 --- a/MediaBrowser.Providers/Movies/MovieDbPersonProvider.cs +++ /dev/null @@ -1,440 +0,0 @@ -using MediaBrowser.Common.Configuration; -using MediaBrowser.Common.Extensions; -using MediaBrowser.Common.IO; -using MediaBrowser.Common.Net; -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 MediaBrowser.Model.Serialization; -using System; -using System.Collections.Generic; -using System.Globalization; -using System.IO; -using System.Net; -using System.Threading; -using System.Threading.Tasks; - -namespace MediaBrowser.Providers.Movies -{ - /// <summary> - /// Class TmdbPersonProvider - /// </summary> - public class MovieDbPersonProvider : BaseMetadataProvider - { - protected readonly IProviderManager ProviderManager; - - internal static MovieDbPersonProvider Current { get; private set; } - - const string DataFileName = "info.json"; - private readonly IFileSystem _fileSystem; - - public MovieDbPersonProvider(IJsonSerializer jsonSerializer, ILogManager logManager, IServerConfigurationManager configurationManager, IProviderManager providerManager, IFileSystem fileSystem) - : base(logManager, configurationManager) - { - if (jsonSerializer == null) - { - throw new ArgumentNullException("jsonSerializer"); - } - JsonSerializer = jsonSerializer; - ProviderManager = providerManager; - _fileSystem = fileSystem; - Current = this; - } - - /// <summary> - /// Gets the json serializer. - /// </summary> - /// <value>The json serializer.</value> - protected IJsonSerializer JsonSerializer { get; private set; } - - /// <summary> - /// Supportses the specified item. - /// </summary> - /// <param name="item">The item.</param> - /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns> - public override bool Supports(BaseItem item) - { - return item is Person; - } - - protected override bool RefreshOnVersionChange - { - get - { - return true; - } - } - - protected override string ProviderVersion - { - get - { - return "3"; - } - } - - public override ItemUpdateType ItemUpdateType - { - get - { - return ItemUpdateType.MetadataDownload; - } - } - - protected override bool NeedsRefreshInternal(BaseItem item, BaseProviderInfo providerInfo) - { - if (HasAltMeta(item)) - return false; - - return base.NeedsRefreshInternal(item, providerInfo); - } - - protected override bool NeedsRefreshBasedOnCompareDate(BaseItem item, BaseProviderInfo providerInfo) - { - var provderId = item.GetProviderId(MetadataProviders.Tmdb); - - if (!string.IsNullOrEmpty(provderId)) - { - // Process images - var path = GetPersonDataPath(ConfigurationManager.ApplicationPaths, provderId); - - var file = Path.Combine(path, DataFileName); - var fileInfo = new FileInfo(file); - - if (fileInfo.Exists) - { - return _fileSystem.GetLastWriteTimeUtc(fileInfo) > providerInfo.LastRefreshed; - } - - return true; - } - - return base.NeedsRefreshBasedOnCompareDate(item, providerInfo); - } - - internal static string GetPersonDataPath(IApplicationPaths appPaths, string tmdbId) - { - var letter = tmdbId.GetMD5().ToString().Substring(0, 1); - - var seriesDataPath = Path.Combine(GetPersonsDataPath(appPaths), letter, tmdbId); - - return seriesDataPath; - } - - internal static string GetPersonDataFilePath(IApplicationPaths appPaths, string tmdbId) - { - var letter = tmdbId.GetMD5().ToString().Substring(0, 1); - - var seriesDataPath = Path.Combine(GetPersonsDataPath(appPaths), letter, tmdbId); - - return Path.Combine(seriesDataPath, DataFileName); - } - - internal static string GetPersonsDataPath(IApplicationPaths appPaths) - { - var dataPath = Path.Combine(appPaths.DataPath, "tmdb-people"); - - return dataPath; - } - - private bool HasAltMeta(BaseItem item) - { - return item.LocationType == LocationType.FileSystem && item.ResolveArgs.ContainsMetaFileByName("person.xml"); - } - - /// <summary> - /// Fetches metadata and returns true or false indicating if any work that requires persistence was done - /// </summary> - /// <param name="item">The item.</param> - /// <param name="force">if set to <c>true</c> [force].</param> - /// <param name="cancellationToken">The cancellation token.</param> - /// <returns>Task{System.Boolean}.</returns> - public override async Task<bool> FetchAsync(BaseItem item, bool force, BaseProviderInfo providerInfo, CancellationToken cancellationToken) - { - cancellationToken.ThrowIfCancellationRequested(); - - var person = (Person)item; - - var id = person.GetProviderId(MetadataProviders.Tmdb); - - // We don't already have an Id, need to fetch it - if (string.IsNullOrEmpty(id)) - { - id = await GetTmdbId(item, cancellationToken).ConfigureAwait(false); - } - - cancellationToken.ThrowIfCancellationRequested(); - - if (!string.IsNullOrEmpty(id)) - { - await FetchInfo(person, id, force, cancellationToken).ConfigureAwait(false); - } - - SetLastRefreshed(item, DateTime.UtcNow, providerInfo); - return true; - } - - /// <summary> - /// Gets the priority. - /// </summary> - /// <value>The priority.</value> - public override MetadataProviderPriority Priority - { - get { return MetadataProviderPriority.Second; } - } - - /// <summary> - /// Gets a value indicating whether [requires internet]. - /// </summary> - /// <value><c>true</c> if [requires internet]; otherwise, <c>false</c>.</value> - public override bool RequiresInternet - { - get - { - return true; - } - } - - private readonly CultureInfo _usCulture = new CultureInfo("en-US"); - - /// <summary> - /// Gets the TMDB id. - /// </summary> - /// <param name="person">The person.</param> - /// <param name="cancellationToken">The cancellation token.</param> - /// <returns>Task{System.String}.</returns> - private async Task<string> GetTmdbId(BaseItem person, CancellationToken cancellationToken) - { - string url = string.Format(@"http://api.themoviedb.org/3/search/person?api_key={1}&query={0}", WebUtility.UrlEncode(person.Name), MovieDbProvider.ApiKey); - PersonSearchResults searchResult = null; - - using (var json = await MovieDbProvider.Current.GetMovieDbResponse(new HttpRequestOptions - { - Url = url, - CancellationToken = cancellationToken, - AcceptHeader = MovieDbProvider.AcceptHeader - - }).ConfigureAwait(false)) - { - searchResult = JsonSerializer.DeserializeFromStream<PersonSearchResults>(json); - } - - return searchResult != null && searchResult.Total_Results > 0 ? searchResult.Results[0].Id.ToString(_usCulture) : null; - } - - /// <summary> - /// Fetches the info. - /// </summary> - /// <param name="person">The person.</param> - /// <param name="id">The id.</param> - /// <param name="isForcedRefresh">if set to <c>true</c> [is forced refresh].</param> - /// <param name="cancellationToken">The cancellation token.</param> - /// <returns>Task.</returns> - private async Task FetchInfo(Person person, string id, bool isForcedRefresh, CancellationToken cancellationToken) - { - await EnsurePersonInfo(id, cancellationToken).ConfigureAwait(false); - - if (isForcedRefresh || !HasAltMeta(person)) - { - var dataFilePath = GetPersonDataFilePath(ConfigurationManager.ApplicationPaths, id); - - var info = JsonSerializer.DeserializeFromFile<PersonResult>(dataFilePath); - - cancellationToken.ThrowIfCancellationRequested(); - - ProcessInfo(person, info); - } - } - - internal async Task EnsurePersonInfo(string id, CancellationToken cancellationToken) - { - var personDataPath = GetPersonDataPath(ConfigurationManager.ApplicationPaths, id); - - var fileInfo = _fileSystem.GetFileSystemInfo(personDataPath); - - if (fileInfo.Exists && (DateTime.UtcNow - _fileSystem.GetLastWriteTimeUtc(fileInfo)).TotalDays <= 7) - { - return; - } - - var url = string.Format(@"http://api.themoviedb.org/3/person/{1}?api_key={0}&append_to_response=credits,images", MovieDbProvider.ApiKey, id); - - using (var json = await MovieDbProvider.Current.GetMovieDbResponse(new HttpRequestOptions - { - Url = url, - CancellationToken = cancellationToken, - AcceptHeader = MovieDbProvider.AcceptHeader - - }).ConfigureAwait(false)) - { - Directory.CreateDirectory(personDataPath); - - using (var fs = _fileSystem.GetFileStream(Path.Combine(personDataPath, DataFileName), FileMode.Create, FileAccess.Write, FileShare.Read, true)) - { - await json.CopyToAsync(fs).ConfigureAwait(false); - } - } - } - - /// <summary> - /// Processes the info. - /// </summary> - /// <param name="person">The person.</param> - /// <param name="searchResult">The search result.</param> - protected void ProcessInfo(Person person, PersonResult searchResult) - { - if (!person.LockedFields.Contains(MetadataFields.Overview)) - { - person.Overview = searchResult.biography; - } - - DateTime date; - - if (DateTime.TryParseExact(searchResult.birthday, "yyyy-MM-dd", new CultureInfo("en-US"), DateTimeStyles.None, out date)) - { - person.PremiereDate = date.ToUniversalTime(); - } - - if (DateTime.TryParseExact(searchResult.deathday, "yyyy-MM-dd", new CultureInfo("en-US"), DateTimeStyles.None, out date)) - { - person.EndDate = date.ToUniversalTime(); - } - - if (!string.IsNullOrEmpty(searchResult.homepage)) - { - person.HomePageUrl = searchResult.homepage; - } - - if (!person.LockedFields.Contains(MetadataFields.ProductionLocations)) - { - if (!string.IsNullOrEmpty(searchResult.place_of_birth)) - { - person.PlaceOfBirth = searchResult.place_of_birth; - } - } - - person.SetProviderId(MetadataProviders.Tmdb, searchResult.id.ToString(_usCulture)); - } - - #region Result Objects - /// <summary> - /// Class PersonSearchResult - /// </summary> - public class PersonSearchResult - { - /// <summary> - /// Gets or sets a value indicating whether this <see cref="PersonSearchResult" /> is adult. - /// </summary> - /// <value><c>true</c> if adult; otherwise, <c>false</c>.</value> - public bool Adult { get; set; } - /// <summary> - /// Gets or sets the id. - /// </summary> - /// <value>The id.</value> - public int Id { get; set; } - /// <summary> - /// Gets or sets the name. - /// </summary> - /// <value>The name.</value> - public string Name { get; set; } - /// <summary> - /// Gets or sets the profile_ path. - /// </summary> - /// <value>The profile_ path.</value> - public string Profile_Path { get; set; } - } - - /// <summary> - /// Class PersonSearchResults - /// </summary> - public class PersonSearchResults - { - /// <summary> - /// Gets or sets the page. - /// </summary> - /// <value>The page.</value> - public int Page { get; set; } - /// <summary> - /// Gets or sets the results. - /// </summary> - /// <value>The results.</value> - public List<PersonSearchResult> Results { get; set; } - /// <summary> - /// Gets or sets the total_ pages. - /// </summary> - /// <value>The total_ pages.</value> - public int Total_Pages { get; set; } - /// <summary> - /// Gets or sets the total_ results. - /// </summary> - /// <value>The total_ results.</value> - public int Total_Results { get; set; } - } - - public class Cast - { - public int id { get; set; } - public string title { get; set; } - public string character { get; set; } - public string original_title { get; set; } - public string poster_path { get; set; } - public string release_date { get; set; } - public bool adult { get; set; } - } - - public class Crew - { - public int id { get; set; } - public string title { get; set; } - public string original_title { get; set; } - public string department { get; set; } - public string job { get; set; } - public string poster_path { get; set; } - public string release_date { get; set; } - public bool adult { get; set; } - } - - public class Credits - { - public List<Cast> cast { get; set; } - public List<Crew> crew { get; set; } - } - - public class Profile - { - public string file_path { get; set; } - public int width { get; set; } - public int height { get; set; } - public object iso_639_1 { get; set; } - public double aspect_ratio { get; set; } - } - - public class Images - { - public List<Profile> profiles { get; set; } - } - - public class PersonResult - { - public bool adult { get; set; } - public List<object> also_known_as { get; set; } - public string biography { get; set; } - public string birthday { get; set; } - public string deathday { get; set; } - public string homepage { get; set; } - public int id { get; set; } - public string imdb_id { get; set; } - public string name { get; set; } - public string place_of_birth { get; set; } - public double popularity { get; set; } - public string profile_path { get; set; } - public Credits credits { get; set; } - public Images images { get; set; } - } - - #endregion - } -} diff --git a/MediaBrowser.Providers/Movies/PersonProviderFromXml.cs b/MediaBrowser.Providers/Movies/PersonProviderFromXml.cs deleted file mode 100644 index 014580025..000000000 --- a/MediaBrowser.Providers/Movies/PersonProviderFromXml.cs +++ /dev/null @@ -1,89 +0,0 @@ -using MediaBrowser.Common.IO; -using MediaBrowser.Controller.Configuration; -using MediaBrowser.Controller.Entities; -using MediaBrowser.Controller.Providers; -using MediaBrowser.Model.Logging; -using System; -using System.IO; -using System.Threading; -using System.Threading.Tasks; - -namespace MediaBrowser.Providers.Movies -{ - class PersonProviderFromXml : BaseMetadataProvider - { - private readonly IFileSystem _fileSystem; - - public PersonProviderFromXml(ILogManager logManager, IServerConfigurationManager configurationManager, IFileSystem fileSystem) - : base(logManager, configurationManager) - { - _fileSystem = fileSystem; - } - - /// <summary> - /// Supportses the specified item. - /// </summary> - /// <param name="item">The item.</param> - /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns> - public override bool Supports(BaseItem item) - { - return item is Person; - } - - /// <summary> - /// Gets the priority. - /// </summary> - /// <value>The priority.</value> - public override MetadataProviderPriority Priority - { - get { return MetadataProviderPriority.Second; } - } - - private const string XmlFileName = "person.xml"; - protected override bool NeedsRefreshBasedOnCompareDate(BaseItem item, BaseProviderInfo providerInfo) - { - var xml = item.ResolveArgs.GetMetaFileByPath(Path.Combine(item.MetaLocation, XmlFileName)); - - if (xml == null) - { - return false; - } - - return _fileSystem.GetLastWriteTimeUtc(xml) > item.DateLastSaved; - } - - /// <summary> - /// Fetches metadata and returns true or false indicating if any work that requires persistence was done - /// </summary> - /// <param name="item">The item.</param> - /// <param name="force">if set to <c>true</c> [force].</param> - /// <param name="providerInfo">The provider information.</param> - /// <param name="cancellationToken">The cancellation token.</param> - /// <returns>Task{System.Boolean}.</returns> - public override async Task<bool> FetchAsync(BaseItem item, bool force, BaseProviderInfo providerInfo, CancellationToken cancellationToken) - { - cancellationToken.ThrowIfCancellationRequested(); - - var metadataFile = item.ResolveArgs.GetMetaFileByPath(Path.Combine(item.MetaLocation, XmlFileName)); - - if (metadataFile != null) - { - var path = metadataFile.FullName; - - await XmlParsingResourcePool.WaitAsync(cancellationToken).ConfigureAwait(false); - - try - { - new BaseItemXmlParser<Person>(Logger).Fetch((Person)item, path, cancellationToken); - } - finally - { - XmlParsingResourcePool.Release(); - } - } - - SetLastRefreshed(item, DateTime.UtcNow, providerInfo); - return true; - } - } -} diff --git a/MediaBrowser.Providers/Music/ManualFanartAlbumProvider.cs b/MediaBrowser.Providers/Music/ManualFanartAlbumProvider.cs index 5c923869f..d5108f309 100644 --- a/MediaBrowser.Providers/Music/ManualFanartAlbumProvider.cs +++ b/MediaBrowser.Providers/Music/ManualFanartAlbumProvider.cs @@ -1,4 +1,5 @@ -using MediaBrowser.Controller.Configuration; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities.Audio; using MediaBrowser.Controller.Providers; @@ -17,14 +18,16 @@ using System.Xml; namespace MediaBrowser.Providers.Music { - public class ManualFanartAlbumProvider : IImageProvider + public class ManualFanartAlbumProvider : IRemoteImageProvider { private readonly CultureInfo _usCulture = new CultureInfo("en-US"); private readonly IServerConfigurationManager _config; + private readonly IHttpClient _httpClient; - public ManualFanartAlbumProvider(IServerConfigurationManager config) + public ManualFanartAlbumProvider(IServerConfigurationManager config, IHttpClient httpClient) { _config = config; + _httpClient = httpClient; } public string Name @@ -42,6 +45,15 @@ namespace MediaBrowser.Providers.Music return item is MusicAlbum; } + public IEnumerable<ImageType> GetSupportedImages(IHasImages item) + { + return new List<ImageType> + { + ImageType.Primary, + ImageType.Disc + }; + } + public async Task<IEnumerable<RemoteImageInfo>> GetImages(IHasImages item, ImageType imageType, CancellationToken cancellationToken) { var images = await GetAllImages(item, cancellationToken).ConfigureAwait(false); @@ -325,9 +337,19 @@ namespace MediaBrowser.Providers.Music list.Add(info); } - public int Priority + public int Order { - get { return 1; } + get { return 0; } + } + + public Task<HttpResponseInfo> GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url, + ResourcePool = FanartBaseProvider.FanArtResourcePool + }); } } } diff --git a/MediaBrowser.Providers/Music/ManualFanartArtistProvider.cs b/MediaBrowser.Providers/Music/ManualFanartArtistProvider.cs index ddf5064aa..f100a3e31 100644 --- a/MediaBrowser.Providers/Music/ManualFanartArtistProvider.cs +++ b/MediaBrowser.Providers/Music/ManualFanartArtistProvider.cs @@ -1,4 +1,5 @@ -using MediaBrowser.Controller.Configuration; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities.Audio; using MediaBrowser.Controller.Providers; @@ -17,14 +18,16 @@ using System.Xml; namespace MediaBrowser.Providers.Music { - public class ManualFanartArtistProvider : IImageProvider + public class ManualFanartArtistProvider : IRemoteImageProvider { private readonly CultureInfo _usCulture = new CultureInfo("en-US"); private readonly IServerConfigurationManager _config; + private readonly IHttpClient _httpClient; - public ManualFanartArtistProvider(IServerConfigurationManager config) + public ManualFanartArtistProvider(IServerConfigurationManager config, IHttpClient httpClient) { _config = config; + _httpClient = httpClient; } public string Name @@ -42,6 +45,18 @@ namespace MediaBrowser.Providers.Music return item is MusicArtist; } + public IEnumerable<ImageType> GetSupportedImages(IHasImages item) + { + return new List<ImageType> + { + ImageType.Primary, + ImageType.Logo, + ImageType.Art, + ImageType.Banner, + ImageType.Backdrop + }; + } + public async Task<IEnumerable<RemoteImageInfo>> GetImages(IHasImages item, ImageType imageType, CancellationToken cancellationToken) { var images = await GetAllImages(item, cancellationToken).ConfigureAwait(false); @@ -334,9 +349,19 @@ namespace MediaBrowser.Providers.Music list.Add(info); } - public int Priority + public int Order { - get { return 1; } + get { return 0; } + } + + public Task<HttpResponseInfo> GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url, + ResourcePool = FanartBaseProvider.FanArtResourcePool + }); } } } diff --git a/MediaBrowser.Providers/Music/ManualLastFmImageProvider.cs b/MediaBrowser.Providers/Music/ManualLastFmImageProvider.cs index 6d6f1ec7b..aa7d00fb6 100644 --- a/MediaBrowser.Providers/Music/ManualLastFmImageProvider.cs +++ b/MediaBrowser.Providers/Music/ManualLastFmImageProvider.cs @@ -1,4 +1,5 @@ -using MediaBrowser.Controller.Entities; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities.Audio; using MediaBrowser.Controller.Providers; using MediaBrowser.Model.Entities; @@ -11,8 +12,15 @@ using System.Threading.Tasks; namespace MediaBrowser.Providers.Music { - public class ManualLastFmImageProvider : IImageProvider + public class ManualLastFmImageProvider : IRemoteImageProvider { + private readonly IHttpClient _httpClient; + + public ManualLastFmImageProvider(IHttpClient httpClient) + { + _httpClient = httpClient; + } + public string Name { get { return ProviderName; } @@ -28,6 +36,14 @@ namespace MediaBrowser.Providers.Music return item is MusicAlbum || item is MusicArtist; } + public IEnumerable<ImageType> GetSupportedImages(IHasImages item) + { + return new List<ImageType> + { + ImageType.Primary + }; + } + public async Task<IEnumerable<RemoteImageInfo>> GetImages(IHasImages item, ImageType imageType, CancellationToken cancellationToken) { var images = await GetAllImages(item, cancellationToken).ConfigureAwait(false); @@ -72,7 +88,8 @@ namespace MediaBrowser.Providers.Music var info = new RemoteImageInfo { ProviderName = Name, - Url = url + Url = url, + Type = ImageType.Primary }; if (string.Equals(size, "mega", StringComparison.OrdinalIgnoreCase)) @@ -95,9 +112,19 @@ namespace MediaBrowser.Providers.Music return info; } - public int Priority + public int Order + { + get { return 1; } + } + + public Task<HttpResponseInfo> GetImageResponse(string url, CancellationToken cancellationToken) { - get { return 0; } + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url, + ResourcePool = LastfmBaseProvider.LastfmResourcePool + }); } } } diff --git a/MediaBrowser.Providers/ImagesByName/MusicGenresManualImageProvider.cs b/MediaBrowser.Providers/MusicGenres/MusicGenreImageProvider.cs index f21e867d1..8ae217e0b 100644 --- a/MediaBrowser.Providers/ImagesByName/MusicGenresManualImageProvider.cs +++ b/MediaBrowser.Providers/MusicGenres/MusicGenreImageProvider.cs @@ -6,15 +6,17 @@ using MediaBrowser.Controller.Entities.Audio; using MediaBrowser.Controller.Providers; using MediaBrowser.Model.Entities; using MediaBrowser.Model.Providers; +using MediaBrowser.Providers.Genres; +using MediaBrowser.Providers.ImagesByName; using System.Collections.Generic; using System.IO; using System.Linq; using System.Threading; using System.Threading.Tasks; -namespace MediaBrowser.Providers.ImagesByName +namespace MediaBrowser.Providers.MusicGenres { - public class MusicGenresManualImageProvider : IImageProvider + public class MusicGenreImageProvider : IRemoteImageProvider { private readonly IServerConfigurationManager _config; private readonly IHttpClient _httpClient; @@ -22,7 +24,7 @@ namespace MediaBrowser.Providers.ImagesByName private readonly SemaphoreSlim _listResourcePool = new SemaphoreSlim(1, 1); - public MusicGenresManualImageProvider(IServerConfigurationManager config, IHttpClient httpClient, IFileSystem fileSystem) + public MusicGenreImageProvider(IServerConfigurationManager config, IHttpClient httpClient, IFileSystem fileSystem) { _config = config; _httpClient = httpClient; @@ -44,6 +46,15 @@ namespace MediaBrowser.Providers.ImagesByName return item is MusicGenre; } + public IEnumerable<ImageType> GetSupportedImages(IHasImages item) + { + return new List<ImageType> + { + ImageType.Primary, + ImageType.Thumb + }; + } + public Task<IEnumerable<RemoteImageInfo>> GetImages(IHasImages item, ImageType imageType, CancellationToken cancellationToken) { return GetImages(item, imageType == ImageType.Primary, imageType == ImageType.Thumb, cancellationToken); @@ -121,9 +132,19 @@ namespace MediaBrowser.Providers.ImagesByName return ImageUtils.EnsureList(url, file, _httpClient, _fileSystem, _listResourcePool, cancellationToken); } - public int Priority + public int Order { get { return 0; } } + + public Task<HttpResponseInfo> GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url, + ResourcePool = GenreImageProvider.ImageDownloadResourcePool + }); + } } } diff --git a/MediaBrowser.Providers/MusicGenres/MusicGenreMetadataService.cs b/MediaBrowser.Providers/MusicGenres/MusicGenreMetadataService.cs new file mode 100644 index 000000000..bc4a99fc3 --- /dev/null +++ b/MediaBrowser.Providers/MusicGenres/MusicGenreMetadataService.cs @@ -0,0 +1,42 @@ +using MediaBrowser.Controller.Configuration; +using MediaBrowser.Controller.Entities.Audio; +using MediaBrowser.Controller.Library; +using MediaBrowser.Controller.Providers; +using MediaBrowser.Model.Entities; +using MediaBrowser.Model.Logging; +using MediaBrowser.Providers.Manager; +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; + +namespace MediaBrowser.Providers.MusicGenres +{ + public class MusicGenreMetadataService : MetadataService<MusicGenre> + { + private readonly ILibraryManager _libraryManager; + + public MusicGenreMetadataService(IServerConfigurationManager serverConfigurationManager, ILogger logger, IProviderManager providerManager, ILibraryManager libraryManager) + : base(serverConfigurationManager, logger, providerManager) + { + _libraryManager = libraryManager; + } + + /// <summary> + /// Merges the specified source. + /// </summary> + /// <param name="source">The source.</param> + /// <param name="target">The target.</param> + /// <param name="lockedFields">The locked fields.</param> + /// <param name="replaceData">if set to <c>true</c> [replace data].</param> + /// <param name="mergeMetadataSettings">if set to <c>true</c> [merge metadata settings].</param> + protected override void MergeData(MusicGenre source, MusicGenre target, List<MetadataFields> lockedFields, bool replaceData, bool mergeMetadataSettings) + { + ProviderUtils.MergeBaseItemData(source, target, lockedFields, replaceData, mergeMetadataSettings); + } + + protected override Task SaveItem(MusicGenre item, ItemUpdateType reason, CancellationToken cancellationToken) + { + return _libraryManager.UpdateItem(item, reason, cancellationToken); + } + } +} diff --git a/MediaBrowser.Providers/Movies/ManualMovieDbPersonImageProvider.cs b/MediaBrowser.Providers/People/MovieDbPersonImageProvider.cs index 4d3a5baac..2b4e43f3c 100644 --- a/MediaBrowser.Providers/Movies/ManualMovieDbPersonImageProvider.cs +++ b/MediaBrowser.Providers/People/MovieDbPersonImageProvider.cs @@ -1,26 +1,30 @@ -using MediaBrowser.Controller.Configuration; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Providers; using MediaBrowser.Model.Entities; using MediaBrowser.Model.Providers; using MediaBrowser.Model.Serialization; +using MediaBrowser.Providers.Movies; using System; using System.Collections.Generic; using System.Linq; using System.Threading; using System.Threading.Tasks; -namespace MediaBrowser.Providers.Movies +namespace MediaBrowser.Providers.People { - public class ManualMovieDbPersonImageProvider : IImageProvider + public class MovieDbPersonImageProvider : IRemoteImageProvider { private readonly IServerConfigurationManager _config; private readonly IJsonSerializer _jsonSerializer; + private readonly IHttpClient _httpClient; - public ManualMovieDbPersonImageProvider(IServerConfigurationManager config, IJsonSerializer jsonSerializer) + public MovieDbPersonImageProvider(IServerConfigurationManager config, IJsonSerializer jsonSerializer, IHttpClient httpClient) { _config = config; _jsonSerializer = jsonSerializer; + _httpClient = httpClient; } public string Name @@ -38,6 +42,14 @@ namespace MediaBrowser.Providers.Movies return item is Person; } + public IEnumerable<ImageType> GetSupportedImages(IHasImages item) + { + return new List<ImageType> + { + ImageType.Primary + }; + } + public async Task<IEnumerable<RemoteImageInfo>> GetImages(IHasImages item, ImageType imageType, CancellationToken cancellationToken) { var images = await GetAllImages(item, cancellationToken).ConfigureAwait(false); @@ -120,9 +132,19 @@ namespace MediaBrowser.Providers.Movies return profile.iso_639_1 == null ? null : profile.iso_639_1.ToString(); } - public int Priority + public int Order { get { return 0; } } + + public Task<HttpResponseInfo> GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url, + ResourcePool = MovieDbProvider.Current.MovieDbResourcePool + }); + } } } diff --git a/MediaBrowser.Providers/People/MovieDbPersonProvider.cs b/MediaBrowser.Providers/People/MovieDbPersonProvider.cs new file mode 100644 index 000000000..088ba0322 --- /dev/null +++ b/MediaBrowser.Providers/People/MovieDbPersonProvider.cs @@ -0,0 +1,289 @@ +using MediaBrowser.Common.Configuration; +using MediaBrowser.Common.Extensions; +using MediaBrowser.Common.IO; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Configuration; +using MediaBrowser.Controller.Entities; +using MediaBrowser.Controller.Providers; +using MediaBrowser.Model.Entities; +using MediaBrowser.Model.Serialization; +using MediaBrowser.Providers.Movies; +using System; +using System.Collections.Generic; +using System.Globalization; +using System.IO; +using System.Net; +using System.Threading; +using System.Threading.Tasks; + +namespace MediaBrowser.Providers.People +{ + public class MovieDbPersonProvider : IRemoteMetadataProvider<Person> + { + const string DataFileName = "info.json"; + + internal static MovieDbPersonProvider Current { get; private set; } + + private readonly IJsonSerializer _jsonSerializer; + private readonly IFileSystem _fileSystem; + private readonly IServerConfigurationManager _configurationManager; + + public MovieDbPersonProvider(IFileSystem fileSystem, IServerConfigurationManager configurationManager, IJsonSerializer jsonSerializer) + { + _fileSystem = fileSystem; + _configurationManager = configurationManager; + _jsonSerializer = jsonSerializer; + Current = this; + } + + public string Name + { + get { return "TheMovieDb"; } + } + + public async Task<MetadataResult<Person>> GetMetadata(ItemId id, CancellationToken cancellationToken) + { + var tmdbId = id.GetProviderId(MetadataProviders.Tmdb); + + // We don't already have an Id, need to fetch it + if (string.IsNullOrEmpty(tmdbId)) + { + tmdbId = await GetTmdbId(id.Name, cancellationToken).ConfigureAwait(false); + } + + var result = new MetadataResult<Person>(); + + if (!string.IsNullOrEmpty(tmdbId)) + { + await EnsurePersonInfo(tmdbId, cancellationToken).ConfigureAwait(false); + + var dataFilePath = GetPersonDataFilePath(_configurationManager.ApplicationPaths, tmdbId); + + var info = _jsonSerializer.DeserializeFromFile<PersonResult>(dataFilePath); + + var item = new Person(); + result.HasMetadata = true; + + item.Name = info.name; + item.HomePageUrl = info.homepage; + item.PlaceOfBirth = info.place_of_birth; + item.Overview = info.biography; + + DateTime date; + + if (DateTime.TryParseExact(info.birthday, "yyyy-MM-dd", new CultureInfo("en-US"), DateTimeStyles.None, out date)) + { + item.PremiereDate = date.ToUniversalTime(); + } + + if (DateTime.TryParseExact(info.deathday, "yyyy-MM-dd", new CultureInfo("en-US"), DateTimeStyles.None, out date)) + { + item.EndDate = date.ToUniversalTime(); + } + + item.SetProviderId(MetadataProviders.Tmdb, info.id.ToString(_usCulture)); + + if (!string.IsNullOrEmpty(info.imdb_id)) + { + item.SetProviderId(MetadataProviders.Imdb, info.imdb_id); + } + + result.Item = item; + } + + return result; + } + + private readonly CultureInfo _usCulture = new CultureInfo("en-US"); + + /// <summary> + /// Gets the TMDB id. + /// </summary> + /// <param name="name">The name.</param> + /// <param name="cancellationToken">The cancellation token.</param> + /// <returns>Task{System.String}.</returns> + private async Task<string> GetTmdbId(string name, CancellationToken cancellationToken) + { + string url = string.Format(@"http://api.themoviedb.org/3/search/person?api_key={1}&query={0}", WebUtility.UrlEncode(name), MovieDbProvider.ApiKey); + PersonSearchResults searchResult = null; + + using (var json = await MovieDbProvider.Current.GetMovieDbResponse(new HttpRequestOptions + { + Url = url, + CancellationToken = cancellationToken, + AcceptHeader = MovieDbProvider.AcceptHeader + + }).ConfigureAwait(false)) + { + searchResult = _jsonSerializer.DeserializeFromStream<PersonSearchResults>(json); + } + + return searchResult != null && searchResult.Total_Results > 0 ? searchResult.Results[0].Id.ToString(_usCulture) : null; + } + + internal async Task EnsurePersonInfo(string id, CancellationToken cancellationToken) + { + var dataFilePath = GetPersonDataFilePath(_configurationManager.ApplicationPaths, id); + + var fileInfo = _fileSystem.GetFileSystemInfo(dataFilePath); + + if (fileInfo.Exists && (DateTime.UtcNow - _fileSystem.GetLastWriteTimeUtc(fileInfo)).TotalDays <= 7) + { + return; + } + + var url = string.Format(@"http://api.themoviedb.org/3/person/{1}?api_key={0}&append_to_response=credits,images", MovieDbProvider.ApiKey, id); + + using (var json = await MovieDbProvider.Current.GetMovieDbResponse(new HttpRequestOptions + { + Url = url, + CancellationToken = cancellationToken, + AcceptHeader = MovieDbProvider.AcceptHeader + + }).ConfigureAwait(false)) + { + Directory.CreateDirectory(Path.GetDirectoryName(dataFilePath)); + + using (var fs = _fileSystem.GetFileStream(dataFilePath, FileMode.Create, FileAccess.Write, FileShare.Read, true)) + { + await json.CopyToAsync(fs).ConfigureAwait(false); + } + } + } + + private static string GetPersonDataPath(IApplicationPaths appPaths, string tmdbId) + { + var letter = tmdbId.GetMD5().ToString().Substring(0, 1); + + return Path.Combine(GetPersonsDataPath(appPaths), letter, tmdbId); + } + + internal static string GetPersonDataFilePath(IApplicationPaths appPaths, string tmdbId) + { + return Path.Combine(GetPersonDataPath(appPaths, tmdbId), DataFileName); + } + + private static string GetPersonsDataPath(IApplicationPaths appPaths) + { + return Path.Combine(appPaths.DataPath, "tmdb-people"); + } + + #region Result Objects + /// <summary> + /// Class PersonSearchResult + /// </summary> + public class PersonSearchResult + { + /// <summary> + /// Gets or sets a value indicating whether this <see cref="MovieDbPersonProvider.PersonSearchResult" /> is adult. + /// </summary> + /// <value><c>true</c> if adult; otherwise, <c>false</c>.</value> + public bool Adult { get; set; } + /// <summary> + /// Gets or sets the id. + /// </summary> + /// <value>The id.</value> + public int Id { get; set; } + /// <summary> + /// Gets or sets the name. + /// </summary> + /// <value>The name.</value> + public string Name { get; set; } + /// <summary> + /// Gets or sets the profile_ path. + /// </summary> + /// <value>The profile_ path.</value> + public string Profile_Path { get; set; } + } + + /// <summary> + /// Class PersonSearchResults + /// </summary> + public class PersonSearchResults + { + /// <summary> + /// Gets or sets the page. + /// </summary> + /// <value>The page.</value> + public int Page { get; set; } + /// <summary> + /// Gets or sets the results. + /// </summary> + /// <value>The results.</value> + public List<MovieDbPersonProvider.PersonSearchResult> Results { get; set; } + /// <summary> + /// Gets or sets the total_ pages. + /// </summary> + /// <value>The total_ pages.</value> + public int Total_Pages { get; set; } + /// <summary> + /// Gets or sets the total_ results. + /// </summary> + /// <value>The total_ results.</value> + public int Total_Results { get; set; } + } + + public class Cast + { + public int id { get; set; } + public string title { get; set; } + public string character { get; set; } + public string original_title { get; set; } + public string poster_path { get; set; } + public string release_date { get; set; } + public bool adult { get; set; } + } + + public class Crew + { + public int id { get; set; } + public string title { get; set; } + public string original_title { get; set; } + public string department { get; set; } + public string job { get; set; } + public string poster_path { get; set; } + public string release_date { get; set; } + public bool adult { get; set; } + } + + public class Credits + { + public List<Cast> cast { get; set; } + public List<Crew> crew { get; set; } + } + + public class Profile + { + public string file_path { get; set; } + public int width { get; set; } + public int height { get; set; } + public object iso_639_1 { get; set; } + public double aspect_ratio { get; set; } + } + + public class Images + { + public List<Profile> profiles { get; set; } + } + + public class PersonResult + { + public bool adult { get; set; } + public List<object> also_known_as { get; set; } + public string biography { get; set; } + public string birthday { get; set; } + public string deathday { get; set; } + public string homepage { get; set; } + public int id { get; set; } + public string imdb_id { get; set; } + public string name { get; set; } + public string place_of_birth { get; set; } + public double popularity { get; set; } + public string profile_path { get; set; } + public Credits credits { get; set; } + public Images images { get; set; } + } + + #endregion + } +} diff --git a/MediaBrowser.Providers/People/PersonMetadataService.cs b/MediaBrowser.Providers/People/PersonMetadataService.cs new file mode 100644 index 000000000..577158aa8 --- /dev/null +++ b/MediaBrowser.Providers/People/PersonMetadataService.cs @@ -0,0 +1,47 @@ +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 MediaBrowser.Providers.Manager; +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; + +namespace MediaBrowser.Providers.People +{ + public class PersonMetadataService : MetadataService<Person> + { + private readonly ILibraryManager _libraryManager; + + public PersonMetadataService(IServerConfigurationManager serverConfigurationManager, ILogger logger, IProviderManager providerManager, ILibraryManager libraryManager) + : base(serverConfigurationManager, logger, providerManager) + { + _libraryManager = libraryManager; + } + + /// <summary> + /// Merges the specified source. + /// </summary> + /// <param name="source">The source.</param> + /// <param name="target">The target.</param> + /// <param name="lockedFields">The locked fields.</param> + /// <param name="replaceData">if set to <c>true</c> [replace data].</param> + /// <param name="mergeMetadataSettings">if set to <c>true</c> [merge metadata settings].</param> + protected override void MergeData(Person source, Person target, List<MetadataFields> lockedFields, bool replaceData, bool mergeMetadataSettings) + { + ProviderUtils.MergeBaseItemData(source, target, lockedFields, replaceData, mergeMetadataSettings); + + if (replaceData || string.IsNullOrEmpty(target.PlaceOfBirth)) + { + target.PlaceOfBirth = source.PlaceOfBirth; + } + } + + protected override Task SaveItem(Person item, ItemUpdateType reason, CancellationToken cancellationToken) + { + return _libraryManager.UpdateItem(item, reason, cancellationToken); + } + } +} diff --git a/MediaBrowser.Providers/People/PersonXmlProvider.cs b/MediaBrowser.Providers/People/PersonXmlProvider.cs new file mode 100644 index 000000000..9da53e827 --- /dev/null +++ b/MediaBrowser.Providers/People/PersonXmlProvider.cs @@ -0,0 +1,64 @@ +using MediaBrowser.Common.IO; +using MediaBrowser.Controller.Entities; +using MediaBrowser.Controller.Providers; +using MediaBrowser.Model.Logging; +using System.IO; +using System.Threading; +using System.Threading.Tasks; + +namespace MediaBrowser.Providers.People +{ + public class PersonXmlProvider : BaseXmlProvider, ILocalMetadataProvider<Person> + { + private readonly ILogger _logger; + + public PersonXmlProvider(IFileSystem fileSystem, ILogger logger) + : base(fileSystem) + { + _logger = logger; + } + + public async Task<MetadataResult<Person>> GetMetadata(string path, CancellationToken cancellationToken) + { + path = GetXmlPath(path); + + var result = new MetadataResult<Person>(); + + await XmlParsingResourcePool.WaitAsync(cancellationToken).ConfigureAwait(false); + + try + { + var person = new Person(); + + new BaseItemXmlParser<Person>(_logger).Fetch(person, path, cancellationToken); + result.HasMetadata = true; + result.Item = person; + } + catch (FileNotFoundException) + { + result.HasMetadata = false; + } + finally + { + XmlParsingResourcePool.Release(); + } + + return result; + } + + public string Name + { + get { return "Media Browser Xml"; } + } + + protected override string GetXmlPath(string path) + { + return Path.Combine(path, "person.xml"); + } + + public bool HasLocalMetadata(IHasMetadata item) + { + return File.Exists(GetXmlPath(item.Path)); + } + } +} diff --git a/MediaBrowser.Providers/TV/ManualTvdbPersonImageProvider.cs b/MediaBrowser.Providers/People/TvdbPersonImageProvider.cs index 456db1048..aa4b9e0d8 100644 --- a/MediaBrowser.Providers/TV/ManualTvdbPersonImageProvider.cs +++ b/MediaBrowser.Providers/People/TvdbPersonImageProvider.cs @@ -1,10 +1,12 @@ -using MediaBrowser.Controller.Configuration; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities.TV; using MediaBrowser.Controller.Library; using MediaBrowser.Controller.Providers; using MediaBrowser.Model.Entities; using MediaBrowser.Model.Providers; +using MediaBrowser.Providers.TV; using System; using System.Collections.Generic; using System.IO; @@ -14,17 +16,19 @@ using System.Threading; using System.Threading.Tasks; using System.Xml; -namespace MediaBrowser.Providers.TV +namespace MediaBrowser.Providers.People { - public class ManualTvdbPersonImageProvider : IImageProvider + public class TvdbPersonImageProvider : IRemoteImageProvider { private readonly IServerConfigurationManager _config; private readonly ILibraryManager _library; + private readonly IHttpClient _httpClient; - public ManualTvdbPersonImageProvider(IServerConfigurationManager config, ILibraryManager library) + public TvdbPersonImageProvider(IServerConfigurationManager config, ILibraryManager library, IHttpClient httpClient) { _config = config; _library = library; + _httpClient = httpClient; } public string Name @@ -42,6 +46,14 @@ namespace MediaBrowser.Providers.TV return item is Person; } + public IEnumerable<ImageType> GetSupportedImages(IHasImages item) + { + return new List<ImageType> + { + ImageType.Primary + }; + } + public async Task<IEnumerable<RemoteImageInfo>> GetImages(IHasImages item, ImageType imageType, CancellationToken cancellationToken) { var images = await GetAllImages(item, cancellationToken).ConfigureAwait(false); @@ -184,9 +196,19 @@ namespace MediaBrowser.Providers.TV return null; } - public int Priority + public int Order { - get { return 0; } + get { return 1; } + } + + public Task<HttpResponseInfo> GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url, + ResourcePool = TvdbSeriesProvider.Current.TvDbResourcePool + }); } } } diff --git a/MediaBrowser.Providers/ProviderUtils.cs b/MediaBrowser.Providers/ProviderUtils.cs new file mode 100644 index 000000000..416ada42c --- /dev/null +++ b/MediaBrowser.Providers/ProviderUtils.cs @@ -0,0 +1,126 @@ +using MediaBrowser.Controller.Entities; +using MediaBrowser.Model.Entities; +using System.Collections.Generic; + +namespace MediaBrowser.Providers +{ + public static class ProviderUtils + { + public static void MergeBaseItemData(BaseItem source, BaseItem target, List<MetadataFields> lockedFields, bool replaceData, bool mergeMetadataSettings) + { + if (!lockedFields.Contains(MetadataFields.Name)) + { + if (replaceData || string.IsNullOrEmpty(target.Name)) + { + target.Name = source.Name; + } + } + + if (replaceData || !target.CommunityRating.HasValue) + { + target.CommunityRating = source.CommunityRating; + } + + if (replaceData || !target.EndDate.HasValue) + { + target.EndDate = source.EndDate; + } + + if (!lockedFields.Contains(MetadataFields.Genres)) + { + if (replaceData || target.Genres.Count == 0) + { + target.Genres = source.Genres; + } + } + + if (replaceData || string.IsNullOrEmpty(target.HomePageUrl)) + { + target.HomePageUrl = source.HomePageUrl; + } + + if (replaceData || !target.IndexNumber.HasValue) + { + target.IndexNumber = source.IndexNumber; + } + + if (!lockedFields.Contains(MetadataFields.OfficialRating)) + { + if (replaceData || string.IsNullOrEmpty(target.OfficialRating)) + { + target.OfficialRating = source.OfficialRating; + } + } + + if (replaceData || string.IsNullOrEmpty(target.OfficialRatingDescription)) + { + target.OfficialRatingDescription = source.OfficialRatingDescription; + } + + if (!lockedFields.Contains(MetadataFields.Overview)) + { + if (replaceData || string.IsNullOrEmpty(target.Overview)) + { + target.Overview = source.Overview; + } + } + + if (replaceData || !target.ParentIndexNumber.HasValue) + { + target.ParentIndexNumber = source.ParentIndexNumber; + } + + if (!lockedFields.Contains(MetadataFields.Cast)) + { + if (replaceData || target.People.Count == 0) + { + target.People = source.People; + } + } + + if (replaceData || !target.PremiereDate.HasValue) + { + target.PremiereDate = source.PremiereDate; + } + + if (replaceData || !target.ProductionYear.HasValue) + { + target.ProductionYear = source.ProductionYear; + } + + if (!lockedFields.Contains(MetadataFields.Runtime)) + { + if (replaceData || !target.RunTimeTicks.HasValue) + { + target.RunTimeTicks = source.RunTimeTicks; + } + } + + if (!lockedFields.Contains(MetadataFields.Studios)) + { + if (replaceData || target.Studios.Count == 0) + { + target.Studios = source.Studios; + } + } + + if (replaceData || !target.VoteCount.HasValue) + { + target.VoteCount = source.VoteCount; + } + + foreach (var id in source.ProviderIds) + { + target.ProviderIds[id.Key] = id.Value; + } + + if (mergeMetadataSettings) + { + target.ForcedSortName = source.ForcedSortName; + target.LockedFields = source.LockedFields; + target.DontFetchMeta = source.DontFetchMeta; + target.DisplayMediaType = source.DisplayMediaType; + } + } + } +} diff --git a/MediaBrowser.Providers/Studios/StudioMetadataService.cs b/MediaBrowser.Providers/Studios/StudioMetadataService.cs new file mode 100644 index 000000000..1a74d8317 --- /dev/null +++ b/MediaBrowser.Providers/Studios/StudioMetadataService.cs @@ -0,0 +1,41 @@ +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 MediaBrowser.Providers.Manager; +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; + +namespace MediaBrowser.Providers.Studios +{ + public class StudioMetadataService : MetadataService<Studio> + { + private readonly ILibraryManager _libraryManager; + + public StudioMetadataService(IServerConfigurationManager serverConfigurationManager, ILogger logger, IProviderManager providerManager, ILibraryManager libraryManager) + : base(serverConfigurationManager, logger, providerManager) + { + _libraryManager = libraryManager; + } + + /// <summary> + /// Merges the specified source. + /// </summary> + /// <param name="source">The source.</param> + /// <param name="target">The target.</param> + /// <param name="lockedFields">The locked fields.</param> + /// <param name="replaceData">if set to <c>true</c> [replace data].</param> + protected override void MergeData(Studio source, Studio target, List<MetadataFields> lockedFields, bool replaceData, bool mergeMetadataSettings) + { + ProviderUtils.MergeBaseItemData(source, target, lockedFields, replaceData, mergeMetadataSettings); + } + + protected override Task SaveItem(Studio item, ItemUpdateType reason, CancellationToken cancellationToken) + { + return _libraryManager.UpdateItem(item, reason, cancellationToken); + } + } +} diff --git a/MediaBrowser.Providers/ImagesByName/StudiosManualImageProvider.cs b/MediaBrowser.Providers/Studios/StudiosImageProvider.cs index 062f08020..eacec5b69 100644 --- a/MediaBrowser.Providers/ImagesByName/StudiosManualImageProvider.cs +++ b/MediaBrowser.Providers/Studios/StudiosImageProvider.cs @@ -5,15 +5,17 @@ using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Providers; using MediaBrowser.Model.Entities; using MediaBrowser.Model.Providers; +using MediaBrowser.Providers.Genres; +using MediaBrowser.Providers.ImagesByName; using System.Collections.Generic; using System.IO; using System.Linq; using System.Threading; using System.Threading.Tasks; -namespace MediaBrowser.Providers.ImagesByName +namespace MediaBrowser.Providers.Studios { - public class StudiosManualImageProvider : IImageProvider + public class StudiosImageProvider : IRemoteImageProvider { private readonly IServerConfigurationManager _config; private readonly IHttpClient _httpClient; @@ -21,7 +23,7 @@ namespace MediaBrowser.Providers.ImagesByName private readonly SemaphoreSlim _listResourcePool = new SemaphoreSlim(1, 1); - public StudiosManualImageProvider(IServerConfigurationManager config, IHttpClient httpClient, IFileSystem fileSystem) + public StudiosImageProvider(IServerConfigurationManager config, IHttpClient httpClient, IFileSystem fileSystem) { _config = config; _httpClient = httpClient; @@ -43,6 +45,15 @@ namespace MediaBrowser.Providers.ImagesByName return item is Studio; } + public IEnumerable<ImageType> GetSupportedImages(IHasImages item) + { + return new List<ImageType> + { + ImageType.Primary, + ImageType.Thumb + }; + } + public Task<IEnumerable<RemoteImageInfo>> GetImages(IHasImages item, ImageType imageType, CancellationToken cancellationToken) { return GetImages(item, imageType == ImageType.Primary, imageType == ImageType.Thumb, cancellationToken); @@ -120,9 +131,19 @@ namespace MediaBrowser.Providers.ImagesByName return ImageUtils.EnsureList(url, file, _httpClient, _fileSystem, _listResourcePool, cancellationToken); } - public int Priority + public int Order { get { return 0; } } + + public Task<HttpResponseInfo> GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url, + ResourcePool = GenreImageProvider.ImageDownloadResourcePool + }); + } } } diff --git a/MediaBrowser.Providers/TV/ManualFanartSeasonProvider.cs b/MediaBrowser.Providers/TV/ManualFanartSeasonProvider.cs index 503c56d0d..1d6f82a3a 100644 --- a/MediaBrowser.Providers/TV/ManualFanartSeasonProvider.cs +++ b/MediaBrowser.Providers/TV/ManualFanartSeasonProvider.cs @@ -1,4 +1,5 @@ -using MediaBrowser.Controller.Configuration; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities.TV; using MediaBrowser.Controller.Providers; @@ -17,14 +18,16 @@ using System.Xml; namespace MediaBrowser.Providers.TV { - public class ManualFanartSeasonImageProvider : IImageProvider + public class ManualFanartSeasonImageProvider : IRemoteImageProvider { private readonly CultureInfo _usCulture = new CultureInfo("en-US"); private readonly IServerConfigurationManager _config; + private readonly IHttpClient _httpClient; - public ManualFanartSeasonImageProvider(IServerConfigurationManager config) + public ManualFanartSeasonImageProvider(IServerConfigurationManager config, IHttpClient httpClient) { _config = config; + _httpClient = httpClient; } public string Name @@ -42,6 +45,15 @@ namespace MediaBrowser.Providers.TV return item is Season; } + public IEnumerable<ImageType> GetSupportedImages(IHasImages item) + { + return new List<ImageType> + { + ImageType.Backdrop, + ImageType.Thumb + }; + } + public async Task<IEnumerable<RemoteImageInfo>> GetImages(IHasImages item, ImageType imageType, CancellationToken cancellationToken) { var images = await GetAllImages(item, cancellationToken).ConfigureAwait(false); @@ -245,9 +257,19 @@ namespace MediaBrowser.Providers.TV } } - public int Priority + public int Order { - get { return 0; } + get { return 1; } + } + + public Task<HttpResponseInfo> GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url, + ResourcePool = FanartBaseProvider.FanArtResourcePool + }); } } } diff --git a/MediaBrowser.Providers/TV/ManualFanartSeriesProvider.cs b/MediaBrowser.Providers/TV/ManualFanartSeriesProvider.cs index 6a80f720a..b88a94e4e 100644 --- a/MediaBrowser.Providers/TV/ManualFanartSeriesProvider.cs +++ b/MediaBrowser.Providers/TV/ManualFanartSeriesProvider.cs @@ -1,4 +1,5 @@ -using MediaBrowser.Controller.Configuration; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities.TV; using MediaBrowser.Controller.Providers; @@ -17,14 +18,16 @@ using System.Xml; namespace MediaBrowser.Providers.TV { - public class ManualFanartSeriesImageProvider : IImageProvider + public class ManualFanartSeriesImageProvider : IRemoteImageProvider { private readonly CultureInfo _usCulture = new CultureInfo("en-US"); private readonly IServerConfigurationManager _config; + private readonly IHttpClient _httpClient; - public ManualFanartSeriesImageProvider(IServerConfigurationManager config) + public ManualFanartSeriesImageProvider(IServerConfigurationManager config, IHttpClient httpClient) { _config = config; + _httpClient = httpClient; } public string Name @@ -42,6 +45,19 @@ namespace MediaBrowser.Providers.TV return item is Series; } + public IEnumerable<ImageType> GetSupportedImages(IHasImages item) + { + return new List<ImageType> + { + ImageType.Primary, + ImageType.Thumb, + ImageType.Art, + ImageType.Logo, + ImageType.Backdrop, + ImageType.Banner + }; + } + public async Task<IEnumerable<RemoteImageInfo>> GetImages(IHasImages item, ImageType imageType, CancellationToken cancellationToken) { var images = await GetAllImages(item, cancellationToken).ConfigureAwait(false); @@ -302,9 +318,19 @@ namespace MediaBrowser.Providers.TV } } - public int Priority + public int Order { - get { return 0; } + get { return 1; } + } + + public Task<HttpResponseInfo> GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url, + ResourcePool = FanartBaseProvider.FanArtResourcePool + }); } } } diff --git a/MediaBrowser.Providers/TV/ManualTvdbEpisodeImageProvider.cs b/MediaBrowser.Providers/TV/ManualTvdbEpisodeImageProvider.cs index 6d38dee2e..abccc2947 100644 --- a/MediaBrowser.Providers/TV/ManualTvdbEpisodeImageProvider.cs +++ b/MediaBrowser.Providers/TV/ManualTvdbEpisodeImageProvider.cs @@ -1,4 +1,5 @@ -using MediaBrowser.Controller.Configuration; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities.TV; using MediaBrowser.Controller.Library; @@ -16,14 +17,16 @@ using System.Xml; namespace MediaBrowser.Providers.TV { - public class ManualTvdbEpisodeImageProvider : IImageProvider + public class ManualTvdbEpisodeImageProvider : IRemoteImageProvider { private readonly IServerConfigurationManager _config; private readonly CultureInfo _usCulture = new CultureInfo("en-US"); + private readonly IHttpClient _httpClient; - public ManualTvdbEpisodeImageProvider(IServerConfigurationManager config) + public ManualTvdbEpisodeImageProvider(IServerConfigurationManager config, IHttpClient httpClient) { _config = config; + _httpClient = httpClient; } public string Name @@ -36,6 +39,14 @@ namespace MediaBrowser.Providers.TV return item is Episode; } + public IEnumerable<ImageType> GetSupportedImages(IHasImages item) + { + return new List<ImageType> + { + ImageType.Primary + }; + } + public async Task<IEnumerable<RemoteImageInfo>> GetImages(IHasImages item, ImageType imageType, CancellationToken cancellationToken) { var images = await GetAllImages(item, cancellationToken).ConfigureAwait(false); @@ -161,9 +172,19 @@ namespace MediaBrowser.Providers.TV }; } - public int Priority + public int Order { get { return 0; } } + + public Task<HttpResponseInfo> GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url, + ResourcePool = TvdbSeriesProvider.Current.TvDbResourcePool + }); + } } } diff --git a/MediaBrowser.Providers/TV/ManualTvdbSeasonImageProvider.cs b/MediaBrowser.Providers/TV/ManualTvdbSeasonImageProvider.cs index d9a6f6507..f672942db 100644 --- a/MediaBrowser.Providers/TV/ManualTvdbSeasonImageProvider.cs +++ b/MediaBrowser.Providers/TV/ManualTvdbSeasonImageProvider.cs @@ -1,4 +1,5 @@ -using MediaBrowser.Controller.Configuration; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities.TV; using MediaBrowser.Controller.Library; @@ -18,14 +19,16 @@ using System.Xml; namespace MediaBrowser.Providers.TV { - public class ManualTvdbSeasonImageProvider : IImageProvider + public class ManualTvdbSeasonImageProvider : IRemoteImageProvider { private readonly IServerConfigurationManager _config; private readonly CultureInfo _usCulture = new CultureInfo("en-US"); + private readonly IHttpClient _httpClient; - public ManualTvdbSeasonImageProvider(IServerConfigurationManager config) + public ManualTvdbSeasonImageProvider(IServerConfigurationManager config, IHttpClient httpClient) { _config = config; + _httpClient = httpClient; } public string Name @@ -43,6 +46,16 @@ namespace MediaBrowser.Providers.TV return item is Season; } + public IEnumerable<ImageType> GetSupportedImages(IHasImages item) + { + return new List<ImageType> + { + ImageType.Primary, + ImageType.Banner, + ImageType.Backdrop + }; + } + public async Task<IEnumerable<RemoteImageInfo>> GetImages(IHasImages item, ImageType imageType, CancellationToken cancellationToken) { var images = await GetAllImages(item, cancellationToken).ConfigureAwait(false); @@ -308,9 +321,19 @@ namespace MediaBrowser.Providers.TV } - public int Priority + public int Order { - get { return 1; } + get { return 0; } + } + + public Task<HttpResponseInfo> GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url, + ResourcePool = TvdbSeriesProvider.Current.TvDbResourcePool + }); } } } diff --git a/MediaBrowser.Providers/TV/ManualTvdbSeriesImageProvider.cs b/MediaBrowser.Providers/TV/ManualTvdbSeriesImageProvider.cs index 644cad93b..a1c7114fc 100644 --- a/MediaBrowser.Providers/TV/ManualTvdbSeriesImageProvider.cs +++ b/MediaBrowser.Providers/TV/ManualTvdbSeriesImageProvider.cs @@ -1,4 +1,5 @@ -using MediaBrowser.Controller.Configuration; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities.TV; using MediaBrowser.Controller.Library; @@ -18,14 +19,16 @@ using System.Xml; namespace MediaBrowser.Providers.TV { - public class ManualTvdbSeriesImageProvider : IImageProvider + public class ManualTvdbSeriesImageProvider : IRemoteImageProvider { private readonly IServerConfigurationManager _config; + private readonly IHttpClient _httpClient; private readonly CultureInfo _usCulture = new CultureInfo("en-US"); - public ManualTvdbSeriesImageProvider(IServerConfigurationManager config) + public ManualTvdbSeriesImageProvider(IServerConfigurationManager config, IHttpClient httpClient) { _config = config; + _httpClient = httpClient; } public string Name @@ -43,6 +46,16 @@ namespace MediaBrowser.Providers.TV return item is Series; } + public IEnumerable<ImageType> GetSupportedImages(IHasImages item) + { + return new List<ImageType> + { + ImageType.Primary, + ImageType.Banner, + ImageType.Backdrop + }; + } + public async Task<IEnumerable<RemoteImageInfo>> GetImages(IHasImages item, ImageType imageType, CancellationToken cancellationToken) { var images = await GetAllImages(item, cancellationToken).ConfigureAwait(false); @@ -304,9 +317,19 @@ namespace MediaBrowser.Providers.TV } - public int Priority + public int Order { - get { return 1; } + get { return 0; } + } + + public Task<HttpResponseInfo> GetImageResponse(string url, CancellationToken cancellationToken) + { + return _httpClient.GetResponse(new HttpRequestOptions + { + CancellationToken = cancellationToken, + Url = url, + ResourcePool = TvdbSeriesProvider.Current.TvDbResourcePool + }); } } } diff --git a/MediaBrowser.Providers/TV/TvdbPersonImageProvider.cs b/MediaBrowser.Providers/TV/TvdbPersonImageProvider.cs deleted file mode 100644 index f2ce92efd..000000000 --- a/MediaBrowser.Providers/TV/TvdbPersonImageProvider.cs +++ /dev/null @@ -1,98 +0,0 @@ -using MediaBrowser.Controller.Configuration; -using MediaBrowser.Controller.Entities; -using MediaBrowser.Controller.Providers; -using MediaBrowser.Model.Entities; -using MediaBrowser.Model.Logging; -using MediaBrowser.Model.Providers; -using System; -using System.Collections.Generic; -using System.Linq; -using System.Threading; -using System.Threading.Tasks; - -namespace MediaBrowser.Providers.TV -{ - public class TvdbPersonImageProvider : BaseMetadataProvider - { - private readonly IProviderManager _providerManager; - - public TvdbPersonImageProvider(ILogManager logManager, IServerConfigurationManager configurationManager, IProviderManager providerManager) - : base(logManager, configurationManager) - { - _providerManager = providerManager; - } - - protected override bool RefreshOnVersionChange - { - get - { - return true; - } - } - - protected override string ProviderVersion - { - get - { - return "2"; - } - } - - public override bool RequiresInternet - { - get - { - return true; - } - } - - public override bool Supports(BaseItem item) - { - return item is Person; - } - - /// <summary> - /// Fetches metadata and returns true or false indicating if any work that requires persistence was done - /// </summary> - /// <param name="item">The item.</param> - /// <param name="force">if set to <c>true</c> [force].</param> - /// <param name="cancellationToken">The cancellation token.</param> - /// <returns>Task{System.Boolean}.</returns> - public override async Task<bool> FetchAsync(BaseItem item, bool force, BaseProviderInfo providerInfo, CancellationToken cancellationToken) - { - if (string.IsNullOrEmpty(item.PrimaryImagePath)) - { - cancellationToken.ThrowIfCancellationRequested(); - - var images = await _providerManager.GetAvailableRemoteImages(item, cancellationToken, ManualTvdbPersonImageProvider.ProviderName).ConfigureAwait(false); - - await DownloadImages(item, images.ToList(), cancellationToken).ConfigureAwait(false); - - SetLastRefreshed(item, DateTime.UtcNow, providerInfo); - return true; - } - - SetLastRefreshed(item, DateTime.UtcNow, providerInfo); - return true; - } - - private async Task DownloadImages(BaseItem item, List<RemoteImageInfo> images, CancellationToken cancellationToken) - { - if (!item.HasImage(ImageType.Primary) && !item.LockedFields.Contains(MetadataFields.Images)) - { - var image = images.FirstOrDefault(i => i.Type == ImageType.Primary); - - if (image != null) - { - await _providerManager.SaveImage(item, image.Url, TvdbSeriesProvider.Current.TvDbResourcePool, ImageType.Primary, null, cancellationToken) - .ConfigureAwait(false); - } - } - } - - public override MetadataProviderPriority Priority - { - get { return MetadataProviderPriority.Fourth; } - } - } -} diff --git a/MediaBrowser.Providers/VirtualItemImageValidator.cs b/MediaBrowser.Providers/VirtualItemImageValidator.cs index f3f32b2b3..892275d38 100644 --- a/MediaBrowser.Providers/VirtualItemImageValidator.cs +++ b/MediaBrowser.Providers/VirtualItemImageValidator.cs @@ -44,14 +44,6 @@ namespace MediaBrowser.Providers public override Task<bool> FetchAsync(BaseItem item, bool force, BaseProviderInfo providerInfo, CancellationToken cancellationToken) { item.ValidateImages(); - item.ValidateBackdrops(); - - var hasScreenshots = item as IHasScreenshots; - - if (hasScreenshots != null) - { - hasScreenshots.ValidateScreenshots(); - } SetLastRefreshed(item, DateTime.UtcNow, providerInfo); return TrueTaskResult; |
