Add DumpingParameters for DIC and Redumper

CHANGELIST.md

@@ -71,6 +71,7 @@
 - Add packer filtering tests
 - Simplify prefix filtering
 - Fix issue with odd quoting
+- Add DumpingParameters for DIC and Redumper
 
 ### 3.2.4 (2024-11-24)
 

MPF.Processors.Test/DiscImageCreatorTests.cs

@@ -257,6 +257,35 @@ public void GetCommandFilePathAndVersion_Valid_Filled()
 
         #endregion
 
+        #region GetParameters
+
+        [Fact]
+        public void GetParameters_Empty_Null()
+        {
+            string basePath = string.Empty;
+            string? parameters = DiscImageCreator.GetParameters(basePath);
+            Assert.Null(parameters);
+        }
+
+        [Fact]
+        public void GetParameters_Invalid_Null()
+        {
+            string basePath = "INVALID";
+            string? parameters = DiscImageCreator.GetParameters(basePath);
+            Assert.Null(parameters);
+        }
+
+        [Fact]
+        public void GetParameters_Valid_Filled()
+        {
+            string? expectedParameters = "TEST DATA";
+            string basePath = Path.Combine(Environment.CurrentDirectory, "TestData", "DiscImageCreator", "CDROM", "test");
+            string? parameters = DiscImageCreator.GetParameters($"{basePath}_19800101T000000.txt");
+            Assert.Equal(expectedParameters, parameters);
+        }
+
+        #endregion
+
         #region GetPlayStationEXEDate
 
         // TODO: This... is horrible

MPF.Processors.Test/RedumperTests.cs

@@ -998,6 +998,35 @@ public void GetUniversalHash_Valid_Filled()
 
         #endregion
 
+        #region GetParameters
+
+        [Fact]
+        public void GetParameters_Empty_Null()
+        {
+            string log = string.Empty;
+            string? actual = Redumper.GetParameters(log);
+            Assert.Null(actual);
+        }
+
+        [Fact]
+        public void GetParameters_Invalid_Null()
+        {
+            string log = "INVALID";
+            string? actual = Redumper.GetParameters(log);
+            Assert.Null(actual);
+        }
+
+        [Fact]
+        public void GetParameters_Valid_Filled()
+        {
+            string? expected = "cd --verbose";
+            string log = Path.Combine(Environment.CurrentDirectory, "TestData", "Redumper", "CDROM", "test.log");
+            string? actual = Redumper.GetParameters(log);
+            Assert.Equal(expected, actual);
+        }
+
+        #endregion
+
         #region GetVersion
 
         [Fact]

MPF.Processors.Test/TestData/Redumper/CDROM/test.log

@@ -2,6 +2,9 @@ DUMPING DATE (DateTime.Now)
 redumper v1980.01.01 build_00 [Jan 01 1980, 00:00:00]
 << GetVersion (above) >>
 
+<< GetParameters >>
+arguments: cd --verbose
+
 << GetCuesheet >>
 CUE [
     cuesheet

MPF.Processors/DiscImageCreator.cs

@@ -80,6 +80,7 @@ public override void GenerateSubmissionInfo(SubmissionInfo info, string basePath
             var dicVersion = GetCommandFilePathAndVersion(basePath, out var dicCmd);
             info.DumpingInfo!.DumpingProgram ??= string.Empty;
             info.DumpingInfo.DumpingProgram += $" {dicVersion ?? "Unknown Version"}";
+            info.DumpingInfo.DumpingParameters = GetParameters(dicCmd) ?? "Unknown Parameters";
             info.DumpingInfo.DumpingDate = ProcessingTool.GetFileModifiedDate(dicCmd)?.ToString("yyyy-MM-dd HH:mm:ss");
 
             // Fill in the hardware data
@@ -820,6 +821,33 @@ internal override List<OutputFile> GetOutputFiles(string? baseDirectory, string
 
         #region Information Extraction Methods
 
+        /// <summary>
+        /// Get the dumping parameters from the log, if possible
+        /// </summary>
+        /// <param name="dicCmd">Log file location</param>
+        /// <returns>Dumping parameters if possible, null otherwise</returns>
+        public static string? GetParameters(string? dicCmd)
+        {
+            // If the file doesn't exist, we can't get the info
+            if (string.IsNullOrEmpty(dicCmd))
+                return null;
+            if (!File.Exists(dicCmd))
+                return null;
+
+            try
+            {
+                // Dumping parameters are on the first line
+                using var sr = File.OpenText(dicCmd);
+                var line = sr.ReadLine();
+                return line?.Trim();
+            }
+            catch
+            {
+                // We don't care what the exception is right now
+                return null;
+            }
+        }
+
         /// <summary>
         /// Get the PSX/PS2/KP2 EXE Date from the log, if possible
         /// </summary>

MPF.Processors/Redumper.cs

@@ -28,6 +28,7 @@ public override void GenerateSubmissionInfo(SubmissionInfo info, string basePath
             // Get the dumping program and version
             info.DumpingInfo!.DumpingProgram ??= string.Empty;
             info.DumpingInfo.DumpingProgram += $" {GetVersion($"{basePath}.log") ?? "Unknown Version"}";
+            info.DumpingInfo.DumpingParameters = GetParameters($"{basePath}.log") ?? "Unknown Parameters";
             info.DumpingInfo.DumpingDate = ProcessingTool.GetFileModifiedDate($"{basePath}.log")?.ToString("yyyy-MM-dd HH:mm:ss");
 
             // Fill in the hardware data
@@ -1818,6 +1819,44 @@ internal static bool GetSaturnBuildInfo(string? segaHeader, out string? buildDat
             }
         }
 
+        /// <summary>
+        /// Get the dumping parameters, if possible
+        /// </summary>
+        /// <param name="log">Log file location</param>
+        /// <returns>Dumping parameters if possible, null on error</returns>
+        internal static string? GetParameters(string log)
+        {
+            // If the file doesn't exist, we can't get info from it
+            if (string.IsNullOrEmpty(log))
+                return null;
+            if (!File.Exists(log))
+                return null;
+
+            // Samples:
+            // arguments: cd --verbose --drive=F:\ --speed=24 --retries=200
+            // arguments: bd --image-path=ISO\PS3_VOLUME --image-name=PS3_VOLUME
+
+            try
+            {
+                // If we find the arguments line, return the arguments
+                using var sr = File.OpenText(log);
+                while (!sr.EndOfStream)
+                {
+                    string? line = sr.ReadLine()?.TrimStart();
+                    if (line?.StartsWith("arguments: ") == true)
+                        return line.Substring("arguments: ".Length).Trim();
+                }
+
+                // We couldn't detect any arguments
+                return null;
+            }
+            catch
+            {
+                // We don't care what the exception is right now
+                return null;
+            }
+        }
+
         /// <summary>
         /// Get all Volume Identifiers
         /// </summary>