Files
2025-02-17 13:16:56 +08:00

286 lines
10 KiB
Python
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
from typing import Any, List, Dict, Tuple, Optional
from urllib.parse import parse_qs
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 BarkMsg(_PluginBase):
# 插件名称
plugin_name = "Bark消息通知"
# 插件描述
plugin_desc = "支持使用Bark发送消息通知。"
# 插件图标
plugin_icon = "Bark_A.png"
# 插件版本
plugin_version = "1.4"
# 插件作者
plugin_author = "jxxghp"
# 作者主页
author_url = "https://github.com/jxxghp"
# 插件配置项ID前缀
plugin_config_prefix = "barkmsg_"
# 加载顺序
plugin_order = 27
# 可使用的用户级别
auth_level = 1
# 私有属性
_enabled = False
_onlyonce = False
_server = None
_apikey = None
_params = None
_msgtypes = []
def init_plugin(self, config: dict = None):
if config:
self._enabled = config.get("enabled")
self._onlyonce = config.get("onlyonce")
self._msgtypes = config.get("msgtypes") or []
self._server = config.get("server")
self._apikey = config.get("apikey")
self._params = config.get("params")
if self._onlyonce:
self._onlyonce = False
self._send("Bark消息测试通知", "Bark消息通知插件已启用")
def get_state(self) -> bool:
return self._enabled and (True if self._server and self._apikey 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 枚举,生成消息类型选项
MsgTypeOptions = []
for item in NotificationType:
MsgTypeOptions.append({
"title": item.value,
"value": item.name
})
return [
{
'component': 'VForm',
'content': [
{
'component': 'VRow',
'content': [
{
'component': 'VCol',
'props': {
'cols': 12,
'md': 6
},
'content': [
{
'component': 'VSwitch',
'props': {
'model': 'enabled',
'label': '启用插件',
}
}
]
},
{
'component': 'VCol',
'props': {
'cols': 12,
'md': 6
},
'content': [
{
'component': 'VSwitch',
'props': {
'model': 'onlyonce',
'label': '测试插件(立即运行)',
}
}
]
}
]
},
{
'component': 'VRow',
'content': [
{
'component': 'VCol',
'props': {
'cols': 12,
'md': 4
},
'content': [
{
'component': 'VTextField',
'props': {
'model': 'server',
'label': '服务器',
'placeholder': 'https://api.day.app',
}
}
]
},
{
'component': 'VCol',
'props': {
'cols': 12,
'md': 4
},
'content': [
{
'component': 'VTextField',
'props': {
'model': 'params',
'label': '附加参数',
'placeholder': '',
}
}
]
},
{
'component': 'VCol',
'props': {
'cols': 12,
'md': 4
},
'content': [
{
'component': 'VTextarea',
'props': {
'model': 'apikey',
'label': '密钥',
'placeholder': '每行一个用户密钥',
}
}
]
}
]
},
{
'component': 'VRow',
'content': [
{
'component': 'VCol',
'props': {
'cols': 12
},
'content': [
{
'component': 'VSelect',
'props': {
'multiple': True,
'chips': True,
'model': 'msgtypes',
'label': '消息类型',
'items': MsgTypeOptions
}
}
]
}
]
},
]
}
], {
"enabled": False,
'msgtypes': [],
'server': 'https://api.day.app',
'apikey': '',
'params': ''
}
def get_page(self) -> List[dict]:
pass
def _send(self, title: str, text: str) -> Optional[Tuple[bool, str]]:
"""
发送消息
:param title: 标题
:param text: 内容
"""
try:
if not self._server or not self._apikey:
return False, "参数未配置"
req_body = {k: v[0] for k, v in parse_qs(self._params).items()}
req_body.update(
{
"title": title,
"body": text,
}
)
for apikey in self._apikey.split():
req_body.update(
{
"device_key": apikey,
}
)
res = RequestUtils().post_res(f"{self._server}/push", data=req_body)
if res and res.status_code == 200:
ret_json = res.json()
code = ret_json["code"]
message = ret_json["message"]
if code == 200:
logger.info(f"{apikey} Bark消息发送成功")
else:
logger.warn(f"{apikey} Bark消息发送失败{message}")
elif res is not None:
logger.warn(
f"{apikey} Bark消息发送失败错误码{res.status_code},错误原因:{res.reason}"
)
else:
logger.warn(f"{apikey} Bark消息发送失败未获取到返回信息")
except Exception as msg_e:
logger.error(f"Bark消息发送失败{str(msg_e)}")
@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:
return
# 类型
msg_type: NotificationType = msg_body.get("type")
# 标题
title = msg_body.get("title")
# 文本
text = msg_body.get("text")
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
return self._send(title, text)
def stop_service(self):
"""
退出插件
"""
pass