Add file name replace option - resolve #18

Author: jamerst

.vscode/launch.json

@@ -11,7 +11,7 @@
             "preLaunchTask": "build",
             // If you have changed target frameworks, make sure to update the program path.
             "program": "${workspaceFolder}/autotag.cli/bin/Debug/net7.0/autotag.dll",
-            "args": ["/home/james/Desktop/test", "/home/james/Desktop/Inside No, 9 S02E02.mkv", "-v"],
+            "args": ["--replace a b --print-config"],
             "cwd": "${workspaceFolder}/autotag.cli",
             // For more information about the 'console' field, see https://aka.ms/VSCode-CS-LaunchJson-Console
             "console": "internalConsole",

AutoTag.CLI/AutoTag.CLI.csproj

@@ -3,7 +3,7 @@
     <AssemblyName>autotag</AssemblyName>
     <OutputType>Exe</OutputType>
     <TargetFramework>net7.0</TargetFramework>
-    <Version>3.5.2</Version>
+    <Version>3.5.3</Version>
     <Nullable>enable</Nullable>
     <ImplicitUsings>enable</ImplicitUsings>
   </PropertyGroup>

AutoTag.CLI/Options/OptionsBase.cs

@@ -6,7 +6,7 @@ namespace AutoTag.CLI.Options;
 public abstract class OptionsBase<TOptions>
 {
     private static Dictionary<string, Option> _propertyOptions = new Dictionary<string, Option>();
-    protected static Option<TValue> GetOption<TValue>(Expression<Func<TOptions, TValue>> property)
+    protected static Option<TValue> GetOption<TValue>(Expression<Func<TOptions, TValue>> property, Action<Option<TValue>>? configure = null)
     {
         var info = GetPropertyInfo(property);
         var attr = info.GetCustomAttribute(typeof(CommandLineOptionAttribute<TValue>)) as CommandLineOptionAttribute<TValue>;
@@ -15,6 +15,8 @@ protected static Option<TValue> GetOption<TValue>(Expression<Func<TOptions, TVal
             var option = attr.GetOption();
             _propertyOptions[info.Name] = option;
 
+            configure?.Invoke(option);
+
             return option;
         }
         else

AutoTag.CLI/Options/RenameOptions.cs

@@ -16,13 +16,25 @@ public class RenameOptions : OptionsBase<RenameOptions>, IOptionsBase<RenameOpti
     [CommandLineOption<bool?>("--rename-subs", "Rename subtitle files")]
     public bool? RenameSubs { get; set; }
 
+    [CommandLineOption<IEnumerable<string>>("--replace", "Replace <replace> with <replacement> in file names")]
+    public IEnumerable<string>? FileNameReplaces { get; set; }
+
     public static IEnumerable<Option> GetOptions()
     {
         yield return GetOption(o => o.NoRename);
         yield return GetOption(o => o.TVPattern);
         yield return GetOption(o => o.MoviePattern);
         yield return GetOption(o => o.WindowsSafe);
         yield return GetOption(o => o.RenameSubs);
+        yield return GetOption(
+            o => o.FileNameReplaces,
+            o =>
+            {
+                o.AllowMultipleArgumentsPerToken = true;
+                o.Arity = new ArgumentArity(2, 2);
+                o.ArgumentHelpName = "replace replacement";
+            }
+        );
     }
 
     public static RenameOptions GetBoundValues(BindingContext context) =>
@@ -32,7 +44,8 @@ public static RenameOptions GetBoundValues(BindingContext context) =>
             TVPattern = GetValueForProperty(o => o.TVPattern, context),
             MoviePattern = GetValueForProperty(o => o.MoviePattern, context),
             WindowsSafe = GetValueForProperty(o => o.WindowsSafe, context),
-            RenameSubs = GetValueForProperty(o => o.RenameSubs, context)
+            RenameSubs = GetValueForProperty(o => o.RenameSubs, context),
+            FileNameReplaces = GetValueForProperty(o => o.FileNameReplaces, context),
         };
 
     public void UpdateConfig(AutoTagConfig config)
@@ -61,5 +74,10 @@ public void UpdateConfig(AutoTagConfig config)
         {
             config.RenameSubtitles = RenameSubs.Value;
         }
+
+        if (FileNameReplaces != null && FileNameReplaces.Any())
+        {
+            config.FileNameReplaces = FileNameReplace.FromStrings(FileNameReplaces);
+        }
     }
 }

AutoTag.Core/AutoTagConfig.cs

@@ -2,7 +2,7 @@ namespace AutoTag.Core;
 public class AutoTagConfig
 {
     public enum Modes { TV, Movie };
-    public const int CurrentVer = 8;
+    public const int CurrentVer = 9;
     public int ConfigVer { get; set; } = CurrentVer;
     public Modes Mode { get; set; } = Modes.TV;
     public bool ManualMode { get; set; } = false;
@@ -18,6 +18,7 @@ public enum Modes { TV, Movie };
     public bool AppleTagging { get; set; } = false;
     public bool RenameSubtitles { get; set; } = false;
     public string Language { get; set; } = "en";
+    public IEnumerable<FileNameReplace> FileNameReplaces { get; set; } = Enumerable.Empty<FileNameReplace>();
 
     public bool IsTVMode() => Mode == Modes.TV;
 }

AutoTag.Core/FileNameReplace.cs

@@ -0,0 +1,36 @@
+namespace AutoTag.Core;
+
+public class FileNameReplace
+{
+    public required string Replace { get; set; }
+    public required string Replacement { get; set; }
+
+    public string Apply(string str) => str.Replace(Replace, Replacement);
+
+    public static IEnumerable<FileNameReplace> FromStrings(IEnumerable<string> strings)
+    {
+        if (strings.Count() % 2 != 0)
+        {
+            throw new ArgumentException("Collection must have an even number of elements", nameof(strings));
+        }
+
+        string? previous = null;
+        foreach (string str in strings)
+        {
+            if (previous == null)
+            {
+                previous = str;
+            }
+            else
+            {
+                yield return new FileNameReplace
+                {
+                    Replace = previous,
+                    Replacement = str
+                };
+
+                previous = null;
+            }
+        }
+    }
+}

AutoTag.Core/FileWriter.cs

@@ -115,10 +115,11 @@ private static bool RenameFile(string path, string newName, Action<string> setPa
         bool fileSuccess = true;
         string newPath = Path.Combine(
             Path.GetDirectoryName(path)!,
-            EscapeFilename(
+            GetFileName(
                 newName,
                 Path.GetFileNameWithoutExtension(path),
-                setStatus
+                setStatus,
+                config
             )
             + Path.GetExtension(path)
         );
@@ -156,15 +157,21 @@ private static bool RenameFile(string path, string newName, Action<string> setPa
         return fileSuccess;
     }
 
-    private static string EscapeFilename(string filename, string oldFilename, Action<string, MessageType> setStatus)
+    private static string GetFileName(string fileName, string oldFileName, Action<string, MessageType> setStatus, AutoTagConfig config)
     {
-        string result = String.Join("", filename.Split(invalidFilenameChars));
-        if (result != oldFilename && result.Length != filename.Length)
+        string result = fileName;
+        foreach (var replace in config.FileNameReplaces)
+        {
+            result = replace.Apply(result);
+        }
+
+        string escapedResult = String.Concat(result.Split(invalidFilenameChars));
+        if (escapedResult != oldFileName && escapedResult.Length != fileName.Length)
         {
             setStatus("Warning: Invalid characters in file name, automatically removing", MessageType.Warning);
         }
 
-        return result;
+        return escapedResult;
     }
 
     private static char[]? invalidFilenameChars { get; set; }

README.md

@@ -40,6 +40,7 @@ Options:
   --movie-pattern <movie-pattern>  Rename pattern for movies
   --windows-safe                   Remove invalid Windows file name characters when renaming
   --rename-subs                    Rename subtitle files
+  --replace <replace replacement>  Replace <replace> with <replacement> in file names
   -c, --config <config>            Config file path
   -p, --pattern <pattern>          Custom regex to parse TV episode information
   -v, --verbose                    Enable verbose output mode
@@ -71,7 +72,10 @@ The regex pattern should have 3 named capturing groups: `SeriesName`, `Season` a
 Note that on Windows all directory separators (`\`) must be escaped as `\\`.
 
 ### Windows Safe
-The `--windows-safe` option is for use on Linux where the files written may be accessed by a Windows host, or are being written to an NTFS filesystem.
+The `--windows-safe` option is for use on Linux/macOS where the files written may be accessed by a Windows host, or are being written to an NTFS filesystem. It automatically removes any invalid NTFS file name characters.
+
+### File Name Replacements
+The `--replace` option allows specific characters or strings in a file name to be replaced, e.g. `--replace a b` will replace all the `a` characters in the file name with `b`. This option can be used multiple times for multiple replacements, e.g. `--replace a b --replace foo bar --replace c ''`. **Note: the arguments for this option are case sensitive.**
 
 ### Extended Tagging
 The `--extended-tagging` option adds additional information to Matroska video files such as actors and their characters. This option is not enabled by default because it may reduce tagging speed significantly due to the additional API requests needed.
@@ -82,7 +86,7 @@ The language of the metadata can be set using the `-l` or `--language` option. T
 ## 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:
 ```
-"configVer": 8,                           // Internal use
+"configVer": 9,                           // Internal use
 "mode": 0,                                // Default tagging mode, 0 = TV, 1 = Movie
 "manualMode": false,                      // Manual tagging mode
 "verbose": false,                         // Verbose output
@@ -96,7 +100,8 @@ AutoTag creates a config file to store default preferences at `~/.config/autotag
 "extendedTagging": false,                 // Add more information to Matroska file tags
 "appleTagging": false,                    // Add extra tags to mp4 files for use with Apple devices and software
 "renameSubtitles": false,                 // Rename subtitle files
-"language": "en"                          // Metadata language
+"language": "en"                          // Metadata language,
+"fileNameReplaces": []                    // File name character replacements. Array of objects of the form { "replace": "", replacement: "" }
 ```
 
 ## Moving away from TheTVDB