@pwddd/skills-scanner 1.0.3

package/src/commands.ts

@@ -0,0 +1,302 @@
+/**
+ * Command handlers module
+ */
+
+import { existsSync, execSync } from "node:fs";
+import { join, basename } from "node:path";
+import { promisify } from "node:util";
+import { exec } from "node:child_process";
+import { runScan } from "./scanner.js";
+import { buildDailyReport } from "./report.js";
+import { loadState, saveState, expandPath } from "./state.js";
+import { isVenvReady } from "./deps.js";
+import { generateConfigGuide } from "./config.js";
+import { ensureCronJob } from "./cron.js";
+import type { ScannerConfig } from "./types.js";
+
+const execAsync = promisify(exec);
+
+export function createCommandHandlers(
+  cfg: ScannerConfig,
+  apiUrl: string,
+  scanDirs: string[],
+  behavioral: boolean,
+  useLLM: boolean,
+  policy: string,
+  preInstallScan: string,
+  onUnsafe: string,
+  venvPython: string,
+  scanScript: string,
+  logger: any
+) {
+  async function handleScanCommand(args: string): Promise<any> {
+    if (!args) {
+      return {
+        text: "用法：`/skills-scanner scan <路径> [--detailed] [--behavioral] [--recursive] [--report]`\n或：`/skills-scanner scan clawhub <URL> [--detailed] [--behavioral]`",
+      };
+    }
+
+    if (!isVenvReady(venvPython)) {
+      return { text: "⏳ Python 依赖尚未就绪，请稍后重试或查看日志" };
+    }
+
+    const parts = args.split(/\s+/);
+    
+    // Check if this is a ClawHub scan
+    if (parts[0] === "clawhub") {
+      const clawhubUrl = parts.find((p) => p.startsWith("https://clawhub.ai/"));
+      if (!clawhubUrl) {
+        return { text: "❌ 请提供有效的 ClawHub URL (例如: https://clawhub.ai/username/project)" };
+      }
+
+      const detailed = parts.includes("--detailed");
+      const useBehav = parts.includes("--behavioral") || behavioral;
+
+      const res = await runScan(venvPython, scanScript, "clawhub", clawhubUrl, {
+        detailed,
+        behavioral: useBehav,
+        apiUrl,
+        useLLM,
+        policy,
+      });
+      const icon = res.exitCode === 0 ? "✅" : "❌";
+      return { text: `${icon} ClawHub 扫描完成\n\`\`\`\n${res.output}\n\`\`\`` };
+    }
+
+    const targetPath = expandPath(parts.find((p) => !p.startsWith("--")) ?? "");
+    const detailed = parts.includes("--detailed");
+    const useBehav = parts.includes("--behavioral") || behavioral;
+    const recursive = parts.includes("--recursive");
+    const isReport = parts.includes("--report");
+
+    if (!targetPath) {
+      return { text: "❌ 请指定扫描路径" };
+    }
+
+    if (!existsSync(targetPath)) {
+      return { text: `❌ 路径不存在: ${targetPath}` };
+    }
+
+    const isSingleSkill = existsSync(join(targetPath, "SKILL.md"));
+
+    if (isReport) {
+      if (scanDirs.length === 0) {
+        return { text: "⚠️ 未找到可扫描目录，请检查配置" };
+      }
+      const report = await buildDailyReport(
+        scanDirs,
+        useBehav,
+        apiUrl,
+        useLLM,
+        policy,
+        logger,
+        venvPython,
+        scanScript
+      );
+      return { text: report };
+    } else if (isSingleSkill) {
+      const res = await runScan(venvPython, scanScript, "scan", targetPath, {
+        detailed,
+        behavioral: useBehav,
+        apiUrl,
+        useLLM,
+        policy,
+      });
+      const icon = res.exitCode === 0 ? "✅" : "❌";
+      return { text: `${icon} 扫描完成\n\`\`\`\n${res.output}\n\`\`\`` };
+    } else {
+      const res = await runScan(venvPython, scanScript, "batch", targetPath, {
+        recursive,
+        detailed,
+        behavioral: useBehav,
+        apiUrl,
+        useLLM,
+        policy,
+      });
+      const icon = res.exitCode === 0 ? "✅" : "❌";
+      return { text: `${icon} 批量扫描完成\n\`\`\`\n${res.output}\n\`\`\`` };
+    }
+  }
+
+  async function handleStatusCommand(): Promise<any> {
+    const state = loadState() as any;
+    const alerts: string[] = state.pendingAlerts ?? [];
+
+    const lines = [
+      "📋 *Skills Scanner 状态*",
+      `API 地址: ${apiUrl}`,
+      `Python 依赖: ${isVenvReady(venvPython) ? "✅ 就绪" : "❌ 未就绪"}`,
+      `安装前扫描: ${preInstallScan === "on" ? `✅ 监听中 (${onUnsafe})` : "❌ 已禁用"}`,
+      `扫描策略: ${policy}`,
+      `LLM 分析: ${useLLM ? "✅ 启用" : "❌ 禁用"}`,
+      `行为分析: ${behavioral ? "✅ 启用" : "❌ 禁用"}`,
+      `上次扫描: ${state.lastScanAt ? new Date(state.lastScanAt).toLocaleString("zh-CN") : "从未"}`,
+      `扫描目录:\n${scanDirs.map((d) => `  • ${d}`).join("\n")}`,
+    ];
+
+    if (isVenvReady(venvPython)) {
+      lines.push("", "🔍 *API 服务检查*");
+      try {
+        const cmd = `"${venvPython}" "${scanScript}" --api-url "${apiUrl}" health`;
+        const env = { ...process.env };
+        delete env.http_proxy;
+        delete env.https_proxy;
+        delete env.HTTP_PROXY;
+        delete env.HTTPS_PROXY;
+        delete env.all_proxy;
+        delete env.ALL_PROXY;
+
+        const { stdout, stderr } = await execAsync(cmd, { timeout: 5000, env });
+        const output = (stdout + stderr).trim();
+
+        if (output.includes("✓") || output.includes("OK")) {
+          lines.push(`API 服务: ✅ 正常`);
+          const jsonMatch = output.match(/\{[\s\S]*\}/);
+          if (jsonMatch) {
+            try {
+              const healthData = JSON.parse(jsonMatch[0]);
+              if (healthData.analyzers_available) {
+                lines.push(`可用分析器: ${healthData.analyzers_available.join(", ")}`);
+              }
+            } catch {}
+          }
+        } else {
+          lines.push(`API 服务: ❌ 不可用`);
+        }
+      } catch (err: any) {
+        lines.push(`API 服务: ❌ 连接失败`);
+        lines.push(`错误: ${err.message}`);
+      }
+    }
+
+    if (alerts.length > 0) {
+      lines.push("", `🔔 *待查告警 (${alerts.length} 条):*`);
+      alerts.slice(-5).forEach((a) => lines.push(`  ${a}`));
+      saveState({ ...state, pendingAlerts: [] });
+    }
+
+    lines.push("", "🕐 *定时任务*");
+    if (state.cronJobId && state.cronJobId !== "manual-created") {
+      lines.push(`状态: ✅ 已注册 (${state.cronJobId})`);
+    } else {
+      lines.push("状态: ❌ 未注册");
+      lines.push("💡 使用 `/skills-scanner cron register` 注册");
+    }
+
+    return { text: lines.join("\n") };
+  }
+
+  async function handleConfigCommand(args: string): Promise<any> {
+    const action = args.trim().toLowerCase() || "show";
+
+    if (action === "show" || action === "") {
+      const configGuide = generateConfigGuide(
+        cfg,
+        apiUrl,
+        scanDirs,
+        behavioral,
+        useLLM,
+        policy,
+        preInstallScan,
+        onUnsafe
+      );
+      return { text: "```\n" + configGuide + "\n```" };
+    } else if (action === "reset") {
+      const state = loadState() as any;
+      saveState({ ...state, configReviewed: false });
+      return {
+        text: "✅ 配置审查标记已重置\n下次重启 Gateway 时将再次显示配置向导",
+      };
+    } else {
+      return { text: "用法: `/skills-scanner config [show|reset]`" };
+    }
+  }
+
+  async function handleCronCommand(args: string): Promise<any> {
+    const action = args.trim().toLowerCase() || "status";
+    const state = loadState() as any;
+
+    if (action === "register") {
+      const oldJobId = state.cronJobId;
+      if (oldJobId && oldJobId !== "manual-created") {
+        try {
+          execSync(`openclaw cron remove ${oldJobId}`, { encoding: "utf-8", timeout: 5000 });
+        } catch {}
+      }
+
+      saveState({ ...state, cronJobId: undefined });
+      await ensureCronJob(logger);
+
+      const newState = loadState() as any;
+      if (newState.cronJobId) {
+        return { text: `✅ 定时任务注册成功\n任务 ID: ${newState.cronJobId}` };
+      } else {
+        return { text: "❌ 定时任务注册失败，请查看日志" };
+      }
+    } else if (action === "unregister") {
+      if (!state.cronJobId) {
+        return { text: "⚠️ 未找到已注册的定时任务" };
+      }
+
+      try {
+        execSync(`openclaw cron remove ${state.cronJobId}`, {
+          encoding: "utf-8",
+          timeout: 5000,
+        });
+        saveState({ ...state, cronJobId: undefined });
+        return { text: `✅ 定时任务已删除: ${state.cronJobId}` };
+      } catch (err: any) {
+        return { text: `❌ 删除失败: ${err.message}` };
+      }
+    } else {
+      const lines = ["🕐 *定时任务状态*"];
+      if (state.cronJobId && state.cronJobId !== "manual-created") {
+        lines.push(`任务 ID: ${state.cronJobId}`);
+        lines.push(`执行时间: 每天 08:00 (Asia/Shanghai)`);
+        lines.push("状态: ✅ 已注册");
+      } else {
+        lines.push("状态: ❌ 未注册");
+        lines.push("", "💡 使用 `/skills-scanner cron register` 注册");
+      }
+      return { text: lines.join("\n") };
+    }
+  }
+
+  function getHelpText(): string {
+    return [
+      "🔍 *Skills Scanner - 帮助*",
+      "",
+      "═══ 扫描命令 ═══",
+      "`/skills-scanner scan <路径> [选项]`",
+      "`/skills-scanner scan clawhub <URL> [选项]`",
+      "",
+      "选项:",
+      "• `--detailed` - 显示详细发现",
+      "• `--behavioral` - 启用行为分析",
+      "• `--recursive` - 递归扫描子目录",
+      "• `--report` - 生成日报格式",
+      "",
+      "示例:",
+      "```",
+      "/skills-scanner scan ~/.openclaw/skills/my-skill",
+      "/skills-scanner scan ~/.openclaw/skills --recursive",
+      "/skills-scanner scan ~/.openclaw/skills --report",
+      "/skills-scanner scan clawhub https://clawhub.ai/username/project",
+      "/skills-scanner scan clawhub https://clawhub.ai/username/project --detailed",
+      "```",
+      "",
+      "═══ 其他命令 ═══",
+      "• `/skills-scanner status` - 查看状态",
+      "• `/skills-scanner config [show|reset]` - 配置管理",
+      "• `/skills-scanner cron [register|unregister|status]` - 定时任务管理",
+    ].join("\n");
+  }
+
+  return {
+    handleScanCommand,
+    handleStatusCommand,
+    handleConfigCommand,
+    handleCronCommand,
+    getHelpText,
+  };
+}

package/src/config.ts

@@ -0,0 +1,170 @@
+/**
+ * 配置管理模块
+ */
+
+import { Type } from "@sinclair/typebox";
+import type { OpenClawPluginConfigSchema } from "openclaw/plugin-sdk";
+import type { ScannerConfig } from "./types.js";
+
+export const skillsScannerConfigSchema: OpenClawPluginConfigSchema = {
+  safeParse: (value: unknown) => {
+    try {
+      const config = value as ScannerConfig;
+      
+      // 验证 policy
+      if (config.policy && !["strict", "balanced", "permissive"].includes(config.policy)) {
+        return {
+          success: false,
+          error: {
+            issues: [{
+              path: ["policy"],
+              message: "policy 必须是 strict、balanced 或 permissive"
+            }]
+          }
+        };
+      }
+      
+      // 验证 preInstallScan
+      if (config.preInstallScan && !["on", "off"].includes(config.preInstallScan)) {
+        return {
+          success: false,
+          error: {
+            issues: [{
+              path: ["preInstallScan"],
+              message: "preInstallScan 必须是 on 或 off"
+            }]
+          }
+        };
+      }
+      
+      // 验证 onUnsafe
+      if (config.onUnsafe && !["quarantine", "delete", "warn"].includes(config.onUnsafe)) {
+        return {
+          success: false,
+          error: {
+            issues: [{
+              path: ["onUnsafe"],
+              message: "onUnsafe 必须是 quarantine、delete 或 warn"
+            }]
+          }
+        };
+      }
+      
+      return { success: true, data: config };
+    } catch (err) {
+      return {
+        success: false,
+        error: {
+          issues: [{
+            path: [],
+            message: String(err)
+          }]
+        }
+      };
+    }
+  },
+  
+  uiHints: {
+    apiUrl: {
+      label: "API 服务地址",
+      help: "扫描 API 服务的 URL 地址",
+      placeholder: "http://localhost:8000"
+    },
+    scanDirs: {
+      label: "扫描目录",
+      help: "要监控的 Skills 目录列表，支持 ~ 路径"
+    },
+    behavioral: {
+      label: "行为分析",
+      help: "启用深度行为分析（较慢但更准确）"
+    },
+    useLLM: {
+      label: "LLM 分析",
+      help: "使用 LLM 进行语义分析"
+    },
+    policy: {
+      label: "扫描策略",
+      help: "strict=严格 / balanced=平衡（推荐）/ permissive=宽松"
+    },
+    preInstallScan: {
+      label: "安装前扫描",
+      help: "监听新 Skill 并自动扫描"
+    },
+    onUnsafe: {
+      label: "不安全处理",
+      help: "quarantine=隔离（推荐）/ delete=删除 / warn=仅警告"
+    }
+  }
+};
+
+export function generateConfigGuide(
+  cfg: ScannerConfig,
+  apiUrl: string,
+  scanDirs: string[],
+  behavioral: boolean,
+  useLLM: boolean,
+  policy: string,
+  preInstallScan: string,
+  onUnsafe: string
+): string {
+  return [
+    "",
+    "╔════════════════════════════════════════════════════════════════╗",
+    "║  🎉 Skills Scanner 首次运行 - 配置向导                         ║",
+    "╚════════════════════════════════════════════════════════════════╝",
+    "",
+    "当前使用默认配置。建议根据您的需求自定义配置：",
+    "",
+    "📋 当前配置：",
+    `  • API 服务地址: ${apiUrl}`,
+    `  • 扫描目录: ${scanDirs.length} 个（自动检测）`,
+    `  • 行为分析: ${behavioral ? "✅ 启用" : "❌ 禁用"}`,
+    `  • LLM 分析: ${useLLM ? "✅ 启用" : "❌ 禁用"}`,
+    `  • 扫描策略: ${policy}`,
+    `  • 安装前扫描: ${preInstallScan === "on" ? "✅ 启用" : "❌ 禁用"}`,
+    `  • 不安全处理: ${onUnsafe}`,
+    "",
+    "🔧 配置文件位置：",
+    "  ~/.openclaw/config.json",
+    "",
+    "📝 推荐配置示例：",
+    "",
+    "```json",
+    "{",
+    '  "plugins": {',
+    '    "entries": {',
+    '      "skills-scanner": {',
+    '        "enabled": true,',
+    '        "config": {',
+    '          "apiUrl": "http://localhost:8000",',
+    '          "scanDirs": ["~/.openclaw/skills"],',
+    '          "behavioral": false,',
+    '          "useLLM": false,',
+    '          "policy": "balanced",',
+    '          "preInstallScan": "on",',
+    '          "onUnsafe": "quarantine"',
+    '        }',
+    '      }',
+    '    }',
+    '  }',
+    "}",
+    "```",
+    "",
+    "💡 配置说明：",
+    "",
+    "1. apiUrl        默认 http://localhost:8000，需先启动 skill-scanner-api 服务",
+    "2. scanDirs      可添加多个目录（默认自动检测 ~/.openclaw/skills）",
+    "3. behavioral    false=快速扫描（推荐），true=深度分析",
+    "4. useLLM        false=不使用 LLM（推荐），true=语义分析",
+    "5. policy        strict / balanced（推荐）/ permissive",
+    "6. preInstallScan on=监听新 Skill 并自动扫描（推荐），off=禁用",
+    "7. onUnsafe      quarantine=隔离（推荐），delete=删除，warn=仅警告",
+    "",
+    "🚀 快速开始：",
+    "  编辑配置文件后重启 Gateway",
+    "  /skills-scanner status",
+    "",
+    "提示：此消息只在首次运行时显示。",
+    "════════════════════════════════════════════════════════════════",
+  ].join("\n");
+}

package/src/cron.ts

@@ -0,0 +1,174 @@
+/**
+ * Cron job management module
+ */
+
+import { execSync } from "node:child_process";
+import { loadState, saveState } from "./state.js";
+
+const CRON_JOB_NAME = "skills-daily-report";
+const CRON_SCHEDULE = "0 8 * * *";
+const CRON_TIMEZONE = "Asia/Shanghai";
+
+export async function ensureCronJob(logger: any): Promise<void> {
+  const state = loadState() as any;
+
+  logger.info("[skills-scanner] ─────────────────────────────────────");
+  logger.info("[skills-scanner] 🕐 Checking cron job...");
+
+  try {
+    let jobs: any[] = [];
+    try {
+      const listResult = execSync("openclaw cron list --format json", {
+        encoding: "utf-8",
+        timeout: 5000,
+      });
+      jobs = JSON.parse(listResult.trim());
+    } catch (listErr: any) {
+      logger.debug("[skills-scanner] JSON format not supported, trying text parsing");
+      try {
+        const listResult = execSync("openclaw cron list", {
+          encoding: "utf-8",
+          timeout: 5000,
+        });
+        if (listResult.includes(CRON_JOB_NAME)) {
+          logger.info(`[skills-scanner] ✅ Found existing job: ${CRON_JOB_NAME}`);
+          if (!state.cronJobId) {
+            saveState({ ...state, cronJobId: "manual-created" });
+          }
+          return;
+        }
+      } catch {
+        logger.debug("[skills-scanner] Cannot list cron jobs, may be permission issue");
+      }
+    }
+
+    // Find all jobs with the same name (to detect duplicates)
+    const existingJobs = jobs.filter(
+      (j: any) =>
+        j.name === CRON_JOB_NAME ||
+        j.jobName === CRON_JOB_NAME
+    );
+
+    // If multiple jobs exist with the same name, remove duplicates
+    if (existingJobs.length > 1) {
+      logger.warn(`[skills-scanner] ⚠️  Found ${existingJobs.length} duplicate jobs, cleaning up...`);
+      
+      // Keep the first one, remove the rest
+      for (let i = 1; i < existingJobs.length; i++) {
+        const jobId = existingJobs[i].id || existingJobs[i].jobId;
+        try {
+          execSync(`openclaw cron remove ${jobId}`, {
+            encoding: "utf-8",
+            timeout: 5000,
+          });
+          logger.info(`[skills-scanner] ✅ Removed duplicate job: ${jobId}`);
+        } catch (removeErr: any) {
+          logger.warn(`[skills-scanner] ⚠️  Failed to remove duplicate job ${jobId}: ${removeErr.message}`);
+        }
+      }
+    }
+
+    // Check if we have an existing job (after cleanup)
+    const existingJob = existingJobs.length > 0 ? existingJobs[0] : 
+                        jobs.find((j: any) => j.id === state.cronJobId);
+
+    if (existingJob) {
+      const jobId = existingJob.id || existingJob.jobId || state.cronJobId;
+
+      const needsUpdate =
+        existingJob.schedule !== CRON_SCHEDULE ||
+        existingJob.timezone !== CRON_TIMEZONE;
+
+      if (needsUpdate) {
+        logger.info(`[skills-scanner] 🔄 Job config changed, updating...`);
+        try {
+          execSync(`openclaw cron remove ${jobId}`, {
+            encoding: "utf-8",
+            timeout: 5000,
+          });
+          logger.info(`[skills-scanner] ✅ Removed old job: ${jobId}`);
+        } catch (removeErr: any) {
+          logger.warn(`[skills-scanner] ⚠️  Failed to remove old job: ${removeErr.message}`);
+          if (state.cronJobId !== jobId) {
+            saveState({ ...state, cronJobId: jobId });
+          }
+          logger.info(`[skills-scanner] ✅ Keeping existing job: ${jobId}`);
+          return;
+        }
+      } else {
+        if (state.cronJobId !== jobId) {
+          saveState({ ...state, cronJobId: jobId });
+          logger.info(`[skills-scanner] ✅ Found existing job: ${jobId}`);
+        } else {
+          logger.info(`[skills-scanner] ✅ Job already exists: ${jobId}`);
+        }
+        return;
+      }
+    }
+
+    logger.info("[skills-scanner] 📝 Creating cron job...");
+
+    // Create cron job with --announce and --channel last
+    // This will deliver to the last place the agent replied
+    const cronCmd = [
+      "openclaw cron add",
+      `--name "${CRON_JOB_NAME}"`,
+      `--cron "${CRON_SCHEDULE}"`,
+      `--tz "${CRON_TIMEZONE}"`,
+      "--session isolated",
+      '--message "Please run /skills-scanner scan --report and send results to this channel"',
+      "--announce",
+      "--channel last",
+    ].join(" ");
+
+    const result = execSync(cronCmd, { encoding: "utf-8", timeout: 10000 });
+
+    const jobIdMatch =
+      result.match(/Job ID[:\s]+([a-zA-Z0-9-]+)/i) ||
+      result.match(/jobId[:\s]+([a-zA-Z0-9-]+)/i) ||
+      result.match(/id[:\s]+([a-zA-Z0-9-]+)/i);
+
+    if (jobIdMatch) {
+      const cronJobId = jobIdMatch[1];
+      saveState({ ...state, cronJobId });
+      logger.info(`[skills-scanner] ✅ Job created successfully: ${cronJobId}`);
+      logger.info(
+        `[skills-scanner] 📅 Schedule: Daily at ${CRON_SCHEDULE.split(" ")[1]}:${CRON_SCHEDULE.split(" ")[0]} (${CRON_TIMEZONE})`
+      );
+      logger.info("[skills-scanner] 📬 Reports will be delivered to the last active channel");
+    } else {
+      logger.info("[skills-scanner] ✅ Job creation command executed");
+      logger.debug(`[skills-scanner] Output: ${result.trim()}`);
+      saveState({ ...state, cronJobId: "created-unknown-id" });
+    }
+  } catch (err: any) {
+    logger.warn("[skills-scanner] ⚠️  Auto-registration failed");
+    logger.debug(`[skills-scanner] Error details: ${err.message}`);
+
+    if (err.message.includes("permission") || err.message.includes("EACCES")) {
+      logger.error("[skills-scanner] ❌ Permission denied, please run with admin privileges");
+    } else if (
+      err.message.includes("command not found") ||
+      err.message.includes("ENOENT")
+    ) {
+      logger.error("[skills-scanner] ❌ openclaw command not found, please check installation");
+    } else {
+      logger.info("[skills-scanner] 💡 Please manually register cron job:");
+      logger.info("[skills-scanner]");
+      logger.info("[skills-scanner]   openclaw cron add \\");
+      logger.info(`[skills-scanner]     --name "${CRON_JOB_NAME}" \\`);
+      logger.info(`[skills-scanner]     --cron "${CRON_SCHEDULE}" \\`);
+      logger.info(`[skills-scanner]     --tz "${CRON_TIMEZONE}" \\`);
+      logger.info("[skills-scanner]     --session isolated \\");
+      logger.info(
+        '[skills-scanner]     --message "Please run /skills-scanner scan --report and send results to this channel" \\'
+      );
+      logger.info("[skills-scanner]     --announce \\");
+      logger.info("[skills-scanner]     --channel last");
+      logger.info("[skills-scanner]");
+      logger.info("[skills-scanner] 💡 Or specify a target channel:");
+      logger.info("[skills-scanner]     --channel feishu --target chat:<chatId>");
+      logger.info("[skills-scanner]");
+    }
+  }
+}