jellyfin/MediaBrowser.Providers/TV/FanArtTVProvider.cs

331 lines
13 KiB
C#
Raw Normal View History

using MediaBrowser.Common.Configuration;
using MediaBrowser.Common.IO;
2013-05-12 23:16:46 +00:00
using MediaBrowser.Common.Net;
2013-03-04 05:43:06 +00:00
using MediaBrowser.Controller.Configuration;
2013-02-21 01:33:05 +00:00
using MediaBrowser.Controller.Entities;
using MediaBrowser.Controller.Entities.TV;
2013-06-09 16:47:28 +00:00
using MediaBrowser.Controller.Providers;
2013-02-21 01:33:05 +00:00
using MediaBrowser.Model.Entities;
2013-03-02 17:59:15 +00:00
using MediaBrowser.Model.Logging;
2013-02-21 01:33:05 +00:00
using System;
using System.Globalization;
using System.IO;
using System.Linq;
2013-02-21 01:33:05 +00:00
using System.Threading;
using System.Threading.Tasks;
using System.Xml;
2013-06-09 16:47:28 +00:00
namespace MediaBrowser.Providers.TV
2013-02-21 01:33:05 +00:00
{
2013-03-02 17:59:15 +00:00
class FanArtTvProvider : FanartBaseProvider
2013-02-21 01:33:05 +00:00
{
protected string FanArtBaseUrl = "http://api.fanart.tv/webservice/series/{0}/{1}/xml/all/1/1";
internal static FanArtTvProvider Current { get; private set; }
2013-02-25 00:13:45 +00:00
/// <summary>
/// Gets the HTTP client.
/// </summary>
/// <value>The HTTP client.</value>
protected IHttpClient HttpClient { get; private set; }
private readonly IProviderManager _providerManager;
2013-04-28 23:39:17 +00:00
public FanArtTvProvider(IHttpClient httpClient, ILogManager logManager, IServerConfigurationManager configurationManager, IProviderManager providerManager)
2013-03-04 05:43:06 +00:00
: base(logManager, configurationManager)
2013-02-25 00:13:45 +00:00
{
if (httpClient == null)
{
throw new ArgumentNullException("httpClient");
}
HttpClient = httpClient;
_providerManager = providerManager;
Current = this;
2013-02-25 00:13:45 +00:00
}
2013-02-21 01:33:05 +00:00
public override bool Supports(BaseItem item)
{
return item is Series;
}
2013-04-28 23:39:17 +00:00
/// <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)
2013-02-21 01:33:05 +00:00
{
2013-04-28 23:39:17 +00:00
if (string.IsNullOrEmpty(item.GetProviderId(MetadataProviders.Tvdb)))
{
return false;
}
2013-05-24 16:05:53 +00:00
2013-04-28 23:39:17 +00:00
if (!ConfigurationManager.Configuration.DownloadSeriesImages.Art &&
!ConfigurationManager.Configuration.DownloadSeriesImages.Logo &&
2013-05-12 23:16:46 +00:00
!ConfigurationManager.Configuration.DownloadSeriesImages.Thumb &&
!ConfigurationManager.Configuration.DownloadSeriesImages.Backdrops &&
!ConfigurationManager.Configuration.DownloadSeriesImages.Banner)
2013-04-28 23:39:17 +00:00
{
return false;
}
2013-02-21 01:33:05 +00:00
if (item.HasImage(ImageType.Art) &&
item.HasImage(ImageType.Logo) &&
item.HasImage(ImageType.Banner) &&
item.HasImage(ImageType.Thumb) &&
item.BackdropImagePaths.Count > 0)
{
return false;
}
2013-05-12 23:16:46 +00:00
2013-04-28 23:39:17 +00:00
return base.NeedsRefreshInternal(item, providerInfo);
2013-02-21 01:33:05 +00:00
}
protected override DateTime CompareDate(BaseItem item)
2013-05-12 23:16:46 +00:00
{
var id = item.GetProviderId(MetadataProviders.Tvdb);
if (!string.IsNullOrEmpty(id))
{
// Process images
var path = GetSeriesDataPath(ConfigurationManager.ApplicationPaths, id);
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);
2013-05-12 23:16:46 +00:00
}
2013-05-24 16:05:53 +00:00
/// <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 "1";
}
}
/// <summary>
/// Gets the series data path.
/// </summary>
/// <param name="appPaths">The app paths.</param>
/// <param name="seriesId">The series id.</param>
/// <returns>System.String.</returns>
internal static string GetSeriesDataPath(IApplicationPaths appPaths, string seriesId)
{
var seriesDataPath = Path.Combine(GetSeriesDataPath(appPaths), seriesId);
if (!Directory.Exists(seriesDataPath))
{
Directory.CreateDirectory(seriesDataPath);
}
return seriesDataPath;
}
/// <summary>
/// Gets the series data path.
/// </summary>
/// <param name="appPaths">The app paths.</param>
/// <returns>System.String.</returns>
internal static string GetSeriesDataPath(IApplicationPaths appPaths)
{
var dataPath = Path.Combine(appPaths.DataPath, "fanart-tv");
if (!Directory.Exists(dataPath))
{
Directory.CreateDirectory(dataPath);
}
return dataPath;
}
2013-05-24 16:05:53 +00:00
protected readonly CultureInfo UsCulture = new CultureInfo("en-US");
2013-05-12 23:16:46 +00:00
public override async Task<bool> FetchAsync(BaseItem item, bool force, CancellationToken cancellationToken)
2013-02-21 01:33:05 +00:00
{
cancellationToken.ThrowIfCancellationRequested();
2013-02-25 00:13:45 +00:00
2013-05-12 23:16:46 +00:00
BaseProviderInfo data;
if (!item.ProviderData.TryGetValue(Id, out data))
{
data = new BaseProviderInfo();
item.ProviderData[Id] = data;
}
2013-05-24 16:05:53 +00:00
var seriesId = item.GetProviderId(MetadataProviders.Tvdb);
var seriesDataPath = GetSeriesDataPath(ConfigurationManager.ApplicationPaths, seriesId);
var xmlPath = Path.Combine(seriesDataPath, "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 DownloadSeriesXml(seriesDataPath, seriesId, cancellationToken).ConfigureAwait(false);
}
if (File.Exists(xmlPath))
2013-02-21 01:33:05 +00:00
{
await FetchFromXml(item, xmlPath, cancellationToken).ConfigureAwait(false);
2013-04-28 23:39:17 +00:00
}
SetLastRefreshed(item, DateTime.UtcNow);
return true;
}
/// <summary>
/// Fetches from XML.
/// </summary>
/// <param name="item">The item.</param>
/// <param name="xmlFilePath">The XML file path.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
private async Task FetchFromXml(BaseItem item, string xmlFilePath, CancellationToken cancellationToken)
{
var doc = new XmlDocument();
doc.Load(xmlFilePath);
2013-04-28 23:39:17 +00:00
cancellationToken.ThrowIfCancellationRequested();
2013-02-21 01:33:05 +00:00
var language = ConfigurationManager.Configuration.PreferredMetadataLanguage.ToLower();
2013-05-24 16:05:53 +00:00
var hd = ConfigurationManager.Configuration.DownloadHDFanArt ? "hdtv" : "clear";
2013-06-19 13:54:45 +00:00
if (ConfigurationManager.Configuration.DownloadSeriesImages.Logo && !item.HasImage(ImageType.Logo))
2013-04-28 23:39:17 +00:00
{
2013-05-24 16:05:53 +00:00
var node = doc.SelectSingleNode("//fanart/series/" + hd + "logos/" + hd + "logo[@lang = \"" + language + "\"]/@url") ??
doc.SelectSingleNode("//fanart/series/clearlogos/clearlogo[@lang = \"" + language + "\"]/@url") ??
doc.SelectSingleNode("//fanart/series/" + hd + "logos/" + hd + "logo/@url") ??
doc.SelectSingleNode("//fanart/series/clearlogos/clearlogo/@url");
var path = node != null ? node.Value : null;
2013-05-24 16:05:53 +00:00
if (!string.IsNullOrEmpty(path))
2013-02-21 01:33:05 +00:00
{
item.SetImage(ImageType.Logo, await _providerManager.DownloadAndSaveImage(item, path, LogoFile, ConfigurationManager.Configuration.SaveLocalMeta, FanArtResourcePool, cancellationToken).ConfigureAwait(false));
2013-02-21 01:33:05 +00:00
}
2013-05-24 16:05:53 +00:00
}
2013-02-21 01:33:05 +00:00
2013-05-24 16:05:53 +00:00
cancellationToken.ThrowIfCancellationRequested();
2013-02-25 00:13:45 +00:00
2013-05-24 16:05:53 +00:00
hd = ConfigurationManager.Configuration.DownloadHDFanArt ? "hd" : "";
2013-06-19 13:54:45 +00:00
if (ConfigurationManager.Configuration.DownloadSeriesImages.Art && !item.HasImage(ImageType.Art))
2013-05-24 16:05:53 +00:00
{
var node = doc.SelectSingleNode("//fanart/series/" + hd + "cleararts/" + hd + "clearart[@lang = \"" + language + "\"]/@url") ??
doc.SelectSingleNode("//fanart/series/cleararts/clearart[@lang = \"" + language + "\"]/@url") ??
doc.SelectSingleNode("//fanart/series/" + hd + "cleararts/" + hd + "clearart/@url") ??
doc.SelectSingleNode("//fanart/series/cleararts/clearart/@url");
var path = node != null ? node.Value : null;
2013-05-24 16:05:53 +00:00
if (!string.IsNullOrEmpty(path))
2013-02-21 01:33:05 +00:00
{
item.SetImage(ImageType.Art, await _providerManager.DownloadAndSaveImage(item, path, ArtFile, ConfigurationManager.Configuration.SaveLocalMeta, FanArtResourcePool, cancellationToken).ConfigureAwait(false));
2013-04-28 23:39:17 +00:00
}
2013-05-24 16:05:53 +00:00
}
2013-02-21 01:33:05 +00:00
2013-05-24 16:05:53 +00:00
cancellationToken.ThrowIfCancellationRequested();
2013-02-25 00:13:45 +00:00
2013-06-19 13:54:45 +00:00
if (ConfigurationManager.Configuration.DownloadSeriesImages.Thumb && !item.HasImage(ImageType.Thumb))
2013-05-24 16:05:53 +00:00
{
var node = doc.SelectSingleNode("//fanart/series/tvthumbs/tvthumb[@lang = \"" + language + "\"]/@url") ??
doc.SelectSingleNode("//fanart/series/tvthumbs/tvthumb/@url");
var path = node != null ? node.Value : null;
2013-05-24 16:05:53 +00:00
if (!string.IsNullOrEmpty(path))
2013-04-28 23:39:17 +00:00
{
item.SetImage(ImageType.Thumb, await _providerManager.DownloadAndSaveImage(item, path, ThumbFile, ConfigurationManager.Configuration.SaveLocalMeta, FanArtResourcePool, cancellationToken).ConfigureAwait(false));
2013-05-12 23:16:46 +00:00
}
2013-05-24 16:05:53 +00:00
}
2013-06-19 13:54:45 +00:00
if (ConfigurationManager.Configuration.DownloadSeriesImages.Banner && !item.HasImage(ImageType.Banner))
2013-05-24 16:05:53 +00:00
{
var node = doc.SelectSingleNode("//fanart/series/tbbanners/tvbanner[@lang = \"" + language + "\"]/@url") ??
doc.SelectSingleNode("//fanart/series/tbbanners/tvbanner/@url");
var path = node != null ? node.Value : null;
2013-05-24 16:05:53 +00:00
if (!string.IsNullOrEmpty(path))
{
item.SetImage(ImageType.Banner, await _providerManager.DownloadAndSaveImage(item, path, BannerFile, ConfigurationManager.Configuration.SaveLocalMeta, FanArtResourcePool, cancellationToken).ConfigureAwait(false));
2013-05-24 16:05:53 +00:00
}
}
2013-06-19 13:54:45 +00:00
if (ConfigurationManager.Configuration.DownloadMovieImages.Backdrops && item.BackdropImagePaths.Count == 0)
2013-05-24 16:05:53 +00:00
{
var nodes = doc.SelectNodes("//fanart/series/showbackgrounds//@url");
2013-04-28 23:39:17 +00:00
2013-05-24 16:05:53 +00:00
if (nodes != null)
2013-05-12 23:16:46 +00:00
{
2013-05-24 16:05:53 +00:00
var numBackdrops = item.BackdropImagePaths.Count;
foreach (XmlNode node in nodes)
2013-05-12 23:16:46 +00:00
{
var path = node.Value;
2013-05-24 16:05:53 +00:00
if (!string.IsNullOrEmpty(path))
{
item.BackdropImagePaths.Add(await _providerManager.DownloadAndSaveImage(item, path, ("backdrop" + (numBackdrops > 0 ? numBackdrops.ToString(UsCulture) : "") + ".jpg"), ConfigurationManager.Configuration.SaveLocalMeta, FanArtResourcePool, cancellationToken).ConfigureAwait(false));
numBackdrops++;
if (item.BackdropImagePaths.Count >= ConfigurationManager.Configuration.MaxBackdrops) break;
}
2013-02-21 01:33:05 +00:00
}
2013-05-24 16:05:53 +00:00
2013-02-21 01:33:05 +00:00
}
}
2013-04-28 23:39:17 +00:00
}
2013-05-24 16:05:53 +00:00
/// <summary>
/// Downloads the series XML.
/// </summary>
/// <param name="seriesDataPath">The series data path.</param>
/// <param name="tvdbId">The TVDB id.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
internal async Task DownloadSeriesXml(string seriesDataPath, string tvdbId, CancellationToken cancellationToken)
{
cancellationToken.ThrowIfCancellationRequested();
2013-04-28 23:39:17 +00:00
string url = string.Format(FanArtBaseUrl, ApiKey, tvdbId);
var xmlPath = Path.Combine(seriesDataPath, "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);
}
}
2013-02-21 01:33:05 +00:00
}
2013-02-21 01:33:05 +00:00
}
}