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

[Skippers] Make header skippers more complete

Browse Source
This commit is contained in:
Matt Nadareski
2016-06-17 11:02:38 -07:00
parent 8143c80be1
commit ae796b98cc
3 changed files with 250 additions and 227 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
Deheader/Headerer.cs
View File

@@ -76,7 +76,7 @@ namespace SabreTools
// If it's a single file, just check it
if (File.Exists(file))
{
DetectRemoveHeader(file);
DetectSkipperAndTransform(file);
}
// If it's a directory, recursively check all
else if (Directory.Exists(file))
@@ -85,7 +85,7 @@ namespace SabreTools
{
if (sub != ".." && sub != ".")
{
DetectRemoveHeader(sub);
DetectSkipperAndTransform(sub);
}
}
}
@@ -123,12 +123,15 @@ namespace SabreTools
}
/// <summary>
/// Detect and remove header from the given file
/// Detect header skipper compliance and create an output file
/// </summary>
/// <param name="file">Name of the file to be parsed</param>
private static void DetectRemoveHeader(string file)
/// <returns>True if the output file was created, false otherwise</returns>
private static bool DetectSkipperAndTransform(string file)
{
// First get the HeaderType, if any
logger.User("\nGetting skipper information for '" + file + "'");
// Then, if the file was headered, store it to the database
int headerSize = -1;
HeaderType type = Skippers.GetFileHeaderType(file, out headerSize, logger);
@@ -150,15 +153,30 @@ namespace SabreTools
}
}
// Write out the remaining bytes to new file
logger.User("Creating unheadered file: " + file + ".new");
Output.RemoveBytesFromFile(file, file + ".new", headerSize, 0);
logger.User("Unheadered file created!");
// Then find an apply the exact rule to the file
SkipperRule rule = Skippers.MatchesSkipper(file, "", logger);
// If we have an empty rule, return false
if (rule.Tests == null || rule.Tests.Count == 0)
{
return false;
}
// Otherwise, apply the rule ot the file
Skippers.TransformFile(file, file + ".new", rule, logger);
// If the output file doesn't exist, return false
if (!File.Exists(file + ".new"))
{
return false;
}
// Now add the information to the database if it's not already there
Rom rom = RomTools.GetSingleFileInfo(file + ".new");
AddHeaderToDatabase(hstr, rom.SHA1, type);
}
return true;
}
/// <summary>

102
SabreTools.Helper/Skippers.cs
View File

@@ -10,7 +10,7 @@ namespace SabreTools.Helper
public class Skippers
{
// Local paths
private const string _skippersPath = "Skippers";
public const string Path = "Skippers";
// Header skippers represented by a list of skipper objects
private static List<Skipper> _list;
@@ -56,9 +56,9 @@ namespace SabreTools.Helper
_list = new List<Skipper>();
}
foreach (string skipperFile in Directory.EnumerateFiles(_skippersPath, "*", SearchOption.AllDirectories))
foreach (string skipperFile in Directory.EnumerateFiles(Path, "*", SearchOption.AllDirectories))
{
_list.Add(PopulateSkippersHelper(Path.GetFullPath(skipperFile)));
_list.Add(PopulateSkippersHelper(System.IO.Path.GetFullPath(skipperFile)));
}
}
@@ -69,7 +69,10 @@ namespace SabreTools.Helper
/// <returns>The Skipper object associated with the file</returns>
private static Skipper PopulateSkippersHelper(string filename)
{
Skipper skipper = new Skipper();
Skipper skipper = new Skipper
{
Rules = new List<SkipperRule>(),
};
if (!File.Exists(filename))
{
@@ -98,6 +101,7 @@ namespace SabreTools.Helper
{
case "detector":
valid = true;
xtr.Read();
break;
case "name":
skipper.Name = xtr.ReadElementContentAsString();
@@ -127,9 +131,7 @@ namespace SabreTools.Helper
}
else
{
long temp = 0;
Int64.TryParse(offset, out temp);
rule.StartOffset = temp;
rule.StartOffset = Convert.ToInt64(offset, 16);
}
}
if (xtr.GetAttribute("end_offset") != null)
@@ -141,9 +143,7 @@ namespace SabreTools.Helper
}
else
{
long temp = 0;
Int64.TryParse(offset, out temp);
rule.EndOffset = temp;
rule.EndOffset = Convert.ToInt64(offset, 16);
}
}
if (xtr.GetAttribute("operation") != null)
@@ -217,9 +217,7 @@ namespace SabreTools.Helper
}
else
{
long temp = 0;
Int64.TryParse(offset, out temp);
test.Offset = temp;
test.Offset = Convert.ToInt64(offset, 16);
}
}
if (subreader.GetAttribute("value") != null)
@@ -269,9 +267,7 @@ namespace SabreTools.Helper
}
else
{
long temp = 0;
Int64.TryParse(size, out temp);
test.Size = temp;
test.Size = Convert.ToInt64(size, 16);
}
}
if (subreader.GetAttribute("operator") != null)
@@ -330,28 +326,15 @@ namespace SabreTools.Helper
}
// Loop through and find a Skipper that has the right name
Skipper matchedSkipper = new Skipper();
logger.User("Beginning search for matching header skip rules");
foreach (Skipper skipper in List)
{
if (!String.IsNullOrEmpty(skipper.Name) && skippername.ToLowerInvariant() == skipper.Name.ToLowerInvariant())
if (String.IsNullOrEmpty(skippername) || (!String.IsNullOrEmpty(skipper.Name) && skippername.ToLowerInvariant() == skipper.Name.ToLowerInvariant()))
{
matchedSkipper = skipper;
break;
}
}
// If we have a blank skipper, return a blank skipper rule
if (String.IsNullOrEmpty(matchedSkipper.Name) || matchedSkipper.Rules == null)
{
logger.Warning("No header skipper by the name of '" + skippername + "' can be found");
return skipperRule;
}
// Otherwise, loop through the rules until one is found that works
// Loop through the rules until one is found that works
using (BinaryReader br = new BinaryReader(File.OpenRead(input)))
{
logger.User("Beginning search for matching header skip rules");
foreach (SkipperRule rule in matchedSkipper.Rules)
foreach (SkipperRule rule in skipper.Rules)
{
// Always reset the stream back to the original place
br.BaseStream.Seek(0, SeekOrigin.Begin);
@@ -487,6 +470,8 @@ namespace SabreTools.Helper
}
}
}
}
}
// If we have a blank rule, inform the user
if (skipperRule.Tests == null)
@@ -507,6 +492,8 @@ namespace SabreTools.Helper
/// <returns></returns>
public static bool TransformFile(string input, string output, SkipperRule rule, Logger logger)
{
bool success = true;
// If the input file doesn't exist, fail
if (!File.Exists(input))
{
@@ -515,9 +502,9 @@ namespace SabreTools.Helper
}
// Create the output directory if it doesn't already
if (!Directory.Exists(Path.GetDirectoryName(output)))
if (!Directory.Exists(System.IO.Path.GetDirectoryName(output)))
{
Directory.CreateDirectory(Path.GetDirectoryName(output));
Directory.CreateDirectory(System.IO.Path.GetDirectoryName(output));
}
// If the sizes are wrong for the values, fail
@@ -533,17 +520,18 @@ namespace SabreTools.Helper
// Now read the proper part of the file and apply the rule
try
{
logger.User("Applying found rule to file '" + input + "'");
using (BinaryWriter bw = new BinaryWriter(File.OpenWrite(output)))
using (BinaryReader br = new BinaryReader(File.OpenRead(input)))
{
// Seek to the beginning offset
if (rule.StartOffset == null)
{
return false;
success = false;
}
else if (Math.Abs((long)rule.StartOffset) > br.BaseStream.Length)
{
return false;
success = false;
}
else if (rule.StartOffset > 0)
{
@@ -555,12 +543,14 @@ namespace SabreTools.Helper
}
// Then read and apply the operation as you go
if (success)
{
byte[] buffer = new byte[4];
int pos = 0;
while (br.BaseStream.Position <= (rule.EndOffset != null ? rule.EndOffset : br.BaseStream.Length)
&& br.BaseStream.Position <= br.BaseStream.Length)
while (br.BaseStream.Position < (rule.EndOffset != null ? rule.EndOffset : br.BaseStream.Length)
&& br.BaseStream.Position < br.BaseStream.Length)
{
uint b = br.ReadUInt32();
byte b = br.ReadByte();
switch (rule.Operation)
{
case HeaderSkipOperation.Bitswap:
@@ -579,22 +569,22 @@ namespace SabreTools.Helper
case HeaderSkipOperation.Byteswap:
if (pos % 2 == 1)
{
buffer[pos - 1] = (byte)b;
buffer[pos - 1] = b;
}
if (pos % 2 == 0)
{
buffer[pos + 1] = (byte)b;
buffer[pos + 1] = b;
}
break;
case HeaderSkipOperation.Wordswap:
buffer[3 - pos] = (byte)b;
buffer[3 - pos] = b;
break;
case HeaderSkipOperation.WordByteswap:
buffer[(pos + 2) % 4] = (byte)b;
buffer[(pos + 2) % 4] = b;
break;
case HeaderSkipOperation.None:
default:
buffer[pos] = (byte)b;
buffer[pos] = b;
break;
}
@@ -605,16 +595,18 @@ namespace SabreTools.Helper
if (pos == 0)
{
bw.Write(buffer);
bw.Flush();
buffer = new byte[4];
}
}
// If there's anything more in the buffer, write only the left bits
for (int i = 0; i < pos; i++)
{
bw.Write(buffer[i]);
}
}
}
}
catch (Exception ex)
{
@@ -622,7 +614,20 @@ namespace SabreTools.Helper
return false;
}
return true;
// If the output file has size 0, delete it
if (new FileInfo(output).Length == 0)
{
try
{
File.Delete(output);
}
catch
{
// Don't log this file deletion error
}
}
return success;
}
#endregion
@@ -658,7 +663,7 @@ namespace SabreTools.Helper
XmlDocument doc = new XmlDocument();
try
{
doc.LoadXml(File.ReadAllText(Path.Combine(_skippersPath, skipper + ".xml")));
doc.LoadXml(File.ReadAllText(System.IO.Path.Combine(Path, skipper + ".xml")));
}
catch (XmlException ex)
{
@@ -744,7 +749,6 @@ namespace SabreTools.Helper
}
catch
{
logger.Warning("The mapping for '" + test.ToString() + "' cannot be found!");
continue;
}

13
SimpleSort/SimpleSort.cs
View File

@@ -375,14 +375,15 @@ namespace SabreTools
ArchiveTools.WriteToArchive(input, _outdir, found);
}
// Now get the headerless file if it exists
int hs = 0;
Skippers.GetFileHeaderType(input, out hs, _logger);
if (hs > 0)
// Now get the transformed file if it exists
SkipperRule rule = Skippers.MatchesSkipper(input, "", _logger);
// If we have have a non-empty rule, apply it
if (rule.Tests != null && rule.Tests.Count != 0)
{
// Otherwise, apply the rule ot the file
string newinput = input + ".new";
_logger.Log("Creating unheadered file: '" + newinput + "'");
Output.RemoveBytesFromFile(input, newinput, hs, 0);
Skippers.TransformFile(input, input + ".new", rule, _logger);
Rom drom = RomTools.GetSingleFileInfo(newinput);
// If we have a blank RomData, it's an error