Make Logger naming consistent

This commit is contained in:
Matt Nadareski
2025-01-08 16:59:44 -05:00
parent 9241011867
commit d67327231b
39 changed files with 186 additions and 186 deletions

View File

@@ -47,7 +47,7 @@ namespace SabreTools.DatFiles
/// Logging object
/// </summary>
[JsonIgnore, XmlIgnore]
protected Logger logger;
protected Logger _logger;
#endregion
@@ -59,7 +59,7 @@ namespace SabreTools.DatFiles
/// <param name="datFile">DatFile to get the values from</param>
public DatFile(DatFile? datFile)
{
logger = new Logger(this);
_logger = new Logger(this);
if (datFile != null)
{
Header = datFile.Header;
@@ -656,7 +656,7 @@ namespace SabreTools.DatFiles
if (rom.GetInt64FieldValue(Models.Metadata.Rom.SizeKey) == null
&& rom.GetStringFieldValue(Models.Metadata.Rom.CRCKey) == "null")
{
logger.Verbose($"Empty folder found: {machine.GetStringFieldValue(Models.Metadata.Machine.NameKey)}");
_logger.Verbose($"Empty folder found: {machine.GetStringFieldValue(Models.Metadata.Machine.NameKey)}");
rom.SetName(rom.GetName() == "null" ? "-" : rom.GetName());
rom.SetFieldValue<string?>(Models.Metadata.Rom.SizeKey, Constants.SizeZero.ToString());
@@ -700,7 +700,7 @@ namespace SabreTools.DatFiles
if (rom.GetInt64FieldValue(Models.Metadata.Rom.SizeKey) == null
&& rom.GetStringFieldValue(Models.Metadata.Rom.CRCKey) == "null")
{
logger.Verbose($"Empty folder found: {machineObj.GetStringFieldValue(Models.Metadata.Machine.NameKey)}");
_logger.Verbose($"Empty folder found: {machineObj.GetStringFieldValue(Models.Metadata.Machine.NameKey)}");
rom.SetName(rom.GetName() == "null" ? "-" : rom.GetName());
rom.SetFieldValue<string?>(Models.Metadata.Rom.SizeKey, Constants.SizeZero.ToString());
@@ -828,14 +828,14 @@ namespace SabreTools.DatFiles
if (datItem.GetDuplicateStatus(lastItem).HasFlag(DupeType.All))
#endif
{
logger.Verbose($"Exact duplicate found for '{datItemName}'");
_logger.Verbose($"Exact duplicate found for '{datItemName}'");
continue;
}
// If the current name matches the previous name, rename the current item
else if (datItemName == lastItemName)
{
logger.Verbose($"Name duplicate found for '{datItemName}'");
_logger.Verbose($"Name duplicate found for '{datItemName}'");
if (datItem is Disk || datItem is DatItems.Formats.File || datItem is Media || datItem is Rom)
{
@@ -923,14 +923,14 @@ namespace SabreTools.DatFiles
if (datItem.Value.GetDuplicateStatus(lastItem).HasFlag(DupeType.All))
#endif
{
logger.Verbose($"Exact duplicate found for '{datItemName}'");
_logger.Verbose($"Exact duplicate found for '{datItemName}'");
continue;
}
// If the current name matches the previous name, rename the current item
else if (datItemName == lastItemName)
{
logger.Verbose($"Name duplicate found for '{datItemName}'");
_logger.Verbose($"Name duplicate found for '{datItemName}'");
if (datItem.Value is Disk || datItem.Value is DatItems.Formats.File || datItem.Value is Media || datItem.Value is Rom)
{
@@ -984,7 +984,7 @@ namespace SabreTools.DatFiles
// If this is invoked with a null DatItem, we ignore
if (datItem == null)
{
logger?.Verbose($"Item was skipped because it was null");
_logger?.Verbose($"Item was skipped because it was null");
return true;
}
@@ -992,7 +992,7 @@ namespace SabreTools.DatFiles
if (datItem.GetBoolFieldValue(DatItem.RemoveKey) == true)
{
string itemString = JsonConvert.SerializeObject(datItem, Formatting.None);
logger?.Verbose($"Item '{itemString}' was skipped because it was marked for removal");
_logger?.Verbose($"Item '{itemString}' was skipped because it was marked for removal");
return true;
}
@@ -1000,7 +1000,7 @@ namespace SabreTools.DatFiles
if (datItem is Blank)
{
string itemString = JsonConvert.SerializeObject(datItem, Formatting.None);
logger?.Verbose($"Item '{itemString}' was skipped because it was of type 'Blank'");
_logger?.Verbose($"Item '{itemString}' was skipped because it was of type 'Blank'");
return true;
}
@@ -1012,7 +1012,7 @@ namespace SabreTools.DatFiles
if (size == 0 || size == null)
{
string itemString = JsonConvert.SerializeObject(datItem, Formatting.None);
logger?.Verbose($"Item '{itemString}' was skipped because it had an invalid size");
_logger?.Verbose($"Item '{itemString}' was skipped because it had an invalid size");
return true;
}
}
@@ -1023,7 +1023,7 @@ namespace SabreTools.DatFiles
if (!Array.Exists(GetSupportedTypes(), t => t == itemType))
{
string itemString = JsonConvert.SerializeObject(datItem, Formatting.None);
logger?.Verbose($"Item '{itemString}' was skipped because it was not supported in {datFormat}");
_logger?.Verbose($"Item '{itemString}' was skipped because it was not supported in {datFormat}");
return true;
}
@@ -1033,9 +1033,9 @@ namespace SabreTools.DatFiles
{
string itemString = JsonConvert.SerializeObject(datItem, Formatting.None);
#if NET20 || NET35
logger?.Verbose($"Item '{itemString}' was skipped because it was missing required fields for {datFormat}: {string.Join(", ", [.. missingFields])}");
_logger?.Verbose($"Item '{itemString}' was skipped because it was missing required fields for {datFormat}: {string.Join(", ", [.. missingFields])}");
#else
logger?.Verbose($"Item '{itemString}' was skipped because it was missing required fields for {datFormat}: {string.Join(", ", missingFields)}");
_logger?.Verbose($"Item '{itemString}' was skipped because it was missing required fields for {datFormat}: {string.Join(", ", missingFields)}");
#endif
return true;
}

View File

@@ -24,7 +24,7 @@ namespace SabreTools.DatFiles
/// <summary>
/// Logging object
/// </summary>
private static readonly Logger logger = new();
private static readonly Logger _staticLogger = new();
#endregion
@@ -1426,7 +1426,7 @@ namespace SabreTools.DatFiles
#endif
{
var input = inputs[i];
logger.User($"Adding DAT: {input.CurrentPath}");
_staticLogger.User($"Adding DAT: {input.CurrentPath}");
datFiles[i] = DatFile.Create(datFile.Header.CloneFiltering());
Parser.ParseInto(datFiles[i], input, i, keep: true);
#if NET40_OR_GREATER || NETCOREAPP

View File

@@ -45,7 +45,7 @@ namespace SabreTools.DatFiles.Formats
catch (Exception ex) when (!throwOnError)
{
string message = $"'{filename}' - An error occurred during parsing";
logger.Error(ex, message);
_logger.Error(ex, message);
}
}
@@ -174,24 +174,24 @@ namespace SabreTools.DatFiles.Formats
{
try
{
logger.User($"Writing to '{outfile}'...");
_logger.User($"Writing to '{outfile}'...");
// Serialize the input file
var metadata = ConvertMetadata(ignoreblanks);
var metadataFile = new Serialization.CrossModel.ClrMamePro().Deserialize(metadata);
if (!Serialization.Serializers.ClrMamePro.SerializeFile(metadataFile, outfile, _quotes))
{
logger.Warning($"File '{outfile}' could not be written! See the log for more details.");
_logger.Warning($"File '{outfile}' could not be written! See the log for more details.");
return false;
}
}
catch (Exception ex) when (!throwOnError)
{
logger.Error(ex);
_logger.Error(ex);
return false;
}
logger.User($"'{outfile}' written!{Environment.NewLine}");
_logger.User($"'{outfile}' written!{Environment.NewLine}");
return true;
}
}

View File

@@ -37,7 +37,7 @@ namespace SabreTools.DatFiles.Formats
catch (Exception ex) when (!throwOnError)
{
string message = $"'{filename}' - An error occurred during parsing";
logger.Error(ex, message);
_logger.Error(ex, message);
}
}
@@ -194,24 +194,24 @@ namespace SabreTools.DatFiles.Formats
{
try
{
logger.User($"Writing to '{outfile}'...");
_logger.User($"Writing to '{outfile}'...");
// Serialize the input file
var metadata = ConvertMetadata(ignoreblanks);
var hashfile = new Serialization.CrossModel.Hashfile().Deserialize(metadata, _hash);
if (!(Serialization.Serializers.Hashfile.SerializeFile(hashfile, outfile, _hash)))
{
logger.Warning($"File '{outfile}' could not be written! See the log for more details.");
_logger.Warning($"File '{outfile}' could not be written! See the log for more details.");
return false;
}
}
catch (Exception ex) when (!throwOnError)
{
logger.Error(ex);
_logger.Error(ex);
return false;
}
logger.User($"'{outfile}' written!{Environment.NewLine}");
_logger.User($"'{outfile}' written!{Environment.NewLine}");
return true;
}
}

View File

@@ -209,7 +209,7 @@ namespace SabreTools.DatFiles.Formats
catch (Exception ex) when (!throwOnError)
{
string message = $"'{filename}' - An error occurred during parsing";
logger.Error(ex, message);
_logger.Error(ex, message);
}
}

View File

@@ -348,7 +348,7 @@ namespace SabreTools.DatFiles.Formats
{
try
{
logger.User($"Writing to '{outfile}'...");
_logger.User($"Writing to '{outfile}'...");
// Serialize the input file
var metadata = ConvertMetadata(ignoreblanks);
@@ -364,17 +364,17 @@ namespace SabreTools.DatFiles.Formats
if (!success)
{
logger.Warning($"File '{outfile}' could not be written! See the log for more details.");
_logger.Warning($"File '{outfile}' could not be written! See the log for more details.");
return false;
}
}
catch (Exception ex) when (!throwOnError)
{
logger.Error(ex);
_logger.Error(ex);
return false;
}
logger.User($"'{outfile}' written!{Environment.NewLine}");
_logger.User($"'{outfile}' written!{Environment.NewLine}");
return true;
}
}

View File

@@ -39,13 +39,13 @@ namespace SabreTools.DatFiles.Formats
{
try
{
logger.User($"Writing to '{outfile}'...");
_logger.User($"Writing to '{outfile}'...");
FileStream fs = File.Create(outfile);
// If we get back null for some reason, just log and return
if (fs == null)
{
logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable");
_logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable");
return false;
}
@@ -82,13 +82,13 @@ namespace SabreTools.DatFiles.Formats
}
}
logger.User($"'{outfile}' written!{Environment.NewLine}");
_logger.User($"'{outfile}' written!{Environment.NewLine}");
sw.Dispose();
fs.Dispose();
}
catch (Exception ex) when (!throwOnError)
{
logger.Error(ex);
_logger.Error(ex);
return false;
}
@@ -100,13 +100,13 @@ namespace SabreTools.DatFiles.Formats
{
try
{
logger.User($"Writing to '{outfile}'...");
_logger.User($"Writing to '{outfile}'...");
FileStream fs = File.Create(outfile);
// If we get back null for some reason, just log and return
if (fs == null)
{
logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable");
_logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable");
return false;
}
@@ -146,13 +146,13 @@ namespace SabreTools.DatFiles.Formats
}
}
logger.User($"'{outfile}' written!{Environment.NewLine}");
_logger.User($"'{outfile}' written!{Environment.NewLine}");
sw.Dispose();
fs.Dispose();
}
catch (Exception ex) when (!throwOnError)
{
logger.Error(ex);
_logger.Error(ex);
return false;
}

View File

@@ -74,7 +74,7 @@ namespace SabreTools.DatFiles.Formats
}
catch (Exception ex) when (!throwOnError)
{
logger.Warning($"Exception found while parsing '{filename}': {ex}");
_logger.Warning($"Exception found while parsing '{filename}': {ex}");
}
jtr.Close();
@@ -365,13 +365,13 @@ namespace SabreTools.DatFiles.Formats
{
try
{
logger.User($"Writing to '{outfile}'...");
_logger.User($"Writing to '{outfile}'...");
FileStream fs = System.IO.File.Create(outfile);
// If we get back null for some reason, just log and return
if (fs == null)
{
logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable");
_logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable");
return false;
}
@@ -428,13 +428,13 @@ namespace SabreTools.DatFiles.Formats
// Write the file footer out
WriteFooter(jtw);
logger.User($"'{outfile}' written!{Environment.NewLine}");
_logger.User($"'{outfile}' written!{Environment.NewLine}");
jtw.Close();
fs.Dispose();
}
catch (Exception ex) when (!throwOnError)
{
logger.Error(ex);
_logger.Error(ex);
return false;
}
@@ -446,13 +446,13 @@ namespace SabreTools.DatFiles.Formats
{
try
{
logger.User($"Writing to '{outfile}'...");
_logger.User($"Writing to '{outfile}'...");
FileStream fs = System.IO.File.Create(outfile);
// If we get back null for some reason, just log and return
if (fs == null)
{
logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable");
_logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable");
return false;
}
@@ -509,13 +509,13 @@ namespace SabreTools.DatFiles.Formats
// Write the file footer out
WriteFooter(jtw);
logger.User($"'{outfile}' written!{Environment.NewLine}");
_logger.User($"'{outfile}' written!{Environment.NewLine}");
jtw.Close();
fs.Dispose();
}
catch (Exception ex) when (!throwOnError)
{
logger.Error(ex);
_logger.Error(ex);
return false;
}

View File

@@ -80,7 +80,7 @@ namespace SabreTools.DatFiles.Formats
}
catch (Exception ex) when (!throwOnError)
{
logger.Warning(ex, $"Exception found while parsing '{filename}'");
_logger.Warning(ex, $"Exception found while parsing '{filename}'");
// For XML errors, just skip the affected node
xtr?.Read();
@@ -194,13 +194,13 @@ namespace SabreTools.DatFiles.Formats
{
try
{
logger.User($"Writing to '{outfile}'...");
_logger.User($"Writing to '{outfile}'...");
FileStream fs = File.Create(outfile);
// If we get back null for some reason, just log and return
if (fs == null)
{
logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable");
_logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable");
return false;
}
@@ -256,7 +256,7 @@ namespace SabreTools.DatFiles.Formats
// Write the file footer out
WriteFooter(xtw);
logger.User($"'{outfile}' written!{Environment.NewLine}");
_logger.User($"'{outfile}' written!{Environment.NewLine}");
#if NET452_OR_GREATER
xtw.Dispose();
#endif
@@ -264,7 +264,7 @@ namespace SabreTools.DatFiles.Formats
}
catch (Exception ex) when (!throwOnError)
{
logger.Error(ex);
_logger.Error(ex);
return false;
}
@@ -276,13 +276,13 @@ namespace SabreTools.DatFiles.Formats
{
try
{
logger.User($"Writing to '{outfile}'...");
_logger.User($"Writing to '{outfile}'...");
FileStream fs = File.Create(outfile);
// If we get back null for some reason, just log and return
if (fs == null)
{
logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable");
_logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable");
return false;
}
@@ -338,7 +338,7 @@ namespace SabreTools.DatFiles.Formats
// Write the file footer out
WriteFooter(xtw);
logger.User($"'{outfile}' written!{Environment.NewLine}");
_logger.User($"'{outfile}' written!{Environment.NewLine}");
#if NET452_OR_GREATER
xtw.Dispose();
#endif
@@ -346,7 +346,7 @@ namespace SabreTools.DatFiles.Formats
}
catch (Exception ex) when (!throwOnError)
{
logger.Error(ex);
_logger.Error(ex);
return false;
}

View File

@@ -36,7 +36,7 @@ namespace SabreTools.DatFiles.Formats
catch (Exception ex) when (!throwOnError)
{
string message = $"'{filename}' - An error occurred during parsing";
logger.Error(ex, message);
_logger.Error(ex, message);
}
}
@@ -94,24 +94,24 @@ namespace SabreTools.DatFiles.Formats
{
try
{
logger.User($"Writing to '{outfile}'...");
_logger.User($"Writing to '{outfile}'...");
// Serialize the input file
var metadata = ConvertMetadata(ignoreblanks);
var metadataFile = new Serialization.CrossModel.SeparatedValue().Deserialize(metadata);
if (!(Serialization.Serializers.SeparatedValue.SerializeFile(metadataFile, outfile, _delim)))
{
logger.Warning($"File '{outfile}' could not be written! See the log for more details.");
_logger.Warning($"File '{outfile}' could not be written! See the log for more details.");
return false;
}
}
catch (Exception ex) when (!throwOnError)
{
logger.Error(ex);
_logger.Error(ex);
return false;
}
logger.User($"'{outfile}' written!{Environment.NewLine}");
_logger.User($"'{outfile}' written!{Environment.NewLine}");
return true;
}
}

View File

@@ -52,7 +52,7 @@ namespace SabreTools.DatFiles
/// <summary>
/// Logging object
/// </summary>
private readonly Logger logger;
private readonly Logger _logger;
#endregion
@@ -108,7 +108,7 @@ namespace SabreTools.DatFiles
{
bucketedBy = ItemKey.NULL;
mergedBy = DedupeType.None;
logger = new Logger(this);
_logger = new Logger(this);
}
#endregion
@@ -196,7 +196,7 @@ namespace SabreTools.DatFiles
&& string.IsNullOrEmpty(disk.GetStringFieldValue(Models.Metadata.Disk.MD5Key))
&& string.IsNullOrEmpty(disk.GetStringFieldValue(Models.Metadata.Disk.SHA1Key)))
{
logger.Verbose($"Incomplete entry for '{disk.GetName()}' will be output as nodump");
_logger.Verbose($"Incomplete entry for '{disk.GetName()}' will be output as nodump");
disk.SetFieldValue<string?>(Models.Metadata.Disk.StatusKey, ItemStatus.Nodump.AsStringValue());
}
@@ -210,7 +210,7 @@ namespace SabreTools.DatFiles
&& string.IsNullOrEmpty(media.GetStringFieldValue(Models.Metadata.Media.SHA256Key))
&& string.IsNullOrEmpty(media.GetStringFieldValue(Models.Metadata.Media.SpamSumKey)))
{
logger.Verbose($"Incomplete entry for '{media.GetName()}' will be output as nodump");
_logger.Verbose($"Incomplete entry for '{media.GetName()}' will be output as nodump");
}
item = media;
@@ -539,20 +539,20 @@ namespace SabreTools.DatFiles
// If the sorted type isn't the same, we want to sort the dictionary accordingly
if (bucketedBy != bucketBy && bucketBy != ItemKey.NULL)
{
logger.User($"Organizing roms by {bucketBy}");
_logger.User($"Organizing roms by {bucketBy}");
PerformBucketing(bucketBy, lower, norename);
}
// If the merge type isn't the same, we want to merge the dictionary accordingly
if (mergedBy != dedupeType)
{
logger.User($"Deduping roms by {dedupeType}");
_logger.User($"Deduping roms by {dedupeType}");
PerformDeduplication(bucketBy, dedupeType);
}
// If the merge type is the same, we want to sort the dictionary to be consistent
else
{
logger.User($"Sorting roms by {bucketBy}");
_logger.User($"Sorting roms by {bucketBy}");
PerformSorting();
}
}
@@ -879,7 +879,7 @@ namespace SabreTools.DatFiles
}
catch (Exception ex) when (!throwOnError)
{
logger.Warning(ex.ToString());
_logger.Warning(ex.ToString());
}
}

View File

@@ -131,7 +131,7 @@ namespace SabreTools.DatFiles
/// <summary>
/// Logging object
/// </summary>
private readonly Logger logger;
private readonly Logger _logger;
#endregion
@@ -165,7 +165,7 @@ namespace SabreTools.DatFiles
/// </summary>
public ItemDictionaryDB()
{
logger = new Logger(this);
_logger = new Logger(this);
}
#region Accessors
@@ -1237,7 +1237,7 @@ namespace SabreTools.DatFiles
}
catch (Exception ex) when (!throwOnError)
{
logger.Warning(ex.ToString());
_logger.Warning(ex.ToString());
}
}

View File

@@ -19,7 +19,7 @@ namespace SabreTools.DatFiles
/// <summary>
/// Logging object
/// </summary>
private static readonly Logger logger = new();
private static readonly Logger _staticLogger = new();
#endregion
@@ -117,7 +117,7 @@ namespace SabreTools.DatFiles
}
catch (Exception ex) when (!throwOnError)
{
logger.Error(ex, $"Error with file '{currentPath}'");
_staticLogger.Error(ex, $"Error with file '{currentPath}'");
}
watch.Stop();

View File

@@ -34,7 +34,7 @@ namespace SabreTools.DatFiles
catch (Exception ex) when (!throwOnError)
{
string message = $"'{filename}' - An error occurred during parsing";
logger.Error(ex, message);
_logger.Error(ex, message);
}
}
@@ -43,24 +43,24 @@ namespace SabreTools.DatFiles
{
try
{
logger.User($"Writing to '{outfile}'...");
_logger.User($"Writing to '{outfile}'...");
// Serialize the input file in two steps
var internalFormat = ConvertMetadata(ignoreblanks);
var specificFormat = Activator.CreateInstance<TModelSerializer>().Deserialize(internalFormat);
if (!Activator.CreateInstance<TFileSerializer>().Serialize(specificFormat, outfile))
{
logger.Warning($"File '{outfile}' could not be written! See the log for more details.");
_logger.Warning($"File '{outfile}' could not be written! See the log for more details.");
return false;
}
}
catch (Exception ex) when (!throwOnError)
{
logger.Error(ex);
_logger.Error(ex);
return false;
}
logger.User($"'{outfile}' written!{Environment.NewLine}");
_logger.User($"'{outfile}' written!{Environment.NewLine}");
return true;
}
@@ -69,24 +69,24 @@ namespace SabreTools.DatFiles
{
try
{
logger.User($"Writing to '{outfile}'...");
_logger.User($"Writing to '{outfile}'...");
// Serialize the input file in two steps
var internalFormat = ConvertMetadataDB(ignoreblanks);
var specificFormat = Activator.CreateInstance<TModelSerializer>().Deserialize(internalFormat);
if (!Activator.CreateInstance<TFileSerializer>().Serialize(specificFormat, outfile))
{
logger.Warning($"File '{outfile}' could not be written! See the log for more details.");
_logger.Warning($"File '{outfile}' could not be written! See the log for more details.");
return false;
}
}
catch (Exception ex) when (!throwOnError)
{
logger.Error(ex);
_logger.Error(ex);
return false;
}
logger.User($"'{outfile}' written!{Environment.NewLine}");
_logger.User($"'{outfile}' written!{Environment.NewLine}");
return true;
}
}