QLAPI.systemNotify 支持自定义通知类型和参数

back/config/const.ts

@@ -25,3 +25,27 @@ export const SAMPLE_FILES = [
 ];
 
 export const PYTHON_INSTALL_DIR = process.env.PYTHON_HOME;
+
+export const NotificationModeStringMap = {
+  0: 'gotify',
+  1: 'goCqHttpBot',
+  2: 'serverChan',
+  3: 'pushDeer',
+  4: 'bark',
+  5: 'chat',
+  6: 'telegramBot',
+  7: 'dingtalkBot',
+  8: 'weWorkBot',
+  9: 'weWorkApp',
+  10: 'aibotk',
+  11: 'iGot',
+  12: 'pushPlus',
+  13: 'wePlusBot',
+  14: 'email',
+  15: 'pushMe',
+  16: 'feishu',
+  17: 'webhook',
+  18: 'chronocat',
+  19: 'ntfy',
+  20: 'wxPusherBot',
+} as const;

back/data/notify.ts

@@ -1,5 +1,3 @@
-import { IncomingHttpHeaders } from 'http';
-
 export enum NotificationMode {
   'gotify' = 'gotify',
   'goCqHttpBot' = 'goCqHttpBot',

back/protos/api.proto

@@ -53,14 +53,7 @@ message Response {
   optional string message = 2;
 }
 
-message SystemNotifyRequest {
+message ExtraScheduleItem { string schedule = 1; }
-  string title = 1;
-  string content = 2;
-}
-
-message ExtraScheduleItem {
-  string schedule = 1;
-}
 
 message CronItem {
   optional int32 id = 1;
@@ -124,6 +117,128 @@ message CronDetailResponse {
   optional string message = 3;
 }
 
+enum NotificationMode {
+  gotify = 0;
+  goCqHttpBot = 1;
+  serverChan = 2;
+  pushDeer = 3;
+  bark = 4;
+  chat = 5;
+  telegramBot = 6;
+  dingtalkBot = 7;
+  weWorkBot = 8;
+  weWorkApp = 9;
+  aibotk = 10;
+  iGot = 11;
+  pushPlus = 12;
+  wePlusBot = 13;
+  email = 14;
+  pushMe = 15;
+  feishu = 16;
+  webhook = 17;
+  chronocat = 18;
+  ntfy = 19;
+  wxPusherBot = 20;
+}
+
+message NotificationInfo {
+  NotificationMode type = 1;
+
+  optional string gotifyUrl = 2;
+  optional string gotifyToken = 3;
+  optional int32 gotifyPriority = 4;
+
+  optional string goCqHttpBotUrl = 5;
+  optional string goCqHttpBotToken = 6;
+  optional string goCqHttpBotQq = 7;
+
+  optional string serverChanKey = 8;
+
+  optional string pushDeerKey = 9;
+  optional string pushDeerUrl = 10;
+
+  optional string synologyChatUrl = 11;
+
+  optional string barkPush = 12;
+  optional string barkIcon = 13;
+  optional string barkSound = 14;
+  optional string barkGroup = 15;
+  optional string barkLevel = 16;
+  optional string barkUrl = 17;
+  optional string barkArchive = 18;
+
+  optional string telegramBotToken = 19;
+  optional string telegramBotUserId = 20;
+  optional string telegramBotProxyHost = 21;
+  optional string telegramBotProxyPort = 22;
+  optional string telegramBotProxyAuth = 23;
+  optional string telegramBotApiHost = 24;
+
+  optional string dingtalkBotToken = 25;
+  optional string dingtalkBotSecret = 26;
+
+  optional string weWorkBotKey = 27;
+  optional string weWorkOrigin = 28;
+
+  optional string weWorkAppKey = 29;
+
+  optional string aibotkKey = 30;
+  optional string aibotkType = 31;
+  optional string aibotkName = 32;
+
+  optional string iGotPushKey = 33;
+
+  optional string pushPlusToken = 34;
+  optional string pushPlusUser = 35;
+  optional string pushPlusTemplate = 36;
+  optional string pushplusChannel = 37;
+  optional string pushplusWebhook = 38;
+  optional string pushplusCallbackUrl = 39;
+  optional string pushplusTo = 40;
+
+  optional string wePlusBotToken = 41;
+  optional string wePlusBotReceiver = 42;
+  optional string wePlusBotVersion = 43;
+
+  optional string emailService = 44;
+  optional string emailUser = 45;
+  optional string emailPass = 46;
+  optional string emailTo = 47;
+
+  optional string pushMeKey = 48;
+  optional string pushMeUrl = 49;
+
+  optional string chronocatURL = 50;
+  optional string chronocatQQ = 51;
+  optional string chronocatToken = 52;
+
+  optional string webhookHeaders = 53;
+  optional string webhookBody = 54;
+  optional string webhookUrl = 55;
+  optional string webhookMethod = 56;
+  optional string webhookContentType = 57;
+
+  optional string larkKey = 58;
+
+  optional string ntfyUrl = 59;
+  optional string ntfyTopic = 60;
+  optional string ntfyPriority = 61;
+  optional string ntfyToken = 62;
+  optional string ntfyUsername = 63;
+  optional string ntfyPassword = 64;
+  optional string ntfyActions = 65;
+
+  optional string wxPusherBotAppToken = 66;
+  optional string wxPusherBotTopicIds = 67;
+  optional string wxPusherBotUids = 68;
+}
+
+message SystemNotifyRequest {
+  string title = 1;
+  string content = 2;
+  optional NotificationInfo notificationInfo = 3;
+}
+
 service Api {
   rpc GetEnvs(GetEnvsRequest) returns (EnvsResponse) {}
   rpc CreateEnv(CreateEnvRequest) returns (EnvsResponse) {}

back/schedule/api.ts

@@ -31,6 +31,7 @@ import {
   DeleteCronsRequest,
   CronResponse,
 } from '../protos/api';
+import { NotificationInfo } from '../data/notify';
 
 Container.set('logger', LoggerInstance);
 
@@ -227,7 +228,11 @@ export const systemNotify = async (
 ) => {
   try {
     const systemService = Container.get(SystemService);
-    const data = await systemService.notify(call.request);
+    const data = await systemService.notify({
+      title: call.request.title,
+      content: call.request.content,
+      notificationInfo: call.request.notificationInfo as unknown as NotificationInfo,
+    });
     callback(null, data);
   } catch (e: any) {
     callback(e);

back/services/notify.ts

@@ -49,12 +49,21 @@ export default class NotificationService {
   public async notify(
     title: string,
     content: string,
+    notificationInfo?: NotificationInfo,
   ): Promise<boolean | undefined> {
-    const { type, ...rest } = await this.userService.getNotificationMode();
+    let { type, ...rest } = await this.userService.getNotificationMode();
+    if (notificationInfo?.type) {
+      type = notificationInfo?.type;
+    }
     if (type) {
       this.title = title;
       this.content = content;
-      this.params = rest;
+      let params = rest;
+      if (notificationInfo) {
+        const { type: _, ...others } = notificationInfo;
+        params = { ...rest, ...others };
+      }
+      this.params = params;
       const notificationModeAction = this.modeMap.get(type);
       try {
         return await notificationModeAction?.call(this);
@@ -623,7 +632,15 @@ export default class NotificationService {
   }
 
   private async ntfy() {
-    const { ntfyUrl, ntfyTopic, ntfyPriority, ntfyToken, ntfyUsername, ntfyPassword, ntfyActions } = this.params;
+    const {
+      ntfyUrl,
+      ntfyTopic,
+      ntfyPriority,
+      ntfyToken,
+      ntfyUsername,
+      ntfyPassword,
+      ntfyActions,
+    } = this.params;
     // 编码函数
     const encodeRfc2047 = (text: string, charset: string = 'UTF-8'): string => {
       const encodedText = Buffer.from(text).toString('base64');
@@ -638,7 +655,9 @@ export default class NotificationService {
       if (ntfyToken) {
         headers['Authorization'] = `Bearer ${ntfyToken}`;
       } else if (ntfyUsername && ntfyPassword) {
-        headers['Authorization'] = `Basic ${Buffer.from(`${ntfyUsername}:${ntfyPassword}`).toString('base64')}`;
+        headers['Authorization'] = `Basic ${Buffer.from(
+          `${ntfyUsername}:${ntfyPassword}`,
+        ).toString('base64')}`;
       }
       if (ntfyActions) {
         headers['Actions'] = encodeRfc2047(ntfyActions);

back/services/system.ts

@@ -7,7 +7,7 @@ import path from 'path';
 import { Inject, Service } from 'typedi';
 import winston from 'winston';
 import config from '../config';
-import { TASK_COMMAND } from '../config/const';
+import { NotificationModeStringMap, TASK_COMMAND } from '../config/const';
 import {
   getPid,
   killTask,
@@ -373,8 +373,27 @@ export default class SystemService {
     return { code: 200 };
   }
 
-  public async notify({ title, content }: { title: string; content: string }) {
+  public async notify({
-    const isSuccess = await this.notificationService.notify(title, content);
+    title,
+    content,
+    notificationInfo,
+  }: {
+    title: string;
+    content: string;
+    notificationInfo?: NotificationInfo;
+  }) {
+    const typeString =
+      typeof notificationInfo?.type === 'number'
+        ? NotificationModeStringMap[notificationInfo.type]
+        : undefined;
+    if (notificationInfo && typeString) {
+      notificationInfo.type = typeString;
+    }
+    const isSuccess = await this.notificationService.notify(
+      title,
+      content,
+      notificationInfo,
+    );
     if (isSuccess) {
       return { code: 200, message: '通知发送成功' };
     } else {