@leoqlin/openclaw-qqbot 1.6.7-alpha1

package/bin/qqbot-cli.js

@@ -0,0 +1,243 @@
+#!/usr/bin/env node
+
+/**
+ * qqbot CLI - 用于升级和管理 qqbot 插件
+ * 
+ * 用法:
+ *   npx openclaw-qqbot upgrade    # 升级插件
+ *   npx openclaw-qqbot install    # 安装插件
+ */
+
+import { execSync } from 'child_process';
+import { existsSync, readFileSync, writeFileSync, rmSync } from 'fs';
+import { homedir } from 'os';
+import { join, dirname } from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+// 获取包的根目录
+const PKG_ROOT = join(__dirname, '..');
+
+const args = process.argv.slice(2);
+const command = args[0];
+
+// 检测使用的是 clawdbot 还是 openclaw
+function detectInstallation() {
+  const home = homedir();
+  if (existsSync(join(home, '.openclaw'))) {
+    return 'openclaw';
+  }
+  if (existsSync(join(home, '.clawdbot'))) {
+    return 'clawdbot';
+  }
+  return null;
+}
+
+// 需要清理的所有可能的插件 ID / 包名（原仓库 + 本仓库 + 框架推断名）
+const PLUGIN_IDS = ['qqbot', 'openclaw-qq', '@sliverp/qqbot', '@tencent-connect/openclaw-qq', '@tencent-connect/qqbot', '@tencent-connect/openclaw-qqbot', 'openclaw-qqbot'];
+// 可能的扩展目录名
+const EXTENSION_DIR_NAMES = ['qqbot', 'openclaw-qq', 'openclaw-qqbot'];
+
+// 清理旧版本插件，返回旧的 qqbot 配置
+function cleanupInstallation(appName) {
+  const home = homedir();
+  const appDir = join(home, `.${appName}`);
+  const configFile = join(appDir, `${appName}.json`);
+
+  let oldQqbotConfig = null;
+
+  console.log(`\n>>> 处理 ${appName} 安装...`);
+
+  // 1. 先读取旧的 qqbot 配置（尝试所有可能的 channel key）
+  if (existsSync(configFile)) {
+    try {
+      const config = JSON.parse(readFileSync(configFile, 'utf8'));
+      if (config.channels?.qqbot) {
+        oldQqbotConfig = { ...config.channels.qqbot };
+        console.log('已保存旧的 qqbot 配置');
+      }
+    } catch (err) {
+      console.error('读取配置文件失败:', err.message);
+    }
+  }
+
+  // 2. 删除所有可能的旧扩展目录
+  for (const dirName of EXTENSION_DIR_NAMES) {
+    const extensionDir = join(appDir, 'extensions', dirName);
+    if (existsSync(extensionDir)) {
+      console.log(`删除旧版本插件: ${extensionDir}`);
+      rmSync(extensionDir, { recursive: true, force: true });
+    }
+  }
+
+  // 3. 清理配置文件中所有可能的插件 ID 相关字段
+  if (existsSync(configFile)) {
+    console.log('清理配置文件中的插件字段...');
+    try {
+      const config = JSON.parse(readFileSync(configFile, 'utf8'));
+
+      for (const id of PLUGIN_IDS) {
+        // 删除 channels.<id>
+        if (config.channels?.[id]) {
+          delete config.channels[id];
+          console.log(`  - 已删除 channels.${id}`);
+        }
+
+        // 删除 plugins.entries.<id>
+        if (config.plugins?.entries?.[id]) {
+          delete config.plugins.entries[id];
+          console.log(`  - 已删除 plugins.entries.${id}`);
+        }
+
+        // 删除 plugins.installs.<id>
+        if (config.plugins?.installs?.[id]) {
+          delete config.plugins.installs[id];
+          console.log(`  - 已删除 plugins.installs.${id}`);
+        }
+
+        // 删除 plugins.allow 中的 <id>
+        if (Array.isArray(config.plugins?.allow)) {
+          const before = config.plugins.allow.length;
+          config.plugins.allow = config.plugins.allow.filter((x) => x !== id);
+          if (config.plugins.allow.length !== before) {
+            console.log(`  - 已删除 plugins.allow.${id}`);
+          }
+        }
+      }
+
+      writeFileSync(configFile, JSON.stringify(config, null, 2));
+      console.log('配置文件已更新');
+    } catch (err) {
+      console.error('清理配置文件失败:', err.message);
+    }
+  } else {
+    console.log(`未找到配置文件: ${configFile}`);
+  }
+
+  return oldQqbotConfig;
+}
+
+// 执行命令并继承 stdio
+function runCommand(cmd, args = []) {
+  try {
+    execSync([cmd, ...args].join(' '), { stdio: 'inherit' });
+    return true;
+  } catch (err) {
+    return false;
+  }
+}
+
+// 升级命令
+function upgrade() {
+  console.log('=== qqbot 插件升级脚本 ===');
+
+  let foundInstallation = null;
+  let savedConfig = null;
+  const home = homedir();
+
+  // 检查 openclaw
+  if (existsSync(join(home, '.openclaw'))) {
+    savedConfig = cleanupInstallation('openclaw');
+    foundInstallation = 'openclaw';
+  }
+
+  // 检查 clawdbot
+  if (existsSync(join(home, '.clawdbot'))) {
+    const clawdbotConfig = cleanupInstallation('clawdbot');
+    if (!savedConfig) savedConfig = clawdbotConfig;
+    foundInstallation = 'clawdbot';
+  }
+
+  if (!foundInstallation) {
+    console.log('\n未找到 clawdbot 或 openclaw 安装目录');
+    console.log('请确认已安装 clawdbot 或 openclaw');
+    process.exit(1);
+  }
+
+  console.log('\n=== 清理完成 ===');
+
+  // 自动安装插件
+  console.log('\n[1/2] 安装新版本插件...');
+  runCommand(foundInstallation, ['plugins', 'install', 'openclaw-qqbot']);
+
+  // 自动配置通道（使用保存的 appId 和 clientSecret）
+  console.log('\n[2/2] 配置机器人通道...');
+  if (savedConfig?.appId && savedConfig?.clientSecret) {
+    const token = `${savedConfig.appId}:${savedConfig.clientSecret}`;
+    console.log(`使用已保存的配置: appId=${savedConfig.appId}`);
+    runCommand(foundInstallation, ['channels', 'add', '--channel', 'qqbot', '--token', `"${token}"`]);
+    
+    // 恢复其他配置项（如 markdownSupport）
+    if (savedConfig.markdownSupport !== undefined) {
+      runCommand(foundInstallation, ['config', 'set', 'channels.qqbot.markdownSupport', String(savedConfig.markdownSupport)]);
+    }
+  } else {
+    console.log('未找到已保存的 qqbot 配置，请手动配置:');
+    console.log(`  ${foundInstallation} channels add --channel qqbot --token "appid:appsecret"`);
+    return;
+  }
+
+  console.log('\n=== 升级完成 ===');
+  console.log(`\n可以运行以下命令前台运行启动机器人:`);
+  console.log(`  ${foundInstallation} gateway  stop && ${foundInstallation} gateway --port 18789 --verbose`);
+}
+
+// 安装命令
+function install() {
+  console.log('=== qqbot 插件安装 ===');
+
+  const cmd = detectInstallation();
+  if (!cmd) {
+    console.log('未找到 clawdbot 或 openclaw 安装');
+    console.log('请先安装 openclaw 或 clawdbot');
+    process.exit(1);
+  }
+
+  console.log(`\n使用 ${cmd} 安装插件...`);
+  runCommand(cmd, ['plugins', 'install', '@tencent-connect/openclaw-qqbot']);
+
+  console.log('\n=== 安装完成 ===');
+  console.log('\n请配置机器人通道:');
+  console.log(`  ${cmd} channels add --channel qqbot --token "appid:appsecret"`);
+}
+
+// 显示帮助
+function showHelp() {
+  console.log(`
+qqbot CLI - QQ机器人插件管理工具
+
+用法:
+  npx openclaw-qqbot <命令>
+
+命令:
+  upgrade       清理旧版本插件（升级前执行）
+  install       安装插件到 openclaw/clawdbot
+
+示例:
+  npx openclaw-qqbot upgrade
+  npx openclaw-qqbot install
+`);
+}
+
+// 主入口
+switch (command) {
+  case 'upgrade':
+    upgrade();
+    break;
+  case 'install':
+    install();
+    break;
+  case '-h':
+  case '--help':
+  case 'help':
+    showHelp();
+    break;
+  default:
+    if (command) {
+      console.log(`未知命令: ${command}`);
+    }
+    showHelp();
+    process.exit(command ? 1 : 0);
+}

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+import type { OpenClawPluginApi } from "openclaw/plugin-sdk";
+declare const plugin: {
+    id: string;
+    name: string;
+    description: string;
+    configSchema: unknown;
+    register(api: OpenClawPluginApi): void;
+};
+export default plugin;
+export { qqbotPlugin } from "./src/channel.js";
+export { setQQBotRuntime, getQQBotRuntime } from "./src/runtime.js";
+export { qqbotOnboardingAdapter } from "./src/onboarding.js";
+export * from "./src/types.js";
+export * from "./src/api.js";
+export * from "./src/config.js";
+export * from "./src/gateway.js";
+export * from "./src/outbound.js";

package/dist/index.js

@@ -0,0 +1,26 @@
+import { emptyPluginConfigSchema } from "openclaw/plugin-sdk";
+import { qqbotPlugin } from "./src/channel.js";
+import { setQQBotRuntime } from "./src/runtime.js";
+import { registerChannelTool } from "./src/tools/channel.js";
+import { registerRemindTool } from "./src/tools/remind.js";
+const plugin = {
+    id: "openclaw-qqbot",
+    name: "QQ Bot",
+    description: "QQ Bot channel plugin",
+    configSchema: emptyPluginConfigSchema(),
+    register(api) {
+        setQQBotRuntime(api.runtime);
+        api.registerChannel({ plugin: qqbotPlugin });
+        registerChannelTool(api);
+        registerRemindTool(api);
+    },
+};
+export default plugin;
+export { qqbotPlugin } from "./src/channel.js";
+export { setQQBotRuntime, getQQBotRuntime } from "./src/runtime.js";
+export { qqbotOnboardingAdapter } from "./src/onboarding.js";
+export * from "./src/types.js";
+export * from "./src/api.js";
+export * from "./src/config.js";
+export * from "./src/gateway.js";
+export * from "./src/outbound.js";

package/dist/src/admin-resolver.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 管理员解析器模块
+ * - 管理员 openid 持久化读写
+ * - 升级问候目标读写
+ * - 启动问候语发送
+ */
+export interface AdminResolverContext {
+    accountId: string;
+    appId: string;
+    clientSecret: string;
+    log?: {
+        info: (msg: string) => void;
+        error: (msg: string) => void;
+    };
+}
+/**
+ * 读取 admin openid（按 accountId + appId 区分）
+ * 兼容策略：新路径优先 → fallback 旧路径 → 自动迁移
+ */
+export declare function loadAdminOpenId(accountId: string, appId: string): string | undefined;
+export declare function saveAdminOpenId(accountId: string, appId: string, openid: string): void;
+export declare function loadUpgradeGreetingTargetOpenId(accountId: string, appId: string, log?: {
+    info: (msg: string) => void;
+}): string | undefined;
+export declare function clearUpgradeGreetingTargetOpenId(accountId: string, appId: string): void;
+/**
+ * 解析管理员 openid：
+ * 1. 优先读持久化文件（按 accountId + appId 区分）
+ * 2. fallback 取第一个私聊用户，并写入文件锁定
+ */
+export declare function resolveAdminOpenId(ctx: Pick<AdminResolverContext, "accountId" | "appId" | "log">): string | undefined;
+/** 异步发送启动问候语（优先发给升级触发者，fallback 发给管理员） */
+export declare function sendStartupGreetings(ctx: AdminResolverContext, trigger: "READY" | "RESUMED"): void;

package/dist/src/admin-resolver.js

@@ -0,0 +1,157 @@
+/**
+ * 管理员解析器模块
+ * - 管理员 openid 持久化读写
+ * - 升级问候目标读写
+ * - 启动问候语发送
+ */
+import path from "node:path";
+import * as fs from "node:fs";
+import { getQQBotDataDir } from "./utils/platform.js";
+import { listKnownUsers } from "./known-users.js";
+import { getAccessToken, sendProactiveC2CMessage } from "./api.js";
+import { getStartupGreetingPlan, markStartupGreetingSent, markStartupGreetingFailed } from "./startup-greeting.js";
+// ---- 文件路径 ----
+function safeName(id) {
+    return id.replace(/[^a-zA-Z0-9._-]/g, "_");
+}
+/** 新版 admin 文件路径（按 accountId + appId 区分） */
+function getAdminMarkerFile(accountId, appId) {
+    return path.join(getQQBotDataDir("data"), `admin-${safeName(accountId)}-${safeName(appId)}.json`);
+}
+/** 旧版 admin 文件路径（仅按 accountId 区分，用于迁移兼容） */
+function getLegacyAdminMarkerFile(accountId) {
+    return path.join(getQQBotDataDir("data"), `admin-${accountId}.json`);
+}
+function getUpgradeGreetingTargetFile(accountId, appId) {
+    return path.join(getQQBotDataDir("data"), `upgrade-greeting-target-${safeName(accountId)}-${safeName(appId)}.json`);
+}
+// ---- 管理员 openid 持久化 ----
+/**
+ * 读取 admin openid（按 accountId + appId 区分）
+ * 兼容策略：新路径优先 → fallback 旧路径 → 自动迁移
+ */
+export function loadAdminOpenId(accountId, appId) {
+    try {
+        // 1. 先尝试新版路径
+        const newFile = getAdminMarkerFile(accountId, appId);
+        if (fs.existsSync(newFile)) {
+            const data = JSON.parse(fs.readFileSync(newFile, "utf8"));
+            if (data.openid)
+                return data.openid;
+        }
+        // 2. fallback 旧版路径（仅按 accountId）
+        const legacyFile = getLegacyAdminMarkerFile(accountId);
+        if (fs.existsSync(legacyFile)) {
+            const data = JSON.parse(fs.readFileSync(legacyFile, "utf8"));
+            if (data.openid) {
+                // 自动迁移：写到新路径，删除旧文件
+                saveAdminOpenId(accountId, appId, data.openid);
+                try {
+                    fs.unlinkSync(legacyFile);
+                }
+                catch { /* ignore */ }
+                return data.openid;
+            }
+        }
+    }
+    catch { /* 文件损坏视为无 */ }
+    return undefined;
+}
+export function saveAdminOpenId(accountId, appId, openid) {
+    try {
+        fs.writeFileSync(getAdminMarkerFile(accountId, appId), JSON.stringify({ accountId, appId, openid, savedAt: new Date().toISOString() }));
+    }
+    catch { /* ignore */ }
+}
+// ---- 升级问候目标 ----
+export function loadUpgradeGreetingTargetOpenId(accountId, appId, log) {
+    try {
+        const file = getUpgradeGreetingTargetFile(accountId, appId);
+        if (fs.existsSync(file)) {
+            const data = JSON.parse(fs.readFileSync(file, "utf8"));
+            if (!data.openid) {
+                log?.info(`[qqbot:${accountId}] upgrade-greeting-target file found but openid is empty`);
+                return undefined;
+            }
+            if (data.appId && data.appId !== appId) {
+                log?.info(`[qqbot:${accountId}] upgrade-greeting-target appId mismatch: file=${data.appId}, current=${appId}`);
+                return undefined;
+            }
+            if (data.accountId && data.accountId !== accountId) {
+                log?.info(`[qqbot:${accountId}] upgrade-greeting-target accountId mismatch: file=${data.accountId}, current=${accountId}`);
+                return undefined;
+            }
+            log?.info(`[qqbot:${accountId}] upgrade-greeting-target loaded: openid=${data.openid}`);
+            return data.openid;
+        }
+        else {
+            log?.info(`[qqbot:${accountId}] upgrade-greeting-target file not found: ${file}`);
+        }
+    }
+    catch (err) {
+        log?.info(`[qqbot:${accountId}] upgrade-greeting-target file read error: ${err}`);
+    }
+    return undefined;
+}
+export function clearUpgradeGreetingTargetOpenId(accountId, appId) {
+    try {
+        const file = getUpgradeGreetingTargetFile(accountId, appId);
+        if (fs.existsSync(file)) {
+            fs.unlinkSync(file);
+        }
+    }
+    catch { /* ignore */ }
+}
+// ---- 解析管理员 ----
+/**
+ * 解析管理员 openid：
+ * 1. 优先读持久化文件（按 accountId + appId 区分）
+ * 2. fallback 取第一个私聊用户，并写入文件锁定
+ */
+export function resolveAdminOpenId(ctx) {
+    const saved = loadAdminOpenId(ctx.accountId, ctx.appId);
+    if (saved)
+        return saved;
+    const first = listKnownUsers({ accountId: ctx.accountId, type: "c2c", sortBy: "firstSeenAt", sortOrder: "asc", limit: 1 })[0]?.openid;
+    if (first) {
+        saveAdminOpenId(ctx.accountId, ctx.appId, first);
+        ctx.log?.info(`[qqbot:${ctx.accountId}] Auto-detected admin openid: ${first} (persisted)`);
+    }
+    return first;
+}
+// ---- 启动问候语 ----
+/** 异步发送启动问候语（优先发给升级触发者，fallback 发给管理员） */
+export function sendStartupGreetings(ctx, trigger) {
+    (async () => {
+        const plan = getStartupGreetingPlan(ctx.accountId, ctx.appId);
+        if (!plan.shouldSend || !plan.greeting) {
+            ctx.log?.info(`[qqbot:${ctx.accountId}] Skipping startup greeting (${plan.reason ?? "debounced"}, trigger=${trigger})`);
+            return;
+        }
+        const upgradeTargetOpenId = loadUpgradeGreetingTargetOpenId(ctx.accountId, ctx.appId, ctx.log);
+        // 没有 upgrade-greeting-target 文件 → 不是通过 /bot-upgrade 触发的升级
+        // （console 手动重启、脚本升级等场景），静默更新 marker 不发消息
+        if (!upgradeTargetOpenId) {
+            markStartupGreetingSent(ctx.accountId, ctx.appId, plan.version);
+            ctx.log?.info(`[qqbot:${ctx.accountId}] Version changed but no upgrade-greeting-target, silently updating marker (trigger=${trigger})`);
+            return;
+        }
+        try {
+            ctx.log?.info(`[qqbot:${ctx.accountId}] Sending startup greeting to upgrade-requester (trigger=${trigger}): "${plan.greeting}"`);
+            const token = await getAccessToken(ctx.appId, ctx.clientSecret);
+            const GREETING_TIMEOUT_MS = 10_000;
+            await Promise.race([
+                sendProactiveC2CMessage(token, upgradeTargetOpenId, plan.greeting),
+                new Promise((_, reject) => setTimeout(() => reject(new Error("Startup greeting send timeout (10s)")), GREETING_TIMEOUT_MS)),
+            ]);
+            markStartupGreetingSent(ctx.accountId, ctx.appId, plan.version);
+            clearUpgradeGreetingTargetOpenId(ctx.accountId, ctx.appId);
+            ctx.log?.info(`[qqbot:${ctx.accountId}] Sent startup greeting to upgrade-requester: ${upgradeTargetOpenId}`);
+        }
+        catch (err) {
+            const message = err instanceof Error ? err.message : String(err);
+            markStartupGreetingFailed(ctx.accountId, ctx.appId, plan.version, message);
+            ctx.log?.error(`[qqbot:${ctx.accountId}] Failed to send startup greeting: ${message}`);
+        }
+    })();
+}