using System.Xml.Serialization;
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
using SabreTools.Core;
using SabreTools.Core.Tools;
using SabreTools.FileTypes;
namespace SabreTools.DatItems.Formats
{
///
/// Represents Compressed Hunks of Data (CHD) formatted disks which use internal hashes
///
[JsonObject("disk"), XmlRoot("disk")]
public class Disk : DatItem
{
#region Fields
#region Common
///
/// Name of the item
///
[JsonProperty("name"), XmlElement("name")]
public string? Name
{
get => _internal.ReadString(Models.Metadata.Disk.NameKey);
set => _internal[Models.Metadata.Disk.NameKey] = value;
}
///
/// Data MD5 hash
///
[JsonProperty("md5", DefaultValueHandling = DefaultValueHandling.Ignore), XmlElement("md5")]
public string? MD5
{
get => _internal.ReadString(Models.Metadata.Disk.MD5Key);
set => _internal[Models.Metadata.Disk.MD5Key] = TextHelper.NormalizeMD5(value);
}
///
/// Data SHA-1 hash
///
[JsonProperty("sha1", DefaultValueHandling = DefaultValueHandling.Ignore), XmlElement("sha1")]
public string? SHA1
{
get => _internal.ReadString(Models.Metadata.Disk.SHA1Key);
set => _internal[Models.Metadata.Disk.SHA1Key] = TextHelper.NormalizeSHA1(value);
}
///
/// Disk name to merge from parent
///
[JsonProperty("merge", DefaultValueHandling = DefaultValueHandling.Ignore), XmlElement("merge")]
public string? MergeTag
{
get => _internal.ReadString(Models.Metadata.Disk.MergeKey);
set => _internal[Models.Metadata.Disk.MergeKey] = value;
}
///
/// Disk region
///
[JsonProperty("region", DefaultValueHandling = DefaultValueHandling.Ignore), XmlElement("region")]
public string? Region
{
get => _internal.ReadString(Models.Metadata.Disk.RegionKey);
set => _internal[Models.Metadata.Disk.RegionKey] = value;
}
///
/// Disk index
///
[JsonProperty("index", DefaultValueHandling = DefaultValueHandling.Ignore), XmlElement("index")]
public string? Index
{
get => _internal.ReadString(Models.Metadata.Disk.IndexKey);
set => _internal[Models.Metadata.Disk.IndexKey] = value;
}
///
/// Disk writable flag
///
[JsonProperty("writable", DefaultValueHandling = DefaultValueHandling.Ignore), XmlElement("writable")]
public bool? Writable
{
get => _internal.ReadBool(Models.Metadata.Disk.WritableKey);
set => _internal[Models.Metadata.Disk.WritableKey] = value;
}
[JsonIgnore]
public bool WritableSpecified { get { return Writable != null; } }
///
/// Disk dump status
///
[JsonProperty("status", DefaultValueHandling = DefaultValueHandling.Ignore), XmlElement("status")]
[JsonConverter(typeof(StringEnumConverter))]
public ItemStatus ItemStatus
{
get => _internal.ReadString(Models.Metadata.Disk.StatusKey).AsEnumValue();
set => _internal[Models.Metadata.Disk.StatusKey] = value.AsStringValue(useSecond: false);
}
[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 => _internal.ReadBool(Models.Metadata.Disk.OptionalKey);
set => _internal[Models.Metadata.Disk.OptionalKey] = value;
}
[JsonIgnore]
public bool OptionalSpecified { get { return Optional != null; } }
#endregion
#region SoftwareList
///
/// Disk area information
///
/// Hack on top of internal model
[JsonProperty("diskarea", DefaultValueHandling = DefaultValueHandling.Ignore), XmlElement("diskarea")]
public DiskArea? DiskArea
{
get => _internal.Read("DISKAREA");
set => _internal["DISKAREA"] = value;
}
[JsonIgnore]
public bool DiskAreaSpecified
{
get
{
return DiskArea != null
&& !string.IsNullOrEmpty(DiskArea.Name);
}
}
///
/// Original hardware part associated with the item
///
/// Hack on top of internal model
[JsonProperty("part", DefaultValueHandling = DefaultValueHandling.Ignore), XmlElement("part")]
public Part? Part
{
get => _internal.Read("PART");
set => _internal["PART"] = value;
}
[JsonIgnore]
public bool PartSpecified
{
get
{
return Part != null
&& (!string.IsNullOrEmpty(Part.Name)
|| !string.IsNullOrEmpty(Part.Interface));
}
}
#endregion
#endregion // Fields
#region Accessors
///
public override string? GetName() => Name;
///
public override void SetName(string? name) => Name = name;
#endregion
#region Constructors
///
/// Create a default, empty Disk object
///
public Disk()
{
_internal = new Models.Metadata.Disk();
Machine = new Machine();
Name = string.Empty;
ItemType = ItemType.Disk;
DupeType = 0x00;
ItemStatus = ItemStatus.None;
}
///
/// Create a Disk object from a BaseFile
///
public Disk(BaseFile baseFile)
{
_internal = new Models.Metadata.Disk();
Machine = new Machine();
Name = baseFile.Filename;
MD5 = TextHelper.ByteArrayToString(baseFile.MD5);
SHA1 = TextHelper.ByteArrayToString(baseFile.SHA1);
ItemType = ItemType.Disk;
DupeType = 0x00;
ItemStatus = ItemStatus.None;
}
#endregion
#region Cloning Methods
///
public override object Clone()
{
return new Disk()
{
ItemType = this.ItemType,
DupeType = this.DupeType,
Machine = this.Machine.Clone() as Machine ?? new Machine(),
Source = this.Source?.Clone() as Source,
Remove = this.Remove,
_internal = this._internal?.Clone() as Models.Metadata.Disk ?? [],
};
}
///
/// Convert Disk object to a BaseFile
///
public BaseFile ConvertToBaseFile()
{
return new BaseFile()
{
Filename = this.Name,
Parent = this.Machine.Name,
MD5 = TextHelper.StringToByteArray(this.MD5),
SHA1 = TextHelper.StringToByteArray(this.SHA1),
};
}
///
/// Convert a disk to the closest Rom approximation
///
///
public Rom ConvertToRom()
{
var rom = new Rom(_internal.ConvertToRom())
{
ItemType = ItemType.Rom,
DupeType = this.DupeType,
Machine = this.Machine.Clone() as Machine ?? new Machine(),
Source = this.Source?.Clone() as Source,
Remove = this.Remove,
DataArea = new DataArea { Name = this.DiskArea?.Name },
Part = this.Part,
};
return rom;
}
#endregion
#region Comparision Methods
///
/// Fill any missing size and hash information from another Disk
///
/// Disk to fill information from
public void FillMissingInformation(Disk other) => _internal.FillMissingHashes(other?._internal);
///
/// Get unique duplicate suffix on name collision
///
/// String representing the suffix
public string GetDuplicateSuffix() => _internal.GetDuplicateSuffix();
#endregion
#region Sorting and Merging
///
public override string GetKey(ItemKey bucketedBy, bool lower = true, bool norename = true)
{
// Set the output key as the default blank string
string? key;
// Now determine what the key should be based on the bucketedBy value
switch (bucketedBy)
{
case ItemKey.MD5:
key = MD5;
break;
case ItemKey.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
key ??= string.Empty;
return key;
}
#endregion
}
}