Author SHA1 Message Date
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
45 changed files with 3659 additions and 962 deletions
+2
View File
@@ -3,3 +3,5 @@
/.idea
*.exe
./Cargo.lock
**/target
**/Cargo.lock
Generated
+177 -15
View File
@@ -11,6 +11,56 @@ dependencies = [
"memchr",
]
[[package]]
name = "anstream"
version = "1.0.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "824a212faf96e9acacdbd09febd34438f8f711fb84e09a8916013cd7815ca28d"
dependencies = [
"anstyle",
"anstyle-parse",
"anstyle-query",
"anstyle-wincon",
"colorchoice",
"is_terminal_polyfill",
"utf8parse",
]
[[package]]
name = "anstyle"
version = "1.0.14"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "940b3a0ca603d1eade50a4846a2afffd5ef57a9feac2c0e2ec2e14f9ead76000"
[[package]]
name = "anstyle-parse"
version = "1.0.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "52ce7f38b242319f7cabaa6813055467063ecdc9d355bbb4ce0c68908cd8130e"
dependencies = [
"utf8parse",
]
[[package]]
name = "anstyle-query"
version = "1.1.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "40c48f72fd53cd289104fc64099abca73db4166ad86ea0b4341abe65af83dadc"
dependencies = [
"windows-sys",
]
[[package]]
name = "anstyle-wincon"
version = "3.0.11"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "291e6a250ff86cd4a820112fb8898808a366d8f9f58ce16d1f538353ad55747d"
dependencies = [
"anstyle",
"once_cell_polyfill",
"windows-sys",
]
[[package]]
name = "anyhow"
version = "1.0.104"
@@ -41,9 +91,9 @@ dependencies = [
[[package]]
name = "cc"
version = "1.4.3"
version = "1.4.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "509591b7bcd67f4ef775afad7662703b4935daaa6ec0e5605cfb1090b32a2b6d"
checksum = "0ad534f4357a5264cce5019c989cf66a4f0dc4e0d1b1d15f8aacec0ff7360273"
dependencies = [
"find-msvc-tools",
"shlex",
@@ -55,6 +105,52 @@ version = "1.0.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801"
[[package]]
name = "clap"
version = "4.6.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "473c7e07f409a8d772161724aa8db6a765a2532a70f9667eeb7b49d3d02fbdca"
dependencies = [
"clap_builder",
"clap_derive",
]
[[package]]
name = "clap_builder"
version = "4.6.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7b48fea5a88e9ae728a2dcbedbfc0e730f7d60da42e1cb049a83c9fb8b789889"
dependencies = [
"anstream",
"anstyle",
"clap_lex",
"strsim",
]
[[package]]
name = "clap_derive"
version = "4.6.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d012d2b9d65aca7f18f4d9878a045bc17899bba951561ba5ec3c2ba1eed9a061"
dependencies = [
"heck",
"proc-macro2",
"quote",
"syn 3.0.3",
]
[[package]]
name = "clap_lex"
version = "1.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c8d4a3bb8b1e0c1050499d1815f5ab16d04f0959b233085fb31653fbfc9d98f9"
[[package]]
name = "colorchoice"
version = "1.0.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1d07550c9036bf2ae0c684c4297d503f838287c83c53686d05370d0e139ae570"
[[package]]
name = "crossbeam-channel"
version = "0.5.16"
@@ -84,9 +180,9 @@ checksum = "92773504d58c093f6de2459af4af33faa518c13451eb8f2b5698ed3d36e7c813"
[[package]]
name = "either"
version = "1.17.0"
version = "1.18.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9e5e8f6c15a24b9a3ee5efec809ccd006d3b30e8b3bb63c39af737c7f87daa1d"
checksum = "252afb9ae5eaa683babdc6a068b3f5726eb19e05070c731f9b2a23a7c3e8ed34"
[[package]]
name = "find-msvc-tools"
@@ -94,6 +190,18 @@ version = "0.1.11"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d45db016d36b838f563236e9193d0ee6ce38f3f68b6c94e914b4929c96bbb890"
[[package]]
name = "heck"
version = "0.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
[[package]]
name = "is_terminal_polyfill"
version = "1.70.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a6cb138bb79a146c1bd460005623e142ef0181e3d0219cb493e02f7d08a35695"
[[package]]
name = "lazy_static"
version = "1.5.0"
@@ -123,18 +231,18 @@ checksum = "0ceec5bc11778974d1bcb055b18002eba7f4b3518b6a0081b3af5f21666da9ad"
[[package]]
name = "lua-src"
version = "550.1.1"
version = "551.0.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "75c110c2fa33f34e0de05448e1f3eb2e0631e7a69e2d8ae1586cffc9fc9f9949"
checksum = "087097f9936a7d819bda525b32d6e96f9c54f3d35ff23ff72fc0c1697d2127db"
dependencies = [
"cc",
]
[[package]]
name = "luajit-src"
version = "210.7.2+b925b3e"
version = "210.7.3+1ee778a"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "920cf654b23d217c550ceea57c32cd2a413ea27b6d47ed77b5ee0cf655adefa6"
checksum = "869665372263eb337b14f480cfb864b89f12eade4eb42cb415f71517b4a67572"
dependencies = [
"cc",
"which",
@@ -156,12 +264,25 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "cf8baf1c55e62ffcace7a9f06f4bd9cd3f0c4beb022d3b367256b91b87513d98"
[[package]]
name = "mirror"
name = "mirror-cli"
version = "0.1.0"
dependencies = [
"anyhow",
"clap",
"mirror-core",
"mlua",
"tracing",
]
[[package]]
name = "mirror-core"
version = "0.1.0"
dependencies = [
"anyhow",
"dunce",
"mlua",
"serde",
"thiserror",
"tinyjson",
"tracing",
"tracing-appender",
@@ -169,11 +290,24 @@ dependencies = [
"windows-sys",
]
[[package]]
name = "mirror-shim"
version = "0.1.0"
dependencies = [
"anyhow",
"mirror-core",
"mlua",
"tracing",
"tracing-appender",
"tracing-subscriber",
"windows-sys",
]
[[package]]
name = "mlua"
version = "0.12.0"
version = "0.12.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ad72ffa037cf5970c9860674f32f703fda25d86cf217475fe7a79c5f9961bcaa"
checksum = "d96e5d00f19d8c46c71ceaced99593b90c31c57aa1fe2cb3e93a8b1698eedba9"
dependencies = [
"bstr",
"either",
@@ -186,9 +320,9 @@ dependencies = [
[[package]]
name = "mlua-sys"
version = "0.11.0"
version = "0.12.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "92136787b906d4e55cfe96cd6c62e010bb1a56889d0d6cf83eb016dbad07576b"
checksum = "b806d7ade031f5d6607eae3e283fb034cb795a76247dd0d1ba753c8c42debccf"
dependencies = [
"cc",
"cfg-if",
@@ -228,6 +362,12 @@ version = "1.21.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
[[package]]
name = "once_cell_polyfill"
version = "1.70.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "384b8ab6d37215f3c5301a95a4accb5d64aa607f1fcb26a11b5303878451b4fe"
[[package]]
name = "parking_lot"
version = "0.12.5"
@@ -325,6 +465,16 @@ version = "1.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49"
[[package]]
name = "serde"
version = "1.0.229"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "4148590afebada386688f18773da617792bf2ef03ffc1e4cbd2b1d45b023e0ba"
dependencies = [
"serde_core",
"serde_derive",
]
[[package]]
name = "serde_core"
version = "1.0.229"
@@ -366,6 +516,12 @@ version = "1.15.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8ed6a63f02c8539c91a8685a86f4099661ba3da017932f6ebbea6de3f0fa7c90"
[[package]]
name = "strsim"
version = "0.11.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f"
[[package]]
name = "symlink"
version = "0.1.0"
@@ -539,6 +695,12 @@ version = "1.0.24"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
[[package]]
name = "utf8parse"
version = "0.2.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
[[package]]
name = "valuable"
version = "0.1.1"
@@ -547,9 +709,9 @@ checksum = "ba73ea9cf16a25df0c8caa16c51acb937d5712a8429db78a3ee29d5dcacd3a65"
[[package]]
name = "which"
version = "8.0.5"
version = "8.0.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8f3ef584124b911bcc3875c2f1472e80f24361ceb789bd1c62b3e9a3df9ff43c"
checksum = "bae2f2b2b816647a1cab1acc91f5bd20812d53cb344382635ec2181940c8034f"
dependencies = [
"libc",
]
+14 -10
View File
@@ -1,16 +1,21 @@
[package]
name = "mirror"
[workspace]
resolver = "2"
members = [
"mirror-core", "mirror-cli",
"mirror-shim",
]
#[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"
[profile.release]
opt-level = "z"
panic = "abort"
[dependencies]
[workspace.dependencies]
anyhow = "1.0.104"
mlua = { version = "0.12.0", features = ["lua54", "vendored","send"] }
@@ -30,9 +35,8 @@ 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"
[features]
default = ["args"]
args=[]
+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
+16
View File
@@ -0,0 +1,16 @@
[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"] }
mlua = { workspace = true }
anyhow = { workspace = true }
tracing = { workspace = true }
+54
View File
@@ -0,0 +1,54 @@
use crate::commands::dynamic::MrCommand;
use clap::{Arg, ArgAction, Command};
use mirror_core::LogLevel;
use std::ffi::OsString;
// 引入强类型枚举
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());
for (name, sub_cmd) in dynamic_cmds.commands {
if name == "log" {
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
}
/// 构建基础 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] = &["handler", "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,
})
}
}
+2
View File
@@ -0,0 +1,2 @@
pub(crate) mod builtin;
pub(crate) mod dynamic;
+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(),
}
}
}
+64
View File
@@ -0,0 +1,64 @@
use crate::cli;
use crate::commands::{builtin, dynamic::MrCommand};
use crate::error::ExecuteError;
use crate::plugins::register_mr_command;
use anyhow::{Context, Result};
use mirror_core::{Layout, LuaRuntime, register_basics};
// 成功的标准退出码
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 registry_file = layout.base_dir.join("commands").join("commands.lua");
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 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() {
// 分支 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 => {}
}
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::{Error, 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)
}
+17
View File
@@ -0,0 +1,17 @@
[package]
name = "mirror-core"
version = { workspace = true }
edition = { workspace = true }
[dependencies]
anyhow = { workspace = true }
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"
+130
View File
@@ -0,0 +1,130 @@
use std::fmt;
use std::path::PathBuf;
use thiserror::Error;
// 构造一个带上下文的 FromLua 转换错误,便于定位配置问题
/// 配置校验错误
pub fn validation_error(message: impl Into<String>) -> mlua::Error {
mlua::Error::RuntimeError(message.into())
}
pub fn conversion_err(
from: &'static str,
to: impl Into<String>,
msg: impl Into<String>,
) -> mlua::Error {
mlua::Error::FromLuaConversionError {
from,
to: to.into(),
message: Some(msg.into()),
}
}
/// 将底层 Lua 语法错误转换为用户友好的提示
pub fn syntax_error(err: mlua::Error) -> mlua::Error {
match &err {
mlua::Error::SyntaxError { message, .. } => {
if message.contains("invalid escape sequence") || message.contains("unfinished string")
{
return validation_error(format!(
"配置文件语法错误:检测到非法的字符串转义。\n\
提示:在 Windows 路径末尾或字符串中使用反斜杠 '\\' 时:\n\
1. 请使用双反斜杠转义,例如: \"D:\\\\CNWei\\\\CNW\\\\Rust\\\\\"\n\
2. 或使用 Lua 原始字符串 (Raw String),例如: [[D:\\CNWei\\CNW\\Rust\\]]\n\
底层错误: {}",
message
));
}
}
_ => {}
}
err
}
/// 全局统一的 `Result` 别名,默认错误类型为 [`Error`]。
pub type Result<T, E = Error> = std::result::Result<T, E>;
#[derive(Error, Debug)]
pub enum Error {
#[error("初始化 Lua 沙箱失败: {0}")]
LuaInit(#[source] mlua::Error),
#[error("构建 LuaRuntime 异常")]
BuildError,
///读取脚本文件失败
#[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}")]
LuaError(#[from] mlua::Error),
// #[error("设置 {0} 环境变量失败")]
// SetMirrorDir(String),
/// 用户自定义扩展错误,用于包装第三方插件产生的错误。
#[error("用户自定义扩展错误: {0}")]
Other(#[source] Box<dyn std::error::Error + Send + Sync>),
}
/// 将 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
)
}
}
}
}
impl std::error::Error for TargetExecutionError {}
+17 -12
View File
@@ -5,49 +5,53 @@ use tracing::debug;
pub struct Layout {
pub base_dir: PathBuf,
pub bin_dir: PathBuf,
pub tools_dir: PathBuf,
pub lua_file: PathBuf,
pub target_name: String,
}
impl Layout {
/// 自动解析目录布局:
/// 1. 优先使用环境变量 MIRROR_HOME
/// 2. 兜底回退到当前垫片可执行文件所在目录推断 (exe -> bin -> root)
pub fn discover(current_exe: &Path) -> Result<Self> {
pub fn from(current_exe: &Path) -> Result<Self> {
let target_name = current_exe
.file_stem()
.and_then(|s| s.to_str())
.with_context(|| 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));
return Self::from_base_dir(PathBuf::from(trimmed), target_name);
}
}
// 策略 2: 相对路径自动推断兜底
debug!("未配置 MIRROR_HOME,尝试从当前可执行文件路径推断根目录");
Self::from_executable(current_exe)
Self::from_executable(current_exe, target_name)
}
/// 基于确定的根目录构建完整布局
fn from_base_dir(base_dir: PathBuf) -> Result<Self> {
fn from_base_dir(base_dir: PathBuf, target_name: String) -> Result<Self> {
if !base_dir.is_dir() {
bail!("指定的根目录不存在或不是有效目录: [{}]", base_dir.display());
}
let bin_dir = base_dir.join("bin");
let tools_dir = base_dir.join("tools");
let lua_file = base_dir.join("../mirror.lua");
Ok(Self {
base_dir,
bin_dir,
tools_dir,
lua_file,
target_name,
})
}
/// 从当前可执行文件解析 shim 安装目录布局
fn from_executable(exe_path: &Path) -> Result<Self> {
fn from_executable(exe_path: &Path, target_name: String) -> Result<Self> {
// let exe_path = exe_path.as_ref();
let bin_dir = exe_path
.parent()
@@ -60,8 +64,9 @@ impl Layout {
.parent()
.with_context(|| format!("无法获取 bin 目录 [{}] 的父级 root 目录", bin_dir.display()))?
.to_path_buf();
debug!("base_dir 目录 {}", base_dir.display());
Self::from_base_dir(base_dir)
Self::from_base_dir(base_dir, target_name)
}
}
+20
View File
@@ -0,0 +1,20 @@
mod error;
mod layout;
mod logger;
mod plugins;
mod runtime;
mod utils;
mod validators;
mod model;
pub use layout::Layout;
// pub use mirror_shim::mirror::Mirror;
pub use runtime::LuaRuntime;
pub use logger::{LogConfig, LogLevel, init_logging_from};
pub use plugins::register_basics;
pub use utils::normalize_path_for_lua;
pub use validators::validate_command_name;
// 把 Result 和 Error 提升到根命名空间,给外部带来极致便利
pub use error::{Error, Result,validation_error,conversion_err,TargetExecutionError};
pub use model::TargetConfig;
+187
View File
@@ -0,0 +1,187 @@
use crate::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)
}
+127
View File
@@ -0,0 +1,127 @@
use std::ffi::OsString;
use mlua::{FromLua, Lua, LuaString, Value};
use std::path::PathBuf;
use crate::utils::lua_string_2_os_string;
use crate::validation_error;
use crate::validators::ensure_no_nul;
/// 目标可执行文件的定位配置(支持静态路径与多版本 Table)
#[derive(Debug, Clone)]
pub enum TargetConfig{
/// 静态单版本工具
Static(PathBuf),
/// 多版本管理
Versioned{
/// 工具主根目录(供 mr use 扫描候选版本)
home:PathBuf,
/// 版本真相源文件名(如 ".version",可选,默认 ".version")
version_file:Option<String>,
/// 当前激活版本的可执行文件完整路径(若未激活或不存在则为 None)
current:Option<PathBuf>,
}
}
impl Default for TargetConfig {
fn default() -> Self {
TargetConfig::Static(PathBuf::default())
}
}
impl TargetConfig {
/// 垫片程序(mirror-shim)专用快速通道:提取最终可执行路径
///
/// - Static: 返回自身路径
/// - Versioned: 返回 current 路径(若未激活则返回 None)
pub fn executable_path(&self) -> Option<&PathBuf> {
match self {
TargetConfig::Static(path) => Some(path),
TargetConfig::Versioned { current, .. } => current.as_ref(),
}
}
/// 管理程序(mr-cli)专用辅助方法:判断是否支持多版本
pub fn is_versioned(&self) -> bool {
matches!(self, TargetConfig::Versioned { .. })
}
}
impl FromLua for TargetConfig {
fn from_lua(value: Value, _lua: &Lua) -> mlua::Result<Self> {
match value {
// 分支 1:静态单版本工具 target = "..."
Value::String(s) => {
let os_str = lua_string_2_os_string(&s)?;
ensure_no_nul(&"target", &os_str)?;
Ok(TargetConfig::Static(PathBuf::from(os_str)))
}
// 分支 2:多版本管理工具 target = { home = "...", ... }
Value::Table(table) => {
// 1. home (必填字段)
let home = match table.get::<Option<Value>>("home")? {
Some(Value::String(s)) => {
let os_str = lua_string_2_os_string(&s)?;
ensure_no_nul(&"target.home", &os_str)?;
PathBuf::from(os_str)
}
None | Some(Value::Nil) => {
return Err(validation_error("多版本 target 表缺少必填字段 'home'"));
}
Some(other) => {
return Err(validation_error(format!(
"target.home 需为路径字符串,实际类型是 {}",
other.type_name()
)));
}
};
// 2. version_file (选填字段,未填或 nil 时为 None)
let version_file = match table.get::<Option<Value>>("version_file")? {
Some(Value::String(s)) => {
let os_str = lua_string_2_os_string(&s)?;
ensure_no_nul(&"target.version_file", &os_str)?;
Some(os_str.to_string_lossy().into_owned())
}
None | Some(Value::Nil) => None,
Some(other) => {
return Err(validation_error(format!(
"target.version_file 需为文件名字符串,实际类型是 {}",
other.type_name()
)));
}
};
// 3. current (选填/可为 nil,表示未激活或当前未指定版本)
let current = match table.get::<Option<Value>>("current")? {
Some(Value::String(s)) => {
let os_str = lua_string_2_os_string(&s)?;
ensure_no_nul(&"target.current", &os_str)?;
Some(PathBuf::from(os_str))
}
// Lua 侧 ver 为 nil 时,current 拼出的也是 nil,此时合法解析为 None
None | Some(Value::Nil) => None,
Some(other) => {
return Err(validation_error(format!(
"target.current 需为有效路径字符串或 nil,实际类型是 {}",
other.type_name()
)));
}
};
Ok(TargetConfig::Versioned {
home,
version_file,
current,
})
}
Value::Nil => Err(validation_error(
"缺少必填字段 target(应为字符串路径或多版本配置表)",
)),
other => Err(validation_error(format!(
"target 需为有效路径字符串或多版本配置表,实际类型是 {}",
other.type_name()
))),
}
}
}
+111
View File
@@ -0,0 +1,111 @@
use crate::error::{Error, Result};
use crate::{Layout, normalize_path_for_lua};
use mlua::{Lua, Table, Value};
use std::env;
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)?;
Ok(())
}
/// 注入全局锚点变量
pub fn register_mirror_dir(lua: &Lua, base_dir: &str) -> Result<()> {
debug!("设置 {MIRROR_DIR} 环境变量");
lua.globals().set(MIRROR_DIR, base_dir)?;
// .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(())
}
+225
View File
@@ -0,0 +1,225 @@
use crate::{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;
fn test_layout() -> Layout {
let root = std::env::temp_dir().join("rshim-test-layout");
Layout {
base_dir: root.clone(),
bin_dir: root.join("bin"),
target_name: "muna".to_string(),
}
}
#[test]
fn missing_module_require_returns_nil() {
let runtime = LuaRuntime::builder().build().unwrap();
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 = LuaRuntime::builder().build().unwrap();
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 = LuaRuntime::builder().build().unwrap();
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 = LuaRuntime::builder().build().unwrap();
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()),
}
}
// #[test]
// fn path_with_get_env_joins_without_quote_error() {
// // 复现用户场景:PATH = { base_dir .. "/tools/numa", get_env("PATH") }
// // 宿主 PATH 即使含双引号,也应拆分后正常拼接,而不是报错
// let runtime = LuaRuntime::new(&test_layout()).unwrap();
// let cfg: Mirror = runtime
// .lua
// .load(
// r#"
// return {
// target = __SHIM_DIR__ .. "/tools/numa/numa.exe",
// args = { "--help" },
// env = {
// PATH = { __SHIM_DIR__ .. "/tools/numa", get_env("PATH") }
// }
// }
// "#,
// )
// .eval()
// .unwrap();
//
// let path = cfg.env.get("PATH").unwrap().to_str().unwrap();
// let prefix = std::env::temp_dir()
// .join("rshim-test-layout")
// .to_string_lossy()
// .replace('\\', "/")
// + "/tools/numa;";
// assert!(path.starts_with(&prefix), "unexpected PATH: {path}");
//
// // 宿主 PATH 的段应被附加在配置前缀之后
// let host = std::env::var("PATH").unwrap_or_default();
// if !host.is_empty() {
// let host_first = std::env::split_paths(&host)
// .next()
// .unwrap()
// .to_string_lossy()
// .into_owned();
// assert!(
// path.contains(&host_first),
// "missing host PATH segment: {host_first}"
// );
// }
//
// // 宿主 PATH 里引号包裹的畸形段(如 "D:\\...\\bin;")应被原样保留,
// // 而不是让整个配置加载失败
// if host.contains('"') {
// assert!(
// path.contains('"'),
// "quoted host segments should be preserved"
// );
// }
// }
}
+71
View File
@@ -0,0 +1,71 @@
use mlua::LuaString;
use std::ffi::OsString;
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('\\', "/")
}
pub fn lua_string_2_os_string(s: &LuaString) -> mlua::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(mlua::Error::FromLuaConversionError {
from: "LuaString",
to: "OsString".to_string(),
message: Some(
format!("字符串{:?}包含无效或当前系统无法识别的编码字节", s).to_string(),
),
});
}
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))
}
}
}
+65
View File
@@ -0,0 +1,65 @@
use std::fmt;
use crate::error::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)
}
pub fn ensure_no_nul(context: &impl fmt::Display, os_str: &std::ffi::OsStr) -> mlua::Result<()> {
#[cfg(unix)]
{
use std::os::unix::ffi::OsStrExt;
if os_str.as_bytes().contains(&0) {
return Err(conversion_error(format!(
"{} 的值不能包含 NUL 字符",
context
)));
}
}
#[cfg(windows)]
{
use std::os::windows::ffi::OsStrExt;
if os_str.encode_wide().any(|c| c == 0) {
return Err(validation_error(format!(
"{} 的值不能包含 NUL 字符",
context
)));
}
}
Ok(())
}
+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"
+2 -1
View File
@@ -1,6 +1,6 @@
-- mirror.lua (总控制台)
-- __MIRROR_DIR__ 已经在 Rust 中注入完毕,并且是正斜杠格式 (例如 C:/Tools)
local base_dir = __MIRROR_DIR__
base_dir = __MIRROR_DIR__
-- 1. 自定义局部变量,方便复用与后续维护
local python_home = base_dir .. "/tools/python39"
@@ -10,6 +10,7 @@ return {
-- 1. 标准相对路径 + 正斜杠拼接 (最推荐,绿色便携)
---------------------------------------------------
["numa"] = {
home="",
target = base_dir .. "/tools/numa/numa.exe",
-- 追加参数
args = { "--help" },
+98
View File
@@ -0,0 +1,98 @@
use crate::mirror::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};
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());
// 构建 Command:复用 ShimConfig::to_command(含 args/env 注入),避免重复逻辑
let mut cmd = mr.to_command(target_path, combined_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, &elevated_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
}
}
}
+45
View File
@@ -0,0 +1,45 @@
use crate::sys::*;
use anyhow::Context;
use mirror_core::{Layout, init_logging_from};
use std::{env, process::exit};
use tracing::debug;
mod executor;
pub mod mirror;
pub mod sys;
pub mod utils;
pub mod validators;
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);
}
+180
View File
@@ -0,0 +1,180 @@
use crate::validators::LuaValidator;
use anyhow::{Context, Result, bail};
use mirror_core::validate_command_name;
use mirror_core::{Layout, LuaRuntime, TargetConfig};
use mirror_core::{TargetExecutionError, conversion_err, validation_error};
use mlua::{FromLua, Lua, Table, Value};
use std::collections::HashMap;
use std::env;
use std::ffi::OsString;
use std::path::{Path, PathBuf};
use std::process::Command;
use tracing::{debug, trace};
pub struct MirrorRegistry {
pub targets: HashMap<String, MirrorTarget>,
}
impl FromLua for MirrorRegistry {
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(),
"MirrorRegistry",
format!(
"mirror 全局注册表顶层必须是 Table,实际检测到: {}",
other.type_name()
),
));
}
};
let mut targets = HashMap::new();
for pair in root_tbl.pairs::<Value, Value>() {
let (key, entry) = pair?;
let target_name = validate_command_name(&key)?;
// 2. 校验 entry 是否是 Table
if !entry.is_table() {
return Err(conversion_err(
entry.type_name(),
"MirrorRegistry",
format!(
"目标工具 '{target_name}' 的配置必须是 Table,实际检测到: {}",
entry.type_name()
),
));
}
// 3. 直接交由子命令解析,外层负责补充错误上下文
let target_spec = MirrorTarget::from_lua(entry, lua).map_err(|err| {
validation_error(format!("目标工具 '{target_name}' 配置解析失败:\n{err}"))
})?;
targets.insert(target_name, target_spec);
}
Ok(Self { targets })
}
}
/// 单个目标程序的代理规格配置
#[derive(Debug, Clone, Default)]
pub struct MirrorTarget {
/// 目标程序可执行文件路径
pub target: TargetConfig,
/// 默认预设参数列表
pub args: Vec<OsString>,
/// 参数别名映射表(用于展开以 mr: 为前缀的别名)
pub aliases: HashMap<String, Vec<OsString>>,
/// 注入/覆盖的环境变量
pub env: HashMap<String, OsString>,
}
impl MirrorTarget {
/// 1. 核心参数路由解析(Delegation 到 Spec 的路由逻辑)
fn resolve_args<I, S>(&self, 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) = self.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
}
pub fn to_command<P, I, S>(&self, target: P, combined_args: I) -> Command
where
P: AsRef<Path>,
I: IntoIterator<Item = S>,
S: AsRef<std::ffi::OsStr>,
{
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 &self.env {
// 直接应用环境变量(Lua 端已经处理好字符串拼接或列表合并)
cmd.env(key, val);
}
cmd
}
}
impl FromLua for MirrorTarget {
fn from_lua(value: Value, lua: &Lua) -> mlua::Result<Self> {
// 脚本返回必须是一个 Table 变体
let table = match value {
Value::Table(t) => t,
_ => {
return Err(validation_error(format!(
"期望得到一个 Lua Table 配置对象,实际是 {}",
value.type_name()
)));
}
};
// 必填字段: target(严格限定为字符串,避免数字被 mlua 宽松转为字符串后掩盖错误)
let target = match table.get::<Option<Value>>("target")? {
None | Some(Value::Nil) => {
return Err(validation_error(
"缺少必填字段 target(应为字符串路径或多版本配置表)",
));
}
// Some(target_val) => LuaValidator::parse_target(&target_val)?,
Some(target_val) => TargetConfig::from_lua(target_val, lua)?,
};
// 可选字段: args(缺失或 nil 时默认空列表;保留空字符串参数,与提权路径的 "" 语义一致)
let args = match table.get::<Option<Value>>("args")? {
None | Some(Value::Nil) => Vec::new(),
Some(args_val) => LuaValidator::parse_args(&args_val)?,
};
// 可选字段: env(只允许缺失/nil,其他类型由 Option<Table> 转换报错,不再静默忽略)
let env = match table.get::<Option<Value>>("env")? {
None | Some(Value::Nil) => HashMap::new(),
Some(env_val) => LuaValidator::parse_env(&env_val)?,
};
// 可选字段: aliases(只允许缺失/nil,其他类型由 Option<Table> 转换报错,不再静默忽略)
let aliases = match table.get::<Option<Value>>("aliases")? {
None | Some(Value::Nil) => HashMap::new(),
Some(env_val) => LuaValidator::parse_aliases(&env_val)?,
};
// println!("环境变量结果:{:?}", env);
Ok(Self {
target,
args,
aliases,
env,
})
}
}
@@ -2,7 +2,7 @@ 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;
@@ -40,7 +40,7 @@ unsafe extern "system" fn console_ctrl_handler(evt: u32) -> BOOL {
CTRL_LOGOFF_EVENT => TRUE, //eprintln!("ctrl_logoff handled!"),
CTRL_SHUTDOWN_EVENT => TRUE, //eprintln!("ctrl_shutdown handled!"),
other => {
eprintln!("未知的系统事件编号: {},未处理!", other);
error!("未知的系统事件编号: {},未处理!", other);
FALSE
}
}
@@ -49,7 +49,7 @@ unsafe extern "system" fn console_ctrl_handler(evt: u32) -> BOOL {
pub fn set_console_ctrl_handler() {
let res: BOOL = unsafe { SetConsoleCtrlHandler(Some(console_ctrl_handler), TRUE) };
if res == FALSE {
eprintln!("警告: 注册控制台中断事件处理器失败。");
error!("警告: 注册控制台中断事件处理器失败。");
}
}
@@ -1,13 +1,5 @@
use mlua::LuaString;
use std::ffi::OsString;
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('\\', "/")
}
/// 将 Lua 字符串转为 Rust 字符串;非 UTF-8 按系统默认的 ANSI/OEM (如 GBK) 进行安全解码
pub fn lua_string_2_os_string(s: &LuaString) -> mlua::Result<OsString> {
@@ -1,13 +1,14 @@
use crate::error::validation_error;
use crate::{lua_string_2_os_string, parse_tokens};
use anyhow::{Context, Result, anyhow};
use mirror_core::{TargetConfig, validation_error};
use mlua::{LuaString, Table, Value};
use std::collections::{HashMap, HashSet};
use std::ffi::OsString;
use std::fmt;
use std::path::PathBuf;
use std::str::FromStr;
use tinyjson::JsonValue;
// use tinyjson::JsonValue;
use crate::utils::{lua_string_2_os_string, parse_tokens};
use tracing::debug;
/// Lua 值校验器:针对不同上下文定义校验规则
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
@@ -211,17 +212,79 @@ impl LuaValidator {
}
impl LuaValidator {
/// 解析并校验 `target`
pub fn parse_target(value: &Value) -> mlua::Result<PathBuf> {
pub fn parse_target(value: &Value) -> mlua::Result<TargetConfig> {
let ctx = Self::Target;
match value {
Value::String(s) => {
let os_str = lua_string_2_os_string(&s)?;
Self::ensure_no_nul(&ctx, &os_str)?;
Ok(PathBuf::from(os_str))
Ok(TargetConfig::Static(PathBuf::from(os_str)))
}
Value::Nil => Err(validation_error("缺少必填字段 target(应为字符串路径)")),
// 分支 2:多版本动态工具 target = { home = "...", version_file = "...", current = "..." }
Value::Table(t) => {
// 1. 解析 home(必填)
let home_val = t.get::<Value>("home")?;
let home = match home_val {
Value::String(ref s) => {
let os_str = lua_string_2_os_string(s)?;
Self::ensure_no_nul(&"target.home", &os_str)?;
PathBuf::from(os_str)
}
Value::Nil => {
return Err(validation_error("多版本 target 表缺少必填字段 'home'"));
}
other => {
return Err(validation_error(format!(
"target.home 需为有效路径字符串,实际类型是 {}",
other.type_name()
)));
}
};
// 2. 解析 version_file(选填,默认为 None,后续业务可 fallback 到 .version)
let version_file = match t.get::<Option<Value>>("version_file")? {
Some(Value::String(ref s)) => {
let os_str = lua_string_2_os_string(s)?;
Self::ensure_no_nul(&"target.version_file", &os_str)?;
Some(os_str.to_string_lossy().into_owned())
}
Some(Value::Nil) | None => None,
Some(other) => {
return Err(validation_error(format!(
"target.version_file 应为文件名字符串,实际类型是 {}",
other.type_name()
)));
}
};
// 3. 解析 current(选填/可为 nil:未激活或找不到版本时允许为 None)
let current = match t.get::<Option<Value>>("current")? {
Some(Value::String(ref s)) => {
let os_str = lua_string_2_os_string(s)?;
Self::ensure_no_nul(&"target.current", &os_str)?;
Some(PathBuf::from(os_str))
}
// Lua 侧 ver 为 nil 时,current 计算结果即为 nil,合法放行
Some(Value::Nil) | None => None,
Some(other) => {
return Err(validation_error(format!(
"target.current 需为有效路径字符串或 nil,实际类型是 {}",
other.type_name()
)));
}
};
Ok(TargetConfig::Versioned {
home,
version_file,
current,
})
}
Value::Nil => Err(validation_error(
"缺少必填字段 target(应为字符串路径或多版本配置表)",
)),
other => Err(validation_error(format!(
"{} 需为有效的路径且类型必须是字符串,实际类型是 {}",
"{} 需为有效的路径且类型必须是字符串或多版本配置表,实际类型是 {}",
ctx,
other.type_name()
))),
@@ -231,13 +294,13 @@ impl LuaValidator {
/// 解析并校验 `args`
pub fn parse_args(value: &Value) -> mlua::Result<Vec<OsString>> {
{
println!("跟踪args1{}", value.type_name());
debug!("args 配置已关闭 ");
#[cfg(not(feature = "args"))]
Ok(Vec::new())
}
#[cfg(feature = "args")]
{
println!("跟踪args1{}", value.type_name());
debug!("args 配置已开启");
let ctx = Self::Args;
match value {
Value::Table(tbl) => {
@@ -246,7 +309,7 @@ impl LuaValidator {
let capacity = tbl.raw_len().min(128);
let mut raw_parts = Vec::with_capacity(capacity);
Self::collect_value_into(&ctx, value, &mut raw_parts)?;
for part in &raw_parts {
@@ -319,7 +382,7 @@ impl LuaValidator {
n += 1;
let (raw_key, raw_val) = pair?;
println!("env {} {}", n, raw_val.type_name());
debug!("env {} {}", n, raw_val.type_name());
// 1. 解析并校验 Key,拿到安全的 String
let key = Self::parse_env_name(&raw_key)?;
@@ -395,7 +458,7 @@ impl LuaValidator {
// 阶段三:无环前提下的高效展开
let mut flattened_aliases: HashMap<String, Vec<OsString>> =
HashMap::with_capacity(raw_aliases.len());
let mut resolved_args = Vec::new();
for key in raw_aliases.keys() {
@@ -467,118 +530,13 @@ impl LuaValidator {
}
}
/// 专用于 JSON (tinyjson) 的类型校验与字段提取器
//当前JsonValidator还为完全可用,后期会对其lua配置特别需要处理动态函数生成的值如:get_env("PATH")
// 数据结构:{
// "target": "C:/tools/git.exe",
// "args": [
// "--no-pager",
// 2,
// true
// ],
// "env": {
// "PATH": ["C:/tools/git/bin", "C:/Windows"],
// "HOME": "C:/tools/home",
// "CONST": 3,
// "BOOL": true
// }
// }
pub struct JsonValidator;
impl JsonValidator {
/// 校验并解析 target (必填,非空字符串)
pub fn parse_target(val: &JsonValue) -> Result<PathBuf> {
let s: &String = val
.get()
.ok_or_else(|| anyhow!("字段 'target' 必须是字符串"))?;
if s.trim().is_empty() {
return Err(anyhow!("字段 'target' 不能为空字符串"));
}
Ok(PathBuf::from(s))
}
/// 校验并解析 args (选填,必须为字符串数组)
pub fn parse_args(val: &JsonValue) -> Result<Vec<OsString>> {
let args_vec: &Vec<JsonValue> =
val.get().ok_or_else(|| anyhow!("字段 'args' 必须是数组"))?;
args_vec
.iter()
.map(|item| {
let s: &String = item
.get()
.ok_or_else(|| anyhow!("'args' 数组内的元素必须全为字符串"))?;
Ok(OsString::from(s))
})
.collect()
}
/// 校验并解析 env (选填,必须为 KV 对象)
pub fn parse_env(val: &JsonValue) -> Result<HashMap<String, OsString>> {
let env_map: &HashMap<String, JsonValue> = val
.get()
.ok_or_else(|| anyhow!("字段 'env' 必须是 Object 键值对"))?;
let mut result = HashMap::new();
for (k, v) in env_map {
let mut segments = Vec::new();
Self::collect_env_segments(v, &mut segments)?;
if !segments.is_empty() {
// 根据操作系统自动拼接环境变量分隔符 (Windows 为 ';', Unix 为 ':')
#[cfg(windows)]
let sep = std::ffi::OsStr::new(";");
#[cfg(not(windows))]
let sep = std::ffi::OsStr::new(":");
let joined = segments.join(sep);
result.insert(k.clone(), joined);
}
}
Ok(result)
}
pub fn parse_aliases(val: &JsonValue) -> Result<HashMap<String, Vec<OsString>>> {
todo!()
}
// =========================================================================
// 私有辅助方法
// =========================================================================
/// 单个标量节点转换为 OsString (支持 String, Number, Boolean)
fn value_to_os_string(val: &JsonValue, ctx: &str) -> Result<OsString> {
if let Some(s) = val.get::<String>() {
Ok(OsString::from(s))
} else if let Some(n) = val.get::<f64>() {
Ok(OsString::from(n.to_string()))
} else if let Some(b) = val.get::<bool>() {
Ok(OsString::from(b.to_string()))
} else {
Err(anyhow!("{} 内只支持字符串、数字或布尔类型", ctx))
}
}
/// 递归打平 env 节点中的数组/标量值
fn collect_env_segments(val: &JsonValue, segments: &mut Vec<OsString>) -> Result<()> {
if let Some(arr) = val.get::<Vec<JsonValue>>() {
for item in arr {
Self::collect_env_segments(item, segments)?;
}
} else {
let parsed_segment = Self::value_to_os_string(val, "'env' 节点的 Value")?;
segments.push(parsed_segment);
}
Ok(())
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::MirrorSpec;
use crate::mirror::MirrorTarget;
use mlua::{FromLua, Lua};
fn parse(src: &str) -> mlua::Result<MirrorSpec> {
fn parse(src: &str) -> mlua::Result<MirrorTarget> {
let lua = Lua::new();
// 模拟 runtime 注入的 get_env:返回按平台分隔符拆分的段数组(空变量返回空表)
let get_env = lua
@@ -597,7 +555,7 @@ mod tests {
lua.globals().set("get_env", get_env).unwrap();
let value = lua.load(src).eval::<Value>()?;
let t = MirrorSpec::from_lua(value, &lua);
let t = MirrorTarget::from_lua(value, &lua);
println!("读取出的数据:{:?}", t.clone()?);
t
}
@@ -638,7 +596,10 @@ mod tests {
"#,
)
.unwrap();
assert_eq!(cfg.target, PathBuf::from("C:/tools/git.exe"));
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 段
+8
View File
@@ -0,0 +1,8 @@
# mirror-log.ini
level = debug
log_dir = "logs"
# 或者带节结构:
# [logger]
# level = info
# log_dir = /var/log/mirror
-25
View File
@@ -1,25 +0,0 @@
// 构造一个带上下文的 FromLua 转换错误,便于定位配置问题
/// 配置校验错误
pub fn validation_error(message: impl Into<String>) -> mlua::Error {
mlua::Error::RuntimeError(message.into())
}
/// 将底层 Lua 语法错误转换为用户友好的提示
pub fn syntax_error(err: mlua::Error) -> mlua::Error {
match &err {
mlua::Error::SyntaxError { message, .. } => {
if message.contains("invalid escape sequence") || message.contains("unfinished string")
{
return validation_error(format!(
"配置文件语法错误:检测到非法的字符串转义。\n\
提示:在 Windows 路径末尾或字符串中使用反斜杠 '\\' 时:\n\
1. 请使用双反斜杠转义,例如: \"D:\\\\CNWei\\\\CNW\\\\Rust\\\\\"\n\
2. 或使用 Lua 原始字符串 (Raw String),例如: [[D:\\CNWei\\CNW\\Rust\\]]\n\
底层错误: {}",
message
));
}
}
_ => {}
}
err
}
-23
View File
@@ -1,23 +0,0 @@
extern crate core;
pub mod error;
mod layout;
mod loader;
mod logger;
mod mirror;
mod runtime;
mod spec;
pub mod sys;
mod utils;
mod validators;
pub use layout::Layout;
pub use mirror::Mirror;
pub use runtime::LuaRuntime;
pub use spec::MirrorSpec;
// pub use sys::{
// ERROR_ELEVATION_REQUIRED, EXIT_FAILED_LOAD_SHIM, EXIT_FAILED_SPAWN_PROG, EXIT_FAILED_WAIT_PROG,
// EXIT_PROG_TERMINATED, execute_elevated, set_console_ctrl_handler,
// };
pub use utils::{lua_string_2_os_string, normalize_path_for_lua, parse_tokens};
-99
View File
@@ -1,99 +0,0 @@
use crate::spec::MirrorSpec;
use crate::{Layout, LuaRuntime};
use anyhow::{Context, Result, bail};
use mlua::Table;
use std::path::PathBuf;
use tracing::{debug, trace, warn};
pub enum Source {
Lua(LuaRuntime),
Json,
}
/// MirrorSpec 加载器,统一对外暴露多源解析接口
pub struct SpecLoader;
impl SpecLoader {
pub fn resolve_spec(source: &Source, layout: &Layout, target_name: &str) -> Result<MirrorSpec> {
match source {
Source::Lua(r) => Self::resolve_lua_spec(&r, layout, target_name),
Source::Json => Self::load_from_json(layout),
}
}
/// 从 Lua 脚本字符串加载 ShimSpec
fn resolve_lua_spec(
runtime: &LuaRuntime,
layout: &Layout,
target_name: &str,
) -> Result<MirrorSpec> {
// 策略 1: 尝试加载全局配置文件 mirror.lua
let global_config = layout.base_dir.join("mirror.lua");
if global_config.is_file() {
trace!(path = %global_config.display(), "发现全局配置文件,尝试解析");
let root_table: Table = runtime.eval_script(&global_config)?;
// 检查 mirror.lua 中是否存在以 target_name 命名的 Table 节点
if root_table
.contains_key(target_name)
.context("检查全局配置失败")?
{
let target_val: MirrorSpec = root_table
.get(target_name)
.with_context(|| format!("解析配置 [{}] 失败: ", target_name))?;
debug!(
target = %target_name,
source = %global_config.display(),
"成功从全局配置文件中匹配到目标工具"
);
return Ok(target_val);
}
// 穿透:若全局配置文件存在但未包含当前程序的 key,继续向下探查
trace!(target = %target_name, "全局配置文件中未包含该目标,继续探查独立配置");
}
let tools_dir: Option<PathBuf> = runtime.tools_dir()?;
// 策略 2: 降级寻找独立文件 ({exe}.lua),优先顺序:tools/ > root/
let target_filename = format!("{}.lua", target_name);
let effective_tools_dir = match tools_dir {
Some(t) => {
if t.is_absolute() {
t.join(&target_filename)
} else {
layout.base_dir.join(t).join(&target_filename)
}
}
None => layout.tools_dir.join(&target_filename),
};
let candidates = [
// layout.tools_dir.join(&target_filename),
effective_tools_dir,
layout.base_dir.join(&target_filename),
];
for config_path in &candidates {
if config_path.is_file() {
debug!(path = %config_path.display(), "找到独立配置文件,开始加载");
// 直接泛型反序列化为 MirrorSpec
return runtime.eval_script::<MirrorSpec>(config_path);
}
trace!(path = %config_path.display(), "独立配置文件不存在,跳过");
}
// 策略 3: 所有查找失败,抛出错误
warn!(target = %target_name, "未找到任何匹配的配置文件");
bail!(
"未找到关于 '{}' 的配置。请检查 mirror.lua 或特定的 {}.lua 文件",
target_name,
target_name
);
}
/// 从 Lua 脚本文件加载 ShimSpec
fn load_from_json(layout: &Layout) -> Result<MirrorSpec> {
todo!("实现json来源")
}
}
-39
View File
@@ -1,39 +0,0 @@
use std::path::Path;
use tracing_appender::non_blocking::WorkerGuard;
use tracing_subscriber::{EnvFilter, fmt};
/// 初始化日志系统,返回的 `_guard` 必须在 main 作用域内保持存活直到程序退出
pub fn init_file_logger(log_dir: impl AsRef<Path>) -> Option<WorkerGuard> {
// 允许通过环境变量动态控制日志级别,如 SHIM_LOG=debug,默认 debug 或 info
let filter = EnvFilter::try_from_env("SHIM_LOG").unwrap_or_else(|_| EnvFilter::new("debug"));
// 1. 创建按天滚动的日志追加器 (每天生成类似 shim.2026-08-14.log)
let file_appender = tracing_appender::rolling::daily(log_dir, "shim.log");
// 2. 包装为非阻塞后台写入(不会拖慢主程序的启动与执行速度)
let (non_blocking, guard) = tracing_appender::non_blocking(file_appender);
// 3. 构建 Subscriber,只输出到文件,不输出到控制台
tracing_subscriber::fmt()
.with_env_filter(filter)
.with_writer(non_blocking) // 写入文件
.with_ansi(false) // 关闭终端彩色转义字符
.with_target(false) // 隐藏模块前缀(可选)
.init();
Some(guard)
}
// 调用
// fn main() -> Result<(), Box<dyn std::error::Error>> {
// // 假设日志存放在安装根目录下的 logs 文件夹
// // 也可以先快速推导 layout 拿到 log_dir
// let log_dir = "path/to/root_dir/logs";
// let _guard = init_file_logger(log_dir);
//
// // 此处写你的 Shim 业务逻辑
// // 业务代码中所有的 debug!/info!/warn! 都会静默写入文件,控制台干干净净
// let config = Shim::load()?;
//
// Ok(())
// }
-65
View File
@@ -1,65 +0,0 @@
use mirror::Mirror;
use mirror::sys::*;
use std::ffi::OsString;
use std::{env, process::exit};
use tracing_subscriber::{EnvFilter, fmt};
fn main() {
//初始化日志:输出到 stderr,避免污染 shim 子进程的 stdout
fmt()
.with_writer(std::io::stderr)
.with_env_filter(
EnvFilter::try_from_env("SHIM_LOG").unwrap_or_else(|_| EnvFilter::new("warn")),
)
.init();
// 2. 注册 Windows 控制台信号
set_console_ctrl_handler();
// 3. 解析调用参数与代理 Mirror 配置
let calling_args: Vec<_> = env::args_os().skip(1).collect();
let mr = match Mirror::new() {
Ok(v) => v,
Err(e) => {
eprintln!("加载代理(mirror)配置时发生错误: {}", e);
exit(EXIT_FAILED_LOAD_SHIM);
}
};
let combined_args = mr.spec.args.iter().chain(calling_args.iter());
// 构建 Command:复用 ShimConfig::to_command(含 args/env 注入),避免重复逻辑
let mut cmd = mr.to_command(combined_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(
&mr.spec.target,
&elevated_args,
Some(&mr.spec.env),
))
}
Err(e) => {
eprintln!(
"启动目标程序 [{}] 时发生错误: {}",
mr.spec.target.to_string_lossy(),
e
);
exit(EXIT_FAILED_SPAWN_PROG);
}
};
// 5. 等待子进程退出
let status = match child.wait() {
Ok(v) => v,
Err(e) => {
eprintln!(
"等待目标程序 [{}] 执行完毕时发生错误: {}",
mr.spec.target.to_string_lossy(),
e
);
exit(EXIT_FAILED_WAIT_PROG);
}
};
exit(status.code().unwrap_or(EXIT_PROG_TERMINATED))
}
-105
View File
@@ -1,105 +0,0 @@
use crate::loader::Source;
use crate::loader::SpecLoader;
use crate::{Layout, LuaRuntime, MirrorSpec};
use anyhow::{Context, Result};
use std::collections::HashMap;
use std::env;
use std::ffi::OsString;
use std::process::Command;
use tracing::debug;
pub struct Mirror {
pub spec: MirrorSpec,
pub layout: Layout,
pub target_name: String,
}
impl Mirror {
pub fn new() -> Result<Self> {
let current_exe = env::current_exe().context("获取代理程序路径失败: {}")?;
debug!("当前目录 {}", current_exe.display());
let target_name = current_exe
.file_stem()
.and_then(|s| s.to_str())
.with_context(|| format!("无法从路径 [{}] 提取有效的程序名称", current_exe.display()))?
.to_lowercase();
debug!(
target_name = %target_name,
current_exe = %current_exe.display(),
"开始加载 Mirror 配置"
);
let layout = Layout::discover(&current_exe)?;
debug!(
root_dir = %layout.base_dir.display(),
bin_dir = %layout.bin_dir.display(),
tools_dir = %layout.tools_dir.display(),
"Mirror 目录布局解析完成"
);
let runtime = LuaRuntime::new(&layout)?;
let spec = SpecLoader::resolve_spec(&Source::Lua(runtime), &layout, &target_name)?;
Ok(Self {
spec,
layout,
target_name,
})
}
/// 1. 核心参数路由解析(Delegation 到 Spec 的路由逻辑)
fn resolve_args<I, S>(&self, args: I, aliases: &HashMap<String, Vec<OsString>>) -> 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
}
pub fn to_command<I, S>(&self, combined_args: I) -> Command
where
I: IntoIterator<Item = S>,
S: AsRef<std::ffi::OsStr>,
{
let mut cmd = Command::new(&self.spec.target);
// 2. 传入预打平的别名字典,查表并展开所有以 `mr:` 为前缀的别名
let final_args = self.resolve_args(combined_args, &self.spec.aliases);
println!("拼接后的命令行参数{:?}",final_args);
// 3. 将解析展开后的无环参数一次性注入 Command
cmd.args(&final_args);
// 4. 注入配置好的环境变量
for (key, val) in &self.spec.env {
// 直接应用环境变量(Lua 端已经处理好字符串拼接或列表合并)
cmd.env(key, val);
}
cmd
}
}
-327
View File
@@ -1,327 +0,0 @@
use crate::Layout;
use crate::error::syntax_error;
use crate::utils::normalize_path_for_lua;
use anyhow::{Context, Result};
use mlua::{FromLua, Lua, StdLib, Table, Value};
use std::path::{Path, PathBuf};
use std::{env, fs};
const MIRROR_DIR: &str = "__MIRROR_DIR__";
const MIRROR_TOOLS_DIR: &str = "__MIRROR_TOOLS_DIR__";
// const MIRROR_LOG_LEVEL: &str = "__MIRROR_LOG_LEVEL__";
const MIRROR_LOG_DIR: &str = "__MIRROR_LOG_DIR__";
pub struct LuaRuntime {
lua: Lua,
}
impl LuaRuntime {
/// 初始化限定权限的 Lua 沙箱环境
pub fn new(layout: &Layout) -> Result<Self> {
// 只加载安全的标准库,剥离 os / io 等风险模块
let lua = Lua::new_with(
StdLib::TABLE | StdLib::STRING | StdLib::MATH | StdLib::PACKAGE,
mlua::LuaOptions::default(),
)
.context("初始化 Lua 失败")?;
// 统一使用 POSIX 风格路径规范化路径字符串
let base_dir = normalize_path_for_lua(&layout.base_dir);
let tools_dir = normalize_path_for_lua(&layout.tools_dir);
// 1. 注入锚点变量 __MIRROR_DIR__(shim 安装根目录)
Self::register_mirror_dir(&lua, &base_dir)?;
// 2. 安全暴露 get_env 供配置读取环境变量
// 返回按平台路径分隔符拆分后的段数组(自动剥离引号包裹),
// 便于 PATH 等列表变量直接嵌入数组:PATH = { prefix, get_env("PATH") }
Self::register_get_env(&lua)?;
// 3. 初始化并配置安全/容错的 require 机制
Self::setup_require(&lua, &base_dir, &tools_dir)?;
Ok(Self { 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).with_context(|| format!("无法读取配置文件: {}", path.display()))?;
let code = String::from_utf8(bytes).with_context(|| {
format!(
"{} 不是有效的 UTF-8 文件(请将 Lua 配置文件保存为 UTF-8 编码)",
path.display()
)
})?;
tracing::trace!("code {:?}", code);
// 使用 @<path> 格式标记 Chunk 名称,确保 Lua 报错时能精确回溯到对应的源文件名与行号。
let chunk_name = format!("@{}", path.display());
self.lua
.load(&code)
.set_name(&chunk_name)
.eval::<T>()
.map_err(syntax_error)
.with_context(|| format!("执行 Lua 配置文件失败: {}", path.display()))
}
pub fn tools_dir(&self) -> Result<Option<PathBuf>> {
self.lua
.globals()
.get(MIRROR_TOOLS_DIR)
.context(format!("设置 {MIRROR_TOOLS_DIR} 失败"))
}
}
impl LuaRuntime {
/// 注入全局锚点变量
fn register_mirror_dir(lua: &Lua, base_dir: &str) -> Result<()> {
lua.globals()
.set(MIRROR_DIR, base_dir)
.context(format!("设置 {MIRROR_DIR} 环境变量失败"))?;
Ok(())
}
///注入 get_env 供配置读取环境变量
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(())
}
/// 通用的路径注册闭包生成器
fn register_dir_reset_fn(
lua: &Lua,
global_fn_name: &str,
target_global_key: &'static str,
) -> Result<()> {
let get_env = lua.create_function(move |lua, rel_path: String| {
let clean_path = rel_path.trim().trim_start_matches('/');
lua.globals().set(target_global_key, clean_path)?;
Ok(())
})?;
// 4. 将函数绑定至 Lua 全局作用域,供 Lua 调用
lua.globals().set(global_fn_name, get_env)?;
Ok(())
}
fn register_reset_tools_dir(lua: &Lua) -> Result<()> {
Self::register_dir_reset_fn(lua, "reset_tools_dir", MIRROR_TOOLS_DIR)
}
fn register_reset_log_dir(lua: &Lua) -> Result<()> {
Self::register_dir_reset_fn(lua, "reset_log_dir", MIRROR_LOG_DIR)
}
/// 配置 package.path 并包装 require,拦截加载失败以提高容错性
fn setup_require(lua: &Lua, base_dir: &str, tools_dir: &str) -> Result<()> {
let globals = lua.globals();
// 1. 安全加固并拓展 package 搜索路径
if let Ok(package) = globals.get::<Table>("package") {
let _ = package.set("cpath", "");
let _ = package.set("loadlib", Value::Nil);
if let Ok(path) = package.get::<String>("path") {
let new_path = format!(
"{};{}/?.lua;{}/?/init.lua;{}/?.lua;{}/?/init.lua",
path, base_dir, base_dir, tools_dir, tools_dir
);
let _ = 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) => {
tracing::warn!(
module = %module,
error = %e,
"配置模块加载失败,已跳过该条目(可在独立配置文件中定义)"
);
Ok(Value::Nil)
}
}
})
.context("创建包装版 require 函数失败")?;
// 3. 覆盖全局 require
globals
.set("require", wrapped_require)
.context("重载 require 函数失败")?;
Ok(())
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::{Layout, MirrorSpec};
fn test_layout() -> Layout {
let root = std::env::temp_dir().join("rshim-test-layout");
Layout {
base_dir: root.clone(),
bin_dir: root.join("bin"),
tools_dir: root.join("tools"),
lua_file: Default::default(),
}
}
#[test]
fn missing_module_require_returns_nil() {
let runtime = LuaRuntime::new(&test_layout()).unwrap();
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 = LuaRuntime::new(&test_layout()).unwrap();
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 = LuaRuntime::new(&test_layout()).unwrap();
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 = LuaRuntime::new(&test_layout()).unwrap();
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()),
}
}
#[test]
fn path_with_get_env_joins_without_quote_error() {
// 复现用户场景:PATH = { base_dir .. "/tools/numa", get_env("PATH") }
// 宿主 PATH 即使含双引号,也应拆分后正常拼接,而不是报错
let runtime = LuaRuntime::new(&test_layout()).unwrap();
let cfg: MirrorSpec = runtime
.lua
.load(
r#"
return {
target = __SHIM_DIR__ .. "/tools/numa/numa.exe",
args = { "--help" },
env = {
PATH = { __SHIM_DIR__ .. "/tools/numa", get_env("PATH") }
}
}
"#,
)
.eval()
.unwrap();
let path = cfg.env.get("PATH").unwrap().to_str().unwrap();
let prefix = std::env::temp_dir()
.join("rshim-test-layout")
.to_string_lossy()
.replace('\\', "/")
+ "/tools/numa;";
assert!(path.starts_with(&prefix), "unexpected PATH: {path}");
// 宿主 PATH 的段应被附加在配置前缀之后
let host = std::env::var("PATH").unwrap_or_default();
if !host.is_empty() {
let host_first = std::env::split_paths(&host)
.next()
.unwrap()
.to_string_lossy()
.into_owned();
assert!(
path.contains(&host_first),
"missing host PATH segment: {host_first}"
);
}
// 宿主 PATH 里引号包裹的畸形段(如 "D:\\...\\bin;")应被原样保留,
// 而不是让整个配置加载失败
if host.contains('"') {
assert!(
path.contains('"'),
"quoted host segments should be preserved"
);
}
}
}
-109
View File
@@ -1,109 +0,0 @@
use crate::error::validation_error;
use crate::validators::{JsonValidator, LuaValidator};
use anyhow::{Result, anyhow};
use mlua::{FromLua, Lua, Value};
use std::collections::HashMap;
use std::ffi::OsString;
use std::path::PathBuf;
use std::str::FromStr;
use tinyjson::JsonValue;
#[derive(Debug, Clone, Default)]
pub struct MirrorSpec {
pub target: PathBuf,
pub args: Vec<OsString>,
pub aliases: HashMap<String, Vec<OsString>>,
pub env: HashMap<String, OsString>,
}
/// 实现 FromLua Trait,由 mlua 自动处理 Table 转换
impl FromLua for MirrorSpec {
fn from_lua(value: Value, _lua: &Lua) -> mlua::Result<Self> {
// 脚本返回必须是一个 Table 变体
let table = match value {
Value::Table(t) => t,
_ => {
return Err(validation_error(format!(
"期望得到一个 Lua Table 配置对象,实际是 {}",
value.type_name()
)));
}
};
// 必填字段: target(严格限定为字符串,避免数字被 mlua 宽松转为字符串后掩盖错误)
let target = match table.get::<Option<Value>>("target")? {
None | Some(Value::Nil) => {
return Err(validation_error("缺少必填字段 target(应为字符串路径)"));
}
Some(target_val) => LuaValidator::parse_target(&target_val)?,
};
// 可选字段: args(缺失或 nil 时默认空列表;保留空字符串参数,与提权路径的 "" 语义一致)
let args = match table.get::<Option<Value>>("args")? {
None | Some(Value::Nil) => Vec::new(),
Some(args_val) => LuaValidator::parse_args(&args_val)?,
};
// 可选字段: env(只允许缺失/nil,其他类型由 Option<Table> 转换报错,不再静默忽略)
let env = match table.get::<Option<Value>>("env")? {
None | Some(Value::Nil) => HashMap::new(),
Some(env_val) => LuaValidator::parse_env(&env_val)?,
};
// 可选字段: aliases(只允许缺失/nil,其他类型由 Option<Table> 转换报错,不再静默忽略)
let aliases = match table.get::<Option<Value>>("aliases")? {
None | Some(Value::Nil) => HashMap::new(),
Some(env_val) => LuaValidator::parse_aliases(&env_val)?,
};
// println!("环境变量结果:{:?}", env);
Ok(MirrorSpec {
target,
args,
aliases,
env,
})
}
}
impl TryFrom<&str> for MirrorSpec {
type Error = anyhow::Error;
fn try_from(json_str: &str) -> Result<Self> {
// 1. 解析 JSON 字符串为 JsonValue 树
let root = JsonValue::from_str(json_str).map_err(|e| anyhow!("JSON 语法错误: {}", e))?;
// 根节点必须是一个 JSON Object
let map: &HashMap<String, JsonValue> = root
.get()
.ok_or_else(|| anyhow!("JSON 根节点必须是 Object 对象"))?;
// 1. target (必填)
let target_val = map
.get("target")
.ok_or_else(|| anyhow!("缺少必填字段: target"))?;
let target = JsonValidator::parse_target(target_val)?;
// 2. args (选填)
let args = match map.get("args") {
Some(args_val) => JsonValidator::parse_args(args_val)?,
None => Vec::new(),
};
// 3. env (选填)
let env = match map.get("env") {
Some(env_val) => JsonValidator::parse_env(env_val)?,
None => HashMap::new(),
};
let aliases = match map.get("aliases") {
Some(env_val) => JsonValidator::parse_aliases(env_val)?,
None => HashMap::new(),
};
Ok(MirrorSpec {
target,
args,
aliases,
env,
})
}
}
+1527
View File
File diff suppressed because it is too large Load Diff