karin-plugin-teamspeak 1.4.1 → 1.5.0

package/README.md

@@ -1,13 +1,15 @@
 # karin-plugin-teamspeak3
 
-karin 下的 [teamspeak](https://www.teamspeak.com/zh-CN/) 插件，使用ts开发。
+karin 下的 [teamspeak](https://www.teamspeak.com/zh-CN/) 插件，使用 ts 开发。
 需要搭配 [karin](https://karin.fun/) 使用。
-在用户进入离开ts服务器时在群里发送用户进出提示
-也会响应QQ群或私聊的 `人数` 命令发送当前服务器内有人在的频道的人数和进入时长
+在用户进入离开 ts 服务器时在群里发送用户进出提示
+也会响应 QQ 群或私聊的 `人数` 命令发送当前服务器内有人在的频道的人数和进入时长
 
 # 使用方法
 
 1. 安装该插件
-2. 运行一次 `npx karin .`
-3. 在karin web界面的插件页签中配置该插件
-4. 保存后查看命令行是否成功连接服务器
+   - `包管理器` 可以通过 `pnpm add karin-plugin-teamspeak@latest -w` 安装
+   - `使用编译产物` 可以 clone 该仓库的 build 分支 `git clone --depth=1 -b build https://github.com/jacksixth/karin-plugin-teamspeak3.git ./plugins/karin-plugin-teamspeak/`，然后通过运行 `pnpm install --filter=karin-plugin-teamspeak` 安装
+2. 运行 `npx karin .`
+3. 在 karin web 界面的插件页签中配置该插件
+4. 保存配置后查看命令行是否成功连接服务器

package/lib/apps/ts3.d.ts

@@ -8,4 +8,14 @@ declare class ts3 {
     reconnectTs: () => Promise<void>;
 }
 declare const teamspeak3: ts3;
+export declare const getAllUserList: () => Promise<{
+    res: {
+        [name: string]: {
+            nickName: string;
+            lastconnected: string;
+            connectTime: string;
+        }[];
+    };
+    count: number;
+} | null | undefined>;
 export default teamspeak3;

package/lib/apps/ts3.js

@@ -1,8 +1,10 @@
 import { QueryProtocol, TeamSpeak } from "ts3-nodejs-library";
-import { config } from "../utils/index.js";
-import karin, { logger, segment } from "node-karin";
+import { config, dirPath } from "../utils/index.js";
+import karin, { logger, segment, app } from "node-karin";
 import moment from "node-karin/moment";
-logger.info("初始化ts3插件");
+import express from "node-karin/express";
+const loggerHex = logger.chalk.hex("#90CAF9");
+logger.info(loggerHex(" ===== ts3 ===== ") + "初始化ts3插件");
 let disNotifyNameList = [];
 class ts3 {
     teamspeak;
@@ -12,7 +14,7 @@ class ts3 {
         const TS = config();
         //fix ReferenceError: Cannot access 'config' before initialization
         disNotifyNameList = [TS.NICKNAME, ...TS.DIS_NOTIFY_NAME_LIST];
-        logger.info("开始连接ts3服务器...");
+        logger.info(loggerHex(" ===== ts3 ===== ") + "开始连接ts3服务器...");
         if (this.teamspeak) {
             await this.teamspeak.quit();
             this.teamspeak = undefined;
@@ -27,43 +29,43 @@ class ts3 {
             nickname: TS.NICKNAME,
         });
         _teamspeak.on("ready", async () => {
-            logger.info("ts3连接成功");
+            logger.info(loggerHex(" ===== ts3 ===== ") + "ts3连接成功");
             this.teamspeak = _teamspeak;
         });
         _teamspeak.on("close", (e) => {
-            logger.error("ts3连接断开", e);
+            logger.error(loggerHex(" ===== ts3 ===== ") + "ts3连接断开", e);
             if (this.teamspeak) {
-                logger.info("重连中...");
+                logger.info(loggerHex(" ===== ts3 ===== ") + "重连中...");
                 this.teamspeak
                     .reconnect(TS.RECONNECT_TIMER, 1000)
                     .catch((e) => {
-                    logger.error("连接TS3失败", e);
+                    logger.error(loggerHex(" ===== ts3 ===== ") + "连接TS3失败", e);
                 })
                     .then(() => {
-                    logger.info("重连成功");
+                    logger.info(loggerHex(" ===== ts3 ===== ") + "重连成功");
                 });
             }
         });
         _teamspeak.on("error", (err) => {
-            logger.error("ts3连接出错", err);
+            logger.error(loggerHex(" ===== ts3 ===== ") + "ts3连接出错", err);
             if (this.teamspeak) {
-                logger.info("重连中...");
+                logger.info(loggerHex(" ===== ts3 ===== ") + "重连中...");
                 this.teamspeak
                     .reconnect(TS.RECONNECT_TIMER, 1000)
                     .catch((e) => {
-                    logger.error("连接TS3失败", e);
+                    logger.error(loggerHex(" ===== ts3 ===== ") + "连接TS3失败", e);
                 })
                     .then(() => {
-                    logger.info("重连成功");
+                    logger.info(loggerHex(" ===== ts3 ===== ") + "重连成功");
                 });
             }
         });
         _teamspeak.on("clientconnect", (e) => {
             if (!disNotifyNameList.includes(e.client.nickname)) {
-                logger.info(e.client.nickname + "进入ts");
+                logger.info(loggerHex(" ===== ts3 ===== ") + e.client.nickname + "进入ts");
                 const msg = segment.text(e.client.nickname + "进入ts");
-                const qq = config().BOT_SELF_ID;
-                config().NOTICE_GROUP_NO.forEach((groupNo) => {
+                const qq = TS.BOT_SELF_ID;
+                TS.NOTICE_GROUP_NO.forEach((groupNo) => {
                     const contact = karin.contact("group", groupNo + "");
                     karin.sendMsg(karin.getBotAll()[1].account.selfId, contact, msg);
                 });
@@ -72,9 +74,9 @@ class ts3 {
         _teamspeak.on("clientdisconnect", (e) => {
             if (e.client) {
                 if (!disNotifyNameList.includes(e.client.nickname)) {
-                    logger.info(e.client.nickname + "离开ts");
+                    logger.info(loggerHex(" ===== ts3 ===== ") + e.client.nickname + "离开ts");
                     const msg = segment.text(e.client.nickname + "离开ts");
-                    config().NOTICE_GROUP_NO.forEach((groupNo) => {
+                    TS.NOTICE_GROUP_NO.forEach((groupNo) => {
                         const contact = karin.contact("group", groupNo + "");
                         karin.sendMsg(karin.getBotAll()[1].account.selfId, contact, msg);
                     });
@@ -82,7 +84,7 @@ class ts3 {
             }
         });
     };
-    //获取ts3服务器的所有对应频道的人
+    //获取ts3服务器的所有对应频道的人 -- 并组装成文字可直接发
     getAllChannelList = async () => {
         if (!this.teamspeak) {
             return;
@@ -94,10 +96,11 @@ class ts3 {
         // } catch (error) {
         //   usePuppeteer = false
         // }
+        const TS = config();
         const renderList = [];
         renderList.push(usePuppeteer
-            ? `<h1>${config().SERVER_NAME || config().HOST}</h1>`
-            : `====${config().SERVER_NAME || config().HOST}====`);
+            ? `<h1>${TS.SERVER_NAME || TS.HOST}</h1>`
+            : `====${TS.SERVER_NAME || TS.HOST}====`);
         renderList.push(usePuppeteer
             ? `<div class="tips">仅展示有人的频道</div>`
             : `仅展示有人的频道 `);
@@ -155,4 +158,44 @@ setTimeout(() => {
     //确保配置文件生成且正确保存
     teamspeak3.init();
 }, 1000);
+//获取ts3服务器内所有频道内在线人数 -- 给接口用
+export const getAllUserList = async () => {
+    if (teamspeak3.teamspeak) {
+        let count = 0;
+        const res = {};
+        const channelList = await teamspeak3.teamspeak.channelList(); //所有频道
+        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 {
+                res,
+                count,
+            };
+        }
+    }
+    else {
+        return null;
+    }
+};
+const router = express.Router();
+router.get("/getAllUserList", async (req, res) => {
+    const result = await getAllUserList();
+    res.send(result);
+});
+app.use("/ts3Api", router);
+app.use(express.static(dirPath + "/resources/static"));
 export default teamspeak3;

package/package.json

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