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

* refactor(ui): add tabs to user notification settings * feat(notif): allow users to enable/disable specific agents * fix(ui): only enforce required fields when agent is enabled * fix(ui): hide unavailable notification agents * feat(notif): mention admin users for admin Discord notifications * fix(ui): modify styling of PGP key textareas to suit expected input * fix(notif): mention all admins when there are multiple and fix rebase error * fix: add missing form values, and fix Yup validation * refactor: reduce repeated logic/code in email notif agent * refactor: move 'Notification Types' label into NotificationTypeSelector component * fix(email): correct inconsistencies in email template formatting * refactor: use bitfields for storing user-enabled notif agent types * feat: improve notification agent logging * fix(ui): mark string fields as nullable so empty values are not type errors * fix: add validation for PGP-related inputs * fix: correctly fetch user in user settings & log mentioned IDs for Discord notifs * fix(ui): fix mobile nav dropdown text & add hover effect to button-style tabs * fix(notif): process admin email notifications asynchronously * fix(logging): log name of notification type instead of its enum value * fix: mark required fields and pass all user settings values to API * fix(frontend): call mutate after changing email/Discord/Telegram global notif settings * refactor: get global notif settings from relevant API endpoints instead of adding to public settings * fix(notif): fall back to email notifications being enabled (default) if user settings do not exist * fix(notif): do not set notifyUser for MEDIA_PENDING or MEDIA_AUTO_APPROVED * fix: expose notif enabled settings in user notif endpoints & remove global enable notif setting * fix(notif): remove unnecessary allowed_mentions object from Discord payload * fix(notif): use form values for email test notification * fix: make suggested changes and regenerate DB migration * fix: loosen validation of PGP keys * fix: fix user profile settings routes * fix: remove route guard from profile pages
182 lines
4.8 KiB
TypeScript
182 lines
4.8 KiB
TypeScript
import axios from 'axios';
|
|
import { hasNotificationType, Notification } from '..';
|
|
import { MediaType } from '../../../constants/media';
|
|
import logger from '../../../logger';
|
|
import { getSettings, NotificationAgentPushbullet } from '../../settings';
|
|
import { BaseAgent, NotificationAgent, NotificationPayload } from './agent';
|
|
|
|
interface PushbulletPayload {
|
|
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(type: Notification): boolean {
|
|
if (
|
|
this.getSettings().enabled &&
|
|
this.getSettings().options.accessToken &&
|
|
hasNotificationType(type, this.getSettings().types)
|
|
) {
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
private constructMessageDetails(
|
|
type: Notification,
|
|
payload: NotificationPayload
|
|
): {
|
|
title: string;
|
|
body: string;
|
|
} {
|
|
let messageTitle = '';
|
|
let message = '';
|
|
|
|
const title = payload.subject;
|
|
const plot = payload.message;
|
|
const username = payload.request?.requestedBy.displayName;
|
|
|
|
switch (type) {
|
|
case Notification.MEDIA_PENDING:
|
|
messageTitle = `New ${
|
|
payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
|
|
} Request`;
|
|
message += `${title}`;
|
|
if (plot) {
|
|
message += `\n\n${plot}`;
|
|
}
|
|
message += `\n\nRequested By: ${username}`;
|
|
message += `\nStatus: Pending Approval`;
|
|
break;
|
|
case Notification.MEDIA_APPROVED:
|
|
messageTitle = `${
|
|
payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
|
|
} Request Approved`;
|
|
message += `${title}`;
|
|
if (plot) {
|
|
message += `\n\n${plot}`;
|
|
}
|
|
message += `\n\nRequested By: ${username}`;
|
|
message += `\nStatus: Processing`;
|
|
break;
|
|
case Notification.MEDIA_AUTO_APPROVED:
|
|
messageTitle = `${
|
|
payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
|
|
} Request Automatically Approved`;
|
|
message += `${title}`;
|
|
if (plot) {
|
|
message += `\n\n${plot}`;
|
|
}
|
|
message += `\n\nRequested By: ${username}`;
|
|
message += `\nStatus: Processing`;
|
|
break;
|
|
case Notification.MEDIA_AVAILABLE:
|
|
messageTitle = `${
|
|
payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
|
|
} Now Available`;
|
|
message += `${title}`;
|
|
if (plot) {
|
|
message += `\n\n${plot}`;
|
|
}
|
|
message += `\n\nRequested By: ${username}`;
|
|
message += `\nStatus: Available`;
|
|
break;
|
|
case Notification.MEDIA_DECLINED:
|
|
messageTitle = `${
|
|
payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
|
|
} Request Declined`;
|
|
message += `${title}`;
|
|
if (plot) {
|
|
message += `\n\n${plot}`;
|
|
}
|
|
message += `\n\nRequested By: ${username}`;
|
|
message += `\nStatus: Declined`;
|
|
break;
|
|
case Notification.MEDIA_FAILED:
|
|
messageTitle = `Failed ${
|
|
payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
|
|
} Request`;
|
|
message += `${title}`;
|
|
if (plot) {
|
|
message += `\n\n${plot}`;
|
|
}
|
|
message += `\n\nRequested By: ${username}`;
|
|
message += `\nStatus: Failed`;
|
|
break;
|
|
case Notification.TEST_NOTIFICATION:
|
|
messageTitle = 'Test Notification';
|
|
message += `${plot}`;
|
|
break;
|
|
}
|
|
|
|
for (const extra of payload.extra ?? []) {
|
|
message += `\n${extra.name}: ${extra.value}`;
|
|
}
|
|
|
|
return {
|
|
title: messageTitle,
|
|
body: message,
|
|
};
|
|
}
|
|
|
|
public async send(
|
|
type: Notification,
|
|
payload: NotificationPayload
|
|
): Promise<boolean> {
|
|
logger.debug('Sending Pushbullet notification', {
|
|
label: 'Notifications',
|
|
type: Notification[type],
|
|
subject: payload.subject,
|
|
});
|
|
|
|
try {
|
|
const endpoint = 'https://api.pushbullet.com/v2/pushes';
|
|
|
|
const { accessToken } = this.getSettings().options;
|
|
|
|
const { title, body } = this.constructMessageDetails(type, payload);
|
|
|
|
await axios.post(
|
|
endpoint,
|
|
{
|
|
type: 'note',
|
|
title: title,
|
|
body: body,
|
|
} as PushbulletPayload,
|
|
{
|
|
headers: {
|
|
'Access-Token': accessToken,
|
|
},
|
|
}
|
|
);
|
|
|
|
return true;
|
|
} 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;
|
|
}
|
|
}
|
|
}
|
|
|
|
export default PushbulletAgent;
|