DatHeader is not in charge of filenames

This commit is contained in:
Matt Nadareski
2025-01-29 13:25:36 -05:00
parent cf657138fc
commit eac31923a1
3 changed files with 217 additions and 285 deletions

View File

@@ -1,8 +1,10 @@
using System;
using System.Collections.Generic;
using System.IO;
#if NET40_OR_GREATER || NETCOREAPP
using System.Threading.Tasks;
#endif
using SabreTools.Core.Tools;
using SabreTools.DatFiles;
using SabreTools.DatItems;
using SabreTools.IO.Extensions;
@@ -153,7 +155,7 @@ namespace SabreTools.DatTools
_staticLogger.User($"A total of {datFile.DatStatistics.TotalCount - datFile.DatStatistics.RemovedCount} items will be written out to '{datFile.Header.GetStringFieldValue(DatHeader.FileNameKey)}'");
// Get the outfile names
Dictionary<DatFormat, string> outfiles = DatHeader.CreateOutFileNames(datFile.Header, outDir!, overwrite);
Dictionary<DatFormat, string> outfiles = CreateOutFileNames(datFile.Header, outDir!, overwrite);
try
{
@@ -221,6 +223,87 @@ namespace SabreTools.DatTools
consoleOutput!.WriteToFile(null, true, true);
}
/// <summary>
/// Generate a proper outfile name based on a DAT and output directory
/// </summary>
/// <param name="datHeader">DatHeader value to pull information from</param>
/// <param name="outDir">Output directory</param>
/// <param name="overwrite">True if we ignore existing files (default), false otherwise</param>
/// <returns>Dictionary of output formats mapped to file names</returns>
internal static Dictionary<DatFormat, string> CreateOutFileNames(DatHeader datHeader, string outDir, bool overwrite = true)
{
// Create the output dictionary
Dictionary<DatFormat, string> outfileNames = [];
// Get the filename to use
string? filename = string.IsNullOrEmpty(datHeader.GetStringFieldValue(DatHeader.FileNameKey))
? datHeader.GetStringFieldValue(Models.Metadata.Header.DescriptionKey)
: datHeader.GetStringFieldValue(DatHeader.FileNameKey);
// Strip off the extension if it's a holdover from the DAT
if (Utilities.HasValidDatExtension(filename))
filename = Path.GetFileNameWithoutExtension(filename);
// Double check the outDir for the end delim
if (!outDir.EndsWith(Path.DirectorySeparatorChar.ToString()))
outDir += Path.DirectorySeparatorChar;
// Get the current format types
DatFormat datFormat = datHeader.GetFieldValue<DatFormat>(DatHeader.DatFormatKey);
List<DatFormat> usedFormats = SplitFormats(datFormat);
// Get the extensions from the output type
List<string> usedExtensions = [];
foreach (var map in ExtensionMappings)
{
// Split the pair
DatFormat format = map.Key;
string[] extensions = map.Value;
// Ignore unused formats
if (!usedFormats.Contains(format))
continue;
// Get the correct extension, assuming a backup exists
string extension = extensions[0];
if (usedExtensions.Contains(extension))
extension = extensions[1];
// Create the filename and set the extension as used
outfileNames.Add(format, CreateOutFileNamesHelper(filename, outDir, extension, overwrite));
usedExtensions.Add(extension);
}
return outfileNames;
}
/// <summary>
/// Help generating the outfile name
/// </summary>
/// <param name="filename">Base filename to use</param>
/// <param name="outDir">Output directory</param>
/// <param name="extension">Extension to use for the file</param>
/// <param name="overwrite">True if we ignore existing files, false otherwise</param>
/// <returns>String containing the new filename</returns>
private static string CreateOutFileNamesHelper(string? filename, string outDir, string extension, bool overwrite)
{
string outfile = $"{outDir}{filename}{extension}";
outfile = outfile.Replace($"{Path.DirectorySeparatorChar}{Path.DirectorySeparatorChar}", Path.DirectorySeparatorChar.ToString());
if (!overwrite)
{
int i = 1;
while (File.Exists(outfile))
{
outfile = $"{outDir}{filename}_{i}{extension}";
outfile = outfile.Replace($"{Path.DirectorySeparatorChar}{Path.DirectorySeparatorChar}", Path.DirectorySeparatorChar.ToString());
i++;
}
}
return outfile;
}
/// <summary>
/// Ensure that FileName, Name, and Description are filled with some value
/// </summary>
@@ -300,5 +383,134 @@ namespace SabreTools.DatTools
return true;
}
/// <summary>
/// Split a format flag into multiple distinct values
/// </summary>
/// <param name="datFormat">Combined DatFormat value to split</param>
/// <returns>List representing the individual flag values set</returns>
/// TODO: Consider making DatFormat a non-flag enum so this doesn't need to happen
private static List<DatFormat> SplitFormats(DatFormat datFormat)
{
List<DatFormat> usedFormats = [];
#if NET20 || NET35
if ((datFormat & DatFormat.ArchiveDotOrg) != 0)
usedFormats.Add(DatFormat.ArchiveDotOrg);
if ((datFormat & DatFormat.AttractMode) != 0)
usedFormats.Add(DatFormat.AttractMode);
if ((datFormat & DatFormat.ClrMamePro) != 0)
usedFormats.Add(DatFormat.ClrMamePro);
if ((datFormat & DatFormat.CSV) != 0)
usedFormats.Add(DatFormat.CSV);
if ((datFormat & DatFormat.DOSCenter) != 0)
usedFormats.Add(DatFormat.DOSCenter);
if ((datFormat & DatFormat.EverdriveSMDB) != 0)
usedFormats.Add(DatFormat.EverdriveSMDB);
if ((datFormat & DatFormat.Listrom) != 0)
usedFormats.Add(DatFormat.Listrom);
if ((datFormat & DatFormat.Listxml) != 0)
usedFormats.Add(DatFormat.Listxml);
if ((datFormat & DatFormat.Logiqx) != 0)
usedFormats.Add(DatFormat.Logiqx);
if ((datFormat & DatFormat.LogiqxDeprecated) != 0)
usedFormats.Add(DatFormat.LogiqxDeprecated);
if ((datFormat & DatFormat.MissFile) != 0)
usedFormats.Add(DatFormat.MissFile);
if ((datFormat & DatFormat.OfflineList) != 0)
usedFormats.Add(DatFormat.OfflineList);
if ((datFormat & DatFormat.OpenMSX) != 0)
usedFormats.Add(DatFormat.OpenMSX);
if ((datFormat & DatFormat.RedumpMD2) != 0)
usedFormats.Add(DatFormat.RedumpMD2);
if ((datFormat & DatFormat.RedumpMD4) != 0)
usedFormats.Add(DatFormat.RedumpMD4);
if ((datFormat & DatFormat.RedumpMD5) != 0)
usedFormats.Add(DatFormat.RedumpMD5);
if ((datFormat & DatFormat.RedumpSFV) != 0)
usedFormats.Add(DatFormat.RedumpSFV);
if ((datFormat & DatFormat.RedumpSHA1) != 0)
usedFormats.Add(DatFormat.RedumpSHA1);
if ((datFormat & DatFormat.RedumpSHA256) != 0)
usedFormats.Add(DatFormat.RedumpSHA256);
if ((datFormat & DatFormat.RedumpSHA384) != 0)
usedFormats.Add(DatFormat.RedumpSHA384);
if ((datFormat & DatFormat.RedumpSHA512) != 0)
usedFormats.Add(DatFormat.RedumpSHA512);
if ((datFormat & DatFormat.RedumpSpamSum) != 0)
usedFormats.Add(DatFormat.RedumpSpamSum);
if ((datFormat & DatFormat.RomCenter) != 0)
usedFormats.Add(DatFormat.RomCenter);
if ((datFormat & DatFormat.SabreJSON) != 0)
usedFormats.Add(DatFormat.SabreJSON);
if ((datFormat & DatFormat.SabreXML) != 0)
usedFormats.Add(DatFormat.SabreXML);
if ((datFormat & DatFormat.SoftwareList) != 0)
usedFormats.Add(DatFormat.SoftwareList);
if ((datFormat & DatFormat.SSV) != 0)
usedFormats.Add(DatFormat.SSV);
if ((datFormat & DatFormat.TSV) != 0)
usedFormats.Add(DatFormat.TSV);
#else
if (datFormat.HasFlag(DatFormat.ArchiveDotOrg))
usedFormats.Add(DatFormat.ArchiveDotOrg);
if (datFormat.HasFlag(DatFormat.AttractMode))
usedFormats.Add(DatFormat.AttractMode);
if (datFormat.HasFlag(DatFormat.ClrMamePro))
usedFormats.Add(DatFormat.ClrMamePro);
if (datFormat.HasFlag(DatFormat.CSV))
usedFormats.Add(DatFormat.CSV);
if (datFormat.HasFlag(DatFormat.DOSCenter))
usedFormats.Add(DatFormat.DOSCenter);
if (datFormat.HasFlag(DatFormat.EverdriveSMDB))
usedFormats.Add(DatFormat.EverdriveSMDB);
if (datFormat.HasFlag(DatFormat.Listrom))
usedFormats.Add(DatFormat.Listrom);
if (datFormat.HasFlag(DatFormat.Listxml))
usedFormats.Add(DatFormat.Listxml);
if (datFormat.HasFlag(DatFormat.Logiqx))
usedFormats.Add(DatFormat.Logiqx);
if (datFormat.HasFlag(DatFormat.LogiqxDeprecated))
usedFormats.Add(DatFormat.LogiqxDeprecated);
if (datFormat.HasFlag(DatFormat.MissFile))
usedFormats.Add(DatFormat.MissFile);
if (datFormat.HasFlag(DatFormat.OfflineList))
usedFormats.Add(DatFormat.OfflineList);
if (datFormat.HasFlag(DatFormat.OpenMSX))
usedFormats.Add(DatFormat.OpenMSX);
if (datFormat.HasFlag(DatFormat.RedumpMD2))
usedFormats.Add(DatFormat.RedumpMD2);
if (datFormat.HasFlag(DatFormat.RedumpMD4))
usedFormats.Add(DatFormat.RedumpMD4);
if (datFormat.HasFlag(DatFormat.RedumpMD5))
usedFormats.Add(DatFormat.RedumpMD5);
if (datFormat.HasFlag(DatFormat.RedumpSFV))
usedFormats.Add(DatFormat.RedumpSFV);
if (datFormat.HasFlag(DatFormat.RedumpSHA1))
usedFormats.Add(DatFormat.RedumpSHA1);
if (datFormat.HasFlag(DatFormat.RedumpSHA256))
usedFormats.Add(DatFormat.RedumpSHA256);
if (datFormat.HasFlag(DatFormat.RedumpSHA384))
usedFormats.Add(DatFormat.RedumpSHA384);
if (datFormat.HasFlag(DatFormat.RedumpSHA512))
usedFormats.Add(DatFormat.RedumpSHA512);
if (datFormat.HasFlag(DatFormat.RedumpSpamSum))
usedFormats.Add(DatFormat.RedumpSpamSum);
if (datFormat.HasFlag(DatFormat.RomCenter))
usedFormats.Add(DatFormat.RomCenter);
if (datFormat.HasFlag(DatFormat.SabreJSON))
usedFormats.Add(DatFormat.SabreJSON);
if (datFormat.HasFlag(DatFormat.SabreXML))
usedFormats.Add(DatFormat.SabreXML);
if (datFormat.HasFlag(DatFormat.SoftwareList))
usedFormats.Add(DatFormat.SoftwareList);
if (datFormat.HasFlag(DatFormat.SSV))
usedFormats.Add(DatFormat.SSV);
if (datFormat.HasFlag(DatFormat.TSV))
usedFormats.Add(DatFormat.TSV);
#endif
return usedFormats;
}
}
}