Add tjs/ns0 create support

Cargo.lock

@@ -1203,6 +1203,25 @@ version = "0.4.28"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "34080505efa8e45a4b816c349525ebe327ceaa8559756f0356cba97ef3bf7432"
 
+[[package]]
+name = "lz4"
+version = "1.28.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a20b523e860d03443e98350ceaac5e71c6ba89aea7d960769ec3ce37f4de5af4"
+dependencies = [
+ "lz4-sys",
+]
+
+[[package]]
+name = "lz4-sys"
+version = "1.11.1+lz4-1.10.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6bd8c0d6c6ed0cd30b3652886bb8711dc4bb01d637a68105a3d5158039b418e6"
+dependencies = [
+ "cc",
+ "libc",
+]
+
 [[package]]
 name = "mac"
 version = "0.1.1"
@@ -1323,6 +1342,7 @@ dependencies = [
  "lazy_static",
  "libflac-sys",
  "libtlg-rs",
+ "lz4",
  "markup5ever",
  "markup5ever_rcdom",
  "memchr",
@@ -1345,7 +1365,7 @@ dependencies = [
  "url",
  "utf16string",
  "webp",
- "windows-sys 0.59.0",
+ "windows-sys 0.61.0",
  "xml5ever",
  "zstd",
 ]

Cargo.toml

@@ -25,6 +25,7 @@ jpegxl-sys = { package = "msg-tool-jpegxl-sys", version = "0.11", optional = tru
 lazy_static = "1.5.0"
 libflac-sys = { version = "0.3", optional = true }
 libtlg-rs = { version = "0.2", optional = true, features = ["encode"] }
+lz4 = { version = "1.28", optional = true }
 markup5ever = { version = "0.35", optional = true }
 markup5ever_rcdom = { version = "0.35", optional = true }
 memchr = { version = "2.7", optional = true }
@@ -76,7 +77,7 @@ escude-arc = ["escude", "rand", "utils-bit-stream"]
 ex-hibit = []
 favorite = []
 hexen-haus = ["memchr", "utils-str"]
-kirikiri = ["emote-psb", "fancy-regex", "flate2", "json", "utils-escape"]
+kirikiri = ["emote-psb", "fancy-regex", "flate2", "json", "lz4", "utils-escape"]
 kirikiri-img = ["kirikiri", "image", "libtlg-rs"]
 silky = []
 softpal = ["int-enum"]

README.md

@@ -168,7 +168,7 @@ msg-tool create -t <script-type> <input> <output>
 | `kirikiri-scn`/`kr-scn` | `kirikiri` | Kirikiri Scene File (.scn) | ✔️ | ✔️ | ✔️ | ✔️ | ❌ | |
 | `kirikiri-simple-crypt`/`kr-simple-crypt` | `kirikiri` | Kirikiri Simple Crypt Text File | ❌ | ❌ | ✔️ | ❌ | ❌ | |
 | `kirikiri-mdf`/`kr-mdf` | `kirikiri` | Kirikiri Zlib-Compressed File | ❌ | ❌ | ✔️ | ❌ | ❌ | |
-| `kirikiri-tjs-ns0`/`kr-tjs-ns0` | `kirikiri` | Kirikiri TJS NS0 binary encoded script | ❌ | ❌ | ✔️ | ❌ | ❌ | |
+| `kirikiri-tjs-ns0`/`kr-tjs-ns0` | `kirikiri` | Kirikiri TJS NS0 binary encoded script | ❌ | ❌ | ✔️ | ✔️ | ✔️ | |
 | `kirikiri-tjs2`/`kr-tjs2` | `kirikiri` | Kirikiri compiled TJS2 script | ✔️ | ✔️ | ✔️ | ✔️ | ❌ | |
 
 | Image Type | Feature Name | Name | Export | Import | Export Multiple | Import Multiple | Create | Remarks |

src/scripts/kirikiri/tjs_ns0.rs

@@ -5,6 +5,8 @@ use crate::types::*;
 use crate::utils::encoding::{decode_to_string, encode_string};
 use crate::utils::struct_pack::*;
 use anyhow::Result;
+use msg_tool_macro::*;
+use overf::wrapping;
 use serde::{Deserialize, Serialize};
 use std::collections::BTreeMap;
 use std::io::{Read, Seek, Write};
@@ -46,11 +48,46 @@ impl ScriptBuilder for TjsNs0Builder {
     }
 
     fn is_this_format(&self, _filename: &str, buf: &[u8], buf_len: usize) -> Option<u8> {
-        if buf_len >= 12 && buf.starts_with(b"TJS/ns0\0TJS\0") {
+        if buf_len >= 8 && (buf.starts_with(b"TJS/ns0\0") || buf.starts_with(b"TJS/4s0\0")) {
             return Some(100);
         }
         None
     }
+
+    fn can_create_file(&self) -> bool {
+        true
+    }
+
+    fn create_file<'a>(
+        &'a self,
+        filename: &'a str,
+        mut writer: Box<dyn WriteSeek + 'a>,
+        encoding: Encoding,
+        file_encoding: Encoding,
+        config: &ExtraConfig,
+    ) -> Result<()> {
+        let s = crate::utils::files::read_file(filename)?;
+        let s = decode_to_string(file_encoding, &s, true)?;
+        let data: TjsValue = if config.custom_yaml {
+            serde_yaml_ng::from_str(&s)?
+        } else {
+            serde_json::from_str(&s)?
+        };
+        let header = Header {
+            magic: *b"TJS/",
+            check: *b"ns0\0",
+            seed: u32::from_le_bytes(*b"TJS\0"),
+            crypt: 0,
+            iv_len: 0,
+        };
+        let mut checker = ByteChecker::new(header.seed);
+        header.pack(&mut writer, false, encoding)?;
+        data.pack(&mut checker, &mut writer, false, encoding)?;
+        let checksum = checker.final_check();
+        writer.write_u32(checksum)?;
+        writer.flush()?;
+        Ok(())
+    }
 }
 
 #[derive(Debug, Serialize, Deserialize)]
@@ -73,10 +110,99 @@ fn unpack_string<R: Read + Seek>(reader: &mut R, big: bool, encoding: Encoding)
     Ok(s)
 }
 
-impl StructUnpack for TjsValue {
-    fn unpack<R: Read + Seek>(reader: &mut R, big: bool, encoding: Encoding) -> Result<Self> {
+fn pack_string<W: Write>(s: &str, writer: &mut W, big: bool, encoding: Encoding) -> Result<()> {
+    let encoded = encode_string(encoding, s, false)?;
+    let len = if encoding.is_utf16le() {
+        (encoded.len() / 2) as u32
+    } else {
+        encoded.len() as u32
+    };
+    len.pack(writer, big, encoding)?;
+    writer.write_all(&encoded)?;
+    Ok(())
+}
+
+impl TjsValue {
+    fn pack<W: Write>(
+        &self,
+        checker: &mut ByteChecker,
+        writer: &mut W,
+        big: bool,
+        encoding: Encoding,
+    ) -> Result<()> {
+        match self {
+            Self::Void(()) => {
+                let typ_byte = 0;
+                let check_byte = checker.get_seed(typ_byte);
+                let typ = ((check_byte as u16) << 8) | (typ_byte as u16);
+                typ.pack(writer, big, encoding)?;
+            }
+            Self::Str(s) => {
+                let typ_byte = 2;
+                let check_byte = checker.get_seed(typ_byte);
+                let typ = ((check_byte as u16) << 8) | (typ_byte as u16);
+                typ.pack(writer, big, encoding)?;
+                pack_string(s, writer, big, encoding)?;
+            }
+            Self::Int(i) => {
+                let typ_byte = 4;
+                let check_byte = checker.get_seed(typ_byte);
+                let typ = ((check_byte as u16) << 8) | (typ_byte as u16);
+                typ.pack(writer, big, encoding)?;
+                i.pack(writer, big, encoding)?;
+            }
+            Self::Double(f) => {
+                let typ_byte = 5;
+                let check_byte = checker.get_seed(typ_byte);
+                let typ = ((check_byte as u16) << 8) | (typ_byte as u16);
+                typ.pack(writer, big, encoding)?;
+                f.pack(writer, big, encoding)?;
+            }
+            Self::Array(arr) => {
+                let typ_byte = 0x81;
+                let check_byte = checker.get_seed(typ_byte);
+                let typ = ((check_byte as u16) << 8) | (typ_byte as u16);
+                typ.pack(writer, big, encoding)?;
+                let arr_len = arr.len() as u32;
+                arr_len.pack(writer, big, encoding)?;
+                for item in arr {
+                    item.pack(checker, writer, big, encoding)?;
+                }
+            }
+            Self::Dict(dict) => {
+                let typ_byte = 0xC1;
+                let check_byte = checker.get_seed(typ_byte);
+                let typ = ((check_byte as u16) << 8) | (typ_byte as u16);
+                typ.pack(writer, big, encoding)?;
+                let dict_len = dict.len() as u32;
+                dict_len.pack(writer, big, encoding)?;
+                for (key, value) in dict {
+                    pack_string(key, writer, big, encoding)?;
+                    value.pack(checker, writer, big, encoding)?;
+                }
+            }
+        }
+        Ok(())
+    }
+
+    fn unpack<R: Read + Seek>(
+        checker: &mut ByteChecker,
+        reader: &mut R,
+        big: bool,
+        encoding: Encoding,
+    ) -> Result<Self> {
         let typ = u16::unpack(reader, big, encoding)?;
         let typ_byte = (typ & 0xff) as u8;
+        let check_byte = (typ >> 8) as u8;
+        let expected_check = checker.get_seed(typ_byte);
+        if check_byte != expected_check {
+            return Err(anyhow::anyhow!(
+                "TJS/ns0 byte check failed: expected {}, got {} at pos {}",
+                expected_check,
+                check_byte,
+                reader.stream_position()? - 1
+            ));
+        }
         Ok(match typ_byte {
             0 => TjsValue::Void(()),
             2 => TjsValue::Str(unpack_string(reader, big, encoding)?),
@@ -86,7 +212,7 @@ impl StructUnpack for TjsValue {
                 let arr_len = u32::unpack(reader, big, encoding)? as usize;
                 let mut arr = Vec::with_capacity(arr_len);
                 for _ in 0..arr_len {
-                    arr.push(reader.read_struct::<TjsValue>(big, encoding)?);
+                    arr.push(TjsValue::unpack(checker, reader, big, encoding)?);
                 }
                 TjsValue::Array(arr)
             }
@@ -95,7 +221,7 @@ impl StructUnpack for TjsValue {
                 let mut dict = BTreeMap::new();
                 for _ in 0..kv_len {
                     let key = unpack_string(reader, big, encoding)?;
-                    let value = reader.read_struct::<TjsValue>(big, encoding)?;
+                    let value = TjsValue::unpack(checker, reader, big, encoding)?;
                     dict.insert(key, value);
                 }
                 TjsValue::Dict(dict)
@@ -116,6 +242,63 @@ impl StructUnpack for TjsValue {
 pub struct TjsNs0 {
     data: TjsValue,
     custom_yaml: bool,
+    header: Header,
+}
+
+struct ByteChecker {
+    seed: u32,
+}
+
+impl ByteChecker {
+    pub fn new(seed: u32) -> Self {
+        Self { seed }
+    }
+
+    fn calculate_round(seed: &mut [u8; 4]) {
+        let a = seed[0] ^ wrapping!(seed[0] * 2);
+        let mut b = a;
+        wrapping! {
+        b >>= 2;
+        b ^= seed[2];
+        b >>= 3;
+        b ^= seed[2];
+        b ^= a;
+        }
+
+        seed[0] = seed[1];
+        seed[1] = seed[2];
+        seed[2] = b;
+    }
+
+    pub fn get_seed(&mut self, type_code: u8) -> u8 {
+        let mut s = self.seed.to_le_bytes();
+        if type_code == 0 {
+            return s[2];
+        }
+        Self::calculate_round(&mut s);
+        self.seed = u32::from_le_bytes(s);
+        return s[2];
+    }
+
+    pub fn final_check(&mut self) -> u32 {
+        let mut s = self.seed.to_le_bytes();
+        Self::calculate_round(&mut s);
+        Self::calculate_round(&mut s);
+        Self::calculate_round(&mut s);
+        let tmp = s[0];
+        s[0] = s[2];
+        s[2] = tmp;
+        u32::from_le_bytes(s)
+    }
+}
+
+#[derive(Clone, Debug, StructPack, StructUnpack)]
+struct Header {
+    magic: [u8; 4],
+    check: [u8; 4],
+    seed: u32,
+    crypt: u16,
+    iv_len: u16,
 }
 
 impl TjsNs0 {
@@ -132,15 +315,46 @@ impl TjsNs0 {
         config: &ExtraConfig,
     ) -> Result<Self> {
         let mut reader = MemReader::new(buf);
-        let mut header = [0u8; 16];
-        reader.read_exact(&mut header)?;
-        if &header != b"TJS/ns0\0TJS\0\0\0\0\0" {
-            return Err(anyhow::anyhow!("Invalid TJS/ns0 header: {:?}", &header));
+        let header = Header::unpack(&mut reader, false, encoding)?;
+        if &header.magic != b"TJS/" {
+            return Err(anyhow::anyhow!("Not a valid TJS/ns0 file"));
+        }
+        if header.check[1] != b's' || header.check[2] != b'0' || header.check[3] != 0 {
+            return Err(anyhow::anyhow!("Not a valid TJS/ns0 file"));
+        }
+        if header.crypt != 0 {
+            return Err(anyhow::anyhow!("Encrypted TJS/ns0 files are not supported"));
+        }
+        if header.iv_len != 0 {
+            return Err(anyhow::anyhow!("TJS/ns0 files with IV are not supported"));
+        }
+        let mut reader = match header.check[0] {
+            b'n' => reader,
+            b'4' => {
+                let decompressed = lz4::block::decompress(&reader.data[reader.pos..], None)?;
+                MemReader::new(decompressed)
+            }
+            _ => {
+                return Err(anyhow::anyhow!(
+                    "Unsupported compression method in TJS/ns0 file"
+                ));
+            }
+        };
+        let mut checker = ByteChecker::new(header.seed);
+        let data = TjsValue::unpack(&mut checker, &mut reader, false, encoding)?;
+        let expected_checksum = checker.final_check();
+        let actual_checksum = reader.read_u32()?;
+        if expected_checksum != actual_checksum {
+            return Err(anyhow::anyhow!(
+                "TJS/ns0 checksum mismatch: expected {:08X}, got {:08X}",
+                expected_checksum,
+                actual_checksum
+            ));
         }
-        let data = TjsValue::unpack(&mut reader, false, encoding)?;
         Ok(Self {
             data,
             custom_yaml: config.custom_yaml,
+            header,
         })
     }
 }
@@ -173,4 +387,29 @@ impl Script for TjsNs0 {
         writer.write_all(&s)?;
         Ok(())
     }
+
+    fn custom_import<'a>(
+        &'a self,
+        custom_filename: &'a str,
+        mut file: Box<dyn WriteSeek + 'a>,
+        encoding: Encoding,
+        output_encoding: Encoding,
+    ) -> Result<()> {
+        let s = crate::utils::files::read_file(custom_filename)?;
+        let s = decode_to_string(output_encoding, &s, true)?;
+        let data: TjsValue = if self.custom_yaml {
+            serde_yaml_ng::from_str(&s)?
+        } else {
+            serde_json::from_str(&s)?
+        };
+        let mut header = self.header.clone();
+        header.check = *b"ns0\0";
+        let mut checker = ByteChecker::new(header.seed);
+        header.pack(&mut file, false, encoding)?;
+        data.pack(&mut checker, &mut file, false, encoding)?;
+        let checksum = checker.final_check();
+        file.write_u32(checksum)?;
+        file.flush()?;
+        Ok(())
+    }
 }

src/utils/struct_pack.rs

@@ -76,3 +76,18 @@ impl<T: StructUnpack> StructUnpack for Option<T> {
         Ok(Some(value))
     }
 }
+
+impl<const T: usize> StructPack for [u8; T] {
+    fn pack<W: Write>(&self, writer: &mut W, _big: bool, _encoding: Encoding) -> Result<()> {
+        writer.write_all(self)?;
+        Ok(())
+    }
+}
+
+impl<const T: usize> StructUnpack for [u8; T] {
+    fn unpack<R: Read + Seek>(reader: &mut R, _big: bool, _encoding: Encoding) -> Result<Self> {
+        let mut buf = [0u8; T];
+        reader.read_exact(&mut buf)?;
+        Ok(buf)
+    }
+}