Author SHA1 Message Date
CNWei c9ac3bda59 feat: 拆分 mirror-core
- 拆分 mirror-core,优化项目结构
2026-10-09 19:33:23 +08:00
CNWei 53579f9c65 feat: 目录结构迁移优化
- 将 MirrorRegistry MirrorTarget 迁移到 model.rs
- TargetConfig 独立实现 FromLua,解耦反序列化与业务校验
- mirror—shim 新增 command.rs 并将 to_command 移动到 command.rs
- 其他优化
2026-09-12 10:45:39 +08:00
CNWei 0bba69fd51 feat: 支持多版本 target 配置并优化执行前校验
- 将 MirrorTarget.target 改造为 TargetConfig 枚举(支持 Static 与 Versioned)
- TargetConfig 独立实现 FromLua,解耦反序列化与业务校验
- to_command 调整为显式接收执行路径,简化构建逻辑
- 增加未选择版本时的前置拦截与友好提示
2026-09-10 20:15:37 +08:00
CNWei 38dabd2ace refactor(core,shim): 统一基于 thiserror 的错误体系
- 移除 anyhow,使用 thiserror 定义强类型 Error 枚举
- 支持 #[from] 自动转换 mlua::Error,关键路径保留源码与上下文
- LuaRuntimeBuilder 采用惰性错误收集,简化链式初始化调用
- MirrorRegistry 实现规范化 FromLuaConversionError 错误转换
2026-09-10 14:33:54 +08:00
CNWei 94b4c23299 refactor(spec,loader): 优化项目结构,
- 提取公共方法
- 优化 Mirror FromLua trait 处理逻辑
- 新增 logger.rs 统一日志处理
- 其他优化
2026-09-07 17:02:54 +08:00
CNWei 941558cb92 feat(cli): 优化 log 子命令并引入 LogLevel 强类型解析,重构 commands.lua 注册表解析与校验逻辑
- 调整 LogLevel 的 FromStr 错误类型为 String,适配 clap 的 value_parser
- log 子命令直接绑定 LogLevel 枚举,消除硬编码校验与类型转换
- 规范化日志级别更新与配置读取逻辑
- handler 类型有 Function 改为 String
2026-09-04 20:20:22 +08:00
CNWei 0c478ae39d refactor(spec,loader): 精简项目结构,移除对json配置的支持
- 优化 spec,loader 部分功能合并到 mirror
- 移除 loader 降级策略逻辑
- 新增 logger.rs 统一日志处理
- 其他优化
2026-08-29 17:01:17 +08:00
CNWei 3db8945e16 refactor(mirror),feat(runtime): 支持在 mirror.lua 中通过 tools_dir 设置自定义目录;优化参数解析与 Command 构建逻辑
- 新增 Lua 动态配置 tools 目录并返回完整路径
- 将 `resolve_args` 和 `to_command` 改为接受泛型 `IntoIterator`,解耦参数来源
- 统一使用 `chain` 零拷贝合并预设参数与运行时参数,消除多余堆分配
- 提权回退分支改为直接复用 `cmd.get_args()`,修复提权时 `mr:` 别名未展开的缺陷
- 规范参数与变量命名,完善代码注释
2026-08-28 17:21:29 +08:00
CNWei 219a6b3d51 refactor(validators): 优化别名解析流程
- 新增 parse_tokens 按空格切分字符串
- 其他优化
2026-08-26 17:47:21 +08:00
CNWei 9e1051737a refactor: 新增别名解析流程
- 封装通用标量/数组校验与提取方法
- 将别名解析拆分为数据清洗、循环引用检测与拓扑展开三阶段
- 重命名项目为 mirror
- 其他优化
2026-08-26 11:52:55 +08:00
CNWei 8aba995fb0 refactor(main): 优化 Lua 配置解析与校验逻辑,
- 优化 Lua 配置解析与校验逻辑
- 清理废弃的注释代码
2026-08-25 15:12:20 +08:00
CNWei 0ac7a07133 refactor(validators,main): 重构 Lua 配置解析与校验逻辑,提取 LuaValidator 模块; 抽离进程执行与 Win32 提权逻辑
- 重构 Lua 配置解析与校验逻辑
- 将控制台事件监听与 UAC 提权执行逻辑迁移至 win.rs 模块
- 简化 main 函数,提升代码可读性与模块化程度
- 清理废弃的注释代码
2026-08-24 20:27:35 +08:00
CNWei 75103dae3c fix(config): 优化 lua 数据校验逻辑
- 新增 parse_sequence 统一处理数组校验
2026-08-21 20:31:15 +08:00
CNWei c7999a90f6 fix(config): 优化 lua 数据校验逻辑
- 新增 ValueValidator 优化结构化校验逻辑
2026-08-21 17:29:40 +08:00
CNWei 428da76a81 fix(config): 优化 layout
- 新增 从环境变量解析目录结构
2026-08-20 14:30:14 +08:00
CNWei f59040c11e fix(config): 优化配置解析
- 完善 `FromLua` 转换与边界校验,拦截空洞 (`nil`) 及非整数键
2026-08-19 11:34:16 +08:00
CNWei e3cb065b35 fix(shim): 优化配置解析、跨平台编码与 UAC 提权逻辑
- 使用 `OsString`/`PathBuf` 替代 `String`,实现跨平台无损编码与命令行参数透传
- 完善 `FromLua` 转换与边界校验,拦截空洞 (`nil`) 及非整数键
- 修复环境变量拼接时由于内置分隔符导致的 `join_paths` 报错
- 优化 Windows 下 UAC 提权执行逻辑,改用宽字符 API (`ShellExecuteExW`)
2026-08-18 11:15:30 +08:00
CNWei 5e69a6a980 refactor: 迁移 winapi 到 windows-sys,修复配置解析漏洞
- 依赖替换为 windows-sys 0.61,main.rs 全面适配新 API
  - 配置解析错误显式传播:env/args 类型错误、数组空洞、非法键不再静默
  吞错
  - 修正空环境变量与空参数语义,补充 UTF-8 与路径拼接校验
  - require 容错移至 Rust 侧,模块加载失败记录日志并跳过
  - 新增配置解析与运行时单元测试(19 个)
2026-08-14 20:09:34 +08:00
CNWei ed5439eaa1 refactor: 拆分代码结构为 lib.rs 与多模块架构
- 将核心业务逻辑抽离至 lib.rs,精简 main.rs 为纯粹的 CLI 入口
- 将代码按职责拆分为 config、env、runtime、shim 等子模块
- 提高可测试性与代码复用度
2026-08-14 10:36:09 +08:00
CNWei e52ba67d7e feat(env): 支持环境变量数组跨平台自动拼接
- 支持在 Lua 中配置数组格式的环境变量(如 PATH),由 Rust 按 OS 自动使用 `;` 或 `:` 拼接
- 保持普通字符串格式环境变量的直接覆盖逻辑
- 新增 `ShimConfig::to_command()` 用于快速创建 Command 对象
- 新增 error.rs 明确错误类型
- 新增 build.rs 优化编译
2026-08-13 20:11:55 +08:00
CNWei 4aa619f07e refactor: 配置文件引擎迁移至 mlua 并优化环境变量注入
- 配置文件解析引擎由 shim 替换为 mlua (Lua 5.4)
- 优化路由策略:统一以根目录 shims.lua 为入口,支持 tools/ 目录模块化降级探测
- 自动注入 __SHIM_DIR__ 绝对路径与 package.path 模块搜索路径
- 环境变量改用 Command::envs 安全注入,并在 UAC 提权时透传
2026-08-12 20:19:50 +08:00
55 changed files with 6342 additions and 276 deletions
+4
View File
@@ -1,3 +1,7 @@
/target /target
/.vscode /.vscode
/.idea
*.exe *.exe
./Cargo.lock
**/target
**/Cargo.lock
Generated
+993 -11
View File
File diff suppressed because it is too large Load Diff
+41 -30
View File
@@ -1,31 +1,42 @@
[package] [workspace]
name = "rshim" resolver = "2"
version = "0.1.0" members = [
authors = ["anonymous <[email protected]>"] "mirror-core", "mirror-cli",
edition = "2018" "mirror-shim",
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[profile.release]
opt-level = "z"
panic = "abort"
[dependencies]
fs-err = "2.5.0"
unicode-bom = "1"
[dependencies.winapi]
version = "0.3"
features = [
"wincon",
"consoleapi",
"minwindef",
"shellapi",
"winuser",
"synchapi",
"combaseapi",
"winbase",
"processthreadsapi",
"objbase",
"impl-default"
] ]
#[package]
#name = "mirror"
[workspace.package]
version = "0.1.0"
edition = "2024"
rust-version = "1.94"
license = "MIT OR Unlicense"
description = "A fast, safe Rust shim launcher for Scoop"
[workspace.dependencies]
anyhow = "1.0.104"
mlua = { version = "0.12.0", features = ["lua54", "vendored","send","macros"] }
windows-sys = { version = "0.61.2", features = [
"Win32_Foundation",
"Win32_System_Com",
"Win32_System_Console",
"Win32_System_Registry",
"Win32_System_Threading",
"Win32_UI_Shell",
"Win32_UI_WindowsAndMessaging",
"Win32_Globalization"
] }
dunce = "1.0.5"
# 日志
tracing = "0.1.44"
tracing-subscriber = { version = "0.3", features = ["env-filter","fmt"] }
tracing-appender = "0.2"
serde = { version = "1.0.229", features = ["derive"] }
tinyjson="2.5.1"
#toml = "1.1.4+spec-1.1.0"
+46
View File
@@ -0,0 +1,46 @@
use std::env;
use std::fs;
use std::path::PathBuf;
fn main() {
// CARGO_MANIFEST_DIR -> 项目根目录路径
// CARGO_TARGET_DIR -> 用户自定义了 target 目录,使用该变量
let manifest_dir = env::var("CARGO_MANIFEST_DIR").unwrap();
let target_dir = env::var("CARGO_TARGET_DIR")
.ok()
.map(PathBuf::from)
.unwrap_or_else(|| PathBuf::from(&manifest_dir).join("target"));
// PROFILE -> 获取当前构建配置文件(debug/release)
let profile = env::var("PROFILE").unwrap();
// let output_dir = target_dir.join(&profile);
// 在 target/debug/ 或 target/release/ 下创建 bin2 目录
let output_dir = target_dir.join(&profile).join("bin2");
// cargo:rerun-if-changed -> 当指定文件变化时,重新运行 xxx
println!("cargo:rerun-if-changed=build.rs");
println!("cargo:rerun-if-changed=mirror.lua");
println!("cargo:rustc-env=OUTPUT_DIR={}", output_dir.display());
// 创建目录
let subdirs = ["bin", "tools"];
for subdir in &subdirs {
let path = output_dir.join(subdir);
if !path.exists() {
fs::create_dir_all(&path).expect(&format!("Failed to create {} directory", subdir));
println!("Created: {:?}", path);
}
}
// 复制文件
let source = PathBuf::from(&manifest_dir).join("mirror.lua");
let destination = output_dir.join("mirror.lua");
if source.exists() {
fs::copy(&source, &destination).expect("Failed to copy mirror.lua");
println!("Copied mirror.lua to: {:?}", destination);
} else {
panic!("mirror.lua not found at: {:?}", source);
}
}
+27
View File
@@ -0,0 +1,27 @@
-- commands/commands.lua
return {
-- 1. 单文件子命令 (commands/use.lua)
["use"] = {
description = "Switch the active version of a tool",
module = mr.command("use")
},
-- 2. 单文件子命令 (commands/list.lua)
["list"] = {
description = "List available and currently activated versions",
module = mr.command("list")
},
-- 3. 复杂多文件子命令 (加载 commands/log/init.lua)
["log"] = {
description = "View or configure mirror runtime logs",
module = mr.command("log")
},
-- 4. 支持别名快捷映射 (例如 mr ls 等价于 mr list)
["ls"] = {
description = "Alias for list",
module = mr.command("list")
}
}
+24
View File
@@ -0,0 +1,24 @@
-- commands/log/init.lua
local argparse = require("argparse")
local utils = require("log.utils") -- 支持相对目录级 require
return function(raw_args)
local parser = argparse("mr log", "Manage and view mirror logs.")
parser:option("-l --level", "Set log level"):choices({"trace", "debug", "info", "warn", "error"})
parser:option("-t --tail", "Show last N lines"):convert(tonumber)
local ok, args = pcall(function() return parser:parse(raw_args) end)
if not ok then
error("__ARGPARSE_HELP__")
end
if args.level then
print(utils.format_level(args.level))
mr.fs.write(__MIRROR_DIR__ .. "/mirror-log.ini", "level = \"" .. args.level .. "\"\n")
print("✔ Updated log level.")
elseif args.tail then
print(string.format("Tailing last %d lines...", args.tail))
else
print("Log module ready. Run 'mr log --help' for details.")
end
end
+8
View File
@@ -0,0 +1,8 @@
-- commands/log/utils.lua
local M = {}
function M.format_level(level)
return string.format("==> [LOG LEVEL: %s] <==", string.upper(level))
end
return M
+18
View File
@@ -0,0 +1,18 @@
[package]
name = "mirror-cli"
version = { workspace = true }
edition = { workspace = true }
description = "Mirror CLI Manager"
# 显式指定生成的二进制文件名
[[bin]]
name = "mr"
path = "src/main.rs"
[dependencies]
mirror-core = { path = "../mirror-core" }
clap = { version = "4.6.6", features = ["cargo", "color", "derive","string"] }
inquire="0.9.4"
tempfile="3.27.0"# 用于安全原子写入
mlua = { workspace = true }
anyhow = { workspace = true }
tracing = { workspace = true }
+76
View File
@@ -0,0 +1,76 @@
use crate::commands::dynamic::MrCommand;
use clap::{Arg, ArgAction, Command};
use mirror_core::LogLevel;
use std::ffi::OsString;
// 核心保留字:系统底座命令,神圣不可侵犯
const RESERVED_COMMANDS: &[&str] = &["use", "log", "help"];
// 引入强类型枚举
pub fn build(dynamic_cmds: MrCommand) -> Command {
let mut app = Command::new("mr")
.about(env!("CARGO_PKG_DESCRIPTION"))
.version(env!("CARGO_PKG_VERSION"))
.arg_required_else_help(true)
.subcommand(log_subcommand())
.subcommand(use_subcommand());
for (name, sub_cmd) in dynamic_cmds.commands {
if RESERVED_COMMANDS.contains(&name.as_str()) {
// 用户要是手痒写了 use.lua 或 log.lua,直接装作没看见
continue;
}
// let a =name.as_str()
// 开启 "string" feature 后,String 可以直接作为 Command 的入参
app = app.subcommand(
Command::new(name)
.about(sub_cmd.description)
.allow_external_subcommands(true),
);
}
app
}
/// 核心内置命令:版本切换
fn use_subcommand() -> Command {
Command::new("use")
.about("切换指定工具的生效版本 (支持交互式选择)")
.arg(
Arg::new("tool")
.required(true)
.value_name("TOOL")
.help("目标工具名称(在 mirror.lua 中声明的 key,例如 node)"),
)
.arg(
Arg::new("version")
.required(false)
.value_name("VERSION")
.help("目标版本号(省略时进入交互式单选)"),
)
}
/// 构建基础 CLI 骨架(内置 Rust 原生命令与参数规则)
fn log_subcommand() -> Command {
Command::new("log")
.about("查看或修改 mirror.ini 日志配置")
.arg(
Arg::new("level")
.short('l')
.long("level")
.value_name("LEVEL")
.help("设置日志级别 (off, error, warn, info, debug, trace)")
.value_parser(clap::value_parser!(LogLevel)),
)
.arg(
Arg::new("dir")
.short('d')
.long("dir")
.value_name("PATH")
.help("设置日志存放路径(绝对路径或相对于 base_dir 的相对路径)"),
)
}
pub fn extract_raw_args(matches: &clap::ArgMatches) -> Vec<String> {
matches
.get_many::<OsString>("")
.unwrap_or_default()
.map(|s| s.to_string_lossy().into_owned())
.collect()
}
+59
View File
@@ -0,0 +1,59 @@
use anyhow::{Context, Result};
use mirror_core::{Layout, LogConfig, LogLevel};
use std::fs;
use std::path::PathBuf;
// Rust 原生处理 log 命令逻辑
pub(crate) fn log_handle(layout: &Layout, matches: &clap::ArgMatches) -> Result<()> {
let log_ini_path = layout.base_dir.join("mirror.ini");
let new_level = matches.get_one::<LogLevel>("level").copied();
let new_dir = matches.get_one::<String>("dir").map(|s| s.trim());
// 1. 反序列化:读取并解析现有配置;若文件不存在则使用默认配置
let mut config: LogConfig = if log_ini_path.is_file() {
let content = fs::read_to_string(&log_ini_path)
.with_context(|| format!("读取配置文件失败: {}", log_ini_path.display()))?;
content.parse().unwrap_or_default()
} else {
LogConfig::default()
};
// 2. 修改配置并写盘(仅更新用户指定的字段,未指定的字段保留原值)
if new_level.is_some() || new_dir.is_some() {
if let Some(lvl) = new_level {
config.level = lvl;
}
if let Some(dir) = new_dir {
config.log_dir = Some(PathBuf::from(dir));
}
// 序列化写回
fs::write(&log_ini_path, config.to_string())
.with_context(|| format!("写入日志配置文件失败: {}", log_ini_path.display()))?;
let actual_dir = config.resolve_log_dir(&layout.base_dir);
println!("✔ 日志配置已更新:");
println!(" 日志级别: {}", config.level.as_str());
println!(" 日志目录: {}", actual_dir.display());
println!(" 配置文件: {}", log_ini_path.display());
return Ok(());
}
// 3. 无修改参数时,展示当前配置状态
println!("=== Mirror 日志配置 ===");
println!("配置文件: {}", log_ini_path.display());
println!("---------------------");
if log_ini_path.is_file() {
print!("{config}");
} else {
println!("状态: 配置文件尚未创建");
println!("当前生效级别: {} (默认)", config.level.as_str());
println!(
"默认日志目录: {}",
config.resolve_log_dir(&layout.base_dir).display()
);
println!("\n提示: 可使用 'mr log -l debug' 或 'mr log -d my_logs' 进行配置修改");
}
Ok(())
}
+149
View File
@@ -0,0 +1,149 @@
use crate::validators;
use mirror_core::{conversion_err, validation_error};
use mlua::{FromLua, Lua, Value};
use std::collections::HashMap;
const ALLOWED_KEYS: &[&str] = &["module", "description"];
#[derive(Debug, Default, Clone)]
pub struct MrCommand {
pub commands: HashMap<String, MrSubCommand>,
}
impl MrCommand {
pub fn get(&self, name: &str) -> Option<&MrSubCommand> {
self.commands.get(name)
}
}
impl FromLua for MrCommand {
fn from_lua(value: Value, lua: &Lua) -> mlua::Result<Self> {
let root_tbl = match value {
Value::Table(t) => t,
other => {
return Err(conversion_err(
other.type_name(),
"MrCommand",
format!(
"commands 注册表的顶层配置必须是 Table,实际检测到: {}",
other.type_name()
),
));
}
};
let mut commands = HashMap::new();
for pair in root_tbl.pairs::<Value, Value>() {
let (cmd_name, cmd_entry) = pair?;
let cmd_name = validators::validate_command_name(&cmd_name)?;
// 2. 校验 entry 是否是 Table
if !cmd_entry.is_table() {
return Err(conversion_err(
cmd_entry.type_name(),
"MrCommand",
format!(
"子命令 '{cmd_name}' 的配置必须是 Table,实际检测到: {}",
cmd_entry.type_name()
),
));
}
// 3. 直接交由子命令解析,外层负责补充错误上下文
let cmd_def = MrSubCommand::from_lua(cmd_entry, lua).map_err(|err| {
validation_error(format!("子命令 '{cmd_name}' 配置解析失败:\n{err}"))
})?;
commands.insert(cmd_name, cmd_def);
}
Ok(Self { commands })
}
}
#[derive(Debug, Default, Clone)]
pub struct MrSubCommand {
/// 命令处理函数:必须是 Lua Function
pub(crate) module: String,
/// 命令行说明:必须是普通文本字符串
pub(crate) description: String,
}
impl FromLua for MrSubCommand {
fn from_lua(value: Value, _lua: &Lua) -> mlua::Result<Self> {
let table = match value {
Value::Table(t) => t,
other => {
return Err(conversion_err(
other.type_name(),
"MrSubCommand",
format!("配置必须是 Table,实际检测到: {}", other.type_name()),
));
}
};
// validators::LuaValidator::parse_command_entry(&tbl)
for pair in table.pairs::<Value, Value>() {
let (key, _) = pair?;
let key_str = validators::validate_command_name(&key)?;
if !ALLOWED_KEYS.contains(&key_str.as_str()) {
return Err(validation_error(format!(
"包含未知字段 '{key_str}'。\n\
==> 合法字段仅支持: {}\n\
==> 请检查是否存在拼写手误(例如把 handler 写成了 handle/handlr)",
ALLOWED_KEYS.join(", ")
)));
}
}
let module_val = table.get::<Value>("module")?;
// let handler_func = match handler_val {
// Value::Function(f) => f,
// Value::Boolean(true) => {
// return Err(validation_error(
// "子命令 handler 返回了布尔值 true。\n\
// ==>排查提示:脚本已成功加载,但未返回函数。\n\
// ==>请在末尾加上 'return function(args) ... end'。",
// ));
// }
// Value::Nil => {
// return Err(validation_error(
// "子命令缺少必填字段 handler(或对应脚本未返回函数)",
// ));
// }
// other => {
// return Err(validation_error(format!(
// "'handler' 必须是函数 (function),实际类型是: {}",
// other.type_name()
// )));
// }
// };
let module = match module_val {
Value::String(s) => {
// 兜底归一化(防止用户手写 module = "a/b" 时未走 mr.command)
// 同时兼容直接写字符串的情况
s.to_str()?.replace(['/', '\\'], ".")
}
other => {
return Err(mlua::Error::runtime(format!(
"module 必须通过 mr.command(\"xxx\") 声明,实际为 {}",
other.type_name()
)));
}
};
// 可选字段: args(缺失或 nil 时默认空列表;保留空字符串参数,与提权路径的 "" 语义一致)
let description_val = table.get::<Value>("description")?;
let description = match description_val {
Value::Nil => String::new(),
Value::String(s) => s.to_str()?.to_string(),
other => {
return Err(validation_error(format!(
"必须是字符串文本,实际类型是 {}",
other.type_name()
)));
}
};
// let handler = lua.create_registry_value(handler_func)?;
Ok(Self {
module,
description,
})
}
}
+5
View File
@@ -0,0 +1,5 @@
pub(crate) mod builtin;
pub(crate) mod dynamic;
mod use_cmd;
pub use use_cmd::switch_version;
+145
View File
@@ -0,0 +1,145 @@
use inquire::Select;
use std::fs::{self, File};
use std::io::{self, Write};
use std::path::{Path, PathBuf};
use tempfile::NamedTempFile;
// 引入你的 mirror-core 类型
use mirror_core::{MirrorRegistry, TargetConfig};
#[derive(Debug)]
pub enum UseError {
ToolNotFound(String),
NotVersioned(String),
HomeDirNotFound(PathBuf),
NoVersionsAvailable(PathBuf),
UserCancelled,
Io(io::Error),
TargetValidationFailed(PathBuf),
}
/// 执行版本切换主流程
pub fn switch_version(
registry: &MirrorRegistry,
tool_name: &str,
target_version: Option<&str>,
) -> Result<(), UseError> {
// 1. 获取配置并断言必须是多版本工具
let spec = registry
.targets
.get(tool_name)
.ok_or_else(|| UseError::ToolNotFound(tool_name.to_string()))?;
let (home, version_file) = match &spec.target {
TargetConfig::Versioned {
home, version_file, ..
} => {
let v_file = version_file.as_deref().unwrap_or(".version");
(home, v_file)
}
TargetConfig::Static(_) => {
return Err(UseError::NotVersioned(tool_name.to_string()));
}
};
if !home.exists() {
return Err(UseError::HomeDirNotFound(home.clone()));
}
// 2. 扫描候选版本目录
let available_versions = scan_versions(home)?;
if available_versions.is_empty() {
return Err(UseError::NoVersionsAvailable(home.clone()));
}
// 3. 确定目标版本(命令行传入 OR 唤起 Inquire 单选菜单)
let selected_ver = match target_version {
Some(ver) => {
// 如果用户传了参,校验是否在候选集中(防呆)
if !available_versions.iter().any(|v| v == ver) {
eprintln!(
"警告: 目录 {:?} 下未发现版本 '{}',仍将强制写入。",
home, ver
);
}
ver.to_string()
}
None => {
// 尝试读取当前已激活的版本,作为 Inquire 的默认初始高亮项
let current_version_path = home.join(version_file);
let current_ver = fs::read_to_string(&current_version_path)
.map(|s| s.trim().to_string())
.ok();
prompt_user_select(&available_versions, current_ver.as_deref())?
}
};
// 4. 原子化持久化写入版本文件
let dest_version_path = home.join(version_file);
atomic_write(&dest_version_path, &selected_ver).map_err(UseError::Io)?;
println!("✔ 已成功将 '{}' 切换至版本: {}", tool_name, selected_ver);
Ok(())
}
/// 扫描 home 目录下的非隐藏有效子文件夹作为版本列表
fn scan_versions(home: &Path) -> Result<Vec<String>, UseError> {
let mut versions = Vec::new();
let entries = fs::read_dir(home).map_err(UseError::Io)?;
for entry in entries.filter_map(|e| e.ok()) {
let path = entry.path();
if path.is_dir() {
if let Some(dir_name) = path.file_name().and_then(|n| n.to_str()) {
// 排除以点开头的隐藏目录(如 .git, .cache)
if !dir_name.starts_with('.') {
versions.push(dir_name.to_string());
}
}
}
}
// 自然排序版本列表
versions.sort();
Ok(versions)
}
/// 唤起 Inquire 进行交互单选
fn prompt_user_select(
versions: &[String],
default_version: Option<&str>,
) -> Result<String, UseError> {
let mut prompt = Select::new("请选择要激活的目标版本:", versions.to_vec());
// 如果能读取到当前版本,默认选中该项
if let Some(def) = default_version {
if let Some(idx) = versions.iter().position(|v| v == def) {
prompt.starting_cursor = idx;
}
}
prompt.prompt().map_err(|_| UseError::UserCancelled)
}
/// 使用临时文件同目录重命名实现“原子写入”
///
/// 杜绝中途掉电、杀死进程导致的空文件损坏
fn atomic_write(dest_path: &Path, content: &str) -> io::Result<()> {
let parent_dir = dest_path
.parent()
.ok_or_else(|| io::Error::new(io::ErrorKind::NotFound, "Parent dir not found"))?;
// 必须在目标文件的同级目录下创建临时文件,跨盘符/分区会导致原子重命名 (Rename) 失败
let mut temp_file = NamedTempFile::new_in(parent_dir)?;
// 写入纯净内容,并强制落盘刷新 (Flush)
temp_file.write_all(content.trim().as_bytes())?;
temp_file.write_all(b"\n")?; // 末尾留标准换行符
temp_file.as_file().sync_all()?;
// 核心操作:原子覆盖(在 Windows 上内部会调用 ReplaceFileW,在 Unix 则是 rename)
temp_file.persist(dest_path).map_err(|e| e.error)?;
Ok(())
}
+14
View File
@@ -0,0 +1,14 @@
pub struct ExecuteError {
pub code: i32,
pub source: anyhow::Error,
}
impl ExecuteError {
pub fn new(code: i32, err: impl Into<anyhow::Error>) -> Self {
Self {
code,
source: err.into(),
}
}
}
+85
View File
@@ -0,0 +1,85 @@
use crate::cli;
use crate::commands::{builtin, dynamic::MrCommand};
use crate::error::ExecuteError;
use crate::plugins::register_mr_command;
use crate::commands::switch_version;
use anyhow::{Context, Result};
use mirror_core::{Layout, LuaRuntime, register_basics};
use mirror_core::MirrorRegistry;
// 成功的标准退出码
pub const EXIT_SUCCESS: i32 = 0;
// mr CLI 专有错误退出码
pub const EXIT_CONFIG_ERROR: i32 = 10; // 配置文件加载、解析失败
pub const EXIT_RUNTIME_ERROR: i32 = 11; // Lua 运行时初始化或脚本执行异常
pub const EXIT_COMMAND_NOT_FOUND: i32 = 12; // 找不到指定的子命令
pub const EXIT_BUILTIN_ERROR: i32 = 13; // 原生命令(如 log)执行失败
pub fn run(layout: &Layout) -> Result<(), ExecuteError> {
let runtime = LuaRuntime::builder()
.with(|lua| register_basics(lua, layout))
.with(register_mr_command)
.build()
.map_err(|e| ExecuteError::new(EXIT_RUNTIME_ERROR, e))?;
let registry_file = layout.base_dir.join("commands").join("commands.lua");
let commands: MrCommand = runtime
.eval_script(&registry_file)
.with_context(|| format!("加载命令配置失败: {}", registry_file.display()))
.map_err(|e| ExecuteError::new(EXIT_CONFIG_ERROR, e))?;
let app = cli::build(commands.clone());
let matches = app.get_matches();
match matches.subcommand() {
Some(("use", sub_matches)) => {
let tool = sub_matches.get_one::<String>("tool").unwrap();
let version = sub_matches.get_one::<String>("version").map(|s| s.as_str());
// 惰性加载 mirror.lua:按需获取 MirrorRegistry
let mirror_file = layout.base_dir.join("mirror.lua");
let registry: MirrorRegistry = runtime
.eval_script(&mirror_file)
.with_context(|| format!("解析主配置失败: {}", mirror_file.display()))
.map_err(|e| ExecuteError::new(EXIT_CONFIG_ERROR, e))?;
if let Err(e) = switch_version(&registry, tool, version) {
eprintln!("[mr] 切换失败: {:?}", e);
std::process::exit(1);
}
}
// 分支 A: 原生 Rust 实现的命令
Some(("log", sub_m)) => {
builtin::log_handle(&layout, sub_m)
.map_err(|e| ExecuteError::new(EXIT_BUILTIN_ERROR, e))?;
}
// 分支 B: 动态 Lua 注册的命令
Some((cmd_name, sub_m)) => {
let sub_cmd = commands.get(cmd_name).ok_or_else(|| {
ExecuteError::new(
EXIT_COMMAND_NOT_FOUND,
anyhow::anyhow!("未找到子命令 '{cmd_name}'"),
)
})?;
let raw_args = cli::extract_raw_args(sub_m);
runtime
.require_and_run(&sub_cmd.module, raw_args)
.map_err(|e| {
ExecuteError::new(
EXIT_COMMAND_NOT_FOUND,
anyhow::anyhow!("执行子命令 '{}' 失败: {:#}", cmd_name, e),
)
})?;
}
// 分支 C: 未输入子命令(通常已被 Clap 的 arg_required_else_help 拦截)
None => {}//unreachable!(),
}
Ok(())
}
+44
View File
@@ -0,0 +1,44 @@
use crate::executor::EXIT_SUCCESS;
use anyhow::Context;
use mirror_core::{Layout, init_logging_from};
use std::process::exit;
use tracing::{debug, error};
mod cli;
mod commands;
mod error;
mod executor;
mod plugins;
mod validators;
fn main() {
let current_exe = match std::env::current_exe().context("获取代理程序路径失败") {
Ok(exe) => exe,
Err(e) => {
eprintln!("垫片启动失败: {:#}", e);
exit(1);
}
};
let layout = match Layout::from(&current_exe) {
Ok(l) => l,
Err(e) => {
eprintln!("解析程序目录布局失败: {:#}", e);
exit(1);
}
};
let _guard = init_logging_from(&layout);
debug!("=== 管理程序启动 ===");
debug!(
exe = %current_exe.display(),
target_name = %layout.target_name,
"日志系统与布局上下文已就位"
);
// 核心运行:成功退出 0,失败根据 AppError 里的 code 退出
if let Err(app_err) = executor::run(&layout) {
error!("{:#}", app_err.source);
exit(app_err.code);
}
exit(EXIT_SUCCESS);
}
+24
View File
@@ -0,0 +1,24 @@
use mirror_core::Result;
use mlua::{Lua, Table, Value};
/// 仅存在于 CLI 侧的 DSL 扩展函数
pub fn register_mr_command(lua: &Lua) -> Result<()> {
let globals = lua.globals();
let mr_table: Table = match globals.get("mr")? {
Value::Table(tbl) => tbl,
_ => {
let tbl = lua.create_table()?;
globals.set("mr", &tbl)?;
tbl
}
};
let command_fn = lua.create_function(|_lua, mod_path: String| {
let normalized = mod_path.replace(['/', '\\'], ".");
Ok(normalized)
})?;
mr_table.set("command", command_fn)?;
Ok(())
}
+41
View File
@@ -0,0 +1,41 @@
use mirror_core::validation_error;
use mlua::Value;
pub fn validate_command_name(name: &Value) -> mlua::Result<String> {
let name_str = match name {
Value::String(s) => s
.to_str()
.map_err(|_| validation_error("子命令名称必须是合法的 UTF-8 字符串"))?
.to_string(),
other => {
return Err(validation_error(format!(
"命令行键名类型错误:期望 string,实际是 {}",
other.type_name()
)));
}
};
let trimmed = name_str.trim();
if trimmed.is_empty() {
return Err(validation_error("子命令名称不能为空字符串"));
}
// 2. 禁止包含空格与不可见控制符(否则 shell 与 clap 无法正确定位)
if name_str.contains(|c: char| c.is_whitespace()) {
return Err(validation_error(format!(
"子命令名称 [{name_str}] 非法:命令名不能包含空格或空白字符"
)));
}
if name_str.contains('=') {
return Err(validation_error(format!(
"子命令名称 [{}] 不能包含 '='",
name_str
)));
}
if name_str.contains('\0') {
return Err(validation_error(format!(
"子命令名称 [{}] 不能包含 NUL 字符",
name_str
)));
}
Ok(name_str)
}
+22
View File
@@ -0,0 +1,22 @@
[package]
name = "mirror-core"
version = { workspace = true }
edition = { workspace = true }
[dependencies]
mlua = { workspace = true }
dunce = { workspace = true }
tinyjson = { workspace = true }
windows-sys = { workspace = true }
serde = { workspace = true }
# 日志
tracing = { workspace = true }
tracing-subscriber = { workspace = true }
tracing-appender = { workspace = true }
thiserror = "2.0.20"
[features]
default = []
args = []
+39
View File
@@ -0,0 +1,39 @@
use std::collections::HashMap;
use std::ffi::OsString;
/// 单个目标程序的代理规格配置
/// 1. 核心参数路由解析(Delegation 到 Spec 的路由逻辑)
pub fn expand_aliases<I, S>(aliases: &HashMap<String, Vec<OsString>>, args: I) -> Vec<OsString>
where
I: IntoIterator<Item = S>,
S: AsRef<std::ffi::OsStr>,
{
let arg_iter = args.into_iter();
// 1. 预分配容量:利用迭代器的下限提示,避免多次 Realloc
let (lower_bound, _) = arg_iter.size_hint();
let mut expanded_args: Vec<OsString> = Vec::with_capacity(lower_bound);
for i in arg_iter {
let os_str = i.as_ref();
let arg_str = os_str.to_string_lossy();
// 检查参数是否带有 mr: 前缀
if let Some(alias_key) = arg_str.strip_prefix("mr:") {
// 如果在加载期打平好的字典中找到了对应的别名,直接展开追加
if let Some(alias_values) = aliases.get(alias_key) {
expanded_args.extend(alias_values.iter().cloned());
} else {
// 如果找不到对应的别名,按原样参数追加
expanded_args.push(os_str.to_os_string());
}
} else {
// 普通参数,直接追加
expanded_args.push(os_str.to_os_string());
}
}
expanded_args
}
+2
View File
@@ -0,0 +1,2 @@
pub(crate) mod alias;
pub(crate) mod tokens;
+161
View File
@@ -0,0 +1,161 @@
use std::ffi::OsString;
/// 将输入的字符串按 Shell 规则切分为独立的 CLI 参数 Token
/// - 自动过滤连续空格
/// - 支持单引号 `'...'` 和双引号 `"..."` 包裹包含空格的参数
pub fn parse_tokens(input: &str) -> Vec<OsString> {
let mut tokens = Vec::new();
let mut current_token = String::new();
let mut in_quote: Option<char> = None;
let mut chars = input.chars().peekable();
while let Some(ch) = chars.next() {
match (ch, in_quote) {
// 处理转义字符 (例如 \")
('\\', _quote) => {
if let Some(&next_ch) = chars.peek() {
let should_escape = if cfg!(windows) {
// Windows 策略:只有在转义引号、反斜杠本身时才剥离 \
// (如果在双引号内部,空格也不应该被 \ 转义)
next_ch == '"' || next_ch == '\'' || next_ch == '\\'
} else {
// Unix 策略:标准 Shell 转义(引号、反斜杠、空格等)
next_ch == '"'
|| next_ch == '\''
|| next_ch == '\\'
|| next_ch.is_whitespace()
};
if should_escape {
chars.next(); // 消耗掉下一个字符
current_token.push(next_ch);
} else {
// 保留 Windows 路径分隔符或未知转义中的 \
current_token.push('\\');
}
} else {
// 结尾孤立的 \
current_token.push('\\');
}
}
// 遇到引号:开启或关闭引号包裹
('"' | '\'', None) => {
in_quote = Some(ch);
}
('"' | '\'', Some(q)) if q == ch => {
in_quote = None;
}
// 引号外部遇到空白字符:切分出一个完整的 Token
(ch, None) if ch.is_whitespace() => {
if !current_token.is_empty() {
tokens.push(OsString::from(std::mem::take(&mut current_token)));
}
}
// 其他字符或引号内部字符:直接追加
(ch, _) => {
current_token.push(ch);
}
}
}
// 收尾最后一个 Token
if !current_token.is_empty() {
tokens.push(OsString::from(current_token));
}
tokens
}
#[cfg(test)]
mod tests {
use super::*;
use std::ffi::OsString;
/// 辅助宏:简化声明与断言对比
macro_rules! assert_tokens {
($input:expr, $expected:expr) => {
let actual = parse_tokens($input);
let expected_os: Vec<OsString> = $expected.into_iter().map(OsString::from).collect();
assert_eq!(
actual, expected_os,
"\n测试输入: {:?}\n期望输出: {:?}\n实际输出: {:?}",
$input, expected_os, actual
);
};
}
#[test]
fn test_parse_tokens_basic_split() {
// 场景 1:基础多参数拆分(空格分隔)
assert_tokens!("cargo run --verbose", vec!["cargo", "run", "--verbose"]);
assert_tokens!("git status", vec!["git", "status"]);
}
#[test]
fn test_parse_tokens_multi_alias_ref() {
// 场景 2:多别名混合与组合引用
assert_tokens!(
"mr:run --bin mr:base_flags",
vec!["mr:run", "--bin", "mr:base_flags"]
);
assert_tokens!(
"mr:app1 mr:app2 --flag",
vec!["mr:app1", "mr:app2", "--flag"]
);
}
#[test]
fn test_parse_tokens_continuous_whitespaces() {
// 场景 3:连续多空格与制表符过滤
assert_tokens!(
"mr:run --bin \t my_app",
vec!["mr:run", "--bin", "my_app"]
);
assert_tokens!(" cargo build ", vec!["cargo", "build"]);
}
#[test]
fn test_parse_tokens_double_quotes() {
// 场景 4:双引号包裹包含空格的参数
assert_tokens!(
"git commit -m \"fix a bug\"",
vec!["git", "commit", "-m", "fix a bug"]
);
assert_tokens!("echo \"hello world\"", vec!["echo", "hello world"]);
}
#[test]
fn test_parse_tokens_single_quotes() {
// 场景 5:单引号包裹包含空格的参数
assert_tokens!(
"gcc -O2 'my file.c' -o app",
vec!["gcc", "-O2", "my file.c", "-o", "app"]
);
assert_tokens!(
"python 'script with space.py'",
vec!["python", "script with space.py"]
);
}
#[test]
fn test_parse_tokens_escaped_characters() {
// 场景 6:反斜杠转义字符
assert_tokens!("echo hello\\ world", vec!["echo", "hello\\", "world"]);
assert_tokens!(
"echo \"hello \\\"world\\\"\"",
vec!["echo", "hello \"world\""]
);
}
#[test]
fn test_parse_tokens_single_scalar_and_edge_cases() {
// 场景 7:单标量参数与边界情况
assert_tokens!("git", vec!["git"]);
assert_tokens!("8000", vec!["8000"]);
assert_tokens!("", Vec::<&str>::new());
assert_tokens!(" ", Vec::<&str>::new());
}
#[test]
fn test_parse_tokens_unclosed_quotes() {
// 场景 8:未闭合引号的容错处理(会尽量追加到当前 Token 中)
assert_tokens!("echo \"hello world", vec!["echo", "hello world"]);
}
}
+89
View File
@@ -0,0 +1,89 @@
use crate::{Error, Result};
use mlua::LuaString;
use std::ffi::{OsStr, OsString};
use std::fmt;
/// Lua 字符串 -> OsString(Linux 直接透传字节,Windows 回退到系统代码页)
pub(crate) fn lua_string_2_os_string(s: &LuaString) -> Result<OsString> {
let raw_bytes = &s.as_bytes();
// 1. Unix 平台:直接零拷贝透传原始字节(无损支持任意编码)
#[cfg(unix)]
{
use std::os::unix::ffi::OsStrExt;
Ok(OsStr::from_bytes(raw_bytes).to_os_string())
}
// 2. Windows 平台:优先按 UTF-8 解码,失败则按当前系统本地代码页 (ANSI/GBK) 转换
#[cfg(windows)]
{
// 先尝试标准的 UTF-8
if let Ok(utf8_str) = std::str::from_utf8(raw_bytes) {
return Ok(OsString::from(utf8_str));
}
unsafe {
use std::os::windows::ffi::OsStringExt;
use windows_sys::Win32::Globalization::{
CP_ACP, MB_ERR_INVALID_CHARS, MultiByteToWideChar,
};
if raw_bytes.is_empty() {
return Ok(OsString::new());
}
let len = MultiByteToWideChar(
CP_ACP,
MB_ERR_INVALID_CHARS,
raw_bytes.as_ptr(),
raw_bytes.len() as i32,
std::ptr::null_mut(),
0,
);
if len <= 0 {
// 构造一个带上下文的 FromLua 转换错误,便于定位配置问题
return Err(Error::EncodingError {
from: "LuaString",
to: "OsString".to_string(),
message: format!("字符串{:?}包含无效或当前系统无法识别的编码字节", s),
});
}
let mut buf = vec![0u16; len as usize];
MultiByteToWideChar(
CP_ACP,
MB_ERR_INVALID_CHARS,
raw_bytes.as_ptr(),
raw_bytes.len() as i32,
buf.as_mut_ptr(),
len,
);
Ok(OsString::from_wide(&buf))
}
}
}
/// 跨平台检查 `OsStr` 中是否含 NUL 字符
pub(crate) fn ensure_no_nul(context: &impl fmt::Display, os_str: &OsStr) -> Result<()> {
#[cfg(unix)]
{
use std::os::unix::ffi::OsStrExt;
if os_str.as_bytes().contains(&0) {
return Err(Error::ContainsNul(format!(
"{} 的值不能包含 NUL 字符",
context
)));
}
}
#[cfg(windows)]
{
use std::os::windows::ffi::OsStrExt;
if os_str.encode_wide().any(|c| c == 0) {
return Err(Error::ContainsNul(format!(
"{} 的值不能包含 NUL 字符",
context
)));
}
}
Ok(())
}
+132
View File
@@ -0,0 +1,132 @@
//! Lua 边界层:只负责把 Lua 值搬成 DTO,不做任何语义判断。
//!
//! 这一层实现的是 mlua 的 `FromLua`,错误天然是 `mlua::Error`。
//! 领域规则(必填字段、类型、编码、命令名、别名环)全部在 `model.rs` 的
//! `TryFrom` 里,那里的错误统一是 `crate::Error`。
use super::model::{MirrorSpec, TargetSpec};
use mlua::{FromLua, Lua, Table, Value};
/// 注册表 DTO:键值对原样保留,命令名合法性交给领域层判断。
pub(crate) struct MirrorSpecDto {
pub entries: Vec<(Value, TargetSpecDto)>,
}
impl FromLua for MirrorSpecDto {
fn from_lua(value: Value, _lua: &Lua) -> mlua::Result<Self> {
let root = value
.as_table()
.ok_or_else(|| mlua::Error::FromLuaConversionError {
from: value.type_name(),
to: "Table".into(),
message: Some("mirror 全局注册表顶层必须是 table".into()),
})?;
let mut entries = Vec::new();
for pair in root.pairs::<Value, Value>() {
let (key, entry) = pair?;
let entry = entry
.as_table()
.ok_or_else(|| mlua::Error::FromLuaConversionError {
from: entry.type_name(),
to: "Table".into(),
message: Some(format!(
"目标工具 '{}' 的配置必须是 table,实际是 {}",
display_key(&key),
entry.type_name()
)),
})?;
entries.push((key, TargetSpecDto::from_table(&entry)?));
}
Ok(Self { entries })
}
}
/// 单个目标工具配置的 DTO:字段原样保留,类型判断留给领域层。
///
/// 字段一律用 `Value`:Lua 里"字段不存在"和"字段是 nil"是同一件事,
/// 都用 `Value::Nil` 表示。用 `Option<Value>` 反而会有两种"缺失"写法。
pub(crate) struct TargetSpecDto {
pub target: TargetDto,
pub args: Value,
pub env: Value,
pub aliases: Value,
}
impl TargetSpecDto {
fn from_table(table: &Table) -> mlua::Result<Self> {
Ok(Self {
target: TargetDto::from_value(table.get::<Value>("target")?)?,
args: table.get::<Value>("args")?,
env: table.get::<Value>("env")?,
aliases: table.get::<Value>("aliases")?,
})
}
}
/// target 的"形状":标量还是多版本 table。
///
/// `Value::Nil`(字段没写)会落进 `Scalar`,由领域层决定它是错误还是默认值。
/// 字符串能不能当路径、table 里 `home` 是否必填,也都留给领域层判断。
pub(crate) enum TargetDto {
Scalar(Value),
Versioned {
home: Value,
version_file: Value,
current: Value,
},
}
impl TargetDto {
fn from_value(value: Value) -> mlua::Result<Self> {
match value {
Value::Table(table) => Ok(Self::Versioned {
home: table.get::<Value>("home")?,
version_file: table.get::<Value>("version_file")?,
current: table.get::<Value>("current")?,
}),
other => Ok(Self::Scalar(other)),
}
}
}
/// 错误信息里显示注册表 key;非字符串 key 退化成类型名。
fn display_key(key: &Value) -> String {
match key {
Value::String(s) => s
.to_str()
.map(|s| s.to_string())
.unwrap_or_else(|_| "<非 UTF-8>".to_string()),
other => other.type_name().to_string(),
}
}
// ---------------------------------------------------------------------------
// 兼容适配器
//
// 消费方目前仍使用 `runtime.eval_script::<MirrorRegistry>(...)` 和
// `MirrorTarget::from_lua(...)`,所以保留这两个薄适配器:
// 边界提取(DTO)→ 领域转换(TryFrom)→ 错误翻译(Into)。
// 领域逻辑一行都不在这两个 impl 里。
// ---------------------------------------------------------------------------
impl FromLua for MirrorSpec {
fn from_lua(value: Value, lua: &Lua) -> mlua::Result<Self> {
let dto = MirrorSpecDto::from_lua(value, lua)?;
MirrorSpec::try_from(dto).map_err(Into::into)
}
}
impl FromLua for TargetSpec {
fn from_lua(value: Value, _lua: &Lua) -> mlua::Result<Self> {
let table = value
.as_table()
.ok_or_else(|| mlua::Error::FromLuaConversionError {
from: value.type_name(),
to: "Table".into(),
message: Some("目标工具配置必须是 table".into()),
})?;
let dto = TargetSpecDto::from_table(&table)?;
TargetSpec::try_from(dto).map_err(Into::into)
}
}
+26
View File
@@ -0,0 +1,26 @@
pub(crate) mod convert;
pub(crate) mod dto;
pub(crate) mod model;
pub(crate) mod naming;
pub(crate) mod values;
pub use model::{MirrorSpec, Target, TargetSpec};
pub use naming::parse_command_name;
// 兼容旧名:mirror-shim / mirror-cli 目前仍按这些名字引用。
// 等消费方迁移到 MirrorSpec / TargetSpec / Target 后可以删掉。
pub type MirrorRegistry = MirrorSpec;
pub type MirrorTarget = TargetSpec;
pub type TargetConfig = Target;
use crate::{LuaRuntime, Result};
use std::path::Path;
/// 配置加载入口:边界提取(DTO)→ 领域转换(TryFrom)。
///
/// 调用方拿到的错误全部是 `crate::Error`;DTO 与 mlua 的错误类型
/// 都被关在这个函数内部。
pub fn load_mirror_spec(runtime: &LuaRuntime, path: impl AsRef<Path>) -> Result<MirrorSpec> {
let dto: dto::MirrorSpecDto = runtime.eval_script(path)?;
MirrorSpec::try_from(dto)
}
+268
View File
@@ -0,0 +1,268 @@
//! 领域模型:只描述"配置应该长什么样",不实现 mlua 的 `FromLua`。
//!
//! 两阶段加载:
//! 1. `config::dto` 把 Lua 值搬成 DTO(边界,错误是 mlua 形状)
//! 2. 本文件的 `TryFrom<DTO>` 做语义校验与类型转换(错误全部是 `crate::Error`)
use crate::config::convert::{ensure_no_nul, lua_string_2_os_string};
use crate::config::dto::{MirrorSpecDto, TargetDto, TargetSpecDto};
use crate::config::values::{parse_aliases, parse_args, parse_env};
use crate::{Error, Result, parse_command_name};
use mlua::Value;
use std::collections::HashMap;
use std::ffi::{OsStr, OsString};
use std::path::PathBuf;
pub struct MirrorSpec {
pub targets: HashMap<String, TargetSpec>,
}
impl TryFrom<MirrorSpecDto> for MirrorSpec {
type Error = Error;
fn try_from(dto: MirrorSpecDto) -> Result<Self> {
let mut targets = HashMap::with_capacity(dto.entries.len());
for (key, tool) in dto.entries {
let name = parse_command_name(&key)?;
targets.insert(name, TargetSpec::try_from(tool)?);
}
Ok(Self { targets })
}
}
#[derive(Debug, Clone, Default)]
pub struct TargetSpec {
/// 目标程序可执行文件路径
pub target: Target,
/// 默认预设参数列表
pub args: Vec<OsString>,
/// 参数别名映射表(用于展开以 mr: 为前缀的别名)
pub aliases: HashMap<String, Vec<OsString>>,
/// 注入/覆盖的环境变量
pub env: HashMap<String, OsString>,
}
impl TargetSpec {
pub fn resolve_args<I, S>(&self, args: I) -> Vec<OsString>
where
I: IntoIterator<Item = S>,
S: AsRef<OsStr>,
{
crate::args::alias::expand_aliases(&self.aliases, args)
}
}
impl TryFrom<TargetSpecDto> for TargetSpec {
type Error = Error;
fn try_from(dto: TargetSpecDto) -> Result<Self> {
let target = Target::try_from(dto.target)?;
let args = match dto.args {
Value::Nil => Vec::new(),
value => parse_args(&value)?,
};
let aliases = match dto.aliases {
Value::Nil => HashMap::new(),
value => parse_aliases(&value)?,
};
let env = match dto.env {
Value::Nil => HashMap::new(),
value => parse_env(&value)?,
};
Ok(Self {
target,
args,
aliases,
env,
})
}
}
/// 目标可执行文件的定位配置(支持静态路径与多版本 Table)
#[derive(Debug, Clone)]
pub enum Target {
/// 静态单版本工具
Static(PathBuf),
/// 多版本管理
Versioned {
/// 工具主根目录(供 mr use 扫描候选版本)
home: PathBuf,
/// 版本真相源文件名(如 ".version",可选,默认 ".version")
version_file: Option<String>,
/// 当前激活版本的可执行文件完整路径(若未激活或不存在则为 None)
current: Option<PathBuf>,
},
}
impl Default for Target {
fn default() -> Self {
Target::Static(PathBuf::default())
}
}
impl Target {
/// 垫片程序(mirror-shim)专用快速通道:提取最终可执行路径
///
/// - Static: 返回自身路径
/// - Versioned: 返回 current 路径(若未激活则返回 None)
pub fn executable_path(&self) -> Option<&PathBuf> {
match self {
Target::Static(path) => Some(path),
Target::Versioned { current, .. } => current.as_ref(),
}
}
/// 管理程序(mr-cli)专用辅助方法:判断是否支持多版本
pub fn is_versioned(&self) -> bool {
matches!(self, Target::Versioned { .. })
}
}
impl TryFrom<TargetDto> for Target {
type Error = Error;
fn try_from(dto: TargetDto) -> Result<Self> {
match dto {
TargetDto::Scalar(Value::String(s)) => {
let os_str = lua_string_2_os_string(&s)?;
ensure_no_nul(&"target", &os_str)?;
Ok(Target::Static(PathBuf::from(os_str)))
}
TargetDto::Scalar(Value::Nil) => Err(Error::MissingField {
field: "target(应为字符串路径或多版本配置表)".into(),
}),
TargetDto::Scalar(other) => Err(Error::TypeMismatch {
field: "target".into(),
expected: "有效路径字符串或多版本配置表",
actual: other.type_name(),
}),
TargetDto::Versioned {
home,
version_file,
current,
} => {
let home = required_path(home, "home(多版本 target 表)", "target.home")?;
let version_file = optional_string(version_file, "target.version_file")?;
let current = optional_path(current, "target.current")?;
Ok(Target::Versioned {
home,
version_file,
current,
})
}
}
}
}
/// 必填路径字段:缺失/nil 报 `MissingField`,类型不符报 `TypeMismatch`
fn required_path(value: Value, field: &str, context: &str) -> Result<PathBuf> {
match value {
Value::Nil => Err(Error::MissingField {
field: field.to_string(),
}),
Value::String(s) => {
let os_str = lua_string_2_os_string(&s)?;
ensure_no_nul(&context, &os_str)?;
Ok(PathBuf::from(os_str))
}
other => Err(Error::TypeMismatch {
field: context.to_string(),
expected: "路径字符串",
actual: other.type_name(),
}),
}
}
/// 可选字符串字段:缺失/nil 视为 None
fn optional_string(value: Value, context: &str) -> Result<Option<String>> {
match value {
Value::Nil => Ok(None),
Value::String(s) => {
let os_str = lua_string_2_os_string(&s)?;
ensure_no_nul(&context, &os_str)?;
Ok(Some(os_str.to_string_lossy().into_owned()))
}
other => Err(Error::TypeMismatch {
field: context.to_string(),
expected: "字符串 (String)",
actual: other.type_name(),
}),
}
}
/// 可选路径字段:缺失/nil 视为 None
fn optional_path(value: Value, context: &str) -> Result<Option<PathBuf>> {
match value {
Value::Nil => Ok(None),
Value::String(s) => {
let os_str = lua_string_2_os_string(&s)?;
ensure_no_nul(&context, &os_str)?;
Ok(Some(PathBuf::from(os_str)))
}
other => Err(Error::TypeMismatch {
field: context.to_string(),
expected: "有效路径字符串 (LuaString) 或 nil",
actual: other.type_name(),
}),
}
}
#[cfg(test)]
mod tests {
use super::*;
/// 领域转换直接产出 crate::Error,不再被 mlua 包一层
#[test]
fn scalar_target_with_wrong_type_is_domain_error() {
let err = Target::try_from(TargetDto::Scalar(Value::Integer(42))).unwrap_err();
match err {
Error::TypeMismatch { field, actual, .. } => {
assert_eq!(field, "target");
assert_eq!(actual, "integer");
}
other => panic!("unexpected error: {other}"),
}
}
#[test]
fn versioned_target_requires_home() {
let dto = TargetDto::Versioned {
home: Value::Nil,
version_file: Value::Nil,
current: Value::Nil,
};
let err = Target::try_from(dto).unwrap_err();
assert!(matches!(err, Error::MissingField { field } if field.starts_with("home")));
}
/// 字段不存在和字段是 nil,在 Lua 里是同一件事
#[test]
fn nil_target_is_missing_field() {
let err = Target::try_from(TargetDto::Scalar(Value::Nil)).unwrap_err();
assert!(matches!(err, Error::MissingField { .. }));
}
#[test]
fn optional_field_type_is_checked() {
let err = optional_string(Value::Integer(1), "target.version_file").unwrap_err();
assert!(matches!(err, Error::TypeMismatch { field, .. } if field == "target.version_file"));
let err = optional_path(Value::Integer(1), "target.current").unwrap_err();
assert!(matches!(err, Error::TypeMismatch { field, .. } if field == "target.current"));
}
#[test]
fn missing_target_is_missing_field() {
let dto = TargetSpecDto {
target: TargetDto::Scalar(Value::Nil),
args: Value::Nil,
env: Value::Nil,
aliases: Value::Nil,
};
let err = TargetSpec::try_from(dto).unwrap_err();
assert!(matches!(err, Error::MissingField { .. }));
}
}
+146
View File
@@ -0,0 +1,146 @@
//! 名称规则:注册表键(命令名)、环境变量名、别名键。
//!
//! 三类名称的规则不同:
//! - 命令名:非空、不能含空白字符、不能含 `=`、不能含 NUL
//! - 环境变量名 / 别名:非空、不能含 `=`、不能含 NUL(允许空格)
use crate::{Error, NameKind, Result};
use mlua::Value;
/// 校验注册表键(命令名)
pub fn parse_command_name(name: &Value) -> Result<String> {
let name = parse_string(name, NameKind::Command)?;
if name.trim().is_empty() {
return Err(invalid(NameKind::Command, "不能为空字符串"));
}
if name.contains(|c: char| c.is_whitespace()) {
return Err(invalid(
NameKind::Command,
format!("[{name}] 不能包含空格或空白字符"),
));
}
if name.contains('=') {
return Err(invalid(NameKind::Command, format!("[{name}] 不能包含 '='")));
}
if name.contains('\0') {
return Err(invalid(
NameKind::Command,
format!("[{name}] 不能包含 NUL 字符"),
));
}
Ok(name)
}
/// 校验环境变量名 / 别名键
pub(crate) fn parse_name(kind: NameKind, name: &Value) -> Result<String> {
let name = parse_string(name, kind)?;
if name.is_empty() {
return Err(invalid(kind, "不能为空"));
}
if name.contains('=') {
return Err(invalid(kind, format!("[{name}] 不能包含 '='")));
}
if name.contains('\0') {
return Err(invalid(kind, format!("[{name}] 不能包含 NUL 字符")));
}
Ok(name)
}
/// 取字符串值;类型不对报 `TypeMismatch`,字节不是 UTF-8 报 `EncodingError`
fn parse_string(value: &Value, kind: NameKind) -> Result<String> {
match value {
Value::String(s) => {
s.to_str()
.map(|text| text.to_string())
.map_err(|e| Error::EncodingError {
from: "LuaString",
to: "String".to_string(),
message: format!("{kind}不是合法的 UTF-8 字符串: {e}"),
})
}
other => Err(Error::TypeMismatch {
field: kind.to_string(),
expected: "字符串 (String)",
actual: other.type_name(),
}),
}
}
fn invalid(kind: NameKind, reason: impl Into<String>) -> Error {
Error::InvalidName {
kind,
reason: reason.into(),
}
}
#[cfg(test)]
mod tests {
use super::*;
use mlua::Lua;
fn string(lua: &Lua, text: &str) -> Value {
Value::String(lua.create_string(text).unwrap())
}
#[test]
fn command_name_accepts_plain_name() {
let lua = Lua::new();
assert_eq!(parse_command_name(&string(&lua, "git")).unwrap(), "git");
}
#[test]
fn command_name_rejects_whitespace_and_equals() {
let lua = Lua::new();
for bad in ["git status", "git=1", " ", ""] {
let err = parse_command_name(&string(&lua, bad)).unwrap_err();
assert!(
matches!(
err,
Error::InvalidName {
kind: NameKind::Command,
..
}
),
"unexpected error for {bad:?}: {err}"
);
}
}
#[test]
fn command_name_type_error_is_type_mismatch() {
let err = parse_command_name(&Value::Integer(1)).unwrap_err();
assert!(matches!(err, Error::TypeMismatch { .. }));
}
#[test]
fn env_name_allows_space_but_rejects_equals() {
let lua = Lua::new();
assert_eq!(
parse_name(NameKind::EnvVar, &string(&lua, "MY VAR")).unwrap(),
"MY VAR"
);
let err = parse_name(NameKind::EnvVar, &string(&lua, "FOO=1")).unwrap_err();
assert!(matches!(
err,
Error::InvalidName {
kind: NameKind::EnvVar,
..
}
));
}
#[test]
fn alias_name_rejects_empty() {
let lua = Lua::new();
let err = parse_name(NameKind::Alias, &string(&lua, "")).unwrap_err();
assert!(matches!(
err,
Error::InvalidName {
kind: NameKind::Alias,
..
}
));
}
}
+172
View File
@@ -0,0 +1,172 @@
use super::as_table;
use super::scalar::{ScalarMode, to_os_strings};
use super::sequence::as_strict_sequence;
use crate::config::naming::parse_name;
use crate::{Error, NameKind, Result};
use mlua::Value;
use std::collections::HashMap;
use std::ffi::OsString;
const CONTEXT: &str = "命令行别名 (aliases)";
/// 数组嵌套上限,防止畸形配置打爆调用栈
const MAX_DEPTH: usize = 16;
/// `mr:` 引用链的最大深度
const MAX_ALIAS_DEPTH: usize = 32;
/// `aliases = { name = value }` → 已展开的别名表。
///
/// value 是"命令行片段":字符串按 shell 规则分词,数组逐项处理。
/// `mr:other` 在加载期递归展开;引用不存在的别名时原样保留;循环引用报错。
pub(crate) fn parse_aliases(value: &Value) -> Result<HashMap<String, Vec<OsString>>> {
let table = as_table(value, CONTEXT)?;
let mut raw: HashMap<String, Vec<OsString>> = HashMap::with_capacity(table.raw_len().min(128));
for pair in table.pairs::<Value, Value>() {
let (raw_key, raw_value) = pair?;
let name = parse_name(NameKind::Alias, &raw_key)?;
let context = format!("别名 '{name}'");
let mut parts = Vec::new();
flatten(&raw_value, &context, 0, &mut parts)?;
raw.insert(name, parts);
}
expand_graph(&raw)
}
/// 递归展平标量与嵌套数组,字符串按 shell 规则分词
fn flatten(value: &Value, context: &str, depth: usize, out: &mut Vec<OsString>) -> Result<()> {
if depth > MAX_DEPTH {
return Err(Error::ParseError(format!(
"{context} 的数组嵌套层级过深(超过 {MAX_DEPTH} 层)"
)));
}
match value {
Value::Table(table) => {
for item in as_strict_sequence(table, context)? {
flatten(&item, context, depth + 1, out)?;
}
}
scalar => out.extend(to_os_strings(scalar, ScalarMode::Tokens, context)?),
}
Ok(())
}
/// 一次 DFS 完成"环检测 + 递归展开 + 结果缓存"
fn expand_graph(raw: &HashMap<String, Vec<OsString>>) -> Result<HashMap<String, Vec<OsString>>> {
let mut cache: HashMap<String, Vec<OsString>> = HashMap::with_capacity(raw.len());
let mut stack: Vec<String> = Vec::new();
for key in raw.keys() {
resolve(key, raw, &mut cache, &mut stack)?;
}
Ok(cache)
}
fn resolve(
key: &str,
raw: &HashMap<String, Vec<OsString>>,
cache: &mut HashMap<String, Vec<OsString>>,
stack: &mut Vec<String>,
) -> Result<Vec<OsString>> {
if let Some(done) = cache.get(key) {
return Ok(done.clone());
}
if stack.iter().any(|pending| pending == key) {
return Err(Error::AliasCycle {
name: key.to_string(),
});
}
if stack.len() >= MAX_ALIAS_DEPTH {
return Err(Error::AliasTooDeep {
max: MAX_ALIAS_DEPTH,
});
}
stack.push(key.to_string());
let mut expanded = Vec::new();
if let Some(args) = raw.get(key) {
for arg in args {
let text = arg.to_string_lossy();
let referenced = text
.strip_prefix("mr:")
.filter(|name| raw.contains_key(*name))
.map(str::to_string);
match referenced {
Some(name) => expanded.extend(resolve(&name, raw, cache, stack)?),
None => expanded.push(arg.clone()),
}
}
}
stack.pop();
cache.insert(key.to_string(), expanded.clone());
Ok(expanded)
}
#[cfg(test)]
mod tests {
use super::*;
use mlua::Lua;
fn with_aliases(code: &str) -> Result<HashMap<String, Vec<OsString>>> {
let lua = Lua::new();
let value: Value = lua.load(code).eval().unwrap();
parse_aliases(&value)
}
#[test]
fn tokenizes_values_and_expands_references() {
let aliases = with_aliases(
r#"return { base = "log --graph", all = { "mr:base", "--all" }, blank = " " }"#,
)
.unwrap();
assert_eq!(
aliases.get("base").unwrap(),
&vec![OsString::from("log"), OsString::from("--graph")]
);
assert_eq!(
aliases.get("all").unwrap(),
&vec![
OsString::from("log"),
OsString::from("--graph"),
OsString::from("--all"),
]
);
assert!(aliases.get("blank").unwrap().is_empty());
}
#[test]
fn scalar_number_and_boolean_are_supported() {
let aliases = with_aliases(r#"return { n = 10, b = true }"#).unwrap();
assert_eq!(aliases.get("n").unwrap(), &vec![OsString::from("10")]);
assert_eq!(aliases.get("b").unwrap(), &vec![OsString::from("true")]);
}
#[test]
fn unknown_reference_is_kept_literal() {
let aliases = with_aliases(r#"return { a = "mr:nope" }"#).unwrap();
assert_eq!(aliases.get("a").unwrap(), &vec![OsString::from("mr:nope")]);
}
#[test]
fn cycle_is_reported() {
let err = with_aliases(r#"return { a = "mr:b", b = "mr:a" }"#).unwrap_err();
assert!(matches!(err, Error::AliasCycle { .. }), "unexpected: {err}");
}
#[test]
fn invalid_alias_name_is_reported() {
let err = with_aliases(r#"return { [""] = "x" }"#).unwrap_err();
assert!(matches!(
err,
Error::InvalidName {
kind: NameKind::Alias,
..
}
));
}
}
+78
View File
@@ -0,0 +1,78 @@
use super::as_table;
use super::scalar::{ScalarMode, to_os_strings};
use super::sequence::as_strict_sequence;
use crate::{Error, Result};
use mlua::Value;
use std::ffi::OsString;
const CONTEXT: &str = "命令行参数 (args)";
/// `args = { … }`:一个数组元素就是一个参数(空串保留为空参数)。
///
/// 只支持一维基础标量:嵌套 table 会让"一个元素 = 一个参数"的语义失效。
pub(crate) fn parse_args(value: &Value) -> Result<Vec<OsString>> {
let table = as_table(value, CONTEXT)?;
let items = as_strict_sequence(table, CONTEXT)?;
let mut args = Vec::with_capacity(items.len());
for (i, item) in items.iter().enumerate() {
if matches!(item, Value::Table(_)) {
return Err(Error::ParseError(format!(
"{CONTEXT} 仅支持一维数组,第 {} 个元素不能是 table",
i + 1
)));
}
let context = format!("{CONTEXT} 第 {} 个元素", i + 1);
args.extend(to_os_strings(item, ScalarMode::Verbatim, &context)?);
}
Ok(args)
}
#[cfg(test)]
mod tests {
use super::*;
use mlua::Lua;
fn with_args(code: &str) -> Result<Vec<OsString>> {
let lua = Lua::new();
let value: Value = lua.load(code).eval().unwrap();
parse_args(&value)
}
#[test]
fn parses_scalars_and_keeps_empty_string() {
let args = with_args(r#"return { "--no-pager", 2, true, "" }"#).unwrap();
assert_eq!(
args,
vec![
OsString::from("--no-pager"),
OsString::from("2"),
OsString::from("true"),
OsString::from(""),
]
);
}
#[test]
fn empty_array_is_empty() {
assert!(with_args("return {}").unwrap().is_empty());
}
#[test]
fn rejects_nested_table() {
let err = with_args(r#"return { { "a" } }"#).unwrap_err();
assert!(matches!(err, Error::ParseError(_)));
}
#[test]
fn rejects_sparse_array() {
let err = with_args(r#"return { "a", nil, "b" }"#).unwrap_err();
assert!(matches!(err, Error::ParseError(_)));
}
#[test]
fn rejects_non_table() {
let err = with_args(r#"return "-B""#).unwrap_err();
assert!(matches!(err, Error::TypeMismatch { .. }));
}
}
+120
View File
@@ -0,0 +1,120 @@
use super::as_table;
use super::scalar::{ScalarMode, to_os_strings};
use super::sequence::as_strict_sequence;
use crate::config::naming::parse_name;
use crate::{Error, NameKind, Result};
use mlua::Value;
use std::collections::HashMap;
use std::ffi::OsString;
const CONTEXT: &str = "环境变量 (env)";
/// 数组嵌套上限,防止畸形配置打爆调用栈
const MAX_DEPTH: usize = 16;
/// `env = { KEY = value }` → 环境变量表。
///
/// value 可以是标量,也可以是任意深度的数组;数组会递归展平,然后按系统
/// 路径分隔符(Windows `;`)拼接。空字符串 / 空数组 → 空值(清空该变量)。
pub(crate) fn parse_env(value: &Value) -> Result<HashMap<String, OsString>> {
let table = as_table(value, CONTEXT)?;
let mut env = HashMap::with_capacity(table.raw_len().min(128));
for pair in table.pairs::<Value, Value>() {
let (raw_key, raw_value) = pair?;
let name = parse_name(NameKind::EnvVar, &raw_key)?;
let context = format!("环境变量 '{name}' 的值");
let mut parts = Vec::new();
flatten(&raw_value, &context, 0, &mut parts)?;
let joined = std::env::join_paths(parts)
.map_err(|e| Error::ParseError(format!("{context} 无法用系统路径分隔符拼接: {e}")))?;
env.insert(name, joined);
}
Ok(env)
}
/// 递归展平标量与嵌套数组(env 的字符串不做分词,整段作为一个路径段)
fn flatten(value: &Value, context: &str, depth: usize, out: &mut Vec<OsString>) -> Result<()> {
if depth > MAX_DEPTH {
return Err(Error::ParseError(format!(
"{context} 的数组嵌套层级过深(超过 {MAX_DEPTH} 层)"
)));
}
match value {
Value::Table(table) => {
for item in as_strict_sequence(table, context)? {
flatten(&item, context, depth + 1, out)?;
}
}
scalar => out.extend(to_os_strings(scalar, ScalarMode::Verbatim, context)?),
}
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
use mlua::Lua;
fn with_env(code: &str) -> Result<HashMap<String, OsString>> {
let lua = Lua::new();
let value: Value = lua.load(code).eval().unwrap();
parse_env(&value)
}
#[test]
fn flattens_nested_arrays_with_path_separator() {
let env = with_env(r#"return { PATH = { "C:/a", { "C:/b", "C:/c" } } }"#).unwrap();
assert_eq!(env.get("PATH").unwrap().to_str(), Some("C:/a;C:/b;C:/c"));
}
#[test]
fn scalars_and_empty_values() {
let env = with_env(r#"return { A = "", B = {}, C = 3, D = true }"#).unwrap();
assert_eq!(env.get("A").unwrap().to_str(), Some(""));
assert_eq!(env.get("B").unwrap().to_str(), Some(""));
assert_eq!(env.get("C").unwrap().to_str(), Some("3"));
assert_eq!(env.get("D").unwrap().to_str(), Some("true"));
}
#[test]
fn rejects_invalid_key() {
let err = with_env(r#"return { ["FOO=1"] = "x" }"#).unwrap_err();
assert!(matches!(
err,
Error::InvalidName {
kind: NameKind::EnvVar,
..
}
));
let err = with_env(r#"return { [""] = "x" }"#).unwrap_err();
assert!(matches!(
err,
Error::InvalidName {
kind: NameKind::EnvVar,
..
}
));
}
#[test]
fn rejects_sparse_array_and_wrong_types() {
let err = with_env(r#"return { P = { "a", nil, "b" } }"#).unwrap_err();
assert!(matches!(err, Error::ParseError(_)));
let err = with_env(r#"return { F = function() end }"#).unwrap_err();
assert!(matches!(err, Error::TypeMismatch { .. }));
let err = with_env(r#"return "PATH=C:/x""#).unwrap_err();
assert!(matches!(err, Error::TypeMismatch { .. }));
}
#[test]
fn rejects_nul_in_value() {
let err = with_env(r#"return { P = { string.char(0) } }"#).unwrap_err();
assert!(matches!(err, Error::ContainsNul(_)));
}
}
+27
View File
@@ -0,0 +1,27 @@
//! Lua 值 → Rust 值的转换:`args` / `env` / `aliases`。
//!
//! 这一层只管"值本身":数组形状、元素类型、键合法性、分词与拼接。
//! 产出的错误统一是 `crate::Error` 的结构化变体;字段级语义
//! (必填、默认值)由 `model.rs` 决定。
mod aliases;
mod args;
mod env;
mod scalar;
mod sequence;
pub(crate) use aliases::parse_aliases;
pub(crate) use args::parse_args;
pub(crate) use env::parse_env;
use crate::{Error, Result};
use mlua::{Table, Value};
/// 值必须是 table,否则报 `TypeMismatch`
pub(crate) fn as_table<'a>(value: &'a Value, context: &str) -> Result<&'a Table> {
value.as_table().ok_or_else(|| Error::TypeMismatch {
field: context.to_string(),
expected: "键值表 (table)",
actual: value.type_name(),
})
}
+52
View File
@@ -0,0 +1,52 @@
use crate::args::tokens::parse_tokens;
use crate::config::convert::{ensure_no_nul, lua_string_2_os_string};
use crate::{Error, Result};
use mlua::Value;
use std::ffi::OsString;
/// 字符串元素的处理策略
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(super) enum ScalarMode {
/// 整体作为一个参数(args:一个数组元素 = 一个参数,空串保留为空参数)
Verbatim,
/// 按 shell 规则分词(aliases:"status -s" → 两个参数)
Tokens,
}
/// 标量 → 参数列表
///
/// - `Nil` 产生 0 个参数(在 env 里表示"清空该变量")
/// - 字符串 / 整数 / 浮点 / 布尔都可以转成字符串
/// - 其它类型报 `TypeMismatch`
/// - 产出的每个 `OsString` 都会做 NUL 检查
pub(super) fn to_os_strings(
value: &Value,
mode: ScalarMode,
context: &str,
) -> Result<Vec<OsString>> {
let os_str: OsString = match value {
Value::String(s) => lua_string_2_os_string(s)?,
Value::Integer(i) => i.to_string().into(),
Value::Number(n) => n.to_string().into(),
Value::Boolean(b) => b.to_string().into(),
Value::Nil => return Ok(Vec::new()),
other => {
return Err(Error::TypeMismatch {
field: context.to_string(),
expected: "string / number / boolean",
actual: other.type_name(),
});
}
};
ensure_no_nul(&context, &os_str)?;
Ok(match mode {
ScalarMode::Verbatim => vec![os_str],
ScalarMode::Tokens => match os_str.to_str() {
Some(text) => parse_tokens(text),
// 非 UTF-8 字节没法按 shell 规则切分,整体作为一个参数
None => vec![os_str],
},
})
}
+41
View File
@@ -0,0 +1,41 @@
use crate::{Error, Result};
use mlua::{Table, Value};
/// 严格连续的纯数组校验:一次遍历 `pairs`,要求键恰好是 `1..=n` 的连续整数。
///
/// 返回按顺序排列的元素。空洞(`{ "a", nil, "b" }`)或字典键都会报错。
pub(super) fn as_strict_sequence(table: &Table, context: &str) -> Result<Vec<Value>> {
let mut slots: Vec<Option<Value>> = Vec::with_capacity(table.raw_len().min(128));
for pair in table.pairs::<Value, Value>() {
let (key, value) = pair?;
let index = match key {
Value::Integer(i) if i >= 1 => (i - 1) as usize,
other => {
return Err(Error::TypeMismatch {
field: context.to_string(),
expected: "连续整数下标 (数组)",
actual: other.type_name(),
});
}
};
if slots.len() <= index {
slots.resize_with(index + 1, || None);
}
slots[index] = Some(value);
}
let mut items = Vec::with_capacity(slots.len());
for (i, slot) in slots.into_iter().enumerate() {
match slot {
Some(value) => items.push(value),
None => {
return Err(Error::ParseError(format!(
"{context} 第 {} 个元素为 nil 或不存在(请检查漏写引号或变量未定义)",
i + 1
)));
}
}
}
Ok(items)
}
+231
View File
@@ -0,0 +1,231 @@
use std::fmt;
use std::path::PathBuf;
use thiserror::Error;
/// 全局统一的 `Result` 别名,默认错误类型为 [`Error`]。
pub type Result<T, E = Error> = std::result::Result<T, E>;
/// 名称所属的类别,用于区分命令名 / 环境变量名 / 别名的校验与报错
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum NameKind {
Command,
EnvVar,
Alias,
}
impl fmt::Display for NameKind {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str(match self {
Self::Command => "命令名",
Self::EnvVar => "环境变量名",
Self::Alias => "别名",
})
}
}
#[derive(Error, Debug)]
pub enum Error {
#[error("初始化 Lua 沙箱失败: {0}")]
LuaInit(#[source] mlua::Error),
// #[error("构建 LuaRuntime 异常")]
// BuildError,
#[error("{kind}非法: {reason}")]
InvalidName { kind: NameKind, reason: String },
#[error("别名 '{name}' 存在循环引用")]
AliasCycle { name: String },
#[error("别名展开层级过深(超过 {max} 层)")]
AliasTooDeep { max: usize },
#[error("{0}")]
ContainsNul(String),
/// 值的结构不合法(数组空洞、字典键、嵌套过深等)
#[error("{0}")]
ParseError(String),
#[error("目录布局解析失败: {0}")]
Layout(String),
#[error("注册全局变量 '{name}' 失败: {source}")]
RegisterGlobal {
name: &'static str,
#[source]
source: mlua::Error,
},
#[error("{from} -> {to} 转换失败: {message}")]
EncodingError {
from: &'static str,
to: String,
message: String,
},
// 类型不符:Lua 值的类型与期望不符,用户应修改配置写法
#[error("字段 {field} 类型不符:期望 {expected},实际是 {actual}")]
TypeMismatch {
field: String,
expected: &'static str,
actual: &'static str,
},
#[error("缺少必填字段 {field}")]
MissingField { field: String },
///读取脚本文件失败
#[error("读取脚本文件失败 ({path}): {source}")]
ScriptRead {
path: PathBuf,
#[source]
source: std::io::Error,
},
#[error("脚本 {path} 不是有效的 UTF-8 文件(请将 Lua 配置文件保存为 UTF-8 编码)")]
InvalidUtf8 { path: PathBuf },
// 收敛所有来自 mlua 的错误,附带来源上下文
#[error("Lua 执行异常 ({chunk}): {source}")]
LuaRuntime {
chunk: String,
#[source]
source: mlua::Error,
},
#[error("模块 '{module_name}' 必须返回一个函数作为入口,实际返回了 {actual_type}")]
InvalidModuleEntry {
module_name: String,
actual_type: &'static str,
},
// #[error("插件/上下文挂载失败 '{name}': {source}")]
// Plugin {
// name: String,
// #[source]
// source: mlua::Error,
// },
#[error("Lua 适配层错误: {0}")]
LuaAdapter(#[from] mlua::Error),
// #[error("设置 {0} 环境变量失败")]
// SetMirrorDir(String),
/// 用户自定义扩展错误,用于包装第三方插件产生的错误。
#[error("用户自定义扩展错误: {0}")]
Other(#[source] Box<dyn std::error::Error + Send + Sync>),
}
/// 出站转换:core 自己的错误 -> Lua 世界能看懂的错误。
///
/// 触发时机:函数返回 `mlua::Result<T>`,但 `?` 的表达式返回 `crate::Result<T>`。
/// 有了这个 impl,Lua 边界的代码只写 `?`,不需要在每个调用点手工构造 mlua 错误。
impl From<Error> for mlua::Error {
fn from(err: Error) -> Self {
match err {
// 本来就是 mlua 的错误:原样透传,保留错误种类与位置信息
Error::LuaInit(e) | Error::LuaAdapter(e) => e,
// source 自带 chunk 名(set_name 已写入),所以这里直接透传内层错误
Error::LuaRuntime { source, .. } => source,
Error::EncodingError { from, to, message } => mlua::Error::FromLuaConversionError {
from,
to,
message: Some(message),
},
Error::TypeMismatch {
field,
expected, actual,
} => mlua::Error::FromLuaConversionError {
from: actual,
to: expected.into(),
message: Some(format!("字段 '{field}' 类型不符")),
},
Error::MissingField { field } => {
mlua::Error::RuntimeError(format!("缺少必填字段 {field}"))
}
// 其余是 core 的领域错误:翻译成 Lua 侧可见的运行时错误,
// to_string() 由 thiserror 的 #[error("...")] 生成,也就是用户看到的中文
other => mlua::Error::RuntimeError(other.to_string()),
}
}
}
/// 将 MirrorTarget 构建为 Command 时可能触发的阻断性错误
#[derive(Debug, Clone)]
pub enum TargetExecutionError {
/// 多版本工具未激活版本 (current == None)
UnselectedVersion { tool: String },
/// 目标可执行文件物理不存在
NotFound { tool: String, path: PathBuf },
}
impl fmt::Display for TargetExecutionError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::UnselectedVersion { tool } => {
write!(
f,
"工具 '{}' 当前未指定有效版本。\n提示: 请先运行 'mr use {}' 选择版本。",
tool, tool
)
}
Self::NotFound { tool, path } => {
write!(f, "工具 '{}' 的目标程序不存在: {}", tool, path.display())
}
}
}
}
impl std::error::Error for TargetExecutionError {}
#[cfg(test)]
mod tests {
use super::*;
/// 领域错误出站后,原始的中文提示必须还在
#[test]
fn config_error_converts_to_lua_error_with_payload() {
let lua_err: mlua::Error = Error::InvalidName {
kind: NameKind::Command,
reason: "不能为空".into(),
}
.into();
assert!(
lua_err.to_string().contains("不能为空"),
"unexpected message: {lua_err}"
);
}
/// Lua 原生错误出站时要原样透传,不能被包成 RuntimeError 丢掉种类
#[test]
fn native_lua_error_passes_through() {
let lua_err: mlua::Error =
Error::LuaAdapter(mlua::Error::RuntimeError("boom".into())).into();
assert!(
lua_err.to_string().contains("boom"),
"unexpected message: {lua_err}"
);
}
#[test]
fn conversion_error_keeps_kind() {
let lua_err: mlua::Error = Error::EncodingError {
from: "LuaString",
to: "OsString".into(),
message: "坏字节".into(),
}
.into();
assert!(matches!(
lua_err,
mlua::Error::FromLuaConversionError { .. }
));
}
#[test]
fn missing_field_message_has_no_duplication() {
let lua_err: mlua::Error = Error::MissingField {
field: "home".into(),
}
.into();
// mlua 会给 RuntimeError 加 "runtime error: " 前缀,所以只断言内容正确且不重复
let message = lua_err.to_string();
assert_eq!(message.matches("缺少必填字段").count(), 1, "{message}");
assert!(message.contains("home"), "{message}");
}
}
+124
View File
@@ -0,0 +1,124 @@
use crate::{Error, Result};
use std::env;
use std::path::{Path, PathBuf};
use tracing::debug;
pub struct Layout {
pub base_dir: PathBuf,
pub target_name: String,
}
impl Layout {
/// 自动解析目录布局:
/// 1. 优先使用环境变量 MIRROR_HOME
/// 2. 兜底回退到当前垫片可执行文件所在目录推断 (exe -> bin -> root)
pub fn from(current_exe: &Path) -> Result<Self> {
let target_name = current_exe
.file_stem()
.and_then(|s| s.to_str())
.ok_or_else(|| {
Error::Layout(format!(
"无法从路径 [{}] 提取有效的程序名称",
current_exe.display()
))
})?
.to_lowercase();
// 策略 1: 环境变量优先
if let Ok(home_val) = env::var("MIRROR_HOME") {
let trimmed = home_val.trim();
if !trimmed.is_empty() {
debug!(home = %trimmed, "检测到 MIRROR_HOME,采用环境变量配置");
return Self::from_base_dir(PathBuf::from(trimmed), target_name);
}
}
// 策略 2: 相对路径自动推断兜底
debug!("未配置 MIRROR_HOME,尝试从当前可执行文件路径推断根目录");
Self::from_executable(current_exe, target_name)
}
/// 基于确定的根目录构建完整布局
fn from_base_dir(base_dir: PathBuf, target_name: String) -> Result<Self> {
if !base_dir.is_dir() {
debug!("指定的根目录不存在或不是有效目录: [{}]", base_dir.display());
return Err(Error::Layout(format!(
"指定的根目录不存在或不是有效目录: [{}]",
base_dir.display()
)));
}
let mirror_file = base_dir.join("mirror.lua");
if !mirror_file.is_file() {
debug!(
"根目录 [{}] 下未找到核心配置文件 [mirror.lua]",
base_dir.display()
);
return Err(Error::Layout(format!(
"根目录 [{}] 下未找到核心配置文件 [mirror.lua]",
base_dir.display()
)));
}
Ok(Self {
base_dir,
target_name,
})
}
/// 从当前可执行文件解析 shim 安装目录布局
fn from_executable(exe_path: &Path, target_name: String) -> Result<Self> {
// let exe_path = exe_path.as_ref();
let start_dir = exe_path.parent().ok_or_else(|| {
Error::Layout(format!("无法获取程序 [{}] 的所在目录", exe_path.display()))
})?;
debug!("可执行程序所在目录: {}", start_dir.display());
// let base_dir = start_dir
// .parent()
// .with_context(|| format!("无法获取 bin 目录 [{}] 的父级 root 目录", bin_dir.display()))?
// .to_path_buf();
// 2. 向上回溯寻找 mirror.lua 锚点
let base_dir = find_base_dir_by_anchor(start_dir).ok_or_else(|| {
Error::Layout(format!(
"路径推导失败:从 [{}] 向上逐级回溯均未找到 [mirror.lua]。\n\
提示: 请确保程序位于包含 mirror.lua 的项目内,或配置 MIRROR_HOME 环境变量。",
start_dir.display()
))
})?;
debug!("成功探测到 base_dir 目录 {}", base_dir.display());
// 此时 base_dir 下必然有 mirror.lua,直接构建
Ok(Self {
base_dir,
target_name,
})
}
}
/// 向上查找包含 mirror.lua 的根目录
fn find_base_dir_by_anchor(start_dir: &Path) -> Option<PathBuf> {
let mut current = Some(start_dir);
// 最大向上回溯层级(例如 3~4 层,防止死循环跑到磁盘根目录甚至网络挂载点)
let mut depth = 0;
const MAX_DEPTH: usize = 4;
while let Some(dir) = current {
if depth > MAX_DEPTH {
debug!("超出最大向上回溯层级:4");
break;
}
// 只要当前目录下有 mirror.lua,这里就是真正的 base_dir!
if dir.join("mirror.lua").is_file() {
return Some(dir.to_path_buf());
}
current = dir.parent();
depth += 1;
}
None
}
+3
View File
@@ -0,0 +1,3 @@
pub(crate) mod layout;
pub(crate) mod path;
pub use layout::Layout;
+10
View File
@@ -0,0 +1,10 @@
use std::path::Path;
/// 将 Path 转换为适合 Lua 使用的安全字符串路径
pub fn normalize_path_for_lua(path: &Path) -> String {
// 自动将 Windows UNC 规范路径转回传统路径
let simplified = dunce::simplified(path);
simplified.to_string_lossy().replace('\\', "/")
}
+18
View File
@@ -0,0 +1,18 @@
mod args;
mod config;
mod error;
mod fs;
mod logging;
mod lua;
pub use config::{
load_mirror_spec, parse_command_name, MirrorRegistry, MirrorSpec, MirrorTarget, Target,
TargetConfig, TargetSpec,
};
pub use fs::Layout;
// pub use mirror_shim::mirror::Mirror;
pub use logging::{LogConfig, LogLevel, init_logging_from};
pub use lua::{register_basics, LuaRuntime};
// 把 Result 和 Error 提升到根命名空间,给外部带来极致便利
pub use error::{Error, NameKind, Result, TargetExecutionError};
+187
View File
@@ -0,0 +1,187 @@
use crate::fs::Layout;
use std::convert::Infallible;
use std::fs;
use std::path::{Path, PathBuf};
use std::str::FromStr;
use tracing_appender::non_blocking::{NonBlocking, WorkerGuard};
use tracing_subscriber::layer::SubscriberExt;
use tracing_subscriber::util::SubscriberInitExt;
use tracing_subscriber::{EnvFilter, fmt};
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, serde::Deserialize, Default)]
#[serde(rename_all = "lowercase")]
pub enum LogLevel {
Off,
Error,
#[default]
Warn,
Info,
Debug,
Trace,
}
impl std::fmt::Display for LogLevel {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.as_str())
}
}
impl LogLevel {
/// 是否需要激活写盘排查模式(Info 及以上更详细的级别)
pub fn is_verbose(&self) -> bool {
*self >= LogLevel::Info
}
pub fn as_str(&self) -> &'static str {
match self {
LogLevel::Off => "off",
LogLevel::Error => "error",
LogLevel::Warn => "warn",
LogLevel::Info => "info",
LogLevel::Debug => "debug",
LogLevel::Trace => "trace",
}
}
}
impl FromStr for LogLevel {
type Err = String;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s.to_ascii_lowercase().as_str() {
"off" => Ok(LogLevel::Off),
"error" => Ok(LogLevel::Error),
"warn" => Ok(LogLevel::Warn),
"info" => Ok(LogLevel::Info),
"debug" => Ok(LogLevel::Debug),
"trace" => Ok(LogLevel::Trace),
_ => Err(format!(
"无效的日志级别 '{s}',可选值为: off, error, warn, info, debug, trace"
)),
}
}
}
/// 日志配置模型(对应 mirror.ini 的纯强类型表示)
#[derive(Debug, Clone, PartialEq, Eq, Default)]
pub struct LogConfig {
pub level: LogLevel,
pub log_dir: Option<PathBuf>,
}
impl LogConfig {
/// 零依赖解析 ini / key-value 文本内容
/// 计算日志目录的实际物理路径(相对路径基于 base_dir 拼接)
pub fn resolve_log_dir(&self, base_dir: &Path) -> PathBuf {
match &self.log_dir {
Some(p) if p.is_absolute() => p.clone(),
Some(p) => base_dir.join(p),
None => base_dir.join("logs"),
}
}
}
// 协议 1: 反序列化 (INI 文本 -> LogConfig)
impl FromStr for LogConfig {
type Err = Infallible;
fn from_str(content: &str) -> Result<Self, Self::Err> {
let mut config = Self::default();
for line in content.lines() {
let line = line.trim();
// 跳过空行、注释 (#, ;) 与 section 标头 ([...])
if line.is_empty() || line.starts_with(['#', ';', '[']) {
continue;
}
if let Some((key, val)) = line.split_once('=') {
let key = key.trim();
let val = val.trim().trim_matches(['"', '\'']);
match key {
"level" => {
if let Ok(lvl) = LogLevel::from_str(val) {
config.level = lvl;
}
}
"log_dir" => {
if !val.is_empty() {
config.log_dir = Some(PathBuf::from(val));
}
}
_ => {}
}
}
}
Ok(config)
}
}
// 协议 2: 序列化 (LogConfig -> INI 文本)
impl std::fmt::Display for LogConfig {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
let dir_str = self
.log_dir
.as_deref()
.and_then(|p| p.to_str())
.unwrap_or("logs");
writeln!(f, "level = \"{}\"", self.level.as_str())?;
writeln!(f, "log_dir = \"{}\"", dir_str)
}
}
/// 基于 Layout 自动寻址 mirror.toml 并初始化日志系统。
/// 仅在开启详细日志(如 info/debug/trace)时激活异步文件记录并返回 `WorkerGuard`。
pub fn init_logging_from(layout: &Layout) -> Option<WorkerGuard> {
// 1. 在 layout.base_dir 目录下寻找 log.toml
// let config_path = layout.base_dir.join("mirror.toml");
let config_path = layout.base_dir.join("mirror.ini");
// 1. 读取并反序列化配置文件(缺失或异常时安全降级为 Default)
let config: LogConfig = fs::read_to_string(&config_path)
.ok()
.and_then(|s| s.parse().ok())
.unwrap_or_default();
// 1. 优先读取环境变量 MIRROR_LOG_LEVEL,解析失败或未设置则退回到 config.level
let effective_level = std::env::var("MIRROR_LOG_LEVEL")
.ok()
.and_then(|val| LogLevel::from_str(&val).ok())
.unwrap_or(config.level);
if effective_level == LogLevel::Off {
return None;
}
let filter = EnvFilter::new(effective_level.as_str());
// 基础终端输出层
let stderr_layer = fmt::layer().with_writer(std::io::stderr).with_target(false);
// 3. 动态配置落盘文件层(仅在 verbose 级别启用)
let (file_layer, guard) = if effective_level.is_verbose() {
let (non_blocking, guard) = create_file_appender(&config.resolve_log_dir(&layout.base_dir));
let layer = fmt::layer()
.with_writer(non_blocking)
.with_ansi(false)
.with_target(false);
(Some(layer), Some(guard))
} else {
(None, None)
};
// 4. 统一组装并初始化 Subscriber(Option<Layer> 天然实现了 Layer trait)
let _ = tracing_subscriber::registry()
.with(filter)
.with(stderr_layer)
.with(file_layer)
.try_init();
guard
}
fn create_file_appender(output_dir: &Path) -> (NonBlocking, WorkerGuard) {
if let Err(err) = fs::create_dir_all(output_dir) {
eprintln!("[WARN] 创建日志目录 {} 失败: {}", output_dir.display(), err);
}
let file_appender = tracing_appender::rolling::daily(output_dir, "mirror.log");
tracing_appender::non_blocking(file_appender)
}
+5
View File
@@ -0,0 +1,5 @@
pub mod runtime;
pub mod plugins;
pub use plugins::register_basics;
pub use runtime::LuaRuntime;
+167
View File
@@ -0,0 +1,167 @@
use crate::error::{Error, Result};
use crate::fs::{Layout, path::normalize_path_for_lua};
use mlua::{Lua, Table, Value};
use std::path::PathBuf;
use std::{env, fs};
use tracing::{debug, warn};
const MIRROR_DIR: &str = "__MIRROR_DIR__";
// 采用形式 A:直接传引用的普通函数
pub fn register_basics(lua: &Lua, layout: &Layout) -> Result<()> {
let base_dir = normalize_path_for_lua(&layout.base_dir);
register_mirror_dir(lua, &base_dir)?;
register_get_env(lua)?;
setup_require(lua, &base_dir)?;
register_mr_version(lua)?;
Ok(())
}
/// 注入全局锚点变量
pub fn register_mirror_dir(lua: &Lua, base_dir: &str) -> Result<()> {
debug!("设置 {MIRROR_DIR} 环境变量");
lua.globals()
.set(MIRROR_DIR, base_dir)
.map_err(|e| Error::RegisterGlobal {
name: MIRROR_DIR,
source: e,
})?;
// .context(format!("设置 {MIRROR_DIR} 环境变量失败"))?;
Ok(())
}
///注入 get_env 供配置读取环境变量
pub fn register_get_env(lua: &Lua) -> Result<()> {
let globals = lua.globals();
let get_env = lua.create_function(|lua, key: String| -> mlua::Result<Table> {
// 缺失变量视为空字符串,拆分后得到空表(不贡献任何路径段)
let value = env::var_os(key).unwrap_or_default();
// 空输入返回空表;否则按平台分隔符拆分(split_paths 会剥离引号包裹)
if value.is_empty() {
return lua.create_table();
}
let table = lua.create_table()?;
for (i, p) in env::split_paths(&value).enumerate() {
// 3. 跨平台提取原始字节并转为 LuaString,保证 100% 无损
#[cfg(unix)]
let lua_str = {
use std::os::unix::ffi::OsStrExt;
lua.create_string(p.as_os_str().as_bytes())?
};
#[cfg(windows)]
let lua_str = {
// Windows 路径是 UTF-16,转成字符串或保持其字节表达
let s = p.to_string_lossy();
lua.create_string(s.as_bytes())?
};
table.set(i + 1, lua_str)?;
}
Ok(table)
})?;
// .context("注册 get_env 函数失败")?;
globals.set("get_env", get_env)?;
// .context("挂载 get_env 全局函数失败")?;
Ok(())
}
/// 配置 package.path 并包装 require,拦截加载失败以提高容错性
pub fn setup_require(lua: &Lua, base_dir: &str) -> Result<()> {
let globals = lua.globals();
// 1. 安全加固并拓展 package 搜索路径
let package = globals.get::<Table>("package")?;
let _ = package.set("cpath", "");
let _ = package.set("loadlib", Value::Nil);
let commands_dir = format!("{}/commands", base_dir);
let vendor_dir = format!("{}/vendor", base_dir);
let path = package.get::<String>("path")?;
let new_path = format!(
"{};{}/?.lua;{}/?/init.lua;{}/?.lua;{}/?/init.lua;{}/?.lua;{}/?/init.lua;",
path, base_dir, base_dir, commands_dir, commands_dir, vendor_dir, vendor_dir
);
debug!("重新写入的 package 查找路径");
package.set("path", new_path)?;
// 2. 获取原生 require 并通过闭包直接持有(无需向全局表注入备份变量)
let original_require: mlua::Function = globals.get("require")?;
// .context("获取内置 require 函数失败")?;
let wrapped_require =
lua.create_function(move |_lua, module: String| -> mlua::Result<Value> {
match original_require.call::<Value>(module.as_str()) {
Ok(value) => Ok(value),
Err(e) => {
warn!(
module = %module,
error = %e,
"配置模块加载失败,已跳过该条目(可在独立配置文件中定义)"
);
Ok(Value::Nil)
}
}
})?;
// .context("创建包装版 require 函数失败")?;
// 3. 覆盖全局 require
globals.set("require", wrapped_require)?;
// .context("重载 require 函数失败")?;
Ok(())
}
/// 向 Lua 全局环境注册 `mr` 模块及其原生辅助函数
pub fn register_mr_version(lua: &Lua) -> Result<()> {
// 1. 获取或创建全局 `mr` Table
let globals = lua.globals();
let mr_table = match globals.get::<Value>("mr")? {
Value::Table(t) => t,
_ => {
let t = lua.create_table()?;
globals.set("mr", t.clone())?;
t
}
};
// 2. 实现 mr.version(home, version_file) -> Option<String>
// 规则:
// - version_file 为可选参数,缺省默认使用 ".version"
// - 文件不存在、空内容或读取失败时,安全返回 nil,绝不让 Lua 脚本崩盘
// - 自动 trim 掉末尾的 \r\n,仅提取纯净版本号
let version_fn = lua.create_function(
|_lua, (home_str, version_file_opt): (String, Option<String>)| {
let version_filename = version_file_opt
.filter(|s| !s.trim().is_empty())
.unwrap_or_else(|| ".version".to_string());
let mut target_path = PathBuf::from(home_str);
target_path.push(version_filename);
// 读取文件并安全修剪
match fs::read_to_string(&target_path) {
Ok(content) => {
let trimmed = content.trim();
if trimmed.is_empty() {
Ok(None::<String>) // 文件内容为空字符串时,视为未设置版本
} else {
Ok(Some(trimmed.to_string()))
}
}
// 常见错误(NotFound 等)直接返回 nil,不抛出 Lua error
Err(_) => Ok(None::<String>),
}
},
)?;
// 3. 挂载到 mr 表
mr_table.set("version", version_fn)?;
Ok(())
}
+175
View File
@@ -0,0 +1,175 @@
use crate::error::{Error, Result};
use mlua::{FromLua, Lua, StdLib, Value};
use std::fs;
use std::path::Path;
use tracing::debug;
pub struct LuaRuntimeBuilder {
lua: Result<Lua>,
}
impl LuaRuntimeBuilder {
pub fn with<F>(mut self, extension: F) -> Self
where
F: FnOnce(&Lua) -> Result<()>,
{
// 如果前面已有错误,直接短路跳过后续操作
if let Ok(ref lua) = self.lua {
if let Err(e) = extension(lua) {
self.lua = Err(e);
}
}
self
}
/// 收敛构建终点:一次性输出统一的 Result
pub fn build(self) -> Result<LuaRuntime> {
let lua = self.lua?;
Ok(LuaRuntime { lua })
}
}
/// 将 Layout 相关的公共上下文组合为一个插件项
pub struct LuaRuntime {
lua: Lua,
}
impl LuaRuntime {
/// 初始化限定权限的 Lua 沙箱环境
pub fn builder() -> LuaRuntimeBuilder {
// 只加载安全的标准库,剥离 os / io 等风险模块
let lua = Lua::new_with(
StdLib::TABLE | StdLib::STRING | StdLib::MATH | StdLib::PACKAGE,
mlua::LuaOptions::default(),
)
.map_err(Error::LuaInit);
LuaRuntimeBuilder { lua }
}
/// 执行指定脚本文件,直接返回完整的 Lua Table
pub fn eval_script<T: FromLua>(&self, path: impl AsRef<Path>) -> Result<T> {
let path = path.as_ref();
let bytes = fs::read(path).map_err(|e| Error::ScriptRead {
path: path.to_path_buf(),
source: e,
})?;
let code = String::from_utf8(bytes).map_err(|_| Error::InvalidUtf8 {
path: path.to_path_buf(),
})?;
debug!("code {:?}", code);
// 使用 @<path> 格式标记 Chunk 名称,确保 Lua 报错时能精确回溯到对应的源文件名与行号。
let chunk_name = format!("@{}", path.display());
self.lua
.load(&code)
.set_name(&chunk_name)
.eval::<T>()
.map_err(|e| Error::LuaRuntime {
chunk: chunk_name,
source: e,
})
}
pub fn require_and_run(&self, module_name: &str, raw_args: Vec<String>) -> Result<()> {
let require: mlua::Function = self.lua.globals().get("require")?;
let handler_val: Value = require.call(module_name)?;
let func = match handler_val {
Value::Function(f) => f,
other => {
return Err(Error::InvalidModuleEntry {
module_name: module_name.to_string(),
actual_type: other.type_name(),
});
}
};
let lua_args = self.lua.create_sequence_from(raw_args)?;
func.call::<()>(lua_args)?;
Ok(())
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::Layout;
/// 测试用运行时:和线上一样注册宿主函数(get_env / require 包装等)
fn test_runtime() -> LuaRuntime {
let layout = Layout {
base_dir: std::env::temp_dir().join("mirror-core-test-layout"),
target_name: "mirror-shim".to_string(),
};
LuaRuntime::builder()
.with(|lua| crate::lua::register_basics(lua, &layout))
.build()
.unwrap()
}
#[test]
fn missing_module_require_returns_nil() {
let runtime = test_runtime();
let value: Value = runtime
.lua
.load(r#"return require("rshim_test_no_such_module")"#)
.eval()
.unwrap();
assert!(matches!(value, Value::Nil));
}
#[test]
fn builtin_module_require_still_works() {
let runtime = test_runtime();
let value: Value = runtime
.lua
.load(r#"return pcall(require, "string")"#)
.eval()
.unwrap();
assert!(matches!(value, Value::Boolean(true)));
}
#[test]
fn get_env_returns_split_table() {
let runtime = test_runtime();
let value: Value = runtime
.lua
.load(r#"return get_env("PATH")"#)
.eval()
.unwrap();
let table = match value {
Value::Table(t) => t,
other => panic!("expected table, got {}", other.type_name()),
};
assert!(
table.raw_len() >= 1,
"PATH should have at least one segment"
);
// split_paths 会剥离引号包裹,拆分段不应再含双引号
for i in 1..=table.raw_len() {
let seg: String = table.raw_get(i).unwrap();
assert!(
!seg.contains('"'),
"segment should not contain quote: {seg:?}"
);
}
}
#[test]
fn get_env_missing_returns_empty_table() {
let runtime = test_runtime();
let value: Value = runtime
.lua
.load(r#"return get_env("RSHIM_TEST_NO_SUCH_VAR_12345")"#)
.eval()
.unwrap();
match value {
Value::Table(t) => assert_eq!(t.raw_len(), 0),
other => panic!("expected table, got {}", other.type_name()),
}
}
}
+25
View File
@@ -0,0 +1,25 @@
[package]
name = "mirror-shim"
version = { workspace = true }
edition = { workspace = true }
[dependencies]
mirror-core = { path = "../mirror-core" }
anyhow = { workspace = true }
windows-sys = { workspace = true }
tracing = { workspace = true }
tracing-subscriber = { workspace = true }
tracing-appender = { workspace = true }
mlua ={workspace = true}
[features]
default = []
args = []
[profile.release]
opt-level = "z"
panic = "abort"
+72
View File
@@ -0,0 +1,72 @@
-- mirror.lua (总控制台)
-- __MIRROR_DIR__ 已经在 Rust 中注入完毕,并且是正斜杠格式 (例如 C:/Tools)
base_dir = __MIRROR_DIR__
-- 1. 自定义局部变量,方便复用与后续维护
local python_home = base_dir .. "/tools/python39"
return {
---------------------------------------------------
-- 1. 标准相对路径 + 正斜杠拼接 (最推荐,绿色便携)
---------------------------------------------------
["numa"] = {
target = base_dir .. "/tools/numa/numa.exe",
-- 追加参数
args = { "--help" },
aliases = {},
-- 注入环境变量,使用 get_env 获取宿主机当前值
env = {
PATH = { base_dir .. "/tools/numa", get_env("PATH") }
}
},
["git"] = {
target = base_dir .. "/git/bin/git.exe",
-- 追加参数
args = { "--no-pager" },
-- 注入环境变量,使用 get_env 获取宿主机当前值
env = {
PATH = { base_dir .. "/git/bin", get_env("PATH") }
}
},
---------------------------------------------------
-- 2. Lua 原生字符串语法 [[ ]] (适合直接从 Windows 复制绝对路径)
---------------------------------------------------
["python"] = {
-- 在 [[]] 内部,\ 不需要写成 \\,直接粘贴即可
target = [[C:\Python310\python.exe]],
args = { "-B" },
-- 空字典也是合法的,等同于不设置
env = {
-- 普通字符串:Rust 直接新建/覆盖该环境变量
PYTHON_HOME = python_home,
HOME = base_dir .. "/home",
-- 数组列表:将 python_home 以及 python_home/Scripts 依次拼接到 PATH 前面
PATH = {
python_home,
python_home .. "/Scripts",
get_env("PATH")
}
}
},
---------------------------------------------------
-- 3. 极简参数覆盖 (没有 args 和 env)
---------------------------------------------------
["curl"] = {
target = base_dir .. "/curl/curl.exe"
},
---------------------------------------------------
-- 4. 模块化路由 (得益于 Rust 注入的 package.path)
-- require 能够直接在当前目录 或 tools/ 目录下寻找 node.lua
-- 模块缺失时由 Rust 侧记录日志并跳过该条目(见 runtime.rs)
---------------------------------------------------
["node"] = require("node"),
["npm"] = require("npm")
}
+39
View File
@@ -0,0 +1,39 @@
---
--- Generated by EmmyLua(https://github.com/EmmyLua)
--- Created by Administrator.
--- DateTime: 2026/9/10 20:16
---
-- tools/node.lua
local home = base_dir .. "/tools/node"
local version_file = ".version"
-- 安全读取当前激活版本:未激活或文件不存在时返回 nil,不抛出异常
local ver = mr.version(home, version_file)
return {
-- 1. target 配置为 Table,自动对应 Rust 侧的 TargetConfig::Versioned
target = {
home = home,
version_file = version_file,
-- 若版本未激活,current 为 nil;若激活,则拼出绝对路径
current = ver and (home .. "/" .. ver .. "/node.exe") or nil
},
-- 2. 默认追加参数
args = {},
-- 3. 别名映射(mr: 前缀可直接展开)
aliases = {
["v"] = { "--version" },
},
-- 4. 环境变量联动:将对应版本的 bin 目录前置到 PATH
env = {
NODE_HOME = ver and (home .. "/" .. ver) or "",
PATH = {
ver and (home .. "/" .. ver) or "",
get_env("PATH")
}
}
}
+25
View File
@@ -0,0 +1,25 @@
use mirror_core::MirrorTarget;
use std::ffi::OsString;
use std::path::Path;
use std::process::Command;
use tracing::debug;
pub fn to_command<P>(spec: &MirrorTarget, target: P, final_args: &[OsString]) -> Command
where
P: AsRef<Path>,
{
let mut cmd = Command::new(target.as_ref());
// 2. 传入预打平的别名字典,查表并展开所有以 `mr:` 为前缀的别名
// let final_args = self.resolve_args(combined_args);
debug!("拼接后的命令行参数{:?}", final_args);
// 3. 将解析展开后的无环参数一次性注入 Command
cmd.args(final_args);
// 4. 注入配置好的环境变量
for (key, val) in &spec.env {
// 直接应用环境变量(Lua 端已经处理好字符串拼接或列表合并)
cmd.env(key, val);
}
cmd
}
+99
View File
@@ -0,0 +1,99 @@
use mirror_core::MirrorRegistry;
use crate::sys::{
ERROR_ELEVATION_REQUIRED, EXIT_FAILED_LOAD_SHIM, EXIT_FAILED_SPAWN_PROG, EXIT_FAILED_WAIT_PROG,
EXIT_PROG_TERMINATED, execute_elevated,
};
use mirror_core::{Layout, LuaRuntime, TargetConfig, TargetExecutionError, register_basics};
use std::env;
use std::ffi::OsString;
use std::process::exit;
use tracing::{error, warn};
use crate::command;
pub fn run(layout: &Layout) -> i32 {
let global_config = &layout.base_dir.join("mirror.lua");
if !global_config.is_file() {
error!("主配置文件不存在: {}", global_config.display());
return EXIT_FAILED_LOAD_SHIM;
}
let runtime = match LuaRuntime::builder()
.with(|lua| register_basics(lua, &layout))
.build()
{
Ok(r) => r,
Err(e) => {
error!("初始化 Lua 失败: {:#}", e);
return EXIT_FAILED_LOAD_SHIM;
}
};
let registry: MirrorRegistry = match runtime.eval_script(&global_config) {
Ok(t) => t,
Err(e) => {
error!("加载命令配置 [{}] 失败: {:#}", global_config.display(), e);
return EXIT_FAILED_LOAD_SHIM;
}
};
let target_name = layout.target_name.as_str();
let mr = match registry.targets.get(target_name) {
Some(m) => m,
None => {
warn!("未在 mirror.lua 中找到目标配置 [{}]", target_name);
return EXIT_FAILED_LOAD_SHIM;
}
};
// 1. 提取生效路径,缺失版本时直接抛出 UnselectedVersion
let target_path = match mr.target.executable_path() {
Some(path) => path,
None => {
warn!(
"[mirror] 工具 '{}' 当前未指定生效版本。\n提示: 请先运行 'mr use {}' 选择版本。",
target_name, target_name
);
return EXIT_FAILED_LOAD_SHIM;
}
};
// 3. 解析调用参数与代理 Mirror 配置
let calling_args: Vec<_> = env::args_os().skip(1).collect();
let combined_args = mr.args.iter().chain(calling_args.iter());
let final_args = mr.resolve_args(combined_args);
// 构建 Command:复用 ShimConfig::to_command(含 args/env 注入),避免重复逻辑
let mut cmd = command::to_command(mr,target_path, &final_args);
let mut child = match cmd.spawn() {
Ok(v) => v,
Err(e) if e.raw_os_error() == Some(ERROR_ELEVATION_REQUIRED) => {
// 提权回退时需要完整参数:配置默认参数 + 调用方透传参数
// let elevated_args: Vec<OsString> = cmd.get_args().map(|s| s.to_os_string()).collect();
exit(execute_elevated(target_path, &final_args, Some(&mr.env)))
}
Err(e) => {
error!(
"启动目标程序 [{}] 时发生错误: {}",
target_path.to_string_lossy(),
e
);
return EXIT_FAILED_SPAWN_PROG;
}
};
// 5. 等待子进程退出
match child.wait() {
Ok(status) => status.code().unwrap_or(EXIT_PROG_TERMINATED),
Err(e) => {
error!(
"等待目标程序 [{}] 执行完毕时发生错误: {}",
target_path.to_string_lossy(),
e
);
EXIT_FAILED_WAIT_PROG
}
}
}
+44
View File
@@ -0,0 +1,44 @@
use crate::sys::*;
use anyhow::Context;
use mirror_core::{init_logging_from, Layout};
use std::{env, process::exit};
use tracing::debug;
mod executor;
pub mod sys;
pub mod validators;
pub mod command;
fn main() {
let current_exe = match env::current_exe().context("获取代理程序路径失败") {
Ok(exe) => exe,
Err(e) => {
eprintln!("垫片启动失败: {:#}", e);
exit(EXIT_FAILED_LOAD_SHIM);
}
};
let layout = match Layout::from(&current_exe) {
Ok(l) => l,
Err(e) => {
eprintln!("解析程序目录布局失败: {:#}", e);
exit(EXIT_FAILED_LOAD_SHIM);
}
};
//初始化日志:输出到 stderr,避免污染 shim 子进程的 stdout
let _guard = init_logging_from(&layout);
debug!("=== 垫片程序启动 ===");
debug!(
exe = %current_exe.display(),
target_name = %layout.target_name,
"日志系统与布局上下文已就位"
);
// 2. 注册 Windows 控制台信号
set_console_ctrl_handler();
let code = executor::run(&layout);
exit(code);
}
+6
View File
@@ -0,0 +1,6 @@
mod win;
pub use win::{
ERROR_ELEVATION_REQUIRED, EXIT_FAILED_LOAD_SHIM, EXIT_FAILED_SPAWN_PROG, EXIT_FAILED_WAIT_PROG,
EXIT_PROG_TERMINATED, execute_elevated, set_console_ctrl_handler,
};
+152
View File
@@ -0,0 +1,152 @@
use std::os::windows::ffi::OsStrExt;
use std::{env, mem::size_of, path::Path, ptr::null_mut};
use std::ffi::{OsStr, OsString};
use tracing::error;
use windows_sys::Win32::UI::Shell::{SHELLEXECUTEINFOW, ShellExecuteExW};
use windows_sys::Win32::Foundation::CloseHandle;
use windows_sys::{
Win32::{
Foundation::{FALSE, TRUE},
System::{
Com::{COINIT_APARTMENTTHREADED, COINIT_DISABLE_OLE1DDE, CoInitializeEx},
Console::{
CTRL_BREAK_EVENT, CTRL_C_EVENT, CTRL_CLOSE_EVENT, CTRL_LOGOFF_EVENT,
CTRL_SHUTDOWN_EVENT, SetConsoleCtrlHandler,
},
Threading::{GetExitCodeProcess, INFINITE, WaitForSingleObject},
},
UI::{
Shell::{SEE_MASK_NOASYNC, SEE_MASK_NOCLOSEPROCESS},
WindowsAndMessaging::SW_NORMAL,
},
},
core::BOOL,
};
pub const EXIT_FAILED_LOAD_SHIM: i32 = 1;
pub const EXIT_FAILED_SPAWN_PROG: i32 = 2;
pub const EXIT_FAILED_WAIT_PROG: i32 = 3;
pub const EXIT_PROG_TERMINATED: i32 = 4;
pub const ERROR_ELEVATION_REQUIRED: i32 = 740;
unsafe extern "system" fn console_ctrl_handler(evt: u32) -> BOOL {
match evt {
CTRL_C_EVENT => TRUE, //eprintln!("ctrl_c handled!"),
CTRL_BREAK_EVENT => TRUE, //eprintln!("ctrl_break handled!"),
CTRL_CLOSE_EVENT => TRUE, //eprintln!("ctrl_close handled!"),
CTRL_LOGOFF_EVENT => TRUE, //eprintln!("ctrl_logoff handled!"),
CTRL_SHUTDOWN_EVENT => TRUE, //eprintln!("ctrl_shutdown handled!"),
other => {
error!("未知的系统事件编号: {},未处理!", other);
FALSE
}
}
}
pub fn set_console_ctrl_handler() {
let res: BOOL = unsafe { SetConsoleCtrlHandler(Some(console_ctrl_handler), TRUE) };
if res == FALSE {
error!("警告: 注册控制台中断事件处理器失败。");
}
}
fn to_wide_null(s: impl AsRef<OsStr>) -> Vec<u16> {
s.as_ref().encode_wide().chain(std::iter::once(0)).collect()
}
pub fn execute_elevated(
program: &Path,
args: &[OsString],
env_vars: Option<&std::collections::HashMap<String, OsString>>,
) -> i32 {
// 若提权启动,在此处将环境变量设置给当前进程(即将弹窗 UAC 的进程,随后会被子进程继承)
if let Some(env_map) = env_vars {
for (k, v) in env_map {
unsafe {
env::set_var(k, v);
}
}
}
// 2. 将参数列表按 Windows 命令行规则拼装为单个命令行字符串
let mut arguments_os = OsString::new();
for (i, arg) in args.iter().enumerate() {
if i > 0 {
arguments_os.push(" ");
}
let arg_str = arg.to_string_lossy();
if arg_str.is_empty() {
arguments_os.push("\"\"");
} else if !arg_str.contains([' ', '\t', '"']) {
arguments_os.push(arg);
} else {
// 包含空格或引号时进行标准转义包裹
arguments_os.push("\"");
for c in arg_str.chars() {
match c {
'\\' => arguments_os.push("\\\\"),
'"' => arguments_os.push("\\\""),
_ => arguments_os.push(c.to_string()),
}
}
arguments_os.push("\"");
}
}
// 3. 准备 Windows 宽字符参数
let runas = to_wide_null("runas");
let program_wide = to_wide_null(program.as_os_str());
let arguments_wide = to_wide_null(&arguments_os);
let mut info = SHELLEXECUTEINFOW {
cbSize: size_of::<SHELLEXECUTEINFOW>() as u32,
fMask: SEE_MASK_NOASYNC | SEE_MASK_NOCLOSEPROCESS,
hwnd: null_mut(),
lpVerb: runas.as_ptr(),
lpFile: program_wide.as_ptr(),
lpParameters: arguments_wide.as_ptr(),
lpDirectory: null_mut(),
nShow: SW_NORMAL as i32,
hInstApp: null_mut(),
lpIDList: null_mut(),
lpClass: null_mut(),
hkeyClass: null_mut(),
dwHotKey: 0,
Anonymous: unsafe { std::mem::zeroed() },
hProcess: null_mut(),
};
// let arguments = CString::new(&arguments[..]).unwrap();
// let mut info = SHELLEXECUTEINFOA::default();
// info.cbSize = size_of::<SHELLEXECUTEINFOA>() as u32;
// info.fMask = SEE_MASK_NOASYNC | SEE_MASK_NOCLOSEPROCESS;
// info.lpVerb = runas.as_ptr().cast::<u8>();
// info.lpFile = program.as_ptr().cast::<u8>();
// info.lpParameters = arguments.as_ptr().cast::<u8>();
// info.nShow = SW_NORMAL;
let res = unsafe {
CoInitializeEx(
null_mut(),
(COINIT_APARTMENTTHREADED | COINIT_DISABLE_OLE1DDE) as u32,
);
// ShellExecuteExA(&mut info as *mut _)
ShellExecuteExW(&mut info)
};
if res == FALSE || info.hProcess == null_mut() {
return EXIT_FAILED_SPAWN_PROG;
}
// 5. 等待提权子进程执行结束并获取退出状态码
let mut exit_code: u32 = 0;
unsafe {
WaitForSingleObject(info.hProcess, INFINITE);
let ok = GetExitCodeProcess(info.hProcess, &mut exit_code);
CloseHandle(info.hProcess); // 释放进程句柄,防止资源泄露
if ok == FALSE {
return EXIT_FAILED_WAIT_PROG;
}
}
exit_code as i32
}
+246
View File
@@ -0,0 +1,246 @@
use anyhow::Context;
use mlua::{Table, Value};
use std::ffi::OsString;
use std::path::PathBuf;
use std::str::FromStr;
#[cfg(test)]
mod tests {
use super::*;
use mirror_core::MirrorTarget;
use mlua::{FromLua, Lua};
fn parse(src: &str) -> mlua::Result<MirrorTarget> {
let lua = Lua::new();
// 模拟 runtime 注入的 get_env:返回按平台分隔符拆分的段数组(空变量返回空表)
let get_env = lua
.create_function(|lua, key: String| -> mlua::Result<Table> {
let value = std::env::var(key).unwrap_or_default();
let segments: Vec<String> = if value.is_empty() {
Vec::new()
} else {
std::env::split_paths(std::ffi::OsStr::new(&value))
.map(|p| p.to_string_lossy().into_owned())
.collect()
};
lua.create_sequence_from(segments)
})
.unwrap();
lua.globals().set("get_env", get_env).unwrap();
let value = lua.load(src).eval::<Value>()?;
let t = MirrorTarget::from_lua(value, &lua);
println!("读取出的数据:{:?}", t.clone()?);
t
}
#[test]
fn parses_basic_config() {
let cfg = parse(
r#"
return {
target = "C:/tools/git.exe",
args = { "--no-pager",2},
env = {
PATH = { "C:/tools/git/bin", "C:/Windows", get_env("PATH")},
HOME = "C:/tools/home",
CONST = 3,
BOOL = true,
},
aliases = {
-- 1. 整体字符串(会自动 trim 首尾空格,保留为单个参数)
st = "status -s",
-- 2. 连续数组表 (Sequence Table)
lg = { "log", "--oneline", "-n", 10 },
-- 3. 标量数字与布尔值支持
v = 1,
quiet = true,
-- 4. 嵌套别名组合(加载期会自动展开并进行死环检测)
base_log = "log --graph",
all_log = { "mr:base_log", "--all","D:\\CNWei\\CNW\\Rust","D:/CNWei/CNW/Rust/" ,[[D:\CNWei\CNW\Rust\]]},
-- 5. nil 或空字符串(解析为空参数列表)
empty_alias = nil,
blank = " "
}
}
"#,
)
.unwrap();
assert_eq!(
cfg.target.executable_path().unwrap().to_path_buf(),
PathBuf::from("C:/tools/git.exe")
);
// assert_eq!(cfg.args, vec!["--no-pager", "2"]);
assert_eq!(cfg.env.get("HOME").unwrap().to_str(), Some("C:/tools/home"));
// PATH 前缀来自配置,随后附加 get_env("PATH") 拆出的宿主 PATH 段
let path = cfg.env.get("PATH").unwrap().to_str().unwrap();
assert!(
path == "C:/tools/git/bin;C:/Windows"
|| path.starts_with("C:/tools/git/bin;C:/Windows;"),
"unexpected PATH: {path}"
);
// ==================== aliases 断言校验 ====================
// 1. 整体字符串:保留原样(trim 后),不切分空格
assert_eq!(
cfg.aliases.get("st").unwrap(),
&vec![OsString::from("status"), OsString::from("-s")]
);
// 2. 连续数组表:按顺序转为 OsString 列表
assert_eq!(
cfg.aliases.get("lg").unwrap(),
&vec![
OsString::from("log"),
OsString::from("--oneline"),
OsString::from("-n"),
OsString::from("10")
]
);
// 3. 标量数字与布尔值支持
assert_eq!(cfg.aliases.get("v").unwrap(), &vec![OsString::from("1")]);
assert_eq!(
cfg.aliases.get("quiet").unwrap(),
&vec![OsString::from("true")]
);
// 4. 嵌套别名组合:加载期递归拓扑打平
// base_log 本身为 "log --graph"
assert_eq!(
cfg.aliases.get("base_log").unwrap(),
&vec![OsString::from("log"), OsString::from("--graph")]
);
// all_log 展开 mr:base_log 替换为 "log --graph",追加 "--all"
assert_eq!(
cfg.aliases.get("all_log").unwrap(),
&vec![
OsString::from("log"),
OsString::from("--graph"),
OsString::from("--all"),
OsString::from("D:\\CNWei\\CNW\\Rust"),
OsString::from("D:/CNWei/CNW/Rust/"),
OsString::from("D:\\CNWei\\CNW\\Rust\\"),
]
);
// 5. nil 与纯空白字符串:解析为空 Vec
assert_eq!(cfg.aliases.get("blank").unwrap(), &Vec::<OsString>::new());
// nil 键在遍历表时会被当作空或不存在,不产生 key 或值为空 Vec
assert!(
cfg.aliases
.get("empty_alias")
.map_or(true, |v| v.is_empty())
);
}
#[test]
fn missing_args_and_env_are_empty() {
let cfg = parse(r#"return { target = "t.exe" }"#).unwrap();
assert!(cfg.args.is_empty());
assert!(cfg.env.is_empty());
}
#[test]
fn keeps_empty_args() {
let cfg = parse(r#"return { target = "t.exe", args = { "" } }"#).unwrap();
assert_eq!(cfg.args, vec![""]);
}
#[test]
fn keeps_empty_env_value() {
let cfg = parse(r#"return { target = "t.exe", env = { FOO = "" } }"#).unwrap();
assert_eq!(cfg.env.get("FOO").unwrap().to_str(), Some(""));
}
#[test]
fn empty_array_clears_env_var() {
let cfg = parse(r#"return { target = "t.exe", env = { PATH = {} } }"#).unwrap();
assert_eq!(cfg.env.get("PATH").unwrap().to_str(), Some(""));
}
#[test]
fn expands_nested_env_array() {
// get_env("PATH") 现在返回拆分后的段数组,嵌套表应被递归展开
let cfg = parse(
r#"return { target = "t.exe", env = { PATH = { "C:/a", { "C:/b", "C:/c" } } } }"#,
)
.unwrap();
assert_eq!(
cfg.env.get("PATH").unwrap().to_str(),
Some("C:/a;C:/b;C:/c")
);
}
#[test]
fn rejects_wrong_env_type() {
assert!(parse(r#"return { target = "t.exe", env = "PATH=C:/x" }"#).is_err());
}
#[test]
fn rejects_sparse_env_array() {
assert!(parse(r#"return { target = "t.exe", env = { P = { "a", nil, "b" } } }"#).is_err());
}
#[test]
fn rejects_mixed_key_env_array() {
assert!(parse(r#"return { target = "t.exe", env = { P = { a = "b" } } }"#).is_err());
}
#[test]
fn rejects_invalid_env_key() {
assert!(parse(r#"return { target = "t.exe", env = { ["FOO=1"] = "x" } }"#).is_err());
assert!(parse(r#"return { target = "t.exe", env = { [""] = "x" } }"#).is_err());
}
#[test]
fn rejects_nul_in_env_value() {
assert!(parse(r#"return { target = "t.exe", env = { P = { string.char(0) } } }"#).is_err());
}
#[test]
fn rejects_quote_in_env_value() {
// Windows 的 join_paths 对含双引号的路径元素返回错误
assert!(
parse(r#"return { target = "t.exe", env = { P = { string.char(34) } } }"#).is_err()
);
}
#[test]
fn rejects_unsupported_env_value_type() {
assert!(parse(r#"return { target = "t.exe", env = { F = function() end } }"#).is_err());
}
#[test]
fn missing_target_is_error() {
assert!(parse(r#"return { args = { "x" } }"#).is_err());
}
#[test]
fn rejects_non_string_target() {
assert!(parse(r#"return { target = 123 }"#).is_err());
assert!(parse(r#"return { target = false }"#).is_err());
}
#[test]
fn rejects_non_string_args_element() {
// ValueShunt::Args 允许基础标量(数字/布尔)转字符串,仅禁止嵌套表
let cfg = parse(r#"return { target = "t.exe", args = { 1, true } }"#).unwrap();
assert_eq!(cfg.args, vec!["1", "true"]);
}
#[test]
fn rejects_sparse_args() {
assert!(parse(r#"return { target = "t.exe", args = { "a", nil, "b" } }"#).is_err());
}
#[test]
fn rejects_non_table_args() {
assert!(parse(r#"return { target = "t.exe", args = "-B" }"#).is_err());
}
}
+8
View File
@@ -0,0 +1,8 @@
# mirror-log.ini
level = debug
log_dir = "logs"
# 或者带节结构:
# [logger]
# level = info
# log_dir = /var/log/mirror
-145
View File
@@ -1,145 +0,0 @@
use std::{
env,
ffi::CString,
mem::size_of,
path::Path,
process::{exit, Command},
ptr::null_mut,
};
use winapi::{
shared::minwindef::{BOOL, DWORD, FALSE, TRUE},
um::{
combaseapi::CoInitializeEx,
consoleapi,
objbase::{COINIT_APARTMENTTHREADED, COINIT_DISABLE_OLE1DDE},
processthreadsapi::GetExitCodeProcess,
shellapi::{ShellExecuteExA, SEE_MASK_NOASYNC, SEE_MASK_NOCLOSEPROCESS, SHELLEXECUTEINFOA},
synchapi::WaitForSingleObject,
winbase::INFINITE,
wincon,
winuser::SW_NORMAL,
},
};
unsafe extern "system" fn routine_handler(evt: DWORD) -> BOOL {
match evt {
wincon::CTRL_C_EVENT => TRUE, //eprintln!("ctrl_c handled!"),
wincon::CTRL_BREAK_EVENT => TRUE, //eprintln!("ctrl_break handled!"),
wincon::CTRL_CLOSE_EVENT => TRUE, //eprintln!("ctrl_close handled!"),
wincon::CTRL_LOGOFF_EVENT => TRUE, //eprintln!("ctrl_logoff handled!"),
wincon::CTRL_SHUTDOWN_EVENT => TRUE, //eprintln!("ctrl_shutdown handled!"),
other => {
eprintln!("unknown event number: {}, unhandled!", other);
return FALSE;
}
}
}
mod shims;
use shims::Shim;
const EXIT_FAILED_LOAD_SHIM: i32 = 1;
const EXIT_FAILED_SPAWN_PROG: i32 = 2;
const EXIT_FAILED_WAIT_PROG: i32 = 3;
const EXIT_PROG_TERMINATED: i32 = 4;
const ERROR_ELEVATION_REQUIRED: i32 = 740;
fn main() {
let res: BOOL = unsafe { consoleapi::SetConsoleCtrlHandler(Some(routine_handler), TRUE) };
if res == FALSE {
eprintln!("shim: register Ctrl handler failed.");
}
let calling_args: Vec<_> = env::args().skip(1).collect();
let shim = match Shim::init() {
Ok(v) => v,
Err(e) => {
eprintln!("Error while loading shim: {}", e);
exit(EXIT_FAILED_LOAD_SHIM);
}
};
let args = if let Some(mut shim_args) = shim.args {
shim_args.extend_from_slice(calling_args.as_slice());
shim_args
} else {
calling_args
};
let mut cmd = match Command::new(&shim.target_path).args(&args).spawn() {
Ok(v) => v,
Err(e) if e.raw_os_error() == Some(ERROR_ELEVATION_REQUIRED) => {
exit(execute_elevated(&shim.target_path, &args))
}
Err(e) => {
eprintln!(
"Error while spawning target program `{}`: {}",
shim.target_path.to_string_lossy(),
e
);
exit(EXIT_FAILED_SPAWN_PROG);
}
};
let status = match cmd.wait() {
Ok(v) => v,
Err(e) => {
eprintln!(
"Error while waiting target program `{}`: {}",
shim.target_path.to_string_lossy(),
e
);
exit(EXIT_FAILED_WAIT_PROG);
}
};
exit(status.code().unwrap_or(EXIT_PROG_TERMINATED))
}
fn execute_elevated(program: &Path, args: &[String]) -> i32 {
let runas = CString::new("runas").unwrap();
let program = CString::new(program.to_str().unwrap()).unwrap();
let mut params = String::new();
for arg in args.iter() {
params.push(' ');
if arg.len() == 0 {
params.push_str("\"\"");
} else if arg.find(&[' ', '\t', '"'][..]).is_none() {
params.push_str(&arg);
} else {
params.push('"');
for c in arg.chars() {
match c {
'\\' => params.push_str("\\\\"),
'"' => params.push_str("\\\""),
c => params.push(c),
}
}
params.push('"');
}
}
let params = CString::new(&params[..]).unwrap();
let mut info = SHELLEXECUTEINFOA::default();
info.cbSize = size_of::<SHELLEXECUTEINFOA>() as DWORD;
info.fMask = SEE_MASK_NOASYNC | SEE_MASK_NOCLOSEPROCESS;
info.lpVerb = runas.as_ptr();
info.lpFile = program.as_ptr();
info.lpParameters = params.as_ptr();
info.nShow = SW_NORMAL;
let res = unsafe {
CoInitializeEx(
null_mut(),
COINIT_APARTMENTTHREADED | COINIT_DISABLE_OLE1DDE,
);
ShellExecuteExA(&mut info as *mut _)
};
if res == FALSE || info.hProcess == null_mut() {
return EXIT_FAILED_SPAWN_PROG;
}
let mut code: DWORD = 0;
unsafe {
WaitForSingleObject(info.hProcess, INFINITE);
if GetExitCodeProcess(info.hProcess, &mut code as *mut _) == FALSE {
return EXIT_FAILED_WAIT_PROG;
}
}
return code as i32;
}
-89
View File
@@ -1,89 +0,0 @@
use fs_err as fs;
use std::{
collections::HashMap,
env,
io::{Error, ErrorKind},
path::{Path, PathBuf},
};
pub struct Shim {
pub target_path: PathBuf,
pub args: Option<Vec<String>>,
}
impl Shim {
pub fn init() -> Result<Self, Error> {
let shim_path = get_shim_file_path()?;
let kvs = parse_shim_file(&shim_path)?;
let target_path = match kvs.get("path") {
Some(p) => PathBuf::from(p),
None => {
return Err(Error::new(
ErrorKind::NotFound,
format!("no path key in {}", shim_path.to_string_lossy()),
))
}
};
let args = kvs.get("args").map(|a| {
a.split_whitespace()
.map(|s| s.to_string())
.collect::<Vec<_>>()
});
Ok(Self { target_path, args })
}
}
fn get_shim_file_path() -> Result<PathBuf, Error> {
let mut current_exe = env::current_exe().map_err(|e| {
Error::new(
ErrorKind::Other,
format!("acquiring shim executable path: {}", e),
)
})?;
if !current_exe.set_extension("shim") {
return Err(Error::new(
ErrorKind::Other,
format!("{} is not a file", current_exe.to_string_lossy()),
));
}
Ok(current_exe)
}
use unicode_bom::Bom;
fn parse_shim_file(shim_path: &Path) -> Result<HashMap<String, String>, Error> {
let mut kvs = HashMap::new();
let raw_content = fs::read_to_string(shim_path).map_err(|e| {
Error::new(
ErrorKind::Other,
format!("reading {}: {}", shim_path.to_string_lossy(), e),
)
})?;
//NOTE: expedient trick for utf-8 with bom
let bom = Bom::from(raw_content.as_bytes());
for line in raw_content[bom.len()..]
.lines()
.filter(|l| !l.trim().is_empty())
{
let mut components = line.split("=");
let key = match components.next() {
Some(k) => k.trim(),
None => {
return Err(Error::new(
ErrorKind::InvalidData,
format!("invalid line in shim file: {}", line),
));
}
};
let value = match components.next() {
Some(v) => v.trim(),
None => {
return Err(Error::new(
ErrorKind::InvalidData,
format!("invalid line in shim file: {}", line),
));
}
};
kvs.insert(key.to_string(), value.to_string());
}
Ok(kvs)
}
+1527
View File
File diff suppressed because it is too large Load Diff