Allow custom TV parsing regex - address #4

Author: jamerst

.vscode/launch.json

@@ -10,7 +10,7 @@
             "request": "launch",
             "preLaunchTask": "build",
             // If you have changed target frameworks, make sure to update the program path.
-            "program": "${workspaceFolder}/autotag.cli/bin/Debug/netcoreapp3.1/autotag.dll",
+            "program": "${workspaceFolder}/autotag.cli/bin/Debug/net5.0/autotag.dll",
             "args": [],
             "cwd": "${workspaceFolder}/autotag.cli",
             // For more information about the 'console' field, see https://aka.ms/VSCode-CS-LaunchJson-Console

README.md

@@ -28,14 +28,19 @@ Options:
   --no-rename                     Disable file renaming
   --no-tag                        Disable file tagging
   --no-cover                      Disable cover art tagging
-  --manual                        Manually choose the series to tag
+  --manual                        Manually choose the series to tag from search results
+  -p|--pattern <PATTERN>          Custom regex to parse TV episode information
   -v|--verbose                    Enable verbose output mode
   --set-default                   Set the current arguments as the default
   --version                       Print version number and exit
   -?|-h|--help                    Show help information
 
 ```
 
+The custom regex pattern is used on the full file path, not just the file name. This allows AutoTag to tag file structures where the series name is not in the file name, e.g. for the structure `Series/Season 1/S01E01 Title.mkv`.
+
+The regex pattern should have 3 named capturing groups: `SeriesName`, `Season` and `Episode`. For the example given above, a pattern could be `.*/(?<SeriesName>.+)/Season (?<Season>\d+)/S\d+E(?<Episode>\d+)`.
+
 ## Config
 AutoTag creates a config file to store default preferences at `~/.config/autotag/conf.json` or `%APPDATA%\Roaming\autotag\conf.json`. A different config file can be specified using the `-c` option. If the file does not exist, a file will be created with the default settings:
 ```
@@ -48,6 +53,7 @@ AutoTag creates a config file to store default preferences at `~/.config/autotag
 "renameFiles": true,                    // Rename files
 "tvRenamePattern": "%1 - %2x%3 - %4",   // Pattern to rename TV files, %1 = Series Name, %2 = Season, %3 = Episode, %4 = Episode Title
 "movieRenamePattern": "%1 (%2)"         // Pattern to rename movie files, %1 = Title, %2 = Year
+"parsePattern": ""                      // Custom regex to parse TV episode information
 ```
 
 ## Known Issues

autotag.Core/AutoTagConfig.cs

@@ -1,7 +1,8 @@
 namespace autotag.Core {
     public class AutoTagConfig {
         public enum Modes { TV, Movie };
-        public int configVer { get; set; } = 1;
+        public static int currentVer = 2;
+        public int configVer { get; set; } = currentVer;
         public Modes mode { get; set; } = Modes.TV;
         public bool manualMode { get; set; } = false;
         public bool verbose { get; set; } = false;
@@ -10,5 +11,6 @@ public enum Modes { TV, Movie };
         public bool renameFiles { get; set; } = true;
         public string tvRenamePattern { get; set; } = "%1 - %2x%3 - %4";
         public string movieRenamePattern { get; set; } = "%1 (%2)";
+        public string parsePattern { get; set; } = "";
     }
 }

autotag.Core/AutoTagSettings.cs

@@ -22,6 +22,12 @@ public AutoTagSettings(string configPath) {
                 } catch (Exception e) {
                     Console.Error.WriteLine($"Error reading config file '{configPath}': {e.Message}");
                 }
+
+                if (config.configVer != AutoTagConfig.currentVer) {
+                    // if config file outdated, update it with new options
+                    config.configVer = AutoTagConfig.currentVer;
+                    Save();
+                }
             } else {
                 Console.WriteLine($"Generating new config file with default options '{configPath}'");
                 FileInfo configFile = new FileInfo(configPath);

autotag.Core/TVProcessor.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using System.Text.RegularExpressions;
 using System.Threading.Tasks;
 
 using TvDbSharper;
@@ -28,19 +29,37 @@ public async Task<bool> process(
                 AutoTagConfig config) {
 
             if (tvdb.Authentication.Token == null) {
-                await tvdb.Authentication.AuthenticateAsync("TQLC3N5YDI1AQVJF");
+                await tvdb.Authentication.AuthenticateAsync(apiKey);
             }
 
             FileMetadata result = new FileMetadata(FileMetadata.Types.TV);
 
             #region Filename parsing
             FileMetadata episodeData;
 
-            try {
-                episodeData = EpisodeParser.ParseEpisodeInfo(Path.GetFileName(filePath)); // Parse info from filename
-            } catch (FormatException ex) {
-                setStatus($"Error: {ex.Message}", true);
-                return false;
+            if (string.IsNullOrEmpty(config.parsePattern)) {
+                try {
+                    episodeData = EpisodeParser.ParseEpisodeInfo(Path.GetFileName(filePath)); // Parse info from filename
+                } catch (FormatException ex) {
+                    setStatus($"Error: {ex.Message}", true);
+                    return false;
+                }
+            } else {
+                try {
+                    var match = Regex.Match(filePath, config.parsePattern, RegexOptions.IgnoreCase | RegexOptions.CultureInvariant);
+
+                    episodeData = new FileMetadata(FileMetadata.Types.TV);
+                    episodeData.SeriesName = match.Groups["SeriesName"].Value;
+                    episodeData.Season = int.Parse(match.Groups["Season"].Value);
+                    episodeData.Episode = int.Parse(match.Groups["Episode"].Value);
+                } catch (FormatException ex) {
+                    if (config.verbose) {
+                        setStatus($"Error: {ex.Message}", true);
+                    } else {
+                        setStatus($"Error: Unable to parse required information from filename", true);
+                    }
+                    return false;
+                }
             }
 
             result.Season = episodeData.Season;

autotag.Core/autotag.Core.csproj

@@ -5,7 +5,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="System.Text.Json" Version="5.0.0" />
+    <PackageReference Include="System.Text.Json" Version="5.0.1" />
     <PackageReference Include="TagLibSharp" Version="2.2.0" />
     <PackageReference Include="TMDbLib" Version="1.6.0" />
     <PackageReference Include="TvDbSharper" Version="3.2.2" />

autotag.cli/Program.cs

@@ -46,6 +46,9 @@ private async Task OnExecuteAsync() {
             if (manualMode) {
                 settings.config.manualMode = true;
             }
+            if (!string.IsNullOrEmpty(pattern)) {
+                settings.config.parsePattern = pattern;
+            }
             if (verbose) {
                 settings.config.verbose = true;
             }
@@ -201,9 +204,12 @@ private void AddFiles(string[] paths) {
         [Option("--no-cover", "Disable cover art tagging", CommandOptionType.NoValue)]
         private bool noCoverArt { get; set; }
 
-        [Option("--manual", "Manually choose the series to tag", CommandOptionType.NoValue)]
+        [Option("--manual", "Manually choose the series to tag from search results", CommandOptionType.NoValue)]
         private bool manualMode { get; set; }
 
+        [Option(Description = "Custom regex to parse TV episode information")]
+        private string pattern { get; set; } = "";
+
         [Option(Description = "Enable verbose output mode")]
         private bool verbose { get; set; }
 

autotag.cli/autotag.cli.csproj

@@ -4,8 +4,11 @@
     <AssemblyName>autotag</AssemblyName>
     <OutputType>Exe</OutputType>
     <TargetFramework>net5.0</TargetFramework>
-    <AssemblyVersion>3.0.1.0</AssemblyVersion>
-    <Version>3.0.1</Version>
+    <AssemblyVersion>3.0.2.0</AssemblyVersion>
+    <Version>3.0.2</Version>
+  </PropertyGroup>
+
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <PublishSingleFile>true</PublishSingleFile>
     <IncludeNativeLibrariesForSelfExtract>true</IncludeNativeLibrariesForSelfExtract>
     <SelfContained>true</SelfContained>
@@ -14,7 +17,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="McMaster.Extensions.CommandLineUtils" Version="3.0.0" />
+    <PackageReference Include="McMaster.Extensions.CommandLineUtils" Version="3.1.0" />
   </ItemGroup>
 
   <ItemGroup>