mirror of
https://github.com/shadowsocks/ShadowsocksX-NG.git
synced 2026-11-22 05:25:41 +00:00
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 文件时两个用例均 失败并点名违规文件,清理后复验为绿。
175 lines
6.5 KiB
Swift
175 lines
6.5 KiB
Swift
import Foundation
|
||
|
||
/// #33 偏好存储。非敏感字段写入受保护的 JSON。GFWList URL 与 PAC 用户规则
|
||
/// 已随 issue #67 移除;未发布的 NG2 PAC 偏好不做迁移。
|
||
struct ProxySettingsFileStore: ProxySettingsStoring {
|
||
let fileURL: URL
|
||
let legacyListenFileURL: URL
|
||
|
||
init(
|
||
fileURL: URL = ProxySettingsFileStore.defaultFileURL(),
|
||
legacyListenFileURL: URL = ListenSettingsFileStore.defaultFileURL()
|
||
) {
|
||
self.fileURL = fileURL
|
||
self.legacyListenFileURL = legacyListenFileURL
|
||
}
|
||
|
||
static func defaultFileURL() -> URL {
|
||
RuntimePaths.settingsFileURL()
|
||
}
|
||
|
||
func load() throws -> ProxySettings {
|
||
guard FileManager.default.fileExists(atPath: fileURL.path) else {
|
||
do {
|
||
let listen = try ListenSettingsFileStore(fileURL: legacyListenFileURL).load()
|
||
return try validated(ProxySettings(listen: listen))
|
||
} catch let error as ListenSettingsStoreError {
|
||
throw ProxySettingsStoreError.legacyListenSettings(error)
|
||
} catch let error as ProxySettingsStoreError {
|
||
throw error
|
||
} catch {
|
||
throw ProxySettingsStoreError.ioFailure(detail: String(describing: error))
|
||
}
|
||
}
|
||
|
||
let data: Data
|
||
do {
|
||
data = try Data(contentsOf: fileURL)
|
||
} catch {
|
||
throw ProxySettingsStoreError.ioFailure(detail: String(describing: error))
|
||
}
|
||
let record: ProxySettingsRecord
|
||
do {
|
||
record = try JSONDecoder().decode(ProxySettingsRecord.self, from: data)
|
||
} catch {
|
||
throw ProxySettingsStoreError.corrupt(detail: String(describing: error))
|
||
}
|
||
return try settings(from: record)
|
||
}
|
||
|
||
func save(_ settings: ProxySettings) throws {
|
||
_ = try validated(settings)
|
||
do {
|
||
let data = try Self.jsonEncoder.encode(record(from: settings))
|
||
try AtomicFileWriter.write(data, to: fileURL)
|
||
} catch let error as ProxySettingsStoreError {
|
||
throw error
|
||
} catch let error as AtomicFileWriter.WriteError {
|
||
throw ProxySettingsStoreError.ioFailure(detail: String(describing: error))
|
||
} catch {
|
||
throw ProxySettingsStoreError.ioFailure(detail: String(describing: error))
|
||
}
|
||
}
|
||
|
||
static func restored(store: ProxySettingsFileStore = ProxySettingsFileStore())
|
||
-> RestoredProxySettings
|
||
{
|
||
do {
|
||
return RestoredProxySettings(settings: try store.load(), unreadableError: nil)
|
||
} catch let error as ProxySettingsStoreError {
|
||
RuntimeLog.emit(.listenSettingsUnreadable(detail: String(describing: error)))
|
||
return RestoredProxySettings(settings: ProxySettings(), unreadableError: error)
|
||
} catch {
|
||
let wrapped = ProxySettingsStoreError.ioFailure(detail: String(describing: error))
|
||
RuntimeLog.emit(.listenSettingsUnreadable(detail: String(describing: error)))
|
||
return RestoredProxySettings(settings: ProxySettings(), unreadableError: wrapped)
|
||
}
|
||
}
|
||
|
||
private func validated(_ settings: ProxySettings) throws -> ProxySettings {
|
||
let errors = settings.validationErrors
|
||
guard errors.isEmpty else { throw ProxySettingsStoreError.invalid(errors) }
|
||
return settings
|
||
}
|
||
|
||
private func settings(from record: ProxySettingsRecord) throws -> ProxySettings {
|
||
var listen = SslocalListenSettings()
|
||
listen.listenerMode = record.listenerMode
|
||
listen.socksPort = record.socksPort
|
||
listen.httpPort = record.httpPort
|
||
|
||
return try validated(
|
||
ProxySettings(
|
||
listen: listen,
|
||
proxyExceptions: record.proxyExceptions,
|
||
preferredMode: record.preferredMode,
|
||
ruleDefaultAction: record.ruleDefaultAction,
|
||
agentEnabled: record.agentEnabled,
|
||
systemProxyEnabled: record.systemProxyEnabled))
|
||
}
|
||
|
||
private func record(from settings: ProxySettings) -> ProxySettingsRecord {
|
||
var record = ProxySettingsRecord()
|
||
record.listenerMode = settings.listen.listenerMode
|
||
record.socksPort = settings.listen.socksPort
|
||
record.httpPort = settings.listen.httpPort
|
||
record.proxyExceptions = settings.proxyExceptions
|
||
record.preferredMode = settings.preferredMode
|
||
record.ruleDefaultAction = settings.ruleDefaultAction
|
||
record.agentEnabled = settings.agentEnabled
|
||
record.systemProxyEnabled = settings.systemProxyEnabled
|
||
return record
|
||
}
|
||
|
||
private static let jsonEncoder: JSONEncoder = {
|
||
let encoder = JSONEncoder()
|
||
encoder.outputFormatting = [.prettyPrinted, .sortedKeys]
|
||
return encoder
|
||
}()
|
||
}
|
||
|
||
private struct ProxySettingsRecord: Codable, Equatable, Sendable {
|
||
var listenerMode: ListenerMode = .localhost
|
||
var socksPort: Int = SslocalListenSettings.defaultSocksPort
|
||
var httpPort: Int = SslocalListenSettings.defaultHTTPPort
|
||
var proxyExceptions: String = ProxySettings.defaultProxyExceptions
|
||
var preferredMode: ProxyModeKind = .rule
|
||
var ruleDefaultAction: RuleDefaultAction = .proxyWhenUnmatched
|
||
var agentEnabled: Bool = false
|
||
var systemProxyEnabled: Bool = false
|
||
|
||
init() {}
|
||
|
||
init(from decoder: Decoder) throws {
|
||
let container = try decoder.container(keyedBy: CodingKeys.self)
|
||
listenerMode =
|
||
try container.decodeIfPresent(ListenerMode.self, forKey: .listenerMode) ?? .localhost
|
||
socksPort =
|
||
try container.decodeIfPresent(Int.self, forKey: .socksPort)
|
||
?? SslocalListenSettings.defaultSocksPort
|
||
httpPort =
|
||
try container.decodeIfPresent(Int.self, forKey: .httpPort)
|
||
?? SslocalListenSettings.defaultHTTPPort
|
||
proxyExceptions =
|
||
try container.decodeIfPresent(String.self, forKey: .proxyExceptions)
|
||
?? ProxySettings.defaultProxyExceptions
|
||
// 旧 NG2 偏好里的 "pac" 等已删除值容错回落到规则模式(issue #67:
|
||
// 未发布的 PAC 偏好不做迁移,但解码失败会把全部保留字段连坐丢掉)。
|
||
if let rawMode = try container.decodeIfPresent(String.self, forKey: .preferredMode),
|
||
let mode = ProxyModeKind(rawValue: rawMode)
|
||
{
|
||
preferredMode = mode
|
||
} else {
|
||
preferredMode = .rule
|
||
}
|
||
// 规则模式子选项(issue #63):出厂「未匹配时代理」。
|
||
ruleDefaultAction =
|
||
try container.decodeIfPresent(RuleDefaultAction.self, forKey: .ruleDefaultAction)
|
||
?? .proxyWhenUnmatched
|
||
// 未发版无迁移:缺省 agent off、系统代理 off(ADR-0011)。
|
||
agentEnabled = try container.decodeIfPresent(Bool.self, forKey: .agentEnabled) ?? false
|
||
systemProxyEnabled =
|
||
try container.decodeIfPresent(Bool.self, forKey: .systemProxyEnabled) ?? false
|
||
}
|
||
}
|
||
|
||
extension ProxySettingsRecord {
|
||
fileprivate enum CodingKeys: String, CodingKey {
|
||
case listenerMode, socksPort, httpPort
|
||
case proxyExceptions
|
||
case preferredMode
|
||
case ruleDefaultAction
|
||
case agentEnabled, systemProxyEnabled
|
||
}
|
||
}
|