claunia/SabreTools
1
0
Fork 0
mirror of https://github.com/claunia/SabreTools.git synced 2025-12-16 19:14:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Migrate to GetMissingRequiredFields

Browse Source
This commit is contained in:
Matt Nadareski
2022-11-03 16:46:53 -07:00
parent c23cfc0b36
commit 6c235e98b6
2 changed files with 127 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
SabreTools.DatFiles/DatFile.cs
View File

@@ -1,4 +1,5 @@
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Xml.Serialization;
@@ -507,15 +508,13 @@ namespace SabreTools.DatFiles
}
/// <summary>
/// Determine if an item has all required fields to write out
/// Return list of required fields missing from a DatItem
/// </summary>
/// <param name="datItem">DatItem to check</param>
/// <returns>True if the item has all required fields, false otherwise</returns>
/// <returns>List of missing required fields, null or empty if none were found</returns>
/// <remarks>
/// TODO: Implement this in all relevant DatFile types
/// TODO: Return list of missing fields?
/// </remarks>
protected virtual bool HasRequiredFields(DatItem datItem) => true;
protected virtual List<DatItemField> GetMissingRequiredFields(DatItem datItem) => null;
/// <summary>
/// Get if a machine contains any writable items
@@ -592,10 +591,11 @@ namespace SabreTools.DatFiles
}
// If we have an item with missing required fields
if (!HasRequiredFields(datItem))
List<DatItemField> missingFields = GetMissingRequiredFields(datItem);
if (missingFields == null || missingFields.Count == 0)
{
string itemString = JsonConvert.SerializeObject(datItem, Formatting.None);
logger?.Verbose($"Item '{itemString}' was skipped because it was missing required fields for {Header?.DatFormat}");
logger?.Verbose($"Item '{itemString}' was skipped because it was missing required fields for {Header?.DatFormat}: {string.Join(", ", missingFields)}");
return true;
}

138
SabreTools.DatFiles/Formats/Hashfile.cs
View File

@@ -1,4 +1,5 @@
using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using SabreTools.Core;
@@ -107,27 +108,128 @@ namespace SabreTools.DatFiles.Formats
}
/// <inheritdoc/>
protected override bool HasRequiredFields(DatItem datItem)
protected override List<DatItemField> GetMissingRequiredFields(DatItem datItem)
{
// TODO: Add code to ensure name as well
List<DatItemField> missingFields = new List<DatItemField>();
return (_hash, datItem.ItemType) switch
// Check item name
if (string.IsNullOrWhiteSpace(datItem.GetName()))
missingFields.Add(DatItemField.Name);
// Check hash linked to specific Hashfile type
switch (_hash)
{
(Hash.CRC, ItemType.Rom) => !string.IsNullOrEmpty((datItem as Rom)?.CRC),
(Hash.MD5, ItemType.Disk) => !string.IsNullOrEmpty((datItem as Disk)?.MD5),
(Hash.MD5, ItemType.Media) => !string.IsNullOrEmpty((datItem as Media)?.MD5),
(Hash.MD5, ItemType.Rom) => !string.IsNullOrEmpty((datItem as Rom)?.MD5),
(Hash.SHA1, ItemType.Disk) => !string.IsNullOrEmpty((datItem as Disk)?.SHA1),
(Hash.SHA1, ItemType.Media) => !string.IsNullOrEmpty((datItem as Media)?.SHA1),
(Hash.SHA1, ItemType.Rom) => !string.IsNullOrEmpty((datItem as Rom)?.SHA1),
(Hash.SHA256, ItemType.Media) => !string.IsNullOrEmpty((datItem as Media)?.SHA256),
(Hash.SHA256, ItemType.Rom) => !string.IsNullOrEmpty((datItem as Rom)?.SHA256),
(Hash.SHA384, ItemType.Rom) => !string.IsNullOrEmpty((datItem as Rom)?.SHA384),
(Hash.SHA512, ItemType.Rom) => !string.IsNullOrEmpty((datItem as Rom)?.SHA512),
(Hash.SpamSum, ItemType.Media) => !string.IsNullOrEmpty((datItem as Media)?.SpamSum),
(Hash.SpamSum, ItemType.Rom) => !string.IsNullOrEmpty((datItem as Rom)?.SpamSum),
_ => false,
};
case Hash.CRC:
switch (datItem.ItemType)
{
case ItemType.Rom:
if (!string.IsNullOrEmpty((datItem as Rom)?.CRC))
missingFields.Add(DatItemField.CRC);
break;
default:
missingFields.Add(DatItemField.CRC);
break;
}
break;
case Hash.MD5:
switch (datItem.ItemType)
{
case ItemType.Disk:
if (!string.IsNullOrEmpty((datItem as Disk)?.MD5))
missingFields.Add(DatItemField.MD5);
break;
case ItemType.Media:
if (!string.IsNullOrEmpty((datItem as Media)?.MD5))
missingFields.Add(DatItemField.MD5);
break;
case ItemType.Rom:
if (!string.IsNullOrEmpty((datItem as Rom)?.MD5))
missingFields.Add(DatItemField.MD5);
break;
default:
missingFields.Add(DatItemField.MD5);
break;
}
break;
case Hash.SHA1:
switch (datItem.ItemType)
{
case ItemType.Disk:
if (!string.IsNullOrEmpty((datItem as Disk)?.SHA1))
missingFields.Add(DatItemField.SHA1);
break;
case ItemType.Media:
if (!string.IsNullOrEmpty((datItem as Media)?.SHA1))
missingFields.Add(DatItemField.SHA1);
break;
case ItemType.Rom:
if (!string.IsNullOrEmpty((datItem as Rom)?.SHA1))
missingFields.Add(DatItemField.SHA1);
break;
default:
missingFields.Add(DatItemField.SHA1);
break;
}
break;
case Hash.SHA256:
switch (datItem.ItemType)
{
case ItemType.Media:
if (!string.IsNullOrEmpty((datItem as Media)?.SHA256))
missingFields.Add(DatItemField.SHA256);
break;
case ItemType.Rom:
if (!string.IsNullOrEmpty((datItem as Rom)?.SHA256))
missingFields.Add(DatItemField.SHA256);
break;
default:
missingFields.Add(DatItemField.SHA256);
break;
}
break;
case Hash.SHA384:
switch (datItem.ItemType)
{
case ItemType.Rom:
if (!string.IsNullOrEmpty((datItem as Rom)?.SHA384))
missingFields.Add(DatItemField.SHA384);
break;
default:
missingFields.Add(DatItemField.SHA384);
break;
}
break;
case Hash.SHA512:
switch (datItem.ItemType)
{
case ItemType.Rom:
if (!string.IsNullOrEmpty((datItem as Rom)?.SHA512))
missingFields.Add(DatItemField.SHA512);
break;
default:
missingFields.Add(DatItemField.SHA512);
break;
}
break;
case Hash.SpamSum:
switch (datItem.ItemType)
{
case ItemType.Media:
if (!string.IsNullOrEmpty((datItem as Media)?.SpamSum))
missingFields.Add(DatItemField.SpamSum);
break;
case ItemType.Rom:
if (!string.IsNullOrEmpty((datItem as Rom)?.SpamSum))
missingFields.Add(DatItemField.SpamSum);
break;
default:
missingFields.Add(DatItemField.SpamSum);
break;
}
break;
}
return missingFields;
}
/// <inheritdoc/>