PicoBot/src/tools/file_write.rs
oudecheng cda14360af chore: 建立工程化基线(rustfmt + clippy + CI + eslint + prettier)
配置:
- rustfmt.toml: 固化 max_width=100 / 4 空格缩进,cargo fmt 全量格式化
- Cargo.toml: 配置 [lints.rust] 与 [lints.clippy] 渐进式规则
- .github/workflows/ci.yml: Rust(fmt+clippy+test) + 前端(eslint+tsc+test) 双平台 CI
- Makefile: 新增 check/fmt/fix 目标,clippy 对齐 --all-targets --all-features
- web: eslint flat config + prettier 配置 + package.json 脚本与依赖
- src/main.rs: loop→while 修复 clippy::never_loop

对抗性审查发现并修复:
- eslint 缺 caughtErrorsIgnorePattern 导致 catch(_) 误报为 error
- 前端 lint 未接入 CI,现已补上 Lint 步骤
- Makefile 与 CI 的 clippy flags 不一致,已对齐
2026-08-03 23:24:02 +08:00

270 lines
8.3 KiB
Rust

use std::path::Path;
use async_trait::async_trait;
use serde_json::json;
use crate::tools::traits::{Tool, ToolResult};
pub struct FileWriteTool {
allowed_dir: Option<String>,
}
impl FileWriteTool {
pub fn new() -> Self {
Self { allowed_dir: None }
}
pub fn with_allowed_dir(dir: String) -> Self {
Self {
allowed_dir: Some(dir),
}
}
fn resolve_path(&self, path: &str) -> Result<std::path::PathBuf, String> {
let p = Path::new(path);
let resolved = if p.is_absolute() {
p.to_path_buf()
} else {
std::env::current_dir()
.map_err(|e| format!("Failed to get current directory: {}", e))?
.join(p)
};
// Check directory restriction
if let Some(ref allowed) = self.allowed_dir {
// canonicalize both paths to resolve symlinks and prevent path traversal
// via symlinks inside allowed_dir pointing outside.
// For write tool the target file may not exist yet; fall back to
// canonicalizing the parent directory.
let canonical_allowed = std::fs::canonicalize(allowed)
.map_err(|e| format!("Failed to canonicalize allowed dir '{}': {}", allowed, e))?;
let canonical_resolved = match std::fs::canonicalize(&resolved) {
Ok(c) => c,
Err(_) => {
// File doesn't exist yet; canonicalize parent directory
let parent = resolved
.parent()
.ok_or_else(|| format!("Path '{}' has no parent directory", path))?;
let canonical_parent = std::fs::canonicalize(parent).map_err(|e| {
format!(
"Failed to canonicalize parent directory of '{}': {}",
path, e
)
})?;
canonical_parent.join(
resolved
.file_name()
.ok_or_else(|| format!("Path '{}' has no file name component", path))?,
)
}
};
if !canonical_resolved.starts_with(&canonical_allowed) {
return Err(format!(
"Path '{}' (resolves to '{}') is outside allowed directory '{}'",
path,
canonical_resolved.display(),
canonical_allowed.display()
));
}
}
Ok(resolved)
}
}
impl Default for FileWriteTool {
fn default() -> Self {
Self::new()
}
}
#[async_trait]
impl Tool for FileWriteTool {
fn name(&self) -> &str {
"write"
}
fn description(&self) -> &str {
"Write content to a file at the given path. Creates parent directories if needed."
}
fn parameters_schema(&self) -> serde_json::Value {
json!({
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "The file path to write to"
},
"content": {
"type": "string",
"description": "The content to write"
}
},
"required": ["path", "content"]
})
}
async fn execute(&self, args: serde_json::Value) -> anyhow::Result<ToolResult> {
let path = match args.get("path").and_then(|v| v.as_str()) {
Some(p) => p,
None => {
return Ok(ToolResult {
success: false,
output: String::new(),
error: Some("Missing required parameter: path".to_string()),
});
}
};
let content = match args.get("content").and_then(|v| v.as_str()) {
Some(c) => c,
None => {
return Ok(ToolResult {
success: false,
output: String::new(),
error: Some("Missing required parameter: content".to_string()),
});
}
};
let resolved = match self.resolve_path(path) {
Ok(p) => p,
Err(e) => {
return Ok(ToolResult {
success: false,
output: String::new(),
error: Some(e),
});
}
};
// Create parent directories if needed
if let Some(parent) = resolved.parent() {
if !parent.exists() {
if let Err(e) = std::fs::create_dir_all(parent) {
return Ok(ToolResult {
success: false,
output: String::new(),
error: Some(format!("Failed to create parent directory: {}", e)),
});
}
}
}
match std::fs::write(&resolved, content) {
Ok(_) => Ok(ToolResult {
success: true,
output: format!(
"Successfully wrote {} bytes to {}",
content.len(),
resolved.display()
),
error: None,
}),
Err(e) => Ok(ToolResult {
success: false,
output: String::new(),
error: Some(format!("Failed to write file: {}", e)),
}),
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use tempfile::TempDir;
#[tokio::test]
async fn test_write_simple_file() {
let temp_dir = TempDir::new().unwrap();
let file_path = temp_dir.path().join("test.txt");
let tool = FileWriteTool::new();
let result = tool
.execute(json!({
"path": file_path.to_str().unwrap(),
"content": "Hello, World!"
}))
.await
.unwrap();
assert!(result.success);
assert!(result.output.contains("Successfully wrote"));
// Verify content
let read_content = std::fs::read_to_string(&file_path).unwrap();
assert_eq!(read_content, "Hello, World!");
}
#[tokio::test]
async fn test_write_creates_parent_dirs() {
let temp_dir = TempDir::new().unwrap();
let file_path = temp_dir.path().join("subdir1/subdir2/test.txt");
let tool = FileWriteTool::new();
let result = tool
.execute(json!({
"path": file_path.to_str().unwrap(),
"content": "Nested content"
}))
.await
.unwrap();
assert!(result.success);
// Verify content
let read_content = std::fs::read_to_string(&file_path).unwrap();
assert_eq!(read_content, "Nested content");
}
#[tokio::test]
async fn test_write_missing_path() {
let tool = FileWriteTool::new();
let result = tool.execute(json!({ "content": "Hello" })).await.unwrap();
assert!(!result.success);
assert!(result.error.unwrap().contains("path"));
}
#[tokio::test]
async fn test_write_missing_content() {
let tool = FileWriteTool::new();
// 使用临时目录确保跨平台兼容
let temp_dir = tempfile::tempdir().unwrap();
let test_path = temp_dir.path().join("test.txt");
let result = tool
.execute(json!({ "path": test_path.to_str().unwrap() }))
.await
.unwrap();
assert!(!result.success);
assert!(result.error.unwrap().contains("content"));
}
#[tokio::test]
async fn test_overwrite_file() {
let temp_dir = TempDir::new().unwrap();
let file_path = temp_dir.path().join("test.txt");
// Write initial content
std::fs::write(&file_path, "Initial content").unwrap();
let tool = FileWriteTool::new();
let result = tool
.execute(json!({
"path": file_path.to_str().unwrap(),
"content": "New content"
}))
.await
.unwrap();
assert!(result.success);
// Verify overwritten
let read_content = std::fs::read_to_string(&file_path).unwrap();
assert_eq!(read_content, "New content");
}
}