Improve support for Invader-built maps

Adds a new attribute that allows for partial build string matching since Invader uses the format "Invader [version]". CacheFileLoader also now verifies the footer magic as false positives began to show up. Support for h1 maps built with the modified "Hell Tools" was also added.

Author: Lord-Zedd

src/Blamite/Blam/CacheFileLoader.cs

@@ -42,7 +42,7 @@ public static ICacheFile LoadCacheFile(IReader reader, string filePath, EngineDa
 			engineInfo = FindEngineDescription(reader, engineDb);
 
 			if (engineInfo == null)
-				throw new NotSupportedException("Engine build of given cache file \"" + Path.GetFileName(filePath) + "\" not supported");
+				throw new NotSupportedException("Engine build of given cache file \"" + Path.GetFileName(filePath) + "\" not supported.");
 
 			return LoadCacheFileWithEngineDescription(reader, filePath, engineInfo);
 		}
@@ -58,7 +58,7 @@ public static ICacheFile LoadCacheFile(IReader reader, string filePath, EngineDa
 		public static ICacheFile LoadCacheFileWithEngineDescription(IReader reader, string filePath, EngineDescription engineInfo)
 		{
 			if (engineInfo == null)
-				throw new NotSupportedException("Engine build of given cache file \"" + Path.GetFileName(filePath) + "\" not supported");
+				throw new NotSupportedException("Engine build of given cache file \"" + Path.GetFileName(filePath) + "\" not supported.");
 
 			//reader is often initialized with Big Endian, switch it to match the EngineDescription
 			reader.Endianness = engineInfo.Endian;
@@ -110,10 +110,15 @@ public static List<EngineDescription> FindEngineDescriptions(IReader reader, Eng
 			reader.SeekTo(0);
 			byte[] headerMagic = reader.ReadBlock(4);
 			var endian = DetermineCacheFileEndianness(headerMagic);
+			var endianMod = DetermineModuleFileEndianness(headerMagic);
 			int fileVersion;
+			bool trial = false;
 
 			List<EngineDescription> matches = new List<EngineDescription>();
 
+			if (endianMod != null)
+				return matches;
+
 			if (endian != null)
 			{
 				reader.Endianness = endian.Value;
@@ -128,26 +133,61 @@ public static List<EngineDescription> FindEngineDescriptions(IReader reader, Eng
 				var trialendian = DetermineTrialCacheFileEndianness(headerMagic);
 
 				if (trialendian == null)
-					return matches;
+					throw new ArgumentException("Invalid cache file header magic.");
 
 				reader.Endianness = trialendian.Value;
 				reader.SeekTo(0x588);
 				fileVersion = reader.ReadInt32();
+				trial = true;
 			}
 
 			var possibleEngines = engineDb.FindEnginesByVersion(fileVersion, reader.Endianness);
 
 			//reduce extra reads by caching the value at each offset
 			Dictionary<int, string> offsetCache = new Dictionary<int, string>();
+			Dictionary<int, bool> footCache = new Dictionary<int, bool>();
 
 			foreach (EngineDescription engine in possibleEngines)
 			{
+				int footOffset;
+
+				if (trial)
+				{
+					var headerLayout = engine.Layouts.GetLayout("header");
+					if (!headerLayout.HasField("footer magic"))
+						continue;
+
+					footOffset = headerLayout.GetFieldOffset("footer magic");
+				}
+				else
+					footOffset = engine.HeaderSize - 4;
+
+				if (footCache.ContainsKey(footOffset))
+				{
+					if (!footCache[footOffset])
+						continue;
+				}
+				else
+				{
+					reader.SeekTo(footOffset);
+					var footMagic = reader.ReadBlock(4);
+
+					bool realFeet = CheckFooter(footMagic);
+
+					footCache.Add(footOffset, realFeet);
+
+					if (!realFeet)
+						continue;
+				}
+
 				if (offsetCache.ContainsKey(engine.BuildStringOffset))
 				{
-					if (offsetCache[engine.BuildStringOffset] == engine.BuildVersion)
+					if ((engine.LooseBuildCheck && offsetCache[engine.BuildStringOffset].StartsWith(engine.BuildVersion)) ||
+						offsetCache[engine.BuildStringOffset] == engine.BuildVersion)
 					{
 						matches.Add(engine);
-						if (!string.IsNullOrEmpty(engine.BuildVersion))
+
+						if (!engine.LooseBuildCheck && !string.IsNullOrEmpty(engine.BuildVersion))
 							break;
 					}
 
@@ -157,10 +197,12 @@ public static List<EngineDescription> FindEngineDescriptions(IReader reader, Eng
 				reader.SeekTo(engine.BuildStringOffset);
 				string buildString = reader.ReadAscii(0x20);
 
-				if (buildString == engine.BuildVersion)
+				if ((engine.LooseBuildCheck && buildString.StartsWith(engine.BuildVersion)) ||
+					buildString == engine.BuildVersion)
 				{
 					matches.Add(engine);
-					if (!string.IsNullOrEmpty(engine.BuildVersion))
+
+					if (!engine.LooseBuildCheck && !string.IsNullOrEmpty(engine.BuildVersion))
 						break;
 				}
 
@@ -178,7 +220,6 @@ public static List<EngineDescription> FindEngineDescriptions(IReader reader, Eng
 				return Endian.LittleEndian;
 
 			return null;
-			//throw new ArgumentException("Invalid cache file header magic");
 		}
 
 		public static Endian? DetermineTrialCacheFileEndianness(byte[] headerMagic)
@@ -189,7 +230,27 @@ public static List<EngineDescription> FindEngineDescriptions(IReader reader, Eng
 				return Endian.LittleEndian;
 
 			return null;
-			//throw new ArgumentException("Invalid cache file header magic");
+		}
+
+		public static Endian? DetermineModuleFileEndianness(byte[] headerMagic)
+		{
+			if (headerMagic[0] == 'd' && headerMagic[1] == 'h' && headerMagic[2] == 'o' && headerMagic[3] == 'm')
+				return Endian.BigEndian;
+			if (headerMagic[0] == 'm' && headerMagic[1] == 'o' && headerMagic[2] == 'h' && headerMagic[3] == 'd')
+				return Endian.LittleEndian;
+
+			return null;
+		}
+
+		public static bool CheckFooter(byte[] footerMagic)
+		{
+			if ((footerMagic[0] == 'f' && footerMagic[1] == 'o' && footerMagic[2] == 'o' && footerMagic[3] == 't') ||
+				(footerMagic[0] == 't' && footerMagic[1] == 'o' && footerMagic[2] == 'o' && footerMagic[3] == 'f') ||
+				(footerMagic[0] == 'G' && footerMagic[1] == 'f' && footerMagic[2] == 'o' && footerMagic[3] == 't') ||
+				(footerMagic[0] == 't' && footerMagic[1] == 'o' && footerMagic[2] == 'f' && footerMagic[3] == 'G'))
+				return true;
+
+			return false;
 		}
 	}
 }

src/Blamite/Blam/FirstGen/Structures/FirstGenHeader.cs

@@ -8,7 +8,10 @@ public class FirstGenHeader
 		private FileSegment _eofSegment;
 		public FirstGenHeader(StructureValueCollection values, EngineDescription info, FileSegmenter segmenter)
 		{
-			BuildString = info.BuildVersion;
+			if (info.LooseBuildCheck)
+				BuildString = values.GetString("build string");
+			else
+				BuildString = info.BuildVersion;
 			HeaderSize = info.HeaderSize;
 			Load(values, segmenter);
 		}

src/Blamite/Formats/Engines.xml

@@ -9,7 +9,8 @@
 		version="{version number}" - The number located at offset 0x4.
 		versionAlt="{version number}" - An alternate version number used by the engine, see above.
 		build="{build string}" - The full build string.
-		inherits="{name of another defined engine}" - Uses the given engine as a base, anything else defined in this new engine overwrites the inherited value. You cannot chain multiple inherits. Any engine using this attribute should be placed AFTER the engine you wish to inherit.
+		looseBuild={"true", "false"} - Instead of checking for an exact build string match, Blamite should check if the cache's string starts with the defined one for the engine. Intended for H1 cache files built with the tool Invader which sets the build string to the tool's version. Default if not present is false.
+		inherits="{name of another defined engine}" - Uses the given engine as a base, anything else defined in this new engine overwrites the inherited value. You cannot chain multiple inherits. Any engine using this attribute should be placed AFTER the engine you wish to inherit within this file.
 		>
 
 		<shortname>{short name}</shortname> - A shorthand name for the engine, displayed on the recent files list. Will also get used as the "game" attribute in Assembly's plugin generator.
@@ -233,7 +234,7 @@
 
 	<engine name="Halo 1 PC v10" version="7" build="01.00.10.0621" inherits="Halo 1 PC" />
 
-	<engine name="Halo 1 PC Invader" version="7" build="Invader 0.44.0.r3320" inherits="Halo 1 PC" />
+	<engine name="Halo 1 PC Invader" version="7" build="Invader " looseBuild="true" inherits="Halo 1 PC" />
 
 	<engine name="Halo 1 Custom Edition" version="609" versionAlt="343" build="01.00.00.0609">
 		<shortName>H1CE</shortName>
@@ -259,7 +260,7 @@
 
 	<engine name="Halo 1 Custom Edition v10" version="609" versionAlt="343" build="01.00.10.0621" inherits="Halo 1 Custom Edition" />
 
-	<engine name="Halo 1 Custom Edition Invader" version="609" versionAlt="343" build="Invader 0.44.0.r3320" inherits="Halo 1 Custom Edition" />
+	<engine name="Halo 1 Custom Edition Invader" version="609" versionAlt="343" build="Invader " looseBuild="true" inherits="Halo 1 Custom Edition" />
 
 	<!-- NOTE: CEA 360 and early MCC have the same build strings, this makes things harder -->
 	<engine name="Halo 1 Anniversary" version="7" build="01.00.01.0563">
@@ -1010,6 +1011,20 @@
 			<usesCompression>false</usesCompression>
 		</engineInfo>
 	</engine>
+	
+	<engine name="Halo 1 Anniversary MCC Invader" version="13" build="Invader " looseBuild="true" inherits="Halo 1 Anniversary MCC">
+		<engineInfo>
+			<segmentAlignment>0x1</segmentAlignment>
+			<usesCompression>false</usesCompression>
+		</engineInfo>
+	</engine>
+	
+	<engine name="Halo 1 Anniversary MCC Hell" version="13" build="01.06.66.HELL" inherits="Halo 1 Anniversary MCC">
+		<engineInfo>
+			<segmentAlignment>0x1</segmentAlignment>
+			<usesCompression>false</usesCompression>
+		</engineInfo>
+	</engine>
 
 	<!-- Halo 2 MCC -->
 	<engine name="Halo 2 MCC" version="10" build=""><!-- gee thanks for the empty string 343 I appreciate it -->

src/Blamite/Serialization/EngineDescription.cs

@@ -18,12 +18,13 @@ public class EngineDescription
 		/// <param name="name">The engine's name.</param>
 		/// <param name="version">The engine's version.</param>
 		/// <param name="settings">The engine's settings.</param>
-		public EngineDescription(string name, int version, int versionalt, string build, SettingsGroup settings)
+		public EngineDescription(string name, int version, int versionalt, string build, bool looseBuild, SettingsGroup settings)
 		{
 			Name = name;
 			Version = version;
 			VersionAlt = versionalt;
 			BuildVersion = build;
+			LooseBuildCheck = looseBuild;
 			Settings = settings;
 
 			LoadSettings();
@@ -202,6 +203,11 @@ public EngineDescription(string name, int version, int versionalt, string build,
 		/// </summary>
 		public bool ReverseChecksum { get; private set; }
 
+		/// <summary>
+		///     Don't look for an exact match on the build string when checking against this EngineDescription during load. See if it starts with the string instead.
+		/// </summary>
+		public bool LooseBuildCheck { get; private set; }
+
 		private void LoadSettings()
 		{
 			LoadEngineSettings();

src/Blamite/Serialization/Settings/XMLEngineDatabaseLoader.cs

@@ -45,6 +45,7 @@ public static EngineDatabase LoadDatabase(XContainer container)
 				string build = XMLUtil.GetStringAttribute(elem, "build");
 				var version = XMLUtil.GetNumericAttribute(elem, "version");
 				var versionAlt = XMLUtil.GetNumericAttribute(elem, "versionAlt", -1);
+				bool looseBuild = XMLUtil.GetBoolAttribute(elem, "looseBuild", false);
 				string inherits = XMLUtil.GetStringAttribute(elem, "inherits", null);
 				SettingsGroup settings = loader.LoadSettingsGroup(elem);
 				if (!string.IsNullOrWhiteSpace(inherits))
@@ -54,7 +55,7 @@ public static EngineDatabase LoadDatabase(XContainer container)
 					baseSettings.Import(settings);
 					settings = baseSettings;
 				}
-				var desc = new EngineDescription(name, (int)version, (int)versionAlt, build, settings);
+				var desc = new EngineDescription(name, (int)version, (int)versionAlt, build, looseBuild, settings);
 				result.RegisterEngine(desc);
 			}
 			return result;