diff --git a/icons/FeiShu_A.png b/icons/FeiShu_A.png new file mode 100644 index 0000000..c0b0446 Binary files /dev/null and b/icons/FeiShu_A.png differ diff --git a/package.json b/package.json index 2fcbdb1..dab3491 100644 --- a/package.json +++ b/package.json @@ -462,5 +462,13 @@ "icon": "DownloaderHelper.png", "author": "hotlcc", "level": 2 + }, + "FeiShuMsg": { + "name": "飞书机器人消息通知", + "description": "支持使用飞书群聊机器人发送消息通知。", + "version": "1.0", + "icon": "FeiShu_A.png", + "author": "InfinityPacer", + "level": 2 } } diff --git a/plugins/feishumsg/__init__.py b/plugins/feishumsg/__init__.py new file mode 100644 index 0000000..69988b7 --- /dev/null +++ b/plugins/feishumsg/__init__.py @@ -0,0 +1,263 @@ +import base64 +import hashlib +import hmac +import time +from typing import Any, List, Dict, Tuple + +from app.core.event import eventmanager, Event +from app.log import logger +from app.plugins import _PluginBase +from app.schemas.types import EventType, NotificationType +from app.utils.http import RequestUtils + + +class FeiShuMsg(_PluginBase): + # 插件名称 + plugin_name = "飞书机器人消息通知" + # 插件描述 + plugin_desc = "支持使用飞书群聊机器人发送消息通知。" + # 插件图标 + plugin_icon = "FeiShu_A.png" + # 插件版本 + plugin_version = "1.0" + # 插件作者 + plugin_author = "InfinityPacer" + # 作者主页 + author_url = "https://github.com/InfinityPacer" + # 插件配置项ID前缀 + plugin_config_prefix = "feishu_" + # 加载顺序 + plugin_order = 28 + # 可使用的用户级别 + auth_level = 1 + + # 私有属性 + _enabled = False + _webhookurl = None + _msgtypes = [] + _secret = None + + def init_plugin(self, config: dict = None): + if config: + self._enabled = config.get("enabled") + self._webhookurl = config.get("webhookurl") + self._msgtypes = config.get("msgtypes") or [] + self._secret = config.get("secret") + + def get_state(self) -> bool: + return self._enabled and (True if self._webhookurl else False) + + @staticmethod + def get_command() -> List[Dict[str, Any]]: + pass + + def get_api(self) -> List[Dict[str, Any]]: + pass + + def get_form(self) -> Tuple[List[dict], Dict[str, Any]]: + """ + 拼装插件配置页面，需要返回两块数据：1、页面配置；2、数据结构 + """ + # 遍历 NotificationType 枚举，生成消息类型选项 + msg_type_options = [] + default_msg_type_values = [] + for item in NotificationType: + msg_type_options.append({ + "title": item.value, + "value": item.name + }) + default_msg_type_values.append(item.name) + return [ + { + 'component': 'VForm', + 'content': [ + { + 'component': 'VRow', + 'content': [ + { + 'component': 'VCol', + 'props': { + 'cols': 12, + 'md': 6 + }, + 'content': [ + { + 'component': 'VSwitch', + 'props': { + 'model': 'enabled', + 'label': '启用插件', + } + } + ] + } + ] + }, + { + 'component': 'VRow', + 'content': [ + { + 'component': 'VCol', + 'props': { + 'cols': 12 + }, + 'content': [ + { + 'component': 'VTextField', + 'props': { + 'model': 'webhookurl', + 'label': 'WebHook地址', + 'placeholder': 'https://open.feishu.cn/open-apis/bot/v2/hook/xxxxxxxxxxxxxxxxx', + } + } + ] + } + ] + }, + { + 'component': 'VRow', + 'content': [ + { + 'component': 'VCol', + 'props': { + 'cols': 12 + }, + 'content': [ + { + 'component': 'VTextField', + 'props': { + 'model': 'secret', + 'label': '密钥', + 'placeholder': '如设置了签名校验，请输入密钥', + } + } + ] + } + ] + }, + { + 'component': 'VRow', + 'content': [ + { + 'component': 'VCol', + 'props': { + 'cols': 12 + }, + 'content': [ + { + 'component': 'VSelect', + 'props': { + 'multiple': True, + 'chips': True, + 'model': 'msgtypes', + 'label': '消息类型', + 'items': msg_type_options + } + } + ] + } + ] + }, + ] + } + ], { + "enabled": False, + 'webhookurl': '', + 'msgtypes': default_msg_type_values, + 'secret': '', + } + + def get_page(self) -> List[dict]: + pass + + @eventmanager.register(EventType.NoticeMessage) + def send(self, event: Event): + """ + 消息发送事件 + """ + if not self.get_state(): + return + + if not event.event_data: + return + + msg_body = event.event_data + # 渠道 + channel = msg_body.get("channel") + if channel: + logger.info(f"channel: {channel} 不进行消息推送") + return + # 类型 + msg_type: NotificationType = msg_body.get("type") + # 标题 + title = msg_body.get("title") + # 文本 + text = msg_body.get("text") + # 图像 + image = msg_body.get("image") + + if not title and not text: + logger.warn("标题和内容不能同时为空") + return + + if (msg_type and self._msgtypes + and msg_type.name not in self._msgtypes): + logger.info(f"消息类型 {msg_type.value} 未开启消息发送") + return + + try: + payload = { + "msg_type": "post", + "content": { + "post": { + "zh_cn": { + "title": title, + "content": [ + [{ + "tag": "text", + "text": text + }] + ] + } + } + } + } + + # 如果存在密钥时，还需要进行签名处理 + if self._secret: + timestamp = str(int(time.time())) + sign = self.gen_sign(timestamp, self._secret) + payload.update({ + "timestamp": timestamp, + "sign": sign + }) + + res = RequestUtils(content_type="application/json").post_res(url=self._webhookurl, json=payload) + if res and res.status_code == 200: + ret_json = res.json() + errno = ret_json.get('code') + error = ret_json.get('msg') + if errno == 0: + logger.info("飞书机器人消息发送成功") + else: + logger.warn(f"飞书机器人消息发送失败，错误码：{errno}，错误原因：{error}") + elif res is not None: + logger.warn(f"飞书机器人消息发送失败，错误码：{res.status_code}，错误原因：{res.reason}") + else: + logger.warn("飞书机器人消息发送失败，未获取到返回信息") + except Exception as msg_e: + logger.error(f"飞书机器人消息发送失败，{str(msg_e)}") + + def stop_service(self): + """ + 退出插件 + """ + pass + + @staticmethod + def gen_sign(timestamp, secret): + # 拼接timestamp和secret + string_to_sign = '{}\n{}'.format(timestamp, secret) + hmac_code = hmac.new(string_to_sign.encode("utf-8"), digestmod=hashlib.sha256).digest() + # 对结果进行base64处理 + sign = base64.b64encode(hmac_code).decode('utf-8') + return sign