| | | 1 | | using System; |
| | | 2 | | using System.Collections.Generic; |
| | | 3 | | using System.Globalization; |
| | | 4 | | using System.Linq; |
| | | 5 | | using System.Threading; |
| | | 6 | | using System.Threading.Tasks; |
| | | 7 | | using MediaBrowser.Controller.Entities; |
| | | 8 | | using MediaBrowser.Controller.Entities.TV; |
| | | 9 | | using MediaBrowser.Controller.Library; |
| | | 10 | | using MediaBrowser.Controller.Providers; |
| | | 11 | | using MediaBrowser.Model.Entities; |
| | | 12 | | using MediaBrowser.Model.IO; |
| | | 13 | | using Microsoft.Extensions.Logging; |
| | | 14 | | using TMDbLib.Objects.Search; |
| | | 15 | | |
| | | 16 | | namespace MediaBrowser.Providers.Plugins.Tmdb.TV |
| | | 17 | | { |
| | | 18 | | /// <summary> |
| | | 19 | | /// Creates virtual (metadata-only) entries for missing and unaired episodes. |
| | | 20 | | /// </summary> |
| | | 21 | | public class TmdbMissingEpisodeProvider : ICustomMetadataProvider<Series>, IHasItemChangeMonitor, IHasOrder |
| | | 22 | | { |
| | | 23 | | private readonly TmdbClientManager _tmdbClientManager; |
| | | 24 | | private readonly ILibraryManager _libraryManager; |
| | | 25 | | private readonly IFileSystem _fileSystem; |
| | | 26 | | private readonly IProviderManager _providerManager; |
| | | 27 | | private readonly ILogger<TmdbMissingEpisodeProvider> _logger; |
| | | 28 | | |
| | | 29 | | /// <summary> |
| | | 30 | | /// Initializes a new instance of the <see cref="TmdbMissingEpisodeProvider"/> class. |
| | | 31 | | /// </summary> |
| | | 32 | | /// <param name="tmdbClientManager">The <see cref="TmdbClientManager"/>.</param> |
| | | 33 | | /// <param name="libraryManager">The <see cref="ILibraryManager"/>.</param> |
| | | 34 | | /// <param name="fileSystem">The <see cref="IFileSystem"/>.</param> |
| | | 35 | | /// <param name="providerManager">The <see cref="IProviderManager"/>.</param> |
| | | 36 | | /// <param name="logger">The <see cref="ILogger{TmdbMissingEpisodeProvider}"/>.</param> |
| | | 37 | | public TmdbMissingEpisodeProvider( |
| | | 38 | | TmdbClientManager tmdbClientManager, |
| | | 39 | | ILibraryManager libraryManager, |
| | | 40 | | IFileSystem fileSystem, |
| | | 41 | | IProviderManager providerManager, |
| | | 42 | | ILogger<TmdbMissingEpisodeProvider> logger) |
| | | 43 | | { |
| | 27 | 44 | | _tmdbClientManager = tmdbClientManager; |
| | 27 | 45 | | _libraryManager = libraryManager; |
| | 27 | 46 | | _fileSystem = fileSystem; |
| | 27 | 47 | | _providerManager = providerManager; |
| | 27 | 48 | | _logger = logger; |
| | 27 | 49 | | } |
| | | 50 | | |
| | | 51 | | /// <inheritdoc /> |
| | 0 | 52 | | public string Name => TmdbUtils.ProviderName; |
| | | 53 | | |
| | | 54 | | /// <inheritdoc /> |
| | | 55 | | // Run after the remote series provider so the TMDb id and other metadata are available. |
| | 0 | 56 | | public int Order => 100; |
| | | 57 | | |
| | | 58 | | /// <inheritdoc /> |
| | | 59 | | public bool HasChanged(BaseItem item, IDirectoryService directoryService) |
| | | 60 | | { |
| | | 61 | | // Reporting a change makes this provider (and only this provider) run during an otherwise incremental refre |
| | 0 | 62 | | if (Plugin.Instance?.Configuration is null) |
| | | 63 | | { |
| | 0 | 64 | | return false; |
| | | 65 | | } |
| | | 66 | | |
| | 0 | 67 | | return item is Series series && series.HasProviderId(MetadataProvider.Tmdb); |
| | | 68 | | } |
| | | 69 | | |
| | | 70 | | /// <inheritdoc /> |
| | | 71 | | public async Task<ItemUpdateType> FetchAsync(Series item, MetadataRefreshOptions options, CancellationToken canc |
| | | 72 | | { |
| | 0 | 73 | | var configuration = Plugin.Instance?.Configuration; |
| | 0 | 74 | | var importUnaired = (configuration?.ImportUnairedEpisodes).GetValueOrDefault(); |
| | 0 | 75 | | var importMissing = (configuration?.ImportMissingEpisodes).GetValueOrDefault(); |
| | | 76 | | |
| | | 77 | | // The provider is inactive for this series when both global imports are off, or the series' |
| | | 78 | | // library has not been opted in. In either case remove every virtual episode (unaired and |
| | | 79 | | // missing alike) it previously created, so disabling the feature cleans up on the next scan. |
| | 0 | 80 | | if ((!importUnaired && !importMissing) || !IsEnabledForLibrary(item)) |
| | | 81 | | { |
| | 0 | 82 | | if (!PruneAllVirtualEpisodes(item)) |
| | | 83 | | { |
| | 0 | 84 | | return ItemUpdateType.None; |
| | | 85 | | } |
| | | 86 | | |
| | 0 | 87 | | item.Children = null; |
| | 0 | 88 | | return ItemUpdateType.MetadataImport; |
| | | 89 | | } |
| | | 90 | | |
| | 0 | 91 | | var tmdbId = item.GetProviderId(MetadataProvider.Tmdb); |
| | 0 | 92 | | if (string.IsNullOrEmpty(tmdbId) |
| | 0 | 93 | | || !int.TryParse(tmdbId, NumberStyles.Integer, CultureInfo.InvariantCulture, out var seriesTmdbId) |
| | 0 | 94 | | || seriesTmdbId <= 0) |
| | | 95 | | { |
| | 0 | 96 | | return ItemUpdateType.None; |
| | | 97 | | } |
| | | 98 | | |
| | 0 | 99 | | var language = item.GetPreferredMetadataLanguage(); |
| | 0 | 100 | | var countryCode = item.GetPreferredMetadataCountryCode(); |
| | 0 | 101 | | var imageLanguages = TmdbUtils.GetImageLanguagesParam(language, countryCode); |
| | | 102 | | |
| | 0 | 103 | | var tmdbSeries = await _tmdbClientManager |
| | 0 | 104 | | .GetSeriesAsync(seriesTmdbId, language, imageLanguages, countryCode, cancellationToken) |
| | 0 | 105 | | .ConfigureAwait(false); |
| | | 106 | | |
| | 0 | 107 | | if (tmdbSeries?.Seasons is null) |
| | | 108 | | { |
| | 0 | 109 | | return ItemUpdateType.None; |
| | | 110 | | } |
| | | 111 | | |
| | 0 | 112 | | var today = DateTime.UtcNow.Date; |
| | | 113 | | |
| | 0 | 114 | | var importSpecials = (configuration?.ImportSpecials).GetValueOrDefault(); |
| | 0 | 115 | | var gracePeriodDays = Math.Max(0, (configuration?.UpcomingEpisodeGracePeriodDays).GetValueOrDefault()); |
| | | 116 | | |
| | | 117 | | // Track every (season, episode) number that already exists (physical or virtual) so we never |
| | | 118 | | // create a duplicate. |
| | | 119 | | // When missing episodes are disabled, this pass also prunes virtual episodes that aired more |
| | | 120 | | // than the grace period ago, as well as any specials when specials are not wanted. |
| | 0 | 121 | | var (existingEpisodes, updatableEpisodes, physicalTmdbIds) = GetExistingEpisodes(item, !importMissing, today |
| | | 122 | | |
| | 0 | 123 | | var seasonsByNumber = item.GetRecursiveChildren(i => i is Season) |
| | 0 | 124 | | .OfType<Season>() |
| | 0 | 125 | | .Where(s => s.IndexNumber.HasValue) |
| | 0 | 126 | | .GroupBy(s => s.IndexNumber!.Value) |
| | 0 | 127 | | .ToDictionary(g => g.Key, g => g.First()); |
| | | 128 | | |
| | 0 | 129 | | var addedEpisodes = false; |
| | 0 | 130 | | var updatedEpisodes = false; |
| | | 131 | | |
| | 0 | 132 | | foreach (var seasonInfo in tmdbSeries.Seasons) |
| | | 133 | | { |
| | 0 | 134 | | cancellationToken.ThrowIfCancellationRequested(); |
| | | 135 | | |
| | 0 | 136 | | var seasonNumber = seasonInfo.SeasonNumber; |
| | 0 | 137 | | var tmdbSeason = await _tmdbClientManager |
| | 0 | 138 | | .GetSeasonAsync(seriesTmdbId, seasonNumber, language, imageLanguages, countryCode, cancellationToken |
| | 0 | 139 | | .ConfigureAwait(false); |
| | | 140 | | |
| | 0 | 141 | | if (tmdbSeason?.Episodes is null) |
| | | 142 | | { |
| | | 143 | | continue; |
| | | 144 | | } |
| | | 145 | | |
| | 0 | 146 | | foreach (var tmdbEpisode in tmdbSeason.Episodes) |
| | | 147 | | { |
| | 0 | 148 | | var episodeNumber = (int)tmdbEpisode.EpisodeNumber; |
| | 0 | 149 | | var premiereDate = GetPremiereDate(tmdbEpisode); |
| | | 150 | | |
| | | 151 | | // Skips undated episodes, unaired (upcoming) ones unless upcoming import is enabled, |
| | | 152 | | // already aired ones unless missing import is enabled, and unaired specials entirely. |
| | 0 | 153 | | if (!ShouldImportEpisode(premiereDate, today, importUnaired, importMissing, seasonNumber == 0, impor |
| | | 154 | | { |
| | | 155 | | continue; |
| | | 156 | | } |
| | | 157 | | |
| | 0 | 158 | | var key = (seasonNumber, episodeNumber); |
| | | 159 | | |
| | | 160 | | // Already have a virtual episode this provider created, keep metadata in sync with TMDb. |
| | 0 | 161 | | if (updatableEpisodes.TryGetValue(key, out var existingEpisode)) |
| | | 162 | | { |
| | 0 | 163 | | var season = await GetOrCreateSeasonAsync(item, seasonNumber, tmdbSeason.Name, seasonsByNumber, |
| | 0 | 164 | | var changed = UpdateVirtualEpisode(existingEpisode, tmdbEpisode, premiereDate); |
| | | 165 | | |
| | 0 | 166 | | if (!existingEpisode.ParentId.Equals(season.Id)) |
| | | 167 | | { |
| | 0 | 168 | | existingEpisode.SetParent(season); |
| | 0 | 169 | | existingEpisode.SeasonId = season.Id; |
| | 0 | 170 | | existingEpisode.SeasonName = season.Name; |
| | 0 | 171 | | changed = true; |
| | | 172 | | } |
| | | 173 | | |
| | 0 | 174 | | if (string.IsNullOrEmpty(existingEpisode.PresentationUniqueKey)) |
| | | 175 | | { |
| | 0 | 176 | | existingEpisode.PresentationUniqueKey = existingEpisode.CreatePresentationUniqueKey(); |
| | 0 | 177 | | changed = true; |
| | | 178 | | } |
| | | 179 | | |
| | 0 | 180 | | if (changed) |
| | | 181 | | { |
| | 0 | 182 | | await existingEpisode.UpdateToRepositoryAsync(ItemUpdateType.MetadataImport, cancellationTok |
| | 0 | 183 | | updatedEpisodes = true; |
| | | 184 | | } |
| | | 185 | | |
| | | 186 | | // Backfill the still for placeholders created before images were fetched. |
| | 0 | 187 | | if (await EnsureEpisodeImageAsync(existingEpisode, tmdbEpisode, cancellationToken).ConfigureAwai |
| | | 188 | | { |
| | 0 | 189 | | updatedEpisodes = true; |
| | | 190 | | } |
| | | 191 | | |
| | 0 | 192 | | continue; |
| | | 193 | | } |
| | | 194 | | |
| | 0 | 195 | | if (!existingEpisodes.Add(key)) |
| | | 196 | | { |
| | | 197 | | continue; |
| | | 198 | | } |
| | | 199 | | |
| | | 200 | | // The slot is free, but the episode itself may not be: when the files follow a different |
| | | 201 | | // order, the same episode sits at another number and creating this one would duplicate it. |
| | 0 | 202 | | if (physicalTmdbIds.Contains(tmdbEpisode.Id.ToString(CultureInfo.InvariantCulture))) |
| | | 203 | | { |
| | | 204 | | continue; |
| | | 205 | | } |
| | | 206 | | |
| | 0 | 207 | | var targetSeason = await GetOrCreateSeasonAsync(item, seasonNumber, tmdbSeason.Name, seasonsByNumber |
| | 0 | 208 | | var newEpisode = AddVirtualEpisode(item, targetSeason, tmdbEpisode, premiereDate); |
| | 0 | 209 | | await EnsureEpisodeImageAsync(newEpisode, tmdbEpisode, cancellationToken).ConfigureAwait(false); |
| | 0 | 210 | | addedEpisodes = true; |
| | 0 | 211 | | } |
| | 0 | 212 | | } |
| | | 213 | | |
| | 0 | 214 | | var alignedSeasons = await AlignVirtualSeasonSortNamesAsync(seasonsByNumber.Values, cancellationToken).Confi |
| | | 215 | | |
| | 0 | 216 | | if (!addedEpisodes && !prunedEpisodes && !updatedEpisodes && !alignedSeasons) |
| | | 217 | | { |
| | 0 | 218 | | return ItemUpdateType.None; |
| | | 219 | | } |
| | | 220 | | |
| | | 221 | | // Invalidate the cached children so that the season creation / cleanup that runs later in |
| | | 222 | | // SeriesMetadataService.AfterMetadataRefresh observes the newly created (and pruned) episodes. |
| | 0 | 223 | | item.Children = null; |
| | | 224 | | |
| | 0 | 225 | | return ItemUpdateType.MetadataImport; |
| | 0 | 226 | | } |
| | | 227 | | |
| | | 228 | | /// <summary> |
| | | 229 | | /// Returns the series' season with the given number, creating (and refreshing) a virtual season |
| | | 230 | | /// when the whole season is missing from the library. |
| | | 231 | | /// </summary> |
| | | 232 | | private async Task<Season> GetOrCreateSeasonAsync(Series series, int seasonNumber, string? seasonName, Dictionar |
| | | 233 | | { |
| | 0 | 234 | | if (seasonsByNumber.TryGetValue(seasonNumber, out var existingSeason)) |
| | | 235 | | { |
| | 0 | 236 | | return existingSeason; |
| | | 237 | | } |
| | | 238 | | |
| | 0 | 239 | | _logger.LogInformation("Creating virtual season {SeasonNumber} for series {SeriesName}", seasonNumber, serie |
| | | 240 | | |
| | 0 | 241 | | var season = new Season |
| | 0 | 242 | | { |
| | 0 | 243 | | Name = seasonName, |
| | 0 | 244 | | IndexNumber = seasonNumber, |
| | 0 | 245 | | Id = _libraryManager.GetNewItemId( |
| | 0 | 246 | | series.Id.ToString("N", CultureInfo.InvariantCulture) + "Season" + seasonNumber.ToString(CultureInfo |
| | 0 | 247 | | typeof(Season)), |
| | 0 | 248 | | IsVirtualItem = true, |
| | 0 | 249 | | SeriesId = series.Id, |
| | 0 | 250 | | SeriesName = series.Name, |
| | 0 | 251 | | SeriesPresentationUniqueKey = series.GetPresentationUniqueKey() |
| | 0 | 252 | | }; |
| | | 253 | | |
| | 0 | 254 | | series.AddChild(season); |
| | 0 | 255 | | await season.RefreshMetadata(new MetadataRefreshOptions(new DirectoryService(_fileSystem)), cancellationToke |
| | | 256 | | |
| | 0 | 257 | | seasonsByNumber[seasonNumber] = season; |
| | 0 | 258 | | return season; |
| | 0 | 259 | | } |
| | | 260 | | |
| | | 261 | | /// <summary> |
| | | 262 | | /// Mirrors physical seasons' name-based sort convention onto virtual seasons so they interleave by |
| | | 263 | | /// number instead of jumping ahead. See <see cref="BuildSeasonSortNameTemplate"/> for the details. |
| | | 264 | | /// </summary> |
| | | 265 | | /// <param name="seasons">The series' seasons (physical and virtual).</param> |
| | | 266 | | /// <param name="cancellationToken">The cancellation token.</param> |
| | | 267 | | /// <returns><c>true</c> if any virtual season was updated; otherwise <c>false</c>.</returns> |
| | | 268 | | private async Task<bool> AlignVirtualSeasonSortNamesAsync(IEnumerable<Season> seasons, CancellationToken cancell |
| | | 269 | | { |
| | 0 | 270 | | var seasonList = seasons.ToList(); |
| | 0 | 271 | | var template = BuildSeasonSortNameTemplate(seasonList); |
| | 0 | 272 | | if (template is null) |
| | | 273 | | { |
| | | 274 | | // No physical season sorts by name: virtual seasons already share the bare-index key space. |
| | 0 | 275 | | return false; |
| | | 276 | | } |
| | | 277 | | |
| | 0 | 278 | | var updated = false; |
| | 0 | 279 | | foreach (var season in seasonList) |
| | | 280 | | { |
| | 0 | 281 | | if (!season.IsVirtualItem || !season.IndexNumber.HasValue) |
| | | 282 | | { |
| | | 283 | | continue; |
| | | 284 | | } |
| | | 285 | | |
| | 0 | 286 | | var desired = template(season.IndexNumber.Value); |
| | 0 | 287 | | if (string.Equals(season.ForcedSortName, desired, StringComparison.Ordinal)) |
| | | 288 | | { |
| | | 289 | | continue; |
| | | 290 | | } |
| | | 291 | | |
| | 0 | 292 | | _logger.LogInformation( |
| | 0 | 293 | | "Aligning sort name of virtual season {SeasonNumber} in series {SeriesName} to {SortName}", |
| | 0 | 294 | | season.IndexNumber, |
| | 0 | 295 | | season.SeriesName, |
| | 0 | 296 | | desired); |
| | | 297 | | |
| | 0 | 298 | | season.ForcedSortName = desired; |
| | 0 | 299 | | await season.UpdateToRepositoryAsync(ItemUpdateType.MetadataEdit, cancellationToken).ConfigureAwait(fals |
| | 0 | 300 | | updated = true; |
| | | 301 | | } |
| | | 302 | | |
| | 0 | 303 | | return updated; |
| | 0 | 304 | | } |
| | | 305 | | |
| | | 306 | | /// <summary> |
| | | 307 | | /// Builds a factory that maps a season number to a forced sort name mirroring a physical, |
| | | 308 | | /// name-sorted sibling season, or <c>null</c> when no physical season sorts by name. |
| | | 309 | | /// </summary> |
| | | 310 | | /// <param name="seasons">The series' seasons (physical and virtual).</param> |
| | | 311 | | /// <returns>A season-number-to-sort-name factory, or <c>null</c> if there is nothing to mirror.</returns> |
| | | 312 | | internal static Func<int, string>? BuildSeasonSortNameTemplate(IEnumerable<Season> seasons) |
| | | 313 | | { |
| | | 314 | | // Season.CreateSortName sorts by the bare padded index ("0003"), but season NFOs give physical |
| | | 315 | | // seasons a name-based forced sort ("Season 01" -> "season 0000000001"). The digit-leading key |
| | | 316 | | // sorts ahead of the letter-leading one, so mirror the sibling's token with each season number. |
| | 5 | 317 | | var reference = seasons.FirstOrDefault(s => |
| | 5 | 318 | | !s.IsVirtualItem && s.IndexNumber.HasValue && !string.IsNullOrEmpty(s.ForcedSortName)); |
| | 5 | 319 | | if (reference is null) |
| | | 320 | | { |
| | 2 | 321 | | return null; |
| | | 322 | | } |
| | | 323 | | |
| | 3 | 324 | | var forced = reference.ForcedSortName!; |
| | | 325 | | |
| | | 326 | | // Locate the last run of digits (the season number) in the sibling's forced sort name. |
| | 3 | 327 | | var end = -1; |
| | 3 | 328 | | var start = -1; |
| | 32 | 329 | | for (var i = forced.Length - 1; i >= 0; i--) |
| | | 330 | | { |
| | 15 | 331 | | if (char.IsDigit(forced[i])) |
| | | 332 | | { |
| | 3 | 333 | | end = end < 0 ? i : end; |
| | 3 | 334 | | start = i; |
| | | 335 | | } |
| | 12 | 336 | | else if (end >= 0) |
| | | 337 | | { |
| | | 338 | | break; |
| | | 339 | | } |
| | | 340 | | } |
| | | 341 | | |
| | 3 | 342 | | if (end < 0) |
| | | 343 | | { |
| | | 344 | | // Sibling has no numeric component to swap; leave virtual seasons on the bare-index key. |
| | 1 | 345 | | return null; |
| | | 346 | | } |
| | | 347 | | |
| | 2 | 348 | | var prefix = forced[..start]; |
| | 2 | 349 | | var suffix = forced[(end + 1)..]; |
| | 2 | 350 | | var width = end - start + 1; |
| | | 351 | | |
| | | 352 | | // The exact zero-padding is cosmetic: ModifySortChunks pads every digit run to 10 characters, |
| | | 353 | | // so "Season 3" and "Season 03" collapse to the same sort key. Keeping the sibling's width just |
| | | 354 | | // makes the stored value read naturally. |
| | 2 | 355 | | return number => prefix |
| | 2 | 356 | | + number.ToString(CultureInfo.InvariantCulture).PadLeft(width, '0') |
| | 2 | 357 | | + suffix; |
| | | 358 | | } |
| | | 359 | | |
| | | 360 | | private bool IsEnabledForLibrary(BaseItem item) |
| | | 361 | | { |
| | 0 | 362 | | var enabledLibraries = Plugin.Instance?.Configuration.EnabledMissingEpisodeLibraries; |
| | 0 | 363 | | if (enabledLibraries is null || enabledLibraries.Length == 0) |
| | | 364 | | { |
| | 0 | 365 | | return false; |
| | | 366 | | } |
| | | 367 | | |
| | | 368 | | // A series can live under more than one collection folder; opting in any one of them is |
| | | 369 | | // enough. An item that belongs to no collection folder cannot be opted in at all. |
| | 0 | 370 | | return _libraryManager.GetCollectionFolders(item).Any(folder => |
| | 0 | 371 | | enabledLibraries.Contains(folder.Id.ToString("N", CultureInfo.InvariantCulture), StringComparer.OrdinalI |
| | | 372 | | } |
| | | 373 | | |
| | | 374 | | private (HashSet<(int Season, int Episode)> Keys, Dictionary<(int Season, int Episode), Episode> Updatable, Hash |
| | | 375 | | { |
| | 0 | 376 | | var keys = new HashSet<(int Season, int Episode)>(); |
| | 0 | 377 | | var updatable = new Dictionary<(int Season, int Episode), Episode>(); |
| | 0 | 378 | | var physicalKeys = new HashSet<(int Season, int Episode)>(); |
| | 0 | 379 | | var physicalTmdbIds = new HashSet<string>(StringComparer.Ordinal); |
| | 0 | 380 | | var ourVirtuals = new List<((int Season, int Episode) Key, Episode Episode)>(); |
| | 0 | 381 | | pruned = false; |
| | | 382 | | |
| | | 383 | | // Enumerate by parent rather than via Series.GetEpisodes: on an initial scan the episodes' |
| | | 384 | | // SeriesPresentationUniqueKey is not set yet, so the presentation-key based query would miss |
| | | 385 | | // them. GetRecursiveChildren walks the actual child tree and sees them regardless. |
| | 0 | 386 | | foreach (var episode in series.GetRecursiveChildren(i => i is Episode).OfType<Episode>()) |
| | | 387 | | { |
| | | 388 | | // The series is refreshed before its episodes during an initial scan, so a freshly |
| | | 389 | | // resolved physical episode may not have its numbers populated yet. Resolve them from |
| | | 390 | | // the path (in memory, mirroring CreateSeasonsAsync) so we can dedupe against episodes |
| | | 391 | | // the user actually has files for instead of creating virtual duplicates. |
| | 0 | 392 | | if (episode.IsFileProtocol && (!episode.ParentIndexNumber.HasValue || !episode.IndexNumber.HasValue)) |
| | | 393 | | { |
| | | 394 | | try |
| | | 395 | | { |
| | 0 | 396 | | _libraryManager.FillMissingEpisodeNumbersFromPath(episode, false); |
| | 0 | 397 | | } |
| | 0 | 398 | | catch (Exception ex) |
| | | 399 | | { |
| | 0 | 400 | | _logger.LogError(ex, "Error resolving episode number from path for {Path}", episode.Path); |
| | 0 | 401 | | } |
| | | 402 | | } |
| | | 403 | | |
| | | 404 | | // Virtual episodes this provider created are candidates for metadata sync (and pruning). |
| | 0 | 405 | | var isOurs = episode.IsVirtualItem && episode.HasProviderId(MetadataProvider.Tmdb); |
| | | 406 | | |
| | 0 | 407 | | if (ShouldPrune(episode, pruneAgedOut, today, gracePeriodDays, importSpecials)) |
| | | 408 | | { |
| | 0 | 409 | | DeleteEpisode(episode, "no longer upcoming and missing episodes are disabled"); |
| | 0 | 410 | | pruned = true; |
| | 0 | 411 | | continue; |
| | | 412 | | } |
| | | 413 | | |
| | 0 | 414 | | if (!episode.IsVirtualItem) |
| | | 415 | | { |
| | | 416 | | // Which episode a file holds is what TMDb's episode id says, not the number the file is |
| | | 417 | | // stored under: aired, DVD and absolute orders number the same episodes differently. |
| | 0 | 418 | | var physicalTmdbId = episode.GetProviderId(MetadataProvider.Tmdb); |
| | 0 | 419 | | if (!string.IsNullOrEmpty(physicalTmdbId)) |
| | | 420 | | { |
| | 0 | 421 | | physicalTmdbIds.Add(physicalTmdbId); |
| | | 422 | | } |
| | | 423 | | } |
| | | 424 | | |
| | 0 | 425 | | if (episode.ParentIndexNumber.HasValue && episode.IndexNumber.HasValue) |
| | | 426 | | { |
| | 0 | 427 | | var key = (episode.ParentIndexNumber.Value, episode.IndexNumber.Value); |
| | 0 | 428 | | keys.Add(key); |
| | | 429 | | |
| | | 430 | | // Defer the ours/physical reconciliation: an episode's virtual counterpart and its |
| | | 431 | | // physical file can appear in either order while walking the tree, so we can only |
| | | 432 | | // decide which of our virtual episodes are superseded once every episode is seen. |
| | 0 | 433 | | if (isOurs) |
| | | 434 | | { |
| | 0 | 435 | | ourVirtuals.Add((key, episode)); |
| | | 436 | | } |
| | 0 | 437 | | else if (!episode.IsVirtualItem) |
| | | 438 | | { |
| | 0 | 439 | | physicalKeys.Add(key); |
| | | 440 | | } |
| | | 441 | | } |
| | | 442 | | } |
| | | 443 | | |
| | | 444 | | // A physical file now exists for one of our placeholders: delete the placeholder here rather |
| | | 445 | | // than updating it (and then leaving RemoveObsoleteEpisodes to delete it moments later). The |
| | | 446 | | // physical key already blocks re-creation via the dedupe set above. |
| | 0 | 447 | | foreach (var (key, episode) in ourVirtuals) |
| | | 448 | | { |
| | 0 | 449 | | if (physicalKeys.Contains(key)) |
| | | 450 | | { |
| | 0 | 451 | | DeleteEpisode(episode, "a physical episode now exists for this slot"); |
| | 0 | 452 | | pruned = true; |
| | | 453 | | } |
| | 0 | 454 | | else if (physicalTmdbIds.Contains(episode.GetProviderId(MetadataProvider.Tmdb)!)) |
| | | 455 | | { |
| | 0 | 456 | | DeleteEpisode(episode, "the same episode is already present under another number"); |
| | 0 | 457 | | pruned = true; |
| | | 458 | | } |
| | | 459 | | else |
| | | 460 | | { |
| | | 461 | | // Virtual episodes this provider created are candidates for metadata sync. |
| | 0 | 462 | | updatable[key] = episode; |
| | | 463 | | } |
| | | 464 | | } |
| | | 465 | | |
| | 0 | 466 | | return (keys, updatable, physicalTmdbIds); |
| | | 467 | | } |
| | | 468 | | |
| | | 469 | | /// <summary> |
| | | 470 | | /// Removes every virtual episode this provider previously created in the series. |
| | | 471 | | /// </summary> |
| | | 472 | | /// <param name="series">The series to clean up.</param> |
| | | 473 | | /// <returns><c>true</c> if any episode was removed; otherwise <c>false</c>.</returns> |
| | | 474 | | private bool PruneAllVirtualEpisodes(Series series) |
| | | 475 | | { |
| | 0 | 476 | | var pruned = false; |
| | 0 | 477 | | foreach (var episode in series.GetRecursiveChildren(i => i is Episode).OfType<Episode>()) |
| | | 478 | | { |
| | 0 | 479 | | if (episode.IsVirtualItem && episode.HasProviderId(MetadataProvider.Tmdb)) |
| | | 480 | | { |
| | 0 | 481 | | DeleteEpisode(episode, "the TMDb missing episode provider is disabled for this library"); |
| | 0 | 482 | | pruned = true; |
| | | 483 | | } |
| | | 484 | | } |
| | | 485 | | |
| | 0 | 486 | | return pruned; |
| | | 487 | | } |
| | | 488 | | |
| | | 489 | | private void DeleteEpisode(Episode episode, string reason) |
| | | 490 | | { |
| | 0 | 491 | | _logger.LogInformation( |
| | 0 | 492 | | "Removing virtual episode S{SeasonNumber}E{EpisodeNumber} in series {SeriesName}: {Reason}", |
| | 0 | 493 | | episode.ParentIndexNumber, |
| | 0 | 494 | | episode.IndexNumber, |
| | 0 | 495 | | episode.SeriesName, |
| | 0 | 496 | | reason); |
| | | 497 | | |
| | 0 | 498 | | _libraryManager.DeleteItem( |
| | 0 | 499 | | episode, |
| | 0 | 500 | | new DeleteOptions { DeleteFileLocation = false }, |
| | 0 | 501 | | false); |
| | 0 | 502 | | } |
| | | 503 | | |
| | | 504 | | /// <summary> |
| | | 505 | | /// Determines whether a TMDb episode should be imported as a virtual item, based on its air date |
| | | 506 | | /// and the enabled options. Undated episodes are never imported; unaired (today or later) episodes |
| | | 507 | | /// require <paramref name="importUnaired"/>; already aired episodes require <paramref name="importMissing"/>. |
| | | 508 | | /// Specials (season 0) are only imported when <paramref name="importSpecials"/> is enabled. |
| | | 509 | | /// </summary> |
| | | 510 | | /// <param name="premiereDate">The episode air date (UTC), or null if unknown.</param> |
| | | 511 | | /// <param name="today">The current UTC date.</param> |
| | | 512 | | /// <param name="importUnaired">Whether unaired (upcoming) episodes should be imported.</param> |
| | | 513 | | /// <param name="importMissing">Whether already aired missing episodes should be imported.</param> |
| | | 514 | | /// <param name="isSpecial">Whether the episode belongs to the specials season (season 0).</param> |
| | | 515 | | /// <param name="importSpecials">Whether specials should be included.</param> |
| | | 516 | | /// <returns><c>true</c> if the episode should be imported; otherwise <c>false</c>.</returns> |
| | | 517 | | internal static bool ShouldImportEpisode(DateTime? premiereDate, DateTime today, bool importUnaired, bool import |
| | | 518 | | { |
| | 16 | 519 | | if (!premiereDate.HasValue) |
| | | 520 | | { |
| | 2 | 521 | | return false; |
| | | 522 | | } |
| | | 523 | | |
| | | 524 | | // Specials are only imported when the user opts in. |
| | 14 | 525 | | if (isSpecial && !importSpecials) |
| | | 526 | | { |
| | 2 | 527 | | return false; |
| | | 528 | | } |
| | | 529 | | |
| | 12 | 530 | | var isUnaired = premiereDate.Value.Date >= today; |
| | 12 | 531 | | return isUnaired ? importUnaired : importMissing; |
| | | 532 | | } |
| | | 533 | | |
| | | 534 | | /// <summary> |
| | | 535 | | /// Determines whether an existing virtual episode created by this provider (carries a TMDb id) |
| | | 536 | | /// should be pruned. Specials are removed entirely unless <paramref name="importSpecials"/> is |
| | | 537 | | /// enabled. Otherwise, when missing episodes are not wanted, an entry is pruned once its air date |
| | | 538 | | /// is more than <paramref name="gracePeriodDays"/> in the past; the grace period keeps recently |
| | | 539 | | /// aired episodes in place to allow for the delay between an episode airing and its file being |
| | | 540 | | /// added to the library. |
| | | 541 | | /// </summary> |
| | | 542 | | /// <param name="episode">The episode to evaluate.</param> |
| | | 543 | | /// <param name="pruneAgedOut">Whether aged-out virtual episodes should be pruned (missing import disabled).</pa |
| | | 544 | | /// <param name="today">The current UTC date.</param> |
| | | 545 | | /// <param name="gracePeriodDays">The number of days an aired episode is retained before pruning.</param> |
| | | 546 | | /// <param name="importSpecials">Whether specials should be kept.</param> |
| | | 547 | | /// <returns><c>true</c> if the episode should be pruned; otherwise <c>false</c>.</returns> |
| | | 548 | | internal static bool ShouldPrune(Episode episode, bool pruneAgedOut, DateTime today, int gracePeriodDays, bool i |
| | | 549 | | { |
| | 9 | 550 | | if (!episode.IsVirtualItem || !episode.HasProviderId(MetadataProvider.Tmdb)) |
| | | 551 | | { |
| | 2 | 552 | | return false; |
| | | 553 | | } |
| | | 554 | | |
| | | 555 | | // Specials are removed entirely unless the user opts in. |
| | 7 | 556 | | if (episode.ParentIndexNumber == 0 && !importSpecials) |
| | | 557 | | { |
| | 1 | 558 | | return true; |
| | | 559 | | } |
| | | 560 | | |
| | | 561 | | // When missing episodes are not wanted, prune placeholders for episodes that aired more than |
| | | 562 | | // the grace period ago. |
| | 6 | 563 | | return pruneAgedOut |
| | 6 | 564 | | && episode.PremiereDate.HasValue |
| | 6 | 565 | | && episode.PremiereDate.Value.Date < today.AddDays(-gracePeriodDays); |
| | | 566 | | } |
| | | 567 | | |
| | | 568 | | internal static DateTime? GetPremiereDate(TvSeasonEpisode tmdbEpisode) |
| | | 569 | | { |
| | 2 | 570 | | return tmdbEpisode.AirDate.HasValue |
| | 2 | 571 | | ? DateTime.SpecifyKind(tmdbEpisode.AirDate.Value, DateTimeKind.Local).ToUniversalTime() |
| | 2 | 572 | | : null; |
| | | 573 | | } |
| | | 574 | | |
| | | 575 | | internal static bool UpdateVirtualEpisode(Episode episode, TvSeasonEpisode tmdbEpisode, DateTime? premiereDate) |
| | | 576 | | { |
| | 4 | 577 | | var changed = false; |
| | | 578 | | |
| | 4 | 579 | | if (!string.IsNullOrEmpty(tmdbEpisode.Name) && !string.Equals(episode.Name, tmdbEpisode.Name, StringComparis |
| | | 580 | | { |
| | 1 | 581 | | episode.Name = tmdbEpisode.Name; |
| | 1 | 582 | | changed = true; |
| | | 583 | | } |
| | | 584 | | |
| | 4 | 585 | | if (!string.IsNullOrEmpty(tmdbEpisode.Overview) && !string.Equals(episode.Overview, tmdbEpisode.Overview, St |
| | | 586 | | { |
| | 0 | 587 | | episode.Overview = tmdbEpisode.Overview; |
| | 0 | 588 | | changed = true; |
| | | 589 | | } |
| | | 590 | | |
| | 4 | 591 | | if (premiereDate.HasValue && episode.PremiereDate != premiereDate) |
| | | 592 | | { |
| | 1 | 593 | | episode.PremiereDate = premiereDate; |
| | 1 | 594 | | episode.ProductionYear = tmdbEpisode.AirDate?.Year; |
| | 1 | 595 | | changed = true; |
| | | 596 | | } |
| | | 597 | | |
| | 4 | 598 | | return changed; |
| | | 599 | | } |
| | | 600 | | |
| | | 601 | | private Episode AddVirtualEpisode(Series series, Season season, TvSeasonEpisode tmdbEpisode, DateTime? premiereD |
| | | 602 | | { |
| | 0 | 603 | | var seasonNumber = season.IndexNumber.GetValueOrDefault(); |
| | 0 | 604 | | var episodeNumber = (int)tmdbEpisode.EpisodeNumber; |
| | | 605 | | |
| | | 606 | | // Leaving Path unset makes the item a virtual (metadata-only) episode. |
| | 0 | 607 | | var episode = new Episode |
| | 0 | 608 | | { |
| | 0 | 609 | | Name = tmdbEpisode.Name, |
| | 0 | 610 | | IndexNumber = episodeNumber, |
| | 0 | 611 | | ParentIndexNumber = seasonNumber, |
| | 0 | 612 | | Id = _libraryManager.GetNewItemId( |
| | 0 | 613 | | series.Id.ToString("N", CultureInfo.InvariantCulture) |
| | 0 | 614 | | + "Season" + seasonNumber.ToString(CultureInfo.InvariantCulture) |
| | 0 | 615 | | + "Episode" + episodeNumber.ToString(CultureInfo.InvariantCulture), |
| | 0 | 616 | | typeof(Episode)), |
| | 0 | 617 | | IsVirtualItem = true, |
| | 0 | 618 | | PremiereDate = premiereDate, |
| | 0 | 619 | | ProductionYear = tmdbEpisode.AirDate?.Year, |
| | 0 | 620 | | Overview = tmdbEpisode.Overview, |
| | 0 | 621 | | SeasonId = season.Id, |
| | 0 | 622 | | SeasonName = season.Name, |
| | 0 | 623 | | SeriesId = series.Id, |
| | 0 | 624 | | SeriesName = series.Name, |
| | 0 | 625 | | SeriesPresentationUniqueKey = series.GetPresentationUniqueKey() |
| | 0 | 626 | | }; |
| | | 627 | | |
| | 0 | 628 | | episode.PresentationUniqueKey = episode.CreatePresentationUniqueKey(); |
| | | 629 | | |
| | 0 | 630 | | if (tmdbEpisode.Id > 0) |
| | | 631 | | { |
| | 0 | 632 | | episode.SetProviderId(MetadataProvider.Tmdb, tmdbEpisode.Id.ToString(CultureInfo.InvariantCulture)); |
| | | 633 | | } |
| | | 634 | | |
| | 0 | 635 | | _logger.LogInformation( |
| | 0 | 636 | | "Creating virtual episode S{SeasonNumber}E{EpisodeNumber} for series {SeriesName}", |
| | 0 | 637 | | seasonNumber, |
| | 0 | 638 | | episodeNumber, |
| | 0 | 639 | | series.Name); |
| | | 640 | | |
| | 0 | 641 | | season.AddChild(episode); |
| | | 642 | | |
| | 0 | 643 | | return episode; |
| | | 644 | | } |
| | | 645 | | |
| | | 646 | | /// <summary> |
| | | 647 | | /// Downloads the TMDb still for a virtual episode that has no image yet, so it does not fall back |
| | | 648 | | /// to the season/series image. |
| | | 649 | | /// </summary> |
| | | 650 | | /// <param name="episode">The virtual episode.</param> |
| | | 651 | | /// <param name="tmdbEpisode">The matching TMDb episode.</param> |
| | | 652 | | /// <param name="cancellationToken">The cancellation token.</param> |
| | | 653 | | /// <returns><c>true</c> if a still was downloaded and saved; otherwise <c>false</c>.</returns> |
| | | 654 | | private async Task<bool> EnsureEpisodeImageAsync(Episode episode, TvSeasonEpisode tmdbEpisode, CancellationToken |
| | | 655 | | { |
| | | 656 | | // The still ships with the season episode list, so use it directly instead of a per-episode lookup. |
| | 0 | 657 | | if (episode.HasImage(ImageType.Primary, 0) || string.IsNullOrEmpty(tmdbEpisode.StillPath)) |
| | | 658 | | { |
| | 0 | 659 | | return false; |
| | | 660 | | } |
| | | 661 | | |
| | 0 | 662 | | var stillUrl = _tmdbClientManager.GetStillUrl(tmdbEpisode.StillPath); |
| | 0 | 663 | | if (string.IsNullOrEmpty(stillUrl)) |
| | | 664 | | { |
| | 0 | 665 | | return false; |
| | | 666 | | } |
| | | 667 | | |
| | | 668 | | try |
| | | 669 | | { |
| | | 670 | | // SaveImage sets the image path on the item but does not persist it, so save afterwards. |
| | 0 | 671 | | await _providerManager.SaveImage(episode, stillUrl, ImageType.Primary, null, cancellationToken).Configur |
| | 0 | 672 | | await episode.UpdateToRepositoryAsync(ItemUpdateType.ImageUpdate, cancellationToken).ConfigureAwait(fals |
| | 0 | 673 | | return true; |
| | | 674 | | } |
| | 0 | 675 | | catch (Exception ex) |
| | | 676 | | { |
| | 0 | 677 | | _logger.LogError( |
| | 0 | 678 | | ex, |
| | 0 | 679 | | "Error downloading still for virtual episode S{SeasonNumber}E{EpisodeNumber} of {SeriesName}", |
| | 0 | 680 | | episode.ParentIndexNumber, |
| | 0 | 681 | | episode.IndexNumber, |
| | 0 | 682 | | episode.SeriesName); |
| | 0 | 683 | | return false; |
| | | 684 | | } |
| | 0 | 685 | | } |
| | | 686 | | } |
| | | 687 | | } |