1 import * as express from 'express'
2 import { body, param, ValidationChain } from 'express-validator/check'
3 import { UserRight, VideoPrivacy } from '../../../../shared'
4 import { logger } from '../../../helpers/logger'
5 import { UserModel } from '../../../models/account/user'
6 import { areValidationErrors } from '../utils'
7 import { isVideoExist, isVideoImage } from '../../../helpers/custom-validators/videos'
8 import { CONSTRAINTS_FIELDS } from '../../../initializers'
9 import { isIdOrUUIDValid, toValueOrNull } from '../../../helpers/custom-validators/misc'
11 isVideoPlaylistDescriptionValid,
13 isVideoPlaylistNameValid,
14 isVideoPlaylistPrivacyValid
15 } from '../../../helpers/custom-validators/video-playlists'
16 import { VideoPlaylistModel } from '../../../models/video/video-playlist'
17 import { cleanUpReqFiles } from '../../../helpers/express-utils'
18 import { isVideoChannelIdExist } from '../../../helpers/custom-validators/video-channels'
19 import { VideoPlaylistElementModel } from '../../../models/video/video-playlist-element'
20 import { VideoModel } from '../../../models/video/video'
21 import { authenticatePromiseIfNeeded } from '../../oauth'
22 import { VideoPlaylistPrivacy } from '../../../../shared/models/videos/playlist/video-playlist-privacy.model'
24 const videoPlaylistsAddValidator = getCommonPlaylistEditAttributes().concat([
25 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
26 logger.debug('Checking videoPlaylistsAddValidator parameters', { parameters: req.body })
28 if (areValidationErrors(req, res)) return cleanUpReqFiles(req)
30 if (req.body.videoChannelId && !await isVideoChannelIdExist(req.body.videoChannelId, res)) return cleanUpReqFiles(req)
36 const videoPlaylistsUpdateValidator = getCommonPlaylistEditAttributes().concat([
38 .custom(isIdOrUUIDValid).withMessage('Should have a valid playlist id/uuid'),
40 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
41 logger.debug('Checking videoPlaylistsUpdateValidator parameters', { parameters: req.body })
43 if (areValidationErrors(req, res)) return cleanUpReqFiles(req)
45 if (!await isVideoPlaylistExist(req.params.playlistId, res)) return cleanUpReqFiles(req)
46 if (!checkUserCanManageVideoPlaylist(res.locals.oauth.token.User, res.locals.videoPlaylist, UserRight.REMOVE_ANY_VIDEO_PLAYLIST, res)) {
47 return cleanUpReqFiles(req)
50 if (req.body.videoChannelId && !await isVideoChannelIdExist(req.body.videoChannelId, res)) return cleanUpReqFiles(req)
56 const videoPlaylistsDeleteValidator = [
58 .custom(isIdOrUUIDValid).withMessage('Should have a valid playlist id/uuid'),
60 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
61 logger.debug('Checking videoPlaylistsDeleteValidator parameters', { parameters: req.params })
63 if (areValidationErrors(req, res)) return
65 if (!await isVideoPlaylistExist(req.params.playlistId, res)) return
66 if (!checkUserCanManageVideoPlaylist(res.locals.oauth.token.User, res.locals.videoPlaylist, UserRight.REMOVE_ANY_VIDEO_PLAYLIST, res)) {
74 const videoPlaylistsGetValidator = [
76 .custom(isIdOrUUIDValid).withMessage('Should have a valid playlist id/uuid'),
78 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
79 logger.debug('Checking videoPlaylistsGetValidator parameters', { parameters: req.params })
81 if (areValidationErrors(req, res)) return
83 if (!await isVideoPlaylistExist(req.params.playlistId, res)) return
85 const videoPlaylist: VideoPlaylistModel = res.locals.videoPlaylist
86 if (videoPlaylist.privacy === VideoPlaylistPrivacy.PRIVATE) {
87 await authenticatePromiseIfNeeded(req, res)
89 const user: UserModel = res.locals.oauth ? res.locals.oauth.token.User : null
93 (videoPlaylist.OwnerAccount.userId !== user.id && !user.hasRight(UserRight.UPDATE_ANY_VIDEO_PLAYLIST))
95 return res.status(403)
96 .json({ error: 'Cannot get this private video playlist.' })
106 const videoPlaylistsAddVideoValidator = [
108 .custom(isIdOrUUIDValid).withMessage('Should have a valid playlist id/uuid'),
110 .custom(isIdOrUUIDValid).withMessage('Should have a valid video id/uuid'),
111 body('startTimestamp')
113 .isInt({ min: 0 }).withMessage('Should have a valid start timestamp'),
114 body('stopTimestamp')
116 .isInt({ min: 0 }).withMessage('Should have a valid stop timestamp'),
118 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
119 logger.debug('Checking videoPlaylistsAddVideoValidator parameters', { parameters: req.params })
121 if (areValidationErrors(req, res)) return
123 if (!await isVideoPlaylistExist(req.params.playlistId, res)) return
124 if (!await isVideoExist(req.body.videoId, res, 'id')) return
126 const videoPlaylist: VideoPlaylistModel = res.locals.videoPlaylist
127 const video: VideoModel = res.locals.video
129 const videoPlaylistElement = await VideoPlaylistElementModel.loadByPlaylistAndVideo(videoPlaylist.id, video.id)
130 if (videoPlaylistElement) {
132 .json({ error: 'This video in this playlist already exists' })
138 if (!checkUserCanManageVideoPlaylist(res.locals.oauth.token.User, res.locals.videoPlaylist, UserRight.UPDATE_ANY_VIDEO_PLAYLIST, res)) {
146 const videoPlaylistsUpdateOrRemoveVideoValidator = [
148 .custom(isIdOrUUIDValid).withMessage('Should have a valid playlist id/uuid'),
150 .custom(isIdOrUUIDValid).withMessage('Should have an video id/uuid'),
151 body('startTimestamp')
153 .isInt({ min: 0 }).withMessage('Should have a valid start timestamp'),
154 body('stopTimestamp')
156 .isInt({ min: 0 }).withMessage('Should have a valid stop timestamp'),
158 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
159 logger.debug('Checking videoPlaylistsRemoveVideoValidator parameters', { parameters: req.params })
161 if (areValidationErrors(req, res)) return
163 if (!await isVideoPlaylistExist(req.params.playlistId, res)) return
164 if (!await isVideoExist(req.params.playlistId, res, 'id')) return
166 const videoPlaylist: VideoPlaylistModel = res.locals.videoPlaylist
167 const video: VideoModel = res.locals.video
169 const videoPlaylistElement = await VideoPlaylistElementModel.loadByPlaylistAndVideo(videoPlaylist.id, video.id)
170 if (!videoPlaylistElement) {
172 .json({ error: 'Video playlist element not found' })
177 res.locals.videoPlaylistElement = videoPlaylistElement
179 if (!checkUserCanManageVideoPlaylist(res.locals.oauth.token.User, videoPlaylist, UserRight.UPDATE_ANY_VIDEO_PLAYLIST, res)) return
185 const videoPlaylistElementAPGetValidator = [
187 .custom(isIdOrUUIDValid).withMessage('Should have a valid playlist id/uuid'),
189 .custom(isIdOrUUIDValid).withMessage('Should have an video id/uuid'),
191 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
192 logger.debug('Checking videoPlaylistElementAPGetValidator parameters', { parameters: req.params })
194 if (areValidationErrors(req, res)) return
196 const videoPlaylistElement = await VideoPlaylistElementModel.loadByPlaylistAndVideoForAP(req.params.playlistId, req.params.videoId)
197 if (!videoPlaylistElement) {
199 .json({ error: 'Video playlist element not found' })
205 if (videoPlaylistElement.VideoPlaylist.privacy === VideoPlaylistPrivacy.PRIVATE) {
206 return res.status(403).end()
209 res.locals.videoPlaylistElement = videoPlaylistElement
215 const videoPlaylistsReorderVideosValidator = [
217 .custom(isIdOrUUIDValid).withMessage('Should have a valid playlist id/uuid'),
218 body('startPosition')
219 .isInt({ min: 1 }).withMessage('Should have a valid start position'),
220 body('insertAfterPosition')
221 .isInt({ min: 0 }).withMessage('Should have a valid insert after position'),
222 body('reorderLength')
224 .isInt({ min: 1 }).withMessage('Should have a valid range length'),
226 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
227 logger.debug('Checking videoPlaylistsReorderVideosValidator parameters', { parameters: req.params })
229 if (areValidationErrors(req, res)) return
231 if (!await isVideoPlaylistExist(req.params.playlistId, res)) return
233 const videoPlaylist: VideoPlaylistModel = res.locals.videoPlaylist
234 if (!checkUserCanManageVideoPlaylist(res.locals.oauth.token.User, videoPlaylist, UserRight.UPDATE_ANY_VIDEO_PLAYLIST, res)) return
240 // ---------------------------------------------------------------------------
243 videoPlaylistsAddValidator,
244 videoPlaylistsUpdateValidator,
245 videoPlaylistsDeleteValidator,
246 videoPlaylistsGetValidator,
248 videoPlaylistsAddVideoValidator,
249 videoPlaylistsUpdateOrRemoveVideoValidator,
250 videoPlaylistsReorderVideosValidator,
252 videoPlaylistElementAPGetValidator
255 // ---------------------------------------------------------------------------
257 function getCommonPlaylistEditAttributes () {
259 body('thumbnailfile')
260 .custom((value, { req }) => isVideoImage(req.files, 'thumbnailfile')).withMessage(
261 'This thumbnail file is not supported or too large. Please, make sure it is of the following type: '
262 + CONSTRAINTS_FIELDS.VIDEO_PLAYLISTS.IMAGE.EXTNAME.join(', ')
266 .custom(isVideoPlaylistNameValid).withMessage('Should have a valid display name'),
269 .customSanitizer(toValueOrNull)
270 .custom(isVideoPlaylistDescriptionValid).withMessage('Should have a valid description'),
274 .custom(isVideoPlaylistPrivacyValid).withMessage('Should have correct playlist privacy'),
275 body('videoChannelId')
278 ] as (ValidationChain | express.Handler)[]
281 function checkUserCanManageVideoPlaylist (user: UserModel, videoPlaylist: VideoPlaylistModel, right: UserRight, res: express.Response) {
282 if (videoPlaylist.isOwned() === false) {
284 .json({ error: 'Cannot manage video playlist of another server.' })
290 // Check if the user can manage the video playlist
291 // The user can delete it if s/he is an admin
292 // Or if s/he is the video playlist's owner
293 if (user.hasRight(right) === false && videoPlaylist.ownerAccountId !== user.Account.id) {
295 .json({ error: 'Cannot manage video playlist of another user' })