533 lines
21 KiB
C#
533 lines
21 KiB
C#
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 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 readonly IXmlReaderSettingsFactory _xmlSettings;
|
|
|
|
public MissingEpisodeProvider(ILogger logger, IServerConfigurationManager config, ILibraryManager libraryManager, ILocalizationManager localization, IFileSystem fileSystem, IXmlReaderSettingsFactory xmlSettings)
|
|
{
|
|
_logger = logger;
|
|
_config = config;
|
|
_libraryManager = libraryManager;
|
|
_localization = localization;
|
|
_fileSystem = fileSystem;
|
|
_xmlSettings = xmlSettings;
|
|
}
|
|
|
|
public async Task<bool> Run(Series series, bool addNewItems, CancellationToken cancellationToken)
|
|
{
|
|
var tvdbId = series.GetProviderId(MetadataProviders.Tvdb);
|
|
|
|
// Todo: Support series by imdb id
|
|
var seriesProviderIds = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
|
|
seriesProviderIds[MetadataProviders.Tvdb.ToString()] = tvdbId;
|
|
|
|
var seriesDataPath = TvdbSeriesProvider.GetSeriesDataPath(_config.ApplicationPaths, seriesProviderIds);
|
|
|
|
// Doesn't have required provider id's
|
|
if (string.IsNullOrWhiteSpace(seriesDataPath))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
// Check this in order to avoid logging an exception due to directory not existing
|
|
if (!Directory.Exists(seriesDataPath))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
var episodeFiles = _fileSystem.GetFilePaths(seriesDataPath)
|
|
.Where(i => string.Equals(Path.GetExtension(i), ".xml", StringComparison.OrdinalIgnoreCase))
|
|
.Select(Path.GetFileNameWithoutExtension)
|
|
.Where(i => i.StartsWith("episode-", StringComparison.OrdinalIgnoreCase))
|
|
.ToList();
|
|
|
|
var episodeLookup = episodeFiles
|
|
.Select(i =>
|
|
{
|
|
var parts = i.Split('-');
|
|
|
|
if (parts.Length == 3)
|
|
{
|
|
if (int.TryParse(parts[1], NumberStyles.Integer, _usCulture, out var seasonNumber))
|
|
{
|
|
if (int.TryParse(parts[2], NumberStyles.Integer, _usCulture, out var episodeNumber))
|
|
{
|
|
return new ValueTuple<int, int>(seasonNumber, episodeNumber);
|
|
}
|
|
}
|
|
}
|
|
|
|
return new ValueTuple<int, int>(-1, -1);
|
|
})
|
|
.Where(i => i.Item1 != -1 && i.Item2 != -1)
|
|
.ToList();
|
|
|
|
var allRecursiveChildren = series.GetRecursiveChildren();
|
|
|
|
var hasBadData = HasInvalidContent(series, allRecursiveChildren);
|
|
|
|
// Be conservative here to avoid creating missing episodes for ones they already have
|
|
var addMissingEpisodes = !hasBadData && _libraryManager.GetLibraryOptions(series).ImportMissingEpisodes;
|
|
|
|
var anySeasonsRemoved = RemoveObsoleteOrMissingSeasons(series, allRecursiveChildren, episodeLookup);
|
|
|
|
if (anySeasonsRemoved)
|
|
{
|
|
// refresh this
|
|
allRecursiveChildren = series.GetRecursiveChildren();
|
|
}
|
|
|
|
var anyEpisodesRemoved = RemoveObsoleteOrMissingEpisodes(series, 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, seriesDataPath, episodeLookup, cancellationToken)
|
|
.ConfigureAwait(false);
|
|
}
|
|
|
|
if (hasNewEpisodes || anySeasonsRemoved || anyEpisodesRemoved)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/// <summary>
|
|
/// 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
|
|
/// </summary>
|
|
private bool HasInvalidContent(Series series, IList<BaseItem> allItems)
|
|
{
|
|
return allItems.OfType<Season>().Any(i => !i.IndexNumber.HasValue) ||
|
|
allItems.OfType<Episode>().Any(i =>
|
|
{
|
|
if (!i.ParentIndexNumber.HasValue)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
// You could have episodes under season 0 with no number
|
|
return false;
|
|
});
|
|
}
|
|
|
|
private const double UnairedEpisodeThresholdDays = 2;
|
|
|
|
/// <summary>
|
|
/// Adds the missing episodes.
|
|
/// </summary>
|
|
/// <param name="series">The series.</param>
|
|
/// <returns>Task.</returns>
|
|
private async Task<bool> AddMissingEpisodes(Series series,
|
|
IList<BaseItem> allItems,
|
|
bool addMissingEpisodes,
|
|
string seriesDataPath,
|
|
IEnumerable<ValueTuple<int, int>> episodeLookup,
|
|
CancellationToken cancellationToken)
|
|
{
|
|
var existingEpisodes = allItems.OfType<Episode>()
|
|
.ToList();
|
|
|
|
var lookup = episodeLookup as IList<ValueTuple<int, int>> ?? episodeLookup.ToList();
|
|
|
|
var seasonCounts = (from e in lookup
|
|
group e by e.Item1 into g
|
|
select g)
|
|
.ToDictionary(g => g.Key, g => g.Count());
|
|
|
|
var hasChanges = false;
|
|
|
|
foreach (var tuple in lookup)
|
|
{
|
|
if (tuple.Item1 <= 0)
|
|
{
|
|
// Ignore season zeros
|
|
continue;
|
|
}
|
|
|
|
if (tuple.Item2 <= 0)
|
|
{
|
|
// Ignore episode zeros
|
|
continue;
|
|
}
|
|
|
|
var existingEpisode = GetExistingEpisode(existingEpisodes, seasonCounts, tuple);
|
|
|
|
if (existingEpisode != null)
|
|
{
|
|
continue;
|
|
}
|
|
|
|
var airDate = GetAirDate(seriesDataPath, tuple.Item1, tuple.Item2);
|
|
|
|
if (!airDate.HasValue)
|
|
{
|
|
continue;
|
|
}
|
|
|
|
var now = DateTime.UtcNow;
|
|
|
|
now = now.AddDays(0 - UnairedEpisodeThresholdDays);
|
|
|
|
if (airDate.Value < now)
|
|
{
|
|
if (addMissingEpisodes)
|
|
{
|
|
// tvdb has a lot of nearly blank episodes
|
|
_logger.LogInformation("Creating virtual missing episode {0} {1}x{2}", series.Name, tuple.Item1, tuple.Item2);
|
|
await AddEpisode(series, tuple.Item1, tuple.Item2, cancellationToken).ConfigureAwait(false);
|
|
|
|
hasChanges = true;
|
|
}
|
|
}
|
|
else if (airDate.Value > now)
|
|
{
|
|
// tvdb has a lot of nearly blank episodes
|
|
_logger.LogInformation("Creating virtual unaired episode {0} {1}x{2}", series.Name, tuple.Item1, tuple.Item2);
|
|
await AddEpisode(series, tuple.Item1, tuple.Item2, cancellationToken).ConfigureAwait(false);
|
|
|
|
hasChanges = true;
|
|
}
|
|
}
|
|
|
|
return hasChanges;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Removes the virtual entry after a corresponding physical version has been added
|
|
/// </summary>
|
|
private bool RemoveObsoleteOrMissingEpisodes(Series series,
|
|
IList<BaseItem> allRecursiveChildren,
|
|
IEnumerable<ValueTuple<int, int>> episodeLookup,
|
|
bool allowMissingEpisodes)
|
|
{
|
|
var existingEpisodes = allRecursiveChildren.OfType<Episode>()
|
|
.ToList();
|
|
|
|
var physicalEpisodes = existingEpisodes
|
|
.Where(i => i.LocationType != LocationType.Virtual)
|
|
.ToList();
|
|
|
|
var virtualEpisodes = existingEpisodes
|
|
.Where(i => i.LocationType == LocationType.Virtual)
|
|
.ToList();
|
|
|
|
var episodesToRemove = virtualEpisodes
|
|
.Where(i =>
|
|
{
|
|
if (i.IndexNumber.HasValue && i.ParentIndexNumber.HasValue)
|
|
{
|
|
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.Item1 == seasonNumber && e.Item2 == episodeNumber))
|
|
{
|
|
return true;
|
|
}
|
|
|
|
if (!allowMissingEpisodes && i.IsMissingEpisode)
|
|
{
|
|
// If it's missing, but not unaired, remove it
|
|
if (!i.PremiereDate.HasValue || i.PremiereDate.Value.ToLocalTime().Date.AddDays(UnairedEpisodeThresholdDays) < DateTime.Now.Date)
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
})
|
|
.ToList();
|
|
|
|
var hasChanges = false;
|
|
|
|
foreach (var episodeToRemove in episodesToRemove)
|
|
{
|
|
_libraryManager.DeleteItem(episodeToRemove, new DeleteOptions
|
|
{
|
|
DeleteFileLocation = true
|
|
|
|
}, false);
|
|
|
|
hasChanges = true;
|
|
}
|
|
|
|
return hasChanges;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Removes the obsolete or missing seasons.
|
|
/// </summary>
|
|
/// <param name="series">The series.</param>
|
|
/// <param name="episodeLookup">The episode lookup.</param>
|
|
/// <returns>Task{System.Boolean}.</returns>
|
|
private bool RemoveObsoleteOrMissingSeasons(Series series,
|
|
IList<BaseItem> allRecursiveChildren,
|
|
IEnumerable<ValueTuple<int, int>> episodeLookup)
|
|
{
|
|
var existingSeasons = allRecursiveChildren.OfType<Season>().ToList();
|
|
|
|
var physicalSeasons = existingSeasons
|
|
.Where(i => i.LocationType != LocationType.Virtual)
|
|
.ToList();
|
|
|
|
var virtualSeasons = existingSeasons
|
|
.Where(i => i.LocationType == LocationType.Virtual)
|
|
.ToList();
|
|
|
|
var allEpisodes = allRecursiveChildren.OfType<Episode>().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.Item1 != 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);
|
|
})
|
|
.ToList();
|
|
|
|
var hasChanges = false;
|
|
|
|
foreach (var seasonToRemove in seasonsToRemove)
|
|
{
|
|
_libraryManager.DeleteItem(seasonToRemove, new DeleteOptions
|
|
{
|
|
DeleteFileLocation = true
|
|
|
|
}, false);
|
|
|
|
hasChanges = true;
|
|
}
|
|
|
|
return hasChanges;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Adds the episode.
|
|
/// </summary>
|
|
/// <param name="series">The series.</param>
|
|
/// <param name="seasonNumber">The season number.</param>
|
|
/// <param name="episodeNumber">The episode number.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task.</returns>
|
|
private async Task AddEpisode(Series series, int seasonNumber, int episodeNumber, CancellationToken cancellationToken)
|
|
{
|
|
var season = series.Children.OfType<Season>()
|
|
.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 = string.Format("Episode {0}", 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 == null ? Guid.Empty : season.Id,
|
|
SeriesId = series.Id
|
|
};
|
|
|
|
episode.SetParent(season);
|
|
|
|
season.AddChild(episode, cancellationToken);
|
|
|
|
await episode.RefreshMetadata(new MetadataRefreshOptions(new DirectoryService(_logger, _fileSystem)), cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the existing episode.
|
|
/// </summary>
|
|
/// <param name="existingEpisodes">The existing episodes.</param>
|
|
/// <param name="seasonCounts"></param>
|
|
/// <param name="tuple">The tuple.</param>
|
|
/// <returns>Episode.</returns>
|
|
private Episode GetExistingEpisode(IList<Episode> existingEpisodes, Dictionary<int, int> seasonCounts, ValueTuple<int, int> tuple)
|
|
{
|
|
var s = tuple.Item1;
|
|
var e = tuple.Item2;
|
|
|
|
while (true)
|
|
{
|
|
var episode = GetExistingEpisode(existingEpisodes, s, e);
|
|
if (episode != null)
|
|
return episode;
|
|
|
|
s--;
|
|
|
|
if (seasonCounts.ContainsKey(s))
|
|
e += seasonCounts[s];
|
|
else
|
|
break;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
private Episode GetExistingEpisode(IEnumerable<Episode> existingEpisodes, int season, int episode)
|
|
{
|
|
return existingEpisodes
|
|
.FirstOrDefault(i => i.ParentIndexNumber == season && i.ContainsEpisodeNumber(episode));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the air date.
|
|
/// </summary>
|
|
/// <param name="seriesDataPath">The series data path.</param>
|
|
/// <param name="seasonNumber">The season number.</param>
|
|
/// <param name="episodeNumber">The episode number.</param>
|
|
/// <returns>System.Nullable{DateTime}.</returns>
|
|
private DateTime? GetAirDate(string seriesDataPath, int seasonNumber, int episodeNumber)
|
|
{
|
|
// First open up the tvdb xml file and make sure it has valid data
|
|
var filename = string.Format("episode-{0}-{1}.xml", seasonNumber.ToString(_usCulture), episodeNumber.ToString(_usCulture));
|
|
|
|
var xmlPath = Path.Combine(seriesDataPath, filename);
|
|
|
|
DateTime? airDate = null;
|
|
|
|
using (var fileStream = _fileSystem.GetFileStream(xmlPath, FileOpenMode.Open, FileAccessMode.Read, FileShareMode.Read))
|
|
{
|
|
// It appears the best way to filter out invalid entries is to only include those with valid air dates
|
|
using (var streamReader = new StreamReader(fileStream, Encoding.UTF8))
|
|
{
|
|
var settings = _xmlSettings.Create(false);
|
|
|
|
settings.CheckCharacters = false;
|
|
settings.IgnoreProcessingInstructions = true;
|
|
settings.IgnoreComments = true;
|
|
|
|
// Use XmlReader for best performance
|
|
using (var reader = XmlReader.Create(streamReader, settings))
|
|
{
|
|
reader.MoveToContent();
|
|
reader.Read();
|
|
|
|
// Loop through each element
|
|
while (!reader.EOF && reader.ReadState == ReadState.Interactive)
|
|
{
|
|
if (reader.NodeType == XmlNodeType.Element)
|
|
{
|
|
switch (reader.Name)
|
|
{
|
|
case "EpisodeName":
|
|
{
|
|
var val = reader.ReadElementContentAsString();
|
|
if (string.IsNullOrWhiteSpace(val))
|
|
{
|
|
// Not valid, ignore these
|
|
return null;
|
|
}
|
|
break;
|
|
}
|
|
case "FirstAired":
|
|
{
|
|
var val = reader.ReadElementContentAsString();
|
|
|
|
if (!string.IsNullOrWhiteSpace(val))
|
|
{
|
|
if (DateTime.TryParse(val, out var date))
|
|
{
|
|
airDate = date.ToUniversalTime();
|
|
}
|
|
}
|
|
|
|
break;
|
|
}
|
|
default:
|
|
{
|
|
reader.Skip();
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
reader.Read();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return airDate;
|
|
}
|
|
}
|
|
}
|