[Headerer] Bring Headerer up to internal spec

This commit is contained in:
Matt Nadareski
2016-06-17 11:47:30 -07:00
parent f6bcfafe0b
commit 18ce3860d0
2 changed files with 137 additions and 55 deletions

View File

@@ -9,11 +9,29 @@ namespace SabreTools
/// <summary> /// <summary>
/// Entry class for the Deheader application /// Entry class for the Deheader application
/// </summary> /// </summary>
class Headerer public class Headerer
{ {
// Private instance variables
private string _input;
private bool _flag;
private Logger _logger;
// Private required variables
private static string _dbName = "Headerer.sqlite"; private static string _dbName = "Headerer.sqlite";
private static string _connectionString = "Data Source=" + _dbName + ";Version = 3;"; private static string _connectionString = "Data Source=" + _dbName + ";Version = 3;";
private static Logger logger;
/// <summary>
/// Create a new Headerer object
/// </summary>
/// <param name="input">Input file or folder name</param>
/// <param name="flag">True if we're extracting headers (default), false if we're replacing them</param>
/// <param name="logger">Logger object for file and console output</param>
public Headerer(string input, bool flag, Logger logger)
{
_input = input;
_flag = flag;
_logger = logger;
}
/// <summary> /// <summary>
/// Start deheader operation with supplied parameters /// Start deheader operation with supplied parameters
@@ -28,7 +46,7 @@ namespace SabreTools
} }
// Perform initial setup and verification // Perform initial setup and verification
logger = new Logger(true, "headerer.log"); Logger logger = new Logger(true, "headerer.log");
logger.Start(); logger.Start();
DBTools.EnsureDatabase(_dbName, _connectionString); DBTools.EnsureDatabase(_dbName, _connectionString);
@@ -39,7 +57,8 @@ namespace SabreTools
return; return;
} }
if (args.Length == 0 || args.Length > 2) // If we have no arguments, show the help
if (args.Length == 0)
{ {
Build.Help(); Build.Help();
logger.Close(); logger.Close();
@@ -50,38 +69,107 @@ namespace SabreTools
Build.Start("Headerer"); Build.Start("Headerer");
// Get the filename (or foldername) // Get the filename (or foldername)
string file = ""; string input = "";
bool deheader = true; bool help = false,
if (args.Length == 1) flag = true,
headerer = true;
foreach (string arg in args)
{ {
file = args[0]; string temparg = arg.Replace("\"", "").Replace("file://", "");
switch (temparg)
{
case "-?":
case "-h":
case "--help":
help = true;
break;
case "-e":
case "--extract":
flag = true;
break;
case "-r":
case "--replace":
flag = false;
break;
default:
if (File.Exists(temparg) || Directory.Exists(temparg))
{
input = temparg;
}
else
{
logger.Error("Invalid input detected: " + arg);
Console.WriteLine();
Build.Help();
logger.Close();
return;
}
break;
}
} }
// If help is set, show the help screen
if (help)
{
Build.Help();
logger.Close();
return;
}
// If a switch that requires a filename is set and no file is, show the help screen
if (String.IsNullOrEmpty(input) && (headerer))
{
logger.Error("This feature requires at exactly one input");
Build.Help();
logger.Close();
return;
}
// If we're in headerer mode
if (headerer)
{
InitHeaderer(input, flag, logger);
}
// If nothing is set, show the help
else else
{ {
Build.Help();
if (args[0] == "-e")
{
deheader = true;
}
else if (args[0] == "-r")
{
deheader = false;
}
file = args[1];
} }
if (deheader) logger.Close();
return;
}
/// <summary>
/// Wrap extracting and replacing headers
/// </summary>
/// <param name="input">Input file or folder name</param>
/// <param name="flag">True if we're extracting headers (default), false if we're replacing them</param>
/// <param name="logger">Logger object for file and console output</param>
private static void InitHeaderer(string input, bool flag, Logger logger)
{
Headerer headerer = new Headerer(input, flag, logger);
headerer.Process();
}
/// <summary>
/// Extract and remove or replace headers
/// </summary>
/// <returns>True if it succeeded, false otherwise</returns>
public bool Process()
{
if (_flag)
{ {
// If it's a single file, just check it // If it's a single file, just check it
if (File.Exists(file)) if (File.Exists(_input))
{ {
DetectSkipperAndTransform(file); DetectSkipperAndTransform(_input);
} }
// If it's a directory, recursively check all // If it's a directory, recursively check all
else if (Directory.Exists(file)) else if (Directory.Exists(_input))
{ {
foreach (string sub in Directory.GetFiles(file)) foreach (string sub in Directory.EnumerateFiles(_input, "*", SearchOption.AllDirectories))
{ {
if (sub != ".." && sub != ".") if (sub != ".." && sub != ".")
{ {
@@ -89,23 +177,18 @@ namespace SabreTools
} }
} }
} }
// Else, show that help text
else
{
Build.Help();
}
} }
else else
{ {
// If it's a single file, just check it // If it's a single file, just check it
if (File.Exists(file)) if (File.Exists(_input))
{ {
ReplaceHeader(file); ReplaceHeader(_input);
} }
// If it's a directory, recursively check all // If it's a directory, recursively check all
else if (Directory.Exists(file)) else if (Directory.Exists(_input))
{ {
foreach (string sub in Directory.GetFiles(file)) foreach (string sub in Directory.GetFiles(_input))
{ {
if (sub != ".." && sub != ".") if (sub != ".." && sub != ".")
{ {
@@ -113,13 +196,9 @@ namespace SabreTools
} }
} }
} }
// Else, show that help text
else
{
Build.Help();
}
} }
logger.Close();
return true;
} }
/// <summary> /// <summary>
@@ -127,19 +206,19 @@ namespace SabreTools
/// </summary> /// </summary>
/// <param name="file">Name of the file to be parsed</param> /// <param name="file">Name of the file to be parsed</param>
/// <returns>True if the output file was created, false otherwise</returns> /// <returns>True if the output file was created, false otherwise</returns>
private static bool DetectSkipperAndTransform(string file) public bool DetectSkipperAndTransform(string file)
{ {
logger.User("\nGetting skipper information for '" + file + "'"); _logger.User("\nGetting skipper information for '" + file + "'");
// Then, if the file was headered, store it to the database // Then, if the file was headered, store it to the database
int headerSize = -1; int headerSize = -1;
HeaderType type = Skippers.GetFileHeaderType(file, out headerSize, logger); HeaderType type = Skippers.GetFileHeaderType(file, out headerSize, _logger);
// If we have a valid HeaderType, remove the correct byte count // If we have a valid HeaderType, remove the correct byte count
logger.User("File has header: " + (type != HeaderType.None)); _logger.User("File has header: " + (type != HeaderType.None));
if (type != HeaderType.None) if (type != HeaderType.None)
{ {
logger.Log("Deteched header type: " + type); _logger.Log("Deteched header type: " + type);
// Now take care of the header and new output file // Now take care of the header and new output file
string hstr = string.Empty; string hstr = string.Empty;
@@ -154,7 +233,7 @@ namespace SabreTools
} }
// Then find an apply the exact rule to the file // Then find an apply the exact rule to the file
SkipperRule rule = Skippers.MatchesSkipper(file, "", logger); SkipperRule rule = Skippers.MatchesSkipper(file, "", _logger);
// If we have an empty rule, return false // If we have an empty rule, return false
if (rule.Tests == null || rule.Tests.Count == 0) if (rule.Tests == null || rule.Tests.Count == 0)
@@ -163,7 +242,7 @@ namespace SabreTools
} }
// Otherwise, apply the rule ot the file // Otherwise, apply the rule ot the file
Skippers.TransformFile(file, file + ".new", rule, logger); Skippers.TransformFile(file, file + ".new", rule, _logger);
// If the output file doesn't exist, return false // If the output file doesn't exist, return false
if (!File.Exists(file + ".new")) if (!File.Exists(file + ".new"))
@@ -185,7 +264,7 @@ namespace SabreTools
/// <param name="header">String representing the header bytes</param> /// <param name="header">String representing the header bytes</param>
/// <param name="SHA1">SHA-1 of the deheadered file</param> /// <param name="SHA1">SHA-1 of the deheadered file</param>
/// <param name="type">HeaderType representing the detected header</param> /// <param name="type">HeaderType representing the detected header</param>
private static void AddHeaderToDatabase(string header, string SHA1, HeaderType type) public void AddHeaderToDatabase(string header, string SHA1, HeaderType type)
{ {
bool exists = false; bool exists = false;
@@ -213,7 +292,7 @@ namespace SabreTools
dbc.Open(); dbc.Open();
using (SqliteCommand slc = new SqliteCommand(query, dbc)) using (SqliteCommand slc = new SqliteCommand(query, dbc))
{ {
logger.Log("Result of inserting header: " + slc.ExecuteNonQuery()); _logger.Log("Result of inserting header: " + slc.ExecuteNonQuery());
} }
} }
} }
@@ -223,7 +302,8 @@ namespace SabreTools
/// Detect and replace header(s) to the given file /// Detect and replace header(s) to the given file
/// </summary> /// </summary>
/// <param name="file">Name of the file to be parsed</param> /// <param name="file">Name of the file to be parsed</param>
private static void ReplaceHeader(string file) /// <returns>True if a header was found and appended, false otherwise</returns>
public bool ReplaceHeader(string file)
{ {
// First, get the SHA-1 hash of the file // First, get the SHA-1 hash of the file
Rom rom = RomTools.GetSingleFileInfo(file); Rom rom = RomTools.GetSingleFileInfo(file);
@@ -244,22 +324,24 @@ namespace SabreTools
int sub = 0; int sub = 0;
while (sldr.Read()) while (sldr.Read())
{ {
logger.Log("Found match with rom type " + sldr.GetString(1)); _logger.Log("Found match with rom type " + sldr.GetString(1));
header = sldr.GetString(0); header = sldr.GetString(0);
logger.User("Creating reheadered file: " + file + ".new" + sub); _logger.User("Creating reheadered file: " + file + ".new" + sub);
Output.AppendBytesToFile(file, file + ".new" + sub, header, string.Empty); Output.AppendBytesToFile(file, file + ".new" + sub, header, string.Empty);
logger.User("Reheadered file created!"); _logger.User("Reheadered file created!");
} }
} }
else else
{ {
logger.Warning("No matching header could be found!"); _logger.Warning("No matching header could be found!");
return; return false;
} }
} }
} }
} }
return true;
} }
} }
} }

View File

@@ -162,7 +162,7 @@ namespace SabreTools.Helper
{ {
encounteredErrors = true; encounteredErrors = true;
} }
catch (Exception ex) catch (Exception)
{ {
// Don't log file open errors // Don't log file open errors
encounteredErrors = true; encounteredErrors = true;