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
301 lines
7.9 KiB
TypeScript
301 lines
7.9 KiB
TypeScript
import { Router } from 'express';
|
|
import { Notification } from '../../lib/notifications';
|
|
import DiscordAgent from '../../lib/notifications/agents/discord';
|
|
import EmailAgent from '../../lib/notifications/agents/email';
|
|
import PushbulletAgent from '../../lib/notifications/agents/pushbullet';
|
|
import PushoverAgent from '../../lib/notifications/agents/pushover';
|
|
import SlackAgent from '../../lib/notifications/agents/slack';
|
|
import TelegramAgent from '../../lib/notifications/agents/telegram';
|
|
import WebhookAgent from '../../lib/notifications/agents/webhook';
|
|
import { getSettings } from '../../lib/settings';
|
|
|
|
const notificationRoutes = Router();
|
|
|
|
notificationRoutes.get('/discord', (_req, res) => {
|
|
const settings = getSettings();
|
|
|
|
res.status(200).json(settings.notifications.agents.discord);
|
|
});
|
|
|
|
notificationRoutes.post('/discord', (req, res) => {
|
|
const settings = getSettings();
|
|
|
|
settings.notifications.agents.discord = req.body;
|
|
settings.save();
|
|
|
|
res.status(200).json(settings.notifications.agents.discord);
|
|
});
|
|
|
|
notificationRoutes.post('/discord/test', (req, res, next) => {
|
|
if (!req.user) {
|
|
return next({
|
|
status: 500,
|
|
message: 'User information missing from request',
|
|
});
|
|
}
|
|
|
|
const discordAgent = new DiscordAgent(req.body);
|
|
discordAgent.send(Notification.TEST_NOTIFICATION, {
|
|
notifyUser: req.user,
|
|
subject: 'Test Notification',
|
|
message:
|
|
'This is a test notification! Check check, 1, 2, 3. Are we coming in clear?',
|
|
});
|
|
|
|
return res.status(204).send();
|
|
});
|
|
|
|
notificationRoutes.get('/slack', (_req, res) => {
|
|
const settings = getSettings();
|
|
|
|
res.status(200).json(settings.notifications.agents.slack);
|
|
});
|
|
|
|
notificationRoutes.post('/slack', (req, res) => {
|
|
const settings = getSettings();
|
|
|
|
settings.notifications.agents.slack = req.body;
|
|
settings.save();
|
|
|
|
res.status(200).json(settings.notifications.agents.slack);
|
|
});
|
|
|
|
notificationRoutes.post('/slack/test', (req, res, next) => {
|
|
if (!req.user) {
|
|
return next({
|
|
status: 500,
|
|
message: 'User information missing from request',
|
|
});
|
|
}
|
|
|
|
const slackAgent = new SlackAgent(req.body);
|
|
slackAgent.send(Notification.TEST_NOTIFICATION, {
|
|
notifyUser: req.user,
|
|
subject: 'Test Notification',
|
|
message:
|
|
'This is a test notification! Check check, 1, 2, 3. Are we coming in clear?',
|
|
});
|
|
|
|
return res.status(204).send();
|
|
});
|
|
|
|
notificationRoutes.get('/telegram', (_req, res) => {
|
|
const settings = getSettings();
|
|
|
|
res.status(200).json(settings.notifications.agents.telegram);
|
|
});
|
|
|
|
notificationRoutes.post('/telegram', (req, res) => {
|
|
const settings = getSettings();
|
|
|
|
settings.notifications.agents.telegram = req.body;
|
|
settings.save();
|
|
|
|
res.status(200).json(settings.notifications.agents.telegram);
|
|
});
|
|
|
|
notificationRoutes.post('/telegram/test', (req, res, next) => {
|
|
if (!req.user) {
|
|
return next({
|
|
status: 500,
|
|
message: 'User information missing from request',
|
|
});
|
|
}
|
|
|
|
const telegramAgent = new TelegramAgent(req.body);
|
|
telegramAgent.send(Notification.TEST_NOTIFICATION, {
|
|
notifyUser: req.user,
|
|
subject: 'Test Notification',
|
|
message:
|
|
'This is a test notification! Check check, 1, 2, 3. Are we coming in clear?',
|
|
});
|
|
|
|
return res.status(204).send();
|
|
});
|
|
|
|
notificationRoutes.get('/pushbullet', (_req, res) => {
|
|
const settings = getSettings();
|
|
|
|
res.status(200).json(settings.notifications.agents.pushbullet);
|
|
});
|
|
|
|
notificationRoutes.post('/pushbullet', (req, res) => {
|
|
const settings = getSettings();
|
|
|
|
settings.notifications.agents.pushbullet = req.body;
|
|
settings.save();
|
|
|
|
res.status(200).json(settings.notifications.agents.pushbullet);
|
|
});
|
|
|
|
notificationRoutes.post('/pushbullet/test', (req, res, next) => {
|
|
if (!req.user) {
|
|
return next({
|
|
status: 500,
|
|
message: 'User information missing from request',
|
|
});
|
|
}
|
|
|
|
const pushbulletAgent = new PushbulletAgent(req.body);
|
|
pushbulletAgent.send(Notification.TEST_NOTIFICATION, {
|
|
notifyUser: req.user,
|
|
subject: 'Test Notification',
|
|
message:
|
|
'This is a test notification! Check check, 1, 2, 3. Are we coming in clear?',
|
|
});
|
|
|
|
return res.status(204).send();
|
|
});
|
|
|
|
notificationRoutes.get('/pushover', (_req, res) => {
|
|
const settings = getSettings();
|
|
|
|
res.status(200).json(settings.notifications.agents.pushover);
|
|
});
|
|
|
|
notificationRoutes.post('/pushover', (req, res) => {
|
|
const settings = getSettings();
|
|
|
|
settings.notifications.agents.pushover = req.body;
|
|
settings.save();
|
|
|
|
res.status(200).json(settings.notifications.agents.pushover);
|
|
});
|
|
|
|
notificationRoutes.post('/pushover/test', (req, res, next) => {
|
|
if (!req.user) {
|
|
return next({
|
|
status: 500,
|
|
message: 'User information missing from request',
|
|
});
|
|
}
|
|
|
|
const pushoverAgent = new PushoverAgent(req.body);
|
|
pushoverAgent.send(Notification.TEST_NOTIFICATION, {
|
|
notifyUser: req.user,
|
|
subject: 'Test Notification',
|
|
message:
|
|
'This is a test notification! Check check, 1, 2, 3. Are we coming in clear?',
|
|
});
|
|
|
|
return res.status(204).send();
|
|
});
|
|
|
|
notificationRoutes.get('/email', (_req, res) => {
|
|
const settings = getSettings();
|
|
|
|
res.status(200).json(settings.notifications.agents.email);
|
|
});
|
|
|
|
notificationRoutes.post('/email', (req, res) => {
|
|
const settings = getSettings();
|
|
|
|
settings.notifications.agents.email = req.body;
|
|
settings.save();
|
|
|
|
res.status(200).json(settings.notifications.agents.email);
|
|
});
|
|
|
|
notificationRoutes.post('/email/test', (req, res, next) => {
|
|
if (!req.user) {
|
|
return next({
|
|
status: 500,
|
|
message: 'User information missing from request',
|
|
});
|
|
}
|
|
|
|
const emailAgent = new EmailAgent(req.body);
|
|
emailAgent.send(Notification.TEST_NOTIFICATION, {
|
|
notifyUser: req.user,
|
|
subject: 'Test Notification',
|
|
message:
|
|
'This is a test notification! Check check, 1, 2, 3. Are we coming in clear?',
|
|
});
|
|
|
|
return res.status(204).send();
|
|
});
|
|
|
|
notificationRoutes.get('/webhook', (_req, res) => {
|
|
const settings = getSettings();
|
|
|
|
const webhookSettings = settings.notifications.agents.webhook;
|
|
|
|
const response: typeof webhookSettings = {
|
|
enabled: webhookSettings.enabled,
|
|
types: webhookSettings.types,
|
|
options: {
|
|
...webhookSettings.options,
|
|
jsonPayload: JSON.parse(
|
|
Buffer.from(webhookSettings.options.jsonPayload, 'base64').toString(
|
|
'ascii'
|
|
)
|
|
),
|
|
},
|
|
};
|
|
|
|
res.status(200).json(response);
|
|
});
|
|
|
|
notificationRoutes.post('/webhook', (req, res, next) => {
|
|
const settings = getSettings();
|
|
try {
|
|
JSON.parse(req.body.options.jsonPayload);
|
|
|
|
settings.notifications.agents.webhook = {
|
|
enabled: req.body.enabled,
|
|
types: req.body.types,
|
|
options: {
|
|
jsonPayload: Buffer.from(req.body.options.jsonPayload).toString(
|
|
'base64'
|
|
),
|
|
webhookUrl: req.body.options.webhookUrl,
|
|
authHeader: req.body.options.authHeader,
|
|
},
|
|
};
|
|
settings.save();
|
|
|
|
res.status(200).json(settings.notifications.agents.webhook);
|
|
} catch (e) {
|
|
next({ status: 500, message: e.message });
|
|
}
|
|
});
|
|
|
|
notificationRoutes.post('/webhook/test', (req, res, next) => {
|
|
if (!req.user) {
|
|
return next({
|
|
status: 500,
|
|
message: 'User information missing from request',
|
|
});
|
|
}
|
|
|
|
try {
|
|
JSON.parse(req.body.options.jsonPayload);
|
|
|
|
const testBody = {
|
|
enabled: req.body.enabled,
|
|
types: req.body.types,
|
|
options: {
|
|
jsonPayload: Buffer.from(req.body.options.jsonPayload).toString(
|
|
'base64'
|
|
),
|
|
webhookUrl: req.body.options.webhookUrl,
|
|
authHeader: req.body.options.authHeader,
|
|
},
|
|
};
|
|
|
|
const webhookAgent = new WebhookAgent(testBody);
|
|
webhookAgent.send(Notification.TEST_NOTIFICATION, {
|
|
notifyUser: req.user,
|
|
subject: 'Test Notification',
|
|
message:
|
|
'This is a test notification! Check check, 1, 2, 3. Are we coming in clear?',
|
|
});
|
|
|
|
return res.status(204).send();
|
|
} catch (e) {
|
|
next({ status: 500, message: e.message });
|
|
}
|
|
});
|
|
|
|
export default notificationRoutes;
|