using System; using System.Collections.Generic; using SabreTools.DatItems; using SabreTools.DatItems.Formats; using SabreTools.Hashing; namespace SabreTools.DatFiles.Formats { /// /// Represents a hashfile such as an SFV, MD5, or SHA-1 file /// public abstract class Hashfile : SerializableDatFile { #region Fields // Private instance variables specific to Hashfile DATs protected HashType _hash; #endregion /// /// Constructor designed for casting a base DatFile /// /// Parent DatFile to copy from public Hashfile(DatFile? datFile) : base(datFile) { } /// public override void ParseFile(string filename, int indexId, bool keep, bool statsOnly = false, bool throwOnError = false) { try { // Deserialize the input file var hashfile = Serialization.Deserializers.Hashfile.DeserializeFile(filename, _hash); var metadata = new Serialization.CrossModel.Hashfile().Serialize(hashfile); // Convert to the internal format ConvertFromMetadata(metadata, filename, indexId, keep, statsOnly); } catch (Exception ex) when (!throwOnError) { string message = $"'{filename}' - An error occurred during parsing"; _logger.Error(ex, message); } } /// public override bool WriteToFile(string outfile, bool ignoreblanks = false, bool throwOnError = false) { try { _logger.User($"Writing to '{outfile}'..."); // Serialize the input file var metadata = ConvertToMetadata(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."); return false; } } catch (Exception ex) when (!throwOnError) { _logger.Error(ex); return false; } _logger.User($"'{outfile}' written!{Environment.NewLine}"); return true; } } /// /// Represents an SFV (CRC-32) hashfile /// public sealed class SfvFile : Hashfile { /// public override ItemType[] SupportedTypes => [ ItemType.Rom, ]; /// /// Constructor designed for casting a base DatFile /// /// Parent DatFile to copy from public SfvFile(DatFile? datFile) : base(datFile) { _hash = HashType.CRC32; } /// protected internal override List? GetMissingRequiredFields(DatItem datItem) { List missingFields = []; // Check item name if (string.IsNullOrEmpty(datItem.GetName())) missingFields.Add(Models.Metadata.Rom.NameKey); switch (datItem) { case Rom rom: if (string.IsNullOrEmpty(rom.GetStringFieldValue(Models.Metadata.Rom.CRCKey))) missingFields.Add(Models.Metadata.Rom.CRCKey); break; } return missingFields; } } /// /// Represents an MD2 hashfile /// public sealed class Md2File : Hashfile { /// public override ItemType[] SupportedTypes => [ ItemType.Rom, ]; /// /// Constructor designed for casting a base DatFile /// /// Parent DatFile to copy from public Md2File(DatFile? datFile) : base(datFile) { _hash = HashType.MD2; } /// protected internal override List? GetMissingRequiredFields(DatItem datItem) { List missingFields = []; // Check item name if (string.IsNullOrEmpty(datItem.GetName())) missingFields.Add(Models.Metadata.Rom.NameKey); switch (datItem) { case Rom rom: if (string.IsNullOrEmpty(rom.GetStringFieldValue(Models.Metadata.Rom.MD2Key))) missingFields.Add(Models.Metadata.Rom.MD2Key); break; } return missingFields; } } /// /// Represents an MD4 hashfile /// public sealed class Md4File : Hashfile { /// public override ItemType[] SupportedTypes => [ ItemType.Rom, ]; /// /// Constructor designed for casting a base DatFile /// /// Parent DatFile to copy from public Md4File(DatFile? datFile) : base(datFile) { _hash = HashType.MD4; } /// protected internal override List? GetMissingRequiredFields(DatItem datItem) { List missingFields = []; // Check item name if (string.IsNullOrEmpty(datItem.GetName())) missingFields.Add(Models.Metadata.Rom.NameKey); switch (datItem) { case Rom rom: if (string.IsNullOrEmpty(rom.GetStringFieldValue(Models.Metadata.Rom.MD4Key))) missingFields.Add(Models.Metadata.Rom.MD4Key); break; } return missingFields; } } /// /// Represents an MD5 hashfile /// public sealed class Md5File : Hashfile { /// public override ItemType[] SupportedTypes => [ ItemType.Disk, ItemType.Media, ItemType.Rom, ]; /// /// Constructor designed for casting a base DatFile /// /// Parent DatFile to copy from public Md5File(DatFile? datFile) : base(datFile) { _hash = HashType.MD5; } /// protected internal override List? GetMissingRequiredFields(DatItem datItem) { List missingFields = []; // Check item name if (string.IsNullOrEmpty(datItem.GetName())) missingFields.Add(Models.Metadata.Rom.NameKey); switch (datItem) { case Disk disk: if (string.IsNullOrEmpty(disk.GetStringFieldValue(Models.Metadata.Disk.MD5Key))) missingFields.Add(Models.Metadata.Disk.MD5Key); break; case Media medium: if (string.IsNullOrEmpty(medium.GetStringFieldValue(Models.Metadata.Media.MD5Key))) missingFields.Add(Models.Metadata.Media.MD5Key); break; case Rom rom: if (string.IsNullOrEmpty(rom.GetStringFieldValue(Models.Metadata.Rom.MD5Key))) missingFields.Add(Models.Metadata.Rom.MD5Key); break; } return missingFields; } } /// /// Represents an SHA-1 hashfile /// public sealed class Sha1File : Hashfile { /// public override ItemType[] SupportedTypes => [ ItemType.Disk, ItemType.Media, ItemType.Rom, ]; /// /// Constructor designed for casting a base DatFile /// /// Parent DatFile to copy from public Sha1File(DatFile? datFile) : base(datFile) { _hash = HashType.SHA1; } /// protected internal override List? GetMissingRequiredFields(DatItem datItem) { List missingFields = []; // Check item name if (string.IsNullOrEmpty(datItem.GetName())) missingFields.Add(Models.Metadata.Rom.NameKey); switch (datItem) { case Disk disk: if (string.IsNullOrEmpty(disk.GetStringFieldValue(Models.Metadata.Disk.SHA1Key))) missingFields.Add(Models.Metadata.Disk.SHA1Key); break; case Media medium: if (string.IsNullOrEmpty(medium.GetStringFieldValue(Models.Metadata.Media.SHA1Key))) missingFields.Add(Models.Metadata.Media.SHA1Key); break; case Rom rom: if (string.IsNullOrEmpty(rom.GetStringFieldValue(Models.Metadata.Rom.SHA1Key))) missingFields.Add(Models.Metadata.Rom.SHA1Key); break; } return missingFields; } } /// /// Represents an SHA-256 hashfile /// public sealed class Sha256File : Hashfile { /// public override ItemType[] SupportedTypes => [ ItemType.Media, ItemType.Rom, ]; /// /// Constructor designed for casting a base DatFile /// /// Parent DatFile to copy from public Sha256File(DatFile? datFile) : base(datFile) { _hash = HashType.SHA256; } /// protected internal override List? GetMissingRequiredFields(DatItem datItem) { List missingFields = []; // Check item name if (string.IsNullOrEmpty(datItem.GetName())) missingFields.Add(Models.Metadata.Rom.NameKey); switch (datItem) { case Media medium: if (string.IsNullOrEmpty(medium.GetStringFieldValue(Models.Metadata.Media.SHA256Key))) missingFields.Add(Models.Metadata.Media.SHA256Key); break; case Rom rom: if (string.IsNullOrEmpty(rom.GetStringFieldValue(Models.Metadata.Rom.SHA256Key))) missingFields.Add(Models.Metadata.Rom.SHA256Key); break; } return missingFields; } } /// /// Represents an SHA-384 hashfile /// public sealed class Sha384File : Hashfile { /// public override ItemType[] SupportedTypes => [ ItemType.Rom, ]; /// /// Constructor designed for casting a base DatFile /// /// Parent DatFile to copy from public Sha384File(DatFile? datFile) : base(datFile) { _hash = HashType.SHA384; } /// protected internal override List? GetMissingRequiredFields(DatItem datItem) { List missingFields = []; // Check item name if (string.IsNullOrEmpty(datItem.GetName())) missingFields.Add(Models.Metadata.Rom.NameKey); switch (datItem) { case Rom rom: if (string.IsNullOrEmpty(rom.GetStringFieldValue(Models.Metadata.Rom.SHA384Key))) missingFields.Add(Models.Metadata.Rom.SHA384Key); break; } return missingFields; } } /// /// Represents an SHA-512 hashfile /// public sealed class Sha512File : Hashfile { /// public override ItemType[] SupportedTypes => [ ItemType.Rom, ]; /// /// Constructor designed for casting a base DatFile /// /// Parent DatFile to copy from public Sha512File(DatFile? datFile) : base(datFile) { _hash = HashType.SHA512; } /// protected internal override List? GetMissingRequiredFields(DatItem datItem) { List missingFields = []; // Check item name if (string.IsNullOrEmpty(datItem.GetName())) missingFields.Add(Models.Metadata.Rom.NameKey); switch (datItem) { case Rom rom: if (string.IsNullOrEmpty(rom.GetStringFieldValue(Models.Metadata.Rom.SHA512Key))) missingFields.Add(Models.Metadata.Rom.SHA512Key); break; } return missingFields; } } /// /// Represents an SpamSum hashfile /// public sealed class SpamSumFile : Hashfile { /// public override ItemType[] SupportedTypes => [ ItemType.Media, ItemType.Rom, ]; /// /// Constructor designed for casting a base DatFile /// /// Parent DatFile to copy from public SpamSumFile(DatFile? datFile) : base(datFile) { _hash = HashType.SpamSum; } /// protected internal override List? GetMissingRequiredFields(DatItem datItem) { List missingFields = []; // Check item name if (string.IsNullOrEmpty(datItem.GetName())) missingFields.Add(Models.Metadata.Rom.NameKey); switch (datItem) { case Media medium: if (string.IsNullOrEmpty(medium.GetStringFieldValue(Models.Metadata.Media.SpamSumKey))) missingFields.Add(Models.Metadata.Media.SpamSumKey); break; case Rom rom: if (string.IsNullOrEmpty(rom.GetStringFieldValue(Models.Metadata.Rom.SpamSumKey))) missingFields.Add(Models.Metadata.Rom.SpamSumKey); break; } return missingFields; } } }