import type { ChannelOnboardingDmPolicy } from "../../../src/channels/plugins/onboarding-types.js"; import { mergeAllowFromEntries, resolveOnboardingAccountId, setOnboardingChannelEnabled, setTopLevelChannelDmPolicyWithAllowFrom, } from "../../../src/channels/plugins/onboarding/helpers.js"; import { applyAccountNameToChannelSection, patchScopedAccountConfig, } from "../../../src/channels/plugins/setup-helpers.js"; import { type ChannelSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; import type { ChannelSetupAdapter } from "../../../src/channels/plugins/types.adapters.js"; import type { ChannelSetupInput } from "../../../src/channels/plugins/types.core.js"; import type { OpenClawConfig } from "../../../src/config/config.js"; import { hasConfiguredSecretInput } from "../../../src/config/types.secrets.js"; import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "../../../src/routing/session-key.js"; import { formatDocsLink } from "../../../src/terminal/links.js"; import type { WizardPrompter } from "../../../src/wizard/prompts.js"; import { listNextcloudTalkAccountIds, resolveDefaultNextcloudTalkAccountId, resolveNextcloudTalkAccount, } from "./accounts.js"; import type { CoreConfig, DmPolicy } from "./types.js"; const channel = "nextcloud-talk" as const; const CONFIGURE_API_FLAG = "__nextcloudTalkConfigureApiCredentials"; type NextcloudSetupInput = ChannelSetupInput & { baseUrl?: string; secret?: string; secretFile?: string; }; type NextcloudTalkSection = NonNullable["nextcloud-talk"]; function normalizeNextcloudTalkBaseUrl(value: string | undefined): string { return value?.trim().replace(/\/+$/, "") ?? ""; } function validateNextcloudTalkBaseUrl(value: string): string | undefined { if (!value) { return "Required"; } if (!value.startsWith("http://") && !value.startsWith("https://")) { return "URL must start with http:// or https://"; } return undefined; } function setNextcloudTalkDmPolicy(cfg: CoreConfig, dmPolicy: DmPolicy): CoreConfig { return setTopLevelChannelDmPolicyWithAllowFrom({ cfg, channel, dmPolicy, }) as CoreConfig; } function setNextcloudTalkAccountConfig( cfg: CoreConfig, accountId: string, updates: Record, ): CoreConfig { return patchScopedAccountConfig({ cfg, channelKey: channel, accountId, patch: updates, }) as CoreConfig; } function clearNextcloudTalkAccountFields( cfg: CoreConfig, accountId: string, fields: string[], ): CoreConfig { const section = cfg.channels?.["nextcloud-talk"]; if (!section) { return cfg; } if (accountId === DEFAULT_ACCOUNT_ID) { const nextSection = { ...section } as Record; for (const field of fields) { delete nextSection[field]; } return { ...cfg, channels: { ...(cfg.channels ?? {}), "nextcloud-talk": nextSection as NextcloudTalkSection, }, } as CoreConfig; } const currentAccount = section.accounts?.[accountId]; if (!currentAccount) { return cfg; } const nextAccount = { ...currentAccount } as Record; for (const field of fields) { delete nextAccount[field]; } return { ...cfg, channels: { ...(cfg.channels ?? {}), "nextcloud-talk": { ...section, accounts: { ...section.accounts, [accountId]: nextAccount as NonNullable[string], }, }, }, } as CoreConfig; } async function promptNextcloudTalkAllowFrom(params: { cfg: CoreConfig; prompter: WizardPrompter; accountId: string; }): Promise { const resolved = resolveNextcloudTalkAccount({ cfg: params.cfg, accountId: params.accountId }); const existingAllowFrom = resolved.config.allowFrom ?? []; await params.prompter.note( [ "1) Check the Nextcloud admin panel for user IDs", "2) Or look at the webhook payload logs when someone messages", "3) User IDs are typically lowercase usernames in Nextcloud", `Docs: ${formatDocsLink("/channels/nextcloud-talk", "channels/nextcloud-talk")}`, ].join("\n"), "Nextcloud Talk user id", ); let resolvedIds: string[] = []; while (resolvedIds.length === 0) { const entry = await params.prompter.text({ message: "Nextcloud Talk allowFrom (user id)", placeholder: "username", initialValue: existingAllowFrom[0] ? String(existingAllowFrom[0]) : undefined, validate: (value) => (String(value ?? "").trim() ? undefined : "Required"), }); resolvedIds = String(entry) .split(/[\n,;]+/g) .map((value) => value.trim().toLowerCase()) .filter(Boolean); if (resolvedIds.length === 0) { await params.prompter.note("Please enter at least one valid user ID.", "Nextcloud Talk"); } } return setNextcloudTalkAccountConfig(params.cfg, params.accountId, { dmPolicy: "allowlist", allowFrom: mergeAllowFromEntries( existingAllowFrom.map((value) => String(value).trim().toLowerCase()), resolvedIds, ), }); } async function promptNextcloudTalkAllowFromForAccount(params: { cfg: OpenClawConfig; prompter: WizardPrompter; accountId?: string; }): Promise { const accountId = resolveOnboardingAccountId({ accountId: params.accountId, defaultAccountId: resolveDefaultNextcloudTalkAccountId(params.cfg as CoreConfig), }); return await promptNextcloudTalkAllowFrom({ cfg: params.cfg as CoreConfig, prompter: params.prompter, accountId, }); } const nextcloudTalkDmPolicy: ChannelOnboardingDmPolicy = { label: "Nextcloud Talk", channel, policyKey: "channels.nextcloud-talk.dmPolicy", allowFromKey: "channels.nextcloud-talk.allowFrom", getCurrent: (cfg) => cfg.channels?.["nextcloud-talk"]?.dmPolicy ?? "pairing", setPolicy: (cfg, policy) => setNextcloudTalkDmPolicy(cfg as CoreConfig, policy as DmPolicy), promptAllowFrom: promptNextcloudTalkAllowFromForAccount, }; export const nextcloudTalkSetupAdapter: ChannelSetupAdapter = { resolveAccountId: ({ accountId }) => normalizeAccountId(accountId), applyAccountName: ({ cfg, accountId, name }) => applyAccountNameToChannelSection({ cfg, channelKey: channel, accountId, name, }), validateInput: ({ accountId, input }) => { const setupInput = input as NextcloudSetupInput; if (setupInput.useEnv && accountId !== DEFAULT_ACCOUNT_ID) { return "NEXTCLOUD_TALK_BOT_SECRET can only be used for the default account."; } if (!setupInput.useEnv && !setupInput.secret && !setupInput.secretFile) { return "Nextcloud Talk requires bot secret or --secret-file (or --use-env)."; } if (!setupInput.baseUrl) { return "Nextcloud Talk requires --base-url."; } return null; }, applyAccountConfig: ({ cfg, accountId, input }) => { const setupInput = input as NextcloudSetupInput; const namedConfig = applyAccountNameToChannelSection({ cfg, channelKey: channel, accountId, name: setupInput.name, }); const next = setupInput.useEnv ? clearNextcloudTalkAccountFields(namedConfig as CoreConfig, accountId, [ "botSecret", "botSecretFile", ]) : namedConfig; const patch = { baseUrl: normalizeNextcloudTalkBaseUrl(setupInput.baseUrl), ...(setupInput.useEnv ? {} : setupInput.secretFile ? { botSecretFile: setupInput.secretFile } : setupInput.secret ? { botSecret: setupInput.secret } : {}), }; return setNextcloudTalkAccountConfig(next as CoreConfig, accountId, patch); }, }; export const nextcloudTalkSetupWizard: ChannelSetupWizard = { channel, stepOrder: "text-first", status: { configuredLabel: "configured", unconfiguredLabel: "needs setup", configuredHint: "configured", unconfiguredHint: "self-hosted chat", configuredScore: 1, unconfiguredScore: 5, resolveConfigured: ({ cfg }) => listNextcloudTalkAccountIds(cfg as CoreConfig).some((accountId) => { const account = resolveNextcloudTalkAccount({ cfg: cfg as CoreConfig, accountId }); return Boolean(account.secret && account.baseUrl); }), }, introNote: { title: "Nextcloud Talk bot setup", lines: [ "1) SSH into your Nextcloud server", '2) Run: ./occ talk:bot:install "OpenClaw" "" "" --feature reaction', "3) Copy the shared secret you used in the command", "4) Enable the bot in your Nextcloud Talk room settings", "Tip: you can also set NEXTCLOUD_TALK_BOT_SECRET in your env.", `Docs: ${formatDocsLink("/channels/nextcloud-talk", "channels/nextcloud-talk")}`, ], shouldShow: ({ cfg, accountId }) => { const account = resolveNextcloudTalkAccount({ cfg: cfg as CoreConfig, accountId }); return !account.secret || !account.baseUrl; }, }, prepare: async ({ cfg, accountId, credentialValues, prompter }) => { const resolvedAccount = resolveNextcloudTalkAccount({ cfg: cfg as CoreConfig, accountId }); const hasApiCredentials = Boolean( resolvedAccount.config.apiUser?.trim() && (hasConfiguredSecretInput(resolvedAccount.config.apiPassword) || resolvedAccount.config.apiPasswordFile), ); const configureApiCredentials = await prompter.confirm({ message: "Configure optional Nextcloud Talk API credentials for room lookups?", initialValue: hasApiCredentials, }); if (!configureApiCredentials) { return; } return { credentialValues: { ...credentialValues, [CONFIGURE_API_FLAG]: "1", }, }; }, credentials: [ { inputKey: "token", providerHint: channel, credentialLabel: "bot secret", preferredEnvVar: "NEXTCLOUD_TALK_BOT_SECRET", envPrompt: "NEXTCLOUD_TALK_BOT_SECRET detected. Use env var?", keepPrompt: "Nextcloud Talk bot secret already configured. Keep it?", inputPrompt: "Enter Nextcloud Talk bot secret", allowEnv: ({ accountId }) => accountId === DEFAULT_ACCOUNT_ID, inspect: ({ cfg, accountId }) => { const resolvedAccount = resolveNextcloudTalkAccount({ cfg: cfg as CoreConfig, accountId }); return { accountConfigured: Boolean(resolvedAccount.secret && resolvedAccount.baseUrl), hasConfiguredValue: Boolean( hasConfiguredSecretInput(resolvedAccount.config.botSecret) || resolvedAccount.config.botSecretFile, ), resolvedValue: resolvedAccount.secret || undefined, envValue: accountId === DEFAULT_ACCOUNT_ID ? process.env.NEXTCLOUD_TALK_BOT_SECRET?.trim() || undefined : undefined, }; }, applyUseEnv: async (params) => { const resolvedAccount = resolveNextcloudTalkAccount({ cfg: params.cfg as CoreConfig, accountId: params.accountId, }); const cleared = clearNextcloudTalkAccountFields( params.cfg as CoreConfig, params.accountId, ["botSecret", "botSecretFile"], ); return setNextcloudTalkAccountConfig(cleared, params.accountId, { baseUrl: resolvedAccount.baseUrl, }); }, applySet: async (params) => setNextcloudTalkAccountConfig( clearNextcloudTalkAccountFields(params.cfg as CoreConfig, params.accountId, [ "botSecret", "botSecretFile", ]), params.accountId, { botSecret: params.value, }, ), }, { inputKey: "password", providerHint: "nextcloud-talk-api", credentialLabel: "API password", preferredEnvVar: "NEXTCLOUD_TALK_API_PASSWORD", envPrompt: "", keepPrompt: "Nextcloud Talk API password already configured. Keep it?", inputPrompt: "Enter Nextcloud Talk API password", inspect: ({ cfg, accountId }) => { const resolvedAccount = resolveNextcloudTalkAccount({ cfg: cfg as CoreConfig, accountId }); const apiUser = resolvedAccount.config.apiUser?.trim(); const apiPasswordConfigured = Boolean( hasConfiguredSecretInput(resolvedAccount.config.apiPassword) || resolvedAccount.config.apiPasswordFile, ); return { accountConfigured: Boolean(apiUser && apiPasswordConfigured), hasConfiguredValue: apiPasswordConfigured, }; }, shouldPrompt: ({ credentialValues }) => credentialValues[CONFIGURE_API_FLAG] === "1", applySet: async (params) => setNextcloudTalkAccountConfig( clearNextcloudTalkAccountFields(params.cfg as CoreConfig, params.accountId, [ "apiPassword", "apiPasswordFile", ]), params.accountId, { apiPassword: params.value, }, ), }, ], textInputs: [ { inputKey: "httpUrl", message: "Enter Nextcloud instance URL (e.g., https://cloud.example.com)", currentValue: ({ cfg, accountId }) => resolveNextcloudTalkAccount({ cfg: cfg as CoreConfig, accountId }).baseUrl || undefined, shouldPrompt: ({ currentValue }) => !currentValue, validate: ({ value }) => validateNextcloudTalkBaseUrl(value), normalizeValue: ({ value }) => normalizeNextcloudTalkBaseUrl(value), applySet: async (params) => setNextcloudTalkAccountConfig(params.cfg as CoreConfig, params.accountId, { baseUrl: params.value, }), }, { inputKey: "userId", message: "Nextcloud Talk API user", currentValue: ({ cfg, accountId }) => resolveNextcloudTalkAccount({ cfg: cfg as CoreConfig, accountId }).config.apiUser?.trim() || undefined, shouldPrompt: ({ credentialValues }) => credentialValues[CONFIGURE_API_FLAG] === "1", validate: ({ value }) => (value ? undefined : "Required"), applySet: async (params) => setNextcloudTalkAccountConfig(params.cfg as CoreConfig, params.accountId, { apiUser: params.value, }), }, ], dmPolicy: nextcloudTalkDmPolicy, disable: (cfg) => setOnboardingChannelEnabled(cfg, channel, false), };