New: Delay import of episodes without titles temporarily

Closes #2098

src/NzbDrone.Core.Test/MediaFiles/EpisodeImport/Specifications/EpisodeTitleSpecificationFixture.cs

@@ -0,0 +1,85 @@
+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 EpisodeTitleSpecificationFixture : CoreTest<EpisodeTitleSpecification>
+    {
+        private Series _series;
+        private LocalEpisode _localEpisode;
+
+        [SetUp]
+        public void Setup()
+        {
+            _series = Builder<Series>.CreateNew()
+                                     .With(s => s.SeriesType = SeriesTypes.Standard)
+                                     .With(s => s.Path = @"C:\Test\TV\30 Rock".AsOsAgnostic())
+                                     .Build();
+
+            var episodes = Builder<Episode>.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<IBuildFileNames>()
+                  .Setup(s => s.RequiresEpisodeTitle(_series, episodes))
+                  .Returns(true);
+        }
+
+        [Test]
+        public void should_reject_when_title_is_null()
+        {
+            _localEpisode.Episodes.First().Title = null;
+
+            Subject.IsSatisfiedBy(_localEpisode, null).Accepted.Should().BeFalse();
+        }
+
+        [Test]
+        public void should_reject_when_title_is_TBA()
+        {
+            _localEpisode.Episodes.First().Title = "TBA";
+
+            Subject.IsSatisfiedBy(_localEpisode, null).Accepted.Should().BeFalse();
+        }
+
+        [Test]
+        public void should_accept_when_did_not_air_recently_but_title_is_TBA()
+        {
+            _localEpisode.Episodes.First().AirDateUtc = DateTime.UtcNow.AddDays(-7);
+            _localEpisode.Episodes.First().Title = "TBA";
+
+            Subject.IsSatisfiedBy(_localEpisode, null).Accepted.Should().BeTrue();
+        }
+
+        [Test]
+        public void should_accept_when_episode_title_is_not_required()
+        {
+            _localEpisode.Episodes.First().Title = "TBA";
+
+            Mocker.GetMock<IBuildFileNames>()
+                  .Setup(s => s.RequiresEpisodeTitle(_series, _localEpisode.Episodes))
+                  .Returns(false);
+
+            Subject.IsSatisfiedBy(_localEpisode, null).Accepted.Should().BeTrue();
+        }
+    }
+}

src/NzbDrone.Core.Test/NzbDrone.Core.Test.csproj

@@ -300,6 +300,7 @@
     <Compile Include="MediaFiles\EpisodeFileMovingServiceTests\MoveEpisodeFileFixture.cs" />
     <Compile Include="MediaFiles\EpisodeImport\ImportDecisionMakerFixture.cs" />
     <Compile Include="MediaFiles\EpisodeImport\DetectSampleFixture.cs" />
+    <Compile Include="MediaFiles\EpisodeImport\Specifications\EpisodeTitleSpecificationFixture.cs" />
     <Compile Include="MediaFiles\EpisodeImport\Specifications\FreeSpaceSpecificationFixture.cs" />
     <Compile Include="MediaFiles\EpisodeImport\Specifications\FullSeasonSpecificationFixture.cs" />
     <Compile Include="MediaFiles\EpisodeImport\Specifications\SameFileSpecificationFixture.cs" />
@@ -320,6 +321,7 @@
     <Compile Include="MetadataSource\SkyHook\SkyHookProxyFixture.cs" />
     <Compile Include="NotificationTests\NotificationBaseFixture.cs" />
     <Compile Include="NotificationTests\SynologyIndexerFixture.cs" />
+    <Compile Include="OrganizerTests\FileNameBuilderTests\RequiresEpisodeTitleFixture.cs" />
     <Compile Include="OrganizerTests\FileNameBuilderTests\CleanTitleFixture.cs" />
     <Compile Include="OrganizerTests\FileNameBuilderTests\EpisodeTitleCollapseFixture.cs" />
     <Compile Include="OrganizerTests\FileNameBuilderTests\MultiEpisodeFixture.cs" />

src/NzbDrone.Core.Test/OrganizerTests/FileNameBuilderTests/RequiresEpisodeTitleFixture.cs

@@ -0,0 +1,57 @@
+using System.Collections.Generic;
+using System.Linq;
+using FizzWare.NBuilder;
+using FluentAssertions;
+using NUnit.Framework;
+using NzbDrone.Core.MediaFiles;
+using NzbDrone.Core.Organizer;
+using NzbDrone.Core.Qualities;
+using NzbDrone.Core.Test.Framework;
+using NzbDrone.Core.Tv;
+
+namespace NzbDrone.Core.Test.OrganizerTests.FileNameBuilderTests
+{
+    [TestFixture]
+    public class RequiresEpisodeTitleFixture : CoreTest<FileNameBuilder>
+    {
+        private Series _series;
+        private Episode _episode;
+        private EpisodeFile _episodeFile;
+        private NamingConfig _namingConfig;
+
+        [SetUp]
+        public void Setup()
+        {
+            _series = Builder<Series>
+                    .CreateNew()
+                    .With(s => s.Title = "South Park")
+                    .Build();
+
+            _episode = Builder<Episode>.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<INamingConfigService>()
+                  .Setup(c => c.GetConfig()).Returns(_namingConfig);
+        }
+
+        [Test]
+        public void should_return_false_when_episode_title_is_not_part_of_the_pattern()
+        {
+            _namingConfig.StandardEpisodeFormat = "{Series Title} S{season:00}E{episode:00}";
+            Subject.RequiresEpisodeTitle(_series, new List<Episode> { _episode }).Should().BeFalse();
+        }
+
+        [Test]
+        public void should_return_true_when_episode_title_is_part_of_the_pattern()
+        {
+            Subject.RequiresEpisodeTitle(_series, new List<Episode> { _episode }).Should().BeTrue();
+        }
+    }
+}

src/NzbDrone.Core.Test/TvTests/ShouldRefreshSeriesFixture.cs

@@ -51,7 +51,7 @@ namespace NzbDrone.Core.Test.TvTests
 
         private void GivenSeriesLastRefreshedRecently()
         {
-            _series.LastInfoSync = DateTime.UtcNow.AddHours(-1);
+            _series.LastInfoSync = DateTime.UtcNow.AddMinutes(-30);
         }
 
         private void GivenRecentlyAired()

src/NzbDrone.Core/MediaFiles/EpisodeImport/Specifications/EpisodeTitleSpecification.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;
+
+namespace NzbDrone.Core.MediaFiles.EpisodeImport.Specifications
+{
+    public class EpisodeTitleSpecification : IImportDecisionEngineSpecification
+    {
+        private readonly IBuildFileNames _buildFileNames;
+        private readonly Logger _logger;
+
+        public EpisodeTitleSpecification(IBuildFileNames buildFileNames, Logger logger)
+        {
+            _buildFileNames = buildFileNames;
+            _logger = logger;
+        }
+        public Decision IsSatisfiedBy(LocalEpisode localEpisode, DownloadClientItem downloadClientItem)
+        {
+            if (!_buildFileNames.RequiresEpisodeTitle(localEpisode.Series, localEpisode.Episodes))
+            {
+                _logger.Debug("File name format does not require episode title, skipping check");
+                return Decision.Accept();
+            }
+
+            foreach (var episode in localEpisode.Episodes)
+            {
+                var airDateUtc = episode.AirDateUtc;
+                var title = episode.Title;
+
+                if (airDateUtc.HasValue && airDateUtc.Value.Before(DateTime.UtcNow.AddDays(-1)))
+                {
+                    _logger.Debug("Episode aired more than 1 day ago");
+                    continue;
+                }
+
+                if (title.IsNullOrWhiteSpace())
+                {
+                    _logger.Debug("Episode does not have a title and recently aired");
+
+                    return Decision.Reject("Episode does not have a title and recently aired");
+                }
+
+                if (title.Equals("TBA"))
+                {
+                    _logger.Debug("Episode has a TBA title and recently aired");
+
+                    return Decision.Reject("Episode has a TBA title and recently aired");
+                }
+            }
+
+            return Decision.Accept();
+        }
+    }
+}

src/NzbDrone.Core/NzbDrone.Core.csproj

@@ -789,6 +789,7 @@
     <Compile Include="MediaFiles\EpisodeImport\DetectSample.cs" />
     <Compile Include="MediaFiles\EpisodeImport\Manual\ManuallyImportedFile.cs" />
     <Compile Include="MediaFiles\EpisodeImport\RootFolderNotFoundException.cs" />
+    <Compile Include="MediaFiles\EpisodeImport\Specifications\EpisodeTitleSpecification.cs" />
     <Compile Include="MediaFiles\EpisodeImport\Specifications\FreeSpaceSpecification.cs" />
     <Compile Include="MediaFiles\EpisodeImport\Specifications\SameFileSpecification.cs" />
     <Compile Include="MediaFiles\EpisodeImport\Specifications\GrabbedReleaseQualitySpecification.cs" />

src/NzbDrone.Core/Organizer/FileNameBuilder.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.Globalization;
 using System.IO;
@@ -23,6 +23,7 @@ namespace NzbDrone.Core.Organizer
         BasicNamingConfig GetBasicNamingConfig(NamingConfig nameSpec);
         string GetSeriesFolder(Series series, NamingConfig namingConfig = null);
         string GetSeasonFolder(Series series, int seasonNumber, NamingConfig namingConfig = null);
+        bool RequiresEpisodeTitle(Series series, List<Episode> episodes);
     }
 
     public class FileNameBuilder : IBuildFileNames
@@ -31,6 +32,7 @@ namespace NzbDrone.Core.Organizer
         private readonly IQualityDefinitionService _qualityDefinitionService;
         private readonly ICached<EpisodeFormat[]> _episodeFormatCache;
         private readonly ICached<AbsoluteEpisodeFormat[]> _absoluteEpisodeFormatCache;
+        private readonly ICached<bool> _requiresEpisodeTitleCache;
         private readonly Logger _logger;
 
         private static readonly Regex TitleRegex = new Regex(@"\{(?<prefix>[- ._\[(]*)(?<token>(?:[a-z0-9]+)(?:(?<separator>[- ._]+)(?:[a-z0-9]+))?)(?::(?<customFormat>[a-z0-9]+))?(?<suffix>[- ._)\]]*)\}",
@@ -78,6 +80,7 @@ namespace NzbDrone.Core.Organizer
             _qualityDefinitionService = qualityDefinitionService;
             _episodeFormatCache = cacheManager.GetCache<EpisodeFormat[]>(GetType(), "episodeFormat");
             _absoluteEpisodeFormatCache = cacheManager.GetCache<AbsoluteEpisodeFormat[]>(GetType(), "absoluteEpisodeFormat");
+            _requiresEpisodeTitleCache = cacheManager.GetCache<bool>(GetType(), "requiresEpisodeTitle");
             _logger = logger;
         }
 
@@ -280,6 +283,40 @@ namespace NzbDrone.Core.Organizer
             return name.Trim(' ', '.');
         }
 
+        public bool RequiresEpisodeTitle(Series series, List<Episode> episodes)
+        {
+            var namingConfig = _namingConfigService.GetConfig();
+            var pattern = namingConfig.StandardEpisodeFormat;
+
+            if (series.SeriesType == SeriesTypes.Daily)
+            {
+                pattern = namingConfig.DailyEpisodeFormat;
+            }
+
+            if (series.SeriesType == SeriesTypes.Anime && episodes.All(e => e.AbsoluteEpisodeNumber.HasValue))
+            {
+                pattern = namingConfig.AnimeEpisodeFormat;
+            }
+
+            return _requiresEpisodeTitleCache.Get(pattern, () =>
+            {
+                var matches = TitleRegex.Matches(pattern);
+
+                foreach (Match match in matches)
+                {
+                    var token = match.Groups["token"].Value;
+
+                    if (FileNameBuilderTokenEqualityComparer.Instance.Equals(token, "{Episode Title}") ||
+                        FileNameBuilderTokenEqualityComparer.Instance.Equals(token, "{Episode CleanTitle}"))
+                    {
+                        return true;
+                    }
+                }
+
+                return false;
+            });
+        }
+
         private void AddSeriesTokens(Dictionary<string, Func<TokenMatch, string>> tokenHandlers, Series series)
         {
             tokenHandlers["{Series Title}"] = m => series.Title;

src/NzbDrone.Core/Tv/SeriesService.cs

@@ -1,11 +1,8 @@
-using System;
+using System.Collections.Generic;
-using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using NLog;
-using NzbDrone.Common.EnsureThat;
 using NzbDrone.Common.Extensions;
-using NzbDrone.Core.DataAugmentation.Scene;
 using NzbDrone.Core.Messaging.Events;
 using NzbDrone.Core.Organizer;
 using NzbDrone.Core.Parser;