crabmate 0.5.0

Rust AI agent: OpenAI-compatible chat/completions, function calling, HTTP serve, ops CLI
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
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
use std::path::Path;

use serde_json::Value as JsonValue;

use crate::cm_tools::tools::command;

pub const MAX_LIMIT: u32 = 200;
pub const DEFAULT_LIST_LIMIT: u32 = 30;
pub const MAX_SEARCH_LIMIT: u32 = 100;
pub const MAX_SEARCH_QUERY_BYTES: usize = 400;
pub const MAX_RELEASE_TAG_LEN: usize = 200;
pub const MAX_JOB_NAME_LEN: usize = 128;
pub const MAX_PR_TITLE_BYTES: usize = 240;
pub const MAX_PR_BODY_BYTES: usize = 65_536;
pub const MAX_PR_REF_TOKEN_BYTES: usize = 200;

pub fn is_safe_token(s: &str) -> bool {
    let t = s.trim();
    !t.is_empty() && !t.contains("..") && !t.starts_with('/')
}

pub fn validate_repo(repo: &str) -> Result<(), String> {
    let t = repo.trim();
    if t.is_empty() {
        return Err("错误:repo 不能为空".to_string());
    }
    if t.contains("..") || t.starts_with('/') {
        return Err("错误:repo 不得含 \"..\" 或以 \"/\" 开头(请用 owner/repo)".to_string());
    }
    let parts: Vec<&str> = t.split('/').filter(|p| !p.is_empty()).collect();
    if parts.len() != 2 {
        return Err("错误:repo 须为 owner/repo 两段式".to_string());
    }
    Ok(())
}

pub fn validate_extra_args(args: &[String]) -> Result<(), String> {
    for a in args {
        if !is_safe_token(a) {
            return Err(format!(
                "错误:extra_args 中含非法参数 {:?}(不得含 \"..\" 或以 \"/\" 开头)",
                a
            ));
        }
    }
    Ok(())
}

pub fn validate_api_path(path: &str) -> Result<(), String> {
    let t = path.trim();
    if t.is_empty() {
        return Err("错误:path 不能为空".to_string());
    }
    if t.contains("..") {
        return Err("错误:path 不得包含 \"..\"".to_string());
    }
    if t.starts_with('/') {
        return Err(
            "错误:path 不得以 \"/\" 开头(请用相对路径,如 repos/owner/repo/issues)".to_string(),
        );
    }
    if !t
        .chars()
        .all(|c| c.is_ascii_alphanumeric() || "/_.@-:".contains(c))
    {
        return Err("错误:path 仅允许字母数字与 / _ . @ - :".to_string());
    }
    Ok(())
}

pub fn gh_allowed(allowed: &[String]) -> Result<(), String> {
    if allowed.iter().any(|c| c == "gh") {
        Ok(())
    } else {
        Err("错误:当前配置 allowed_commands 未包含 gh(可在 config/tools.toml 或 CM_ALLOWED_COMMANDS 中加入)".to_string())
    }
}

pub fn join_json_fields(fields: &[String]) -> Result<String, String> {
    if fields.is_empty() {
        return Err("错误:fields 数组不能为空".to_string());
    }
    let mut out = Vec::new();
    for f in fields {
        let t = f.trim();
        if t.is_empty() {
            return Err("错误:fields 中含空字符串".to_string());
        }
        if !t.chars().all(|c| c.is_ascii_alphanumeric() || c == '_') {
            return Err(format!("错误:非法 json 字段名 {:?}", t));
        }
        out.push(t.to_string());
    }
    Ok(out.join(","))
}

pub fn clamp_limit(n: Option<u32>) -> u32 {
    n.unwrap_or(DEFAULT_LIST_LIMIT).clamp(1, MAX_LIMIT)
}

/// 解析 `gh_*` 工具 JSON 参数;失败时返回错误字符串(与 [`run_gh_vec`] 风格一致)。
pub fn parse_gh_tool_args(args_json: &str) -> Result<JsonValue, String> {
    crate::cm_tools::tools::parse_args_json(args_json)
}

pub fn push_repo_argv(argv: &mut Vec<String>, v: &JsonValue) -> Result<(), String> {
    if let Some(r) = v.get("repo").and_then(|x| x.as_str()) {
        validate_repo(r)?;
        argv.push("-R".into());
        argv.push(r.trim().to_string());
    }
    Ok(())
}

pub fn push_json_fields_argv(argv: &mut Vec<String>, v: &JsonValue) -> Result<(), String> {
    if let Some(arr) = v.get("fields").and_then(|x| x.as_array()) {
        let fields: Vec<String> = arr
            .iter()
            .filter_map(|x| x.as_str().map(String::from))
            .collect();
        let j = join_json_fields(&fields)?;
        argv.push("--json".into());
        argv.push(j);
    }
    Ok(())
}

pub fn push_web_argv(argv: &mut Vec<String>, v: &JsonValue) {
    if v.get("web").and_then(|x| x.as_bool()) == Some(true) {
        argv.push("--web".into());
    }
}

pub fn push_extra_args_argv(argv: &mut Vec<String>, v: &JsonValue) -> Result<(), String> {
    if let Some(arr) = v.get("extra_args").and_then(|x| x.as_array()) {
        let extra: Vec<String> = arr
            .iter()
            .filter_map(|x| x.as_str().map(String::from))
            .collect();
        validate_extra_args(&extra)?;
        argv.extend(extra);
    }
    Ok(())
}

pub fn push_list_state_argv(
    argv: &mut Vec<String>,
    v: &JsonValue,
    allow_merged: bool,
) -> Result<(), String> {
    if let Some(s) = v.get("state").and_then(|x| x.as_str()) {
        let st = s.trim();
        let valid = if allow_merged {
            matches!(st, "open" | "closed" | "merged" | "all")
        } else {
            matches!(st, "open" | "closed" | "all")
        };
        if !valid {
            return Err(if allow_merged {
                "错误:state 须为 open、closed、merged 或 all".to_string()
            } else {
                "错误:state 须为 open、closed 或 all".to_string()
            });
        }
        if st != "open" {
            argv.push("--state".into());
            argv.push(st.to_string());
        }
    }
    Ok(())
}

pub fn push_list_limit_argv(argv: &mut Vec<String>, v: &JsonValue) {
    let lim = clamp_limit(v.get("limit").and_then(|x| x.as_u64()).map(|u| u as u32));
    argv.push("--limit".into());
    argv.push(lim.to_string());
}

pub fn push_view_tail_argv(argv: &mut Vec<String>, v: &JsonValue) -> Result<(), String> {
    push_repo_argv(argv, v)?;
    push_json_fields_argv(argv, v)?;
    push_web_argv(argv, v);
    push_extra_args_argv(argv, v)?;
    Ok(())
}

pub fn push_list_tail_argv(
    argv: &mut Vec<String>,
    v: &JsonValue,
    allow_merged: bool,
) -> Result<(), String> {
    push_list_state_argv(argv, v, allow_merged)?;
    push_list_limit_argv(argv, v);
    push_json_fields_argv(argv, v)?;
    push_web_argv(argv, v);
    push_extra_args_argv(argv, v)?;
    Ok(())
}

pub fn try_pretty_json(stdout: &str) -> Option<String> {
    let t = stdout.trim();
    if t.is_empty() {
        return None;
    }
    let v: JsonValue = serde_json::from_str(t).ok()?;
    serde_json::to_string_pretty(&v).ok()
}

pub fn wrap_with_parsed(raw: String, stdout: &str) -> String {
    if let Some(pretty) = try_pretty_json(stdout) {
        format!(
            "{raw}\n\n---\n解析后的 JSON(供模型直接使用):\n{pretty}",
            raw = raw.trim_end(),
            pretty = pretty
        )
    } else {
        raw
    }
}

/// 从 `command::run` 风格输出中解析 `退出码:N`(可出现在 `命令:…` 行之后)。
pub fn command_formatted_exit_code(formatted: &str) -> Option<i32> {
    formatted.lines().find_map(|l| {
        l.strip_prefix("退出码:")
            .and_then(|s| s.trim().parse::<i32>().ok())
    })
}

/// 从 `command::run` 风格输出中提取「标准输出:」段落(不含后续「标准错误:」或模型用 JSON 附录)。
pub fn extract_stdout_from_formatted(out: &str) -> &str {
    let Some(idx) = out.find("标准输出:\n") else {
        return "";
    };
    let start = idx + "标准输出:\n".len();
    let mut end = out[start..]
        .find("\n标准错误:\n")
        .map(|e| start + e)
        .unwrap_or(out.len());
    if let Some(mark) = out[start..end].find("\n\n---\n") {
        end = start + mark;
    }
    out[start..end].trim_end()
}

/// 从 `command::run` 风格输出中提取「标准错误:」段落(通常为失败时的诊断信息,位于输出末尾)。
///
/// 与 [`extract_stdout_from_formatted`] 不同,此处无需截断「\n\n---\n」模型 JSON 附录:
/// 该附录只在退出码 0 时由 `attach_json_if_exit_zero` 附加,而 stderr 提取用于失败路径。
pub fn extract_stderr_from_formatted(out: &str) -> &str {
    let Some(idx) = out.find("\n标准错误:\n") else {
        return "";
    };
    let start = idx + "\n标准错误:\n".len();
    out[start..].trim_end()
}

/// 存在 `退出码:0` 且 stdout 可解析为 JSON 时附加格式化块。
pub fn attach_json_if_exit_zero(formatted: String, stdout_raw: &str) -> String {
    if command_formatted_exit_code(&formatted) != Some(0) {
        return formatted;
    }
    wrap_with_parsed(formatted, stdout_raw)
}

pub fn run_gh_vec(
    argv: Vec<String>,
    max_output_len: usize,
    allowed_commands: &[String],
    working_dir: &Path,
) -> String {
    let args_json = match serde_json::to_string(&serde_json::json!({
        "command": "gh",
        "args": argv,
    })) {
        Ok(s) => s,
        Err(e) => return format!("错误:构造 gh 参数失败:{e}"),
    };
    let out = command::run(
        &args_json,
        max_output_len,
        allowed_commands,
        working_dir,
        None,
        false,
    );
    let stdout = extract_stdout_from_formatted(&out).to_string();
    attach_json_if_exit_zero(out, stdout.as_str())
}

pub fn validate_run_id(id: &str) -> Result<(), String> {
    let t = id.trim();
    if t.is_empty() {
        return Err("错误:run_id 不能为空".to_string());
    }
    if t.len() > 24 {
        return Err("错误:run_id 过长".to_string());
    }
    if !t.chars().all(|c| c.is_ascii_digit()) {
        return Err(
            "错误:run_id 须为纯数字(与 `gh run list --json databaseId` 一致)".to_string(),
        );
    }
    Ok(())
}

pub fn validate_release_tag(tag: &str) -> Result<(), String> {
    let t = tag.trim();
    if t.is_empty() {
        return Err("错误:tag 不能为空".to_string());
    }
    if t.len() > MAX_RELEASE_TAG_LEN {
        return Err("错误:tag 过长".to_string());
    }
    if t.contains("..") || t.starts_with('/') {
        return Err("错误:tag 不得含 \"..\" 或以 \"/\" 开头".to_string());
    }
    if !t
        .chars()
        .all(|c| c.is_ascii_alphanumeric() || "-_.+@".contains(c))
    {
        return Err("错误:tag 仅允许字母数字与 - _ . + @".to_string());
    }
    Ok(())
}

pub fn validate_search_query(q: &str) -> Result<(), String> {
    let t = q.trim();
    if t.is_empty() {
        return Err("错误:query 不能为空".to_string());
    }
    if t.len() > MAX_SEARCH_QUERY_BYTES {
        return Err(format!(
            "错误:query 过长(上限 {} 字节)",
            MAX_SEARCH_QUERY_BYTES
        ));
    }
    if t.contains("..") {
        return Err("错误:query 不得包含 \"..\"".to_string());
    }
    for ch in t.chars() {
        if matches!(ch, '\n' | '\r' | '\0' | '\t') {
            return Err("错误:query 不得含换行、制表符或空字符".to_string());
        }
        if matches!(ch, ';' | '|' | '&' | '`' | '$' | '<' | '>') {
            return Err(format!("错误:query 含不允许的字符 {:?}", ch));
        }
    }
    Ok(())
}

pub fn validate_pr_title(title: &str) -> Result<(), String> {
    let t = title.trim();
    if t.is_empty() {
        return Err("错误:title 不能为空".to_string());
    }
    if t.len() > MAX_PR_TITLE_BYTES {
        return Err(format!(
            "错误:title 过长(上限 {} 字节)",
            MAX_PR_TITLE_BYTES
        ));
    }
    if t.contains('\0') || t.contains('\n') || t.contains('\r') {
        return Err("错误:title 不得含换行或空字符".to_string());
    }
    Ok(())
}

pub fn validate_pr_body(body: &str) -> Result<(), String> {
    if body.len() > MAX_PR_BODY_BYTES {
        return Err(format!(
            "错误:body 过长(上限 {} 字节)",
            MAX_PR_BODY_BYTES
        ));
    }
    if body.contains('\0') {
        return Err("错误:body 不得含空字符".to_string());
    }
    Ok(())
}

/// `--base` / `--head` 传给 `gh pr create` 的单个 token(分支名或 `owner:branch` 等)。
pub fn validate_pr_ref_token(token: &str) -> Result<(), String> {
    let t = token.trim();
    if t.is_empty() {
        return Err("错误:base/head 不能为空".to_string());
    }
    if t.len() > MAX_PR_REF_TOKEN_BYTES {
        return Err(format!(
            "错误:base/head 过长(上限 {} 字节)",
            MAX_PR_REF_TOKEN_BYTES
        ));
    }
    if t.contains("..") || t.starts_with('/') {
        return Err("错误:base/head 不得含 \"..\" 或以 \"/\" 开头".to_string());
    }
    if !t
        .chars()
        .all(|c| c.is_ascii_alphanumeric() || "-_./:@".contains(c))
    {
        return Err(
            "错误:base/head 仅允许字母数字与 - _ . / : @(与常见分支 / fork:branch 写法一致)"
                .to_string(),
        );
    }
    Ok(())
}

pub fn validate_job_name(name: &str) -> Result<(), String> {
    let t = name.trim();
    if t.is_empty() {
        return Err("错误:job 不能为空".to_string());
    }
    if t.len() > MAX_JOB_NAME_LEN {
        return Err("错误:job 名称过长".to_string());
    }
    if !t
        .chars()
        .all(|c| c.is_ascii_alphanumeric() || c == '-' || c == '_' || c == ' ')
    {
        return Err("错误:job 仅允许字母数字、空格、连字符与下划线".to_string());
    }
    Ok(())
}

pub fn clamp_search_limit(n: Option<u32>) -> u32 {
    n.unwrap_or(DEFAULT_LIST_LIMIT).clamp(1, MAX_SEARCH_LIMIT)
}

pub fn write_workspace_temp_markdown(
    working_dir: &Path,
    filename: &str,
    content: &[u8],
    err_label: &str,
) -> Result<(tempfile::TempDir, String), String> {
    let dir = tempfile::tempdir_in(working_dir)
        .map_err(|e| format!("错误:无法在工作区内创建临时目录:{e}"))?;
    let path = dir.path().join(filename);
    std::fs::write(&path, content)
        .map_err(|e| format!("错误:写入 {err_label} 临时文件失败:{e}"))?;
    let path_str = path
        .to_str()
        .ok_or_else(|| format!("错误:{err_label} 临时文件路径非 UTF-8"))?
        .to_string();
    Ok((dir, path_str))
}

pub fn push_repo_arg(v: &JsonValue, argv: &mut Vec<String>) -> Result<(), String> {
    if let Some(r) = v.get("repo").and_then(|x| x.as_str()) {
        validate_repo(r)?;
        argv.push("-R".into());
        argv.push(r.trim().to_string());
    }
    Ok(())
}

pub fn push_extra_args_from_json(v: &JsonValue, argv: &mut Vec<String>) -> Result<(), String> {
    if let Some(arr) = v.get("extra_args").and_then(|x| x.as_array()) {
        let extra: Vec<String> = arr
            .iter()
            .filter_map(|x| x.as_str().map(String::from))
            .collect();
        validate_extra_args(&extra)?;
        argv.extend(extra);
    }
    Ok(())
}

/// 若 JSON 含 `fields` 数组,追加 `--json <joined>`(经 [`join_json_fields`] 校验;空数组会报错)。
pub fn push_json_fields_from_json(v: &JsonValue, argv: &mut Vec<String>) -> Result<(), String> {
    let Some(arr) = v.get("fields").and_then(|x| x.as_array()) else {
        return Ok(());
    };
    let fields: Vec<String> = arr
        .iter()
        .filter_map(|x| x.as_str().map(String::from))
        .collect();
    let joined = join_json_fields(&fields)?;
    argv.push("--json".into());
    argv.push(joined);
    Ok(())
}

pub fn push_bool_flag(v: &JsonValue, key: &str, flag: &str, argv: &mut Vec<String>) {
    if v.get(key).and_then(|x| x.as_bool()) == Some(true) {
        argv.push(flag.into());
    }
}

pub fn push_trimmed_string_flag(v: &JsonValue, key: &str, flag: &str, argv: &mut Vec<String>) {
    if let Some(s) = v.get(key).and_then(|x| x.as_str()) {
        let t = s.trim();
        if !t.is_empty() {
            argv.push(flag.into());
            argv.push(t.to_string());
        }
    }
}

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

    #[test]
    fn command_formatted_exit_code_skips_command_invocation_line() {
        let raw = "命令:gh pr checks\n退出码:0\n标准输出:\n[]\n";
        assert_eq!(command_formatted_exit_code(raw), Some(0));
    }

    #[test]
    fn extract_stdout_stops_before_parsed_json_appendix() {
        let raw = "命令:gh pr list\n退出码:0\n标准输出:\n[]\n\n---\n解析后的 JSON(供模型直接使用):\n[]\n";
        assert_eq!(extract_stdout_from_formatted(raw), "[]");
    }

    #[test]
    fn extract_stderr_returns_empty_when_absent() {
        let raw = "命令:gh pr create\n退出码:1\n标准输出:\n(无输出)\n";
        assert_eq!(extract_stderr_from_formatted(raw), "");
    }

    #[test]
    fn extract_stderr_takes_remaining_tail() {
        let raw = "命令:gh pr create --title t\n退出码:1\n标准输出:\n(无输出)\n标准错误:\npull request create failed: GraphQL: No commits between main and feat/x (createPullRequest)\n";
        assert_eq!(
            extract_stderr_from_formatted(raw),
            "pull request create failed: GraphQL: No commits between main and feat/x (createPullRequest)"
        );
    }

    #[test]
    fn attach_json_if_exit_zero_appends_after_command_line() {
        let raw = "命令:gh pr list\n退出码:0\n标准输出:\n[]\n".to_string();
        let out = attach_json_if_exit_zero(raw, "[]");
        assert!(out.contains("解析后的 JSON"), "{out}");
    }
}