NapCatQQ source snapshot

packages/napcat-onebot/action/system/CanSendImage.ts

@@ -0,0 +1,11 @@
+import { ActionName } from '@/napcat-onebot/action/router';
+import { CanSend } from './CanSendRecord';
+
+export default class CanSendImage extends CanSend {
+  override actionName = ActionName.CanSendImage;
+  override actionSummary = '是否可以发送图片';
+  override actionDescription = '检查是否可以发送图片';
+  override actionTags = ['系统接口'];
+  override payloadExample = {};
+  override returnExample = { yes: true };
+}

packages/napcat-onebot/action/system/CanSendRecord.ts

@@ -0,0 +1,30 @@
+import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
+import { ActionName } from '@/napcat-onebot/action/router';
+import { Type, Static } from '@sinclair/typebox';
+
+export const CanSendReturnSchema = Type.Object({
+  yes: Type.Boolean({ description: '是否可以发送' }),
+});
+
+export type CanSendReturnType = Static<typeof CanSendReturnSchema>;
+
+export class CanSend extends OneBotAction<void, CanSendReturnType> {
+  override payloadSchema = Type.Object({});
+  override returnSchema = CanSendReturnSchema;
+  override actionTags = ['系统接口'];
+
+  async _handle (): Promise<CanSendReturnType> {
+    return {
+      yes: true,
+    };
+  }
+}
+
+export default class CanSendRecord extends CanSend {
+  override actionName = ActionName.CanSendRecord;
+  override actionSummary = '是否可以发送语音';
+  override actionDescription = '检查是否可以发送语音';
+  override actionTags = ['系统接口'];
+  override payloadExample = {};
+  override returnExample = { yes: true };
+}

packages/napcat-onebot/action/system/CleanCache.ts

@@ -0,0 +1,75 @@
+import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
+import { ActionName } from '@/napcat-onebot/action/router';
+import { unlink, readdir } from 'fs/promises';
+import path, { join } from 'path';
+import { Type } from '@sinclair/typebox';
+
+export class CleanCache extends OneBotAction<void, void> {
+  override actionName = ActionName.CleanCache;
+  override payloadSchema = Type.Object({});
+  override returnSchema = Type.Null();
+  override actionSummary = '清理缓存';
+  override actionDescription = '清理缓存';
+  override actionTags = ['系统接口'];
+  override payloadExample = {};
+  override returnExample = null;
+
+  async _handle () {
+    try {
+      // 获取临时文件夹路径
+      const tempPath = this.core.NapCatTempPath;
+
+      // 读取文件夹中的所有文件
+      const files = await readdir(tempPath);
+
+      // 删除每个文件
+      const deletePromises = files.map(async (file) => {
+        const filePath = join(tempPath, file);
+        try {
+          await unlink(filePath);
+          this.core.context.logger.log(`已删除文件: ${filePath}`);
+        } catch (err: unknown) {
+          this.core.context.logger.log(`删除文件 ${filePath} 失败: ${(err as Error).message}`);
+        }
+      });
+
+      // 等待所有删除操作完成
+      await Promise.all(deletePromises);
+      const basic_path = path.join(this.core.dataPath, this.core.selfInfo.uin || '10001', 'nt_qq', 'nt_data');
+
+      // 需要清理的目录列表
+      const dirsToClean = ['Pic', 'Ptt', 'Video', 'File', 'log'];
+
+      // 清理每个指定目录
+      for (const dir of dirsToClean) {
+        const dirPath = path.join(basic_path, dir);
+        try {
+          // 检查目录是否存在
+          const files = await readdir(dirPath).catch(() => null);
+          if (files) {
+            // 删除目录下的所有文件
+            const dirDeletePromises = files.map(async (file) => {
+              const filePath = path.join(dirPath, file);
+              try {
+                await unlink(filePath);
+                this.core.context.logger.log(`已删除文件: ${filePath}`);
+              } catch (err: unknown) {
+                this.core.context.logger.log(`删除文件 ${filePath} 失败: ${(err as Error).message}`);
+              }
+            });
+
+            await Promise.all(dirDeletePromises);
+            this.core.context.logger.log(`目录清理完成: ${dirPath}`);
+          }
+        } catch (err: unknown) {
+          this.core.context.logger.log(`清理目录 ${dirPath} 失败: ${(err as Error).message}`);
+        }
+      }
+
+      this.core.context.logger.log(`临时文件夹清理完成: ${tempPath}`);
+    } catch (err: unknown) {
+      this.core.context.logger.log(`清理缓存失败: ${(err as Error).message}`);
+      throw err;
+    }
+  }
+}

packages/napcat-onebot/action/system/GetCSRF.ts

@@ -0,0 +1,32 @@
+import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
+import { ActionName } from '@/napcat-onebot/action/router';
+import { Type, Static } from '@sinclair/typebox';
+
+export const GetCSRFReturnSchema = Type.Object({
+  token: Type.Number({ description: 'CSRF Token' }),
+});
+
+export type GetCSRFReturnType = Static<typeof GetCSRFReturnSchema>;
+
+export class GetCSRF extends OneBotAction<void, GetCSRFReturnType> {
+  override actionName = ActionName.GetCSRF;
+  override payloadSchema = Type.Object({});
+  override returnSchema = GetCSRFReturnSchema;
+  override actionSummary = '获取 CSRF Token';
+  override actionDescription = '获取 CSRF Token';
+  override actionTags = ['系统接口'];
+  override payloadExample = {};
+  override returnExample = {
+    token: 123456789,
+  };
+
+  async _handle () {
+    const sKey = await this.core.apis.UserApi.getSKey();
+    if (!sKey) {
+      throw new Error('SKey is undefined');
+    }
+    return {
+      token: +this.core.apis.WebApi.getBknFromSKey(sKey),
+    };
+  }
+}

packages/napcat-onebot/action/system/GetCredentials.ts

@@ -0,0 +1,41 @@
+import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
+import { ActionName } from '@/napcat-onebot/action/router';
+import { Static, Type } from '@sinclair/typebox';
+
+export const GetCredentialsPayloadSchema = Type.Object({
+  domain: Type.String({ description: '需要获取 cookies 的域名' }),
+});
+
+export type GetCredentialsPayload = Static<typeof GetCredentialsPayloadSchema>;
+
+export const GetCredentialsReturnSchema = Type.Object({
+  cookies: Type.String({ description: 'Cookies' }),
+  token: Type.Number({ description: 'CSRF Token' }),
+});
+
+export type GetCredentialsResponse = Static<typeof GetCredentialsReturnSchema>;
+
+export class GetCredentials extends OneBotAction<GetCredentialsPayload, GetCredentialsResponse> {
+  override actionName = ActionName.GetCredentials;
+  override payloadSchema = GetCredentialsPayloadSchema;
+  override returnSchema = GetCredentialsReturnSchema;
+  override actionSummary = '获取登录凭证';
+  override actionDescription = '获取登录凭证';
+  override actionTags = ['系统接口'];
+  override payloadExample = {
+    domain: 'qun.qq.com',
+  };
+
+  override returnExample = {
+    cookies: 'uin=o123456789; skey=@abc12345;',
+    token: 123456789,
+  };
+
+  async _handle (payload: GetCredentialsPayload) {
+    const cookiesObject = await this.core.apis.UserApi.getCookies(payload.domain);
+    // 把获取到的cookiesObject转换成 k=v; 格式字符串拼接在一起
+    const cookies = Object.entries(cookiesObject).map(([key, value]) => `${key}=${value}`).join('; ');
+    const bkn = cookiesObject?.['skey'] ? this.core.apis.WebApi.getBknFromCookie(cookiesObject) : '';
+    return { cookies, token: +bkn };
+  }
+}

packages/napcat-onebot/action/system/GetLoginInfo.ts

@@ -0,0 +1,24 @@
+import { OB11User } from '@/napcat-onebot/index';
+import { OB11Construct } from '@/napcat-onebot/helper/data';
+import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
+import { ActionName } from '@/napcat-onebot/action/router';
+import { OB11UserSchema } from '../schemas';
+import { Type } from '@sinclair/typebox';
+import { SystemActionsExamples } from '@/napcat-onebot/action/example/SystemActionsExamples';
+
+class GetLoginInfo extends OneBotAction<void, OB11User> {
+  override actionName = ActionName.GetLoginInfo;
+  override payloadSchema = Type.Object({});
+  override returnSchema = OB11UserSchema;
+  override actionSummary = '获取登录号信息';
+  override actionDescription = '获取当前登录帐号的信息';
+  override actionTags = ['系统接口'];
+  override payloadExample = SystemActionsExamples.GetLoginInfo.payload;
+  override returnExample = SystemActionsExamples.GetLoginInfo.response;
+
+  async _handle () {
+    return OB11Construct.selfInfo(this.core.selfInfo);
+  }
+}
+
+export default GetLoginInfo;

packages/napcat-onebot/action/system/GetStatus.ts

@@ -0,0 +1,34 @@
+import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
+import { ActionName } from '@/napcat-onebot/action/router';
+import { Type, Static } from '@sinclair/typebox';
+
+export const GetStatusReturnSchema = Type.Object({
+  online: Type.Boolean({ description: '是否在线' }),
+  good: Type.Boolean({ description: '状态是否良好' }),
+  stat: Type.Unknown({ description: '统计信息' }),
+});
+
+export type GetStatusReturnType = Static<typeof GetStatusReturnSchema>;
+
+export default class GetStatus extends OneBotAction<void, GetStatusReturnType> {
+  override actionName = ActionName.GetStatus;
+  override payloadSchema = Type.Object({});
+  override returnSchema = GetStatusReturnSchema;
+  override actionSummary = '获取运行状态';
+  override actionDescription = '获取运行状态';
+  override actionTags = ['系统接口'];
+  override payloadExample = {};
+  override returnExample = {
+    online: true,
+    good: true,
+    stat: {},
+  };
+
+  async _handle (): Promise<GetStatusReturnType> {
+    return {
+      online: !!this.core.selfInfo.online,
+      good: true,
+      stat: {},
+    };
+  }
+}

packages/napcat-onebot/action/system/GetSystemMsg.ts

@@ -0,0 +1,69 @@
+import { GroupNotifyMsgStatus } from 'napcat-core';
+import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
+import { ActionName } from '@/napcat-onebot/action/router';
+import { Static, Type } from '@sinclair/typebox';
+import { OB11NotifySchema } from '../schemas';
+
+export const GetGroupSystemMsgPayloadSchema = Type.Object({
+  count: Type.Union([Type.Number(), Type.String()], { default: 50, description: '获取的消息数量' }),
+});
+
+export type GetGroupSystemMsgPayload = Static<typeof GetGroupSystemMsgPayloadSchema>;
+
+export const GetGroupSystemMsgReturnSchema = Type.Object({
+  invited_requests: Type.Array(OB11NotifySchema, { description: '进群邀请列表' }),
+  InvitedRequest: Type.Array(OB11NotifySchema, { description: '进群邀请列表 (兼容)' }),
+  join_requests: Type.Array(OB11NotifySchema, { description: '进群申请列表' }),
+});
+
+export type GetGroupSystemMsgReturn = Static<typeof GetGroupSystemMsgReturnSchema>;
+
+export class GetGroupSystemMsg extends OneBotAction<GetGroupSystemMsgPayload, GetGroupSystemMsgReturn> {
+  override actionName = ActionName.GetGroupSystemMsg;
+  override payloadSchema = GetGroupSystemMsgPayloadSchema;
+  override returnSchema = GetGroupSystemMsgReturnSchema;
+  override actionSummary = '获取群系统消息';
+  override actionDescription = '获取群系统消息';
+  override actionTags = ['系统接口'];
+  override payloadExample = {
+    count: 50,
+  };
+
+  override returnExample = {
+    invited_requests: [],
+    InvitedRequest: [],
+    join_requests: [],
+  };
+
+  async _handle (params: GetGroupSystemMsgPayload): Promise<GetGroupSystemMsgReturn> {
+    const SingleScreenNotifies = await this.core.apis.GroupApi.getSingleScreenNotifies(false, +params.count);
+    const retData: GetGroupSystemMsgReturn = { invited_requests: [], InvitedRequest: [], join_requests: [] };
+
+    const notifyPromises = SingleScreenNotifies.map(async (SSNotify) => {
+      const invitorUin = SSNotify.user1?.uid ? +await this.core.apis.UserApi.getUinByUidV2(SSNotify.user1.uid) : 0;
+      const actorUin = SSNotify.user2?.uid ? +await this.core.apis.UserApi.getUinByUidV2(SSNotify.user2.uid) : 0;
+      const commonData = {
+        request_id: +SSNotify.seq,
+        invitor_uin: invitorUin,
+        invitor_nick: SSNotify.user1?.nickName || '',
+        group_id: +SSNotify.group?.groupCode,
+        message: SSNotify?.postscript || '',
+        group_name: SSNotify.group?.groupName || '',
+        checked: SSNotify.status !== GroupNotifyMsgStatus.KUNHANDLE,
+        actor: actorUin,
+        requester_nick: SSNotify.user1?.nickName || '',
+      };
+
+      if (SSNotify.type === 1) {
+        retData.InvitedRequest.push(commonData);
+      } else if (SSNotify.type === 7) {
+        retData.join_requests.push(commonData);
+      }
+    });
+
+    await Promise.all(notifyPromises);
+
+    retData.invited_requests = retData.InvitedRequest;
+    return retData;
+  }
+}

packages/napcat-onebot/action/system/GetVersionInfo.ts

@@ -0,0 +1,34 @@
+import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
+import { ActionName } from '@/napcat-onebot/action/router';
+import { napCatVersion } from 'napcat-common/src/version';
+import { Type, Static } from '@sinclair/typebox';
+
+const ReturnSchema = Type.Object({
+  app_name: Type.String({ description: '应用名称' }),
+  protocol_version: Type.String({ description: '协议版本' }),
+  app_version: Type.String({ description: '应用版本' }),
+}, { description: '版本信息' });
+
+type ReturnType = Static<typeof ReturnSchema>;
+
+export default class GetVersionInfo extends OneBotAction<void, ReturnType> {
+  override actionName = ActionName.GetVersionInfo;
+  override returnSchema = ReturnSchema;
+  override actionSummary = '获取版本信息';
+  override actionDescription = '获取版本信息';
+  override actionTags = ['系统接口'];
+  override payloadExample = {};
+  override returnExample = {
+    app_name: 'NapCat.Onebot',
+    protocol_version: 'v11',
+    app_version: '1.0.0',
+  };
+
+  async _handle (): Promise<ReturnType> {
+    return {
+      app_name: 'NapCat.Onebot',
+      protocol_version: 'v11',
+      app_version: napCatVersion,
+    };
+  }
+}

packages/napcat-onebot/action/system/SetRestart.ts

@@ -0,0 +1,22 @@
+import { ActionName } from '@/napcat-onebot/action/router';
+import { OneBotAction } from '../OneBotAction';
+import { WebUiDataRuntime } from 'napcat-webui-backend/src/helper/Data';
+import { Type } from '@sinclair/typebox';
+
+export class SetRestart extends OneBotAction<void, void> {
+  override actionName = ActionName.Reboot;
+  override payloadSchema = Type.Object({});
+  override returnSchema = Type.Null();
+  override actionSummary = '重启服务';
+  override actionDescription = '重启服务';
+  override actionTags = ['系统接口'];
+  override payloadExample = {};
+  override returnExample = null;
+
+  async _handle () {
+    const result = await WebUiDataRuntime.requestRestartProcess();
+    if (!result.result) {
+      throw new Error(result.message || '进程重启失败');
+    }
+  }
+}