mirror of
https://github.com/sct/overseerr.git
synced 2025-09-17 17:24:35 +02:00

* feat(notif): issue notifications * refactor: dedupe test notification strings * fix: webhook key parsing * fix(notif): skip send for admin who requested on behalf of another user * fix(notif): send comment notifs to admins when other admins reply * fix(notif): also send resolved notifs to admins, and reopened notifs to issue creator * fix: don't send duplicate notifications * fix(lang): tweak notification description strings * fix(notif): tweak Slack notification styling * fix(notif): tweak Pushbullet & Telegram notification styling * docs: reformat webhooks page * fix(notif): add missing issue_type & issue_status variables to LunaSea notif payloads * fix: explicitly attach media & issue objects where applicable * fix(notif): correctly notify both notifyUser and managers where applicable * fix: update default webhook payload for new installs * fix(notif): add missing comment_message to LunaSea notif payload * refactor(sw): simplify notificationclick event listener logic * fix(notif): add missing event description for MEDIA_AVAILABLE notifications
229 lines
6.3 KiB
TypeScript
229 lines
6.3 KiB
TypeScript
import axios from 'axios';
|
|
import { getRepository } from 'typeorm';
|
|
import {
|
|
hasNotificationType,
|
|
Notification,
|
|
shouldSendAdminNotification,
|
|
} from '..';
|
|
import { IssueStatus, IssueTypeName } from '../../../constants/issue';
|
|
import { User } from '../../../entity/User';
|
|
import logger from '../../../logger';
|
|
import {
|
|
getSettings,
|
|
NotificationAgentKey,
|
|
NotificationAgentPushbullet,
|
|
} from '../../settings';
|
|
import { BaseAgent, NotificationAgent, NotificationPayload } from './agent';
|
|
|
|
interface PushbulletPayload {
|
|
type: string;
|
|
title: string;
|
|
body: string;
|
|
}
|
|
|
|
class PushbulletAgent
|
|
extends BaseAgent<NotificationAgentPushbullet>
|
|
implements NotificationAgent
|
|
{
|
|
protected getSettings(): NotificationAgentPushbullet {
|
|
if (this.settings) {
|
|
return this.settings;
|
|
}
|
|
|
|
const settings = getSettings();
|
|
|
|
return settings.notifications.agents.pushbullet;
|
|
}
|
|
|
|
public shouldSend(): boolean {
|
|
return true;
|
|
}
|
|
|
|
private getNotificationPayload(
|
|
type: Notification,
|
|
payload: NotificationPayload
|
|
): PushbulletPayload {
|
|
const title = payload.event
|
|
? `${payload.event} - ${payload.subject}`
|
|
: payload.subject;
|
|
let body = payload.message ?? '';
|
|
|
|
if (payload.request) {
|
|
body += `\n\nRequested By: ${payload.request.requestedBy.displayName}`;
|
|
|
|
let status = '';
|
|
switch (type) {
|
|
case Notification.MEDIA_PENDING:
|
|
status = 'Pending Approval';
|
|
break;
|
|
case Notification.MEDIA_APPROVED:
|
|
case Notification.MEDIA_AUTO_APPROVED:
|
|
status = 'Processing';
|
|
break;
|
|
case Notification.MEDIA_AVAILABLE:
|
|
status = 'Available';
|
|
break;
|
|
case Notification.MEDIA_DECLINED:
|
|
status = 'Declined';
|
|
break;
|
|
case Notification.MEDIA_FAILED:
|
|
status = 'Failed';
|
|
break;
|
|
}
|
|
|
|
if (status) {
|
|
body += `\nRequest Status: ${status}`;
|
|
}
|
|
} else if (payload.comment) {
|
|
body += `\n\nComment from ${payload.comment.user.displayName}:\n${payload.comment.message}`;
|
|
} else if (payload.issue) {
|
|
body += `\n\nReported By: ${payload.issue.createdBy.displayName}`;
|
|
body += `\nIssue Type: ${IssueTypeName[payload.issue.issueType]}`;
|
|
body += `\nIssue Status: ${
|
|
payload.issue.status === IssueStatus.OPEN ? 'Open' : 'Resolved'
|
|
}`;
|
|
}
|
|
|
|
for (const extra of payload.extra ?? []) {
|
|
body += `\n${extra.name}: ${extra.value}`;
|
|
}
|
|
|
|
return {
|
|
type: 'note',
|
|
title,
|
|
body,
|
|
};
|
|
}
|
|
|
|
public async send(
|
|
type: Notification,
|
|
payload: NotificationPayload
|
|
): Promise<boolean> {
|
|
const settings = this.getSettings();
|
|
const endpoint = 'https://api.pushbullet.com/v2/pushes';
|
|
const notificationPayload = this.getNotificationPayload(type, payload);
|
|
|
|
// Send system notification
|
|
if (
|
|
hasNotificationType(type, settings.types ?? 0) &&
|
|
settings.enabled &&
|
|
settings.options.accessToken
|
|
) {
|
|
logger.debug('Sending Pushbullet notification', {
|
|
label: 'Notifications',
|
|
type: Notification[type],
|
|
subject: payload.subject,
|
|
});
|
|
|
|
try {
|
|
await axios.post(endpoint, notificationPayload, {
|
|
headers: {
|
|
'Access-Token': settings.options.accessToken,
|
|
},
|
|
});
|
|
} catch (e) {
|
|
logger.error('Error sending Pushbullet notification', {
|
|
label: 'Notifications',
|
|
type: Notification[type],
|
|
subject: payload.subject,
|
|
errorMessage: e.message,
|
|
response: e.response?.data,
|
|
});
|
|
|
|
return false;
|
|
}
|
|
}
|
|
|
|
if (payload.notifyUser) {
|
|
if (
|
|
payload.notifyUser.settings?.hasNotificationType(
|
|
NotificationAgentKey.PUSHBULLET,
|
|
type
|
|
) &&
|
|
payload.notifyUser.settings?.pushbulletAccessToken &&
|
|
payload.notifyUser.settings.pushbulletAccessToken !==
|
|
settings.options.accessToken
|
|
) {
|
|
logger.debug('Sending Pushbullet notification', {
|
|
label: 'Notifications',
|
|
recipient: payload.notifyUser.displayName,
|
|
type: Notification[type],
|
|
subject: payload.subject,
|
|
});
|
|
|
|
try {
|
|
await axios.post(endpoint, notificationPayload, {
|
|
headers: {
|
|
'Access-Token': payload.notifyUser.settings.pushbulletAccessToken,
|
|
},
|
|
});
|
|
} catch (e) {
|
|
logger.error('Error sending Pushbullet notification', {
|
|
label: 'Notifications',
|
|
recipient: payload.notifyUser.displayName,
|
|
type: Notification[type],
|
|
subject: payload.subject,
|
|
errorMessage: e.message,
|
|
response: e.response?.data,
|
|
});
|
|
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (payload.notifyAdmin) {
|
|
const userRepository = getRepository(User);
|
|
const users = await userRepository.find();
|
|
|
|
await Promise.all(
|
|
users
|
|
.filter(
|
|
(user) =>
|
|
user.settings?.hasNotificationType(
|
|
NotificationAgentKey.PUSHBULLET,
|
|
type
|
|
) && shouldSendAdminNotification(type, user, payload)
|
|
)
|
|
.map(async (user) => {
|
|
if (
|
|
user.settings?.pushbulletAccessToken &&
|
|
user.settings.pushbulletAccessToken !==
|
|
settings.options.accessToken
|
|
) {
|
|
logger.debug('Sending Pushbullet notification', {
|
|
label: 'Notifications',
|
|
recipient: user.displayName,
|
|
type: Notification[type],
|
|
subject: payload.subject,
|
|
});
|
|
|
|
try {
|
|
await axios.post(endpoint, notificationPayload, {
|
|
headers: {
|
|
'Access-Token': user.settings.pushbulletAccessToken,
|
|
},
|
|
});
|
|
} catch (e) {
|
|
logger.error('Error sending Pushbullet notification', {
|
|
label: 'Notifications',
|
|
recipient: user.displayName,
|
|
type: Notification[type],
|
|
subject: payload.subject,
|
|
errorMessage: e.message,
|
|
response: e.response?.data,
|
|
});
|
|
|
|
return false;
|
|
}
|
|
}
|
|
})
|
|
);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
}
|
|
|
|
export default PushbulletAgent;
|