jellyfin/MediaBrowser.Controller/Providers/Movies/FanArtMovieProvider.cs

using MediaBrowser.Common.Extensions;
using MediaBrowser.Common.Net;
using MediaBrowser.Controller.Configuration;
using MediaBrowser.Controller.Entities;
using MediaBrowser.Controller.Entities.Movies;
using MediaBrowser.Model.Entities;
using MediaBrowser.Model.Logging;
using MediaBrowser.Model.Net;
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Threading;
using System.Threading.Tasks;
using System.Xml;

namespace MediaBrowser.Controller.Providers.Movies
{
    /// <summary>
    /// Class FanArtMovieProvider
    /// </summary>
    class FanArtMovieProvider : FanartBaseProvider, IDisposable
    {
        /// <summary>
        /// Gets the HTTP client.
        /// </summary>
        /// <value>The HTTP client.</value>
        protected IHttpClient HttpClient { get; private set; }

        private readonly IProviderManager _providerManager;

        private static readonly CultureInfo UsCulture = new CultureInfo("en-US");

        /// <summary>
        /// Initializes a new instance of the <see cref="FanArtMovieProvider" /> class.
        /// </summary>
        /// <param name="httpClient">The HTTP client.</param>
        /// <param name="logManager">The log manager.</param>
        /// <param name="configurationManager">The configuration manager.</param>
        /// <param name="providerManager">The provider manager.</param>
        /// <exception cref="System.ArgumentNullException">httpClient</exception>
        public FanArtMovieProvider(IHttpClient httpClient, ILogManager logManager, IServerConfigurationManager configurationManager, IProviderManager providerManager)
            : base(logManager, configurationManager)
        {
            if (httpClient == null)
            {
                throw new ArgumentNullException("httpClient");
            }
            HttpClient = httpClient;
            _providerManager = providerManager;
        }

        /// <summary>
        /// Releases unmanaged and - optionally - managed resources.
        /// </summary>
        /// <param name="dispose"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
        protected virtual void Dispose(bool dispose)
        {
            if (dispose)
            {
                FanArtResourcePool.Dispose();
            }
        }

        /// <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 "12";
            }
        }
        
        /// <summary>
        /// The fan art base URL
        /// </summary>
        protected string FanArtBaseUrl = "http://api.fanart.tv/webservice/movie/{0}/{1}/xml/all/1/1";

        /// <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)
        {
            var trailer = item as Trailer;

            if (trailer != null)
            {
                return !trailer.IsLocalTrailer;
            }

            return item is Movie || item is BoxSet;
        }

        /// <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;
            }
            
            if (!ConfigurationManager.Configuration.DownloadMovieImages.Art &&
                !ConfigurationManager.Configuration.DownloadMovieImages.Logo &&
                !ConfigurationManager.Configuration.DownloadMovieImages.Disc &&
                !ConfigurationManager.Configuration.DownloadMovieImages.Backdrops &&
                !ConfigurationManager.Configuration.DownloadMovieImages.Banner &&
                !ConfigurationManager.Configuration.DownloadMovieImages.Thumb)
            {
                return false;
            }

            // Refresh if tmdb id has changed
            if (providerInfo.Data != GetComparisonData(item.GetProviderId(MetadataProviders.Tmdb)))
            {
                return true;
            }

            return base.NeedsRefreshInternal(item, providerInfo);
        }

        /// <summary>
        /// Gets the comparison data.
        /// </summary>
        /// <returns>Guid.</returns>
        private Guid GetComparisonData(string id)
        {
            return string.IsNullOrEmpty(id) ? Guid.Empty : id.GetMD5();
        }

        /// <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, CancellationToken cancellationToken)
        {
            cancellationToken.ThrowIfCancellationRequested();

            BaseProviderInfo data;

            if (!item.ProviderData.TryGetValue(Id, out data))
            {
                data = new BaseProviderInfo();
                item.ProviderData[Id] = data;
            }

            var status = ProviderRefreshStatus.Success;
            
            var movie = item;

            var language = ConfigurationManager.Configuration.PreferredMetadataLanguage.ToLower();
            var url = string.Format(FanArtBaseUrl, APIKey, movie.GetProviderId(MetadataProviders.Tmdb));
            var doc = new XmlDocument();

            using (var xml = await HttpClient.Get(new HttpRequestOptions
            {
                Url = url,
                ResourcePool = FanArtResourcePool,
                CancellationToken = cancellationToken,
                EnableResponseCache = true

            }).ConfigureAwait(false))
            {
                doc.Load(xml);
            }

            cancellationToken.ThrowIfCancellationRequested();

            var saveLocal = ConfigurationManager.Configuration.SaveLocalMeta &&
                            item.LocationType == LocationType.FileSystem;

            if (doc.HasChildNodes)
            {
                string path;
                var hd = ConfigurationManager.Configuration.DownloadHDFanArt ? "hd" : "";

                var hasLogo = item.LocationType == LocationType.FileSystem ? 
                    item.ResolveArgs.ContainsMetaFileByName(LOGO_FILE) 
                    : item.HasImage(ImageType.Logo);

                if (ConfigurationManager.Configuration.DownloadMovieImages.Logo && !hasLogo)
                {
                    var node =
                        doc.SelectSingleNode("//fanart/movie/movielogos/" + hd + "movielogo[@lang = \"" + language + "\"]/@url") ??
                        doc.SelectSingleNode("//fanart/movie/movielogos/movielogo[@lang = \"" + language + "\"]/@url");
                    if (node == null && language != "en")
                    {
                        //maybe just couldn't find language - try just first one
                        node = doc.SelectSingleNode("//fanart/movie/movielogos/" + hd + "movielogo/@url");
                    }
                    path = node != null ? node.Value : null;
                    if (!string.IsNullOrEmpty(path))
                    {
                        movie.SetImage(ImageType.Logo, await _providerManager.DownloadAndSaveImage(movie, path, LOGO_FILE, saveLocal, FanArtResourcePool, cancellationToken).ConfigureAwait(false));
                    }
                }
                cancellationToken.ThrowIfCancellationRequested();

                var hasArt = item.LocationType == LocationType.FileSystem ?
                    item.ResolveArgs.ContainsMetaFileByName(ART_FILE)
                    : item.HasImage(ImageType.Art);

                if (ConfigurationManager.Configuration.DownloadMovieImages.Art && !hasArt)
                {
                    var node =
                        doc.SelectSingleNode("//fanart/movie/moviearts/" + hd + "movieart[@lang = \"" + language + "\"]/@url") ??
                        doc.SelectSingleNode("//fanart/movie/moviearts/" + hd + "movieart/@url") ??
                        doc.SelectSingleNode("//fanart/movie/moviearts/movieart[@lang = \"" + language + "\"]/@url") ??
                        doc.SelectSingleNode("//fanart/movie/moviearts/movieart/@url");
                    path = node != null ? node.Value : null;
                    if (!string.IsNullOrEmpty(path))
                    {
                        movie.SetImage(ImageType.Art, await _providerManager.DownloadAndSaveImage(movie, path, ART_FILE, saveLocal, FanArtResourcePool, cancellationToken).ConfigureAwait(false));
                    }
                }
                cancellationToken.ThrowIfCancellationRequested();

                var hasDisc = item.LocationType == LocationType.FileSystem ?
                    item.ResolveArgs.ContainsMetaFileByName(DISC_FILE)
                    : item.HasImage(ImageType.Disc);

                if (ConfigurationManager.Configuration.DownloadMovieImages.Disc && !hasDisc)
                {
                    var node = doc.SelectSingleNode("//fanart/movie/moviediscs/moviedisc[@lang = \"" + language + "\"]/@url") ??
                               doc.SelectSingleNode("//fanart/movie/moviediscs/moviedisc/@url");
                    path = node != null ? node.Value : null;
                    if (!string.IsNullOrEmpty(path))
                    {
                        movie.SetImage(ImageType.Disc, await _providerManager.DownloadAndSaveImage(movie, path, DISC_FILE, saveLocal, FanArtResourcePool, cancellationToken).ConfigureAwait(false));
                    }
                }

                cancellationToken.ThrowIfCancellationRequested();

                var hasBanner = item.LocationType == LocationType.FileSystem ?
                    item.ResolveArgs.ContainsMetaFileByName(BANNER_FILE)
                    : item.HasImage(ImageType.Banner);

                if (ConfigurationManager.Configuration.DownloadMovieImages.Banner && !hasBanner)
                {
                    var node = doc.SelectSingleNode("//fanart/movie/moviebanners/moviebanner[@lang = \"" + language + "\"]/@url") ??
                               doc.SelectSingleNode("//fanart/movie/moviebanners/moviebanner/@url");
                    path = node != null ? node.Value : null;
                    if (!string.IsNullOrEmpty(path))
                    {
                        movie.SetImage(ImageType.Banner, await _providerManager.DownloadAndSaveImage(movie, path, BANNER_FILE, saveLocal, FanArtResourcePool, cancellationToken).ConfigureAwait(false));
                    }
                }

                cancellationToken.ThrowIfCancellationRequested();

                var hasThumb = item.LocationType == LocationType.FileSystem ?
                    item.ResolveArgs.ContainsMetaFileByName(THUMB_FILE)
                    : item.HasImage(ImageType.Thumb);

                if (ConfigurationManager.Configuration.DownloadMovieImages.Thumb && !hasThumb)
                {
                    var node = doc.SelectSingleNode("//fanart/movie/moviethumbs/moviethumb[@lang = \"" + language + "\"]/@url") ??
                               doc.SelectSingleNode("//fanart/movie/moviethumbs/moviethumb/@url");
                    path = node != null ? node.Value : null;
                    if (!string.IsNullOrEmpty(path))
                    {
                        movie.SetImage(ImageType.Thumb, await _providerManager.DownloadAndSaveImage(movie, path, THUMB_FILE, saveLocal, FanArtResourcePool, cancellationToken).ConfigureAwait(false));
                    }
                }

                var hasBackdrop = item.LocationType == LocationType.FileSystem ?
                    item.ResolveArgs.ContainsMetaFileByName(BACKDROP_FILE)
                    : item.BackdropImagePaths.Count > 0;

                if (ConfigurationManager.Configuration.DownloadMovieImages.Backdrops && !hasBackdrop)
                {
                    var nodes = doc.SelectNodes("//fanart/movie/moviebackgrounds//@url");
                    if (nodes != null)
                    {
                        var numBackdrops = 0;
                        item.BackdropImagePaths = new List<string>();
                        foreach (XmlNode node in nodes)
                        {
                            path = node.Value;
                            if (!string.IsNullOrEmpty(path))
                            {
                                Logger.Debug("FanArtProvider getting Backdrop for " + item.Name);
                                item.BackdropImagePaths.Add(await _providerManager.DownloadAndSaveImage(item, path, ("backdrop" + (numBackdrops > 0 ? numBackdrops.ToString(UsCulture) : "") + ".jpg"), saveLocal, FanArtResourcePool, cancellationToken).ConfigureAwait(false));
                                numBackdrops++;
                                if (numBackdrops >= ConfigurationManager.Configuration.MaxBackdrops) break;
                            }
                        }

                    }

                }

            }

            data.Data = GetComparisonData(item.GetProviderId(MetadataProviders.Tmdb));
            SetLastRefreshed(movie, DateTime.UtcNow, status);
            return true;
        }

        public void Dispose()
        {
            Dispose(true);
        }
    }
}