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

Add nullable context to SabreTools.DatItems

Browse Source 
This change also starts migrating the internals of the DatItem formats to the new internal models. Right now, it's basically just acting like a wrapper around those models.
This commit is contained in:
Matt Nadareski
2023-08-14 13:17:51 -04:00
parent 1752b1a0ac
commit b37aed389e
87 changed files with 3266 additions and 2199 deletions
Download Patch File Download Diff File Expand all files Collapse all files

172
SabreTools.DatItems/Formats/Media.cs
View File

@@ -1,5 +1,4 @@
using System.Text;
using System.Xml.Serialization;
using System.Xml.Serialization;
using Newtonsoft.Json;
using SabreTools.Core;
using SabreTools.Core.Tools;
@@ -13,72 +12,73 @@ namespace SabreTools.DatItems.Formats
[JsonObject("media"), XmlRoot("media")]
public class Media : DatItem
{
#region Private instance variables
private byte[] _md5; // 16 bytes
private byte[] _sha1; // 20 bytes
private byte[] _sha256; // 32 bytes
private byte[] _spamsum; // variable bytes
#endregion
#region Fields
/// <summary>
/// Name of the item
/// </summary>
[JsonProperty("name"), XmlElement("name")]
public string Name { get; set; }
public string? Name
{
get => _media.ReadString(Models.Internal.Media.NameKey);
set => _media[Models.Internal.Media.NameKey] = value;
}
/// <summary>
/// Data MD5 hash
/// </summary>
[JsonProperty("md5", DefaultValueHandling = DefaultValueHandling.Ignore), XmlElement("md5")]
public string MD5
public string? MD5
{
get { return _md5.IsNullOrEmpty() ? null : Utilities.ByteArrayToString(_md5); }
set { _md5 = Utilities.StringToByteArray(CleanMD5(value)); }
get => _media.ReadString(Models.Internal.Media.MD5Key);
set => _media[Models.Internal.Media.MD5Key] = TextHelper.NormalizeMD5(value);
}
/// <summary>
/// Data SHA-1 hash
/// </summary>
[JsonProperty("sha1", DefaultValueHandling = DefaultValueHandling.Ignore), XmlElement("sha1")]
public string SHA1
public string? SHA1
{
get { return _sha1.IsNullOrEmpty() ? null : Utilities.ByteArrayToString(_sha1); }
set { _sha1 = Utilities.StringToByteArray(CleanSHA1(value)); }
get => _media.ReadString(Models.Internal.Media.SHA1Key);
set => _media[Models.Internal.Media.SHA1Key] = TextHelper.NormalizeSHA1(value);
}
/// <summary>
/// Data SHA-256 hash
/// </summary>
[JsonProperty("sha256", DefaultValueHandling = DefaultValueHandling.Ignore), XmlElement("sha256")]
public string SHA256
public string? SHA256
{
get { return _sha256.IsNullOrEmpty() ? null : Utilities.ByteArrayToString(_sha256); }
set { _sha256 = Utilities.StringToByteArray(CleanSHA256(value)); }
get => _media.ReadString(Models.Internal.Media.SHA256Key);
set => _media[Models.Internal.Media.SHA256Key] = TextHelper.NormalizeSHA256(value);
}
/// <summary>
/// File SpamSum fuzzy hash
/// </summary>
[JsonProperty("spamsum", DefaultValueHandling = DefaultValueHandling.Ignore), XmlElement("spamsum")]
public string SpamSum
public string? SpamSum
{
get { return _spamsum.IsNullOrEmpty() ? null : Encoding.UTF8.GetString(_spamsum); }
set { _spamsum = Encoding.UTF8.GetBytes(value ?? string.Empty); }
get => _media.ReadString(Models.Internal.Media.SpamSumKey);
set => _media[Models.Internal.Media.SpamSumKey] = value;
}
/// <summary>
/// Internal Media model
/// </summary>
[JsonIgnore]
private Models.Internal.Media _media = new();
#endregion
#region Accessors
/// <inheritdoc/>
public override string GetName() => Name;
public override string? GetName() => Name;
/// <inheritdoc/>
public override void SetName(string name) => Name = name;
public override void SetName(string? name) => Name = name;
#endregion
@@ -101,10 +101,10 @@ namespace SabreTools.DatItems.Formats
public Media(BaseFile baseFile)
{
Name = baseFile.Filename;
_md5 = baseFile.MD5;
_sha1 = baseFile.SHA1;
_sha256 = baseFile.SHA256;
_spamsum = baseFile.SpamSum;
MD5 = Utilities.ByteArrayToString(baseFile.MD5);
SHA1 = Utilities.ByteArrayToString(baseFile.SHA1);
SHA256 = Utilities.ByteArrayToString(baseFile.SHA256);
SpamSum = Utilities.ByteArrayToString(baseFile.SpamSum);
ItemType = ItemType.Media;
DupeType = 0x00;
@@ -122,15 +122,11 @@ namespace SabreTools.DatItems.Formats
ItemType = this.ItemType,
DupeType = this.DupeType,
Machine = this.Machine.Clone() as Machine,
Source = this.Source.Clone() as Source,
Machine = this.Machine?.Clone() as Machine,
Source = this.Source?.Clone() as Source,
Remove = this.Remove,
Name = this.Name,
_md5 = this._md5,
_sha1 = this._sha1,
_sha256 = this._sha256,
_spamsum = this._spamsum,
_media = this._media?.Clone() as Models.Internal.Media ?? new Models.Internal.Media(),
};
}
@@ -143,10 +139,10 @@ namespace SabreTools.DatItems.Formats
{
Filename = this.Name,
Parent = this.Machine?.Name,
MD5 = this._md5,
SHA1 = this._sha1,
SHA256 = this._sha256,
SpamSum = this._spamsum,
MD5 = Utilities.StringToByteArray(this.MD5),
SHA1 = Utilities.StringToByteArray(this.SHA1),
SHA256 = Utilities.StringToByteArray(this.SHA256),
SpamSum = Utilities.StringToByteArray(this.SpamSum),
};
}
@@ -161,8 +157,8 @@ namespace SabreTools.DatItems.Formats
ItemType = ItemType.Rom,
DupeType = this.DupeType,
Machine = this.Machine.Clone() as Machine,
Source = this.Source.Clone() as Source,
Machine = this.Machine?.Clone() as Machine,
Source = this.Source?.Clone() as Source,
Remove = this.Remove,
Name = this.Name + ".aif",
@@ -180,22 +176,14 @@ namespace SabreTools.DatItems.Formats
#region Comparision Methods
/// <inheritdoc/>
public override bool Equals(DatItem other)
public override bool Equals(DatItem? other)
{
bool dupefound = false;
// If we don't have a Media, return false
if (ItemType != other.ItemType)
return dupefound;
if (ItemType != other?.ItemType || other is not Media otherInternal)
return false;
// Otherwise, treat it as a Media
Media newOther = other as Media;
// If we get a partial match
if (HashMatch(newOther))
dupefound = true;
return dupefound;
// Compare the internal models
return _media.EqualTo(otherInternal._media);
}
/// <summary>
@@ -204,17 +192,17 @@ namespace SabreTools.DatItems.Formats
/// <param name="other">Media to fill information from</param>
public void FillMissingInformation(Media other)
{
if (_md5.IsNullOrEmpty() && !other._md5.IsNullOrEmpty())
_md5 = other._md5;
if (string.IsNullOrWhiteSpace(MD5) && !string.IsNullOrWhiteSpace(other.MD5))
MD5 = other.MD5;
if (_sha1.IsNullOrEmpty() && !other._sha1.IsNullOrEmpty())
_sha1 = other._sha1;
if (string.IsNullOrWhiteSpace(SHA1) && !string.IsNullOrWhiteSpace(other.SHA1))
SHA1 = other.SHA1;
if (_sha256.IsNullOrEmpty() && !other._sha256.IsNullOrEmpty())
_sha256 = other._sha256;
if (string.IsNullOrWhiteSpace(SHA256) && !string.IsNullOrWhiteSpace(other.SHA256))
SHA256 = other.SHA256;
if (_spamsum.IsNullOrEmpty() && !other._spamsum.IsNullOrEmpty())
_spamsum = other._spamsum;
if (string.IsNullOrWhiteSpace(SpamSum) && !string.IsNullOrWhiteSpace(other.SpamSum))
SpamSum = other.SpamSum;
}
/// <summary>
@@ -223,64 +211,18 @@ namespace SabreTools.DatItems.Formats
/// <returns>String representing the suffix</returns>
public string GetDuplicateSuffix()
{
if (!_md5.IsNullOrEmpty())
if (!string.IsNullOrWhiteSpace(MD5))
return $"_{MD5}";
else if (!_sha1.IsNullOrEmpty())
else if (!string.IsNullOrWhiteSpace(SHA1))
return $"_{SHA1}";
else if (!_sha256.IsNullOrEmpty())
else if (!string.IsNullOrWhiteSpace(SHA256))
return $"_{SHA256}";
else if (!_spamsum.IsNullOrEmpty())
else if (!string.IsNullOrWhiteSpace(SpamSum))
return $"_{SpamSum}";
else
return "_1";
}
/// <summary>
/// Returns if there are no, non-empty hashes in common with another Media
/// </summary>
/// <param name="other">Media to compare against</param>
/// <returns>True if at least one hash is not mutually exclusive, false otherwise</returns>
private bool HasCommonHash(Media other)
{
return !(_md5.IsNullOrEmpty() ^ other._md5.IsNullOrEmpty())
|| !(_sha1.IsNullOrEmpty() ^ other._sha1.IsNullOrEmpty())
|| !(_sha256.IsNullOrEmpty() ^ other._sha256.IsNullOrEmpty())
|| !(_spamsum.IsNullOrEmpty() ^ other._spamsum.IsNullOrEmpty());
}
/// <summary>
/// Returns if the Media contains any hashes
/// </summary>
/// <returns>True if any hash exists, false otherwise</returns>
private bool HasHashes()
{
return !_md5.IsNullOrEmpty()
|| !_sha1.IsNullOrEmpty()
|| !_sha256.IsNullOrEmpty()
|| !_spamsum.IsNullOrEmpty();
}
/// <summary>
/// Returns if any hashes are common with another Media
/// </summary>
/// <param name="other">Media to compare against</param>
/// <returns>True if any hashes are in common, false otherwise</returns>
private bool HashMatch(Media 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)
&& ConditionalHashEquals(_spamsum, other._spamsum);
}
#endregion
#region Sorting and Merging
@@ -289,7 +231,7 @@ namespace SabreTools.DatItems.Formats
public override string GetKey(ItemKey bucketedBy, bool lower = true, bool norename = true)
{
// Set the output key as the default blank string
string key;
string? key;
// Now determine what the key should be based on the bucketedBy value
switch (bucketedBy)