msg_tool 0.3.1

A command-line tool for exporting, importing, packing, and unpacking script 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
//! Yaneurao Itufuru Archive File (.scd)
use crate::ext::io::*;
use crate::scripts::base::*;
use crate::types::*;
use crate::utils::encoding::encode_string;
use crate::utils::struct_pack::*;
use crate::utils::xored_stream::XoredStream as Crypto;
use anyhow::Result;
use msg_tool_macro::*;
use std::collections::HashMap;
use std::io::{Read, Seek, SeekFrom, Write};
use std::sync::{Arc, Mutex};

#[derive(Debug)]
/// Yaneurao Itufuru Archive Builder
pub struct ItufuruArchiveBuilder {}

impl ItufuruArchiveBuilder {
    /// Creates a new instance of `ItufuruArchiveBuilder`
    pub const fn new() -> Self {
        ItufuruArchiveBuilder {}
    }
}

impl ScriptBuilder for ItufuruArchiveBuilder {
    fn default_encoding(&self) -> Encoding {
        Encoding::Cp932
    }

    fn default_archive_encoding(&self) -> Option<Encoding> {
        Some(Encoding::Cp932)
    }

    fn build_script(
        &self,
        data: Vec<u8>,
        _filename: &str,
        _encoding: Encoding,
        archive_encoding: Encoding,
        config: &ExtraConfig,
        _archive: Option<&Box<dyn Script>>,
    ) -> Result<Box<dyn Script>> {
        Ok(Box::new(ItufuruArchive::new(
            MemReader::new(data),
            archive_encoding,
            config,
        )?))
    }

    fn build_script_from_file(
        &self,
        filename: &str,
        _encoding: Encoding,
        archive_encoding: Encoding,
        config: &ExtraConfig,
        _archive: Option<&Box<dyn Script>>,
    ) -> Result<Box<dyn Script>> {
        if filename == "-" {
            let data = crate::utils::files::read_file(filename)?;
            Ok(Box::new(ItufuruArchive::new(
                MemReader::new(data),
                archive_encoding,
                config,
            )?))
        } else {
            let f = std::fs::File::open(filename)?;
            let reader = std::io::BufReader::new(f);
            Ok(Box::new(ItufuruArchive::new(
                reader,
                archive_encoding,
                config,
            )?))
        }
    }

    fn build_script_from_reader(
        &self,
        reader: Box<dyn ReadSeek>,
        _filename: &str,
        _encoding: Encoding,
        archive_encoding: Encoding,
        config: &ExtraConfig,
        _archive: Option<&Box<dyn Script>>,
    ) -> Result<Box<dyn Script>> {
        Ok(Box::new(ItufuruArchive::new(
            reader,
            archive_encoding,
            config,
        )?))
    }

    fn extensions(&self) -> &'static [&'static str] {
        &["scd"]
    }

    fn is_this_format(&self, _filename: &str, buf: &[u8], buf_len: usize) -> Option<u8> {
        if buf_len >= 4 && buf.starts_with(b"SCR\0") {
            Some(1)
        } else {
            None
        }
    }

    fn script_type(&self) -> &'static ScriptType {
        &ScriptType::YaneuraoItufuruArc
    }

    fn is_archive(&self) -> bool {
        true
    }

    fn create_archive(
        &self,
        filename: &str,
        files: &[&str],
        encoding: Encoding,
        config: &ExtraConfig,
    ) -> Result<Box<dyn Archive>> {
        let f = std::fs::File::create(filename)?;
        let writer = std::io::BufWriter::new(f);
        let archive = ItufuruArchiveWriter::new(writer, files, encoding, config)?;
        Ok(Box::new(archive))
    }
}

#[derive(Debug, StructPack, StructUnpack)]
struct ItufuruFileHeader {
    #[fstring = 12]
    file_name: String,
    offset: u32,
}

#[derive(Debug, StructPack)]
struct CustomHeader {
    #[fstring = 12]
    file_name: String,
    offset: u32,
    #[skip_pack]
    size: u32,
}

struct Entry {
    name: String,
    data: MemReader,
}

impl Read for Entry {
    fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
        self.data.read(buf)
    }
}

impl ArchiveContent for Entry {
    fn name(&self) -> &str {
        &self.name
    }

    fn script_type(&self) -> Option<&ScriptType> {
        Some(&ScriptType::YaneuraoItufuru)
    }

    fn data(&mut self) -> Result<Vec<u8>> {
        Ok(self.data.data.clone())
    }

    fn to_data<'a>(&'a mut self) -> Result<Box<dyn ReadSeek + 'a>> {
        Ok(Box::new(&mut self.data))
    }
}

#[derive(Debug)]
/// Yaneurao Itufuru Archive Script
pub struct ItufuruArchive<T: Read + Seek + std::fmt::Debug> {
    reader: Arc<Mutex<Crypto<T>>>,
    first_file_offset: u32,
    files: Vec<CustomHeader>,
}

impl<T: Read + Seek + std::fmt::Debug> ItufuruArchive<T> {
    /// Creates a new `ItufuruArchive`
    ///
    /// * `reader` - The reader to read the archive data from
    /// * `archive_encoding` - The encoding used for the archive
    /// * `config` - Extra configuration options
    pub fn new(mut reader: T, archive_encoding: Encoding, _config: &ExtraConfig) -> Result<Self> {
        let mut header = [0u8; 4];
        reader.read_exact(&mut header)?;
        if &header != b"SCR\0" {
            return Err(anyhow::anyhow!("Invalid Itufuru archive header"));
        }
        let file_count = reader.read_u32()?;
        let first_file_offset = reader.read_u32()?;
        reader.read_u32()?; // Skip unused field
        let mut reader = Crypto::new(reader, 0xA5);
        let mut tfiles = Vec::with_capacity(file_count as usize);
        for _ in 0..file_count {
            let file = ItufuruFileHeader::unpack(&mut reader, false, archive_encoding, &None)?;
            tfiles.push(file);
        }
        let mut files = Vec::with_capacity(tfiles.len());
        if !tfiles.is_empty() {
            for i in 0..tfiles.len() - 1 {
                let file = CustomHeader {
                    file_name: tfiles[i].file_name.clone(),
                    offset: tfiles[i].offset,
                    size: tfiles[i + 1].offset - tfiles[i].offset,
                };
                files.push(file);
            }
            let last_file = &tfiles[tfiles.len() - 1];
            let file = CustomHeader {
                file_name: last_file.file_name.clone(),
                offset: last_file.offset,
                size: reader.seek(SeekFrom::End(0))? as u32 - last_file.offset - first_file_offset,
            };
            files.push(file);
        }
        Ok(ItufuruArchive {
            reader: Arc::new(Mutex::new(reader)),
            first_file_offset,
            files,
        })
    }
}

impl<T: Read + Seek + std::fmt::Debug + std::any::Any> Script for ItufuruArchive<T> {
    fn default_output_script_type(&self) -> OutputScriptType {
        OutputScriptType::Json
    }

    fn default_format_type(&self) -> FormatOptions {
        FormatOptions::None
    }

    fn is_archive(&self) -> bool {
        true
    }

    fn iter_archive_filename<'a>(
        &'a self,
    ) -> Result<Box<dyn Iterator<Item = Result<String>> + 'a>> {
        Ok(Box::new(
            self.files.iter().map(|s| Ok(s.file_name.to_owned())),
        ))
    }

    fn iter_archive_offset<'a>(&'a self) -> Result<Box<dyn Iterator<Item = Result<u64>> + 'a>> {
        Ok(Box::new(self.files.iter().map(|s| Ok(s.offset as u64))))
    }

    fn open_file<'a>(&'a self, index: usize) -> Result<Box<dyn ArchiveContent + 'a>> {
        if index >= self.files.len() {
            return Err(anyhow::anyhow!(
                "Index out of bounds: {} (max: {})",
                index,
                self.files.len()
            ));
        }
        let entry = &self.files[index];
        let file_offset = entry.offset as u64;
        match self.reader.cpeek_exact_at_vec(
            file_offset + self.first_file_offset as u64,
            entry.size as usize,
        ) {
            Ok(data) => {
                let name = entry.file_name.clone();
                Ok(Box::new(Entry {
                    name,
                    data: MemReader::new(data),
                }))
            }
            Err(e) => Err(anyhow::anyhow!(
                "Failed to read file {}: {}",
                entry.file_name,
                e
            )),
        }
    }
}

/// Archive Writer for Itufuru Archive
pub struct ItufuruArchiveWriter<T: Write + Seek> {
    writer: T,
    headers: HashMap<String, CustomHeader>,
    first_file_offset: u32,
    encoding: Encoding,
}

impl<T: Write + Seek> ItufuruArchiveWriter<T> {
    /// Creates a new `ItufuruArchiveWriter`
    ///
    /// * `writer` - The writer to write the archive data to
    /// * `files` - List of file names to include in the archive
    /// * `encoding` - The encoding used for the archive
    /// * `config` - Extra configuration options
    pub fn new(
        mut writer: T,
        files: &[&str],
        encoding: Encoding,
        _config: &ExtraConfig,
    ) -> Result<Self> {
        writer.write_all(b"SCR\0")?;
        let file_count = files.len() as u32;
        writer.write_u32(file_count)?;
        let first_file_offset = 0x10 + file_count * 16; // 16 bytes per file header
        writer.write_u32(first_file_offset)?;
        writer.write_u32(0)?; // Unused field
        let mut headers = HashMap::new();
        for file in files {
            headers.insert(
                file.to_string(),
                CustomHeader {
                    file_name: file.to_string(),
                    offset: 0,
                    size: 0,
                },
            );
        }
        let mut crypto = Crypto::new(&mut writer, 0xA5);
        for (_, header) in headers.iter() {
            header.pack(&mut crypto, false, encoding, &None)?;
        }
        Ok(ItufuruArchiveWriter {
            writer,
            headers,
            first_file_offset,
            encoding,
        })
    }
}

impl<T: Write + Seek> Archive for ItufuruArchiveWriter<T> {
    fn new_file<'a>(
        &'a mut self,
        name: &str,
        _size: Option<u64>,
    ) -> Result<Box<dyn WriteSeek + 'a>> {
        let entry = self
            .headers
            .get_mut(name)
            .ok_or_else(|| anyhow::anyhow!("File '{}' not found in archive", name))?;
        if entry.size != 0 {
            return Err(anyhow::anyhow!("File '{}' already exists in archive", name));
        }
        entry.offset = self.writer.stream_position()? as u32 - self.first_file_offset;
        Ok(Box::new(ItufuruArchiveWriterEntry::new(
            &mut self.writer,
            entry,
            self.first_file_offset,
        )))
    }
    fn write_header(&mut self) -> Result<()> {
        let mut crypto = Crypto::new(&mut self.writer, 0xA5);
        let mut entries = self.headers.values().collect::<Vec<_>>();
        entries.sort_by_key(|h| h.offset);
        crypto.seek(SeekFrom::Start(16))?;
        for entry in entries.iter() {
            entry.pack(&mut crypto, false, self.encoding, &None)?;
        }
        Ok(())
    }
}

/// File Writer for Itufuru Archive
pub struct ItufuruArchiveWriterEntry<'a, T: Write + Seek> {
    writer: Crypto<&'a mut T>,
    header: &'a mut CustomHeader,
    first_file_offset: u32,
    pos: usize,
}

impl<'a, T: Write + Seek> ItufuruArchiveWriterEntry<'a, T> {
    fn new(writer: &'a mut T, header: &'a mut CustomHeader, first_file_offset: u32) -> Self {
        let writer = Crypto::new(writer, 0xA5);
        ItufuruArchiveWriterEntry {
            writer,
            header,
            first_file_offset,
            pos: 0,
        }
    }
}

impl<'a, T: Write + Seek> Write for ItufuruArchiveWriterEntry<'a, T> {
    fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
        self.writer.seek(SeekFrom::Start(
            self.header.offset as u64 + self.first_file_offset as u64 + self.pos as u64,
        ))?;
        let written = self.writer.write(buf)?;
        self.pos += written;
        self.header.size = self.header.size.max(self.pos as u32);
        Ok(written)
    }

    fn flush(&mut self) -> std::io::Result<()> {
        self.writer.flush()
    }
}

impl<'a, T: Write + Seek> Seek for ItufuruArchiveWriterEntry<'a, T> {
    fn seek(&mut self, pos: SeekFrom) -> std::io::Result<u64> {
        let new_pos = match pos {
            SeekFrom::Start(offset) => offset as usize,
            SeekFrom::End(offset) => {
                if offset < 0 {
                    if (-offset) as usize > self.header.size as usize {
                        return Err(std::io::Error::new(
                            std::io::ErrorKind::InvalidInput,
                            "Seek from end exceeds file length",
                        ));
                    }
                    self.header.size as usize - (-offset) as usize
                } else {
                    self.header.size as usize + offset as usize
                }
            }
            SeekFrom::Current(offset) => {
                if offset < 0 {
                    if (-offset) as usize > self.pos {
                        return Err(std::io::Error::new(
                            std::io::ErrorKind::InvalidInput,
                            "Seek from current exceeds current position",
                        ));
                    }
                    self.pos.saturating_sub((-offset) as usize)
                } else {
                    self.pos + offset as usize
                }
            }
        };
        self.pos = new_pos;
        Ok(self.pos as u64)
    }

    fn stream_position(&mut self) -> std::io::Result<u64> {
        Ok(self.pos as u64)
    }
}