RemoteFortressReader: GetCreatureRaws sends CP437 (not UTF-8) strings, which breaks protobuf decoding
维护者通常 3 天内回复
评估
调研方向
Read plugins/remotefortressreader/remotefortressreader.cpp and check the creature-raw string fields, starting with the caste description assignment identified in the issue. Convert game-sourced strings to UTF-8 consistently, then validate GetCreatureRaws replies with strict UTF-8 decoding. A linked pull request is already open, so check its changes and status before taking this on.
由索引模型根据 Issue 内容生成。
描述
Disclaimer: this issue was drafted by GitHub Copilot (an AI assistant) under the direction of user @dwmuller. The test results below come from real runs against a live game, but the source-code analysis is AI-generated, so please verify it.
Summary
RemoteFortressReader.GetCreatureRaws returns some strings in the game's CP437 encoding instead of UTF-8. Protobuf string fields must be UTF-8, so strict clients (Rust prost, and likely others) reject the whole reply. A single bad string makes the 23 MB reply undecodable.
The 50.08-r2 changelog says "RemoteFortressReader: ensured names are transmitted in UTF-8 instead of CP437", but DF2UTF is applied selectively and was not applied here.
Environment
- Dwarf Fortress 53.16
- DFHack 53.16-r3
- Remote client: Rust
dfhack-remote0.12.0 (prost) - Fortress with many generated creatures (raw indices ~2026-2085 are affected)
Observed
Decoding fails with:
failed to decode Protobuf message: CasteRaw.description: CreatureRaw.caste:
CreatureRawList.creature_raws: invalid string value: data is not UTF-8 encoded.
I walked the raw reply bytes without UTF-8 validation and found 74 non-UTF-8 strings. They fall into three fields:
| Field | Count | Example (raw bytes) |
|---|---|---|
CreatureRaw.name (field 3) |
19 | Being of r\x86sh |
CreatureRaw.caste[].caste_name (path 1.10.3) |
31 | Being of r\x86sh |
CreatureRaw.caste[].description (path 1.10.15) |
24 | ...created by the dwarven goddess R\x86sh and is of a part with deformity... |
0x86 is "å" in CP437, which fits these generated names ("Råsh").
Paging GetPartialCreatureRaws and bisecting shows that exactly 14 raws in the 2026-2085 range fail. Indices before 2026 decode fine.
Cause (from reading the source)
In plugins/remotefortressreader/remotefortressreader.cpp, the caste loop has:
send_caste->set_description(orig_caste->description);
There is no DF2UTF(...). The CreatureRaw/CasteRaw name fields (name, caste_name, baby/child names) show the same symptom in the data and should be checked as well. I only confirmed the unconverted set_description call in the source.
Not affected in this fortress
GetUnitListandGetUnitListInside(305 units) have no invalid UTF-8.GetMaterialList,GetGrowthList,GetItemListandGetPlantRawshave no invalid UTF-8.
I looked at these specifically because they also carry caste strings. They're fine here, but it's worth auditing every string that reaches a protobuf message.
Suggested fix
Wrap all game-sourced strings in the creature-raw path with DF2UTF, and audit the other set_* string calls in the plugin for the same omission.
Reproduction
Any client works. Call GetCreatureRaws and validate the reply strictly as UTF-8. I wrote a small test harness that does this. It's in a project of mine, and everything is read-only:
Run it against a live game (DFHack remote on port 5000):
cargo test --test live_game_tests -- --ignored --nocapture --test-threads=1
creature_rawsandcreature_raws_pageduse the typed client, and the paged one bisects to the failing indices.raw_creature_raws_utf8bypasses prost, reads the protobuf wire format directly, and lists every non-UTF-8 field by path with example bytes.- The other
raw_*tests do the same for the unit and material/item lists.
- 主要语言
- C++
- 星标
- 2.1k
- 派生
- 509
- 平均合并
- 2 天 19 小时
- 30 天内合并 PR
- 25
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
DFHack/dfhack 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 3 天内回复
-
难度 2/5 1-3 小时 新手友好度 66/100
维护者通常 3 天内回复
-
难度 5/5 一周以上 新手友好度 35/100
维护者通常 3 天内回复
-
难度 5/5 一周以上 新手友好度 25/100
维护者通常 3 天内回复
-
难度 5/5 一周以上 新手友好度 25/100
维护者通常 3 天内回复
相似的 Issue
-
Jupyter kernel leaks two file descriptors per cell; after ~100 cells every cell fails with "pipe() failed"可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
Test discovery aborts on GPU builds without cuStateVec: check_cuStateVec expects a failed result but set_config() now raises RuntimeError可能已有人在做 @dmeliksetian 今天认领。 未关闭bug
难度 2/5 1-3 小时 新手友好度 84/100
Qiskit/qiskit-aer#2495 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 65/100
sumatrapdfreader/sumatrapdf#6403 ·
-
Module:Polygraphy
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
enhancement GUI maintainer-review
难度 2/5 1-3 小时 新手友好度 66/100
aethersdr/AetherSDR#6681 · 1 条评论 ·
维护者通常 1 天内回复