blte 0.4.3

BLTE (Block Table Encoded) compression/decompression for World of Warcraft CASC files
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
//! BLTE decompression implementation
//!
//! Handles all BLTE compression modes including encryption support.

use byteorder::{LittleEndian, ReadBytesExt};
use flate2::read::ZlibDecoder;
use std::io::{Cursor, Read};
use tracing::{debug, trace};

#[allow(deprecated)]
use crate::memory_pool::{PooledBufferGuard, global_pool};
use crate::{BLTEFile, CompressionMode, Error, Result};
#[allow(deprecated)]
use ngdp_crypto::{KeyService, arc4::decrypt_arc4, salsa20::decrypt_salsa20};

/// Decompress a complete BLTE file
pub fn decompress_blte(data: Vec<u8>, key_service: Option<&KeyService>) -> Result<Vec<u8>> {
    decompress_blte_pooled(data, key_service, None)
}

/// Decompress a complete BLTE file using memory pooling
pub fn decompress_blte_pooled(
    data: Vec<u8>,
    key_service: Option<&KeyService>,
    pool: Option<&crate::BLTEMemoryPool>,
) -> Result<Vec<u8>> {
    let blte_file = BLTEFile::parse(data)?;

    debug!(
        "Decompressing BLTE file with {} chunks (pooled={})",
        blte_file.chunk_count(),
        pool.is_some()
    );

    // Estimate total decompressed size for better buffer allocation
    let estimated_size = estimate_decompressed_size(&blte_file);

    let pool = pool.unwrap_or_else(|| global_pool());
    let mut result_guard = PooledBufferGuard::new(pool.get_buffer(estimated_size), pool.clone());
    let result_vec = result_guard.buffer_mut().as_mut_vec();

    for chunk_index in 0..blte_file.chunk_count() {
        let chunk = blte_file.get_chunk_data(chunk_index)?;

        // Verify checksum if present (skip for zero checksum)
        if !chunk.verify_checksum() {
            return Err(Error::ChecksumMismatch {
                expected: hex::encode(chunk.checksum),
                actual: hex::encode(md5::compute(&chunk.data).0),
            });
        }

        let decompressed =
            decompress_chunk_pooled(&chunk.data, chunk_index, key_service, Some(pool))?;
        result_vec.extend_from_slice(&decompressed);
    }

    // Clone the result and let the buffer return to pool automatically
    let result = result_vec.clone();
    Ok(result)
}

/// Estimate decompressed size for better buffer pre-allocation
fn estimate_decompressed_size(blte_file: &BLTEFile) -> usize {
    if blte_file.is_single_chunk() {
        // For single chunk, estimate based on common compression ratios
        blte_file.data.len() * 3 // Conservative estimate for compressed data
    } else {
        // For multi-chunk, sum up the decompressed sizes
        blte_file
            .header
            .chunks
            .iter()
            .map(|chunk| chunk.decompressed_size as usize)
            .sum::<usize>()
            .max(blte_file.data.len()) // Ensure we have at least the compressed size
    }
}

/// Decompress a single chunk
pub fn decompress_chunk(
    data: &[u8],
    block_index: usize,
    key_service: Option<&KeyService>,
) -> Result<Vec<u8>> {
    decompress_chunk_pooled(data, block_index, key_service, None)
}

/// Decompress a single chunk using memory pooling
pub fn decompress_chunk_pooled(
    data: &[u8],
    block_index: usize,
    key_service: Option<&KeyService>,
    pool: Option<&crate::BLTEMemoryPool>,
) -> Result<Vec<u8>> {
    if data.is_empty() {
        return Err(Error::TruncatedData {
            expected: 1,
            actual: 0,
        });
    }

    let mode = CompressionMode::from_byte(data[0]).ok_or(Error::UnknownCompressionMode(data[0]))?;

    trace!(
        "Decompressing chunk with mode {:?} (block_index={}, pooled={})",
        mode,
        block_index,
        pool.is_some()
    );

    let pool = pool.unwrap_or_else(|| global_pool());

    #[allow(deprecated)]
    match mode {
        CompressionMode::None => decompress_none_pooled(&data[1..], pool),
        CompressionMode::ZLib => decompress_zlib_pooled(&data[1..], pool),
        CompressionMode::LZ4 => decompress_lz4_pooled(&data[1..], pool),
        CompressionMode::Frame => decompress_frame_pooled(&data[1..], key_service, pool),
        CompressionMode::Encrypted => {
            let key_service = key_service.ok_or_else(|| {
                Error::DecompressionFailed("Key service required for encrypted blocks".to_string())
            })?;
            decompress_encrypted_pooled(&data[1..], block_index, key_service, pool)
        }
    }
}

/// Mode 'N' - No compression
#[allow(dead_code)]
fn decompress_none(data: &[u8]) -> Result<Vec<u8>> {
    decompress_none_pooled(data, global_pool())
}

/// Mode 'N' - No compression (pooled)
fn decompress_none_pooled(data: &[u8], pool: &crate::BLTEMemoryPool) -> Result<Vec<u8>> {
    trace!(
        "No compression - returning {} bytes as-is (pooled)",
        data.len()
    );

    let mut buffer_guard = PooledBufferGuard::new(pool.get_buffer(data.len()), pool.clone());
    let result_vec = buffer_guard.buffer_mut().as_mut_vec();
    result_vec.extend_from_slice(data);

    let result = result_vec.clone();
    Ok(result)
}

/// Mode 'Z' - ZLib compression
#[allow(dead_code)]
fn decompress_zlib(data: &[u8]) -> Result<Vec<u8>> {
    decompress_zlib_pooled(data, global_pool())
}

/// Mode 'Z' - ZLib compression (pooled)
fn decompress_zlib_pooled(data: &[u8], pool: &crate::BLTEMemoryPool) -> Result<Vec<u8>> {
    trace!("ZLib decompression of {} bytes (pooled)", data.len());

    // Estimate decompressed size (ZLib typically compresses to ~30-70% of original)
    let estimated_size = data.len() * 3; // Conservative estimate

    let mut buffer_guard = PooledBufferGuard::new(pool.get_buffer(estimated_size), pool.clone());
    let result_vec = buffer_guard.buffer_mut().as_mut_vec();

    let mut decoder = ZlibDecoder::new(data);
    decoder
        .read_to_end(result_vec)
        .map_err(|e| Error::DecompressionFailed(format!("ZLib decompression failed: {e}")))?;

    debug!(
        "ZLib: {} bytes -> {} bytes (pooled)",
        data.len(),
        result_vec.len()
    );
    let result = result_vec.clone();
    Ok(result)
}

/// Mode '4' - LZ4 compression
#[allow(dead_code)]
fn decompress_lz4(data: &[u8]) -> Result<Vec<u8>> {
    decompress_lz4_pooled(data, global_pool())
}

/// Mode '4' - LZ4 compression (pooled)
fn decompress_lz4_pooled(data: &[u8], pool: &crate::BLTEMemoryPool) -> Result<Vec<u8>> {
    trace!("LZ4 decompression of {} bytes (pooled)", data.len());

    if data.len() < 8 {
        return Err(Error::TruncatedData {
            expected: 8,
            actual: data.len(),
        });
    }

    let mut cursor = Cursor::new(data);
    let decompressed_size = cursor.read_u32::<LittleEndian>()? as usize;
    let compressed_size = cursor.read_u32::<LittleEndian>()? as usize;

    if compressed_size + 8 != data.len() {
        return Err(Error::DecompressionFailed(format!(
            "LZ4 size mismatch: expected {} bytes, got {}",
            compressed_size + 8,
            data.len()
        )));
    }

    let lz4_data = &data[8..];

    // Use pooled buffer with exact decompressed size
    let mut buffer_guard = PooledBufferGuard::new(pool.get_buffer(decompressed_size), pool.clone());
    let result_vec = buffer_guard.buffer_mut().as_mut_vec();

    // LZ4 decompression directly into our buffer
    let decompressed_data = lz4_flex::decompress(lz4_data, decompressed_size)
        .map_err(|e| Error::DecompressionFailed(format!("LZ4 decompression failed: {e}")))?;

    result_vec.extend_from_slice(&decompressed_data);

    debug!(
        "LZ4: {} bytes -> {} bytes (pooled)",
        data.len(),
        result_vec.len()
    );
    let result = result_vec.clone();
    Ok(result)
}

/// Mode 'F' - Frame/Recursive BLTE
#[allow(dead_code)]
#[allow(deprecated)]
fn decompress_frame(data: &[u8], key_service: Option<&KeyService>) -> Result<Vec<u8>> {
    decompress_frame_pooled(data, key_service, global_pool())
}

/// Mode 'F' - Frame/Recursive BLTE (pooled)
#[allow(deprecated)]
fn decompress_frame_pooled(
    data: &[u8],
    key_service: Option<&KeyService>,
    pool: &crate::BLTEMemoryPool,
) -> Result<Vec<u8>> {
    trace!(
        "Frame/recursive decompression of {} bytes (pooled)",
        data.len()
    );

    // The data contains another complete BLTE structure
    decompress_blte_pooled(data.to_vec(), key_service, Some(pool))
}

/// Mode 'E' - Encrypted
#[allow(dead_code)]
fn decompress_encrypted(
    data: &[u8],
    block_index: usize,
    key_service: &KeyService,
) -> Result<Vec<u8>> {
    decompress_encrypted_pooled(data, block_index, key_service, global_pool())
}

/// Mode 'E' - Encrypted (pooled)
fn decompress_encrypted_pooled(
    data: &[u8],
    block_index: usize,
    key_service: &KeyService,
    pool: &crate::BLTEMemoryPool,
) -> Result<Vec<u8>> {
    trace!(
        "Encrypted decompression of {} bytes (block_index={}, pooled)",
        data.len(),
        block_index
    );

    if data.len() < 17 {
        return Err(Error::InvalidEncryptedBlock(format!(
            "Encrypted block too short: {} bytes (minimum 17)",
            data.len()
        )));
    }

    let mut cursor = Cursor::new(data);

    // Read key name size (should be 8)
    let key_name_size = cursor.read_u64::<LittleEndian>()?;
    if key_name_size != 8 {
        return Err(Error::InvalidEncryptedBlock(format!(
            "Invalid key name size: {key_name_size} (expected 8)"
        )));
    }

    // Read key name (8 bytes, little-endian)
    let key_name = cursor.read_u64::<LittleEndian>()?;

    // Look up the key
    let key = key_service
        .get_key(key_name)
        .ok_or(Error::KeyNotFound(key_name))?;

    // Read IV size (should be 4)
    let iv_size = cursor.read_u32::<LittleEndian>()?;
    if iv_size != 4 {
        return Err(Error::InvalidEncryptedBlock(format!(
            "Invalid IV size: {iv_size} (expected 4)"
        )));
    }

    // Read IV (4 bytes)
    let mut iv = [0u8; 4];
    cursor.read_exact(&mut iv)?;

    // Read encryption type
    let enc_type = cursor.read_u8()?;

    // Get the encrypted data
    let encrypted_data = &data[cursor.position() as usize..];

    debug!(
        "Decrypting block: key_name={:#018x}, enc_type={:#04x}, block_index={} (pooled)",
        key_name, enc_type, block_index
    );

    // Decrypt based on encryption type
    #[allow(deprecated)]
    let decrypted = match enc_type {
        0x53 => {
            // Salsa20
            decrypt_salsa20(encrypted_data, key, &iv, block_index)?
        }
        0x41 => {
            // ARC4
            decrypt_arc4(encrypted_data, key, &iv, block_index)?
        }
        _ => {
            return Err(Error::UnsupportedEncryptionType(enc_type));
        }
    };

    debug!(
        "Decrypted {} bytes -> {} bytes (pooled)",
        encrypted_data.len(),
        decrypted.len()
    );

    // Recursively decompress the decrypted data if it's compressed
    if !decrypted.is_empty() {
        let decrypted_mode = CompressionMode::from_byte(decrypted[0]);
        if decrypted_mode.is_some() && decrypted_mode != Some(CompressionMode::Encrypted) {
            trace!("Recursively decompressing decrypted data (pooled)");
            return decompress_chunk_pooled(&decrypted, block_index, Some(key_service), Some(pool));
        }
    }

    Ok(decrypted)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_decompress_none() {
        let test_data = b"Hello, BLTE!";
        let result = decompress_none(test_data).unwrap();
        assert_eq!(result, test_data);
    }

    #[test]
    fn test_decompress_zlib() {
        // Create some zlib-compressed data
        use flate2::Compression;
        use flate2::write::ZlibEncoder;
        use std::io::Write;

        let original = b"Hello, BLTE! This is a longer string to get better compression.";
        let mut encoder = ZlibEncoder::new(Vec::new(), Compression::default());
        encoder.write_all(original).unwrap();
        let compressed = encoder.finish().unwrap();

        let result = decompress_zlib(&compressed).unwrap();
        assert_eq!(result, original);
    }

    #[test]
    fn test_decompress_lz4() {
        let original = b"Hello, BLTE! This is some test data for LZ4 compression testing.";
        let compressed = lz4_flex::compress(original);

        // Create LZ4 BLTE format: decompressed_size + compressed_size + data
        let mut lz4_data = Vec::new();
        lz4_data.extend_from_slice(&(original.len() as u32).to_le_bytes());
        lz4_data.extend_from_slice(&(compressed.len() as u32).to_le_bytes());
        lz4_data.extend_from_slice(&compressed);

        let result = decompress_lz4(&lz4_data).unwrap();
        assert_eq!(result, original);
    }

    #[test]
    #[allow(deprecated)]
    fn test_compression_mode_from_byte() {
        assert_eq!(
            CompressionMode::from_byte(b'N'),
            Some(CompressionMode::None)
        );
        assert_eq!(
            CompressionMode::from_byte(b'Z'),
            Some(CompressionMode::ZLib)
        );
        assert_eq!(CompressionMode::from_byte(b'4'), Some(CompressionMode::LZ4));
        assert_eq!(
            CompressionMode::from_byte(b'F'),
            Some(CompressionMode::Frame)
        );
        assert_eq!(
            CompressionMode::from_byte(b'E'),
            Some(CompressionMode::Encrypted)
        );
        assert_eq!(CompressionMode::from_byte(b'X'), None);
    }

    #[test]
    fn test_single_chunk_decompression() {
        let mut blte_data = Vec::new();
        blte_data.extend_from_slice(b"BLTE");
        blte_data.extend_from_slice(&0u32.to_be_bytes()); // Single chunk
        blte_data.push(b'N'); // No compression
        blte_data.extend_from_slice(b"Hello, BLTE!");

        let result = decompress_blte(blte_data, None).unwrap();
        assert_eq!(result, b"Hello, BLTE!");
    }

    #[test]
    fn test_multi_chunk_decompression() {
        use flate2::Compression;
        use flate2::write::ZlibEncoder;
        use std::io::Write;

        // Create two compressed chunks
        let chunk1_data = b"Hello, ";
        let chunk2_data = b"BLTE!";

        let mut encoder1 = ZlibEncoder::new(Vec::new(), Compression::default());
        encoder1.write_all(chunk1_data).unwrap();
        let compressed1 = encoder1.finish().unwrap();

        let mut encoder2 = ZlibEncoder::new(Vec::new(), Compression::default());
        encoder2.write_all(chunk2_data).unwrap();
        let compressed2 = encoder2.finish().unwrap();

        // Build chunk data with compression mode prefixes
        let mut chunk1_full = Vec::new();
        chunk1_full.push(b'Z'); // ZLib compression mode
        chunk1_full.extend_from_slice(&compressed1);

        let mut chunk2_full = Vec::new();
        chunk2_full.push(b'Z'); // ZLib compression mode
        chunk2_full.extend_from_slice(&compressed2);

        // Calculate header size (does NOT include magic + header_size field itself)
        let header_size = 1 + 3 + 2 * 24; // flags + chunk_count + 2 * chunk_info = 52

        // Build BLTE file
        let mut blte_data = Vec::new();

        // Header
        blte_data.extend_from_slice(b"BLTE");
        blte_data.extend_from_slice(&(header_size as u32).to_be_bytes());

        // Chunk table
        blte_data.push(0x0F); // Flags
        blte_data.extend_from_slice(&[0x00, 0x00, 0x02]); // 2 chunks

        // Chunk 1 info
        blte_data.extend_from_slice(&(chunk1_full.len() as u32).to_be_bytes());
        blte_data.extend_from_slice(&(chunk1_data.len() as u32).to_be_bytes());
        blte_data.extend_from_slice(&[0; 16]); // Zero checksum to skip verification

        // Chunk 2 info
        blte_data.extend_from_slice(&(chunk2_full.len() as u32).to_be_bytes());
        blte_data.extend_from_slice(&(chunk2_data.len() as u32).to_be_bytes());
        blte_data.extend_from_slice(&[0; 16]); // Zero checksum to skip verification

        // Chunk data
        blte_data.extend_from_slice(&chunk1_full);
        blte_data.extend_from_slice(&chunk2_full);

        let result = decompress_blte(blte_data, None).unwrap();
        assert_eq!(result, b"Hello, BLTE!");
    }
}