koishi-plugin-terminal 1.0.0 → 1.0.2

package/lib/index.d.ts

@@ -3,9 +3,9 @@ import * as pty from "node-pty";
 export declare const name = "terminal";
 export interface Config {
     admin?: Array<string>;
+    auth?: number;
     root?: string;
     shell?: string;
-    encoding?: string;
     timeout?: number;
     cols?: number;
     rows?: number;
@@ -15,6 +15,7 @@ export interface ShellSession {
     terminal: pty.IPty;
     buffer: string;
     timer?: NodeJS.Timeout;
+    timeoutTimer?: NodeJS.Timeout;
     disposables: Array<{
         dispose(): void;
     }>;

package/lib/index.js

@@ -40,14 +40,14 @@ var pty = __toESM(require("node-pty"));
 var import_node_timers = require("node:timers");
 var name = "terminal";
 var Config = import_koishi.Schema.object({
-  admin: import_koishi.Schema.array(String).description("超级管理员用户，具有绝对权限。").default([]),
-  root: import_koishi.Schema.string().description("初始工作路径。").default(process.env.HOME),
-  shell: import_koishi.Schema.string().description("Shell路径。留空则自动检测系统默认Shell。"),
-  encoding: import_koishi.Schema.string().description("输出内容编码。").default("utf8"),
-  timeout: import_koishi.Schema.number().description("超时时长。").default(import_koishi.Time.minute),
+  admin: import_koishi.Schema.array(String).description("超级管理员用户名单").default([]),
+  auth: import_koishi.Schema.number().description("使用本插件所需的最低权限，此外，用户也需要在超级管理员名单中。").min(1).max(4).step(1).default(4),
+  root: import_koishi.Schema.string().description("初始工作路径").default(process.env.HOME),
+  shell: import_koishi.Schema.string().description("Shell路径，留空则自动检测系统默认Shell"),
+  timeout: import_koishi.Schema.number().description("超时时长").default(import_koishi.Time.minute),
   cols: import_koishi.Schema.number().description("终端列数").default(80),
   rows: import_koishi.Schema.number().description("终端行数").default(24),
-  maxOutputLength: import_koishi.Schema.number().description("单次发送最大输出长度。").default(1800)
+  maxOutputLength: import_koishi.Schema.number().description("单次发送最大输出长度").default(16384)
 });
 function resolveShell(shell) {
   if (shell) return shell;
@@ -63,23 +63,55 @@ function resolveShell(shell) {
 }
 __name(resolveShell, "resolveShell");
 function stripAnsi(input) {
-  return input.replace(
+  const text = input.replace(
     // eslint-disable-next-line no-control-regex
     /\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])/g,
     ""
   );
+  return text.replace(/\r\n/g, "\n").split("\n").map((line) => line.split("\r").at(-1)).join("\n");
 }
 __name(stripAnsi, "stripAnsi");
 function getKey(session) {
   return `${session.platform}:${session.userId}`;
 }
 __name(getKey, "getKey");
+function isInteractiveCommand(command) {
+  const trimmed = command.trim();
+  if (!trimmed) return false;
+  const [name2, ...args] = trimmed.split(/\s+/);
+  if (/^(vi|vim|nvim|nano|emacs)$/.test(name2)) return true;
+  if (/^(less|more|man)$/.test(name2)) return true;
+  if (/^(top|htop|btop|watch)$/.test(name2)) return true;
+  if (/^(tmux|screen)$/.test(name2)) return true;
+  if (/^(ssh|sftp|ftp|telnet)$/.test(name2)) return true;
+  if (/^(mysql|psql|sqlite3|redis-cli|mongosh)$/.test(name2)) return true;
+  if (/^(node|python|python3|ipython|ruby|irb|php|lua|R)$/.test(name2) && !args.length) return true;
+  if (name2 === "tail" && args.includes("-f")) return true;
+  if (name2 === "docker" && args.includes("exec") && args.some((arg) => arg.includes("it"))) return true;
+  if (name2 === "kubectl" && args.includes("exec") && args.some((arg) => arg.includes("it"))) return true;
+  return false;
+}
+__name(isInteractiveCommand, "isInteractiveCommand");
 var map = /* @__PURE__ */ new Map();
 function apply(ctx, config) {
   const allowedUsers = config.admin;
-  function sendCommand(shellSession, command) {
+  function refreshTimeout(shellSession, key, session) {
+    if (!config.timeout) return;
+    if (shellSession.timeoutTimer) (0, import_node_timers.clearTimeout)(shellSession.timeoutTimer);
+    shellSession.timeoutTimer = setTimeout(async () => {
+      if (map.get(key) !== shellSession) return;
+      cleanupSession(shellSession, key, true);
+      await session.send("Shell session timed out.");
+    }, config.timeout);
+  }
+  __name(refreshTimeout, "refreshTimeout");
+  function sendCommand(shellSession, key, session, command) {
+    refreshTimeout(shellSession, key, session);
+    if (isInteractiveCommand(command)) {
+      shellSession.terminal.write(`echo "Interactive command is not supported in chat terminal. Use a non-interactive form, or run shell -t to restart."\r`);
+      return;
+    }
     shellSession.terminal.write(command + "\r");
-    shellSession.terminal.write("pwd\r");
   }
   __name(sendCommand, "sendCommand");
   function initSession(session, key) {
@@ -101,7 +133,7 @@ function apply(ctx, config) {
       shellSession.buffer = "";
       if (!output) return;
       const text = output.length > config.maxOutputLength ? output.slice(0, config.maxOutputLength - 1) + "\n ...Truncated output" : output;
-      await session.send(text + "$");
+      await session.send(text);
     }, "flush");
     const dataDisposable = terminal.onData((data) => {
       shellSession.buffer += data;
@@ -109,22 +141,31 @@ function apply(ctx, config) {
       shellSession.timer = setTimeout(flush, 300);
     });
     const exitDisposable = terminal.onExit(async () => {
-      cleanupSession(shellSession, key);
+      flush();
+      cleanupSession(shellSession, key, false);
       await session.send("Shell exited.");
     });
     shellSession.disposables.push(dataDisposable, exitDisposable);
     map.set(key, shellSession);
+    refreshTimeout(shellSession, key, session);
     return shellSession;
   }
   __name(initSession, "initSession");
-  function cleanupSession(shellSession, key) {
+  function cleanupSession(shellSession, key, kill = true) {
     map.delete(key);
-    shellSession.disposables.forEach((d) => d.dispose());
-    shellSession.terminal.kill();
     if (shellSession.timer) (0, import_node_timers.clearTimeout)(shellSession.timer);
+    if (shellSession.timeoutTimer) (0, import_node_timers.clearTimeout)(shellSession.timeoutTimer);
+    shellSession.disposables.forEach((d) => d.dispose());
+    shellSession.disposables.length = 0;
+    if (kill) {
+      try {
+        shellSession.terminal.kill();
+      } catch {
+      }
+    }
   }
   __name(cleanupSession, "cleanupSession");
-  ctx.command("shell [command:text]", "Start a persistent shell session", { authority: 4 }).option("terminate", "-t Terminate current shell session").usage("After start up, regular user messages will be sent to shell process.").example("shell echo Operating System: Three Easy Pieces > qljj.txt").action(async ({ session, options }, command) => {
+  ctx.command("shell [command:text]", "Start a persistent shell session", { authority: config.auth }).option("terminate", "-t Terminate current shell session").usage("After start up, regular user messages will be sent to shell process.").example("shell echo Operating System: Three Easy Pieces > qljj.txt").action(async ({ session, options }, command) => {
     if (!allowedUsers.includes(session.userId)) {
       return "Unauthorized user.";
     }
@@ -132,7 +173,7 @@ function apply(ctx, config) {
     if (options.terminate) {
       const current2 = map.get(key);
       if (!current2) return "There doesn't exist running shell session.";
-      cleanupSession(current2, key);
+      cleanupSession(current2, key, true);
       return "Shell session terminated.";
     }
     let current = map.get(key);
@@ -141,7 +182,7 @@ function apply(ctx, config) {
       if (!command) return "Shell session started. Send regular messages as commands. Send shell -t to terminate.";
     }
     if (!command) return "Shell session is running.";
-    sendCommand(current, command);
+    sendCommand(current, key, session, command);
   });
   ctx.middleware(async (session, next) => {
     const key = getKey(session);
@@ -152,12 +193,13 @@ function apply(ctx, config) {
       return next();
     }
     if (!content) return;
-    sendCommand(current, content);
+    sendCommand(current, key, session, content);
   }, true);
   ctx.on("dispose", () => {
     for (const current of map.values()) {
       current.disposables.forEach((d) => d.dispose());
       if (current.timer) (0, import_node_timers.clearTimeout)(current.timer);
+      if (current.timeoutTimer) (0, import_node_timers.clearTimeout)(current.timeoutTimer);
       current.terminal.kill();
     }
     map.clear();

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "koishi-plugin-terminal",
-    "description": "Persistent terminal interface to a shell session over QQ.",
-    "version": "1.0.0",
+    "description": "通过 QQ 运行持久的 Shell 终端",
+    "version": "1.0.2",
     "main": "lib/index.js",
     "typings": "lib/index.d.ts",
     "files": [
@@ -18,7 +18,8 @@
         "terminal",
         "cmd",
         "bash",
-        "zsh"
+        "zsh",
+        "command"
     ],
     "repository": {
         "type": "git",