using MediaBrowser.Common.Extensions; using MediaBrowser.Common.Net; using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities.TV; using MediaBrowser.Controller.Extensions; using MediaBrowser.Controller.Library; using MediaBrowser.Model.Entities; using MediaBrowser.Model.Logging; using MediaBrowser.Model.Net; using System; using System.Collections.Generic; using System.IO; using System.Net; using System.Text; using System.Threading; using System.Threading.Tasks; using System.Xml; namespace MediaBrowser.Controller.Providers.TV { /// /// Class RemoteSeriesProvider /// class RemoteSeriesProvider : BaseMetadataProvider, IDisposable { private readonly IProviderManager _providerManager; /// /// The tv db /// internal readonly SemaphoreSlim TvDbResourcePool = new SemaphoreSlim(5, 5); internal static RemoteSeriesProvider Current { get; private set; } /// /// Gets the HTTP client. /// /// The HTTP client. protected IHttpClient HttpClient { get; private set; } /// /// Initializes a new instance of the class. /// /// The HTTP client. /// The log manager. /// The configuration manager. /// The provider manager. /// httpClient public RemoteSeriesProvider(IHttpClient httpClient, ILogManager logManager, IServerConfigurationManager configurationManager, IProviderManager providerManager) : base(logManager, configurationManager) { if (httpClient == null) { throw new ArgumentNullException("httpClient"); } HttpClient = httpClient; _providerManager = providerManager; Current = this; } /// /// Releases unmanaged and - optionally - managed resources. /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. protected virtual void Dispose(bool dispose) { if (dispose) { TvDbResourcePool.Dispose(); } } /// /// The root URL /// private const string rootUrl = "http://www.thetvdb.com/api/"; /// /// The series query /// private const string seriesQuery = "GetSeries.php?seriesname={0}"; /// /// The series get /// private const string seriesGet = "http://www.thetvdb.com/api/{0}/series/{1}/{2}.xml"; /// /// The get actors /// private const string getActors = "http://www.thetvdb.com/api/{0}/series/{1}/actors.xml"; /// /// The LOCA l_ MET a_ FIL e_ NAME /// protected const string LOCAL_META_FILE_NAME = "Series.xml"; /// /// 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 { get { return MetadataProviderPriority.Second; } } /// /// Gets a value indicating whether [requires internet]. /// /// true if [requires internet]; otherwise, false. public override bool RequiresInternet { get { return true; } } /// /// Needses the refresh internal. /// /// The item. /// The provider info. /// true if XXXX, false otherwise protected override bool NeedsRefreshInternal(BaseItem item, BaseProviderInfo providerInfo) { var downloadDate = providerInfo.LastRefreshed; if (ConfigurationManager.Configuration.MetadataRefreshDays == -1 && downloadDate != DateTime.MinValue) { return false; } if (item.DontFetchMeta) return false; return !HasLocalMeta(item) && (ConfigurationManager.Configuration.MetadataRefreshDays != -1 && DateTime.UtcNow.Subtract(downloadDate).TotalDays > ConfigurationManager.Configuration.MetadataRefreshDays); } /// /// 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; if (!item.DontFetchMeta && !HasLocalMeta(series)) { var path = item.Path ?? ""; var seriesId = Path.GetFileName(path).GetAttributeValue("tvdbid") ?? await GetSeriesId(series, cancellationToken); cancellationToken.ThrowIfCancellationRequested(); if (!string.IsNullOrEmpty(seriesId)) { series.SetProviderId(MetadataProviders.Tvdb, seriesId); if (!HasCompleteMetadata(series)) { await FetchSeriesData(series, seriesId, cancellationToken).ConfigureAwait(false); } } SetLastRefreshed(item, DateTime.UtcNow); return true; } Logger.Info("Series provider not fetching because local meta exists or requested to ignore: " + item.Name); return false; } /// /// Fetches the series data. /// /// The series. /// The series id. /// The cancellation token. /// Task{System.Boolean}. private async Task FetchSeriesData(Series series, string seriesId, CancellationToken cancellationToken) { var success = false; var name = series.Name; Logger.Debug("TvDbProvider: Fetching series data: " + name); if (!string.IsNullOrEmpty(seriesId)) { string url = string.Format(seriesGet, TVUtils.TVDBApiKey, seriesId, ConfigurationManager.Configuration.PreferredMetadataLanguage); var doc = new XmlDocument(); try { using (var xml = await HttpClient.Get(url, TvDbResourcePool, cancellationToken).ConfigureAwait(false)) { doc.Load(xml); } } catch (HttpException) { } if (doc.HasChildNodes) { //kick off the actor and image fetch simultaneously var actorTask = FetchActors(series, seriesId, doc, cancellationToken); var imageTask = FetchImages(series, seriesId, cancellationToken); success = true; series.Name = doc.SafeGetString("//SeriesName"); series.Overview = doc.SafeGetString("//Overview"); series.CommunityRating = doc.SafeGetSingle("//Rating", 0, 10); series.AirDays = TVUtils.GetAirDays(doc.SafeGetString("//Airs_DayOfWeek")); series.AirTime = doc.SafeGetString("//Airs_Time"); string n = doc.SafeGetString("//banner"); if (!string.IsNullOrWhiteSpace(n)) { series.SetImage(ImageType.Banner, await _providerManager.DownloadAndSaveImage(series, TVUtils.BannerUrl + n, "banner" + Path.GetExtension(n), TvDbResourcePool, cancellationToken).ConfigureAwait(false)); } string s = doc.SafeGetString("//Network"); if (!string.IsNullOrWhiteSpace(s)) series.AddStudios(new List(s.Trim().Split('|'))); series.OfficialRating = doc.SafeGetString("//ContentRating"); string g = doc.SafeGetString("//Genre"); if (g != null) { string[] genres = g.Trim('|').Split('|'); if (g.Length > 0) { series.AddGenres(genres); } } //wait for other tasks await Task.WhenAll(actorTask, imageTask).ConfigureAwait(false); if (ConfigurationManager.Configuration.SaveLocalMeta) { var ms = new MemoryStream(); doc.Save(ms); await _providerManager.SaveToLibraryFilesystem(series, Path.Combine(series.MetaLocation, LOCAL_META_FILE_NAME), ms, cancellationToken).ConfigureAwait(false); } } } return success; } /// /// Fetches the actors. /// /// The series. /// The series id. /// The doc. /// The cancellation token. /// Task. private async Task FetchActors(Series series, string seriesId, XmlDocument doc, CancellationToken cancellationToken) { string urlActors = string.Format(getActors, TVUtils.TVDBApiKey, seriesId); var docActors = new XmlDocument(); try { using (var actors = await HttpClient.Get(urlActors, TvDbResourcePool, cancellationToken).ConfigureAwait(false)) { docActors.Load(actors); } } catch (HttpException) { } if (docActors.HasChildNodes) { XmlNode actorsNode = null; if (ConfigurationManager.Configuration.SaveLocalMeta) { //add to the main doc for saving var seriesNode = doc.SelectSingleNode("//Series"); if (seriesNode != null) { actorsNode = doc.CreateNode(XmlNodeType.Element, "Persons", null); seriesNode.AppendChild(actorsNode); } } var xmlNodeList = docActors.SelectNodes("Actors/Actor"); if (xmlNodeList != null) foreach (XmlNode p in xmlNodeList) { string actorName = p.SafeGetString("Name"); string actorRole = p.SafeGetString("Role"); if (!string.IsNullOrWhiteSpace(actorName)) { series.AddPerson(new PersonInfo { Type = PersonType.Actor, Name = actorName, Role = actorRole }); if (ConfigurationManager.Configuration.SaveLocalMeta && actorsNode != null) { //create in main doc var personNode = doc.CreateNode(XmlNodeType.Element, "Person", null); foreach (XmlNode subNode in p.ChildNodes) personNode.AppendChild(doc.ImportNode(subNode, true)); //need to add the type var typeNode = doc.CreateNode(XmlNodeType.Element, "Type", null); typeNode.InnerText = "Actor"; personNode.AppendChild(typeNode); actorsNode.AppendChild(personNode); } } } } } /// /// Fetches the images. /// /// The series. /// The series id. /// The cancellation token. /// Task. private async Task FetchImages(Series series, string seriesId, CancellationToken cancellationToken) { if ((!string.IsNullOrEmpty(seriesId)) && ((series.PrimaryImagePath == null) || (series.BackdropImagePaths == null))) { string url = string.Format("http://www.thetvdb.com/api/" + TVUtils.TVDBApiKey + "/series/{0}/banners.xml", seriesId); var images = new XmlDocument(); try { using (var imgs = await HttpClient.Get(url, TvDbResourcePool, cancellationToken).ConfigureAwait(false)) { images.Load(imgs); } } catch (HttpException) { } if (images.HasChildNodes) { if (ConfigurationManager.Configuration.RefreshItemImages || !series.HasLocalImage("folder")) { var n = images.SelectSingleNode("//Banner[BannerType='poster']"); if (n != null) { n = n.SelectSingleNode("./BannerPath"); if (n != null) { try { series.PrimaryImagePath = await _providerManager.DownloadAndSaveImage(series, TVUtils.BannerUrl + n.InnerText, "folder" + Path.GetExtension(n.InnerText), TvDbResourcePool, cancellationToken).ConfigureAwait(false); } catch (HttpException) { } catch (IOException) { } } } } if (ConfigurationManager.Configuration.DownloadSeriesImages.Banner && (ConfigurationManager.Configuration.RefreshItemImages || !series.HasLocalImage("banner"))) { var n = images.SelectSingleNode("//Banner[BannerType='series']"); if (n != null) { n = n.SelectSingleNode("./BannerPath"); if (n != null) { try { var bannerImagePath = await _providerManager.DownloadAndSaveImage(series, TVUtils.BannerUrl + n.InnerText, "banner" + Path.GetExtension(n.InnerText), TvDbResourcePool, cancellationToken); series.SetImage(ImageType.Banner, bannerImagePath); } catch (HttpException) { } catch (IOException) { } } } } var bdNo = 0; var xmlNodeList = images.SelectNodes("//Banner[BannerType='fanart']"); if (xmlNodeList != null) foreach (XmlNode b in xmlNodeList) { series.BackdropImagePaths = new List(); var p = b.SelectSingleNode("./BannerPath"); if (p != null) { var bdName = "backdrop" + (bdNo > 0 ? bdNo.ToString() : ""); if (ConfigurationManager.Configuration.RefreshItemImages || !series.HasLocalImage(bdName)) { try { series.BackdropImagePaths.Add(await _providerManager.DownloadAndSaveImage(series, TVUtils.BannerUrl + p.InnerText, bdName + Path.GetExtension(p.InnerText), TvDbResourcePool, cancellationToken).ConfigureAwait(false)); } catch (HttpException) { } catch (IOException) { } } bdNo++; if (bdNo >= ConfigurationManager.Configuration.MaxBackdrops) break; } } } } } /// /// Determines whether [has complete metadata] [the specified series]. /// /// The series. /// true if [has complete metadata] [the specified series]; otherwise, false. private bool HasCompleteMetadata(Series series) { return (series.HasImage(ImageType.Banner)) && (series.CommunityRating != null) && (series.Overview != null) && (series.Name != null) && (series.People != null) && (series.Genres != null) && (series.OfficialRating != null); } /// /// Determines whether [has local meta] [the specified item]. /// /// The item. /// true if [has local meta] [the specified item]; otherwise, false. private bool HasLocalMeta(BaseItem item) { //need at least the xml and folder.jpg/png return item.ResolveArgs.ContainsMetaFileByName(LOCAL_META_FILE_NAME) && (item.ResolveArgs.ContainsMetaFileByName("folder.jpg") || item.ResolveArgs.ContainsMetaFileByName("folder.png")); } /// /// Gets the series id. /// /// The item. /// The cancellation token. /// Task{System.String}. private async Task GetSeriesId(BaseItem item, CancellationToken cancellationToken) { var seriesId = item.GetProviderId(MetadataProviders.Tvdb); if (string.IsNullOrEmpty(seriesId)) { seriesId = await FindSeries(item.Name, cancellationToken).ConfigureAwait(false); } return seriesId; } /// /// Finds the series. /// /// The name. /// The cancellation token. /// Task{System.String}. public async Task FindSeries(string name, CancellationToken cancellationToken) { //nope - search for it string url = string.Format(rootUrl + seriesQuery, WebUtility.UrlEncode(name)); var doc = new XmlDocument(); try { using (var results = await HttpClient.Get(url, TvDbResourcePool, cancellationToken).ConfigureAwait(false)) { doc.Load(results); } } catch (HttpException) { } if (doc.HasChildNodes) { XmlNodeList nodes = doc.SelectNodes("//Series"); string comparableName = GetComparableName(name); if (nodes != null) foreach (XmlNode node in nodes) { var n = node.SelectSingleNode("./SeriesName"); if (n != null && GetComparableName(n.InnerText) == comparableName) { n = node.SelectSingleNode("./seriesid"); if (n != null) return n.InnerText; } else { if (n != null) Logger.Info("TVDb Provider - " + n.InnerText + " did not match " + comparableName); } } } Logger.Info("TVDb Provider - Could not find " + name + ". Check name on Thetvdb.org."); return null; } /// /// The remove /// const string remove = "\"'!`?"; /// /// The spacers /// const string spacers = "/,.:;\\(){}[]+-_=–*"; // (there are not actually two - in the they are different char codes) /// /// Gets the name of the comparable. /// /// The name. /// System.String. internal static string GetComparableName(string name) { name = name.ToLower(); name = name.Normalize(NormalizationForm.FormKD); var sb = new StringBuilder(); foreach (var c in name) { if ((int)c >= 0x2B0 && (int)c <= 0x0333) { // skip char modifier and diacritics } else if (remove.IndexOf(c) > -1) { // skip chars we are removing } else if (spacers.IndexOf(c) > -1) { sb.Append(" "); } else if (c == '&') { sb.Append(" and "); } else { sb.Append(c); } } name = sb.ToString(); name = name.Replace(", the", ""); name = name.Replace("the ", " "); name = name.Replace(" the ", " "); string prevName; do { prevName = name; name = name.Replace(" ", " "); } while (name.Length != prevName.Length); return name.Trim(); } public void Dispose() { Dispose(true); } } }