using System.IO;
using System.Text;
using SharpCompress.Compressors;
using SharpCompress.Compressors.Deflate;
namespace BinaryObjectScanner.Wrappers
{
public class BFPK : WrapperBase
{
#region Descriptive Properties
///
public override string Description => "BFPK Archive";
#endregion
#region Pass-Through Properties
#region Header
///
public string Magic => _archive.Header.Magic;
///
public int Version => _archive.Header.Version;
///
public int Files => _archive.Header.Files;
#endregion
#region Files
///
public Models.BFPK.FileEntry[] FileTable => _archive.Files;
#endregion
#endregion
#region Instance Variables
///
/// Internal representation of the archive
///
private Models.BFPK.Archive _archive;
#endregion
#region Constructors
///
/// Private constructor
///
private BFPK() { }
///
/// Create a BFPK archive from a byte array and offset
///
/// Byte array representing the archive
/// Offset within the array to parse
/// A BFPK archive wrapper on success, null on failure
public static BFPK Create(byte[] data, int offset)
{
// If the data is invalid
if (data == null)
return null;
// If the offset is out of bounds
if (offset < 0 || offset >= data.Length)
return null;
// Create a memory stream and use that
MemoryStream dataStream = new MemoryStream(data, offset, data.Length - offset);
return Create(dataStream);
}
///
/// Create a BFPK archive from a Stream
///
/// Stream representing the archive
/// A BFPK archive wrapper on success, null on failure
public static BFPK Create(Stream data)
{
// If the data is invalid
if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead)
return null;
var archive = Builders.BFPK.ParseArchive(data);
if (archive == null)
return null;
var wrapper = new BFPK
{
_archive = archive,
_dataSource = DataSource.Stream,
_streamData = data,
};
return wrapper;
}
#endregion
#region Data
///
/// Extract all files from the BFPK to an output directory
///
/// Output directory to write to
/// True if all files extracted, false otherwise
public bool ExtractAll(string outputDirectory)
{
// If we have no files
if (FileTable == null || FileTable.Length == 0)
return false;
// Loop through and extract all files to the output
bool allExtracted = true;
for (int i = 0; i < FileTable.Length; i++)
{
allExtracted &= ExtractFile(i, outputDirectory);
}
return allExtracted;
}
///
/// Extract a file from the BFPK to an output directory by index
///
/// File index to extract
/// Output directory to write to
/// True if the file extracted, false otherwise
public bool ExtractFile(int index, string outputDirectory)
{
// If we have no files
if (Files == 0 || FileTable == null || FileTable.Length == 0)
return false;
// If we have an invalid index
if (index < 0 || index >= FileTable.Length)
return false;
// Get the file information
var file = FileTable[index];
// Get the read index and length
int offset = file.Offset + 4;
int compressedSize = file.CompressedSize;
// Some files can lack the length prefix
if (compressedSize > GetEndOfFile())
{
offset -= 4;
compressedSize = file.UncompressedSize;
}
try
{
// Ensure the output directory exists
Directory.CreateDirectory(outputDirectory);
// Create the output path
string filePath = Path.Combine(outputDirectory, file.Name);
using (FileStream fs = File.OpenWrite(filePath))
{
// Read the data block
byte[] data = ReadFromDataSource(offset, compressedSize);
// If we have uncompressed data
if (compressedSize == file.UncompressedSize)
{
fs.Write(data, 0, compressedSize);
}
else
{
MemoryStream ms = new MemoryStream(data);
ZlibStream zs = new ZlibStream(ms, CompressionMode.Decompress);
zs.CopyTo(fs);
}
}
return true;
}
catch
{
return false;
}
}
#endregion
#region Printing
///
public override StringBuilder PrettyPrint()
{
StringBuilder builder = new StringBuilder();
builder.AppendLine("BFPK Information:");
builder.AppendLine("-------------------------");
builder.AppendLine();
PrintHeader(builder);
PrintFileTable(builder);
return builder;
}
///
/// Print header information
///
/// StringBuilder to append information to
private void PrintHeader(StringBuilder builder)
{
builder.AppendLine(" Header Information:");
builder.AppendLine(" -------------------------");
builder.AppendLine($" Magic: {Magic}");
builder.AppendLine($" Version: {Version} (0x{Version:X})");
builder.AppendLine($" Files: {Files} (0x{Files:X})");
builder.AppendLine();
}
///
/// Print file table information
///
/// StringBuilder to append information to
private void PrintFileTable(StringBuilder builder)
{
builder.AppendLine(" File Table Information:");
builder.AppendLine(" -------------------------");
if (Files == 0 || FileTable == null || FileTable.Length == 0)
{
builder.AppendLine(" No file table items");
}
else
{
for (int i = 0; i < FileTable.Length; i++)
{
var entry = FileTable[i];
builder.AppendLine($" File Table Entry {i}");
builder.AppendLine($" Name size: {entry.NameSize} (0x{entry.NameSize:X})");
builder.AppendLine($" Name: {entry.Name}");
builder.AppendLine($" Uncompressed size: {entry.UncompressedSize} (0x{entry.UncompressedSize:X})");
builder.AppendLine($" Offset: {entry.Offset} (0x{entry.Offset:X})");
builder.AppendLine($" Compressed Size: {entry.CompressedSize} (0x{entry.CompressedSize:X})");
}
}
builder.AppendLine();
}
#if NET6_0_OR_GREATER
///
public override string ExportJSON() => System.Text.Json.JsonSerializer.Serialize(_archive, _jsonSerializerOptions);
#endif
#endregion
}
}