koishi-plugin-docker-control 0.0.1

package/lib/utils/stream.js

@@ -0,0 +1,156 @@
+"use strict";
+/**
+ * 流处理工具
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.streamToString = streamToString;
+exports.stringToStream = stringToStream;
+exports.mergeStreams = mergeStreams;
+exports.throttleStream = throttleStream;
+exports.decodeStream = decodeStream;
+exports.tailStream = tailStream;
+/**
+ * 将 Stream 转换为字符串
+ */
+async function streamToString(stream) {
+    const chunks = [];
+    return new Promise((resolve, reject) => {
+        stream.on('data', (chunk) => chunks.push(chunk));
+        stream.on('end', () => {
+            const buffer = Buffer.concat(chunks);
+            resolve(buffer.toString('utf8'));
+        });
+        stream.on('error', reject);
+    });
+}
+/**
+ * 将字符串转换为 Stream
+ */
+function stringToStream(content, encoding = 'utf8') {
+    const { Readable } = require('stream');
+    return Readable.from([Buffer.from(content, encoding)]);
+}
+/**
+ * 合并多个 Stream
+ */
+function mergeStreams(streams) {
+    const { Readable, PassThrough } = require('stream');
+    const output = new PassThrough();
+    let pending = streams.length;
+    if (pending === 0) {
+        output.end();
+        return output;
+    }
+    for (const stream of streams) {
+        stream.on('data', (chunk) => output.write(chunk));
+        stream.on('end', () => {
+            pending--;
+            if (pending === 0) {
+                output.end();
+            }
+        });
+        stream.on('error', (err) => {
+            output.destroy(err);
+        });
+    }
+    return output;
+}
+/**
+ * 限流 Stream
+ * 控制数据输出的速度
+ */
+function throttleStream(stream, maxBytesPerSecond) {
+    const { PassThrough } = require('stream');
+    const output = new PassThrough();
+    let bytesWritten = 0;
+    let lastTime = Date.now();
+    const checkThrottle = () => {
+        const now = Date.now();
+        const elapsed = now - lastTime;
+        if (elapsed >= 1000) {
+            bytesWritten = 0;
+            lastTime = now;
+        }
+    };
+    stream.on('data', (chunk) => {
+        checkThrottle();
+        if (bytesWritten + chunk.length > maxBytesPerSecond) {
+            // 需要限流，延迟写入
+            const delay = Math.ceil(((bytesWritten + chunk.length - maxBytesPerSecond) /
+                maxBytesPerSecond) *
+                1000);
+            setTimeout(() => {
+                output.write(chunk);
+            }, delay);
+        }
+        else {
+            output.write(chunk);
+        }
+        bytesWritten += chunk.length;
+    });
+    stream.on('end', () => output.end());
+    stream.on('error', (err) => output.destroy(err));
+    return output;
+}
+/**
+ * 解码 Stream (处理 ANSI 转义码)
+ */
+function decodeStream(stream) {
+    const { PassThrough } = require('stream');
+    const output = new PassThrough();
+    let buffer = '';
+    stream.on('data', (chunk) => {
+        // 解码 UTF-8
+        const text = chunk.toString('utf8');
+        buffer += text;
+        // 按行处理
+        const lines = buffer.split('\n');
+        buffer = lines.pop() || '';
+        for (const line of lines) {
+            // 移除 ANSI 转义码
+            const cleanLine = line.replace(/[\x00-\x08\x0b\x0c\x0e-\x1f]/g, '');
+            output.write(cleanLine + '\n');
+        }
+    });
+    stream.on('end', () => {
+        if (buffer) {
+            output.write(buffer);
+        }
+        output.end();
+    });
+    stream.on('error', (err) => output.destroy(err));
+    return output;
+}
+/**
+ * 截取 Stream 的最后 N 行
+ */
+function tailStream(stream, maxLines) {
+    const { PassThrough } = require('stream');
+    const output = new PassThrough();
+    const lines = [];
+    stream.on('data', (chunk) => {
+        const text = chunk.toString('utf8');
+        const newLines = text.split('\n');
+        // 将新行加入队列
+        if (lines.length > 0) {
+            lines[lines.length - 1] += newLines[0];
+            lines.push(...newLines.slice(1));
+        }
+        else {
+            lines.push(...newLines);
+        }
+        // 保持最大行数
+        while (lines.length > maxLines + 1) {
+            lines.shift();
+        }
+    });
+    stream.on('end', () => {
+        // 输出保留的行
+        if (lines.length > 1) {
+            output.write(lines.slice(1).join('\n'));
+        }
+        output.end();
+    });
+    stream.on('error', (err) => output.destroy(err));
+    return output;
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "koishi-plugin-docker-control",
+  "description": "Koishi 插件 - 通过 SSH 控制 Docker 容器",
+  "version": "0.0.1",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "files": [
+    "lib",
+    "dist"
+  ],
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc -w"
+  },
+  "keywords": [
+    "chatbot",
+    "koishi",
+    "plugin",
+    "docker",
+    "container",
+    "ssh"
+  ],
+  "peerDependencies": {
+    "dockerode": "^4.0.9",
+    "koishi": "4.18.10",
+    "ssh2": "^1.17.0"
+  },
+  "dependencies": {
+    "puppeteer": "^21.0.0"
+  },
+  "devDependencies": {
+    "@types/dockerode": "^3.3.47",
+    "@types/node": "^20.19.27",
+    "@types/ssh2": "^1.15.5",
+    "typescript": "^5.9.3"
+  }
+}

package/readme.md

@@ -0,0 +1,96 @@
+# koishi-plugin-docker-control
+
+Koishi 插件 - 通过 SSH 管理远程 Docker 容器
+
+## 简介
+
+通过 SSH 连接管理远程 Docker 容器，支持容器列表、启动、停止、重启、日志查看、命令执行等功能。
+
+## 快速开始
+
+### 1. 配置节点
+
+在 Koishi 控制台配置 SSH 凭证和 Docker 节点。
+
+### 2. 订阅容器通知
+
+```
+# 订阅指定节点的指定容器
+docker.subscribe yun myapp
+
+# 订阅指定节点的所有容器
+docker.subscribe yun all
+
+# 订阅所有节点的指定容器
+docker.subscribe all myapp
+
+# 订阅所有容器的所有事件
+docker.subscribe all all
+
+# 只监听启动和停止事件
+docker.subscribe all all -e start,stop
+```
+
+### 3. 查看订阅
+
+```
+docker.subscriptions
+```
+
+### 4. 取消订阅
+
+```
+docker.unsubscribe <订阅ID>
+```
+
+## 指令说明
+
+### 基础指令
+
+| 指令 | 说明 |
+|------|------|
+| `docker.ls` | 列出所有节点容器 |
+| `docker.ls <selector>` | 列出指定节点容器 |
+| `docker.ls -a` | 列出所有容器（含已停止） |
+| `docker.ls -f image` | 图片格式输出 |
+
+### 控制指令
+
+| 指令 | 说明 |
+|------|------|
+| `docker.start <selector> <container>` | 启动容器 |
+| `docker.stop <selector> <container>` | 停止容器 |
+| `docker.restart <selector> <container>` | 重启容器 |
+| `docker.inspect <selector> <container>` | 查看容器详情 |
+
+### 日志与执行
+
+| 指令 | 说明 |
+|------|------|
+| `docker.logs <container>` | 查看容器日志（自动搜索） |
+| `docker.logs <container> <node>` | 查看指定节点容器日志 |
+| `docker.logs <container> -n 100` | 查看最近 100 行日志 |
+| `docker.exec <selector> <container> <cmd>` | 在容器内执行命令 |
+
+### 订阅指令
+
+| 指令 | 说明 |
+|------|------|
+| `docker.subscribe <node> <container>` | 订阅容器通知 |
+| `docker.subscriptions` | 查看当前订阅 |
+| `docker.unsubscribe <id>` | 取消订阅 |
+
+## 参数说明
+
+- **selector**: 节点选择器，支持节点 ID、节点名称或 `@标签`
+- **container**: 容器名称或 ID（支持模糊匹配）
+- **-n**: 日志行数限制
+- **-a**: 显示所有容器（含已停止）
+- **-f**: 输出格式（simple/detail/json/image）
+- **-e**: 监听的事件类型（start/stop/restart/die）
+
+## 配置项
+
+- **debug**: 调试模式
+- **imageOutput**: 图片格式输出
+- **defaultLogLines**: 默认日志行数