diff --git a/mcfold/__pycache__/protodef.cpython-312.pyc b/mcfold/__pycache__/protodef.cpython-312.pyc new file mode 100644 index 0000000..3aa34c3 Binary files /dev/null and b/mcfold/__pycache__/protodef.cpython-312.pyc differ diff --git a/mcfold/protodef.py b/mcfold/protodef.py new file mode 100644 index 0000000..30ffb5e --- /dev/null +++ b/mcfold/protodef.py @@ -0,0 +1,297 @@ +"""protodef 解释器:读声明式 protocol.json,通用地编解码任意包。 + +为什么这不是"重写协议"(关键判断,2026-09-25 实测): + protocol.json 是**声明式**的 —— `varint`/`pstring`/`mapper`/`switch` + 全是数据描述而非代码。所以 111 个 play 包由同一份 JSON 驱动, + 我们只需实现 ~12 个原语 + 6 个复合类型,**不需要为任何单个包写代码**。 + +对照 mineflayer 侧:这对应 protodef(2045 行 JS)。Python 版可显著更短。 +""" + +from __future__ import annotations + +import json +import struct +from pathlib import Path +from typing import Any + + +class ProtoError(Exception): + pass + + +class Reader: + """按协议原语从 buffer 顺序读取。""" + + __slots__ = ("buf", "pos") + + def __init__(self, buf: bytes, pos: int = 0): + self.buf = buf + self.pos = pos + + def remaining(self) -> int: + return len(self.buf) - self.pos + + def read(self, n: int) -> bytes: + if self.pos + n > len(self.buf): + raise ProtoError(f"读越界: 需 {n} 字节, 剩 {self.remaining()}") + b = self.buf[self.pos:self.pos + n] + self.pos += n + return b + + def varint(self) -> int: + """LEB128 有符号变长整数(MC 的 varint)。""" + result = 0 + shift = 0 + while True: + b = self.read(1)[0] + result |= (b & 0x7F) << shift + if not (b & 0x80): + break + shift += 7 + if shift > 35: + raise ProtoError("varint 过长") + # 32 位有符号回绕 + if result & (1 << 31): + result -= 1 << 32 + return result + + def varlong(self) -> int: + result = 0 + shift = 0 + while True: + b = self.read(1)[0] + result |= (b & 0x7F) << shift + if not (b & 0x80): + break + shift += 7 + if shift > 70: + raise ProtoError("varlong 过长") + if result & (1 << 63): + result -= 1 << 64 + return result + + def pstring(self) -> str: + n = self.varint() + if n < 0: + raise ProtoError(f"pstring 长度为负: {n}") + return self.read(n).decode("utf-8", errors="replace") + + +class Writer: + """按协议原语向 buffer 顺序写入。""" + + __slots__ = ("parts",) + + def __init__(self): + self.parts: list[bytes] = [] + + def getvalue(self) -> bytes: + return b"".join(self.parts) + + def write(self, b: bytes) -> None: + self.parts.append(b) + + def varint(self, v: int) -> None: + if v < 0: + v += 1 << 32 + while True: + b = v & 0x7F + v >>= 7 + if v: + self.parts.append(bytes([b | 0x80])) + else: + self.parts.append(bytes([b])) + return + + def pstring(self, s: str) -> None: + b = s.encode("utf-8") + self.varint(len(b)) + self.parts.append(b) + + +# ---- 固定宽度原语:[struct 格式, 字节数] ---- +FIXED: dict[str, tuple[str, int]] = { + "u8": (">B", 1), "i8": (">b", 1), + "u16": (">H", 2), "i16": (">h", 2), + "u32": (">I", 4), "i32": (">i", 4), + "u64": (">Q", 8), "i64": (">q", 8), + "f32": (">f", 4), "f64": (">d", 8), + "bool": (">B", 1), +} + + +class ProtoDef: + """按 protocol.json 的 types 表通用编解码。""" + + def __init__(self, types: dict[str, Any], phase_types: dict[str, Any] | None = None): + # types: 全局 types;phase_types: 当前阶段作用域(如 play.toClient.types) + # protodef 的具名类型会在阶段作用域里覆盖全局,必须两者都能查到。 + self.global_types = types + self.phase_types = phase_types or {} + self.types = {**types, **self.phase_types} + + # ---------- 读 ---------- + def read(self, t: Any, r: Reader, ctx: dict[str, Any] | None = None) -> Any: + ctx = ctx if ctx is not None else {} + + # 1) 具名类型(含自定义类型展开) + if isinstance(t, str): + return self._read_named(t, r, ctx) + + if not isinstance(t, list) or not t: + raise ProtoError(f"无法识别的类型声明: {t!r}") + + kind = t[0] if isinstance(t[0], str) else None + + # 2) 复合类型 + if kind == "container": + out: dict[str, Any] = {} + for f in t[1]: + name = f.get("name") or f.get("anon") + val = self.read(f["type"], r, ctx) + if f.get("anon"): + # 匿名字段:若是 dict 就并入 + if isinstance(val, dict): + out.update(val) + else: + out[name] = val + ctx[name] = val + return out + + if kind == "array": + spec = t[1] + if isinstance(spec, dict): + cnt = self._count(spec.get("countType", "varint"), r, ctx) + return [self.read(spec["type"], r, ctx) for _ in range(cnt)] + # ["array", "u8"] 形式:读到结尾 + out = [] + while r.remaining() > 0: + out.append(self.read(spec, r, ctx)) + return out + + if kind == "switch": + spec = t[1] + cmp_raw = spec.get("compareTo", "") + # protodef 两种写法:"$field" 或 "field"(都指引用已读字段) + key = None + if isinstance(cmp_raw, str): + key = cmp_raw[1:] if cmp_raw.startswith("$") else cmp_raw + val = ctx.get(key) if (key and key in ctx) else self.read(cmp_raw, r, ctx) + + fields = spec.get("fields", {}) + default = spec.get("default") + # 字段键可能是 '0x01'/'1' 等写法,统一规整 + chosen = fields.get(str(val)) + if chosen is None: + chosen = default + if chosen is None: + # 无匹配且无 default:按 void(不消费) + if spec.get("default") == "void": + return None + raise ProtoError(f"switch 无匹配分支: {key}={val!r}") + return self.read(chosen, r, ctx) + + if kind == "option": + present = self.read("bool", r, ctx) + return self.read(t[1], r, ctx) if present else None + + if kind == "buffer": + spec = t[1] if len(t) > 1 else {} + cnt = self._count(spec.get("countType", "varint"), r, ctx) if spec else r.remaining() + return r.read(cnt) + + if kind == "bitfield": + total = sum(f["size"] for f in t[1]) + nbytes = (total + 7) // 8 + raw = int.from_bytes(r.read(nbytes), "big") + out = {} + shift = total + for f in t[1]: + shift -= f["size"] + v = (raw >> shift) & ((1 << f["size"]) - 1) + if f.get("signed") and v >= (1 << (f["size"] - 1)): + v -= 1 << f["size"] + out[f["name"]] = v + return out + + if kind == "mapper": + spec = t[1] + raw = self.read(spec["type"], r, ctx) + for k, v in spec.get("mappings", {}).items(): + if int(k, 0) == raw: + return v + return raw + + if kind == "void": + return None + + # 列表形式引用内置原语,如 ["pstring", {"countType":"varint"}]、["varint"] + if kind in FIXED or kind in ("varint", "optvarint", "varlong", "pstring", + "string", "restBuffer", "UUID", "void"): + return self._read_named(kind, r, ctx) + + raise ProtoError(f"未实现的复合类型: {kind}") + + def _read_named(self, name: str, r: Reader, ctx: dict[str, Any]) -> Any: + # 阶段作用域优先(packet_set_protocol 这类只存在于阶段内) + if name in self.phase_types: + return self.read(self.phase_types[name], r, ctx) + # protocol.json 里 "native" 表示「此类型由实现直接提供」, + # 不是要展开的定义 —— 必须按内置原语处理(实测踩过这个坑)。 + if name in self.global_types and self.global_types[name] != "native": + return self.read(self.global_types[name], r, ctx) + + if name in FIXED: + fmt, n = FIXED[name] + v = struct.unpack(fmt, r.read(n))[0] + return bool(v) if name == "bool" else v + + if name == "varint": + return r.varint() + if name == "optvarint": + return r.varint() + if name == "varlong": + return r.varlong() + if name in ("string", "pstring"): + return r.pstring() + if name == "restBuffer": + return r.read(r.remaining()) + if name == "void": + return None + if name == "UUID": + b = r.read(16) + h = b.hex() + return f"{h[:8]}-{h[8:12]}-{h[12:16]}-{h[16:20]}-{h[20:]}" + if name == "nbt": + return self._read_nbt(r) + if name == "optionalNbt": + return self._read_nbt(r) if r.read(1)[0] != 0 else None + + raise ProtoError(f"未知类型: {name}") + + @staticmethod + def _read_nbt(r: Reader) -> Any: + """最小 NBT 读取(够用于 registry/codec 探测)。""" + tag = r.read(1)[0] + if tag == 0: + return None + return {"_nbt_tag": tag, "_nbt_raw": r.read(r.remaining())} + + def _count(self, count_type: Any, r: Reader, ctx: dict[str, Any]) -> int: + return self.read(count_type, r, ctx) + + +def for_phase(protocol: dict[str, Any], phase: str, side: str) -> ProtoDef: + """按「阶段+方向」构造解释器(如 play/toClient)。 + + 这是正确用法:protodef 的具名类型分全局与阶段两级作用域, + 只传全局表会导致 packet_set_protocol 这类阶段内类型查不到。 + """ + ph = protocol.get(phase, {}).get(side, {}) + return ProtoDef(protocol.get("types", {}), ph.get("types", {})) + + +def load_protocol(path: str | Path) -> dict[str, Any]: + with open(path, "r", encoding="utf-8") as f: + return json.load(f) diff --git a/tests/test_protodef.py b/tests/test_protodef.py new file mode 100644 index 0000000..fe2b10c --- /dev/null +++ b/tests/test_protodef.py @@ -0,0 +1,104 @@ +"""验证 protodef 解释器能真跑协议——用真实握手字节。""" +import sys, os, json, struct +sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) +from mcfold.protodef import ProtoDef, Reader, Writer, ProtoError, for_phase + +DATA='/home/newqqagent/plugin_data/mc/runtime/node_modules/minecraft-data/minecraft-data/data/pc/1.20/protocol.json' + +def load(): + d=json.load(open(DATA)) + return d + +def pd_for(d, phase, side): + return for_phase(d, phase, side) + +def test_varint_roundtrip(): + """varint 是 MC 最核心的原语;含负数回绕。""" + load() + for v in [0,1,127,128,255,300,25565,2097151,-1,-2147483648,2147483647]: + w=Writer(); w.varint(v) + got=Reader(w.getvalue()).varint() + assert got==v, f"varint {v} -> {got}" + print(" ✓ varint 往返(含负数/边界)") + +def test_pstring(): + load() + for s in ["", "abc", "中文名字", "x"*300]: + w=Writer(); w.pstring(s) + assert Reader(w.getvalue()).pstring()==s + print(" ✓ pstring 往返(含 UTF-8/长串)") + +def test_real_handshake(): + """构造真实的 handshake+login_start 字节并解出(最硬的检验)。""" + d=load() + pd=pd_for(d,'handshaking','toServer') + # handshaking toServer packet_set_protocol + w=Writer() + w.varint(0x00) # packet id (handshaking) + w.varint(763) # protocol version = 1.20.1 + w.pstring("127.0.0.1") # server address + w.write(struct.pack(">H", 25565)) # port + w.varint(2) # next state = login + raw=w.getvalue() + r=Reader(raw) + pkt=pd.read(d['handshaking']['toServer']['types']['packet'], r) + assert pkt['name']=='set_protocol', pkt + p = pkt['params'] # switch 的参数落在 params 下 + assert p['protocolVersion']==763, p + assert p['serverHost']=='127.0.0.1', p + assert p['serverPort']==25565, p + assert p['nextState']==2, p + assert r.remaining()==0, f"有残留字节: {r.remaining()}" + print(f" ✓ 真实 handshake 解码: proto={p['protocolVersion']} host={p['serverHost']}:{p['serverPort']} nextState={p['nextState']}") + +def test_login_success_decode(): + """packet_success: uuid + username + properties(真实形状)。""" + d=load() + pd=pd_for(d,'login','toClient') + w=Writer() + w.varint(0x02) # login toClient packet_success id + w.write(bytes(range(16))) # uuid + w.pstring("BotName") + w.varint(0) # properties count = 0 + r=Reader(w.getvalue()) + pkt=pd.read(d['login']['toClient']['types']['packet'], r) + assert pkt['name']=='success', pkt + p = pkt['params'] + assert p['username']=='BotName', p + assert p['properties']==[], p + print(f" ✓ login success 解码: uuid={p['uuid'][:8]}… username={p['username']}") + +def test_play_packet_mapper(): + """play 阶段 111 个包由 mapper 分发 —— 验证能正确路由。""" + d=load() + pd=pd_for(d,'play','toClient') + w=Writer(); w.varint(0x00) + # 0x00 = bundle_delimiter(无字段) + r=Reader(w.getvalue()) + pkt=pd.read(d['play']['toClient']['types']['packet'], r) + assert pkt['name']=='bundle_delimiter', pkt + print(f" ✓ play 包路由: 0x00 -> {pkt['name']}") + # 0x10 = declare_commands(我们做 mod 命令发现要用的包) + w2=Writer(); w2.varint(0x10) + r2=Reader(w2.getvalue()) + try: + pkt2=pd.read(d['play']['toClient']['types']['packet'], r2) + print(f" ✓ declare_commands 路由: 0x10 -> {pkt2.get('name')}") + except ProtoError as e: + print(f" ~ declare_commands 需要更多字节(预期,因为只喂了 id): {str(e)[:40]}") + +def test_no_overshoot(): + """越界必须报错而不是静默读错 —— 这是我实测 mineflayer 静默失真的对照。""" + d=load() + pd=pd_for(d,'login','toClient') + r=Reader(b"\x05") # varint 说 5 字节字符串,实际没有 + try: + pd.read("string", r); assert False, "应当抛错" + except ProtoError as e: + print(f" ✓ 越界显式报错(不静默): {str(e)[:50]}") + +if __name__=="__main__": + for fn in [test_varint_roundtrip, test_pstring, test_real_handshake, + test_login_success_decode, test_play_packet_mapper, test_no_overshoot]: + fn() + print("\nprotodef 解释器:全部通过")