karin-plugin-teamspeak 1.12.0 → 1.13.0

package/lib/apps/command.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 渲染ts3服务器内存在用户的列表
+ * 触发指令: 人数
+ */
+export declare const image: import("node-karin").Command<keyof import("node-karin").MessageEventMap>;

package/lib/apps/command.js

@@ -0,0 +1,38 @@
+import { karin, segment, logger } from "node-karin";
+import teamspeak3 from "./ts3.js";
+const loggerPluginName = logger.chalk.hex("#90CAF9")(" ===== ts3 ===== ");
+/**
+ * 渲染ts3服务器内存在用户的列表
+ * 触发指令: 人数
+ */
+export const image = karin.command(/^#?人数$/, async (e) => {
+    try {
+        const list = await teamspeak3.getAllChannelList();
+        if (list) {
+            if (e.bot.adapter.protocol == "qqbot") {
+                await e.reply(segment.markdown(list));
+            }
+            else {
+                await e.reply(segment.text(list));
+            }
+        }
+        else {
+            await e.reply(segment.text("获取频道列表失败,可能是连接ts3服务器失败"));
+        }
+        return true;
+    }
+    catch (error) {
+        logger.error(loggerPluginName, error);
+        await e.reply(JSON.stringify(error));
+        return true;
+    }
+}, {
+    /** 插件优先级 */
+    priority: 9999,
+    /** 插件触发是否打印触发日志 */
+    log: true,
+    /** 插件名称 */
+    name: "显示ts服务器内人数",
+    /** 谁可以触发这个插件 'all' | 'master' | 'admin' | 'group.owner' | 'group.admin' */
+    permission: "all",
+});

package/lib/apps/ts3.d.ts

@@ -0,0 +1,23 @@
+import { TeamSpeak } from "ts3-nodejs-library";
+declare class ts3 {
+    teamspeak: undefined | TeamSpeak;
+    connectTimer: number;
+    private isReConnecting;
+    init: () => Promise<void>;
+    getAllChannelList: () => Promise<string | undefined>;
+    quitTs: () => Promise<void>;
+    private handelReconnect;
+}
+declare const teamspeak3: ts3;
+export declare const getAllUserList: () => Promise<{
+    name: string;
+    res: {
+        [name: string]: {
+            nickName: string;
+            lastconnected: string;
+            connectTime: string;
+        }[];
+    };
+    count: number;
+} | null>;
+export default teamspeak3;

package/lib/apps/ts3.js

@@ -0,0 +1,204 @@
+import { QueryProtocol, TeamSpeak } from "ts3-nodejs-library";
+import { config } from "../utils/index.js";
+import karin, { logger, segment, app } from "node-karin";
+import moment from "node-karin/moment";
+import express from "node-karin/express";
+const loggerPluginName = logger.chalk.hex("#90CAF9")(" ===== ts3 ===== ");
+logger.info(loggerPluginName + "初始化ts3插件");
+let disNotifyNameList = [];
+class ts3 {
+    teamspeak;
+    connectTimer = 0;
+    isReConnecting = false;
+    //初始化 如果已经有连接了就关闭连接重新连接
+    init = async () => {
+        const TS = config();
+        this.isReConnecting = false;
+        disNotifyNameList = [TS.NICKNAME, ...TS.DIS_NOTIFY_NAME_LIST];
+        logger.info(loggerPluginName + "开始连接ts3服务器...");
+        if (this.teamspeak) {
+            await this.quitTs();
+        }
+        const _teamspeak = new TeamSpeak({
+            host: TS.HOST,
+            protocol: QueryProtocol[TS.PROTOCOL],
+            queryport: TS.QUERY_PORT,
+            serverport: TS.SERVER_PORT,
+            username: TS.USERNAME,
+            password: TS.PASSWORD,
+            nickname: TS.NICKNAME,
+        });
+        _teamspeak.on("ready", async () => {
+            if (this.isReConnecting) {
+                logger.info(loggerPluginName + "重连成功");
+            }
+            else {
+                logger.info(loggerPluginName + "ts3连接成功");
+            }
+            this.isReConnecting = false;
+            this.teamspeak = _teamspeak;
+        });
+        _teamspeak.on("close", (e) => {
+            logger.error(loggerPluginName + "ts3连接断开", e);
+            this.handelReconnect();
+        });
+        _teamspeak.on("error", (err) => {
+            logger.error(loggerPluginName + "ts3连接出错", err);
+        });
+        _teamspeak.on("clientconnect", (e) => {
+            if (!disNotifyNameList.includes(e.client.nickname)) {
+                logger.info(loggerPluginName + e.client.nickname + "进入ts");
+                const bots = karin.getBotAll().filter(bot => bot.account.selfId !== "console");
+                TS.NOTICE_GROUP_NO.forEach((groupNo) => {
+                    const contact = karin.contact("group", groupNo + "");
+                    bots.forEach(bot => {
+                        const msg = bot.adapter.protocol === "qqbot"
+                            ? segment.markdown(`**${e.client.nickname}** 进入了 TS 服务器`)
+                            : segment.text(`${e.client.nickname} 进入了 TS 服务器`);
+                        karin.sendMsg(bot.account.selfId, contact, msg);
+                    });
+                });
+            }
+        });
+        _teamspeak.on("clientdisconnect", (e) => {
+            if (e.client) {
+                if (!disNotifyNameList.includes(e.client.nickname)) {
+                    logger.info(loggerPluginName + e.client.nickname + "离开ts");
+                    const bots = karin.getBotAll().filter(bot => bot.account.selfId !== "console");
+                    TS.NOTICE_GROUP_NO.forEach((groupNo) => {
+                        const contact = karin.contact("group", groupNo + "");
+                        bots.forEach(bot => {
+                            const msg = bot.adapter.protocol === "qqbot"
+                                ? segment.markdown(`**${e.client.nickname}** 离开了 TS 服务器`)
+                                : segment.text(`${e.client.nickname} 离开了 TS 服务器`);
+                            karin.sendMsg(bot.account.selfId, contact, msg);
+                        });
+                    });
+                }
+            }
+        });
+        // 监听用户移动频道事件
+        _teamspeak.on("clientmoved", (e) => {
+            if (TS.ENABLE_CHANNEL_MOVE_NOTIFY === "true" &&
+                e.client &&
+                !disNotifyNameList.includes(e.client.nickname)) {
+                logger.info(loggerPluginName +
+                    e.client.nickname +
+                    "移动到频道: " +
+                    e.channel.name);
+                const bots = karin.getBotAll().filter(bot => bot.account.selfId !== "console");
+                TS.NOTICE_GROUP_NO.forEach((groupNo) => {
+                    const contact = karin.contact("group", groupNo + "");
+                    bots.forEach(bot => {
+                        const msg = bot.adapter.protocol === "qqbot"
+                            ? segment.markdown(`**${e.client.nickname}** 移动到了频道 **${e.channel.name}**`)
+                            : segment.text(`${e.client.nickname} 移动到了频道 ${e.channel.name}`);
+                        karin.sendMsg(bot.account.selfId, contact, msg);
+                    });
+                });
+            }
+        });
+    };
+    //获取ts3服务器的所有对应频道的人 -- 并组装成文字可直接发
+    getAllChannelList = async () => {
+        if (!this.teamspeak) {
+            return;
+        }
+        const TS = config();
+        const renderList = [];
+        renderList.push(`# ${TS.SERVER_NAME || TS.HOST}`);
+        renderList.push(`> 仅展示有人的频道`);
+        const channelList = await this.teamspeak.channelList(); //所有频道
+        let count = 0;
+        for (let index = 0; index < channelList.length; index++) {
+            const channel = channelList[index]; //频道
+            const allClient = await channel.getClients(); //在当前频道的人
+            //排除不显示的人
+            const clients = allClient.filter((c) => !disNotifyNameList.includes(c.nickname));
+            count += clients.length;
+            if (clients.length == 0)
+                continue;
+            renderList.push(`---`);
+            renderList.push(`**${channel.name}**`);
+            for (let index = 0; index < clients.length; index++) {
+                const client = clients[index];
+                const connectTimeSec = moment().diff(moment.unix(client.lastconnected), "second");
+                let connectTime = `(${Math.floor(connectTimeSec / 60)}:${Math.floor(connectTimeSec % 60)})`;
+                renderList.push(`- ${client.nickname} ${connectTime}`);
+            }
+        }
+        renderList.splice(2, 0, `> 当前在线 **${count}** 人`);
+        return renderList.join("\n");
+    };
+    //关闭连接
+    quitTs = async () => {
+        if (this.teamspeak) {
+            this.teamspeak.removeAllListeners();
+            this.teamspeak.quit();
+            this.teamspeak = undefined;
+        }
+    };
+    //重连逻辑
+    async handelReconnect() {
+        const TS = config();
+        if (!this.teamspeak || this.isReConnecting)
+            return;
+        this.isReConnecting = true;
+        logger.info(loggerPluginName + "重连中...");
+        try {
+            await this.teamspeak.reconnect(TS.RECONNECT_TIMER, 1000);
+        }
+        catch (e) {
+            logger.error(loggerPluginName + "连接TS3失败", e);
+        }
+    }
+}
+const teamspeak3 = new ts3();
+setTimeout(() => {
+    //确保配置文件生成且正确保存
+    teamspeak3.init();
+}, 1000);
+//获取ts3服务器内所有频道内在线人数 -- 给接口用
+export const getAllUserList = async () => {
+    if (teamspeak3.teamspeak) {
+        let count = 0;
+        const res = {};
+        const channelList = await teamspeak3.teamspeak.channelList().catch(() => {
+            return [];
+        }); //所有频道
+        for (let index = 0; index < channelList.length; index++) {
+            const channel = channelList[index]; //频道
+            const allClient = await channel.getClients(); //在当前频道的人
+            //排除不显示的人
+            const clients = allClient.filter((c) => !disNotifyNameList.includes(c.nickname));
+            count += clients.length;
+            res[channel.name] = clients.map((c) => {
+                const connectTimeSec = moment().diff(moment.unix(c.lastconnected), "second");
+                let connectTime = `${Math.floor(connectTimeSec / 60)}:${Math.floor(connectTimeSec % 60)}`;
+                return {
+                    nickName: c.nickname, //昵称
+                    lastconnected: moment
+                        .unix(c.lastconnected)
+                        .format("YYYY-MM-DD HH:mm:ss"), //上次连接进来的时间
+                    connectTime, //已经连接的时间 - 单位分:秒
+                };
+            });
+        }
+        return {
+            name: config().SERVER_NAME || config().HOST,
+            res,
+            count,
+        };
+    }
+    else {
+        return null;
+    }
+};
+const router = express.Router();
+router.get("/getAllUserList", async (req, res) => {
+    const result = await getAllUserList();
+    res.send(result);
+});
+//将路由挂载到express实例中
+app.use("/api/teamspeak", router);
+export default teamspeak3;

package/lib/cli/pr.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/lib/cli/pr.js

@@ -0,0 +1,93 @@
+#!/usr/bin/env node
+import fs from "fs";
+/**
+ * @description 获取package.json路径
+ */
+const getPkgPath = () => process.cwd() + "/package.json";
+/**
+ * @description 读取package.json
+ */
+const readPkg = () => JSON.parse(fs.readFileSync(getPkgPath(), "utf-8"));
+/**
+ * @description 写入package.json
+ * @param pkg package.json
+ */
+const writePkg = (pkg) => fs.writeFileSync(getPkgPath(), JSON.stringify(pkg, null, 2));
+/**
+ * @description 构建pr版本号 <主版本号>.<次版本号>.<修订号>.<PR标识>.<PR编号>.<当前提交唯一短哈希>
+ * @example 1.0.0.pr.184.a1b2c3d
+ * @param pkg package.json
+ */
+const updateVersion = (pkg) => {
+    const list = pkg.version.split(".");
+    const shortHash = process.env.GITHUB_SHA?.substring(0, 7) ?? "unknown";
+    list[2] = `${Number(list[2]) + 1}`;
+    pkg.version = `${list.join(".")}-pr${process.env.PR_NUMBER}.${shortHash}`;
+};
+/**
+ * @description 设置环境变量
+ * @param pkg package.json
+ */
+const setEnvVariables = (pkg) => {
+    const githubEnvPath = process.env.GITHUB_ENV;
+    if (!githubEnvPath) {
+        throw new Error("GITHUB_ENV 环境变量未定义");
+    }
+    fs.appendFileSync(githubEnvPath, `PKG_NAME=${pkg.name}\nPKG_VERSION=${pkg.version}\n`);
+};
+/**
+ * @description 更新版本号并设置环境变量
+ */
+const version = () => {
+    console.log("开始执行版本更新...");
+    const pkg = readPkg();
+    console.log(`当前版本: ${pkg.version}`);
+    updateVersion(pkg);
+    console.log(`更新后版本: ${pkg.version}`);
+    writePkg(pkg);
+    console.log("package.json 写入成功");
+    setEnvVariables(pkg);
+    console.log("环境变量设置完成");
+};
+/**
+ * @description 删除devDependencies和
+ */
+const clean = () => {
+    console.log("开始清理依赖...");
+    const pkg = readPkg();
+    console.log("正在删除 devDependencies");
+    delete pkg.devDependencies;
+    writePkg(pkg);
+    console.log("依赖清理完成");
+};
+/**
+ * @description 执行所有操作
+ */
+const all = () => {
+    console.log("开始执行所有操作...");
+    const pkg = readPkg();
+    console.log(`当前版本: ${pkg.version}`);
+    updateVersion(pkg);
+    console.log(`更新后版本: ${pkg.version}`);
+    console.log("正在删除 devDependencies");
+    delete pkg.devDependencies;
+    writePkg(pkg);
+    console.log("package.json 写入成功");
+    setEnvVariables(pkg);
+    console.log("环境变量设置完成");
+    console.log("所有操作执行完毕");
+};
+const cmd = process.argv[2];
+console.log(`执行命令: ${cmd}`);
+if (cmd.includes("version")) {
+    version();
+}
+else if (cmd.includes("clean")) {
+    clean();
+}
+else if (cmd.includes("all")) {
+    all();
+}
+else {
+    console.log("未知命令，可用命令: version, clean, all");
+}

package/lib/index.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/index.js

@@ -0,0 +1,4 @@
+import { logger } from "node-karin";
+import { basename, pkg } from "./utils/index.js";
+/** 请不要在这编写插件 不会有任何效果~ */
+logger.info(`${logger.violet(`[插件:${pkg().version}]`)} ${logger.green(basename)} 初始化完成~`);

package/lib/utils/config.d.ts

@@ -0,0 +1,11 @@
+import { Config } from "../../config/config/config.d";
+export declare const dir: string;
+export declare const dirConfig: string;
+/**
+ * @description 配置文件
+ */
+export declare const config: () => Config;
+/**
+ * @description package.json
+ */
+export declare const pkg: () => any;

package/lib/utils/config.js

@@ -0,0 +1,34 @@
+import { dirPath, basename } from "../utils/index.js";
+import { watch, logger, basePath, filesByExt, copyConfigSync, requireFileSync, } from "node-karin";
+import teamspeak3 from "../apps/ts3.js";
+export const dir = `${basePath}/${basename}`;
+export const dirConfig = `${dir}/config`;
+const defDir = `${dirPath}/config`;
+const defConfig = `${defDir}/config`;
+/**
+ * @description 初始化配置文件
+ */
+copyConfigSync(defConfig, dirConfig, [".json"]);
+/**
+ * @description 配置文件
+ */
+export const config = () => {
+    const cfg = requireFileSync(`${dirConfig}/config.json`);
+    const def = requireFileSync(`${defConfig}/config.json`);
+    return { ...def, ...cfg };
+};
+/**
+ * @description package.json
+ */
+export const pkg = () => requireFileSync(`${dirPath}/package.json`);
+/**
+ * @description 监听配置文件
+ */
+setTimeout(() => {
+    const list = filesByExt(dirConfig, ".json", "abs");
+    list.forEach((file) => watch(file, (old, now) => {
+        logger.info("旧数据:\n", old);
+        logger.info("新数据:\n", now);
+        teamspeak3.init();
+    }));
+}, 2000);

package/lib/utils/dir.d.ts

@@ -0,0 +1,5 @@
+/** 插件包绝对路径 */
+declare const dirPath: string;
+/** 插件包的名称 */
+declare const basename: string;
+export { dirPath, basename };

package/lib/utils/dir.js

@@ -0,0 +1,9 @@
+import path from "path";
+import { fileURLToPath } from "url";
+/** 当前文件的绝对路径 */
+const filePath = fileURLToPath(import.meta.url).replace(/\\/g, "/");
+/** 插件包绝对路径 */
+const dirPath = path.resolve(filePath, "../../../");
+/** 插件包的名称 */
+const basename = path.basename(dirPath);
+export { dirPath, basename };

package/lib/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./dir.js";
+export * from "./config.js";

package/lib/utils/index.js

@@ -0,0 +1,2 @@
+export * from "./dir.js";
+export * from "./config.js";

package/lib/web.config.d.ts

@@ -0,0 +1,15 @@
+import { Config } from "config/config/config.d";
+declare const _default: {
+    info: {
+        name: string;
+        description: string;
+    };
+    /** 动态渲染的组件 */
+    components: () => (import("node-karin").InputProps | import("node-karin").RadioGroupProps | import("node-karin").InputGroupProps)[];
+    /** 前端点击保存之后调用的方法 */
+    save: (config: Config) => {
+        success: boolean;
+        message: string;
+    };
+};
+export default _default;

package/lib/web.config.js

@@ -0,0 +1,144 @@
+import { components, logger, writeJsonSync } from "node-karin";
+import { config, dirConfig } from "./utils/index.js";
+export default {
+    info: {
+        // 插件信息配置
+        name: "Teamspeak3 服务器",
+        description: "连接并管理 Teamspeak3 语音服务器",
+    },
+    /** 动态渲染的组件 */
+    components: () => [
+        components.input.string("HOST", {
+            label: "teamspeak 服务器地址或域名(不带端口)",
+            defaultValue: config().HOST,
+            variant: "underlined",
+            placeholder: "请输入服务器地址或域名",
+            rules: [
+                {
+                    regex: /^((\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.){3}(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])$|^([0-9a-zA-Z-]{1,}\.)+([a-zA-Z]{2,})$/,
+                    error: "请输入正确的IP地址或域名",
+                },
+            ],
+        }),
+        components.input.string("SERVER_NAME", {
+            label: "展示的服务器名(不填写则显示服务器地址)",
+            placeholder: "请输入展示的服务器名",
+            defaultValue: config().SERVER_NAME,
+            variant: "underlined",
+            isRequired: false,
+        }),
+        components.radio.group("PROTOCOL", {
+            defaultValue: config().PROTOCOL,
+            label: "teamspeak 服务器查询 (一般使用默认的RAW即可)",
+            size: "sm",
+            orientation: "horizontal",
+            radio: [
+                {
+                    componentType: "radio",
+                    key: "PROTOCOL_RAW",
+                    value: "RAW",
+                    label: "RAW",
+                },
+                {
+                    componentType: "radio",
+                    key: "PROTOCOL_SSH",
+                    value: "SSH",
+                    label: "SSH",
+                },
+            ],
+        }),
+        components.input.number("QUERY_PORT", {
+            label: "teamspeak 服务器查询端口 (一般使用默认 10011 即可)",
+            type: "number",
+            placeholder: "请输入服务器查询端口",
+            variant: "underlined",
+            defaultValue: config().QUERY_PORT + "",
+            rules: [{ min: 1, max: 65535 }],
+        }),
+        components.input.number("SERVER_PORT", {
+            label: "teamspeak 服务器语音端口 (一般使用默认 9987 即可)",
+            defaultValue: config().SERVER_PORT + "",
+            placeholder: "请输入服务器语音端口",
+            variant: "underlined",
+            rules: [{ min: 1, max: 65535 }],
+        }),
+        components.input.number("RECONNECT_TIMER", {
+            label: "teamspeak 连接断开后重连次数 (-1表示将不断尝试)",
+            defaultValue: config().RECONNECT_TIMER + "",
+            placeholder: "请输入重连次数",
+            variant: "underlined",
+            rules: [{ min: -1 }],
+        }),
+        components.input.string("USERNAME", {
+            label: "teamspeak 管理员用户名 (建服时出现的,没修改时默认是 serveradmin )",
+            defaultValue: config().USERNAME,
+            placeholder: "请输入管理员用户名",
+            variant: "underlined",
+        }),
+        components.input.string("PASSWORD", {
+            label: "teamspeak 管理员密码 (建服时出现的,每个服务器都不一样)",
+            defaultValue: config().PASSWORD,
+            type: "password",
+            placeholder: "请输入管理员密码",
+            variant: "underlined",
+        }),
+        components.input.string("NICKNAME", {
+            label: "插件连接进服务器时使用的昵称 (默认为TSBOT,···客户端看不到该用户···) ",
+            placeholder: "请输入连接昵称",
+            defaultValue: config().NICKNAME,
+            variant: "underlined",
+        }),
+        components.input.group("NOTICE_GROUP_NO", {
+            label: "通知用户进出ts3的群号 可多个(如果是QQ官BOT,此处需要填写OPEN_GROUP_ID。请先在对应群内触发人数并在后台获取OPEN_GROUP_ID,请查看readme来获取详情)",
+            template: {
+                componentType: "input",
+                key: "NOTICE_GROUP_NO",
+                type: "text",
+                variant: "faded",
+                placeholder: "请输入群号",
+            },
+            data: [...config().NOTICE_GROUP_NO.map((i) => i + "")],
+        }),
+        components.input.group("DIS_NOTIFY_NAME_LIST", {
+            label: "不提醒的昵称列表 可多个 (不会提醒当前机器人，无需添加当前机器人昵称)",
+            template: {
+                componentType: "input",
+                key: "DIS_NOTIFY_NAME",
+                type: "text",
+                variant: "faded",
+                placeholder: "请输入昵称",
+            },
+            data: [...config().DIS_NOTIFY_NAME_LIST],
+        }),
+        components.radio.group("ENABLE_CHANNEL_MOVE_NOTIFY", {
+            defaultValue: config().ENABLE_CHANNEL_MOVE_NOTIFY ? "true" : "false",
+            label: "移动频道播报功能",
+            description: "当用户在Teamspeak中移动频道时自动播报",
+            size: "sm",
+            orientation: "horizontal",
+            radio: [
+                {
+                    componentType: "radio",
+                    key: "ENABLE_CHANNEL_MOVE_NOTIFY_TRUE",
+                    value: "true",
+                    label: "开启",
+                },
+                {
+                    componentType: "radio",
+                    key: "ENABLE_CHANNEL_MOVE_NOTIFY_FALSE",
+                    value: "false",
+                    label: "关闭",
+                },
+            ],
+        }),
+    ],
+    /** 前端点击保存之后调用的方法 */
+    save: (config) => {
+        logger.info("保存的配置:", config);
+        writeJsonSync(`${dirConfig}/config.json`, config);
+        return {
+            success: true,
+            message: "保存成功",
+        };
+    },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "karin-plugin-teamspeak",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "karin 的 teamspeak 插件",
   "homepage": "https://github.com/jacksixth/karin-plugin-teamspeak3",
   "bugs": {