koishi-plugin-spawn-modified 1.1.2

package/LICENSE

@@ -0,0 +1,212 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License.
+
+   Subject to the terms and conditions of this License, each Contributor
+   hereby grants to You a perpetual, worldwide, non-exclusive, no-charge,
+   royalty-free, irrevocable copyright license to reproduce, prepare
+   Derivative Works of, publicly display, publicly perform, sublicense,
+   and distribute the Work and such Derivative Works in Source or Object
+   form.
+
+3. Grant of Patent License.
+
+   Subject to the terms and conditions of this License, each Contributor
+   hereby grants to You a perpetual, worldwide, non-exclusive, no-charge,
+   royalty-free, irrevocable (except as stated in this section) patent
+   license to make, have made, use, offer to sell, sell, import, and
+   otherwise transfer the Work, where such license applies only to those
+   patent claims licensable by such Contributor that are necessarily
+   infringed by their Contribution(s) alone or by combination of their
+   Contribution(s) with the Work to which such Contribution(s) was
+   submitted. If You institute patent litigation against any entity
+   (including a cross-claim or counterclaim in a lawsuit) alleging that
+   the Work or a Contribution incorporated within the Work constitutes
+   direct or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution.
+
+   You may reproduce and distribute copies of the Work or Derivative
+   Works thereof in any medium, with or without modifications, and in
+   Source or Object form, provided that You meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions.
+
+   Unless You explicitly state otherwise, any Contribution intentionally
+   submitted for inclusion in the Work by You to the Licensor shall be
+   under the terms and conditions of this License, without any additional
+   terms or conditions. Notwithstanding the above, nothing herein shall
+   supersede or modify the terms of any separate license agreement you
+   may have executed with Licensor regarding such Contributions.
+
+6. Trademarks.
+
+   This License does not grant permission to use the trade names,
+   trademarks, service marks, or product names of the Licensor, except as
+   required for reasonable and customary use in describing the origin of
+   the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+   Unless required by applicable law or agreed to in writing, Licensor
+   provides the Work (and each Contributor provides its Contributions)
+   on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied, including, without limitation, any
+   warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY,
+   or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for
+   determining the appropriateness of using or redistributing the Work
+   and assume any risks associated with Your exercise of permissions
+   under this License.
+
+8. Limitation of Liability.
+
+   In no event and under no legal theory, whether in tort (including
+   negligence), contract, or otherwise, unless required by applicable
+   law (such as deliberate and grossly negligent acts) or agreed to in
+   writing, shall any Contributor be liable to You for damages, including
+   any direct, indirect, special, incidental, or consequential damages of
+   any character arising as a result of this License or out of the use or
+   inability to use the Work (including but not limited to damages for
+   loss of goodwill, work stoppage, computer failure or malfunction, or
+   any and all other commercial damages or losses), even if such
+   Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+   While redistributing the Work or Derivative Works thereof, You may choose
+   to offer, and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this License.
+   However, in accepting such obligations, You may act only on Your own behalf
+   and on Your sole responsibility, not on behalf of any other Contributor,
+   and only if You agree to indemnify, defend, and hold each Contributor
+   harmless for any liability incurred by, or claims asserted against, such
+   Contributor by reason of your accepting any such warranty or additional
+   liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,9 @@
+# [koishi-plugin-spawn](https://common.koishi.chat/plugins/spawn.html)
+ 
+[![npm](https://img.shields.io/npm/v/koishi-plugin-spawn?style=flat-square)](https://www.npmjs.com/package/koishi-plugin-spawn)
+
+Run shell commands with Koishi. | 使用 Koishi 运行终端命令。
+
+## 文档
+
+<https://common.koishi.chat/plugins/spawn.html>

package/lib/index.d.ts

@@ -0,0 +1,33 @@
+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/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "koishi-plugin-spawn-modified",
+  "version": "1.1.2",
+  "description": "Run shell commands with Koishi",
+  "keywords": [
+    "bot",
+    "chatbot",
+    "koishi",
+    "plugin",
+    "spawn",
+    "exec",
+    "process",
+    "shell",
+    "command",
+    "terminal",
+    "common"
+  ],
+  "homepage": "https://github.com/MuxYang/koishi-plugin-spawn-modified#readme",
+  "bugs": {
+    "url": "https://github.com/MuxYang/koishi-plugin-spawn-modified/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MuxYang/koishi-plugin-spawn-modified.git"
+  },
+  "license": "Apache-2.0",
+  "author": "MuxYang <tlnkmc.b@gmail.com>",
+  "contributors": [
+    {
+      "name": "Shigma",
+      "email": "shigma10826@gmail.com"
+    },
+    {
+      "name": "Dragon-Fish",
+      "email": "dragon-fish@qq.com"
+    },
+    {
+      "name": "MuxYang",
+      "email": "tlnkmc.b@gmail.com"
+    }
+  ],
+  "type": "commonjs",
+  "main": "lib/index.js",
+  "directories": {
+    "lib": "lib",
+    "test": "tests"
+  },
+  "files": [
+    "lib",
+    "src",
+    "fonts"
+  ],
+  "scripts": {
+    "build": "tsc -b",
+    "clean": "rimraf lib"
+  },
+  "devDependencies": {
+    "@koishijs/plugin-help": "^2.4.3",
+    "@koishijs/plugin-mock": "^2.6.5",
+    "koishi": "^4.17.2",
+    "typescript": "^5.9.3"
+  },
+  "peerDependencies": {
+    "koishi": "^4.17.2"
+  },
+  "peerDependenciesMeta": {
+    "koishi-plugin-puppeteer": {
+      "optional": true
+    }
+  },
+  "typings": "lib/index.d.ts",
+  "koishi": {
+    "description": {
+      "en": "Run shell commands with Koishi",
+      "zh": "使用 Koishi 运行终端命令"
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,291 @@
+import { exec } from 'child_process'
+import { Context, h, Schema, Time } from 'koishi'
+import path from 'path'
+import { pathToFileURL } from 'url'
+
+declare module 'koishi' {
+  interface Context {
+    puppeteer?: {
+      page(): Promise<any>
+    }
+  }
+}
+
+const encodings = ['utf8', 'utf16le', 'latin1', 'ucs2'] as const
+
+export interface Config {
+  root?: string
+  shell?: string
+  encoding?: typeof encodings[number]
+  timeout?: number
+  renderImage?: boolean
+  blockedCommands?: string[]
+  restrictDirectory?: boolean
+}
+
+export const Config: Schema<Config> = Schema.object({
+  root: Schema.string().description('工作路径。').default(''),
+  shell: Schema.string().description('运行命令的程序。'),
+  encoding: Schema.union(encodings).description('输出内容编码。').default('utf8'),
+  timeout: Schema.number().description('最长运行时间。').default(Time.minute),
+  renderImage: Schema.boolean().description('是否将命令执行结果渲染为图片（需要安装 puppeteer 插件）。').default(false),
+  blockedCommands: Schema.array(String).description('违禁命令列表（命令的开头部分）。').default([]),
+  restrictDirectory: Schema.boolean().description('是否限制在当前目录及子目录内执行命令（禁止 cd 到上级或其他目录）。').default(false),
+})
+
+export interface State {
+  command: string
+  timeout: number
+  output: string
+  code?: number
+  signal?: NodeJS.Signals
+  timeUsed?: number
+}
+
+export const name = 'spawn'
+
+export const inject = {
+  optional: ['puppeteer'],
+}
+
+// 当前工作目录状态管理
+const sessionDirs = new Map<string, string>()
+
+// 验证命令是否被禁止
+function isCommandBlocked(command: string, blockedCommands: string[]): boolean {
+  const trimmedCommand = command.trim().toLowerCase()
+  return blockedCommands.some(blocked => trimmedCommand.startsWith(blocked.toLowerCase()))
+}
+
+// 解析 cd 命令并验证路径
+function validateCdCommand(command: string, currentDir: string, rootDir: string, restrictDirectory: boolean): { valid: boolean; newDir?: string; error?: string } {
+  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.resolve(currentDir, targetPath)
+  const normalizedRoot = path.resolve(rootDir)
+  
+  // 检查目标路径是否在根目录内
+  if (!absolutePath.startsWith(normalizedRoot)) {
+    return { valid: false, error: 'restricted-directory' }
+  }
+  
+  return { valid: true, newDir: absolutePath }
+}
+
+// 渲染终端输出为图片
+async function renderTerminalImage(ctx: Context, workingDir: string, command: string, output: string): Promise<h> {
+  if (!ctx.puppeteer) {
+    throw new Error('Puppeteer plugin is not available')
+  }
+
+  const fontPath = pathToFileURL(path.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 }) as Buffer
+    
+    return h.image(screenshot, 'image/png')
+  } finally {
+    await page.close()
+  }
+}
+
+function escapeHtml(text: string): string {
+  return text
+    .replace(/&/g, '&amp;')
+    .replace(/</g, '&lt;')
+    .replace(/>/g, '&gt;')
+    .replace(/"/g, '&quot;')
+    .replace(/'/g, '&#039;')
+}
+
+export function apply(ctx: Context, config: 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 = h('', h.parse(command)).toString(true)
+      
+      // 检查违禁命令
+      if (isCommandBlocked(command, config.blockedCommands)) {
+        return session.text('.blocked-command')
+      }
+      
+      const sessionId = session.uid || session.channelId
+      const rootDir = path.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: State = { command, timeout, output: '' }
+      
+      if (!config.renderImage) {
+        await session.send(session.text('.started', state))
+      }
+
+      return new Promise((resolve) => {
+        const start = Date.now()
+        const child = 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))
+          }
+        })
+      })
+    })
+}

package/src/locales/zh-CN.yml

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