feat(notifications): add pushover integration (#574)

* feat(notifications): add pushover integration

* refactor(pushover): group i18n translations

overseerr-api.yml

@@ -871,6 +871,26 @@ components:
               type: string
             chatId:
               type: string
+    PushoverSettings:
+      type: object
+      properties:
+        enabled:
+          type: boolean
+          example: false
+        types:
+          type: number
+          example: 2
+        options:
+          type: object
+          properties:
+            accessToken:
+              type: string
+            userToken:
+              type: string
+            priority:
+              type: number
+            sound:
+              type: string
     NotificationEmailSettings:
       type: object
       properties:
@@ -1720,6 +1740,52 @@ paths:
       responses:
         '204':
           description: Test notification attempted
+  /settings/notifications/pushover:
+    get:
+      summary: Return current pushover notification settings
+      description: Returns current pushover notification settings in JSON format
+      tags:
+        - settings
+      responses:
+        '200':
+          description: Returned pushover settings
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PushoverSettings'
+    post:
+      summary: Update pushover notification settings
+      description: Update current pushover notification settings with provided values
+      tags:
+        - settings
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PushoverSettings'
+      responses:
+        '200':
+          description: 'Values were sucessfully updated'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PushoverSettings'
+  /settings/notifications/pushover/test:
+    post:
+      summary: Test the provided pushover settings
+      description: Sends a test notification to the pushover agent
+      tags:
+        - settings
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PushoverSettings'
+      responses:
+        '204':
+          description: Test notification attempted
   /settings/notifications/slack:
     get:
       summary: Return current slack notification settings

server/index.ts

@@ -20,6 +20,7 @@ import EmailAgent from './lib/notifications/agents/email';
 import TelegramAgent from './lib/notifications/agents/telegram';
 import { getAppVersion } from './utils/appVersion';
 import SlackAgent from './lib/notifications/agents/slack';
+import PushoverAgent from './lib/notifications/agents/pushover';
 
 const API_SPEC_PATH = path.join(__dirname, '../overseerr-api.yml');
 
@@ -49,6 +50,7 @@ app
       new EmailAgent(),
       new SlackAgent(),
       new TelegramAgent(),
+      new PushoverAgent(),
     ]);
 
     // Start Jobs

server/lib/notifications/agents/pushover.ts

@@ -0,0 +1,122 @@
+import axios from 'axios';
+import { hasNotificationType, Notification } from '..';
+import logger from '../../../logger';
+import { getSettings, NotificationAgentPushover } from '../../settings';
+import { BaseAgent, NotificationAgent, NotificationPayload } from './agent';
+
+interface PushoverPayload {
+  token: string;
+  user: string;
+  title: string;
+  message: string;
+  html: number;
+}
+
+class PushoverAgent
+  extends BaseAgent<NotificationAgentPushover>
+  implements NotificationAgent {
+  protected getSettings(): NotificationAgentPushover {
+    if (this.settings) {
+      return this.settings;
+    }
+
+    const settings = getSettings();
+
+    return settings.notifications.agents.pushover;
+  }
+
+  public shouldSend(type: Notification): boolean {
+    if (
+      this.getSettings().enabled &&
+      this.getSettings().options.accessToken &&
+      this.getSettings().options.userToken &&
+      hasNotificationType(type, this.getSettings().types)
+    ) {
+      return true;
+    }
+
+    return false;
+  }
+
+  private constructMessageDetails(
+    type: Notification,
+    payload: NotificationPayload
+  ): { title: string; message: string } {
+    const settings = getSettings();
+    let messageTitle = '';
+    let message = '';
+
+    const title = payload.subject;
+    const plot = payload.message;
+    const user = payload.notifyUser.username;
+
+    switch (type) {
+      case Notification.MEDIA_PENDING:
+        messageTitle = 'New Request';
+        message += `${title}\n\n`;
+        message += `${plot}\n\n`;
+        message += `<b>Requested By</b>\n${user}\n\n`;
+        message += `<b>Status</b>\nPending Approval\n`;
+        break;
+      case Notification.MEDIA_APPROVED:
+        messageTitle = 'Request Approved';
+        message += `${title}\n\n`;
+        message += `${plot}\n\n`;
+        message += `<b>Requested By</b>\n${user}\n\n`;
+        message += `<b>Status</b>\nProcessing Request\n`;
+        break;
+      case Notification.MEDIA_AVAILABLE:
+        messageTitle = 'Now available!';
+        message += `${title}\n\n`;
+        message += `${plot}\n\n`;
+        message += `<b>Requested By</b>\n${user}\n\n`;
+        message += `<b>Status</b>\nAvailable\n`;
+        break;
+      case Notification.TEST_NOTIFICATION:
+        messageTitle = 'Test Notification';
+        message += `${title}\n\n`;
+        message += `${plot}\n\n`;
+        message += `<b>Requested By</b>\n${user}\n`;
+        break;
+    }
+
+    if (settings.main.applicationUrl && payload.media) {
+      const actionUrl = `${settings.main.applicationUrl}/${payload.media.mediaType}/${payload.media.tmdbId}`;
+      message += `<a href="${actionUrl}">Open in Overseerr</a>`;
+    }
+
+    return { title: messageTitle, message };
+  }
+
+  public async send(
+    type: Notification,
+    payload: NotificationPayload
+  ): Promise<boolean> {
+    logger.debug('Sending Pushover notification', { label: 'Notifications' });
+    try {
+      const endpoint = 'https://api.pushover.net/1/messages.json';
+
+      const { accessToken, userToken } = this.getSettings().options;
+
+      const { title, message } = this.constructMessageDetails(type, payload);
+
+      await axios.post(endpoint, {
+        token: accessToken,
+        user: userToken,
+        title: title,
+        message: message,
+        html: 1,
+      } as PushoverPayload);
+
+      return true;
+    } catch (e) {
+      logger.error('Error sending Pushover notification', {
+        label: 'Notifications',
+        message: e.message,
+      });
+      return false;
+    }
+  }
+}
+
+export default PushoverAgent;

server/lib/settings.ts

@@ -92,11 +92,21 @@ export interface NotificationAgentTelegram extends NotificationAgentConfig {
   };
 }
 
+export interface NotificationAgentPushover extends NotificationAgentConfig {
+  options: {
+    accessToken: string;
+    userToken: string;
+    priority: number;
+    sound: string;
+  };
+}
+
 interface NotificationAgents {
   email: NotificationAgentEmail;
   discord: NotificationAgentDiscord;
   slack: NotificationAgentSlack;
   telegram: NotificationAgentTelegram;
+  pushover: NotificationAgentPushover;
 }
 
 interface NotificationSettings {
@@ -174,6 +184,16 @@ class Settings {
               chatId: '',
             },
           },
+          pushover: {
+            enabled: false,
+            types: 0,
+            options: {
+              accessToken: '',
+              userToken: '',
+              priority: 0,
+              sound: '',
+            },
+          },
         },
       },
     };

server/routes/settings.ts

@@ -26,6 +26,7 @@ import DiscordAgent from '../lib/notifications/agents/discord';
 import EmailAgent from '../lib/notifications/agents/email';
 import SlackAgent from '../lib/notifications/agents/slack';
 import TelegramAgent from '../lib/notifications/agents/telegram';
+import PushoverAgent from '../lib/notifications/agents/pushover';
 
 const settingsRoutes = Router();
 
@@ -538,6 +539,40 @@ settingsRoutes.post('/notifications/telegram/test', (req, res, next) => {
   return res.status(204).send();
 });
 
+settingsRoutes.get('/notifications/pushover', (_req, res) => {
+  const settings = getSettings();
+
+  res.status(200).json(settings.notifications.agents.pushover);
+});
+
+settingsRoutes.post('/notifications/pushover', (req, res) => {
+  const settings = getSettings();
+
+  settings.notifications.agents.pushover = req.body;
+  settings.save();
+
+  res.status(200).json(settings.notifications.agents.pushover);
+});
+
+settingsRoutes.post('/notifications/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();
+});
+
 settingsRoutes.get('/notifications/email', (_req, res) => {
   const settings = getSettings();