using MediaBrowser.Common.IO; using MediaBrowser.Common.Net; using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities.TV; using MediaBrowser.Controller.IO; using MediaBrowser.Controller.Library; using MediaBrowser.Controller.Providers; 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.Text; using System.Threading; using System.Threading.Tasks; using System.Xml; namespace MediaBrowser.Providers.TV { public class TvdbSeriesImageProvider : BaseMetadataProvider { /// /// Gets the HTTP client. /// /// The HTTP client. protected IHttpClient HttpClient { get; private set; } /// /// The _provider manager /// private readonly IProviderManager _providerManager; private readonly IFileSystem _fileSystem; /// /// Initializes a new instance of the class. /// /// The HTTP client. /// The log manager. /// The configuration manager. /// The provider manager. /// httpClient public TvdbSeriesImageProvider(IHttpClient httpClient, ILogManager logManager, IServerConfigurationManager configurationManager, IProviderManager providerManager, IFileSystem fileSystem) : base(logManager, configurationManager) { if (httpClient == null) { throw new ArgumentNullException("httpClient"); } HttpClient = httpClient; _providerManager = providerManager; _fileSystem = fileSystem; } /// /// Supportses the specified item. /// /// The item. /// true if XXXX, false otherwise public override bool Supports(BaseItem item) { return item is Series; } /// /// Gets the priority. /// /// The priority. public override MetadataProviderPriority Priority { // Run after fanart get { return MetadataProviderPriority.Fourth; } } /// /// Gets a value indicating whether [requires internet]. /// /// true if [requires internet]; otherwise, false. public override bool RequiresInternet { get { return true; } } public override ItemUpdateType ItemUpdateType { get { return ItemUpdateType.ImageUpdate; } } /// /// Gets a value indicating whether [refresh on version change]. /// /// true if [refresh on version change]; otherwise, false. protected override bool RefreshOnVersionChange { get { return true; } } /// /// Gets the provider version. /// /// The provider version. protected override string ProviderVersion { get { return "1"; } } protected override DateTime CompareDate(BaseItem item) { var seriesId = item.GetProviderId(MetadataProviders.Tvdb); if (!string.IsNullOrEmpty(seriesId)) { // Process images var imagesXmlPath = Path.Combine(RemoteSeriesProvider.GetSeriesDataPath(ConfigurationManager.ApplicationPaths, seriesId), "banners.xml"); var imagesFileInfo = new FileInfo(imagesXmlPath); if (imagesFileInfo.Exists) { return _fileSystem.GetLastWriteTimeUtc(imagesFileInfo); } } return base.CompareDate(item); } protected override bool NeedsRefreshInternal(BaseItem item, BaseProviderInfo providerInfo) { if (item.HasImage(ImageType.Primary) && item.HasImage(ImageType.Banner) && item.BackdropImagePaths.Count >= ConfigurationManager.Configuration.MaxBackdrops) { return false; } return base.NeedsRefreshInternal(item, providerInfo); } /// /// Fetches metadata and returns true or false indicating if any work that requires persistence was done /// /// The item. /// if set to true [force]. /// The cancellation token. /// Task{System.Boolean}. public override async Task FetchAsync(BaseItem item, bool force, CancellationToken cancellationToken) { cancellationToken.ThrowIfCancellationRequested(); var series = (Series)item; var seriesId = series.GetProviderId(MetadataProviders.Tvdb); if (!string.IsNullOrEmpty(seriesId)) { // Process images var seriesDataPath = RemoteSeriesProvider.GetSeriesDataPath(ConfigurationManager.ApplicationPaths, seriesId); var imagesXmlPath = Path.Combine(seriesDataPath, "banners.xml"); var backdropLimit = ConfigurationManager.Configuration.MaxBackdrops; if (!series.HasImage(ImageType.Primary) || !series.HasImage(ImageType.Banner) || series.BackdropImagePaths.Count < backdropLimit) { Directory.CreateDirectory(seriesDataPath); try { var fanartData = FetchFanartXmlData(imagesXmlPath, backdropLimit, cancellationToken); await DownloadImages(item, fanartData, backdropLimit, cancellationToken).ConfigureAwait(false); } catch (FileNotFoundException) { // No biggie. Not all series have images } } SetLastRefreshed(item, DateTime.UtcNow); return true; } return false; } protected readonly CultureInfo UsCulture = new CultureInfo("en-US"); private async Task DownloadImages(BaseItem item, FanartXmlData data, int backdropLimit, CancellationToken cancellationToken) { if (!item.HasImage(ImageType.Primary)) { var url = data.LanguagePoster ?? data.Poster; if (!string.IsNullOrEmpty(url)) { url = TVUtils.BannerUrl + url; await _providerManager.SaveImage(item, url, RemoteSeriesProvider.Current.TvDbResourcePool, ImageType.Primary, null, cancellationToken) .ConfigureAwait(false); } } if (ConfigurationManager.Configuration.DownloadSeriesImages.Banner && !item.HasImage(ImageType.Banner)) { var url = data.LanguageBanner ?? data.Banner; if (!string.IsNullOrEmpty(url)) { url = TVUtils.BannerUrl + url; await _providerManager.SaveImage(item, url, RemoteSeriesProvider.Current.TvDbResourcePool, ImageType.Banner, null, cancellationToken) .ConfigureAwait(false); } } if (ConfigurationManager.Configuration.DownloadSeriesImages.Backdrops && item.BackdropImagePaths.Count < backdropLimit) { var bdNo = item.BackdropImagePaths.Count; var eligibleBackdrops = data.Backdrops .Where(i => { if (string.IsNullOrEmpty(i.Resolution)) { return true; } var parts = i.Resolution.Split('x'); int width; if (int.TryParse(parts[0], NumberStyles.Any, UsCulture, out width)) { return width >= ConfigurationManager.Configuration.MinSeriesBackdropWidth; } return true; }) .ToList(); foreach (var backdrop in eligibleBackdrops) { var url = TVUtils.BannerUrl + backdrop.Url; if (item.ContainsImageWithSourceUrl(url)) { continue; } await _providerManager.SaveImage(item, url, RemoteSeriesProvider.Current.TvDbResourcePool, ImageType.Backdrop, bdNo, cancellationToken) .ConfigureAwait(false); bdNo++; if (item.BackdropImagePaths.Count >= backdropLimit) break; } } } private FanartXmlData FetchFanartXmlData(string bannersXmlPath, int backdropLimit, CancellationToken cancellationToken) { var settings = new XmlReaderSettings { CheckCharacters = false, IgnoreProcessingInstructions = true, IgnoreComments = true, ValidationType = ValidationType.None }; var data = new FanartXmlData(); using (var streamReader = new StreamReader(bannersXmlPath, Encoding.UTF8)) { // Use XmlReader for best performance using (var reader = XmlReader.Create(streamReader, settings)) { reader.MoveToContent(); // Loop through each element while (reader.Read()) { cancellationToken.ThrowIfCancellationRequested(); if (reader.NodeType == XmlNodeType.Element) { switch (reader.Name) { case "Banner": { using (var subtree = reader.ReadSubtree()) { FetchInfoFromBannerNode(data, subtree, backdropLimit); } break; } default: reader.Skip(); break; } } } } } return data; } private void FetchInfoFromBannerNode(FanartXmlData data, XmlReader reader, int backdropLimit) { reader.MoveToContent(); string type = null; string url = null; string resolution = null; while (reader.Read()) { if (reader.NodeType == XmlNodeType.Element) { switch (reader.Name) { case "BannerType": { type = reader.ReadElementContentAsString() ?? string.Empty; if (string.Equals(type, "poster", StringComparison.OrdinalIgnoreCase)) { // Already got it if (!string.IsNullOrEmpty(data.Poster)) { return; } } else if (string.Equals(type, "series", StringComparison.OrdinalIgnoreCase)) { // Already got it if (!string.IsNullOrEmpty(data.Banner)) { return; } } else { return; } break; } case "BannerPath": { url = reader.ReadElementContentAsString() ?? string.Empty; break; } case "BannerType2": { resolution = reader.ReadElementContentAsString() ?? string.Empty; break; } default: reader.Skip(); break; } } } if (!string.IsNullOrEmpty(url)) { if (string.Equals(type, "poster", StringComparison.OrdinalIgnoreCase)) { // Just grab the first if (string.IsNullOrWhiteSpace(data.Poster)) { data.Poster = url; } } else if (string.Equals(type, "series", StringComparison.OrdinalIgnoreCase)) { // Just grab the first if (string.IsNullOrWhiteSpace(data.Banner)) { data.Banner = url; } } else if (string.Equals(type, "fanart", StringComparison.OrdinalIgnoreCase)) { data.Backdrops.Add(new ImageInfo { Url = url, Resolution = resolution }); } } } } internal class FanartXmlData { public string LanguagePoster { get; set; } public string LanguageBanner { get; set; } public string Poster { get; set; } public string Banner { get; set; } public List Backdrops = new List(); } internal class ImageInfo { public string Url { get; set; } public string Resolution { get; set; } } }