Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds support for compressed CSMAN files #749

Merged
merged 1 commit into from
Nov 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ threadpool = "1.8.1"
serde_json = "1.0"
env_logger = "0.11.5"
flate2 = "1.0.34"
miniz_oxide = "0.8.0"
aho-corasick = "1.1.3"
serde = { version = "1.0", features = ["derive"]}
clap = { version = "4.5.16", features = ["derive"] }
Expand Down
22 changes: 21 additions & 1 deletion src/extractors/csman.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
use crate::common::is_offset_safe;
use crate::extractors::common::{Chroot, ExtractionResult, Extractor, ExtractorType};
use crate::structures::csman::{parse_csman_entry, parse_csman_header, CSManEntry};
use miniz_oxide::inflate;
use std::collections::HashMap;

/// Defines the internal extractor function for CSMan DAT files
Expand Down Expand Up @@ -38,6 +39,8 @@ pub fn extract_csman_dat(
offset: usize,
output_directory: Option<&String>,
) -> ExtractionResult {
const COMPRESSED_HEADER_SIZE: usize = 2;

// Return value
let mut result = ExtractionResult {
..Default::default()
Expand All @@ -47,12 +50,29 @@ pub fn extract_csman_dat(

// Parse the CSMAN header
if let Ok(csman_header) = parse_csman_header(&file_data[offset..]) {
println!("{:?}", csman_header);
// Calulate the start and end offsets of the CSMAN entries
let entries_start: usize = offset + csman_header.header_size;
let entries_end: usize = entries_start + csman_header.data_size;

// Get the CSMAN entry data
if let Some(entry_data) = file_data.get(entries_start..entries_end) {
if let Some(raw_entry_data) = file_data.get(entries_start..entries_end) {
let mut entry_data = raw_entry_data.to_vec();

// If the entries are compressed, decompress it (zlib compression)
if csman_header.compressed {
if let Some(compressed_data) = raw_entry_data.get(COMPRESSED_HEADER_SIZE..) {
match inflate::decompress_to_vec(compressed_data) {
Err(_) => {
return result;
}
Ok(decompressed_data) => {
entry_data = decompressed_data.clone();
}
}
}
}

// Offsets for processing CSMAN entries in entry_data
let mut next_offset: usize = 0;
let mut previous_offset = None;
Expand Down
28 changes: 21 additions & 7 deletions src/structures/csman.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,23 @@ use crate::structures::common::{self, StructureError};
/// Struct to store CSMAN header info
#[derive(Debug, Default, Clone)]
pub struct CSManHeader {
pub compressed: bool,
pub data_size: usize,
pub endianness: String,
pub header_size: usize,
}

/// Parses a CSMAN header
pub fn parse_csman_header(csman_data: &[u8]) -> Result<CSManHeader, StructureError> {
const COMPRESSED_MAGIC: &[u8] = b"\x78";
const LITTLE_ENDIAN_MAGIC: usize = 0x4353;

let csman_header_structure = vec![
("magic", "u16"),
("unknown1", "u16"),
("data_size_1", "u32"),
("compressed_size", "u32"),
("unknown2", "u32"),
("data_size_2", "u32"),
("decompressed_size", "u32"),
];

let mut result = CSManHeader {
Expand All @@ -39,12 +41,24 @@ pub fn parse_csman_header(csman_data: &[u8]) -> Result<CSManHeader, StructureErr
result.endianness = "big".to_string();
}

// Data size is repeated in both these fields
if !result.endianness.is_empty()
&& csman_header["data_size_1"] == csman_header["data_size_2"]
{
result.data_size = csman_header["data_size_1"];
// Should have been able to determine the endianness
if !result.endianness.is_empty() {
result.data_size = csman_header["compressed_size"];
result.header_size = common::size(&csman_header_structure);
result.compressed =
csman_header["compressed_size"] != csman_header["decompressed_size"];

// If compressed, check the expected compressed magic bytes
if result.compressed {
if let Some(compressed_magic) =
csman_data.get(result.header_size..result.header_size + COMPRESSED_MAGIC.len())
{
if compressed_magic != COMPRESSED_MAGIC {
return Err(StructureError);
}
}
}

return Ok(result);
}
}
Expand Down