feat: blacklist media items

fallenbagel · Jul 14, 2024 · d7905dc · d7905dc
1 parent a4046a8
commit d7905dc
Show file tree

Hide file tree

Showing 20 changed files with 376 additions and 378 deletions.
diff --git a/overseerr-api.yml b/overseerr-api.yml
@@ -2829,63 +2829,6 @@ paths:
       responses:
         '204':
           description: 'Flushed cache'
-  /settings/blacklist:
-    get:
-      summary: Returns blacklisted items
-      description: Returns list of all blacklisted media
-      tags:
-        - settings
-      parameters:
-        - in: query
-          name: take
-          schema:
-            type: number
-            nullable: true
-            example: 25
-        - in: query
-          name: skip
-          schema:
-            type: number
-            nullable: true
-            example: 0
-        - in: query
-          name: search
-          schema:
-            type: string
-            nullable: true
-            example: dune
-      responses:
-        '200':
-          description: Blacklisted items returned
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  pageInfo:
-                    $ref: '#/components/schemas/PageInfo'
-                  results:
-                    type: array
-                    items:
-                      type: object
-                      properties:
-                        user:
-                          $ref: '#/components/schemas/User'
-                        createdAt:
-                          type: string
-                          example: 2024-04-21T01:55:44.000Z
-                        id:
-                          type: number
-                          example: 1
-                        mediaType:
-                          type: string
-                          example: movie
-                        title:
-                          type: string
-                          example: Dune
-                        tmdbId:
-                          type: number
-                          example: 438631
   /settings/logs:
     get:
       summary: Returns logs
@@ -4113,6 +4056,62 @@ paths:
                         type: boolean
                         example: false
   /blacklist:
+    get:
+      summary: Returns blacklisted items
+      description: Returns list of all blacklisted media
+      tags:
+        - settings
+      parameters:
+        - in: query
+          name: take
+          schema:
+            type: number
+            nullable: true
+            example: 25
+        - in: query
+          name: skip
+          schema:
+            type: number
+            nullable: true
+            example: 0
+        - in: query
+          name: search
+          schema:
+            type: string
+            nullable: true
+            example: dune
+      responses:
+        '200':
+          description: Blacklisted items returned
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  pageInfo:
+                    $ref: '#/components/schemas/PageInfo'
+                  results:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        user:
+                          $ref: '#/components/schemas/User'
+                        createdAt:
+                          type: string
+                          example: 2024-04-21T01:55:44.000Z
+                        id:
+                          type: number
+                          example: 1
+                        mediaType:
+                          type: string
+                          example: movie
+                        title:
+                          type: string
+                          example: Dune
+                        tmdbId:
+                          type: number
+                          example: 438631
     post:
       summary: Add media to blacklist
       tags:

diff --git a/server/entity/Blacklist.ts b/server/entity/Blacklist.ts
@@ -2,7 +2,7 @@ import { MediaStatus, type MediaType } from '@server/constants/media';
 import { getRepository } from '@server/datasource';
 import Media from '@server/entity/Media';
 import { User } from '@server/entity/User';
-import type { BlacklistItem } from '@server/interfaces/api/discoverInterfaces';
+import type { BlacklistItem } from '@server/interfaces/api/blacklistInterfaces';
 import {
   Column,
   CreateDateColumn,

diff --git a/server/interfaces/api/blacklistAdd.ts b/server/interfaces/api/blacklistAdd.ts
diff --git a/server/interfaces/api/blacklistInterfaces.ts b/server/interfaces/api/blacklistInterfaces.ts
@@ -0,0 +1,14 @@
+import type { User } from '@server/entity/User';
+import type { PaginatedResponse } from '@server/interfaces/api/common';
+
+export interface BlacklistItem {
+  tmdbId: number;
+  mediaType: 'movie' | 'tv';
+  title?: string;
+  createdAt?: Date;
+  user: User;
+}
+
+export interface BlacklistResultsResponse extends PaginatedResponse {
+  results: BlacklistItem[];
+}
diff --git a/server/interfaces/api/discoverInterfaces.ts b/server/interfaces/api/discoverInterfaces.ts
@@ -1,5 +1,3 @@
-import type { User } from '@server/entity/User';
-
 export interface GenreSliderItem {
   id: number;
   name: string;
@@ -19,11 +17,3 @@ export interface WatchlistResponse {
   totalResults: number;
   results: WatchlistItem[];
 }
-
-export interface BlacklistItem {
-  tmdbId: number;
-  mediaType: 'movie' | 'tv';
-  title?: string;
-  createdAt?: Date;
-  user: User;
-}
diff --git a/server/interfaces/api/settingsInterfaces.ts b/server/interfaces/api/settingsInterfaces.ts
@@ -1,4 +1,3 @@
-import type { BlacklistItem } from '@server/interfaces/api/discoverInterfaces';
 import type { PaginatedResponse } from './common';
 
 export type LogMessage = {
@@ -69,7 +68,3 @@ export interface StatusResponse {
   commitsBehind: number;
   restartRequired: boolean;
 }
-
-export interface BlacklistResultsResponse extends PaginatedResponse {
-  results: BlacklistItem[];
-}
diff --git a/server/lib/permissions.ts b/server/lib/permissions.ts
@@ -28,7 +28,6 @@ export enum Permission {
   RECENT_VIEW = 67108864,
   WATCHLIST_VIEW = 134217728,
   MANAGE_BLACKLIST = 268435456,
-  MEDIA_BLACKLIST = 536870912,
   VIEW_BLACKLIST = 1073741824,
 }
 

diff --git a/server/routes/blacklist.ts b/server/routes/blacklist.ts
@@ -1,19 +1,79 @@
+import { MediaType } from '@server/constants/media';
 import { getRepository } from '@server/datasource';
 import { Blacklist } from '@server/entity/Blacklist';
 import Media from '@server/entity/Media';
 import { NotFoundError } from '@server/entity/Watchlist';
-import { blacklistAdd } from '@server/interfaces/api/blacklistAdd';
+import type { BlacklistResultsResponse } from '@server/interfaces/api/blacklistInterfaces';
 import { Permission } from '@server/lib/permissions';
 import logger from '@server/logger';
 import { isAuthenticated } from '@server/middleware/auth';
 import { Router } from 'express';
+import rateLimit from 'express-rate-limit';
 import { QueryFailedError } from 'typeorm';
+import { z } from 'zod';
 
 const blacklistRoutes = Router();
 
+export const blacklistAdd = z.object({
+  tmdbId: z.coerce.number(),
+  mediaType: z.nativeEnum(MediaType),
+  title: z.coerce.string().optional(),
+  user: z.coerce.number(),
+});
+
+blacklistRoutes.get(
+  '/',
+  isAuthenticated([Permission.MANAGE_BLACKLIST, Permission.VIEW_BLACKLIST], {
+    type: 'or',
+  }),
+  rateLimit({ windowMs: 60 * 1000, max: 50 }),
+  async (req, res, next) => {
+    const pageSize = req.query.take ? Number(req.query.take) : 25;
+    const skip = req.query.skip ? Number(req.query.skip) : 0;
+    const search = (req.query.search as string) ?? '';
+
+    try {
+      let query = getRepository(Blacklist)
+        .createQueryBuilder('blacklist')
+        .leftJoinAndSelect('blacklist.user', 'user');
+
+      if (search.length > 0) {
+        query = query.where('blacklist.title like :title', {
+          title: `%${search}%`,
+        });
+      }
+
+      const [blacklistedItems, itemsCount] = await query
+        .orderBy('blacklist.createdAt', 'DESC')
+        .take(pageSize)
+        .skip(skip)
+        .getManyAndCount();
+
+      return res.status(200).json({
+        pageInfo: {
+          pages: Math.ceil(itemsCount / pageSize),
+          pageSize,
+          results: itemsCount,
+          page: Math.ceil(skip / pageSize) + 1,
+        },
+        results: blacklistedItems,
+      } as BlacklistResultsResponse);
+    } catch (error) {
+      logger.error('Something went wrong while retrieving blacklisted items', {
+        label: 'Blacklist',
+        errorMessage: error.message,
+      });
+      return next({
+        status: 500,
+        message: 'Unable to retrieve blacklisted items.',
+      });
+    }
+  }
+);
+
 blacklistRoutes.post(
   '/',
-  isAuthenticated([Permission.MANAGE_BLACKLIST, Permission.MEDIA_BLACKLIST], {
+  isAuthenticated([Permission.MANAGE_BLACKLIST], {
     type: 'or',
   }),
   async (req, res, next) => {
@@ -51,7 +111,7 @@ blacklistRoutes.post(
 
 blacklistRoutes.delete(
   '/:id',
-  isAuthenticated([Permission.MANAGE_BLACKLIST, Permission.MEDIA_BLACKLIST], {
+  isAuthenticated([Permission.MANAGE_BLACKLIST], {
     type: 'or',
   }),
   async (req, res, next) => {

diff --git a/server/routes/settings/index.ts b/server/routes/settings/index.ts
@@ -4,13 +4,11 @@ import PlexTvAPI from '@server/api/plextv';
 import TautulliAPI from '@server/api/tautulli';
 import { ApiErrorCode } from '@server/constants/error';
 import { getRepository } from '@server/datasource';
-import { Blacklist } from '@server/entity/Blacklist';
 import Media from '@server/entity/Media';
 import { MediaRequest } from '@server/entity/MediaRequest';
 import { User } from '@server/entity/User';
 import type { PlexConnection } from '@server/interfaces/api/plexInterfaces';
 import type {
-  BlacklistResultsResponse,
   LogMessage,
   LogsResultsResponse,
   SettingsAboutResponse,
@@ -522,69 +520,6 @@ settingsRoutes.get(
   }
 );
 
-settingsRoutes.get(
-  '/blacklist',
-  rateLimit({ windowMs: 60 * 1000, max: 50 }),
-  async (req, res, next) => {
-    if (
-      !req.user?.hasPermission(
-        [Permission.MANAGE_BLACKLIST, Permission.VIEW_BLACKLIST],
-        { type: 'or' }
-      )
-    ) {
-      return next({
-        status: 403,
-        message: 'You do not have permission to access blacklisted items.',
-      });
-    }
-    const pageSize = req.query.take ? Number(req.query.take) : 25;
-    const skip = req.query.skip ? Number(req.query.skip) : 0;
-    const search = (req.query.search as string) ?? '';
-
-    let blacklistedItems;
-
-    try {
-      if (search.length > 0) {
-        blacklistedItems = await getRepository(Blacklist)
-          .createQueryBuilder('blacklist')
-          .where('blacklist.title like :title', { title: `%${search}%` })
-          .leftJoinAndSelect('blacklist.user', 'user')
-          .orderBy('blacklist.createdAt', 'DESC')
-          .take(pageSize)
-          .skip(skip)
-          .getMany();
-      } else {
-        blacklistedItems = await getRepository(Blacklist)
-          .createQueryBuilder('blacklist')
-          .leftJoinAndSelect('blacklist.user', 'user')
-          .orderBy('blacklist.createdAt', 'DESC')
-          .take(pageSize)
-          .skip(skip)
-          .getMany();
-      }
-
-      return res.status(200).json({
-        pageInfo: {
-          pages: Math.ceil(blacklistedItems.length / pageSize),
-          pageSize,
-          results: blacklistedItems.length,
-          page: Math.ceil(skip / pageSize) + 1,
-        },
-        results: blacklistedItems,
-      } as BlacklistResultsResponse);
-    } catch (error) {
-      logger.error('Something went wrong while retrieving blacklisted items', {
-        label: 'Blacklist',
-        errorMessage: error.message,
-      });
-      return next({
-        status: 500,
-        message: 'Unable to retrieve blacklisted items.',
-      });
-    }
-  }
-);
-
 settingsRoutes.get(
   '/logs',
   rateLimit({ windowMs: 60 * 1000, max: 50 }),