Files
xiaoli-cli/plugins/cmd_executor.py
T
shuiyu1123 bac5ea01a9 feat: 统一错误处理 - ToolResult 类
- 新增 xcli_core/tool_result.py: ToolResult + ErrorCode
- unified_tool_manager: execute/mcp_call 返回 ToolResult
- cmd_executor: 所有返回改为 ToolResult
- file_manager: 所有返回改为 ToolResult
- 兼容旧接口: execute_dict() 返回 dict, handler 可返回 str 或 ToolResult
2026-06-19 00:26:49 +08:00

151 lines
4.8 KiB
Python

"""
命令执行器插件 - 跨平台 Shell 命令执行
"""
import os
import re
import subprocess
import platform
import sys
# 添加项目根目录到 path
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
from xcli_core.tool_result import ToolResult, ErrorCode
class Liugin:
"""Shell 命令执行器 - 跨平台命令行工具"""
def __init__(self):
self.usage = """Shell 命令执行器
操作:
run <命令> [--timeout 秒] - 执行 Shell 命令 (默认超时 30s)
示例:
run ls -la - 列出当前目录
run python3 --version - 查看 Python 版本
run git status - 查看 Git 状态
run make build --timeout 60 - 执行构建 (60秒超时)
注意:
- 跨平台兼容 (Linux/macOS/Windows)
- 输出限制 5000 字符
- 某些危险命令会被拦截
"""
self.cli = None
def set_cli(self, cli):
self.cli = cli
def get_tool_info(self):
return {
"name": "cmd_executor",
"description": "Shell 命令执行器 - 跨平台执行系统命令,支持超时控制",
"keywords": ["命令", "执行", "shell", "cmd", "终端", "命令行", "subprocess"],
"usage": self.usage
}
def get_mcp_definition(self):
return {
"name": "cmd_executor",
"description": "Shell 命令执行器",
"inputSchema": {
"type": "object",
"properties": {
"command": {"type": "string", "description": "要执行的命令"},
"timeout": {"type": "integer", "description": "超时秒数", "default": 30}
},
"required": ["command"]
}
}
def convert_mcp_args(self, arguments):
cmd = arguments.get("command", "")
timeout = arguments.get("timeout", "")
result = f"run {cmd}"
if timeout:
result += f" --timeout {timeout}"
return result
# 危险命令黑名单
BLOCKED = {
'rm -rf /', 'rm -rf ~', 'mkfs', 'dd if=', 'wipefs', 'shred',
':(){ :|:& };:', 'chmod -R 777 /', 'mv / ', 'wget http',
}
def handle(self, args: str):
try:
parts = args.strip().split(maxsplit=1)
if not parts:
return ToolResult.missing("操作。可用: run <命令>")
operation = parts[0].lower()
if operation != "run":
return ToolResult.fail(f"不支持的操作 '{operation}'。可用: run", ErrorCode.UNSUPPORTED_OP)
if len(parts) < 2:
return ToolResult.missing("要执行的命令")
rest = parts[1]
# 解析 --timeout
timeout = 30
timeout_match = re.search(r'--timeout\s+(\d+)', rest)
if timeout_match:
timeout = int(timeout_match.group(1))
rest = re.sub(r'--timeout\s+\d+', '', rest).strip()
if not rest:
return ToolResult.missing("要执行的命令")
# 安全检查
for blocked in self.BLOCKED:
if blocked in rest:
return ToolResult.fail(f"安全拦截: 检测到危险命令模式 '{blocked}'", ErrorCode.PERMISSION_DENIED)
return self._execute(rest, timeout)
except Exception as e:
return ToolResult.fail(str(e), ErrorCode.INTERNAL_ERROR, tool_name="cmd_executor")
def _execute(self, command: str, timeout: int):
try:
use_shell = platform.system() == 'Windows'
result = subprocess.run(
command,
shell=True,
capture_output=True,
text=True,
timeout=timeout,
encoding='utf-8',
errors='replace'
)
stdout = result.stdout.strip()
stderr = result.stderr.strip()
rc = result.returncode
output = ""
if stdout:
output += stdout + "\n"
if stderr:
output += f"[stderr]\n{stderr}\n"
if rc != 0:
output += f"[exit code: {rc}]\n"
if not output:
output = f"命令执行完成,无输出 (超时: {timeout}s)"
if len(output) > 5000:
output = output[:5000] + f"\n... (截断,超时: {timeout}s)"
if rc != 0:
return ToolResult.fail(output.strip(), ErrorCode.EXEC_FAILED, tool_name="cmd_executor")
return ToolResult.ok(output.strip(), tool_name="cmd_executor")
except subprocess.TimeoutExpired:
return ToolResult.timeout(timeout, tool_name="cmd_executor")
except Exception as e:
return ToolResult.fail(str(e), ErrorCode.EXEC_FAILED, tool_name="cmd_executor")