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