From 5f6f4915a1011c9c38928d902564ed024dfec25f Mon Sep 17 00:00:00 2001 From: Mark McDowall Date: Sat, 1 Dec 2018 00:35:46 -0800 Subject: [PATCH] Delay import when absolute episode number is missing New: Delay import is absolute episode number is required and is missing for EpisodeFormat --- ...soluteEpisodeNumberSpecificationFixture.cs | 77 +++++++++++++++++++ .../NzbDrone.Core.Test.csproj | 2 + .../RequiresAbsoluteEpisodeNumberFixture.cs | 55 +++++++++++++ .../AbsoluteEpisodeNumberSpecification.cs | 58 ++++++++++++++ src/NzbDrone.Core/NzbDrone.Core.csproj | 1 + .../Organizer/FileNameBuilder.cs | 21 +++++ 6 files changed, 214 insertions(+) create mode 100644 src/NzbDrone.Core.Test/MediaFiles/EpisodeImport/Specifications/AbsoluteEpisodeNumberSpecificationFixture.cs create mode 100644 src/NzbDrone.Core.Test/OrganizerTests/FileNameBuilderTests/RequiresAbsoluteEpisodeNumberFixture.cs create mode 100644 src/NzbDrone.Core/MediaFiles/EpisodeImport/Specifications/AbsoluteEpisodeNumberSpecification.cs diff --git a/src/NzbDrone.Core.Test/MediaFiles/EpisodeImport/Specifications/AbsoluteEpisodeNumberSpecificationFixture.cs b/src/NzbDrone.Core.Test/MediaFiles/EpisodeImport/Specifications/AbsoluteEpisodeNumberSpecificationFixture.cs new file mode 100644 index 000000000..3a64a5127 --- /dev/null +++ b/src/NzbDrone.Core.Test/MediaFiles/EpisodeImport/Specifications/AbsoluteEpisodeNumberSpecificationFixture.cs @@ -0,0 +1,77 @@ +using System; +using System.Linq; +using FizzWare.NBuilder; +using FluentAssertions; +using NUnit.Framework; +using NzbDrone.Core.MediaFiles.EpisodeImport.Specifications; +using NzbDrone.Core.Organizer; +using NzbDrone.Core.Parser.Model; +using NzbDrone.Core.Test.Framework; +using NzbDrone.Core.Tv; +using NzbDrone.Test.Common; + +namespace NzbDrone.Core.Test.MediaFiles.EpisodeImport.Specifications +{ + [TestFixture] + public class AbsoluteEpisodeNumberSpecificationFixture : CoreTest + { + private Series _series; + private LocalEpisode _localEpisode; + + [SetUp] + public void Setup() + { + _series = Builder.CreateNew() + .With(s => s.SeriesType = SeriesTypes.Anime) + .With(s => s.Path = @"C:\Test\TV\30 Rock".AsOsAgnostic()) + .Build(); + + var episodes = Builder.CreateListOfSize(1) + .All() + .With(e => e.SeasonNumber = 1) + .With(e => e.AirDateUtc = DateTime.UtcNow) + .Build() + .ToList(); + + _localEpisode = new LocalEpisode + { + Path = @"C:\Test\Unsorted\30 Rock\30.rock.s01e01.avi".AsOsAgnostic(), + Episodes = episodes, + Series = _series + }; + + Mocker.GetMock() + .Setup(s => s.RequiresAbsoluteEpisodeNumber(_series, episodes)) + .Returns(true); + } + + [Test] + public void should_reject_when_absolute_episode_number_is_null() + { + _localEpisode.Episodes.First().AbsoluteEpisodeNumber = null; + + Subject.IsSatisfiedBy(_localEpisode, null).Accepted.Should().BeFalse(); + } + + [Test] + public void should_accept_when_did_not_air_recently_but_absolute_episode_number_is_null() + { + _localEpisode.Episodes.First().AirDateUtc = DateTime.UtcNow.AddDays(-7); + _localEpisode.Episodes.First().AbsoluteEpisodeNumber = null; + + Subject.IsSatisfiedBy(_localEpisode, null).Accepted.Should().BeTrue(); + } + + [Test] + public void should_accept_when_absolute_episode_number_is_not_required() + { + _localEpisode.Episodes.First().AbsoluteEpisodeNumber = null; + + Mocker.GetMock() + .Setup(s => s.RequiresAbsoluteEpisodeNumber(_series, _localEpisode.Episodes)) + .Returns(false); + + Subject.IsSatisfiedBy(_localEpisode, null).Accepted.Should().BeTrue(); + } + } +} diff --git a/src/NzbDrone.Core.Test/NzbDrone.Core.Test.csproj b/src/NzbDrone.Core.Test/NzbDrone.Core.Test.csproj index f0586f599..3d81c628a 100644 --- a/src/NzbDrone.Core.Test/NzbDrone.Core.Test.csproj +++ b/src/NzbDrone.Core.Test/NzbDrone.Core.Test.csproj @@ -312,6 +312,7 @@ + @@ -332,6 +333,7 @@ + diff --git a/src/NzbDrone.Core.Test/OrganizerTests/FileNameBuilderTests/RequiresAbsoluteEpisodeNumberFixture.cs b/src/NzbDrone.Core.Test/OrganizerTests/FileNameBuilderTests/RequiresAbsoluteEpisodeNumberFixture.cs new file mode 100644 index 000000000..3093e339b --- /dev/null +++ b/src/NzbDrone.Core.Test/OrganizerTests/FileNameBuilderTests/RequiresAbsoluteEpisodeNumberFixture.cs @@ -0,0 +1,55 @@ +using System.Collections.Generic; +using FizzWare.NBuilder; +using FluentAssertions; +using NUnit.Framework; +using NzbDrone.Core.Organizer; +using NzbDrone.Core.Test.Framework; +using NzbDrone.Core.Tv; + +namespace NzbDrone.Core.Test.OrganizerTests.FileNameBuilderTests +{ + [TestFixture] + public class RequiresAbsoluteEpisodeNumberFixture : CoreTest + { + private Series _series; + private Episode _episode; + private NamingConfig _namingConfig; + + [SetUp] + public void Setup() + { + _series = Builder + .CreateNew() + .With(s => s.SeriesType = SeriesTypes.Anime) + .With(s => s.Title = "South Park") + .Build(); + + _episode = Builder.CreateNew() + .With(e => e.Title = "City Sushi") + .With(e => e.SeasonNumber = 15) + .With(e => e.EpisodeNumber = 6) + .With(e => e.AbsoluteEpisodeNumber = 100) + .Build(); + + _namingConfig = NamingConfig.Default; + _namingConfig.RenameEpisodes = true; + + Mocker.GetMock() + .Setup(c => c.GetConfig()).Returns(_namingConfig); + } + + [Test] + public void should_return_false_when_absolute_episode_number_is_not_part_of_the_pattern() + { + _namingConfig.AnimeEpisodeFormat = "{Series Title} S{season:00}E{episode:00}"; + Subject.RequiresAbsoluteEpisodeNumber(_series, new List { _episode }).Should().BeFalse(); + } + + [Test] + public void should_return_true_when_absolute_episode_number_is_part_of_the_pattern() + { + _namingConfig.AnimeEpisodeFormat = "{Series Title} {absolute:00}"; + Subject.RequiresAbsoluteEpisodeNumber(_series, new List { _episode }).Should().BeTrue(); + } + } +} diff --git a/src/NzbDrone.Core/MediaFiles/EpisodeImport/Specifications/AbsoluteEpisodeNumberSpecification.cs b/src/NzbDrone.Core/MediaFiles/EpisodeImport/Specifications/AbsoluteEpisodeNumberSpecification.cs new file mode 100644 index 000000000..65eeabd5c --- /dev/null +++ b/src/NzbDrone.Core/MediaFiles/EpisodeImport/Specifications/AbsoluteEpisodeNumberSpecification.cs @@ -0,0 +1,58 @@ +using System; +using NLog; +using NzbDrone.Common.Extensions; +using NzbDrone.Core.DecisionEngine; +using NzbDrone.Core.Download; +using NzbDrone.Core.Organizer; +using NzbDrone.Core.Parser.Model; +using NzbDrone.Core.Tv; + +namespace NzbDrone.Core.MediaFiles.EpisodeImport.Specifications +{ + public class AbsoluteEpisodeNumberSpecification : IImportDecisionEngineSpecification + { + private readonly IBuildFileNames _buildFileNames; + private readonly Logger _logger; + + public AbsoluteEpisodeNumberSpecification(IBuildFileNames buildFileNames, Logger logger) + { + _buildFileNames = buildFileNames; + _logger = logger; + } + public Decision IsSatisfiedBy(LocalEpisode localEpisode, DownloadClientItem downloadClientItem) + { + if (localEpisode.Series.SeriesType != SeriesTypes.Anime) + { + _logger.Debug("Series type is not Anime, skipping check"); + return Decision.Accept(); + } + + if (!_buildFileNames.RequiresAbsoluteEpisodeNumber(localEpisode.Series, localEpisode.Episodes)) + { + _logger.Debug("File name format does not require absolute episode number, skipping check"); + return Decision.Accept(); + } + + foreach (var episode in localEpisode.Episodes) + { + var airDateUtc = episode.AirDateUtc; + var absoluteEpisodeNumber = episode.AbsoluteEpisodeNumber; + + if (airDateUtc.HasValue && airDateUtc.Value.Before(DateTime.UtcNow.AddDays(-1))) + { + _logger.Debug("Episode aired more than 1 day ago"); + continue; + } + + if (!absoluteEpisodeNumber.HasValue) + { + _logger.Debug("Episode does not have an absolute episode number and recently aired"); + + return Decision.Reject("Episode does not have an absolute episode number and recently aired"); + } + } + + return Decision.Accept(); + } + } +} diff --git a/src/NzbDrone.Core/NzbDrone.Core.csproj b/src/NzbDrone.Core/NzbDrone.Core.csproj index 7cf0203eb..dbc5a5dd0 100644 --- a/src/NzbDrone.Core/NzbDrone.Core.csproj +++ b/src/NzbDrone.Core/NzbDrone.Core.csproj @@ -776,6 +776,7 @@ + diff --git a/src/NzbDrone.Core/Organizer/FileNameBuilder.cs b/src/NzbDrone.Core/Organizer/FileNameBuilder.cs index 0474d635b..16582b025 100644 --- a/src/NzbDrone.Core/Organizer/FileNameBuilder.cs +++ b/src/NzbDrone.Core/Organizer/FileNameBuilder.cs @@ -25,6 +25,7 @@ namespace NzbDrone.Core.Organizer string GetSeriesFolder(Series series, NamingConfig namingConfig = null); string GetSeasonFolder(Series series, int seasonNumber, NamingConfig namingConfig = null); bool RequiresEpisodeTitle(Series series, List episodes); + bool RequiresAbsoluteEpisodeNumber(Series series, List episodes); } public class FileNameBuilder : IBuildFileNames @@ -35,6 +36,7 @@ namespace NzbDrone.Core.Organizer private readonly ICached _episodeFormatCache; private readonly ICached _absoluteEpisodeFormatCache; private readonly ICached _requiresEpisodeTitleCache; + private readonly ICached _requiresAbsoluteEpisodeNumberCache; private readonly Logger _logger; private static readonly Regex TitleRegex = new Regex(@"\{(?[- ._\[(]*)(?(?:[a-z0-9]+)(?:(?[- ._]+)(?:[a-z0-9]+))?)(?::(?[a-z0-9]+))?(?[- ._)\]]*)\}", @@ -87,6 +89,7 @@ namespace NzbDrone.Core.Organizer _episodeFormatCache = cacheManager.GetCache(GetType(), "episodeFormat"); _absoluteEpisodeFormatCache = cacheManager.GetCache(GetType(), "absoluteEpisodeFormat"); _requiresEpisodeTitleCache = cacheManager.GetCache(GetType(), "requiresEpisodeTitle"); + _requiresAbsoluteEpisodeNumberCache = cacheManager.GetCache(GetType(), "requiresAbsoluteEpisodeNumber"); _logger = logger; } @@ -340,6 +343,24 @@ namespace NzbDrone.Core.Organizer }); } + public bool RequiresAbsoluteEpisodeNumber(Series series, List episodes) + { + if (series.SeriesType != SeriesTypes.Anime) + { + return false; + } + + var namingConfig = _namingConfigService.GetConfig(); + var pattern = namingConfig.AnimeEpisodeFormat; + + return _requiresAbsoluteEpisodeNumberCache.Get(pattern, () => + { + var matches = AbsoluteEpisodeRegex.Matches(pattern); + + return matches.Count > 0; + }); + } + private void AddSeriesTokens(Dictionary> tokenHandlers, Series series) { tokenHandlers["{Series Title}"] = m => series.Title;