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
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
//! BLTE streaming decompression implementation
//!
//! Provides TRUE streaming decompression for BLTE files, reading chunks
//! on-demand without loading the entire file into memory.

use byteorder::{BigEndian, LittleEndian, ReadBytesExt};
use flate2::read::ZlibDecoder;
use std::io::{Cursor, Read, Result as IoResult, Seek, SeekFrom};
use tracing::{debug, trace, warn};

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

/// A true streaming BLTE decompressor
///
/// This decompresses BLTE files chunk by chunk without loading
/// the entire file into memory. Truly memory-efficient for large files.
pub struct BLTEStream<R: Read + Seek> {
    /// The source reader
    reader: R,
    /// BLTE header information
    header: BLTEHeader,
    /// Current chunk being processed
    current_chunk: usize,
    /// Key service for encrypted chunks
    key_service: Option<KeyService>,
    /// Internal buffer for current chunk decompressed data
    chunk_buffer: Vec<u8>,
    /// Position within current chunk buffer
    chunk_position: usize,
    /// Offset where chunk data starts in the source
    data_offset: u64,
}

impl<R: Read + Seek> BLTEStream<R> {
    /// Create a new streaming BLTE decompressor
    ///
    /// # Arguments
    /// * `reader` - The source to read from (must support seeking)
    /// * `key_service` - Optional key service for encrypted chunks
    ///
    /// # Errors
    /// Returns an error if the BLTE header cannot be parsed.
    pub fn new(mut reader: R, key_service: Option<KeyService>) -> Result<Self> {
        // Read and parse just the header
        let mut magic = [0u8; 4];
        reader
            .read_exact(&mut magic)
            .map_err(|e| Error::DecompressionFailed(format!("Failed to read magic: {e}")))?;

        if &magic != b"BLTE" {
            return Err(Error::InvalidHeader(format!(
                "Invalid BLTE magic: {}",
                hex::encode(magic)
            )));
        }

        let header_size = reader
            .read_u32::<BigEndian>()
            .map_err(|e| Error::DecompressionFailed(format!("Failed to read header size: {e}")))?;

        // Calculate data offset (magic + header_size field + actual header)
        let data_offset = 8u64 + header_size as u64;

        // Read the header data if multi-chunk
        let header = if header_size == 0 {
            // Single chunk - no additional header
            BLTEHeader {
                magic,
                header_size,
                chunks: Vec::new(),
            }
        } else {
            // Multi-chunk - read chunk table
            let mut header_data = vec![0u8; header_size as usize];
            reader
                .read_exact(&mut header_data)
                .map_err(|e| Error::DecompressionFailed(format!("Failed to read header: {e}")))?;

            // Parse chunk table from header data
            let mut header_bytes = Vec::with_capacity(8 + header_size as usize);
            header_bytes.extend_from_slice(b"BLTE");
            header_bytes.extend_from_slice(&header_size.to_be_bytes());
            header_bytes.extend_from_slice(&header_data);

            BLTEHeader::parse(&header_bytes)?
        };

        debug!(
            "Created streaming BLTE with {} chunks, data offset: {}",
            header.chunk_count(),
            data_offset
        );

        Ok(Self {
            reader,
            header,
            current_chunk: 0,
            key_service,
            chunk_buffer: Vec::new(),
            chunk_position: 0,
            data_offset,
        })
    }

    /// Get the total number of chunks
    pub fn chunk_count(&self) -> usize {
        self.header.chunk_count()
    }

    /// Get the current chunk index being processed
    pub fn current_chunk_index(&self) -> usize {
        self.current_chunk
    }

    /// Check if we have more chunks to process
    pub fn has_more_chunks(&self) -> bool {
        self.current_chunk < self.header.chunk_count()
    }

    /// Prepare the next chunk for reading
    fn prepare_next_chunk(&mut self) -> Result<()> {
        if !self.has_more_chunks() {
            return Ok(()); // No more chunks
        }

        trace!("Preparing chunk {} for streaming", self.current_chunk);

        // Calculate the offset and size for this chunk
        let (chunk_offset, chunk_size) = if self.header.is_single_chunk() {
            // Single chunk - read from data_offset to end
            (self.data_offset, None)
        } else {
            // Multi-chunk - calculate offset based on previous chunks
            let chunk_info = &self.header.chunks[self.current_chunk];
            let mut offset = self.data_offset;

            // Add sizes of all previous chunks
            for i in 0..self.current_chunk {
                offset += self.header.chunks[i].compressed_size as u64;
            }

            (offset, Some(chunk_info.compressed_size as usize))
        };

        // Seek to chunk position
        self.reader
            .seek(SeekFrom::Start(chunk_offset))
            .map_err(|e| Error::DecompressionFailed(format!("Failed to seek to chunk: {e}")))?;

        // Read the chunk data
        let chunk_data = if let Some(size) = chunk_size {
            // Known size - read exactly that amount
            let mut buffer = vec![0u8; size];
            self.reader
                .read_exact(&mut buffer)
                .map_err(|e| Error::DecompressionFailed(format!("Failed to read chunk: {e}")))?;
            buffer
        } else {
            // Unknown size (single chunk) - read to end
            let mut buffer = Vec::new();
            self.reader.read_to_end(&mut buffer).map_err(|e| {
                Error::DecompressionFailed(format!("Failed to read single chunk: {e}"))
            })?;
            buffer
        };

        // Verify checksum if we have chunk info
        if !self.header.is_single_chunk() {
            let chunk_info = &self.header.chunks[self.current_chunk];
            if chunk_info.checksum != [0u8; 16] {
                let calculated = md5::compute(&chunk_data);
                if calculated.0 != chunk_info.checksum {
                    return Err(Error::ChecksumMismatch {
                        expected: hex::encode(chunk_info.checksum),
                        actual: hex::encode(calculated.0),
                    });
                }
            }
        }

        // Decompress the chunk
        let decompressed =
            decompress_chunk_streaming(&chunk_data, self.current_chunk, self.key_service.as_ref())?;

        self.chunk_buffer = decompressed;
        self.chunk_position = 0;
        self.current_chunk += 1;

        trace!(
            "Prepared chunk {} with {} bytes decompressed",
            self.current_chunk - 1,
            self.chunk_buffer.len()
        );

        Ok(())
    }
}

impl<R: Read + Seek> Read for BLTEStream<R> {
    fn read(&mut self, buf: &mut [u8]) -> IoResult<usize> {
        let mut bytes_read = 0;

        while bytes_read < buf.len() {
            // If we've consumed all data from the current chunk, prepare the next one
            if self.chunk_position >= self.chunk_buffer.len() {
                if !self.has_more_chunks() {
                    break; // No more data
                }

                if let Err(e) = self.prepare_next_chunk() {
                    warn!("Failed to prepare next chunk: {}", e);
                    break;
                }

                if self.chunk_buffer.is_empty() {
                    continue; // This chunk was empty, try the next one
                }
            }

            // Copy data from current chunk buffer
            let available = self.chunk_buffer.len() - self.chunk_position;
            let to_copy = std::cmp::min(available, buf.len() - bytes_read);

            if to_copy == 0 {
                break;
            }

            buf[bytes_read..bytes_read + to_copy].copy_from_slice(
                &self.chunk_buffer[self.chunk_position..self.chunk_position + to_copy],
            );

            self.chunk_position += to_copy;
            bytes_read += to_copy;
        }

        Ok(bytes_read)
    }
}

/// Create a streaming reader from any Read + Seek source
///
/// This is a convenience function that creates a BLTEStream for immediate use.
pub fn create_streaming_reader<R: Read + Seek>(
    reader: R,
    key_service: Option<KeyService>,
) -> Result<BLTEStream<R>> {
    BLTEStream::new(reader, key_service)
}

/// Decompress a single chunk for streaming (internal function)
fn decompress_chunk_streaming(
    data: &[u8],
    block_index: usize,
    key_service: Option<&KeyService>,
) -> 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 streaming chunk with mode {:?} (block_index={})",
        mode, block_index
    );

    #[allow(deprecated)]
    match mode {
        CompressionMode::None => decompress_none_streaming(&data[1..]),
        CompressionMode::ZLib => decompress_zlib_streaming(&data[1..]),
        CompressionMode::LZ4 => decompress_lz4_streaming(&data[1..]),
        CompressionMode::Frame => decompress_frame_streaming(&data[1..], key_service),
        CompressionMode::Encrypted => {
            let key_service = key_service.ok_or_else(|| {
                Error::DecompressionFailed("Key service required for encrypted blocks".to_string())
            })?;
            decompress_encrypted_streaming(&data[1..], block_index, key_service)
        }
    }
}

/// Mode 'N' - No compression (streaming)
fn decompress_none_streaming(data: &[u8]) -> Result<Vec<u8>> {
    trace!(
        "No compression (streaming) - returning {} bytes as-is",
        data.len()
    );
    Ok(data.to_vec())
}

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

    let mut decoder = ZlibDecoder::new(data);
    let mut result = Vec::new();

    decoder
        .read_to_end(&mut result)
        .map_err(|e| Error::DecompressionFailed(format!("ZLib decompression failed: {e}")))?;

    debug!(
        "ZLib (streaming): {} bytes -> {} bytes",
        data.len(),
        result.len()
    );
    Ok(result)
}

/// Mode '4' - LZ4 compression (streaming)
fn decompress_lz4_streaming(data: &[u8]) -> Result<Vec<u8>> {
    trace!("LZ4 decompression (streaming) of {} bytes", 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..];
    let result = lz4_flex::decompress(lz4_data, decompressed_size)
        .map_err(|e| Error::DecompressionFailed(format!("LZ4 decompression failed: {e}")))?;

    debug!(
        "LZ4 (streaming): {} bytes -> {} bytes",
        data.len(),
        result.len()
    );
    Ok(result)
}

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

    // For now, fall back to the regular decompression for nested BLTE frames
    // This avoids the KeyService cloning issue but still works correctly
    crate::decompress::decompress_blte(data.to_vec(), key_service)
}

/// Mode 'E' - Encrypted (streaming)
fn decompress_encrypted_streaming(
    data: &[u8],
    block_index: usize,
    key_service: &KeyService,
) -> Result<Vec<u8>> {
    trace!(
        "Encrypted decompression (streaming) of {} bytes (block_index={})",
        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 (streaming): key_name={:#018x}, enc_type={:#04x}, block_index={}",
        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 (streaming) {} bytes -> {} bytes",
        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 (streaming)");
            return decompress_chunk_streaming(&decrypted, block_index, Some(key_service));
        }
    }

    Ok(decrypted)
}

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

    #[test]
    fn test_streaming_single_chunk() {
        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 Streaming!");

        let cursor = Cursor::new(blte_data);
        let mut stream = BLTEStream::new(cursor, None).unwrap();
        let mut result = String::new();
        stream.read_to_string(&mut result).unwrap();

        assert_eq!(result, "Hello, BLTE Streaming!");
    }

    #[test]
    fn test_streaming_multi_chunk() {
        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 Streaming!";

        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 cursor = Cursor::new(blte_data);
        let mut stream = BLTEStream::new(cursor, None).unwrap();
        let mut result = String::new();
        stream.read_to_string(&mut result).unwrap();

        assert_eq!(result, "Hello, BLTE Streaming!");
    }

    #[test]
    fn test_streaming_chunk_by_chunk_read() {
        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 cursor = Cursor::new(blte_data);
        let mut stream = BLTEStream::new(cursor, None).unwrap();

        // Read in small chunks
        let mut result = Vec::new();
        let mut buffer = [0u8; 4];

        loop {
            let bytes_read = stream.read(&mut buffer).unwrap();
            if bytes_read == 0 {
                break;
            }
            result.extend_from_slice(&buffer[..bytes_read]);
        }

        assert_eq!(String::from_utf8(result).unwrap(), "Hello, BLTE!");
    }

    #[test]
    fn test_create_streaming_reader() {
        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, Reader!");

        let cursor = Cursor::new(blte_data);
        let mut reader = create_streaming_reader(cursor, None).unwrap();
        let mut result = String::new();
        reader.read_to_string(&mut result).unwrap();

        assert_eq!(result, "Hello, Reader!");
    }
}