mirror of
https://github.com/whyour/qinglong.git
synced 2025-07-04 09:06:06 +08:00
ntfy 增加可选的认证与用户动作 (#2741)
* feat:ntfy增加可选的认证 * feat:ntfy增加可选的用户动作 * fix:ntfy动作包含中文报错
This commit is contained in:
憶夣
GitHub
parent
394e96bbf8
commit
57939391b9
|
|
@ -150,6 +150,10 @@ export class NtfyNotification extends NotificationBaseInfo {
|
|||
public ntfyUrl = '';
|
||||
public ntfyTopic = '';
|
||||
public ntfyPriority = '';
|
||||
public ntfyToken = '';
|
||||
public ntfyUsername = '';
|
||||
public ntfyPassword = '';
|
||||
public ntfyActions = '';
|
||||
}
|
||||
|
||||
export class WxPusherBotNotification extends NotificationBaseInfo {
|
||||
|
|
|
|||
|
|
@ -623,20 +623,32 @@ export default class NotificationService {
|
|||
}
|
||||
|
||||
private async ntfy() {
|
||||
const { ntfyUrl, ntfyTopic, ntfyPriority } = 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');
|
||||
return `=?${charset}?B?${encodedText}?=`;
|
||||
};
|
||||
try {
|
||||
const encodedTitle = encodeRfc2047(this.title);
|
||||
const headers: Record<string, string> = {
|
||||
Title: encodeRfc2047(this.title),
|
||||
Priority: `${ntfyPriority || '3'}`,
|
||||
Icon: 'https://qn.whyour.cn/logo.png',
|
||||
};
|
||||
if (ntfyToken) {
|
||||
headers['Authorization'] = `Bearer ${ntfyToken}`;
|
||||
} else if (ntfyUsername && ntfyPassword) {
|
||||
headers['Authorization'] = `Basic ${Buffer.from(`${ntfyUsername}:${ntfyPassword}`).toString('base64')}`;
|
||||
}
|
||||
if (ntfyActions) {
|
||||
headers['Actions'] = encodeRfc2047(ntfyActions);
|
||||
}
|
||||
const res = await httpClient.request(
|
||||
`${ntfyUrl || 'https://ntfy.sh'}/${ntfyTopic}`,
|
||||
{
|
||||
...this.gotOption,
|
||||
body: `${this.content}`,
|
||||
headers: { Title: encodedTitle, Priority: `${ntfyPriority || '3'}` },
|
||||
headers: headers,
|
||||
method: 'POST',
|
||||
},
|
||||
);
|
||||
|
|
|
|||
|
|
@ -226,9 +226,17 @@ export QMSG_TYPE=""
|
|||
## ntfy_url 填写ntfy地址,如https://ntfy.sh
|
||||
## ntfy_topic 填写ntfy的消息应用topic
|
||||
## ntfy_priority 填写推送消息优先级,默认为3
|
||||
## ntfy_token 填写推送token,可选
|
||||
## ntfy_username 填写推送用户名称,可选
|
||||
## ntfy_password 填写推送用户密码,可选
|
||||
## ntfy_actions 填写推送用户动作,可选
|
||||
export NTFY_URL=""
|
||||
export NTFY_TOPIC=""
|
||||
export NTFY_PRIORITY="3"
|
||||
export NTFY_TOKEN=""
|
||||
export NTFY_USERNAME=""
|
||||
export NTFY_PASSWORD=""
|
||||
export NTFY_ACTIONS=""
|
||||
|
||||
## 21. wxPusher
|
||||
## 官方文档: https://wxpusher.zjiecode.com/docs/
|
||||
|
|
|
|||
|
|
@ -140,6 +140,10 @@ const push_config = {
|
|||
NTFY_URL: '', // ntfy地址,如https://ntfy.sh,默认为https://ntfy.sh
|
||||
NTFY_TOPIC: '', // ntfy的消息应用topic
|
||||
NTFY_PRIORITY: '3', // 推送消息优先级,默认为3
|
||||
NTFY_TOKEN: '', // 推送token,可选
|
||||
NTFY_USERNAME: '', // 推送用户名称,可选
|
||||
NTFY_PASSWORD: '', // 推送用户密码,可选
|
||||
NTFY_ACTIONS: '', // 推送用户动作,可选
|
||||
|
||||
// 官方文档: https://wxpusher.zjiecode.com/docs/
|
||||
// 管理后台: https://wxpusher.zjiecode.com/admin/
|
||||
|
|
@ -1258,7 +1262,7 @@ function ntfyNotify(text, desp) {
|
|||
}
|
||||
|
||||
return new Promise((resolve) => {
|
||||
const { NTFY_URL, NTFY_TOPIC, NTFY_PRIORITY } = push_config;
|
||||
const { NTFY_URL, NTFY_TOPIC, NTFY_PRIORITY, NTFY_TOKEN, NTFY_USERNAME, NTFY_PASSWORD, NTFY_ACTIONS } = push_config;
|
||||
if (NTFY_TOPIC) {
|
||||
const options = {
|
||||
url: `${NTFY_URL || 'https://ntfy.sh'}/${NTFY_TOPIC}`,
|
||||
|
|
@ -1266,9 +1270,19 @@ function ntfyNotify(text, desp) {
|
|||
headers: {
|
||||
Title: `${encodeRFC2047(text)}`,
|
||||
Priority: NTFY_PRIORITY || '3',
|
||||
Icon: 'https://qn.whyour.cn/logo.png',
|
||||
},
|
||||
timeout,
|
||||
};
|
||||
if (NTFY_TOKEN) {
|
||||
options.headers['Authorization'] = `Bearer ${NTFY_TOKEN}`;
|
||||
} else if (NTFY_USERNAME && NTFY_PASSWORD) {
|
||||
options.headers['Authorization'] = `Basic ${Buffer.from(`${NTFY_USERNAME}:${NTFY_PASSWORD}`).toString('base64')}`;
|
||||
}
|
||||
if (NTFY_ACTIONS) {
|
||||
options.headers['Actions'] = encodeRFC2047(NTFY_ACTIONS);
|
||||
}
|
||||
|
||||
$.post(options, (err, resp, data) => {
|
||||
try {
|
||||
if (err) {
|
||||
|
|
|
|||
|
|
@ -126,6 +126,10 @@ push_config = {
|
|||
'NTFY_URL': '', # ntfy地址,如https://ntfy.sh
|
||||
'NTFY_TOPIC': '', # ntfy的消息应用topic
|
||||
'NTFY_PRIORITY':'3', # 推送消息优先级,默认为3
|
||||
'NTFY_TOKEN': '', # 推送token,可选
|
||||
'NTFY_USERNAME': '', # 推送用户名称,可选
|
||||
'NTFY_PASSWORD': '', # 推送用户密码,可选
|
||||
'NTFY_ACTIONS': '', # 推送用户动作,可选
|
||||
|
||||
'WXPUSHER_APP_TOKEN': '', # wxpusher 的 appToken 官方文档: https://wxpusher.zjiecode.com/docs/ 管理后台: https://wxpusher.zjiecode.com/admin/
|
||||
'WXPUSHER_TOPIC_IDS': '', # wxpusher 的 主题ID，多个用英文分号;分隔 topic_ids 与 uids 至少配置一个才行
|
||||
|
|
@ -806,7 +810,14 @@ def ntfy(title: str, content: str) -> None:
|
|||
encoded_title = encode_rfc2047(title)
|
||||
|
||||
data = content.encode(encoding="utf-8")
|
||||
headers = {"Title": encoded_title, "Priority": priority} # 使用编码后的 title
|
||||
headers = {"Title": encoded_title, "Priority": priority, "Icon": "https://qn.whyour.cn/logo.png"} # 使用编码后的 title
|
||||
if push_config.get("NTFY_TOKEN"):
|
||||
headers['Authorization'] = "Bearer " + push_config.get("NTFY_TOKEN")
|
||||
elif push_config.get("NTFY_USERNAME") and push_config.get("NTFY_PASSWORD"):
|
||||
authStr = push_config.get("NTFY_USERNAME") + ":" + push_config.get("NTFY_PASSWORD")
|
||||
headers['Authorization'] = "Basic " + base64.b64encode(authStr.encode('utf-8')).decode('utf-8')
|
||||
if push_config.get("NTFY_ACTIONS"):
|
||||
headers['Actions'] = encode_rfc2047(push_config.get("NTFY_ACTIONS"))
|
||||
|
||||
url = push_config.get("NTFY_URL") + "/" + push_config.get("NTFY_TOPIC")
|
||||
response = requests.post(url, data=data, headers=headers)
|
||||
|
|
|
|||
|
|
@ -395,7 +395,11 @@
|
|||
"PushMe的Key，https://push.i-i.me/": "PushMe key, https://push.i-i.me/",
|
||||
"自建的PushMeServer消息接口地址，例如：http://127.0.0.1:3010，不填则使用官方消息接口": "The self built PushMeServer message interface address, for example: http://127.0.0.1:3010 If left blank, use the official message interface",
|
||||
"ntfy的url地址，例如 https://ntfy.sh": "The URL address of ntfy, for example, https://ntfy.sh.",
|
||||
"ntfy的消息应用topic": "The topic for ntfy's messaging application.",
|
||||
"ntfy应用topic": "The topic for ntfy's application.",
|
||||
"ntfy应用token": "The token for ntfy's application, see https://docs.ntfy.sh/config/#access-tokens",
|
||||
"ntfy应用用户名": "The username for ntfy's application, see https://docs.ntfy.sh/config/#users-and-roles",
|
||||
"ntfy应用密码": "The password for ntfy's application, see https://docs.ntfy.sh/config/#users-and-roles",
|
||||
"ntfy用户动作": "The user actions for ntfy's application, up to three actions, see https://docs.ntfy.sh/publish/?h=actions#action-buttons",
|
||||
"wxPusherBot的appToken": "wxPusherBot's appToken, obtain according to docs https://wxpusher.zjiecode.com/docs/",
|
||||
"wxPusherBot的topicIds": "wxPusherBot's topicIds, at least one of topicIds or uids must be configured",
|
||||
"wxPusherBot的uids": "wxPusherBot's uids, at least one of topicIds or uids must be configured",
|
||||
|
|
|
|||
|
|
@ -395,7 +395,11 @@
|
|||
"PushMe的Key，https://push.i-i.me/": "PushMe的Key，https://push.i-i.me/",
|
||||
"自建的PushMeServer消息接口地址，例如：http://127.0.0.1:3010，不填则使用官方消息接口": "自建的PushMeServer消息接口地址，例如：http://127.0.0.1:3010，不填则使用官方消息接口",
|
||||
"ntfy的url地址，例如 https://ntfy.sh": "ntfy的url地址，例如 https://ntfy.sh",
|
||||
"ntfy的消息应用topic": "ntfy的消息应用topic",
|
||||
"ntfy应用topic": "ntfy应用topic",
|
||||
"ntfy应用token": "ntfy应用token，参考 https://docs.ntfy.sh/config/#access-tokens",
|
||||
"ntfy应用用户名": "ntfy应用用户名，参考 https://docs.ntfy.sh/config/#users-and-roles",
|
||||
"ntfy应用密码": "ntfy应用密码，参考 https://docs.ntfy.sh/config/#users-and-roles",
|
||||
"ntfy用户动作": "ntfy用户动作，最多三个动作，参考 https://docs.ntfy.sh/publish/?h=actions#action-buttons",
|
||||
"wxPusherBot的appToken": "wxPusherBot的appToken, 按照文档获取 https://wxpusher.zjiecode.com/docs/",
|
||||
"wxPusherBot的topicIds": "wxPusherBot的topicIds, topicIds 和 uids 至少配置一个才行",
|
||||
"wxPusherBot的uids": "wxPusherBot的uids, topicIds 和 uids 至少配置一个才行",
|
||||
|
|
@ -508,4 +512,3 @@
|
|||
"当前文件未保存，确认离开吗": "当前文件未保存，确认离开吗",
|
||||
"收件邮箱地址，多个分号分隔，默认发送给发件邮箱地址": "收件邮箱地址，多个分号分隔，默认发送给发件邮箱地址"
|
||||
}
|
||||
|
||||
|
|
@ -128,10 +128,14 @@ export default {
|
|||
},
|
||||
{
|
||||
label: 'ntfyTopic',
|
||||
tip: intl.get('ntfy的消息应用topic'),
|
||||
tip: intl.get('ntfy应用topic'),
|
||||
required: true,
|
||||
},
|
||||
{ label: 'ntfyPriority', tip: intl.get('推送消息的优先级') },
|
||||
{ label: 'ntfyToken', tip: intl.get('ntfy应用token') },
|
||||
{ label: 'ntfyUsername', tip: intl.get('ntfy应用用户名') },
|
||||
{ label: 'ntfyPassword', tip: intl.get('ntfy应用密码') },
|
||||
{ label: 'ntfyActions', tip: intl.get('ntfy用户动作') },
|
||||
],
|
||||
chat: [
|
||||
{
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user