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.Entities.Audio; 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.Threading; using System.Threading.Tasks; using System.Xml; namespace MediaBrowser.Providers.Music { /// /// Class FanArtArtistProvider /// public class FanArtArtistProvider : FanartBaseProvider { /// /// Gets the HTTP client. /// /// The HTTP client. protected IHttpClient HttpClient { get; private set; } /// /// The _provider manager /// private readonly IProviderManager _providerManager; internal static FanArtArtistProvider Current; /// /// Initializes a new instance of the class. /// /// The HTTP client. /// The log manager. /// The configuration manager. /// The provider manager. /// httpClient public FanArtArtistProvider(IHttpClient httpClient, ILogManager logManager, IServerConfigurationManager configurationManager, IProviderManager providerManager) : base(logManager, configurationManager) { if (httpClient == null) { throw new ArgumentNullException("httpClient"); } HttpClient = httpClient; _providerManager = providerManager; Current = this; } /// /// The fan art base URL /// protected string FanArtBaseUrl = "http://api.fanart.tv/webservice/artist/{0}/{1}/xml/all/1/1"; public override ItemUpdateType ItemUpdateType { get { return ItemUpdateType.ImageUpdate; } } /// /// Supportses the specified item. /// /// The item. /// true if XXXX, false otherwise public override bool Supports(BaseItem item) { return item is MusicArtist; } /// /// Gets a value indicating whether [save local meta]. /// /// true if [save local meta]; otherwise, false. protected virtual bool SaveLocalMeta { get { return ConfigurationManager.Configuration.SaveLocalMeta; } } /// /// 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 "7"; } } /// /// Needses the refresh internal. /// /// The item. /// The provider info. /// true if XXXX, false otherwise protected override bool NeedsRefreshInternal(BaseItem item, BaseProviderInfo providerInfo) { if (string.IsNullOrEmpty(item.GetProviderId(MetadataProviders.Musicbrainz))) { return false; } if (!ConfigurationManager.Configuration.DownloadMusicArtistImages.Art && !ConfigurationManager.Configuration.DownloadMusicArtistImages.Backdrops && !ConfigurationManager.Configuration.DownloadMusicArtistImages.Banner && !ConfigurationManager.Configuration.DownloadMusicArtistImages.Logo && !ConfigurationManager.Configuration.DownloadMusicArtistImages.Primary && // The fanart album provider depends on xml downloaded here, so honor it's settings too !ConfigurationManager.Configuration.DownloadMusicAlbumImages.Disc && !ConfigurationManager.Configuration.DownloadMusicAlbumImages.Primary) { return false; } return base.NeedsRefreshInternal(item, providerInfo); } protected override DateTime CompareDate(BaseItem item) { var musicBrainzId = item.GetProviderId(MetadataProviders.Musicbrainz); if (!string.IsNullOrEmpty(musicBrainzId)) { // Process images var path = GetArtistDataPath(ConfigurationManager.ApplicationPaths, musicBrainzId); var files = new DirectoryInfo(path) .EnumerateFiles("*.xml", SearchOption.TopDirectoryOnly) .Select(i => i.LastWriteTimeUtc) .ToArray(); if (files.Length > 0) { return files.Max(); } } return base.CompareDate(item); } /// /// The us culture /// protected readonly CultureInfo UsCulture = new CultureInfo("en-US"); /// /// Gets the series data path. /// /// The app paths. /// The music brainz artist id. /// System.String. internal static string GetArtistDataPath(IApplicationPaths appPaths, string musicBrainzArtistId) { var seriesDataPath = Path.Combine(GetArtistDataPath(appPaths), musicBrainzArtistId); if (!Directory.Exists(seriesDataPath)) { Directory.CreateDirectory(seriesDataPath); } return seriesDataPath; } /// /// Gets the series data path. /// /// The app paths. /// System.String. internal static string GetArtistDataPath(IApplicationPaths appPaths) { var dataPath = Path.Combine(appPaths.DataPath, "fanart-music"); if (!Directory.Exists(dataPath)) { Directory.CreateDirectory(dataPath); } return dataPath; } /// /// 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 musicBrainzId = item.GetProviderId(MetadataProviders.Musicbrainz); var artistDataPath = GetArtistDataPath(ConfigurationManager.ApplicationPaths, musicBrainzId); var xmlPath = Path.Combine(artistDataPath, "fanart.xml"); // Only download the xml if it doesn't already exist. The prescan task will take care of getting updates if (!File.Exists(xmlPath)) { await DownloadArtistXml(artistDataPath, musicBrainzId, cancellationToken).ConfigureAwait(false); } if (ConfigurationManager.Configuration.DownloadMusicArtistImages.Art || ConfigurationManager.Configuration.DownloadMusicArtistImages.Backdrops || ConfigurationManager.Configuration.DownloadMusicArtistImages.Banner || ConfigurationManager.Configuration.DownloadMusicArtistImages.Logo || ConfigurationManager.Configuration.DownloadMusicArtistImages.Primary) { if (File.Exists(xmlPath)) { await FetchFromXml(item, xmlPath, cancellationToken).ConfigureAwait(false); } } BaseProviderInfo data; if (!item.ProviderData.TryGetValue(Id, out data)) { data = new BaseProviderInfo(); item.ProviderData[Id] = data; } SetLastRefreshed(item, DateTime.UtcNow); return true; } /// /// Downloads the artist XML. /// /// The artist path. /// The music brainz id. /// The cancellation token. /// Task{System.Boolean}. internal async Task DownloadArtistXml(string artistPath, string musicBrainzId, CancellationToken cancellationToken) { cancellationToken.ThrowIfCancellationRequested(); var url = string.Format(FanArtBaseUrl, ApiKey, musicBrainzId); var xmlPath = Path.Combine(artistPath, "fanart.xml"); using (var response = await HttpClient.Get(new HttpRequestOptions { Url = url, ResourcePool = FanArtResourcePool, CancellationToken = cancellationToken }).ConfigureAwait(false)) { using (var xmlFileStream = new FileStream(xmlPath, FileMode.Create, FileAccess.Write, FileShare.Read, StreamDefaults.DefaultFileStreamBufferSize, FileOptions.Asynchronous)) { await response.CopyToAsync(xmlFileStream).ConfigureAwait(false); } } } /// /// Fetches from XML. /// /// The item. /// The XML file path. /// The cancellation token. /// Task. private async Task FetchFromXml(BaseItem item, string xmlFilePath, CancellationToken cancellationToken) { var doc = new XmlDocument(); doc.Load(xmlFilePath); cancellationToken.ThrowIfCancellationRequested(); string path; var hd = ConfigurationManager.Configuration.DownloadHDFanArt ? "hd" : ""; if (ConfigurationManager.Configuration.DownloadMusicArtistImages.Logo && !item.HasImage(ImageType.Logo)) { var node = doc.SelectSingleNode("//fanart/music/musiclogos/" + hd + "musiclogo/@url") ?? doc.SelectSingleNode("//fanart/music/musiclogos/musiclogo/@url"); path = node != null ? node.Value : null; if (!string.IsNullOrEmpty(path)) { item.SetImage(ImageType.Logo, await _providerManager.DownloadAndSaveImage(item, path, LogoFile, SaveLocalMeta, FanArtResourcePool, cancellationToken).ConfigureAwait(false)); } } cancellationToken.ThrowIfCancellationRequested(); if (ConfigurationManager.Configuration.DownloadMusicArtistImages.Backdrops && item.BackdropImagePaths.Count == 0) { var nodes = doc.SelectNodes("//fanart/music/artistbackgrounds//@url"); if (nodes != null) { var numBackdrops = 0; item.BackdropImagePaths = new List(); foreach (XmlNode node in nodes) { path = node.Value; if (!string.IsNullOrEmpty(path)) { item.BackdropImagePaths.Add(await _providerManager.DownloadAndSaveImage(item, path, ("Backdrop" + (numBackdrops > 0 ? numBackdrops.ToString(UsCulture) : "") + ".jpg"), SaveLocalMeta, FanArtResourcePool, cancellationToken).ConfigureAwait(false)); numBackdrops++; if (numBackdrops >= ConfigurationManager.Configuration.MaxBackdrops) break; } } } } cancellationToken.ThrowIfCancellationRequested(); if (ConfigurationManager.Configuration.DownloadMusicArtistImages.Art && !item.HasImage(ImageType.Art)) { var node = doc.SelectSingleNode("//fanart/music/musicarts/" + hd + "musicart/@url") ?? doc.SelectSingleNode("//fanart/music/musicarts/musicart/@url"); path = node != null ? node.Value : null; if (!string.IsNullOrEmpty(path)) { item.SetImage(ImageType.Art, await _providerManager.DownloadAndSaveImage(item, path, ArtFile, SaveLocalMeta, FanArtResourcePool, cancellationToken).ConfigureAwait(false)); } } cancellationToken.ThrowIfCancellationRequested(); if (ConfigurationManager.Configuration.DownloadMusicArtistImages.Banner && !item.HasImage(ImageType.Banner)) { var node = doc.SelectSingleNode("//fanart/music/musicbanners/" + hd + "musicbanner/@url") ?? doc.SelectSingleNode("//fanart/music/musicbanners/musicbanner/@url"); path = node != null ? node.Value : null; if (!string.IsNullOrEmpty(path)) { item.SetImage(ImageType.Banner, await _providerManager.DownloadAndSaveImage(item, path, BannerFile, SaveLocalMeta, FanArtResourcePool, cancellationToken).ConfigureAwait(false)); } } cancellationToken.ThrowIfCancellationRequested(); // Artist thumbs are actually primary images (they are square/portrait) if (ConfigurationManager.Configuration.DownloadMusicArtistImages.Primary && !item.HasImage(ImageType.Primary)) { var node = doc.SelectSingleNode("//fanart/music/artistthumbs/artistthumb/@url"); path = node != null ? node.Value : null; if (!string.IsNullOrEmpty(path)) { item.SetImage(ImageType.Primary, await _providerManager.DownloadAndSaveImage(item, path, PrimaryFile, SaveLocalMeta, FanArtResourcePool, cancellationToken).ConfigureAwait(false)); } } } } }