server/controllers/api/videos/blacklist.ts

   1 import * as express from 'express'
   2 import { blacklistVideo, unblacklistVideo } from '@server/lib/video-blacklist'
   3 import { UserRight, VideoBlacklistCreate } from '../../../../shared'
   4 import { HttpStatusCode } from '../../../../shared/models/http/http-error-codes'
   5 import { logger } from '../../../helpers/logger'
   6 import { getFormattedObjects } from '../../../helpers/utils'
   7 import { sequelizeTypescript } from '../../../initializers/database'
   8 import {
   9   asyncMiddleware,
  10   authenticate,
  11   blacklistSortValidator,
  12   ensureUserHasRight,
  13   openapiOperationDoc,
  14   paginationValidator,
  15   setBlacklistSort,
  16   setDefaultPagination,
  17   videosBlacklistAddValidator,
  18   videosBlacklistFiltersValidator,
  19   videosBlacklistRemoveValidator,
  20   videosBlacklistUpdateValidator
  21 } from '../../../middlewares'
  22 import { VideoBlacklistModel } from '../../../models/video/video-blacklist'
  23
  24 const blacklistRouter = express.Router()
  25
  26 blacklistRouter.post('/:videoId/blacklist',
  27   openapiOperationDoc({ operationId: 'addVideoBlock' }),
  28   authenticate,
  29   ensureUserHasRight(UserRight.MANAGE_VIDEO_BLACKLIST),
  30   asyncMiddleware(videosBlacklistAddValidator),
  31   asyncMiddleware(addVideoToBlacklistController)
  32 )
  33
  34 blacklistRouter.get('/blacklist',
  35   openapiOperationDoc({ operationId: 'getVideoBlocks' }),
  36   authenticate,
  37   ensureUserHasRight(UserRight.MANAGE_VIDEO_BLACKLIST),
  38   paginationValidator,
  39   blacklistSortValidator,
  40   setBlacklistSort,
  41   setDefaultPagination,
  42   videosBlacklistFiltersValidator,
  43   asyncMiddleware(listBlacklist)
  44 )
  45
  46 blacklistRouter.put('/:videoId/blacklist',
  47   authenticate,
  48   ensureUserHasRight(UserRight.MANAGE_VIDEO_BLACKLIST),
  49   asyncMiddleware(videosBlacklistUpdateValidator),
  50   asyncMiddleware(updateVideoBlacklistController)
  51 )
  52
  53 blacklistRouter.delete('/:videoId/blacklist',
  54   openapiOperationDoc({ operationId: 'delVideoBlock' }),
  55   authenticate,
  56   ensureUserHasRight(UserRight.MANAGE_VIDEO_BLACKLIST),
  57   asyncMiddleware(videosBlacklistRemoveValidator),
  58   asyncMiddleware(removeVideoFromBlacklistController)
  59 )
  60
  61 // ---------------------------------------------------------------------------
  62
  63 export {
  64   blacklistRouter
  65 }
  66
  67 // ---------------------------------------------------------------------------
  68
  69 async function addVideoToBlacklistController (req: express.Request, res: express.Response) {
  70   const videoInstance = res.locals.videoAll
  71   const body: VideoBlacklistCreate = req.body
  72
  73   await blacklistVideo(videoInstance, body)
  74
  75   logger.info('Video %s blacklisted.', videoInstance.uuid)
  76
  77   return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end()
  78 }
  79
  80 async function updateVideoBlacklistController (req: express.Request, res: express.Response) {
  81   const videoBlacklist = res.locals.videoBlacklist
  82
  83   if (req.body.reason !== undefined) videoBlacklist.reason = req.body.reason
  84
  85   await sequelizeTypescript.transaction(t => {
  86     return videoBlacklist.save({ transaction: t })
  87   })
  88
  89   return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end()
  90 }
  91
  92 async function listBlacklist (req: express.Request, res: express.Response) {
  93   const resultList = await VideoBlacklistModel.listForApi({
  94     start: req.query.start,
  95     count: req.query.count,
  96     sort: req.query.sort,
  97     search: req.query.search,
  98     type: req.query.type
  99   })
 100
 101   return res.json(getFormattedObjects(resultList.data, resultList.total))
 102 }
 103
 104 async function removeVideoFromBlacklistController (req: express.Request, res: express.Response) {
 105   const videoBlacklist = res.locals.videoBlacklist
 106   const video = res.locals.videoAll
 107
 108   await unblacklistVideo(videoBlacklist, video)
 109
 110   logger.info('Video %s removed from blacklist.', video.uuid)
 111
 112   return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end()
 113 }