feat(notif): add "Media Automatically Approved" notification type (#1137)

2025-09-17 17:24:35 +02:00 · 2021-03-11 21:42:06 -05:00
parent 1be97fe7fb
commit f7d2723fab
19 changed files with 284 additions and 102 deletions
--- a/server/lib/notifications/agents/agent.ts
+++ b/server/lib/notifications/agents/agent.ts
@@ -21,6 +21,12 @@ export abstract class BaseAgent<T extends NotificationAgentConfig> {
  }

  protected abstract getSettings(): T;
+
+  protected userNotificationTypes: Notification[] = [
+    Notification.MEDIA_APPROVED,
+    Notification.MEDIA_DECLINED,
+    Notification.MEDIA_AVAILABLE,
+  ];
 }

 export interface NotificationAgent {
--- a/server/lib/notifications/agents/discord.ts
+++ b/server/lib/notifications/agents/discord.ts
@@ -122,6 +122,7 @@ class DiscordAgent
        });
        break;
      case Notification.MEDIA_APPROVED:
+      case Notification.MEDIA_AUTO_APPROVED:
        color = EmbedColors.PURPLE;
        fields.push({
          name: 'Status',
@@ -201,7 +202,7 @@ class DiscordAgent
    type: Notification,
    payload: NotificationPayload
  ): Promise<boolean> {
-    logger.debug('Sending discord notification', { label: 'Notifications' });
+    logger.debug('Sending Discord notification', { label: 'Notifications' });
    try {
      const {
        botUsername,
@@ -217,6 +218,7 @@ class DiscordAgent
      let content = undefined;

      if (
+        this.userNotificationTypes.includes(type) &&
        payload.notifyUser.settings?.enableNotifications &&
        payload.notifyUser.settings?.discordId
      ) {
--- a/server/lib/notifications/agents/email.ts
+++ b/server/lib/notifications/agents/email.ts
@@ -7,6 +7,7 @@ import { getRepository } from 'typeorm';
 import { User } from '../../../entity/User';
 import { Permission } from '../../permissions';
 import PreparedEmail from '../../email';
+import { MediaType } from '../../../constants/media';

 class EmailAgent
  extends BaseAgent<NotificationAgentEmail>
@@ -57,7 +58,9 @@ class EmailAgent
              to: user.email,
            },
            locals: {
-              body: 'A user has requested new media!',
+              body: `A user has requested a new ${
+                payload.media?.mediaType === MediaType.TV ? 'series' : 'movie'
+              }!`,
              mediaName: payload.subject,
              imageUrl: payload.image,
              timestamp: new Date().toTimeString(),
@@ -67,13 +70,15 @@ class EmailAgent
                : undefined,
              applicationUrl,
              applicationTitle,
-              requestType: 'New Request',
+              requestType: `New ${
+                payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+              } Request`,
            },
          });
        });
      return true;
    } catch (e) {
-      logger.error('Mail notification failed to send', {
+      logger.error('Email notification failed to send', {
        label: 'Notifications',
        message: e.message,
      });
@@ -103,8 +108,11 @@ class EmailAgent
              to: user.email,
            },
            locals: {
-              body:
-                "A user's new request has failed to add to Sonarr or Radarr",
+              body: `A new request for the following ${
+                payload.media?.mediaType === MediaType.TV ? 'series' : 'movie'
+              } could not be added to ${
+                payload.media?.mediaType === MediaType.TV ? 'Sonarr' : 'Radarr'
+              }`,
              mediaName: payload.subject,
              imageUrl: payload.image,
              timestamp: new Date().toTimeString(),
@@ -114,13 +122,15 @@ class EmailAgent
                : undefined,
              applicationUrl,
              applicationTitle,
-              requestType: 'Failed Request',
+              requestType: `Failed ${
+                payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+              } Request`,
            },
          });
        });
      return true;
    } catch (e) {
-      logger.error('Mail notification failed to send', {
+      logger.error('Email notification failed to send', {
        label: 'Notifications',
        message: e.message,
      });
@@ -143,7 +153,9 @@ class EmailAgent
          to: payload.notifyUser.email,
        },
        locals: {
-          body: 'Your request for the following media has been approved:',
+          body: `Your request for the following ${
+            payload.media?.mediaType === MediaType.TV ? 'series' : 'movie'
+          } has been approved:`,
          mediaName: payload.subject,
          imageUrl: payload.image,
          timestamp: new Date().toTimeString(),
@@ -153,12 +165,64 @@ class EmailAgent
            : undefined,
          applicationUrl,
          applicationTitle,
-          requestType: 'Request Approved',
+          requestType: `${
+            payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+          } Request Approved`,
        },
      });
      return true;
    } catch (e) {
-      logger.error('Mail notification failed to send', {
+      logger.error('Email notification failed to send', {
+        label: 'Notifications',
+        message: e.message,
+      });
+      return false;
+    }
+  }
+
+  private async sendMediaAutoApprovedEmail(payload: NotificationPayload) {
+    // This is getting main settings for the whole app
+    const { applicationUrl, applicationTitle } = getSettings().main;
+    try {
+      const userRepository = getRepository(User);
+      const users = await userRepository.find();
+
+      // Send to all users with the manage requests permission (or admins)
+      users
+        .filter((user) => user.hasPermission(Permission.MANAGE_REQUESTS))
+        .forEach((user) => {
+          const email = new PreparedEmail();
+
+          email.send({
+            template: path.join(
+              __dirname,
+              '../../../templates/email/media-request'
+            ),
+            message: {
+              to: user.email,
+            },
+            locals: {
+              body: `A new request for the following ${
+                payload.media?.mediaType === MediaType.TV ? 'series' : 'movie'
+              } has been automatically approved:`,
+              mediaName: payload.subject,
+              imageUrl: payload.image,
+              timestamp: new Date().toTimeString(),
+              requestedBy: payload.notifyUser.displayName,
+              actionUrl: applicationUrl
+                ? `${applicationUrl}/${payload.media?.mediaType}/${payload.media?.tmdbId}`
+                : undefined,
+              applicationUrl,
+              applicationTitle,
+              requestType: `${
+                payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+              } Request Automatically Approved`,
+            },
+          });
+        });
+      return true;
+    } catch (e) {
+      logger.error('Email notification failed to send', {
        label: 'Notifications',
        message: e.message,
      });
@@ -181,7 +245,9 @@ class EmailAgent
          to: payload.notifyUser.email,
        },
        locals: {
-          body: 'Your request for the following media was declined:',
+          body: `Your request for the following ${
+            payload.media?.mediaType === MediaType.TV ? 'series' : 'movie'
+          } was declined:`,
          mediaName: payload.subject,
          imageUrl: payload.image,
          timestamp: new Date().toTimeString(),
@@ -191,12 +257,14 @@ class EmailAgent
            : undefined,
          applicationUrl,
          applicationTitle,
-          requestType: 'Request Declined',
+          requestType: `${
+            payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+          } Request Declined`,
        },
      });
      return true;
    } catch (e) {
-      logger.error('Mail notification failed to send', {
+      logger.error('Email notification failed to send', {
        label: 'Notifications',
        message: e.message,
      });
@@ -219,7 +287,9 @@ class EmailAgent
          to: payload.notifyUser.email,
        },
        locals: {
-          body: 'Your requested media is now available!',
+          body: `The following ${
+            payload.media?.mediaType === MediaType.TV ? 'series' : 'movie'
+          } you requested is now available!`,
          mediaName: payload.subject,
          imageUrl: payload.image,
          timestamp: new Date().toTimeString(),
@@ -229,12 +299,14 @@ class EmailAgent
            : undefined,
          applicationUrl,
          applicationTitle,
-          requestType: 'Now Available',
+          requestType: `${
+            payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+          } Now Available`,
        },
      });
      return true;
    } catch (e) {
-      logger.error('Mail notification failed to send', {
+      logger.error('Email notification failed to send', {
        label: 'Notifications',
        message: e.message,
      });
@@ -261,7 +333,7 @@ class EmailAgent
      });
      return true;
    } catch (e) {
-      logger.error('Mail notification failed to send', {
+      logger.error('Email notification failed to send', {
        label: 'Notifications',
        message: e.message,
      });
@@ -282,6 +354,9 @@ class EmailAgent
      case Notification.MEDIA_APPROVED:
        this.sendMediaApprovedEmail(payload);
        break;
+      case Notification.MEDIA_AUTO_APPROVED:
+        this.sendMediaAutoApprovedEmail(payload);
+        break;
      case Notification.MEDIA_DECLINED:
        this.sendMediaDeclinedEmail(payload);
        break;
--- a/server/lib/notifications/agents/pushbullet.ts
+++ b/server/lib/notifications/agents/pushbullet.ts
@@ -3,6 +3,7 @@ import { hasNotificationType, Notification } from '..';
 import logger from '../../../logger';
 import { getSettings, NotificationAgentPushbullet } from '../../settings';
 import { BaseAgent, NotificationAgent, NotificationPayload } from './agent';
+import { MediaType } from '../../../constants/media';

 interface PushbulletPayload {
  title: string;
@@ -50,7 +51,9 @@ class PushbulletAgent

    switch (type) {
      case Notification.MEDIA_PENDING:
-        messageTitle = 'New Request';
+        messageTitle = `New ${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Request`;
        message += `${title}`;
        if (plot) {
          message += `\n\n${plot}`;
@@ -59,7 +62,20 @@ class PushbulletAgent
        message += `\nStatus: Pending Approval`;
        break;
      case Notification.MEDIA_APPROVED:
-        messageTitle = 'Request 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}`;
@@ -68,7 +84,9 @@ class PushbulletAgent
        message += `\nStatus: Processing`;
        break;
      case Notification.MEDIA_AVAILABLE:
-        messageTitle = 'Now Available';
+        messageTitle = `${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Now Available`;
        message += `${title}`;
        if (plot) {
          message += `\n\n${plot}`;
@@ -77,7 +95,9 @@ class PushbulletAgent
        message += `\nStatus: Available`;
        break;
      case Notification.MEDIA_DECLINED:
-        messageTitle = 'Request Declined';
+        messageTitle = `${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Request Declined`;
        message += `${title}`;
        if (plot) {
          message += `\n\n${plot}`;
@@ -86,7 +106,9 @@ class PushbulletAgent
        message += `\nStatus: Declined`;
        break;
      case Notification.MEDIA_FAILED:
-        messageTitle = 'Failed Request';
+        messageTitle = `Failed ${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Request`;
        message += `${title}`;
        if (plot) {
          message += `\n\n${plot}`;
--- a/server/lib/notifications/agents/pushover.ts
+++ b/server/lib/notifications/agents/pushover.ts
@@ -3,6 +3,7 @@ import { hasNotificationType, Notification } from '..';
 import logger from '../../../logger';
 import { getSettings, NotificationAgentPushover } from '../../settings';
 import { BaseAgent, NotificationAgent, NotificationPayload } from './agent';
+import { MediaType } from '../../../constants/media';

 interface PushoverPayload {
  token: string;
@@ -64,7 +65,9 @@ class PushoverAgent

    switch (type) {
      case Notification.MEDIA_PENDING:
-        messageTitle = 'New Request';
+        messageTitle = `New ${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Request`;
        message += `<b>${title}</b>`;
        if (plot) {
          message += `\n${plot}`;
@@ -73,7 +76,20 @@ class PushoverAgent
        message += `\n\n<b>Status</b>\nPending Approval`;
        break;
      case Notification.MEDIA_APPROVED:
-        messageTitle = 'Request Approved';
+        messageTitle = `${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Request Approved`;
+        message += `<b>${title}</b>`;
+        if (plot) {
+          message += `\n${plot}`;
+        }
+        message += `\n\n<b>Requested By</b>\n${username}`;
+        message += `\n\n<b>Status</b>\nProcessing`;
+        break;
+      case Notification.MEDIA_AUTO_APPROVED:
+        messageTitle = `${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Request Automatically Approved`;
        message += `<b>${title}</b>`;
        if (plot) {
          message += `\n${plot}`;
@@ -82,7 +98,9 @@ class PushoverAgent
        message += `\n\n<b>Status</b>\nProcessing`;
        break;
      case Notification.MEDIA_AVAILABLE:
-        messageTitle = 'Now Available';
+        messageTitle = `${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Now Available`;
        message += `<b>${title}</b>`;
        if (plot) {
          message += `\n${plot}`;
@@ -91,7 +109,9 @@ class PushoverAgent
        message += `\n\n<b>Status</b>\nAvailable`;
        break;
      case Notification.MEDIA_DECLINED:
-        messageTitle = 'Request Declined';
+        messageTitle = `${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Request Declined`;
        message += `<b>${title}</b>`;
        if (plot) {
          message += `\n${plot}`;
@@ -101,7 +121,9 @@ class PushoverAgent
        priority = 1;
        break;
      case Notification.MEDIA_FAILED:
-        messageTitle = 'Failed Request';
+        messageTitle = `Failed ${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Request`;
        message += `<b>${title}</b>`;
        if (plot) {
          message += `\n${plot}`;
--- a/server/lib/notifications/agents/slack.ts
+++ b/server/lib/notifications/agents/slack.ts
@@ -3,6 +3,7 @@ import { hasNotificationType, Notification } from '..';
 import logger from '../../../logger';
 import { getSettings, NotificationAgentSlack } from '../../settings';
 import { BaseAgent, NotificationAgent, NotificationPayload } from './agent';
+import { MediaType } from '../../../constants/media';

 interface EmbedField {
  type: 'plain_text' | 'mrkdwn';
@@ -72,35 +73,54 @@ class SlackAgent

    switch (type) {
      case Notification.MEDIA_PENDING:
-        header = 'New Request';
+        header = `New ${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Request`;
        fields.push({
          type: 'mrkdwn',
          text: '*Status*\nPending Approval',
        });
        break;
      case Notification.MEDIA_APPROVED:
-        header = 'Request Approved';
+        header = `${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Request Approved`;
+        fields.push({
+          type: 'mrkdwn',
+          text: '*Status*\nProcessing',
+        });
+        break;
+      case Notification.MEDIA_AUTO_APPROVED:
+        header = `${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Request Automatically Approved`;
        fields.push({
          type: 'mrkdwn',
          text: '*Status*\nProcessing',
        });
        break;
      case Notification.MEDIA_AVAILABLE:
-        header = 'Now Available';
+        header = `${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Now Available`;
        fields.push({
          type: 'mrkdwn',
          text: '*Status*\nAvailable',
        });
        break;
      case Notification.MEDIA_DECLINED:
-        header = 'Request Declined';
+        header = `${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Request Declined`;
        fields.push({
          type: 'mrkdwn',
          text: '*Status*\nDeclined',
        });
        break;
      case Notification.MEDIA_FAILED:
-        header = 'Failed Request';
+        header = `Failed ${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Request`;
        fields.push({
          type: 'mrkdwn',
          text: '*Status*\nFailed',
@@ -206,7 +226,7 @@ class SlackAgent
    type: Notification,
    payload: NotificationPayload
  ): Promise<boolean> {
-    logger.debug('Sending slack notification', { label: 'Notifications' });
+    logger.debug('Sending Slack notification', { label: 'Notifications' });
    try {
      const webhookUrl = this.getSettings().options.webhookUrl;

--- a/server/lib/notifications/agents/telegram.ts
+++ b/server/lib/notifications/agents/telegram.ts
@@ -2,6 +2,7 @@ import axios from 'axios';
 import { hasNotificationType, Notification } from '..';
 import logger from '../../../logger';
 import { getSettings, NotificationAgentTelegram } from '../../settings';
+import { MediaType } from '../../../constants/media';
 import { BaseAgent, NotificationAgent, NotificationPayload } from './agent';

 interface TelegramMessagePayload {
@@ -66,7 +67,9 @@ class TelegramAgent
    /* eslint-disable no-useless-escape */
    switch (type) {
      case Notification.MEDIA_PENDING:
-        message += `\*New Request\*`;
+        message += `\*New ${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Request\*`;
        message += `\n\n\*${title}\*`;
        if (plot) {
          message += `\n${plot}`;
@@ -75,7 +78,20 @@ class TelegramAgent
        message += `\n\n\*Status\*\nPending Approval`;
        break;
      case Notification.MEDIA_APPROVED:
-        message += `\*Request Approved\*`;
+        message += `\*${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Request Approved\*`;
+        message += `\n\n\*${title}\*`;
+        if (plot) {
+          message += `\n${plot}`;
+        }
+        message += `\n\n\*Requested By\*\n${user}`;
+        message += `\n\n\*Status\*\nProcessing`;
+        break;
+      case Notification.MEDIA_AUTO_APPROVED:
+        message += `\*${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Request Automatically Approved\*`;
        message += `\n\n\*${title}\*`;
        if (plot) {
          message += `\n${plot}`;
@@ -84,7 +100,9 @@ class TelegramAgent
        message += `\n\n\*Status\*\nProcessing`;
        break;
      case Notification.MEDIA_AVAILABLE:
-        message += `\*Now Available\*`;
+        message += `\*${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Now Available\*`;
        message += `\n\n\*${title}\*`;
        if (plot) {
          message += `\n${plot}`;
@@ -93,7 +111,9 @@ class TelegramAgent
        message += `\n\n\*Status\*\nAvailable`;
        break;
      case Notification.MEDIA_DECLINED:
-        message += `\*Request Declined\*`;
+        message += `\*${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Request Declined\*`;
        message += `\n\n\*${title}\*`;
        if (plot) {
          message += `\n${plot}`;
@@ -102,7 +122,9 @@ class TelegramAgent
        message += `\n\n\*Status\*\nDeclined`;
        break;
      case Notification.MEDIA_FAILED:
-        message += `\*Failed Request\*`;
+        message += `\*Failed ${
+          payload.media?.mediaType === MediaType.TV ? 'Series' : 'Movie'
+        } Request\*`;
        message += `\n\n\*${title}\*`;
        if (plot) {
          message += `\n${plot}`;
@@ -129,12 +151,13 @@ class TelegramAgent
    type: Notification,
    payload: NotificationPayload
  ): Promise<boolean> {
-    logger.debug('Sending telegram notification', { label: 'Notifications' });
+    logger.debug('Sending Telegram notification', { label: 'Notifications' });
    try {
      const endpoint = `${this.baseUrl}bot${
        this.getSettings().options.botAPI
      }/${payload.image ? 'sendPhoto' : 'sendMessage'}`;

+      // Send system notification
      await (payload.image
        ? axios.post(endpoint, {
            photo: payload.image,
@@ -150,7 +173,9 @@ class TelegramAgent
            disable_notification: this.getSettings().options.sendSilently,
          } as TelegramMessagePayload));

+      // Send user notification
      if (
+        this.userNotificationTypes.includes(type) &&
        payload.notifyUser.settings?.enableNotifications &&
        payload.notifyUser.settings?.telegramChatId &&
        payload.notifyUser.settings?.telegramChatId !==
--- a/server/lib/notifications/agents/webhook.ts
+++ b/server/lib/notifications/agents/webhook.ts
@@ -138,7 +138,7 @@ class WebhookAgent

      return true;
    } catch (e) {
-      logger.error('Error sending Webhook notification', {
+      logger.error('Error sending webhook notification', {
        label: 'Notifications',
        errorMessage: e.message,
      });