mirror of
https://github.com/shadowsocks/ShadowsocksX-NG.git
synced 2026-11-14 10:13:54 +00:00
Qiu Yuzhou
ea801d5f38
Migrate legacy enabled fields to v3 without preserving their semantics. Keep recoverable invalid imports visible and filter them during activation.
473 lines
18 KiB
Swift
473 lines
18 KiB
Swift
import Foundation
|
||
import SwiftUI
|
||
|
||
/// 主窗口视图模型（issue #32/#35）：把 ConfigurationCatalog 领域语义接到树
|
||
/// 操作、详情表单、添加三入口、分享与订阅生命周期。所有变更走「副本变更 →
|
||
/// 落盘 → 发布 → postCommit 重展开」，失败即整体不变更；凭据读写只在模型层
|
||
/// 出现。
|
||
@MainActor
|
||
final class CatalogViewModel: ObservableObject {
|
||
@Published private(set) var catalog: ConfigurationCatalog
|
||
@Published private(set) var subscriptions: [SubscriptionRecord] = []
|
||
/// 正在刷新的订阅（并发守卫：同一订阅不重入，issue #35）。
|
||
@Published private(set) var inFlightRefreshIDs: Set<NodeID> = []
|
||
@Published var selectedNodeID: NodeID?
|
||
/// 需要弹窗呈现的错误（领域拒绝、导入失败、凭据失败）。
|
||
@Published var presentedError: String?
|
||
/// Legacy 快照发现与一次性完成标记（issue #36）。跳过不写标记，显式
|
||
/// 再导入仍会创建新的独立手动分组。
|
||
@Published private(set) var legacyImportAvailable = false
|
||
@Published private(set) var legacyImportCompleted = false
|
||
@Published private(set) var legacyImportReport: LegacyImportReport?
|
||
private var discoveredLegacySnapshot: LegacySnapshot?
|
||
|
||
private let fileStore: CatalogFileStore
|
||
/// 订阅扩展（CatalogViewModel+Subscriptions）同样经此读写凭据。
|
||
let credentials: CredentialStoring
|
||
private let plugins: ManagedPluginProviding
|
||
/// 订阅获取缝（默认 URLSession 实现；测试注入夹具，issue #35）。
|
||
var subscriptionFetcher: SubscriptionFetching
|
||
/// 目录提交后的运行时重展开（生产接线 `ProxyRuntimeController.catalogDidCommit`）。
|
||
var postCommit: (() async -> Void)?
|
||
/// Legacy 导入提交后的运行时边界（生产接线为不写系统代理的停止/重载）。
|
||
var postLegacyImport: ((LegacyImportOutcome) async -> Void)?
|
||
private let legacyImportService: LegacyImportService
|
||
|
||
init(
|
||
fileStore: CatalogFileStore = CatalogFileStore(fileURL: CatalogFileStore.defaultFileURL()),
|
||
credentials: CredentialStoring = KeychainCredentialStore(),
|
||
plugins: ManagedPluginProviding = BundleManagedPluginProvider(),
|
||
subscriptionFetcher: SubscriptionFetching = HTTPSSubscriptionFetcher(),
|
||
legacyImportService: LegacyImportService? = nil
|
||
) {
|
||
self.fileStore = fileStore
|
||
self.credentials = credentials
|
||
self.plugins = plugins
|
||
self.subscriptionFetcher = subscriptionFetcher
|
||
self.legacyImportService =
|
||
legacyImportService
|
||
?? LegacyImportService(
|
||
catalogStore: fileStore,
|
||
settingsStore: ProxySettingsFileStore(credentials: credentials),
|
||
activationStore: ActivationStateFileStore(
|
||
fileURL: ActivationStateFileStore.defaultFileURL()),
|
||
credentials: credentials)
|
||
let loaded = (try? fileStore.load()) ?? CatalogDocument()
|
||
catalog = loaded.catalog
|
||
subscriptions = loaded.subscriptions
|
||
refreshLegacyImportState()
|
||
}
|
||
|
||
var shouldOfferLegacyImport: Bool {
|
||
legacyImportAvailable && !legacyImportCompleted
|
||
}
|
||
|
||
/// Reads discovery state without writing any marker or Legacy data.
|
||
func refreshLegacyImportState() {
|
||
legacyImportCompleted = (try? legacyImportService.isCompleted()) ?? false
|
||
discoveredLegacySnapshot = try? legacyImportService.readSnapshot()
|
||
legacyImportAvailable = discoveredLegacySnapshot != nil
|
||
}
|
||
|
||
/// Imports the current immutable Legacy snapshot. The view model reloads its
|
||
/// published catalog only after the service has committed every store.
|
||
func importLegacy(reimport: Bool = false) async throws -> LegacyImportOutcome {
|
||
let snapshot: LegacySnapshot
|
||
if reimport {
|
||
guard let current = try legacyImportService.readSnapshot() else {
|
||
throw LegacyImportError.noSnapshot
|
||
}
|
||
snapshot = current
|
||
} else if let discoveredLegacySnapshot {
|
||
snapshot = discoveredLegacySnapshot
|
||
} else {
|
||
guard let current = try legacyImportService.readSnapshot() else {
|
||
throw LegacyImportError.noSnapshot
|
||
}
|
||
snapshot = current
|
||
}
|
||
let outcome = try legacyImportService.importSnapshot(snapshot, reimport: reimport)
|
||
let loaded = try fileStore.load()
|
||
catalog = loaded.catalog
|
||
subscriptions = loaded.subscriptions
|
||
legacyImportReport = outcome.report
|
||
refreshLegacyImportState()
|
||
await postLegacyImport?(outcome)
|
||
return outcome
|
||
}
|
||
|
||
// MARK: - 查询面
|
||
|
||
/// 订阅刷新并发守卫的写入口（扩展文件使用；保持集合只对外可读）。
|
||
func setSubscriptionRefreshInFlight(_ id: NodeID, _ inFlight: Bool) {
|
||
if inFlight {
|
||
inFlightRefreshIDs.insert(id)
|
||
} else {
|
||
inFlightRefreshIDs.remove(id)
|
||
}
|
||
}
|
||
|
||
func entry(for id: NodeID) -> CatalogEntry? { catalog.entry(for: id) }
|
||
|
||
func parentID(of id: NodeID) -> NodeID? { (try? catalog.parentID(of: id)) ?? nil }
|
||
|
||
/// 行显示名：委托目录条目的共用口径（`CatalogEntry.displayName`）。
|
||
func displayName(for id: NodeID) -> String {
|
||
catalog.entry(for: id)?.displayName ?? ""
|
||
}
|
||
|
||
// MARK: - 变更面（CatalogError / ServerFormError / CredentialStoreError 上抛）
|
||
|
||
/// ss:// 批量导入（剪贴板、导入 URL、二维码识别三入口的共同落点）。
|
||
/// 逐行解码，可解析行全部添加（每次新建身份，不按内容去重）；返回成功条数
|
||
/// 与失败行的点名原因。
|
||
func addServers(fromURIs text: String, into parent: NodeID?) async throws -> (
|
||
added: Int, failures: [String]
|
||
) {
|
||
var prepared: [(uri: SsUri, fields: ServerFields)] = []
|
||
var failures: [String] = []
|
||
for line in text.split(whereSeparator: \.isNewline) {
|
||
do {
|
||
let uri = try SsUri.decode(String(line))
|
||
let fields = try Self.serverFields(from: uri, credentials: credentials)
|
||
prepared.append((uri: uri, fields: fields))
|
||
} catch {
|
||
let digest = line.count > 24 ? "\(line.prefix(24))…" : line
|
||
let reason =
|
||
(error as? SsUriError).map { String(describing: $0) } ?? error.presentableMessage
|
||
failures.append("「\(digest)」：\(reason)")
|
||
}
|
||
}
|
||
guard !prepared.isEmpty else { return (0, failures) }
|
||
do {
|
||
try await commit { catalog in
|
||
for item in prepared {
|
||
try catalog.addServer(item.fields, to: parent)
|
||
}
|
||
}
|
||
} catch {
|
||
for item in prepared {
|
||
Self.deleteCredentialRefs(for: item.fields, credentials: credentials)
|
||
}
|
||
throw error
|
||
}
|
||
return (prepared.count, failures)
|
||
}
|
||
|
||
@discardableResult
|
||
func addGroup(named name: String, into parent: NodeID?) async throws -> NodeID {
|
||
let trimmed = name.trimmingCharacters(in: .whitespaces)
|
||
guard !trimmed.isEmpty else { throw ServerFormError.emptyName }
|
||
return try await commit { catalog in
|
||
try catalog.addGroup(trimmed, to: parent)
|
||
}
|
||
}
|
||
|
||
func renameGroup(_ id: NodeID, to name: String) async throws {
|
||
let trimmed = name.trimmingCharacters(in: .whitespaces)
|
||
guard !trimmed.isEmpty else { throw ServerFormError.emptyName }
|
||
try await commit { catalog in
|
||
try catalog.renameGroup(id, to: trimmed)
|
||
}
|
||
}
|
||
|
||
/// 拖拽/移动菜单落点。跨来源、成环、移动进自身由领域拒绝，原样上抛呈现。
|
||
func move(_ id: NodeID, to parent: NodeID?) async throws {
|
||
try await commit { catalog in
|
||
try catalog.move(id, to: parent)
|
||
}
|
||
}
|
||
|
||
/// 删除（手动分组递归删整棵子树），并尽力清理被删节点的 Keychain 秘密。
|
||
func remove(_ id: NodeID) async throws {
|
||
let removed: [CatalogEntry] = try await commit { catalog in
|
||
try catalog.remove(id)
|
||
}
|
||
if let selection = selectedNodeID, removed.contains(where: { $0.id == selection }) {
|
||
selectedNodeID = nil
|
||
}
|
||
for entry in removed {
|
||
if let fields = serverFields(of: entry) {
|
||
try? credentials.delete(fields.passwordRef)
|
||
if let optionsRef = fields.pluginOptionsRef { try? credentials.delete(optionsRef) }
|
||
}
|
||
}
|
||
}
|
||
|
||
/// 详情表单提交（手动服务器）。密码经凭据存储覆盖写；插件选择按 #38 语义
|
||
/// 落盘（「无」整体清除、受管写程序名与参数、集外引用原样保留）。
|
||
func updateServer(
|
||
_ id: NodeID,
|
||
address: String,
|
||
port: Int,
|
||
encryptionMethod: String,
|
||
password: String,
|
||
remark: String,
|
||
plugin: PluginSelection,
|
||
pluginOptions: String?
|
||
) async throws {
|
||
let trimmedAddress = address.trimmingCharacters(in: .whitespaces)
|
||
guard !trimmedAddress.isEmpty else { throw ServerFormError.invalidAddress }
|
||
guard (1...65_535).contains(port) else { throw ServerFormError.invalidPort }
|
||
let trimmedMethod = encryptionMethod.trimmingCharacters(in: .whitespacesAndNewlines)
|
||
guard !trimmedMethod.isEmpty else { throw ServerFormError.missingEncryptionMethod }
|
||
guard EncryptionMethodCatalog.isSupported(trimmedMethod) else {
|
||
throw ServerFormError.unsupportedEncryptionMethod(trimmedMethod)
|
||
}
|
||
guard !password.isEmpty else { throw ServerFormError.invalidPassword }
|
||
try await commit { catalog in
|
||
guard let entry = catalog.entry(for: id), case .server(var fields) = entry.kind else {
|
||
throw CatalogError.notAServer(id)
|
||
}
|
||
try credentials.save(password, for: fields.passwordRef)
|
||
fields.address = trimmedAddress
|
||
fields.port = port
|
||
fields.encryptionMethod = trimmedMethod
|
||
fields.remark = remark.trimmingCharacters(in: .whitespaces)
|
||
try Self.applyPluginSelection(
|
||
plugin, options: pluginOptions, to: &fields, credentials: credentials)
|
||
try catalog.updateServer(id, with: fields)
|
||
}
|
||
}
|
||
|
||
// MARK: - 详情表单
|
||
|
||
func serverFormState(for id: NodeID) -> ServerFormState? {
|
||
guard let entry = catalog.entry(for: id), case .server(let fields) = entry.kind else {
|
||
return nil
|
||
}
|
||
let password = (try? credentials.secret(for: fields.passwordRef)) ?? ""
|
||
return ServerFormState(
|
||
address: fields.address,
|
||
port: fields.port,
|
||
encryptionMethod: fields.encryptionMethod,
|
||
password: password,
|
||
remark: fields.remark,
|
||
plugin: pluginSectionState(for: fields),
|
||
isEditable: entry.source == .manual)
|
||
}
|
||
|
||
/// 插件区状态（#38）：集内引用给可执行文件存在性事实与参数明文；集外引用
|
||
/// 以显式 unknown 呈现（原样保留，激活语义由状态机点名拒绝）。
|
||
private func pluginSectionState(for fields: ServerFields) -> PluginSectionState {
|
||
let selection: PluginSelection
|
||
if let program = fields.pluginProgram {
|
||
selection =
|
||
ManagedPluginCatalog.info(forProgram: program) != nil
|
||
? .managed(program: program)
|
||
: .unknown(program: program)
|
||
} else {
|
||
selection = .none
|
||
}
|
||
var provided = false
|
||
var options = ""
|
||
if case .managed(let program) = selection {
|
||
provided = plugins.executablePath(forProgram: program) != nil
|
||
options = fields.pluginOptionsRef.flatMap { (try? credentials.secret(for: $0)) ?? "" } ?? ""
|
||
}
|
||
return PluginSectionState(
|
||
selection: selection,
|
||
managed: ManagedPluginCatalog.plugins,
|
||
provided: provided,
|
||
optionsPresent: fields.pluginOptionsRef != nil,
|
||
options: options)
|
||
}
|
||
|
||
// MARK: - 分享
|
||
|
||
/// 服务器 → ss://（SIP002）：凭据从存储解析；无凭据即点名失败（不分享空档）。
|
||
func ssUri(for id: NodeID) throws -> String {
|
||
guard let entry = catalog.entry(for: id), case .server(let fields) = entry.kind else {
|
||
throw CatalogError.notAServer(id)
|
||
}
|
||
guard let password = try credentials.secret(for: fields.passwordRef) else {
|
||
throw CredentialStoreError.keychainStatus(errSecItemNotFound)
|
||
}
|
||
var pluginOptions: String?
|
||
if let optionsRef = fields.pluginOptionsRef {
|
||
pluginOptions = try credentials.secret(for: optionsRef) ?? ""
|
||
}
|
||
return SsUri(
|
||
method: fields.encryptionMethod,
|
||
password: password,
|
||
host: fields.address,
|
||
port: fields.port,
|
||
pluginProgram: fields.pluginProgram,
|
||
pluginOptions: pluginOptions,
|
||
remark: fields.remark.isEmpty ? nil : fields.remark
|
||
).encode()
|
||
}
|
||
|
||
/// 添加落点：选中手动分组 → 组内；选中服务器 → 其父组（仅手动）；其余 → 根。
|
||
func importTargetParent(for selection: NodeID?) -> NodeID? {
|
||
guard let selection, let entry = catalog.entry(for: selection) else { return nil }
|
||
switch entry.kind {
|
||
case .group:
|
||
return entry.source == .manual ? selection : nil
|
||
case .server:
|
||
guard let parent = parentID(of: selection) else { return nil }
|
||
return catalog.entry(for: parent)?.source == .manual ? parent : nil
|
||
}
|
||
}
|
||
|
||
// MARK: - 提交管线
|
||
|
||
/// 副本变更 → 落盘 → 发布 → postCommit；任一步失败则已发布状态不动。
|
||
private func commit<T>(
|
||
_ mutate: (inout ConfigurationCatalog) throws -> T
|
||
) async throws -> T {
|
||
try await commitDocument { catalog, _ in
|
||
try mutate(&catalog)
|
||
}
|
||
}
|
||
|
||
/// 目录 + 订阅记录同文档提交（订阅刷新/创建/删除共用）：任一步失败则已
|
||
/// 发布状态不动，成功才依次发布并触发运行时重展开。
|
||
func commitDocument<T>(
|
||
_ mutate: (inout ConfigurationCatalog, inout [SubscriptionRecord]) throws -> T
|
||
) async throws -> T {
|
||
var workingCatalog = catalog
|
||
var workingSubscriptions = subscriptions
|
||
let result = try mutate(&workingCatalog, &workingSubscriptions)
|
||
try fileStore.save(
|
||
CatalogDocument(catalog: workingCatalog, subscriptions: workingSubscriptions))
|
||
catalog = workingCatalog
|
||
subscriptions = workingSubscriptions
|
||
await postCommit?()
|
||
return result
|
||
}
|
||
|
||
/// URI → 服务器叶子字段：密码与插件参数入凭据存储、目录只持引用。
|
||
private static func serverFields(
|
||
from uri: SsUri, credentials: CredentialStoring
|
||
) throws -> ServerFields {
|
||
let passwordRef = CredentialReference.fresh()
|
||
var pluginOptionsRef: CredentialReference?
|
||
do {
|
||
try credentials.save(uri.password, for: passwordRef)
|
||
if uri.pluginProgram != nil, let options = uri.pluginOptions {
|
||
let ref = CredentialReference.fresh()
|
||
try credentials.save(options, for: ref)
|
||
pluginOptionsRef = ref
|
||
}
|
||
} catch {
|
||
try? credentials.delete(passwordRef)
|
||
if let pluginOptionsRef { try? credentials.delete(pluginOptionsRef) }
|
||
throw error
|
||
}
|
||
return ServerFields(
|
||
address: uri.host,
|
||
port: uri.port,
|
||
encryptionMethod: uri.method,
|
||
passwordRef: passwordRef,
|
||
remark: uri.remark ?? "",
|
||
pluginProgram: uri.pluginProgram,
|
||
pluginOptionsRef: pluginOptionsRef)
|
||
}
|
||
|
||
private static func deleteCredentialRefs(
|
||
for fields: ServerFields, credentials: CredentialStoring
|
||
) {
|
||
try? credentials.delete(fields.passwordRef)
|
||
if let optionsRef = fields.pluginOptionsRef { try? credentials.delete(optionsRef) }
|
||
}
|
||
|
||
/// 插件选择落盘（issue #38，D10/CONTEXT.md 不变量）：「无」整体清除引用与
|
||
/// 参数秘密；受管程序写引用、参数按空/非空写删钥匙串；集外引用原样保留
|
||
/// （不因打开或保存表单而漂移，激活语义由状态机点名拒绝）。
|
||
private static func applyPluginSelection(
|
||
_ selection: PluginSelection,
|
||
options: String?,
|
||
to fields: inout ServerFields,
|
||
credentials: CredentialStoring
|
||
) throws {
|
||
switch selection {
|
||
case .none:
|
||
if let reference = fields.pluginOptionsRef {
|
||
try? credentials.delete(reference)
|
||
}
|
||
fields.pluginProgram = nil
|
||
fields.pluginOptionsRef = nil
|
||
case .managed(let program):
|
||
guard ManagedPluginCatalog.info(forProgram: program) != nil else {
|
||
throw ServerFormError.pluginNotManaged(program)
|
||
}
|
||
fields.pluginProgram = program
|
||
let trimmedOptions = (options ?? "").trimmingCharacters(in: .whitespacesAndNewlines)
|
||
if trimmedOptions.isEmpty {
|
||
if let reference = fields.pluginOptionsRef {
|
||
try? credentials.delete(reference)
|
||
}
|
||
fields.pluginOptionsRef = nil
|
||
} else if let reference = fields.pluginOptionsRef {
|
||
try credentials.save(trimmedOptions, for: reference)
|
||
} else {
|
||
let reference = CredentialReference.fresh()
|
||
try credentials.save(trimmedOptions, for: reference)
|
||
fields.pluginOptionsRef = reference
|
||
}
|
||
case .unknown:
|
||
// Imported manual records may contain an unsupported plugin. Keep the opaque
|
||
// reference unchanged while the user repairs another field or selects a
|
||
// supported plugin explicitly.
|
||
break
|
||
}
|
||
}
|
||
|
||
private func serverFields(of entry: CatalogEntry) -> ServerFields? {
|
||
if case .server(let fields) = entry.kind { return fields }
|
||
return nil
|
||
}
|
||
}
|
||
|
||
extension CatalogViewModel {
|
||
func validation(for id: NodeID) -> ServerValidation? {
|
||
guard let entry = catalog.entry(for: id), case .server(let fields) = entry.kind else {
|
||
return nil
|
||
}
|
||
return ServerValidation.evaluate(fields, credentials: credentials, plugins: plugins)
|
||
}
|
||
|
||
// MARK: - 侧栏树快照
|
||
|
||
func sidebarNodes() -> [SidebarNode] {
|
||
sidebarChildren(of: nil)
|
||
}
|
||
|
||
private func sidebarChildren(of parent: NodeID?) -> [SidebarNode] {
|
||
let ids = (try? catalog.children(of: parent)) ?? []
|
||
return ids.compactMap { id in
|
||
guard let entry = catalog.entry(for: id) else { return nil }
|
||
let isGroup: Bool = {
|
||
if case .group = entry.kind { return true }
|
||
return false
|
||
}()
|
||
let children = isGroup ? sidebarChildren(of: id) : nil
|
||
let validation: ServerValidation? = {
|
||
guard case .server(let fields) = entry.kind else { return nil }
|
||
return ServerValidation.evaluate(fields, credentials: credentials, plugins: plugins)
|
||
}()
|
||
return SidebarNode(
|
||
id: id,
|
||
name: displayName(for: id),
|
||
isGroup: isGroup,
|
||
source: entry.source,
|
||
validation: validation,
|
||
invalidDescendantCount: children?.reduce(0) { $0 + $1.invalidServerCount } ?? 0,
|
||
children: children)
|
||
}
|
||
}
|
||
}
|
||
|
||
/// 表单级校验失败（地址/端口/名称）；领域拒绝仍以 CatalogError 上抛。
|
||
enum ServerFormError: Error, Equatable {
|
||
case invalidAddress
|
||
case invalidPort
|
||
case missingEncryptionMethod
|
||
case unsupportedEncryptionMethod(String)
|
||
case invalidPassword
|
||
case emptyName
|
||
/// 提交了受管集之外的插件选择（表单只能产生受管集内的选择，此为程序错误防线的显式拒绝）。
|
||
case pluginNotManaged(String)
|
||
}
|