* refactor: introduce provider plugin registry * refactor: move provider CLI to plugins * docs: add provider plugin implementation notes * refactor: shift provider runtime logic into plugins * refactor: add plugin defaults and summaries * docs: update provider plugin notes * feat(commands): add /commands slash list * Auto-reply: tidy help message * Auto-reply: fix status command lint * Tests: align google shared expectations * Auto-reply: tidy help message * Auto-reply: fix status command lint * refactor: move provider routing into plugins * test: align agent routing expectations * docs: update provider plugin notes * refactor: route replies via provider plugins * docs: note route-reply plugin hooks * refactor: extend provider plugin contract * refactor: derive provider status from plugins * refactor: unify gateway provider control * refactor: use plugin metadata in auto-reply * fix: parenthesize cron target selection * refactor: derive gateway methods from plugins * refactor: generalize provider logout * refactor: route provider logout through plugins * refactor: move WhatsApp web login methods into plugin * refactor: generalize provider log prefixes * refactor: centralize default chat provider * refactor: derive provider lists from registry * refactor: move provider reload noops into plugins * refactor: resolve web login provider via alias * refactor: derive CLI provider options from plugins * refactor: derive prompt provider list from plugins * style: apply biome lint fixes * fix: resolve provider routing edge cases * docs: update provider plugin refactor notes * fix(gateway): harden agent provider routing * refactor: move provider routing into plugins * refactor: move provider CLI to plugins * refactor: derive provider lists from registry * fix: restore slash command parsing * refactor: align provider ids for schema * refactor: unify outbound target resolution * fix: keep outbound labels stable * feat: add msteams to cron surfaces * fix: clean up lint build issues * refactor: localize chat provider alias normalization * refactor: drive gateway provider lists from plugins * docs: update provider plugin notes * style: format message-provider * fix: avoid provider registry init cycles * style: sort message-provider imports * fix: relax provider alias map typing * refactor: move provider routing into plugins * refactor: add plugin pairing/config adapters * refactor: route pairing and provider removal via plugins * refactor: align auto-reply provider typing * test: stabilize telegram media mocks * docs: update provider plugin refactor notes * refactor: pluginize outbound targets * refactor: pluginize provider selection * refactor: generalize text chunk limits * docs: update provider plugin notes * refactor: generalize group session/config * fix: normalize provider id for room detection * fix: avoid provider init in system prompt * style: formatting cleanup * refactor: normalize agent delivery targets * test: update outbound delivery labels * chore: fix lint regressions * refactor: extend provider plugin adapters * refactor: move elevated/block streaming defaults to plugins * refactor: defer outbound send deps to plugins * docs: note plugin-driven streaming/elevated defaults * refactor: centralize webchat provider constant * refactor: add provider setup adapters * refactor: delegate provider add config to plugins * docs: document plugin-driven provider add * refactor: add plugin state/binding metadata * refactor: build agent provider status from plugins * docs: note plugin-driven agent bindings * refactor: centralize internal provider constant usage * fix: normalize WhatsApp targets for groups and E.164 (#631) (thanks @imfing) * refactor: centralize default chat provider * refactor: centralize WhatsApp target normalization * refactor: move provider routing into plugins * refactor: normalize agent delivery targets * chore: fix lint regressions * fix: normalize WhatsApp targets for groups and E.164 (#631) (thanks @imfing) * feat: expand provider plugin adapters * refactor: route auto-reply via provider plugins * fix: align WhatsApp target normalization * fix: normalize WhatsApp targets for groups and E.164 (#631) (thanks @imfing) * refactor: centralize WhatsApp target normalization * feat: add /config chat config updates * docs: add /config get alias * feat(commands): add /commands slash list * refactor: centralize default chat provider * style: apply biome lint fixes * chore: fix lint regressions * fix: clean up whatsapp allowlist typing * style: format config command helpers * refactor: pluginize tool threading context * refactor: normalize session announce targets * docs: note new plugin threading and announce hooks * refactor: pluginize message actions * docs: update provider plugin actions notes * fix: align provider action adapters * refactor: centralize webchat checks * style: format message provider helpers * refactor: move provider onboarding into adapters * docs: note onboarding provider adapters * feat: add msteams onboarding adapter * style: organize onboarding imports * fix: normalize msteams allowFrom types * feat: add plugin text chunk limits * refactor: use plugin chunk limit fallbacks * feat: add provider mention stripping hooks * style: organize provider plugin type imports * refactor: generalize health snapshots * refactor: update macOS health snapshot handling * docs: refresh health snapshot notes * style: format health snapshot updates * refactor: drive security warnings via plugins * docs: note provider security adapter * style: format provider security adapters * refactor: centralize provider account defaults * refactor: type gateway client identity constants * chore: regen gateway protocol swift * fix: degrade health on failed provider probe * refactor: centralize pairing approve hint * docs: add plugin CLI command references * refactor: route auth and tool sends through plugins * docs: expand provider plugin hooks * refactor: document provider docking touchpoints * refactor: normalize internal provider defaults * refactor: streamline outbound delivery wiring * refactor: make provider onboarding plugin-owned * refactor: support provider-owned agent tools * refactor: move telegram draft chunking into telegram module * refactor: infer provider tool sends via extractToolSend * fix: repair plugin onboarding imports * refactor: de-dup outbound target normalization * style: tidy plugin and agent imports * refactor: data-drive provider selection line * fix: satisfy lint after provider plugin rebase * test: deflake gateway-cli coverage * style: format gateway-cli coverage test * refactor(provider-plugins): simplify provider ids * test(pairing-cli): avoid provider-specific ternary * style(macos): swiftformat HealthStore * refactor(sandbox): derive provider tool denylist * fix(sandbox): avoid plugin init in defaults * refactor(provider-plugins): centralize provider aliases * style(test): satisfy biome * refactor(protocol): v3 providers.status maps * refactor(ui): adapt to protocol v3 * refactor(macos): adapt to protocol v3 * test: update providers.status v3 fixtures * refactor(gateway): map provider runtime snapshot * test(gateway): update reload runtime snapshot * refactor(whatsapp): normalize heartbeat provider id * docs(refactor): update provider plugin notes * style: satisfy biome after rebase * fix: describe sandboxed elevated in prompt * feat(gateway): add agent image attachments + live probe * refactor: derive CLI provider options from plugins * fix(gateway): harden agent provider routing * fix(gateway): harden agent provider routing * refactor: align provider ids for schema * fix(protocol): keep agent provider string * fix(gateway): harden agent provider routing * fix(protocol): keep agent provider string * refactor: normalize agent delivery targets * refactor: support provider-owned agent tools * refactor(config): provider-keyed elevated allowFrom * style: satisfy biome * fix(gateway): appease provider narrowing * style: satisfy biome * refactor(reply): move group intro hints into plugin * fix(reply): avoid plugin registry init cycle * refactor(providers): add lightweight provider dock * refactor(gateway): use typed client id in connect * refactor(providers): document docks and avoid init cycles * refactor(providers): make media limit helper generic * fix(providers): break plugin registry import cycles * style: satisfy biome * refactor(status-all): build providers table from plugins * refactor(gateway): delegate web login to provider plugin * refactor(provider): drop web alias * refactor(provider): lazy-load monitors * style: satisfy lint/format * style: format status-all providers table * style: swiftformat gateway discovery model * test: make reload plan plugin-driven * fix: avoid token stringification in status-all * refactor: make provider IDs explicit in status * feat: warn on signal/imessage provider runtime errors * test: cover gateway provider runtime warnings in status * fix: add runtime kind to provider status issues * test: cover health degradation on probe failure * fix: keep routeReply lightweight * style: organize routeReply imports * refactor(web): extract auth-store helpers * refactor(whatsapp): lazy login imports * refactor(outbound): route replies via plugin outbound * docs: update provider plugin notes * style: format provider status issues * fix: make sandbox scope warning wrap-safe * refactor: load outbound adapters from provider plugins * docs: update provider plugin outbound notes * style(macos): fix swiftformat lint * docs: changelog for provider plugins * fix(macos): satisfy swiftformat * fix(macos): open settings via menu action * style: format after rebase * fix(macos): open Settings via menu action --------- Co-authored-by: LK <luke@kyohere.com> Co-authored-by: Luke K (pr-0f3t) <2609441+lc0rp@users.noreply.github.com> Co-authored-by: Xin <xin@imfing.com>
363 lines
14 KiB
Swift
363 lines
14 KiB
Swift
import Foundation
|
|
|
|
enum GatewayLaunchAgentManager {
|
|
private static let logger = Logger(subsystem: "com.clawdbot", category: "gateway.launchd")
|
|
private static let supportedBindModes: Set<String> = ["loopback", "tailnet", "lan", "auto"]
|
|
private static let legacyGatewayLaunchdLabel = "com.steipete.clawdbot.gateway"
|
|
private static let disableLaunchAgentMarker = ".clawdbot/disable-launchagent"
|
|
|
|
private enum GatewayProgramArgumentsError: LocalizedError {
|
|
case cliNotFound
|
|
|
|
var errorDescription: String? {
|
|
switch self {
|
|
case .cliNotFound:
|
|
"clawdbot CLI not found in PATH; install the CLI."
|
|
}
|
|
}
|
|
}
|
|
|
|
private static var plistURL: URL {
|
|
FileManager.default.homeDirectoryForCurrentUser
|
|
.appendingPathComponent("Library/LaunchAgents/\(gatewayLaunchdLabel).plist")
|
|
}
|
|
|
|
private static var legacyPlistURL: URL {
|
|
FileManager.default.homeDirectoryForCurrentUser
|
|
.appendingPathComponent("Library/LaunchAgents/\(legacyGatewayLaunchdLabel).plist")
|
|
}
|
|
|
|
private static func gatewayProgramArguments(
|
|
port: Int,
|
|
bind: String) -> Result<[String], GatewayProgramArgumentsError>
|
|
{
|
|
#if DEBUG
|
|
let projectRoot = CommandResolver.projectRoot()
|
|
if let localBin = CommandResolver.projectClawdbotExecutable(projectRoot: projectRoot) {
|
|
return .success([localBin, "gateway-daemon", "--port", "\(port)", "--bind", bind])
|
|
}
|
|
if let entry = CommandResolver.gatewayEntrypoint(in: projectRoot) {
|
|
switch CommandResolver.runtimeResolution() {
|
|
case let .success(runtime):
|
|
let cmd = CommandResolver.makeRuntimeCommand(
|
|
runtime: runtime,
|
|
entrypoint: entry,
|
|
subcommand: "gateway-daemon",
|
|
extraArgs: ["--port", "\(port)", "--bind", bind])
|
|
return .success(cmd)
|
|
case .failure:
|
|
break
|
|
}
|
|
}
|
|
#endif
|
|
let searchPaths = CommandResolver.preferredPaths()
|
|
if let gatewayBin = CommandResolver.clawdbotExecutable(searchPaths: searchPaths) {
|
|
return .success([gatewayBin, "gateway-daemon", "--port", "\(port)", "--bind", bind])
|
|
}
|
|
|
|
let fallbackProjectRoot = CommandResolver.projectRoot()
|
|
if let entry = CommandResolver.gatewayEntrypoint(in: fallbackProjectRoot) {
|
|
switch CommandResolver.runtimeResolution(searchPaths: searchPaths) {
|
|
case let .success(runtime):
|
|
let cmd = CommandResolver.makeRuntimeCommand(
|
|
runtime: runtime,
|
|
entrypoint: entry,
|
|
subcommand: "gateway-daemon",
|
|
extraArgs: ["--port", "\(port)", "--bind", bind])
|
|
return .success(cmd)
|
|
case .failure:
|
|
break
|
|
}
|
|
}
|
|
|
|
return .failure(.cliNotFound)
|
|
}
|
|
|
|
static func isLoaded() async -> Bool {
|
|
guard FileManager.default.fileExists(atPath: self.plistURL.path) else { return false }
|
|
let result = await Launchctl.run(["print", "gui/\(getuid())/\(gatewayLaunchdLabel)"])
|
|
return result.status == 0
|
|
}
|
|
|
|
static func set(enabled: Bool, bundlePath: String, port: Int) async -> String? {
|
|
_ = bundlePath
|
|
if enabled, self.isLaunchAgentWriteDisabled() {
|
|
self.logger.info("launchd enable skipped (attach-only or disable marker set)")
|
|
return nil
|
|
}
|
|
if enabled {
|
|
_ = await Launchctl.run(["bootout", "gui/\(getuid())/\(self.legacyGatewayLaunchdLabel)"])
|
|
try? FileManager.default.removeItem(at: self.legacyPlistURL)
|
|
|
|
let desiredBind = self.preferredGatewayBind() ?? "loopback"
|
|
let desiredToken = self.preferredGatewayToken()
|
|
let desiredPassword = self.preferredGatewayPassword()
|
|
let desiredConfig = DesiredConfig(
|
|
port: port,
|
|
bind: desiredBind,
|
|
token: desiredToken,
|
|
password: desiredPassword)
|
|
let programArgumentsResult = self.gatewayProgramArguments(port: port, bind: desiredBind)
|
|
let programArguments: [String]
|
|
switch programArgumentsResult {
|
|
case let .success(args):
|
|
programArguments = args
|
|
case let .failure(error):
|
|
let message = error.errorDescription ?? "Failed to resolve gateway CLI"
|
|
self.logger.error("launchd enable failed: \(message)")
|
|
return message
|
|
}
|
|
|
|
// If launchd already loaded the job (common on login), avoid `bootout` unless we must
|
|
// change the config. `bootout` can kill a just-started gateway and cause attach loops.
|
|
let loaded = await self.isLoaded()
|
|
if loaded {
|
|
if let existing = self.readPlistConfig(), existing.matches(desiredConfig) {
|
|
self.logger.info("launchd job already loaded with desired config; skipping bootout")
|
|
await self.ensureEnabled()
|
|
_ = await Launchctl.run(["kickstart", "gui/\(getuid())/\(gatewayLaunchdLabel)"])
|
|
return nil
|
|
}
|
|
}
|
|
|
|
self.logger.info("launchd enable requested port=\(port) bind=\(desiredBind)")
|
|
self.writePlist(programArguments: programArguments)
|
|
|
|
await self.ensureEnabled()
|
|
if loaded {
|
|
_ = await Launchctl.run(["bootout", "gui/\(getuid())/\(gatewayLaunchdLabel)"])
|
|
}
|
|
let bootstrap = await Launchctl.run(["bootstrap", "gui/\(getuid())", self.plistURL.path])
|
|
if bootstrap.status != 0 {
|
|
let msg = bootstrap.output.trimmingCharacters(in: .whitespacesAndNewlines)
|
|
self.logger.error("launchd bootstrap failed: \(msg)")
|
|
return bootstrap.output.trimmingCharacters(in: .whitespacesAndNewlines).isEmpty
|
|
? "Failed to bootstrap gateway launchd job"
|
|
: bootstrap.output.trimmingCharacters(in: .whitespacesAndNewlines)
|
|
}
|
|
await self.ensureEnabled()
|
|
return nil
|
|
}
|
|
|
|
self.logger.info("launchd disable requested")
|
|
_ = await Launchctl.run(["bootout", "gui/\(getuid())/\(gatewayLaunchdLabel)"])
|
|
await self.ensureDisabled()
|
|
try? FileManager.default.removeItem(at: self.plistURL)
|
|
return nil
|
|
}
|
|
|
|
static func kickstart() async {
|
|
_ = await Launchctl.run(["kickstart", "-k", "gui/\(getuid())/\(gatewayLaunchdLabel)"])
|
|
}
|
|
|
|
private static func writePlist(programArguments: [String]) {
|
|
let preferredPath = CommandResolver.preferredPaths().joined(separator: ":")
|
|
let token = self.preferredGatewayToken()
|
|
let password = self.preferredGatewayPassword()
|
|
var envEntries = """
|
|
<key>PATH</key>
|
|
<string>\(preferredPath)</string>
|
|
"""
|
|
if let token {
|
|
let escapedToken = self.escapePlistValue(token)
|
|
envEntries += """
|
|
<key>CLAWDBOT_GATEWAY_TOKEN</key>
|
|
<string>\(escapedToken)</string>
|
|
"""
|
|
}
|
|
if let password {
|
|
let escapedPassword = self.escapePlistValue(password)
|
|
envEntries += """
|
|
<key>CLAWDBOT_GATEWAY_PASSWORD</key>
|
|
<string>\(escapedPassword)</string>
|
|
"""
|
|
}
|
|
let argsXml = programArguments
|
|
.map { "<string>\(self.escapePlistValue($0))</string>" }
|
|
.joined(separator: "\n ")
|
|
let plist = """
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
<plist version="1.0">
|
|
<dict>
|
|
<key>Label</key>
|
|
<string>\(gatewayLaunchdLabel)</string>
|
|
<key>ProgramArguments</key>
|
|
<array>
|
|
\(argsXml)
|
|
</array>
|
|
<key>WorkingDirectory</key>
|
|
<string>\(FileManager.default.homeDirectoryForCurrentUser.path)</string>
|
|
<key>RunAtLoad</key>
|
|
<true/>
|
|
<key>KeepAlive</key>
|
|
<true/>
|
|
<key>EnvironmentVariables</key>
|
|
<dict>
|
|
\(envEntries)
|
|
</dict>
|
|
<key>StandardOutPath</key>
|
|
<string>\(LogLocator.launchdGatewayLogPath)</string>
|
|
<key>StandardErrorPath</key>
|
|
<string>\(LogLocator.launchdGatewayLogPath)</string>
|
|
</dict>
|
|
</plist>
|
|
"""
|
|
do {
|
|
try plist.write(to: self.plistURL, atomically: true, encoding: .utf8)
|
|
} catch {
|
|
self.logger.error("launchd plist write failed: \(error.localizedDescription)")
|
|
}
|
|
}
|
|
|
|
private static func preferredGatewayBind() -> String? {
|
|
if CommandResolver.connectionModeIsRemote() {
|
|
return nil
|
|
}
|
|
if let env = ProcessInfo.processInfo.environment["CLAWDBOT_GATEWAY_BIND"] {
|
|
let trimmed = env.trimmingCharacters(in: .whitespacesAndNewlines).lowercased()
|
|
if self.supportedBindModes.contains(trimmed) {
|
|
return trimmed
|
|
}
|
|
}
|
|
|
|
let root = ClawdbotConfigFile.loadDict()
|
|
if let gateway = root["gateway"] as? [String: Any],
|
|
let bind = gateway["bind"] as? String
|
|
{
|
|
let trimmed = bind.trimmingCharacters(in: .whitespacesAndNewlines).lowercased()
|
|
if self.supportedBindModes.contains(trimmed) {
|
|
return trimmed
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
private static func preferredGatewayToken() -> String? {
|
|
let raw = ProcessInfo.processInfo.environment["CLAWDBOT_GATEWAY_TOKEN"] ?? ""
|
|
let trimmed = raw.trimmingCharacters(in: .whitespacesAndNewlines)
|
|
if !trimmed.isEmpty {
|
|
return trimmed
|
|
}
|
|
let root = ClawdbotConfigFile.loadDict()
|
|
if let gateway = root["gateway"] as? [String: Any],
|
|
let auth = gateway["auth"] as? [String: Any],
|
|
let token = auth["token"] as? String
|
|
{
|
|
let value = token.trimmingCharacters(in: .whitespacesAndNewlines)
|
|
if !value.isEmpty {
|
|
return value
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
private static func preferredGatewayPassword() -> String? {
|
|
// First check environment variable
|
|
let raw = ProcessInfo.processInfo.environment["CLAWDBOT_GATEWAY_PASSWORD"] ?? ""
|
|
let trimmed = raw.trimmingCharacters(in: .whitespacesAndNewlines)
|
|
if !trimmed.isEmpty {
|
|
return trimmed
|
|
}
|
|
// Then check config file (gateway.auth.password)
|
|
let root = ClawdbotConfigFile.loadDict()
|
|
if let gateway = root["gateway"] as? [String: Any],
|
|
let auth = gateway["auth"] as? [String: Any],
|
|
let password = auth["password"] as? String
|
|
{
|
|
return password.trimmingCharacters(in: .whitespacesAndNewlines)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
private static func escapePlistValue(_ raw: String) -> String {
|
|
raw
|
|
.replacingOccurrences(of: "&", with: "&")
|
|
.replacingOccurrences(of: "<", with: "<")
|
|
.replacingOccurrences(of: ">", with: ">")
|
|
.replacingOccurrences(of: "\"", with: """)
|
|
.replacingOccurrences(of: "'", with: "'")
|
|
}
|
|
|
|
private struct DesiredConfig: Equatable {
|
|
let port: Int
|
|
let bind: String
|
|
let token: String?
|
|
let password: String?
|
|
}
|
|
|
|
private struct InstalledConfig: Equatable {
|
|
let port: Int?
|
|
let bind: String?
|
|
let token: String?
|
|
let password: String?
|
|
|
|
func matches(_ desired: DesiredConfig) -> Bool {
|
|
guard self.port == desired.port else { return false }
|
|
guard (self.bind ?? "loopback") == desired.bind else { return false }
|
|
guard self.token == desired.token else { return false }
|
|
guard self.password == desired.password else { return false }
|
|
return true
|
|
}
|
|
}
|
|
|
|
private static func readPlistConfig() -> InstalledConfig? {
|
|
guard let snapshot = LaunchAgentPlist.snapshot(url: self.plistURL) else { return nil }
|
|
return InstalledConfig(
|
|
port: snapshot.port,
|
|
bind: snapshot.bind,
|
|
token: snapshot.token,
|
|
password: snapshot.password)
|
|
}
|
|
|
|
private static func ensureEnabled() async {
|
|
let result = await Launchctl.run(["enable", "gui/\(getuid())/\(gatewayLaunchdLabel)"])
|
|
guard result.status != 0 else { return }
|
|
let msg = result.output.trimmingCharacters(in: .whitespacesAndNewlines)
|
|
if msg.isEmpty {
|
|
self.logger.warning("launchd enable failed")
|
|
} else {
|
|
self.logger.warning("launchd enable failed: \(msg)")
|
|
}
|
|
}
|
|
|
|
private static func ensureDisabled() async {
|
|
let result = await Launchctl.run(["disable", "gui/\(getuid())/\(gatewayLaunchdLabel)"])
|
|
guard result.status != 0 else { return }
|
|
let msg = result.output.trimmingCharacters(in: .whitespacesAndNewlines)
|
|
if msg.isEmpty {
|
|
self.logger.warning("launchd disable failed")
|
|
} else {
|
|
self.logger.warning("launchd disable failed: \(msg)")
|
|
}
|
|
}
|
|
}
|
|
|
|
extension GatewayLaunchAgentManager {
|
|
private static func isLaunchAgentWriteDisabled() -> Bool {
|
|
if UserDefaults.standard.bool(forKey: attachExistingGatewayOnlyKey) {
|
|
return true
|
|
}
|
|
let marker = FileManager.default.homeDirectoryForCurrentUser
|
|
.appendingPathComponent(self.disableLaunchAgentMarker)
|
|
return FileManager.default.fileExists(atPath: marker.path)
|
|
}
|
|
}
|
|
|
|
#if DEBUG
|
|
extension GatewayLaunchAgentManager {
|
|
static func _testPreferredGatewayBind() -> String? {
|
|
self.preferredGatewayBind()
|
|
}
|
|
|
|
static func _testPreferredGatewayToken() -> String? {
|
|
self.preferredGatewayToken()
|
|
}
|
|
|
|
static func _testEscapePlistValue(_ raw: String) -> String {
|
|
self.escapePlistValue(raw)
|
|
}
|
|
}
|
|
#endif
|