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
use crate::resource::resource_info::ResourceInfo;
use crate::resource::resource_package::ReferenceType::{INSTALL, NORMAL, WEAK};
use binrw::{parser, BinRead, BinReaderExt, BinResult};
use itertools::Itertools;
use lz4::block::decompress_to_buffer;
use memmap2::Mmap;
use modular_bitfield::prelude::*;
use std::collections::HashMap;
use std::fs::File;
use std::io::{Cursor, Read, Seek};
use std::iter::zip;
use std::path::Path;
use std::{fmt, io};
use thiserror::Error;

use crate::resource::runtime_resource_id::RuntimeResourceID;

#[derive(Debug, Error)]
pub enum ResourcePackageError {
    #[error("Error opening the file: {0}")]
    IoError(#[from] io::Error),

    #[error("Couldn't find the requested resource inside of the given resource package")]
    ResourceNotFound,

    #[error("Parsing error: {0}")]
    ParsingError(#[from] binrw::Error),
}

#[allow(dead_code)]
#[derive(BinRead)]
#[br(import(is_patch: bool))]
pub struct ResourcePackage {
    magic: [u8; 4],

    #[br(if (magic == * b"2KPR"))]
    metadata: Option<PackageMetadata>,

    header: PackageHeader,

    #[br(if (is_patch && header.table_offset != 0 && metadata.as_ref().map_or(true, | m | m.patch_id > 0)))]
    unneeded_resource_count: u32,

    #[br(if(is_patch))]
    #[br(little, count = unneeded_resource_count, map = |ids: Vec<u64>| {
    match unneeded_resource_count{
        0 => None,
        _ => Some(ids.into_iter().map(RuntimeResourceID::from).collect::<Vec<_>>()),
    }
    })]
    unneeded_resources: Option<Vec<RuntimeResourceID>>,

    #[br(parse_with = resource_parser, args(header.file_count))]
    resources: HashMap<RuntimeResourceID, ResourceInfo>,
}

#[parser(reader: reader, endian)]
fn resource_parser(file_count: u32) -> BinResult<HashMap<RuntimeResourceID, ResourceInfo>> {
    let mut map = HashMap::new();
    let mut resource_entries = vec![];
    for _ in 0..file_count {
        resource_entries.push(PackageOffsetInfo {
            runtime_resource_id: u64::read_options(reader, endian, ())?.into(),
            data_offset: u64::read_options(reader, endian, ())?,
            compressed_size_and_is_scrambled_flag: u32::read_options(reader, endian, ())?,
        });
    }

    let mut resource_metadata = vec![];
    for _ in 0..file_count {
        resource_metadata.push(ResourceHeader::read_options(reader, endian, ())?);
    }

    let resources = zip(resource_entries, resource_metadata)
        .map(|(entry, header)| ResourceInfo { entry, header })
        .collect::<Vec<ResourceInfo>>();

    for resource in resources {
        map.insert(resource.entry.runtime_resource_id, resource);
    }

    Ok(map)
}

impl ResourcePackage {
    pub fn from_file(package_path: &Path) -> Result<Self, ResourcePackageError> {
        let file = File::open(package_path).map_err(ResourcePackageError::IoError)?;
        let mmap = unsafe { Mmap::map(&file).map_err(ResourcePackageError::IoError)? };
        let mut reader = Cursor::new(&mmap[..]);
        let is_patch = package_path
            .file_name()
            .unwrap()
            .to_str()
            .unwrap()
            .contains("patch");
        reader
            .read_ne_args::<ResourcePackage>((is_patch,))
            .map_err(ResourcePackageError::ParsingError)
    }

    pub fn magic(&self) -> String {
        String::from_utf8_lossy(&self.magic)
            .into_owned()
            .chars()
            .rev()
            .collect()
    }

    pub fn metadata(&self) -> &Option<PackageMetadata> {
        &self.metadata
    }

    pub fn header(&self) -> &PackageHeader {
        &self.header
    }

    pub fn unneeded_resources(&self) -> Vec<RuntimeResourceID> {
        match &self.unneeded_resources {
            None => {
                vec![]
            }
            Some(v) => (*v.clone()).to_vec(),
        }
    }

    pub fn resource_info(&self, rrid: &RuntimeResourceID) -> Option<&ResourceInfo> {
        self.resources.get(rrid)
    }

    pub fn has_resource(&self, rrid: &RuntimeResourceID) -> bool {
        self.resources.contains_key(rrid)
    }

    pub fn removes_resource(&self, rrid: &RuntimeResourceID) -> bool {
        if let Some(unneeded_resources) = &self.unneeded_resources {
            unneeded_resources.contains(rrid)
        } else {
            false
        }
    }

    pub fn read_resource(
        &self,
        package_path: &Path,
        rrid: &RuntimeResourceID,
    ) -> Result<Vec<u8>, ResourcePackageError> {
        let resource = self
            .resources
            .get(rrid)
            .ok_or(ResourcePackageError::ResourceNotFound)?;
        let final_size = resource
            .compressed_size()
            .unwrap_or(resource.header.data_size as usize);

        let is_lz4ed = resource.is_compressed();
        let is_scrambled = resource.is_scrambled();

        // Extract the resource bytes from the resourcePackage
        let mut file = File::open(package_path).map_err(ResourcePackageError::IoError)?;

        file.seek(io::SeekFrom::Start(resource.entry.data_offset))
            .unwrap();

        let mut buffer = vec![0; final_size];
        file.read_exact(&mut buffer).unwrap();

        if is_scrambled {
            let str_xor = [0xdc, 0x45, 0xa6, 0x9c, 0xd3, 0x72, 0x4c, 0xab];
            buffer.iter_mut().enumerate().for_each(|(index, byte)| {
                *byte ^= str_xor[index % str_xor.len()];
            });
        }

        if is_lz4ed {
            let mut file = vec![0; resource.header.data_size as usize];
            let size =
                decompress_to_buffer(&buffer, Some(resource.header.data_size as i32), &mut file)
                    .map_err(ResourcePackageError::IoError)?;

            if size == resource.header.data_size as usize {
                return Ok(file);
            }
        }

        Ok(buffer)
    }

    pub fn resource_ids(&self) -> &HashMap<RuntimeResourceID, ResourceInfo> {
        &self.resources
    }

    pub fn unneeded_resource_ids(&self) -> Vec<&RuntimeResourceID> {
        match &self.unneeded_resources {
            None => {
                vec![]
            }
            Some(val) => val.iter().collect(),
        }
    }
}

#[allow(dead_code)]
#[derive(BinRead)]
pub struct PackageMetadata {
    pub unknown: u32,
    pub chunk_id: u8,
    pub chunk_type: u8,
    pub patch_id: u8,
    pub language_tag: [u8; 2], //this is presumably an unused language code, is always 'xx'
}

#[allow(dead_code)]
#[derive(BinRead)]
pub struct PackageHeader {
    file_count: u32,
    table_offset: u32,
    table_size: u32,
}

#[allow(dead_code)]
#[derive(Copy, Clone)]
pub struct PackageOffsetInfo {
    pub(crate) runtime_resource_id: RuntimeResourceID,
    pub(crate) data_offset: u64,
    pub(crate) compressed_size_and_is_scrambled_flag: u32,
}

impl PackageOffsetInfo {
    pub fn is_scrambled(&self) -> bool {
        self.compressed_size_and_is_scrambled_flag & 0x80000000 == 0x80000000
    }

    pub fn compressed_size(&self) -> Option<usize> {
        match (self.compressed_size_and_is_scrambled_flag & 0x7FFFFFFF) as usize {
            0 => None,
            n => Some(n),
        }
    }
}

#[allow(dead_code)]
#[derive(BinRead, Clone, PartialEq, Eq)]
pub struct ResourceHeader {
    pub(crate) m_type: [u8; 4],
    references_chunk_size: u32,
    states_chunk_size: u32,
    pub(crate) data_size: u32,
    pub(crate) system_memory_requirement: u32,
    pub(crate) video_memory_requirement: u32,

    #[br(if (references_chunk_size > 0), parse_with = read_references)]
    pub references: Vec<(RuntimeResourceID, ResourceReferenceFlags)>,
}

#[derive(Copy, Clone, Eq, PartialEq)]
pub enum ResourceReferenceFlags {
    Legacy(u8),
    Standard(u8),
}

impl ResourceReferenceFlags {
    pub fn language_code(&self) -> u8 {
        match self {
            ResourceReferenceFlags::Legacy(b) => convert_old_flags_to_new_type(b).language_code(),
            ResourceReferenceFlags::Standard(b) => b & 0b0001_1111,
        }
    }

    pub fn is_acquired(&self) -> bool {
        match self {
            ResourceReferenceFlags::Legacy(b) => convert_old_flags_to_new_type(b).is_acquired(),
            ResourceReferenceFlags::Standard(b) => (b & 0b0010_0000) != 0,
        }
    }

    pub fn reference_type(&self) -> ReferenceType {
        match self {
            ResourceReferenceFlags::Legacy(b) => convert_old_flags_to_new_type(b).reference_type(),
            ResourceReferenceFlags::Standard(b) => match b & 0b1100_0000 {
                0 => INSTALL,
                1 => NORMAL,
                2 => WEAK,
                _ => NORMAL,
            },
        }
    }

    pub fn new(reference_type: ReferenceType, acquired: bool) -> Self {
        ResourceReferenceFlags::Standard(
            0x1f | ((acquired as u8) << 0x5) | ((reference_type as u8) << 0x6),
        )
    }
}

#[allow(dead_code)]
#[derive(BitfieldSpecifier, Debug)]
#[bits = 2]
pub enum ReferenceType {
    INSTALL = 0,
    NORMAL = 1,
    WEAK = 2,
}

fn convert_old_flags_to_new_type(old_flags: &u8) -> ResourceReferenceFlags {
    ResourceReferenceFlags::new(
        match old_flags {
            _ if (old_flags & 0x44) != 0 => WEAK,
            _ if !old_flags >> 7 == 1 => INSTALL,
            _ => NORMAL,
        },
        (old_flags & 2) == 2,
    )
}

#[parser(reader)]
fn read_references() -> BinResult<Vec<(RuntimeResourceID, ResourceReferenceFlags)>> {
    let reference_count_and_flag = u32::read_le(reader)?;
    let reference_count = reference_count_and_flag & 0x3FFFFFFF;
    let is_new_format = reference_count_and_flag & 0x40000000 == 0x40000000;

    let arrays = if is_new_format {
        let flags: Vec<ResourceReferenceFlags> = (0..reference_count)
            .map(|_| u8::read_le(reader))
            .map_ok(ResourceReferenceFlags::Standard)
            .collect::<BinResult<Vec<_>>>()?;
        let rrids: Vec<RuntimeResourceID> = (0..reference_count)
            .map(|_| u64::read_le(reader))
            .map_ok(RuntimeResourceID::from)
            .collect::<BinResult<Vec<_>>>()?;
        (rrids, flags)
    } else {
        let rrids: Vec<RuntimeResourceID> = (0..reference_count)
            .map(|_| u64::read_le(reader))
            .map_ok(RuntimeResourceID::from)
            .collect::<BinResult<Vec<_>>>()?;
        let flags: Vec<ResourceReferenceFlags> = (0..reference_count)
            .map(|_| u8::read_le(reader))
            .map_ok(ResourceReferenceFlags::Legacy)
            .collect::<BinResult<Vec<_>>>()?;
        (rrids, flags)
    };

    Ok(arrays.0.into_iter().zip(arrays.1).collect::<Vec<(_, _)>>())
}

impl fmt::Display for PackageOffsetInfo {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            "resource {} is {} bytes at {}",
            self.runtime_resource_id.to_hex_string(),
            self.compressed_size_and_is_scrambled_flag & 0x3FFFFFFF,
            self.data_offset
        )
    }
}

impl fmt::Display for ResourceHeader {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let mut res_type = self.m_type;
        res_type.reverse();
        write!(
            f,
            "type: {}, reference_num: {}, size: {}, num_reqs: ({} {})",
            std::str::from_utf8(&res_type).unwrap(),
            self.references_chunk_size,
            self.data_size,
            self.system_memory_requirement,
            self.video_memory_requirement
        )
    }
}