xyz-rust 0.4.11

One definition, three interfaces(CLI / HTTP / MCP)— a command toolkit for Rust
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
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
// lang 是内置界面文本的 i18n 层:语言枚举 + 进程级目录 + 用户覆盖。默认
// 英文(xyz 的规范默认);中文随库携带。选择顺序(根派发器负责落地):
// --xyz.lang flag > Config.lang > LANG/LC_ALL 环境检测 > 英文。
//
// t(key) 返回当前语言文本;tf(key, params) 用 {0}、{1}… 占位符代入。
// 覆盖表(Config.translations)优先于内置译文;未命中回退键名本身(绝不
// panic)。键名与英文文案与 xyz-go 的 langx 目录逐键一致(xyz-spec
// §15.8 的规范键表),传输相关键(mcp 模式行/用法)按本 SDK 能力取值。

use std::collections::HashMap;
use std::sync::RwLock;

/// 受支持的语言。默认英文(规范默认)。
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum XyzLang {
    #[default]
    En,
    ZhCn,
}

impl XyzLang {
    /// --xyz.lang 的取值形态。
    pub fn as_str(&self) -> &'static str {
        match self {
            XyzLang::En => "en",
            XyzLang::ZhCn => "zh-CN",
        }
    }

    /// 解析 --xyz.lang 值;未知值 None(注册期报错)。
    pub fn parse(s: &str) -> Option<XyzLang> {
        match s {
            "en" => Some(XyzLang::En),
            "zh-CN" => Some(XyzLang::ZhCn),
            _ => None,
        }
    }

    /// LANG/LC_ALL 环境检测:zh 前缀 → 中文;其余 → 英文。
    pub fn detect() -> XyzLang {
        for key in ["LC_ALL", "LANG"] {
            if let Ok(v) = std::env::var(key) {
                if v.is_empty() {
                    continue;
                }
                let lower = v.to_ascii_lowercase();
                if lower.starts_with("zh") {
                    return XyzLang::ZhCn;
                }
                return XyzLang::En;
            }
        }
        XyzLang::En
    }
}

static STATE: RwLock<(XyzLang, Option<HashMap<String, String>>)> = RwLock::new((XyzLang::En, None));

/// 设置进程级语言与可选覆盖表(None = 无覆盖)。嵌入场景可自行调用。
pub fn set(lang: XyzLang, overrides: Option<HashMap<String, String>>) {
    *STATE.write().unwrap() = (lang, overrides);
}

/// 当前语言(零配置下 En)。
pub fn lang() -> XyzLang {
    STATE.read().unwrap().0
}

/// 消息目录:en 为规范文案(xyz-spec §15.8 键表),zh-CN 为随库译文。
const EN: &[(&str, &str)] = &[
    (
        "overview.usage_line",
        "Usage (the mode is detected automatically; definitions live in one place):",
    ),
    (
        "overview.cli_mode",
        "  <app> [command] [args]         CLI mode (subcommands + flags/positionals; -h help, -v version)",
    ),
    (
        "overview.serve_mode",
        "  <app> {0} [--addr :8080]    HTTP mode (REST routes + /openapi.json + optional /mcp)",
    ),
    (
        "overview.mcp_mode",
        "  <app> {0} stdio|http        MCP mode (official SDK; --versions pins revisions)",
    ),
    (
        "overview.builtins",
        "Built-in parameters (xyz.Config in code or on the command line): --xyz.addr=:8080 (default listen address) --xyz.bearer=tok1,tok2 (Bearer credentials for serve and MCP http)",
    ),
    ("overview.commands", "Commands:"),
    (
        "overview.http_mode",
        "  <app> {0} [--addr :8080]     HTTP mode (REST routes + /openapi.json only; no /mcp)",
    ),
    (
        "overview.help_mode",
        "  <app> {0} [command|mode]    detailed help for a command or a mode",
    ),
    (
        "mode_help.serve",
        "{0}: start the HTTP server — REST routes + /openapi.json + the streamable-HTTP MCP endpoint at /mcp.\n\nFlags (also as --xyz.<name> anywhere):\n  --addr :8080        listen address\n  --bearer tok1,tok2  require Authorization: Bearer <tok>\n  --timeout 45s       read/write/idle timeout\n  --tls-cert/--tls-key  both set → serve HTTPS\n  --cors a,b | *      CORS allowlist\n  --default k=v       channel default (repeatable)\n  --xyz.header k=v    extra response header (repeatable)\n  --xyz.no-server-headers  suppress X-App-*/X-XYZ-* headers\n\nFor REST only (no /mcp), use the http mode. -h/--help prints this.",
    ),
    (
        "mode_help.http",
        "{0}: start the standalone HTTP server — REST routes + /openapi.json only (no /mcp endpoint).\n\nFlags (also as --xyz.<name> anywhere):\n  --addr :8080        listen address\n  --bearer tok1,tok2  require Authorization: Bearer <tok>\n  --timeout 45s       read/write/idle timeout\n  --tls-cert/--tls-key  both set → serve HTTPS\n  --cors a,b | *      CORS allowlist\n  --default k=v       channel default (repeatable)\n  --xyz.header k=v    extra response header (repeatable)\n  --xyz.no-server-headers  suppress X-App-*/X-XYZ-* headers\n\nFor REST + /mcp together, use the serve mode. -h/--help prints this.",
    ),
    (
        "mode_help.mcp",
        "{0}: start the MCP server (official SDK); one tool per registered command.\n\nUsage: {0} stdio|http [flags]\n  stdio  local process transport\n  http   streamable HTTP (2026-07-28 needs --stateless)\n\nFlags: --addr :8080, --versions v1,v2, --name N, --server-version V,\n  --bearer tok1,tok2, --cors a,b, --session-timeout 30m, --default k=v.\n-h/--help prints this.",
    ),
    (
        "mode_help.help",
        "{0}: print help.\n\nUsage: {0} [command|mode]\n  {0}                 the overview (modes + commands)\n  {0} user.add        detailed help for a command (same as `user add -h`)\n  {0} serve|http|mcp  help for a mode\n\nDotted or space-separated command paths both work.",
    ),
    ("http.err_invalid_json", "invalid JSON body"),
    ("http.err_not_found", "not found"),
    ("overview.disabled", " (disabled)"),
    ("overview.not_compiled", " (not compiled into this binary)"),
    ("help.usage", "Usage:"),
    ("help.aliases", "Aliases:"),
    ("help.commands", "Commands:"),
    ("help.flags", "Flags:"),
    ("help.global_flags", "Global Flags:"),
    ("help.commands_placeholder", "[command]"),
    ("help.flags_placeholder", "[flags]"),
    (
        "help.json_flag",
        "output JSON instead of the human-readable form",
    ),
    ("help.version_flag", "print version information"),
    ("help.help_flag", "print help"),
    (
        "cli.err_positional_count",
        "{0}: positional argument count mismatch (want {1} to {2}, got {3})",
    ),
    (
        "warn.mode_disabled",
        "{0} mode was disabled (Config.Capabilities.No{1})",
    ),
    (
        "warn.no_cli",
        "subcommands unavailable: CLI is disabled (Config.Capabilities.NoCLI; {0}/{1}/help/-v remain available)",
    ),
    (
        "warn.bearer_stdio",
        "Bearer credential checks only apply to the http transport; stdio is a local process and is not protected",
    ),
    (
        "stub.not_compiled",
        "this binary was built without the {0} frontend",
    ),
    (
        "log.serve_listening",
        "listening on {0}://{1} (REST + /openapi.json{2})",
    ),
    ("log.graceful", "gracefully shut down (ctx cancelled)"),
    ("log.mcp_listening", "MCP listening on {0}"),
    ("log.cors_on", "CORS enabled: {0}"),
    (
        "log.debug_dispatch",
        "dispatch: mode word='{0}' addr={1} tokens={2} timeout={3:?} cors={4}",
    ),
    (
        "mcp.usage",
        "usage: mcp stdio|http [--addr :8080] [--versions 2025-06-18,2026-07-28] [--name N] [--server-version V]",
    ),
    ("mcp.err_missing_transport", "missing transport"),
    (
        "mcp.err_unknown_transport",
        "unknown transport {0} (want stdio|http)",
    ),
    (
        "mcp.err_sse_removed",
        "this SDK removed the legacy HTTP+SSE transport with the 2026-07-28 revision (available: stdio|http)",
    ),
    (
        "mcp.err_unknown_version",
        "unknown protocol version {0} (known: {1})",
    ),
    (
        "mcp.err_empty_version",
        "empty protocol version in --versions",
    ),
    (
        "mcp.err_transport_versions",
        "transport {0} cannot serve any of the requested versions {1}",
    ),
    ("mcp.err_usage_extra_arg", "unexpected argument {0}"),
];

const ZH: &[(&str, &str)] = &[
    (
        "overview.usage_line",
        "用法(模式由程序自动判断,定义只有一份):",
    ),
    (
        "overview.cli_mode",
        "  <app> [命令] [参数]           CLI 模式(子命令 + flag/位置参数;-h 帮助,-v 版本)",
    ),
    (
        "overview.serve_mode",
        "  <app> {0} [--addr :8080]      HTTP 模式(REST 路由 + /openapi.json + 可挂 /mcp)",
    ),
    (
        "overview.mcp_mode",
        "  <app> {0} stdio|http          MCP 模式(官方 SDK;--versions 限定协议版本)",
    ),
    (
        "overview.builtins",
        "内置参数(代码中的 xyz_rust::Config 或命令行):--xyz.addr=:8080(默认监听地址) --xyz.bearer=tok1,tok2(serve 与 MCP http 的 Bearer 凭据)",
    ),
    ("overview.commands", "命令:"),
    (
        "overview.http_mode",
        "  <app> {0} [--addr :8080]     HTTP 模式(仅 REST 路由 + /openapi.json;不挂 /mcp)",
    ),
    (
        "overview.help_mode",
        "  <app> {0} [命令|模式]    某命令或某模式的详细帮助",
    ),
    (
        "mode_help.serve",
        "{0}:启动 HTTP 服务器——REST 路由 + /openapi.json + 挂在 /mcp 的流式 HTTP MCP 端点。\n\n旗标(亦可用 --xyz.<名> 置于任意位置):\n  --addr :8080        监听地址\n  --bearer tok1,tok2  要求 Authorization: Bearer <tok>\n  --timeout 45s       读/写/空闲超时\n  --tls-cert/--tls-key  两者都设 → HTTPS\n  --cors a,b | *      CORS 白名单\n  --default k=v       通道默认参数(可重复)\n  --xyz.header k=v    附加响应头(可重复)\n  --xyz.no-server-headers  抑制 X-App-*/X-XYZ-* 头\n\n只要 REST(不挂 /mcp)请用 http 模式。-h/--help 打印本帮助。",
    ),
    (
        "mode_help.http",
        "{0}:启动单独的 HTTP 服务器——仅 REST 路由 + /openapi.json(不挂 /mcp 端点)。\n\n旗标(亦可用 --xyz.<名> 置于任意位置):\n  --addr :8080        监听地址\n  --bearer tok1,tok2  要求 Authorization: Bearer <tok>\n  --timeout 45s       读/写/空闲超时\n  --tls-cert/--tls-key  两者都设 → HTTPS\n  --cors a,b | *      CORS 白名单\n  --default k=v       通道默认参数(可重复)\n  --xyz.header k=v    附加响应头(可重复)\n  --xyz.no-server-headers  抑制 X-App-*/X-XYZ-* 头\n\n要 REST + /mcp 一起请用 serve 模式。-h/--help 打印本帮助。",
    ),
    (
        "mode_help.mcp",
        "{0}:启动 MCP 服务器(官方 SDK);每个已注册命令一个工具。\n\n用法:{0} stdio|http [旗标]\n  stdio  本地进程传输\n  http   流式 HTTP(2026-07-28 需 --stateless)\n\n旗标:--addr :8080、--versions v1,v2、--name N、--server-version V、\n  --bearer tok1,tok2、--cors a,b、--session-timeout 30m、--default k=v。\n-h/--help 打印本帮助。",
    ),
    (
        "mode_help.help",
        "{0}:打印帮助。\n\n用法:{0} [命令|模式]\n  {0}                 总览(模式 + 命令)\n  {0} user.add        某命令的详细帮助(等同 `user add -h`)\n  {0} serve|http|mcp  某模式的帮助\n\n命令路径点分或空格分隔皆可。",
    ),
    ("http.err_invalid_json", "无效的 JSON 请求体"),
    ("http.err_not_found", "未找到"),
    ("overview.disabled", "(已禁用)"),
    ("overview.not_compiled", "(本二进制未编译)"),
    ("help.usage", "Usage:"),
    ("help.aliases", "Aliases:"),
    ("help.commands", "命令:"),
    ("help.flags", "Flags:"),
    ("help.global_flags", "Global Flags:"),
    ("help.commands_placeholder", "[命令]"),
    ("help.flags_placeholder", "[flags]"),
    ("help.json_flag", "输出 JSON 而不是人类可读格式"),
    ("help.version_flag", "输出版本信息"),
    ("help.help_flag", "打印帮助"),
    (
        "cli.err_positional_count",
        "{0}: 位置参数数量不符(需要 {1} 到 {2} 个,收到 {3} 个)",
    ),
    (
        "warn.mode_disabled",
        "{0} 模式已被禁用(Config.Capabilities.No{1})",
    ),
    (
        "warn.no_cli",
        "子命令不可用:CLI 已禁用(Config.Capabilities.NoCLI;{0}/{1}/help/-v 仍可用)",
    ),
    (
        "warn.bearer_stdio",
        "Bearer 凭据校验只作用于 http 传输,stdio 为本地进程不受保护",
    ),
    ("stub.not_compiled", "本二进制未编译 {0} 前端"),
    (
        "log.serve_listening",
        "监听 {0}://{1}(REST + /openapi.json{2})",
    ),
    ("log.graceful", "已优雅关停(ctx 取消)"),
    ("log.mcp_listening", "MCP 监听 {0}"),
    ("log.cors_on", "CORS 开启:{0}"),
    (
        "log.debug_dispatch",
        "dispatch: mode word={0} addr={1} tokens={2} timeout={3} cors={4}",
    ),
    (
        "mcp.usage",
        "用法: mcp stdio|http [--addr :8080] [--versions 2025-06-18,2026-07-28]",
    ),
    ("mcp.err_missing_transport", "missing transport"),
    (
        "mcp.err_unknown_transport",
        "unknown transport {0} (want stdio|http)",
    ),
    (
        "mcp.err_sse_removed",
        "本 SDK(官方 Rust SDK rmcp)已随 2026-07-28 修订移除 HTTP+SSE 传输(可用 stdio|http)",
    ),
    (
        "mcp.err_unknown_version",
        "unknown protocol version {0} (known: {1})",
    ),
    (
        "mcp.err_empty_version",
        "empty protocol version in --versions",
    ),
    (
        "mcp.err_transport_versions",
        "transport {0} cannot serve any of the requested versions {1}",
    ),
    ("mcp.err_usage_extra_arg", "unexpected argument {0}"),
];

fn lookup(lang: XyzLang, key: &str) -> String {
    let table = match lang {
        XyzLang::ZhCn => ZH,
        XyzLang::En => EN,
    };
    table
        .iter()
        .find(|(k, _)| *k == key)
        .map(|(_, v)| (*v).to_string())
        .unwrap_or_else(|| key.to_string())
}

/// 当前语言下 key 的文本:覆盖 > 内置 > 键名回退。
pub fn t(key: &str) -> String {
    let guard = STATE.read().unwrap();
    let lang = guard.0;
    let overridden = guard.1.as_ref().and_then(|ov| ov.get(key).cloned());
    drop(guard);
    if let Some(s) = overridden {
        return s;
    }
    lookup(lang, key)
}

/// 当前进程语言(spec §14 item7 的 Language 访问器用)。
pub fn current() -> XyzLang {
    STATE.read().unwrap().0
}

/// 按指定语言查目录(不含用户覆盖表)——逐请求语言(§11.7)的框架消息用。
pub fn t_lang(lang: XyzLang, key: &str) -> String {
    lookup(lang, key)
}

/// t_lang 的带参数形态。
pub fn tf_lang(lang: XyzLang, key: &str, params: &[&str]) -> String {
    let mut out = t_lang(lang, key);
    for (i, p) in params.iter().enumerate() {
        out = out.replace(&format!("{{{i}}}"), p);
    }
    out
}

/// 解析 HTTP Accept-Language(spec §11.7):按 q 值择优(缺省 q=1),
/// `zh*` → zh-CN、`en*` → en;无受支持标签返回 None(调用方回退进程语言)。
pub fn parse_accept_language(header: &str) -> Option<XyzLang> {
    let mut best_q = -1.0f64;
    let mut best: Option<XyzLang> = None;
    for part in header.split(',') {
        let part = part.trim();
        if part.is_empty() {
            continue;
        }
        let (tag, mut q) = match part.split_once(';') {
            Some((t, params)) => {
                let mut q = 1.0f64;
                for param in params.split(';') {
                    let param = param.trim();
                    if let Some(v) = param.strip_prefix("q=")
                        && let Ok(f) = v.trim().parse::<f64>()
                    {
                        q = f;
                    }
                }
                (t.trim(), q)
            }
            None => (part, 1.0f64),
        };
        // 标签大小写不敏感(RFC 惯例;对齐 Go 的 ToLower 匹配)。
        let tag = tag.trim().to_ascii_lowercase();
        let lang = if tag.starts_with("zh") {
            Some(XyzLang::ZhCn)
        } else if tag.starts_with("en") {
            Some(XyzLang::En)
        } else {
            None
        };
        if let Some(l) = lang
            && q > best_q
        {
            best_q = q;
            best = Some(l);
        }
        if q <= 0.0 {
            q = 0.0; // q=0 表示不接收;此处仅防守
        }
        let _ = q;
    }
    best
}

/// 带参数的 t:模板中的 {0}、{1}… 依次替换。
pub fn tf(key: &str, params: &[&str]) -> String {
    let mut out = t(key);
    for (i, p) in params.iter().enumerate() {
        out = out.replace(&format!("{{{i}}}"), p);
    }
    out
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn parse_and_default() {
        assert_eq!(XyzLang::parse("en"), Some(XyzLang::En));
        assert_eq!(XyzLang::parse("zh-CN"), Some(XyzLang::ZhCn));
        assert_eq!(XyzLang::parse("fr"), None);
        assert_eq!(XyzLang::default(), XyzLang::En);
    }

    #[test]
    fn catalog_and_overrides() {
        set(XyzLang::En, None);
        assert!(t("overview.usage_line").starts_with("Usage ("));
        set(XyzLang::ZhCn, None);
        assert!(t("overview.usage_line").starts_with("用法("));
        // 覆盖优先、未知键回退、tf 占位
        set(
            XyzLang::En,
            Some(HashMap::from([(
                "help.help_flag".to_string(),
                "show me help".to_string(),
            )])),
        );
        assert_eq!(t("help.help_flag"), "show me help");
        assert_eq!(t("no.such.key"), "no.such.key");
        assert_eq!(
            tf("warn.mode_disabled", &["serve", "HTTP"]),
            "serve mode was disabled (Config.Capabilities.NoHTTP)"
        );
        set(XyzLang::En, None);
    }
}

#[cfg(test)]
mod accept_language_tests {
    use super::*;

    #[test]
    fn accept_language_edges() {
        // 大小写不敏感(对齐 Go ToLower 匹配)。
        assert_eq!(parse_accept_language("ZH-CN"), Some(XyzLang::ZhCn));
        assert_eq!(parse_accept_language("En-US,en;q=0.9"), Some(XyzLang::En));
        // 空白与 q 值。
        assert_eq!(
            parse_accept_language(" zh-CN ; q=0.8 , en ; q=0.9 "),
            Some(XyzLang::En)
        );
        // 坏 q 视为缺省 1.0(对齐 Go:解析失败保持默认)。
        assert_eq!(parse_accept_language("zh;q=abc,en"), Some(XyzLang::ZhCn));
        // q=0 仍参与择优(与 Go 行为一致;锁一致而非 RFC 严格性)。
        assert_eq!(parse_accept_language("zh;q=0,en;q=0.5"), Some(XyzLang::En));
        assert_eq!(parse_accept_language("zh;q=0"), Some(XyzLang::ZhCn));
        // 通配与空串 → 无受支持标签。
        assert_eq!(parse_accept_language("*"), None);
        assert_eq!(parse_accept_language(""), None);
        assert_eq!(parse_accept_language("fr-FR,de;q=0.8"), None);
    }
}