Files
ShadowsocksX-NG/ShadowsocksX-NG2/Domain/Runtime/RuntimePaths.swift
T
Qiu Yuzhou 856d6b4272 refactor(domain): 按主题重组 Domain/ 源码目录
Domain/ 根目录原有 62 个平铺源文件,无法从目录读出主题划分。

按「目录即主题」重组为 11 个目录(Rules/Custom 为嵌套子目录):Catalog /
Subscription / Rules / Runtime / Activation / Settings / SystemProxy /
Plugin / Credentials / LegacyImport / Diagnostics。纯移动:类型名、模块名
与 import 均未改动,Domain/ 根下不再有散落文件。目录口径取自
GLOSSARY.md 的章节划分(配置与订阅、代理规则、代理控制与网络、设置、
凭据与诊断),而非新造分类。

配套改动:

- project.yml:wrapper 与 helper 两个 target 按文件引用的 15 条显式路径
  随目录改名,并补注释固定这一约定——这 15 条指向不存在的文件时,
  xcodegen generate 以 "missing source directory" 直接失败(实测,不静默)。
- SkeletonTests 新增 DomainLayoutTests:断言 Domain/ 根下无平铺 .swift、
  树下只有 .swift。后者防的是与 App/ 同源的坑——Domain/ 整目录是 app 与
  Core 的 source path,任何非源码文件都会被 XcodeGen 收进 Resources 阶段
  并封进签名后的 bundle。
- README 工程结构说明同步;docs/design 与 docs/research 属历史文档不改。

验证:xcodegen generate 后 app 164 / Core 163 源文件数与整理前一致;Agent
恰好 9 个、Helper 恰好 6 个 Domain 文件(无缺失无多出);app 与 Core 各覆盖
全部 62 个。clean build 0 error;task test 1024 用例全通过(整理前 1022,
+2 为新增守卫);task format 未改写任何被移动文件(证明纯移动);task lint
与整理前同为 21 条内容型 warning;packaging-gate.sh ALL CHECKS PASSED。

布局守卫已做变异验证:临时投放松散 .swift 与非 .swift 文件时两个用例均
失败并点名违规文件,清理后复验为绿。
2026-10-05 20:13:35 +08:00

103 lines
4.4 KiB
Swift
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
import Foundation
/// App Support 目录全部文件的路径清单:GUI 配置与跨进程运行时契约共用同一
/// 目录。运行时契约子集(spec #21 D5,issue #27)是 GUI 写、wrapper 读的固定
/// 位置;GUI 配置文件 wrapper 不经手。目录 0700、文件 0600,由写入方与
/// wrapper 共同维护。
enum RuntimePaths {
static func runtimeDirectory() -> URL {
FileManager.default.urls(for: .applicationSupportDirectory, in: .userDomainMask)[0]
.appendingPathComponent("ShadowsocksX-NG2", isDirectory: true)
}
/// sslocal 配置契约:激活派生的完整 JSON,GUI 原子写入、wrapper 以绝对路径
/// 交给 `sslocal -c`(也是 SIGUSR1 热重载时上游重读的文件)。
static func runtimeFileURL() -> URL {
runtimeDirectory().appendingPathComponent("sslocal-active.json")
}
/// ACL 稳定链接(ADR-0011):sslocal 经契约 `acl` 键读取;指向某个
/// `acl-<summary>.ini` 变体,换模式只改链接指向。
static func aclFileURL() -> URL {
runtimeDirectory().appendingPathComponent("acl-active.ini")
}
/// wrapper 进程 pid 文件:SMAppService.Status 不暴露运行中 agent 的 pid,
/// wrapper 自写此文件供 GUI 判活(kill(pid, 0))并投递 SIGUSR1。
static func agentPIDFileURL() -> URL {
runtimeDirectory().appendingPathComponent("agent.pid")
}
/// The wrapper's sslocal deployment receipt. ACL-backed receipts are written
/// after the child owns the configured TCP listeners; the GUI checks its
/// digest and PID during direct-mode health checks.
static func agentRuntimeStatusURL() -> URL {
runtimeDirectory().appendingPathComponent("agent-runtime-status.json")
}
/// wrapper 与 sslocal 的收敛日志(stderr 重定向目标);滚动与诊断导出由 #33
/// 完善。不属于「运行时文件」,显式停止时不删除。
static func agentLogURL() -> URL {
runtimeDirectory().appendingPathComponent("agent.log")
}
// 旧版端点签名/所有权文件(system-proxy-endpoint-signature.json、
// system-proxy-ownership.json)按 issue #71 就地遗留:不读取、不迁移、
// 不删除。
// MARK: - GUI 配置文件(GUI 私有读写,wrapper 不经手)
/// 服务器目录(CatalogFileStore)。
static func catalogFileURL() -> URL {
runtimeDirectory().appendingPathComponent("catalog.json")
}
/// 代理偏好(ProxySettingsFileStore,#33)。
static func settingsFileURL() -> URL {
runtimeDirectory().appendingPathComponent("settings.json")
}
/// 监听设置(ListenSettingsFileStore;settings.json 未建立时的 legacy 回退
/// 读取源)。
static func listenSettingsFileURL() -> URL {
runtimeDirectory().appendingPathComponent("listen-settings.json")
}
/// 自定义规则文档(CustomRuleStore,issue #66)。
static func customRulesFileURL() -> URL {
runtimeDirectory().appendingPathComponent("custom-rules.json")
}
/// 活动目标(ActivationStateFileStore,spec #21 D3/D5)。
static func activationStateFileURL() -> URL {
runtimeDirectory().appendingPathComponent("activation.json")
}
/// 静默启动偏好的 ADR 0017 初版文件形态,仅遗留迁移路径使用
/// (SilentLaunchStore.migrateLegacyFileIfPresent)。
static func silentLaunchLegacyFileURL() -> URL {
runtimeDirectory().appendingPathComponent("silent-launch.json")
}
}
/// ACL 活动链接的防逃逸校验(ADR-0011):解析 symlink 后必须仍是运行目录
/// 内的普通文件。目录与目标都做 symlink 解析,避免 `/var` vs `/private/var`
/// 造成假阴性。GUI 写入侧与 Agent 加载侧共用此判定。
enum ACLActiveLinkPolicy {
static func resolvesToRegularFile(inside directory: URL, linkURL: URL) -> Bool {
let fileManager = FileManager.default
let linkPath = linkURL.standardizedFileURL.path
guard fileManager.fileExists(atPath: linkPath) else { return false }
let resolved = URL(fileURLWithPath: linkPath).resolvingSymlinksInPath().standardizedFileURL
let resolvedDirectory = URL(fileURLWithPath: directory.path).resolvingSymlinksInPath()
.standardizedFileURL.path
guard resolved.path == resolvedDirectory || resolved.path.hasPrefix(resolvedDirectory + "/")
else { return false }
var isDirectory: ObjCBool = false
guard fileManager.fileExists(atPath: resolved.path, isDirectory: &isDirectory) else {
return false
}
return !isDirectory.boolValue
}
}