using System.Collections.Generic; using System.IO; using System.Linq; using System.Xml.Serialization; using SabreTools.Library.FileTypes; using SabreTools.Library.Filtering; using SabreTools.Library.Tools; using Newtonsoft.Json; using Newtonsoft.Json.Converters; namespace SabreTools.Library.DatItems { /// /// Represents Compressed Hunks of Data (CHD) formatted disks which use internal hashes /// [JsonObject("disk")] [XmlRoot("disk")] public class Disk : DatItem { #region Private instance variables private byte[] _md5; // 16 bytes private byte[] _sha1; // 20 bytes #endregion #region Fields #region Common /// /// Name of the item /// [JsonProperty("name")] [XmlElement("name")] public string Name { get; set; } /// /// Data MD5 hash /// [JsonProperty("md5", DefaultValueHandling = DefaultValueHandling.Ignore)] [XmlElement("md5")] public string MD5 { get { return _md5.IsNullOrEmpty() ? null : Utilities.ByteArrayToString(_md5); } set { _md5 = Utilities.StringToByteArray(Sanitizer.CleanMD5(value)); } } /// /// Data SHA-1 hash /// [JsonProperty("sha1", DefaultValueHandling = DefaultValueHandling.Ignore)] [XmlElement("sha1")] public string SHA1 { get { return _sha1.IsNullOrEmpty() ? null : Utilities.ByteArrayToString(_sha1); } set { _sha1 = Utilities.StringToByteArray(Sanitizer.CleanSHA1(value)); } } /// /// Disk name to merge from parent /// [JsonProperty("merge", DefaultValueHandling = DefaultValueHandling.Ignore)] [XmlElement("merge")] public string MergeTag { get; set; } /// /// Disk region /// [JsonProperty("region", DefaultValueHandling = DefaultValueHandling.Ignore)] [XmlElement("region")] public string Region { get; set; } /// /// Disk index /// [JsonProperty("index", DefaultValueHandling = DefaultValueHandling.Ignore)] [XmlElement("index")] public string Index { get; set; } /// /// Disk writable flag /// [JsonProperty("writable", DefaultValueHandling = DefaultValueHandling.Ignore)] [XmlElement("writable")] public bool? Writable { get; set; } [JsonIgnore] public bool WritableSpecified { get { return Writable != null; } } /// /// Disk dump status /// [JsonProperty("status", DefaultValueHandling = DefaultValueHandling.Ignore)] [JsonConverter(typeof(StringEnumConverter))] [XmlElement("status")] public ItemStatus ItemStatus { get; set; } [JsonIgnore] public bool ItemStatusSpecified { get { return ItemStatus != ItemStatus.NULL; } } /// /// Determine if the disk is optional in the set /// [JsonProperty("optional", DefaultValueHandling = DefaultValueHandling.Ignore)] [XmlElement("optional")] public bool? Optional { get; set; } [JsonIgnore] public bool OptionalSpecified { get { return Optional != null; } } #endregion #region SoftwareList /// /// Disk area information /// [JsonProperty("diskarea", DefaultValueHandling = DefaultValueHandling.Ignore)] [XmlElement("diskarea")] public DiskArea DiskArea { get; set; } [JsonIgnore] public bool DiskAreaSpecified { get { return DiskArea != null && DiskArea != default && DiskArea.Name != null && DiskArea.Name != default; } } /// /// Original hardware part associated with the item /// [JsonProperty("part", DefaultValueHandling = DefaultValueHandling.Ignore)] [XmlElement("part")] public Part Part { get; set; } [JsonIgnore] public bool PartSpecified { get { return Part != null && Part != default && ((Part.Name != null && Part.Name != default) || (Part.Interface != null && Part.Interface != default)); } } #endregion #endregion // Fields #region Accessors /// /// Gets the name to use for a DatItem /// /// Name if available, null otherwise public override string GetName() { return Name; } /// /// Set fields with given values /// /// Mappings dictionary public override void SetFields(Dictionary mappings) { // Set base fields base.SetFields(mappings); // Handle Disk-specific fields if (mappings.Keys.Contains(Field.DatItem_Name)) Name = mappings[Field.DatItem_Name]; if (mappings.Keys.Contains(Field.DatItem_MD5)) MD5 = mappings[Field.DatItem_MD5]; if (mappings.Keys.Contains(Field.DatItem_SHA1)) SHA1 = mappings[Field.DatItem_SHA1]; if (mappings.Keys.Contains(Field.DatItem_Merge)) MergeTag = mappings[Field.DatItem_Merge]; if (mappings.Keys.Contains(Field.DatItem_Region)) Region = mappings[Field.DatItem_Region]; if (mappings.Keys.Contains(Field.DatItem_Index)) Index = mappings[Field.DatItem_Index]; if (mappings.Keys.Contains(Field.DatItem_Writable)) Writable = mappings[Field.DatItem_Writable].AsYesNo(); if (mappings.Keys.Contains(Field.DatItem_Status)) ItemStatus = mappings[Field.DatItem_Status].AsItemStatus(); if (mappings.Keys.Contains(Field.DatItem_Optional)) Optional = mappings[Field.DatItem_Optional].AsYesNo(); // Handle DiskArea-specific fields if (DiskArea == null) DiskArea = new DiskArea(); DiskArea.SetFields(mappings); // Handle Part-specific fields if (Part == null) Part = new Part(); Part.SetFields(mappings); } #endregion #region Constructors /// /// Create a default, empty Disk object /// public Disk() { Name = string.Empty; ItemType = ItemType.Disk; DupeType = 0x00; ItemStatus = ItemStatus.None; } /// /// Create a Disk object from a BaseFile /// /// public Disk(BaseFile baseFile) { Name = baseFile.Filename; _md5 = baseFile.MD5; _sha1 = baseFile.SHA1; ItemType = ItemType.Disk; DupeType = 0x00; ItemStatus = ItemStatus.None; } #endregion #region Cloning Methods public override object Clone() { return new Disk() { Name = this.Name, ItemType = this.ItemType, DupeType = this.DupeType, Machine = this.Machine.Clone() as Machine, Source = this.Source.Clone() as Source, Remove = this.Remove, _md5 = this._md5, _sha1 = this._sha1, MergeTag = this.MergeTag, Region = this.Region, Index = this.Index, Writable = this.Writable, ItemStatus = this.ItemStatus, Optional = this.Optional, DiskArea = this.DiskArea, Part = this.Part, }; } /// /// Convert a disk to the closest Rom approximation /// /// public Rom ConvertToRom() { var rom = new Rom() { Name = this.Name + ".chd", ItemType = ItemType.Rom, DupeType = this.DupeType, Machine = this.Machine.Clone() as Machine, Source = this.Source.Clone() as Source, Remove = this.Remove, MergeTag = this.MergeTag, Region = this.Region, ItemStatus = this.ItemStatus, Optional = this.Optional, MD5 = this.MD5, SHA1 = this.SHA1, DataArea = new DataArea { Name = this.DiskArea.Name }, Part = this.Part, }; return rom; } #endregion #region Comparision Methods public override bool Equals(DatItem other) { bool dupefound = false; // If we don't have a rom, return false if (ItemType != other.ItemType) return dupefound; // Otherwise, treat it as a Disk Disk newOther = other as Disk; // If all hashes are empty but they're both nodump and the names match, then they're dupes if ((ItemStatus == ItemStatus.Nodump && newOther.ItemStatus == ItemStatus.Nodump) && Name == newOther.Name && !HasHashes() && !newOther.HasHashes()) { dupefound = true; } // Otherwise if we get a partial match else if (HashMatch(newOther)) { dupefound = true; } return dupefound; } /// /// Fill any missing size and hash information from another Disk /// /// Disk to fill information from public void FillMissingInformation(Disk other) { if (_md5.IsNullOrEmpty() && !other._md5.IsNullOrEmpty()) _md5 = other._md5; if (_sha1.IsNullOrEmpty() && !other._sha1.IsNullOrEmpty()) _sha1 = other._sha1; } /// /// Get unique duplicate suffix on name collision /// /// String representing the suffix public string GetDuplicateSuffix() { if (!_md5.IsNullOrEmpty()) return $"_{MD5}"; else if (!_sha1.IsNullOrEmpty()) return $"_{SHA1}"; else return "_1"; } /// /// Returns if there are no, non-empty hashes in common with another Disk /// /// Disk to compare against /// True if at least one hash is not mutually exclusive, false otherwise private bool HasCommonHash(Disk other) { return !(_md5.IsNullOrEmpty() ^ other._md5.IsNullOrEmpty()) || !(_sha1.IsNullOrEmpty() ^ other._sha1.IsNullOrEmpty()); } /// /// Returns if the Disk contains any hashes /// /// True if any hash exists, false otherwise private bool HasHashes() { return !_md5.IsNullOrEmpty() || !_sha1.IsNullOrEmpty(); } /// /// Returns if any hashes are common with another Disk /// /// Disk to compare against /// True if any hashes are in common, false otherwise private bool HashMatch(Disk other) { // If either have no hashes, we return false, otherwise this would be a false positive if (!HasHashes() || !other.HasHashes()) return false; // If neither have hashes in common, we return false, otherwise this would be a false positive if (!HasCommonHash(other)) return false; // Return if all hashes match according to merge rules return ConditionalHashEquals(_md5, other._md5) && ConditionalHashEquals(_sha1, other._sha1); } #endregion #region Filtering /// /// Clean a DatItem according to the cleaner /// /// Cleaner to implement public override void Clean(Cleaner cleaner) { // Clean common items first base.Clean(cleaner); // If we're stripping unicode characters, strip item name if (cleaner?.RemoveUnicode == true) Name = Sanitizer.RemoveUnicodeCharacters(Name); // If we are in NTFS trim mode, trim the game name if (cleaner?.Trim == true) { // Windows max name length is 260 int usableLength = 260 - Machine.Name.Length - (cleaner.Root?.Length ?? 0); if (Name.Length > usableLength) { string ext = Path.GetExtension(Name); Name = Name.Substring(0, usableLength - ext.Length); Name += ext; } } } /// /// Check to see if a DatItem passes the filter /// /// Filter to check against /// True if the item passed the filter, false otherwise public override bool PassesFilter(Filter filter) { // Check common fields first if (!base.PassesFilter(filter)) return false; #region Common // Filter on item name if (filter.DatItem_Name.MatchesPositiveSet(Name) == false) return false; if (filter.DatItem_Name.MatchesNegativeSet(Name) == true) return false; // Filter on MD5 if (filter.DatItem_MD5.MatchesPositiveSet(MD5) == false) return false; if (filter.DatItem_MD5.MatchesNegativeSet(MD5) == true) return false; // Filter on SHA-1 if (filter.DatItem_SHA1.MatchesPositiveSet(SHA1) == false) return false; if (filter.DatItem_SHA1.MatchesNegativeSet(SHA1) == true) return false; // Filter on merge tag if (filter.DatItem_Merge.MatchesPositiveSet(MergeTag) == false) return false; if (filter.DatItem_Merge.MatchesNegativeSet(MergeTag) == true) return false; // Filter on region if (filter.DatItem_Region.MatchesPositiveSet(Region) == false) return false; if (filter.DatItem_Region.MatchesNegativeSet(Region) == true) return false; // Filter on index if (filter.DatItem_Index.MatchesPositiveSet(Index) == false) return false; if (filter.DatItem_Index.MatchesNegativeSet(Index) == true) return false; // Filter on writable if (filter.DatItem_Writable.MatchesNeutral(null, Writable) == false) return false; // Filter on status if (filter.DatItem_Status.MatchesPositive(ItemStatus.NULL, ItemStatus) == false) return false; if (filter.DatItem_Status.MatchesNegative(ItemStatus.NULL, ItemStatus) == true) return false; // Filter on optional if (filter.DatItem_Optional.MatchesNeutral(null, Optional) == false) return false; #endregion #region SoftwareList // Filter on DiskArea if (DiskArea != null) { if (!DiskArea.PassesFilter(filter)) return false; } // Filter on Part if (Part != null) { if (!Part.PassesFilter(filter)) return false; } #endregion return true; } /// /// Remove fields from the DatItem /// /// List of Fields to remove public override void RemoveFields(List fields) { // Remove common fields first base.RemoveFields(fields); // Remove the fields #region Common if (fields.Contains(Field.DatItem_Name)) Name = null; if (fields.Contains(Field.DatItem_MD5)) MD5 = null; if (fields.Contains(Field.DatItem_SHA1)) SHA1 = null; if (fields.Contains(Field.DatItem_Merge)) MergeTag = null; if (fields.Contains(Field.DatItem_Region)) Region = null; if (fields.Contains(Field.DatItem_Index)) Index = null; if (fields.Contains(Field.DatItem_Writable)) Writable = null; if (fields.Contains(Field.DatItem_Status)) ItemStatus = ItemStatus.NULL; if (fields.Contains(Field.DatItem_Optional)) Optional = null; #endregion #region SoftwareList if (DiskArea != null) DiskArea.RemoveFields(fields); if (Part != null) Part.RemoveFields(fields); #endregion } /// /// Set internal names to match One Rom Per Game (ORPG) logic /// public override void SetOneRomPerGame() { string[] splitname = Name.Split('.'); Machine.Name += $"/{string.Join(".", splitname.Take(splitname.Length > 1 ? splitname.Length - 1 : 1))}"; Name = Path.GetFileName(Name); } #endregion #region Sorting and Merging /// /// Get the dictionary key that should be used for a given item and bucketing type /// /// Field enum representing what key to get /// True if the key should be lowercased (default), false otherwise /// True if games should only be compared on game and file name, false if system and source are counted /// String representing the key to be used for the DatItem public override string GetKey(Field bucketedBy, bool lower = true, bool norename = true) { // Set the output key as the default blank string string key = string.Empty; // Now determine what the key should be based on the bucketedBy value switch (bucketedBy) { case Field.DatItem_MD5: key = MD5; break; case Field.DatItem_SHA1: key = SHA1; break; // Let the base handle generic stuff default: return base.GetKey(bucketedBy, lower, norename); } // Double and triple check the key for corner cases if (key == null) key = string.Empty; return key; } /// /// Replace fields from another item /// /// DatItem to pull new information from /// List of Fields representing what should be updated public override void ReplaceFields(DatItem item, List fields) { // Replace common fields first base.ReplaceFields(item, fields); // If we don't have a Disk to replace from, ignore specific fields if (item.ItemType != ItemType.Disk) return; // Cast for easier access Disk newItem = item as Disk; // Replace the fields #region Common if (fields.Contains(Field.DatItem_Name)) Name = newItem.Name; if (fields.Contains(Field.DatItem_MD5)) { if (string.IsNullOrEmpty(MD5) && !string.IsNullOrEmpty(newItem.MD5)) MD5 = newItem.MD5; } if (fields.Contains(Field.DatItem_SHA1)) { if (string.IsNullOrEmpty(SHA1) && !string.IsNullOrEmpty(newItem.SHA1)) SHA1 = newItem.SHA1; } if (fields.Contains(Field.DatItem_Merge)) MergeTag = newItem.MergeTag; if (fields.Contains(Field.DatItem_Region)) Region = newItem.Region; if (fields.Contains(Field.DatItem_Index)) Index = newItem.Index; if (fields.Contains(Field.DatItem_Writable)) Writable = newItem.Writable; if (fields.Contains(Field.DatItem_Status)) ItemStatus = newItem.ItemStatus; if (fields.Contains(Field.DatItem_Optional)) Optional = newItem.Optional; #endregion #region SoftwareList if (DiskArea != null && newItem.DiskArea != null) DiskArea.ReplaceFields(newItem.DiskArea, fields); if (Part != null && newItem.Part != null) Part.ReplaceFields(newItem.Part, fields); #endregion } #endregion } }