kokkoro-plugin-eval 0.0.0 → 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Yuki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1 +1,54 @@
-# cocoro
+# kokkoro-plugin-eval
+
+代码执行，运行 JavaScript 或 TypeScript 代码并返回执行结果。
+
+## 安装
+
+```shell
+bun add kokkoro-plugin-eval
+```
+
+## 指令
+
+```text
+/执行 <code>
+```
+
+`code` 表示需要执行的代码。发送指令后，插件会返回执行结果。
+
+```text
+/执行 0.1 + 0.2
+```
+
+## 快捷方式
+
+也可以使用「>」快捷执行：
+
+```text
+> await fetch('https://example.com').then(response => response.status)
+```
+
+群聊需要开启「获取群内全部消息」权限。
+
+## 环境变量
+
+`EVAL_TIMEOUT` 和 `EVAL_MAX_BUFFER` 用于自定义插件的执行超时时间和输出上限，单位分别为毫秒和字节。默认值如下：
+
+```ini
+EVAL_TIMEOUT=60000
+EVAL_MAX_BUFFER=65536
+```
+
+## API
+
+其他插件可以从 `service` 入口导入 `evaluate()`，在独立的 Bun 子进程中执行代码：
+
+```typescript
+import { evaluate } from 'kokkoro-plugin-eval/service';
+
+const output = await evaluate('0.1 + 0.2');
+```
+
+## 安全
+
+建议只允许可信用户使用该插件。执行的代码拥有与 Kokkoro 进程相同的系统权限，可以读取文件和环境变量，也可以执行系统命令。

package/package.json

@@ -1,15 +1,31 @@
 {
   "name": "kokkoro-plugin-eval",
-  "version": "0.0.0",
-  "exports": "./src/index.ts",
+  "version": "1.0.2",
+  "description": "代码执行，运行 JavaScript 或 TypeScript 代码并返回执行结果。",
+  "keywords": [
+    "bot",
+    "kokkoro",
+    "eval",
+    "qq"
+  ],
+  "bugs": "https://github.com/kokkorojs/kokkoro/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kokkorojs/kokkoro.git",
+    "directory": "plugins/eval"
+  },
+  "license": "MIT",
+  "author": "Yuki <admin@yuki.sh>",
   "type": "module",
+  "exports": {
+    ".": "./src/index.ts",
+    "./service": "./src/service.ts"
+  },
   "files": [
     "src"
   ],
-  "devDependencies": {
-    "@types/bun": "latest"
-  },
   "peerDependencies": {
-    "typescript": "^7"
+    "@kokkoro/core": "^3.1.4",
+    "typescript": "^6.0.3"
   }
 }

package/src/index.ts

@@ -1 +1,20 @@
-console.log('Ciallo～(∠·ω< )⌒★');
+import { useCommand, useLogger } from '@kokkoro/core';
+
+import { evaluate } from './service';
+
+const logger = useLogger();
+
+export default () => {
+  useCommand('/执行 <code>', async context => {
+    const source = context.trigger === 'shortcut' ? context.args.code : context.content.replace(/^.*?\/执行\s+/s, '');
+
+    logger.debug('开始执行代码', { source });
+
+    const output = await evaluate(source);
+
+    logger.debug('代码执行结果', { output });
+    logger.info('已执行代码');
+
+    return output;
+  }).shortcut(/^>\s*(?<code>.+)$/s);
+};

package/src/service.ts

@@ -0,0 +1,28 @@
+import { spawn } from 'bun';
+
+const { EVAL_TIMEOUT: TIMEOUT = 1000 * 60, EVAL_MAX_BUFFER: MAX_BUFFER = 1024 * 64 } = import.meta.env;
+
+/** 在独立的 Bun 子进程中执行代码，并返回标准输出和错误输出。 */
+export async function evaluate(source: string): Promise<string | undefined> {
+  const signal = AbortSignal.timeout(Number(TIMEOUT));
+  const subprocess = spawn(['bun', '--print', source], {
+    stderr: 'pipe',
+    signal,
+    killSignal: 'SIGKILL',
+    maxBuffer: Number(MAX_BUFFER),
+  });
+  const [stdout, stderr, exitCode] = await Promise.all([
+    subprocess.stdout.text(),
+    subprocess.stderr.text(),
+    subprocess.exited,
+  ]);
+
+  if (signal.aborted) {
+    throw new Error('代码执行超时');
+  }
+
+  if (exitCode) {
+    throw new Error(stderr.trim() || `代码执行失败，退出码 ${exitCode}`);
+  }
+  return [stdout.trim(), stderr.trim()].filter(Boolean).join('\n') || undefined;
+}