koishi-plugin-spawn-modified 1.1.10 → 1.1.12

package/lib/locales/zh-CN.yml

@@ -0,0 +1,11 @@
+commands:
+  exec:
+    description: 执行命令
+    messages:
+      expect-text: 请输入要运行的命令。
+      started: '[运行开始] {command}'
+      finished: |-
+        [运行完毕] {command}
+        {output}
+      blocked-command: 该命令已被禁止执行。
+      restricted-directory: 不允许切换到上级或其他目录。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koishi-plugin-spawn-modified",
-  "version": "1.1.10",
+  "version": "1.1.12",
   "description": "Run shell commands with Koishi",
   "keywords": [
     "bot",
@@ -51,15 +51,17 @@
     "fonts"
   ],
   "scripts": {
-    "build": "tsc -b",
+    "build": "tsc -b && node scripts/copy-locales.js",
     "clean": "rimraf lib",
-    "prepare": "npm run build"
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run clean && npm run build"
   },
   "devDependencies": {
     "@koishijs/plugin-help": "^2.4.3",
     "@koishijs/plugin-mock": "^2.6.5",
     "koishi": "^4.17.2",
-    "typescript": "^5.9.3"
+    "typescript": "^5.9.3",
+    "rimraf": "^5.0.5"
   },
   "peerDependencies": {
     "koishi": "^4.17.2"

package/src/index.ts

@@ -21,6 +21,9 @@ export interface Config {
   renderImage?: boolean
   blockedCommands?: string[]
   restrictDirectory?: boolean
+  authority?: number
+  commandFilterMode?: 'blacklist' | 'whitelist'
+  commandList?: string[]
 }
 
 export const Config: Schema<Config> = Schema.object({
@@ -31,6 +34,9 @@ export const Config: Schema<Config> = Schema.object({
   renderImage: Schema.boolean().description('是否将命令执行结果渲染为图片（需要安装 puppeteer 插件）。').default(false),
   blockedCommands: Schema.array(String).description('违禁命令列表（命令的开头部分）。').default([]),
   restrictDirectory: Schema.boolean().description('是否限制在当前目录及子目录内执行命令（禁止 cd 到上级或其他目录）。').default(false),
+  authority: Schema.number().description('exec 命令所需权限等级。').default(4),
+  commandFilterMode: Schema.union(['blacklist', 'whitelist']).description('命令过滤模式：blacklist/whitelist').default('blacklist'),
+  commandList: Schema.array(String).description('命令过滤列表，配合过滤模式使用（为空则不限制）。').default([]),
 })
 
 export interface State {
@@ -51,10 +57,12 @@ export const inject = {
 // 当前工作目录状态管理
 const sessionDirs = new Map<string, string>()
 
-// 验证命令是否被禁止
-function isCommandBlocked(command: string, blockedCommands: string[]): boolean {
+// 命令过滤：支持黑名单/白名单模式
+function isCommandBlocked(command: string, mode: 'blacklist' | 'whitelist', list: string[]): boolean {
+  if (!list?.length) return false
   const trimmedCommand = command.trim().toLowerCase()
-  return blockedCommands.some(blocked => trimmedCommand.startsWith(blocked.toLowerCase()))
+  const hit = list.some(entry => trimmedCommand.startsWith(entry.toLowerCase()))
+  return mode === 'blacklist' ? hit : !hit
 }
 
 // 解析 cd 命令并验证路径
@@ -219,14 +227,16 @@ function escapeHtml(text: string): string {
 export function apply(ctx: Context, config: Config) {
   ctx.i18n.define('zh-CN', require('./locales/zh-CN'))
 
-  ctx.command('exec <command:text>', { authority: 4 })
+  ctx.command('exec <command:text>', { authority: config.authority ?? 4 })
     .action(async ({ session }, command) => {
       if (!command) return session.text('.expect-text')
 
       command = h('', h.parse(command)).toString(true)
       
-      // 检查违禁命令
-      if (isCommandBlocked(command, config.blockedCommands)) {
+      // 检查命令过滤（黑/白名单）
+      const filterList = (config.commandList?.length ? config.commandList : config.blockedCommands) || []
+      const filterMode = config.commandFilterMode || 'blacklist'
+      if (isCommandBlocked(command, filterMode, filterList)) {
         return session.text('.blocked-command')
       }
       

package/src/locales/zh-CN.yml

@@ -2,7 +2,7 @@ commands:
   exec:
     description: 执行命令
     messages:
-      expect-input: 请输入要运行的命令。
+      expect-text: 请输入要运行的命令。
       started: '[运行开始] {command}'
       finished: |-
         [运行完毕] {command}

package/lib/index.d.ts

@@ -1,33 +0,0 @@
-import { Context, Schema } from 'koishi';
-declare module 'koishi' {
-    interface Context {
-        puppeteer?: {
-            page(): Promise<any>;
-        };
-    }
-}
-declare const encodings: readonly ["utf8", "utf16le", "latin1", "ucs2"];
-export interface Config {
-    root?: string;
-    shell?: string;
-    encoding?: typeof encodings[number];
-    timeout?: number;
-    renderImage?: boolean;
-    blockedCommands?: string[];
-    restrictDirectory?: boolean;
-}
-export declare const Config: Schema<Config>;
-export interface State {
-    command: string;
-    timeout: number;
-    output: string;
-    code?: number;
-    signal?: NodeJS.Signals;
-    timeUsed?: number;
-}
-export declare const name = "spawn";
-export declare const inject: {
-    optional: string[];
-};
-export declare function apply(ctx: Context, config: Config): void;
-export {};

package/lib/index.js

@@ -1,248 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.inject = exports.name = exports.Config = void 0;
-exports.apply = apply;
-const child_process_1 = require("child_process");
-const koishi_1 = require("koishi");
-const path_1 = __importDefault(require("path"));
-const url_1 = require("url");
-const encodings = ['utf8', 'utf16le', 'latin1', 'ucs2'];
-exports.Config = koishi_1.Schema.object({
-    root: koishi_1.Schema.string().description('工作路径。').default(''),
-    shell: koishi_1.Schema.string().description('运行命令的程序。'),
-    encoding: koishi_1.Schema.union(encodings).description('输出内容编码。').default('utf8'),
-    timeout: koishi_1.Schema.number().description('最长运行时间。').default(koishi_1.Time.minute),
-    renderImage: koishi_1.Schema.boolean().description('是否将命令执行结果渲染为图片（需要安装 puppeteer 插件）。').default(false),
-    blockedCommands: koishi_1.Schema.array(String).description('违禁命令列表（命令的开头部分）。').default([]),
-    restrictDirectory: koishi_1.Schema.boolean().description('是否限制在当前目录及子目录内执行命令（禁止 cd 到上级或其他目录）。').default(false),
-});
-exports.name = 'spawn';
-exports.inject = {
-    optional: ['puppeteer'],
-};
-// 当前工作目录状态管理
-const sessionDirs = new Map();
-// 验证命令是否被禁止
-function isCommandBlocked(command, blockedCommands) {
-    const trimmedCommand = command.trim().toLowerCase();
-    return blockedCommands.some(blocked => trimmedCommand.startsWith(blocked.toLowerCase()));
-}
-// 解析 cd 命令并验证路径
-function validateCdCommand(command, currentDir, rootDir, restrictDirectory) {
-    const cdMatch = command.trim().match(/^cd\s+(.+)$/i);
-    if (!cdMatch)
-        return { valid: true };
-    if (!restrictDirectory)
-        return { valid: true };
-    const targetPath = cdMatch[1].trim().replace(/['"]/g, '');
-    const absolutePath = path_1.default.resolve(currentDir, targetPath);
-    const normalizedRoot = path_1.default.resolve(rootDir);
-    // 检查目标路径是否在根目录内
-    if (!absolutePath.startsWith(normalizedRoot)) {
-        return { valid: false, error: 'restricted-directory' };
-    }
-    return { valid: true, newDir: absolutePath };
-}
-// 渲染终端输出为图片
-async function renderTerminalImage(ctx, workingDir, command, output) {
-    if (!ctx.puppeteer) {
-        throw new Error('Puppeteer plugin is not available');
-    }
-    const fontPath = (0, url_1.pathToFileURL)(path_1.default.resolve(__dirname, '../fonts/JetBrainsMono-Regular.ttf')).href;
-    const html = `
-<!DOCTYPE html>
-<html>
-<head>
-  <meta charset="UTF-8">
-  <style>
-    @font-face {
-      font-family: 'JetBrains Mono';
-      src: url('${fontPath}') format('truetype');
-    }
-    
-    * {
-      margin: 0;
-      padding: 0;
-      box-sizing: border-box;
-    }
-    
-    body {
-      background: #1e1e1e;
-      color: #cccccc;
-      font-family: 'JetBrains Mono', 'Courier New', monospace;
-      font-size: 14px;
-      padding: 0;
-      display: inline-block;
-      min-width: 600px;
-      max-width: 1200px;
-    }
-    
-    .terminal {
-      background: #1e1e1e;
-      border: 1px solid #3c3c3c;
-      border-radius: 8px;
-      overflow: hidden;
-    }
-    
-    .title-bar {
-      background: #2d2d2d;
-      height: 35px;
-      display: flex;
-      align-items: center;
-      justify-content: space-between;
-      padding: 0 12px;
-      border-bottom: 1px solid #3c3c3c;
-    }
-    
-    .title {
-      color: #cccccc;
-      font-size: 13px;
-      font-weight: 500;
-    }
-    
-    .buttons {
-      display: flex;
-      gap: 8px;
-    }
-    
-    .button {
-      width: 12px;
-      height: 12px;
-      border-radius: 50%;
-    }
-    
-    .button.minimize { background: #ffbd2e; }
-    .button.maximize { background: #28c940; }
-    .button.close { background: #ff5f56; }
-    
-    .content {
-      padding: 16px;
-      white-space: pre-wrap;
-      word-break: break-all;
-      line-height: 1.5;
-    }
-    
-    .prompt {
-      color: #4ec9b0;
-      margin-bottom: 8px;
-    }
-    
-    .command {
-      color: #dcdcaa;
-      margin-bottom: 12px;
-    }
-    
-    .output {
-      color: #cccccc;
-    }
-  </style>
-</head>
-<body>
-  <div class="terminal">
-    <div class="title-bar">
-      <div class="title">Terminal</div>
-      <div class="buttons">
-        <div class="button minimize"></div>
-        <div class="button maximize"></div>
-        <div class="button close"></div>
-      </div>
-    </div>
-    <div class="content">
-      <div class="prompt">${escapeHtml(workingDir)}$</div>
-      <div class="command">${escapeHtml(command)}</div>
-      <div class="output">${escapeHtml(output)}</div>
-    </div>
-  </div>
-</body>
-</html>
-  `;
-    const page = await ctx.puppeteer.page();
-    try {
-        await page.setContent(html);
-        await page.waitForNetworkIdle({ timeout: 5000 });
-        const element = await page.$('.terminal');
-        const clip = await element.boundingBox();
-        const screenshot = await page.screenshot({ clip });
-        return koishi_1.h.image(screenshot, 'image/png');
-    }
-    finally {
-        await page.close();
-    }
-}
-function escapeHtml(text) {
-    return text
-        .replace(/&/g, '&amp;')
-        .replace(/</g, '&lt;')
-        .replace(/>/g, '&gt;')
-        .replace(/"/g, '&quot;')
-        .replace(/'/g, '&#039;');
-}
-function apply(ctx, config) {
-    ctx.i18n.define('zh-CN', require('./locales/zh-CN'));
-    ctx.command('exec <command:text>', { authority: 4 })
-        .action(async ({ session }, command) => {
-        if (!command)
-            return session.text('.expect-text');
-        command = (0, koishi_1.h)('', koishi_1.h.parse(command)).toString(true);
-        // 检查违禁命令
-        if (isCommandBlocked(command, config.blockedCommands)) {
-            return session.text('.blocked-command');
-        }
-        const sessionId = session.uid || session.channelId;
-        const rootDir = path_1.default.resolve(ctx.baseDir, config.root);
-        const currentDir = sessionDirs.get(sessionId) || rootDir;
-        // 验证 cd 命令
-        const cdValidation = validateCdCommand(command, currentDir, rootDir, config.restrictDirectory);
-        if (!cdValidation.valid) {
-            return session.text('.restricted-directory');
-        }
-        const { timeout } = config;
-        const state = { command, timeout, output: '' };
-        if (!config.renderImage) {
-            await session.send(session.text('.started', state));
-        }
-        return new Promise((resolve) => {
-            const start = Date.now();
-            const child = (0, child_process_1.exec)(command, {
-                timeout,
-                cwd: currentDir,
-                encoding: config.encoding,
-                shell: config.shell,
-                windowsHide: true,
-            });
-            child.stdout.on('data', (data) => {
-                state.output += data.toString();
-            });
-            child.stderr.on('data', (data) => {
-                state.output += data.toString();
-            });
-            child.on('close', async (code, signal) => {
-                state.code = code;
-                state.signal = signal;
-                state.timeUsed = Date.now() - start;
-                state.output = state.output.trim();
-                // 更新当前目录（如果是 cd 命令且执行成功）
-                if (cdValidation.newDir && code === 0) {
-                    sessionDirs.set(sessionId, cdValidation.newDir);
-                }
-                // 渲染为图片或返回文本
-                if (config.renderImage && ctx.puppeteer) {
-                    try {
-                        const image = await renderTerminalImage(ctx, currentDir, command, state.output || '(no output)');
-                        resolve(image);
-                    }
-                    catch (error) {
-                        ctx.logger.error('Failed to render terminal image:', error);
-                        resolve(session.text('.finished', state));
-                    }
-                }
-                else {
-                    resolve(session.text('.finished', state));
-                }
-            });
-        });
-    });
-}