Files
ShadowsocksX-NG/ShadowsocksX-NG2/Domain/ProxyPortSemantics.swift
T
Qiu Yuzhou e683fe99b1 feat(ng2): port semantics and conflict handling (#30)
Ports as explicit user configuration (spec #21 D8): factory defaults
1086/1087/1089, named validation errors (range + pairwise-distinct),
free-port suggestion over 32768-65535 excluding other endpoints'
configured values, best-effort occupancy probe (bind test + lsof
process name), and persisted listen settings that refuse silent port
rewrites - an unreadable store stops the runtime with a named launch
failure instead of deploying placeholder ports. PAC-port changes
surface the shared-URL invalidation notice (UI lands with #33).
Runtime bind failure keeps flowing through the #29 health gate:
launch failed, system proxy untouched.
2026-09-21 06:57:23 +08:00

105 lines
4.2 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.
/// 本地代理端点的端口语义(spec #21 D8,issue #30):端口是显式用户配置,
/// 出厂默认沿用 Legacy(SOCKS5 1086 / HTTP 1087 / PAC 1089);系统任何路径
/// 都不静默改端口——建议端口只产出候选,必须经用户确认保存后才生效;激活
/// 是否成功以 runtime 实际绑定为准(健康门禁),本层的占用校验只是设置编辑
/// 期尽力而为的即时提示。
/// 三个本地代理端点;显示名与 D8 及诊断报告的措辞一致。
enum ProxyEndpointKind: Equatable, Sendable, CaseIterable {
case socks
case http
case pac
var displayName: String {
switch self {
case .socks: "SOCKS5"
case .http: "HTTP"
case .pac: "PAC"
}
}
}
/// 端口配置校验错误:点名端点与端口(D8 错误信息要求)。
enum PortSettingError: Error, Equatable, Sendable {
case portOutOfRange(endpoint: ProxyEndpointKind, port: Int)
/// 两个端点的配置端口相同;`endpoint` 在枚举序(socks → http → pac)中在前。
case duplicatePort(endpoint: ProxyEndpointKind, otherEndpoint: ProxyEndpointKind, port: Int)
var presentedReason: String {
switch self {
case .portOutOfRange(let endpoint, let port):
return "\(endpoint.displayName) 端口 \(port) 无效,必须是 1–65535 之间的整数"
case .duplicatePort(let endpoint, let otherEndpoint, let port):
return
"\(endpoint.displayName) 端口与 \(otherEndpoint.displayName) 端口冲突(都是 \(port)),请为每个端点配置不同的端口"
}
}
}
/// 建议空闲端口算法(D8):32768–65535 高位段升序扫描,跳过排除集合与不
/// 空闲端口。空闲判定由调用方注入,保证主缝可测。
enum PortSuggestion {
static let range = 32768...65535
static func firstFree(excluding excludedPorts: Set<Int>, isFree: (Int) -> Bool) -> Int? {
for candidate in range where !excludedPorts.contains(candidate) {
if isFree(candidate) { return candidate }
}
return nil
}
}
extension SslocalListenSettings {
/// 三个端点的配置端口(与 HTTP 是否启用无关:配置值一律互异,避免日后
/// 重新启用 HTTP 时才暴露冲突)。
func configuredPort(for endpoint: ProxyEndpointKind) -> Int {
switch endpoint {
case .socks: socksPort
case .http: httpPort
case .pac: pacPort
}
}
/// 端口配置校验:范围 1–65535、三端点配置值两两互异。错误按固定次序
/// (socks/http/pac 范围检查,再 socks-http、socks-pac、http-pac 冲突)。
func portValidationErrors() -> [PortSettingError] {
var errors: [PortSettingError] = []
for endpoint in ProxyEndpointKind.allCases {
let port = configuredPort(for: endpoint)
if !(1...65535).contains(port) {
errors.append(.portOutOfRange(endpoint: endpoint, port: port))
}
}
for pair in Self.endpointPairs {
let first = configuredPort(for: pair.0)
if first == configuredPort(for: pair.1) {
errors.append(.duplicatePort(endpoint: pair.0, otherEndpoint: pair.1, port: first))
}
}
return errors
}
/// 为 `endpoint` 建议一个空闲端口:高位段升序首个空闲且不等于另两个端点
/// 配置值的候选;整段无可用返回 nil。只产出候选,绝不替用户改配置。
func suggestedPort(for endpoint: ProxyEndpointKind, isFree: (Int) -> Bool) -> Int? {
let others = Set(ProxyEndpointKind.allCases.filter { $0 != endpoint }.map(configuredPort))
return PortSuggestion.firstFree(excluding: others, isFree: isFree)
}
private static let endpointPairs: [(ProxyEndpointKind, ProxyEndpointKind)] = [
(.socks, .http), (.socks, .pac), (.http, .pac),
]
}
/// PAC 端口变更的失效提示(D8):已分享出去的 PAC URL 内嵌端口,换端口即
/// 失效,保存前必须提示。UI 呈现面在 #33 接线。
enum PortChangeNotice {
static func pacInvalidation(
from previous: SslocalListenSettings, to next: SslocalListenSettings
) -> String? {
guard previous.pacPort != next.pacPort else { return nil }
return
"PAC 端口将从 \(previous.pacPort) 改为 \(next.pacPort),已分享的 PAC URL 将失效,保存后需要重新分享"
}
}