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; using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities.TV; using MediaBrowser.Controller.Library; using MediaBrowser.Controller.Providers; using MediaBrowser.Model.Entities; using MediaBrowser.Model.Globalization; using MediaBrowser.Model.IO; using MediaBrowser.Model.Xml; using MediaBrowser.Providers.TV.TheTVDB; using Microsoft.Extensions.Logging; namespace MediaBrowser.Providers.TV { public class MissingEpisodeProvider { private readonly IServerConfigurationManager _config; private readonly ILogger _logger; private readonly ILibraryManager _libraryManager; private readonly ILocalizationManager _localization; private readonly IFileSystem _fileSystem; private readonly CultureInfo _usCulture = new CultureInfo("en-US"); private const double UnairedEpisodeThresholdDays = 2; public MissingEpisodeProvider(ILogger logger, IServerConfigurationManager config, ILibraryManager libraryManager, ILocalizationManager localization, IFileSystem fileSystem) { _logger = logger; _config = config; _libraryManager = libraryManager; _localization = localization; _fileSystem = fileSystem; } public async Task Run(Series series, bool addNewItems, CancellationToken cancellationToken) { var tvdbId = series.GetProviderId(MetadataProviders.Tvdb); if (string.IsNullOrEmpty(tvdbId)) { return false; } var episodes = await TvDbClientManager.Instance.GetAllEpisodesAsync(Convert.ToInt32(tvdbId), cancellationToken); var episodeLookup = episodes .Select(i => { DateTime.TryParse(i.FirstAired, out var firstAired); var seasonNumber = i.AiredSeason.GetValueOrDefault(-1); var episodeNumber = i.AiredEpisodeNumber.GetValueOrDefault(-1); return (SeasonNumber: seasonNumber, EpisodeNumber: episodeNumber, firstAired: firstAired); }) .Where(i => i.SeasonNumber != -1 && i.EpisodeNumber != -1) .OrderBy(i => i.SeasonNumber) .ThenBy(i => i.EpisodeNumber) .ToList(); var allRecursiveChildren = series.GetRecursiveChildren(); var hasBadData = HasInvalidContent(allRecursiveChildren); // Be conservative here to avoid creating missing episodes for ones they already have var addMissingEpisodes = !hasBadData && _libraryManager.GetLibraryOptions(series).ImportMissingEpisodes; var anySeasonsRemoved = RemoveObsoleteOrMissingSeasons(allRecursiveChildren, episodeLookup); if (anySeasonsRemoved) { // refresh this allRecursiveChildren = series.GetRecursiveChildren(); } var anyEpisodesRemoved = RemoveObsoleteOrMissingEpisodes(allRecursiveChildren, episodeLookup, addMissingEpisodes); if (anyEpisodesRemoved) { // refresh this allRecursiveChildren = series.GetRecursiveChildren(); } var hasNewEpisodes = false; if (addNewItems && series.IsMetadataFetcherEnabled(_libraryManager.GetLibraryOptions(series), TvdbSeriesProvider.Current.Name)) { hasNewEpisodes = await AddMissingEpisodes(series, allRecursiveChildren, addMissingEpisodes, episodeLookup, cancellationToken) .ConfigureAwait(false); } if (hasNewEpisodes || anySeasonsRemoved || anyEpisodesRemoved) { return true; } return false; } /// /// Returns true if a series has any seasons or episodes without season or episode numbers /// If this data is missing no virtual items will be added in order to prevent possible duplicates /// private bool HasInvalidContent(IList allItems) { return allItems.OfType().Any(i => !i.IndexNumber.HasValue) || allItems.OfType().Any(i => { if (!i.ParentIndexNumber.HasValue) { return true; } // You could have episodes under season 0 with no number return false; }); } private async Task AddMissingEpisodes( Series series, IEnumerable allItems, bool addMissingEpisodes, IReadOnlyCollection<(int SeasonNumber, int Episodenumber, DateTime FirstAired)> episodeLookup, CancellationToken cancellationToken) { var existingEpisodes = allItems.OfType() .ToList(); var seasonCounts = episodeLookup.GroupBy(e => e.SeasonNumber).ToDictionary(g => g.Key, g => g.Count()); var hasChanges = false; foreach (var tuple in episodeLookup) { if (tuple.SeasonNumber <= 0 || tuple.Episodenumber <= 0) { // Ignore episode/season zeros continue; } var existingEpisode = GetExistingEpisode(existingEpisodes, seasonCounts, tuple); if (existingEpisode != null) { continue; } var airDate = tuple.FirstAired; var now = DateTime.UtcNow.AddDays(0 - UnairedEpisodeThresholdDays); if (airDate < now && addMissingEpisodes || airDate > now) { // tvdb has a lot of nearly blank episodes _logger.LogInformation("Creating virtual missing/unaired episode {0} {1}x{2}", series.Name, tuple.SeasonNumber, tuple.Episodenumber); await AddEpisode(series, tuple.SeasonNumber, tuple.Episodenumber, cancellationToken).ConfigureAwait(false); hasChanges = true; } } return hasChanges; } /// /// Removes the virtual entry after a corresponding physical version has been added /// private bool RemoveObsoleteOrMissingEpisodes( IEnumerable allRecursiveChildren, IEnumerable<(int SeasonNumber, int EpisodeNumber, DateTime FirstAired)> episodeLookup, bool allowMissingEpisodes) { var existingEpisodes = allRecursiveChildren.OfType(); var physicalEpisodes = new List(); var virtualEpisodes = new List(); foreach (var episode in existingEpisodes) { if (episode.LocationType == LocationType.Virtual) { virtualEpisodes.Add(episode); } else { physicalEpisodes.Add(episode); } } var episodesToRemove = virtualEpisodes .Where(i => { if (!i.IndexNumber.HasValue || !i.ParentIndexNumber.HasValue) { return true; } var seasonNumber = i.ParentIndexNumber.Value; var episodeNumber = i.IndexNumber.Value; // If there's a physical episode with the same season and episode number, delete it if (physicalEpisodes.Any(p => p.ParentIndexNumber.HasValue && p.ParentIndexNumber.Value == seasonNumber && p.ContainsEpisodeNumber(episodeNumber))) { return true; } // If the episode no longer exists in the remote lookup, delete it if (!episodeLookup.Any(e => e.SeasonNumber == seasonNumber && e.EpisodeNumber == episodeNumber)) { return true; } // If it's missing, but not unaired, remove it return !allowMissingEpisodes && i.IsMissingEpisode && (!i.PremiereDate.HasValue || i.PremiereDate.Value.ToLocalTime().Date.AddDays(UnairedEpisodeThresholdDays) < DateTime.Now.Date); }); var hasChanges = false; foreach (var episodeToRemove in episodesToRemove) { _libraryManager.DeleteItem(episodeToRemove, new DeleteOptions { DeleteFileLocation = true }, false); hasChanges = true; } return hasChanges; } /// /// Removes the obsolete or missing seasons. /// /// /// The episode lookup. /// Task{System.Boolean}. private bool RemoveObsoleteOrMissingSeasons(IList allRecursiveChildren, IEnumerable<(int SeasonNumber, int EpisodeNumber, DateTime FirstAired)> episodeLookup) { var existingSeasons = allRecursiveChildren.OfType().ToList(); var physicalSeasons = new List(); var virtualSeasons = new List(); foreach (var season in existingSeasons) { if (season.LocationType == LocationType.Virtual) { virtualSeasons.Add(season); } else { physicalSeasons.Add(season); } } var allEpisodes = allRecursiveChildren.OfType().ToList(); var seasonsToRemove = virtualSeasons .Where(i => { if (i.IndexNumber.HasValue) { var seasonNumber = i.IndexNumber.Value; // If there's a physical season with the same number, delete it if (physicalSeasons.Any(p => p.IndexNumber.HasValue && p.IndexNumber.Value == seasonNumber && string.Equals(p.Series.PresentationUniqueKey, i.Series.PresentationUniqueKey, StringComparison.Ordinal))) { return true; } // If the season no longer exists in the remote lookup, delete it, but only if an existing episode doesn't require it if (episodeLookup.All(e => e.SeasonNumber != seasonNumber)) { if (allEpisodes.All(s => s.ParentIndexNumber != seasonNumber || s.IsInSeasonFolder)) { return true; } } return false; } // Season does not have a number // Remove if there are no episodes directly in series without a season number return allEpisodes.All(s => s.ParentIndexNumber.HasValue || s.IsInSeasonFolder); }); var hasChanges = false; foreach (var seasonToRemove in seasonsToRemove) { _libraryManager.DeleteItem(seasonToRemove, new DeleteOptions { DeleteFileLocation = true }, false); hasChanges = true; } return hasChanges; } /// /// Adds the episode. /// /// The series. /// The season number. /// The episode number. /// The cancellation token. /// Task. private async Task AddEpisode(Series series, int seasonNumber, int episodeNumber, CancellationToken cancellationToken) { var season = series.Children.OfType() .FirstOrDefault(i => i.IndexNumber.HasValue && i.IndexNumber.Value == seasonNumber); if (season == null) { var provider = new DummySeasonProvider(_config, _logger, _localization, _libraryManager, _fileSystem); season = await provider.AddSeason(series, seasonNumber, true, cancellationToken).ConfigureAwait(false); } var name = $"Episode {episodeNumber.ToString(_usCulture)}"; var episode = new Episode { Name = name, IndexNumber = episodeNumber, ParentIndexNumber = seasonNumber, Id = _libraryManager.GetNewItemId(series.Id + seasonNumber.ToString(_usCulture) + name, typeof(Episode)), IsVirtualItem = true, SeasonId = season?.Id ?? Guid.Empty, SeriesId = series.Id }; season.AddChild(episode, cancellationToken); await episode.RefreshMetadata(new MetadataRefreshOptions(new DirectoryService(_logger, _fileSystem)), cancellationToken).ConfigureAwait(false); } /// /// Gets the existing episode. /// /// The existing episodes. /// /// The tuple. /// Episode. private Episode GetExistingEpisode(IList existingEpisodes, Dictionary seasonCounts, (int SeasonNumber, int EpisodeNumber, DateTime FirstAired) episodeTuple) { var seasonNumber = episodeTuple.SeasonNumber; var episodeNumber = episodeTuple.EpisodeNumber; while (true) { var episode = GetExistingEpisode(existingEpisodes, seasonNumber, episodeNumber); if (episode != null) return episode; seasonNumber--; if (seasonCounts.ContainsKey(seasonNumber)) episodeNumber += seasonCounts[seasonNumber]; else break; } return null; } private Episode GetExistingEpisode(IEnumerable existingEpisodes, int season, int episode) { return existingEpisodes .FirstOrDefault(i => i.ParentIndexNumber == season && i.ContainsEpisodeNumber(episode)); } } }