1 import * as express from 'express'
2 import { body, param, query, ValidationChain } from 'express-validator'
3 import { UserRight, VideoPlaylistCreate, VideoPlaylistUpdate } from '../../../../shared'
4 import { logger } from '../../../helpers/logger'
5 import { areValidationErrors } from '../utils'
6 import { isVideoImage } from '../../../helpers/custom-validators/videos'
7 import { CONSTRAINTS_FIELDS } from '../../../initializers/constants'
16 } from '../../../helpers/custom-validators/misc'
18 isVideoPlaylistDescriptionValid,
19 isVideoPlaylistNameValid,
20 isVideoPlaylistPrivacyValid,
21 isVideoPlaylistTimestampValid,
22 isVideoPlaylistTypeValid
23 } from '../../../helpers/custom-validators/video-playlists'
24 import { cleanUpReqFiles } from '../../../helpers/express-utils'
25 import { VideoPlaylistElementModel } from '../../../models/video/video-playlist-element'
26 import { authenticatePromiseIfNeeded } from '../../oauth'
27 import { VideoPlaylistPrivacy } from '../../../../shared/models/videos/playlist/video-playlist-privacy.model'
28 import { VideoPlaylistType } from '../../../../shared/models/videos/playlist/video-playlist-type.model'
29 import { doesVideoChannelIdExist, doesVideoExist, doesVideoPlaylistExist, VideoPlaylistFetchType } from '../../../helpers/middlewares'
30 import { MVideoPlaylist } from '../../../types/models/video/video-playlist'
31 import { MUserAccountId } from '@server/types/models'
33 const videoPlaylistsAddValidator = getCommonPlaylistEditAttributes().concat([
35 .custom(isVideoPlaylistNameValid).withMessage('Should have a valid display name'),
37 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
38 logger.debug('Checking videoPlaylistsAddValidator parameters', { parameters: req.body })
40 if (areValidationErrors(req, res)) return cleanUpReqFiles(req)
42 const body: VideoPlaylistCreate = req.body
43 if (body.videoChannelId && !await doesVideoChannelIdExist(body.videoChannelId, res)) return cleanUpReqFiles(req)
45 if (body.privacy === VideoPlaylistPrivacy.PUBLIC && !body.videoChannelId) {
47 return res.status(400)
48 .json({ error: 'Cannot set "public" a playlist that is not assigned to a channel.' })
55 const videoPlaylistsUpdateValidator = getCommonPlaylistEditAttributes().concat([
57 .custom(isIdOrUUIDValid).withMessage('Should have a valid playlist id/uuid'),
61 .custom(isVideoPlaylistNameValid).withMessage('Should have a valid display name'),
63 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
64 logger.debug('Checking videoPlaylistsUpdateValidator parameters', { parameters: req.body })
66 if (areValidationErrors(req, res)) return cleanUpReqFiles(req)
68 if (!await doesVideoPlaylistExist(req.params.playlistId, res, 'all')) return cleanUpReqFiles(req)
70 const videoPlaylist = getPlaylist(res)
72 if (!checkUserCanManageVideoPlaylist(res.locals.oauth.token.User, videoPlaylist, UserRight.REMOVE_ANY_VIDEO_PLAYLIST, res)) {
73 return cleanUpReqFiles(req)
76 const body: VideoPlaylistUpdate = req.body
78 const newPrivacy = body.privacy || videoPlaylist.privacy
79 if (newPrivacy === VideoPlaylistPrivacy.PUBLIC &&
81 (!videoPlaylist.videoChannelId && !body.videoChannelId) ||
82 body.videoChannelId === null
86 return res.status(400)
87 .json({ error: 'Cannot set "public" a playlist that is not assigned to a channel.' })
90 if (videoPlaylist.type === VideoPlaylistType.WATCH_LATER) {
92 return res.status(400)
93 .json({ error: 'Cannot update a watch later playlist.' })
96 if (body.videoChannelId && !await doesVideoChannelIdExist(body.videoChannelId, res)) return cleanUpReqFiles(req)
102 const videoPlaylistsDeleteValidator = [
104 .custom(isIdOrUUIDValid).withMessage('Should have a valid playlist id/uuid'),
106 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
107 logger.debug('Checking videoPlaylistsDeleteValidator parameters', { parameters: req.params })
109 if (areValidationErrors(req, res)) return
111 if (!await doesVideoPlaylistExist(req.params.playlistId, res)) return
113 const videoPlaylist = getPlaylist(res)
114 if (videoPlaylist.type === VideoPlaylistType.WATCH_LATER) {
115 return res.status(400)
116 .json({ error: 'Cannot delete a watch later playlist.' })
119 if (!checkUserCanManageVideoPlaylist(res.locals.oauth.token.User, videoPlaylist, UserRight.REMOVE_ANY_VIDEO_PLAYLIST, res)) {
127 const videoPlaylistsGetValidator = (fetchType: VideoPlaylistFetchType) => {
130 .custom(isIdOrUUIDValid).withMessage('Should have a valid playlist id/uuid'),
132 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
133 logger.debug('Checking videoPlaylistsGetValidator parameters', { parameters: req.params })
135 if (areValidationErrors(req, res)) return
137 if (!await doesVideoPlaylistExist(req.params.playlistId, res, fetchType)) return
139 const videoPlaylist = res.locals.videoPlaylistFull || res.locals.videoPlaylistSummary
141 // Video is unlisted, check we used the uuid to fetch it
142 if (videoPlaylist.privacy === VideoPlaylistPrivacy.UNLISTED) {
143 if (isUUIDValid(req.params.playlistId)) return next()
145 return res.status(404).end()
148 if (videoPlaylist.privacy === VideoPlaylistPrivacy.PRIVATE) {
149 await authenticatePromiseIfNeeded(req, res)
151 const user = res.locals.oauth ? res.locals.oauth.token.User : null
155 (videoPlaylist.OwnerAccount.id !== user.Account.id && !user.hasRight(UserRight.UPDATE_ANY_VIDEO_PLAYLIST))
157 return res.status(403)
158 .json({ error: 'Cannot get this private video playlist.' })
169 const videoPlaylistsSearchValidator = [
170 query('search').optional().not().isEmpty().withMessage('Should have a valid search'),
172 (req: express.Request, res: express.Response, next: express.NextFunction) => {
173 logger.debug('Checking videoPlaylists search query', { parameters: req.query })
175 if (areValidationErrors(req, res)) return
181 const videoPlaylistsAddVideoValidator = [
183 .custom(isIdOrUUIDValid).withMessage('Should have a valid playlist id/uuid'),
185 .custom(isIdOrUUIDValid).withMessage('Should have a valid video id/uuid'),
186 body('startTimestamp')
188 .custom(isVideoPlaylistTimestampValid).withMessage('Should have a valid start timestamp'),
189 body('stopTimestamp')
191 .custom(isVideoPlaylistTimestampValid).withMessage('Should have a valid stop timestamp'),
193 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
194 logger.debug('Checking videoPlaylistsAddVideoValidator parameters', { parameters: req.params })
196 if (areValidationErrors(req, res)) return
198 if (!await doesVideoPlaylistExist(req.params.playlistId, res, 'all')) return
199 if (!await doesVideoExist(req.body.videoId, res, 'only-video')) return
201 const videoPlaylist = getPlaylist(res)
203 if (!checkUserCanManageVideoPlaylist(res.locals.oauth.token.User, videoPlaylist, UserRight.UPDATE_ANY_VIDEO_PLAYLIST, res)) {
211 const videoPlaylistsUpdateOrRemoveVideoValidator = [
213 .custom(isIdOrUUIDValid).withMessage('Should have a valid playlist id/uuid'),
214 param('playlistElementId')
215 .custom(isIdValid).withMessage('Should have an element id/uuid'),
216 body('startTimestamp')
218 .custom(isVideoPlaylistTimestampValid).withMessage('Should have a valid start timestamp'),
219 body('stopTimestamp')
221 .custom(isVideoPlaylistTimestampValid).withMessage('Should have a valid stop timestamp'),
223 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
224 logger.debug('Checking videoPlaylistsRemoveVideoValidator parameters', { parameters: req.params })
226 if (areValidationErrors(req, res)) return
228 if (!await doesVideoPlaylistExist(req.params.playlistId, res, 'all')) return
230 const videoPlaylist = getPlaylist(res)
232 const videoPlaylistElement = await VideoPlaylistElementModel.loadById(req.params.playlistElementId)
233 if (!videoPlaylistElement) {
235 .json({ error: 'Video playlist element not found' })
240 res.locals.videoPlaylistElement = videoPlaylistElement
242 if (!checkUserCanManageVideoPlaylist(res.locals.oauth.token.User, videoPlaylist, UserRight.UPDATE_ANY_VIDEO_PLAYLIST, res)) return
248 const videoPlaylistElementAPGetValidator = [
250 .custom(isIdOrUUIDValid).withMessage('Should have a valid playlist id/uuid'),
251 param('playlistElementId')
252 .custom(isIdValid).withMessage('Should have an playlist element id'),
254 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
255 logger.debug('Checking videoPlaylistElementAPGetValidator parameters', { parameters: req.params })
257 if (areValidationErrors(req, res)) return
259 const playlistElementId = parseInt(req.params.playlistElementId + '', 10)
260 const playlistId = req.params.playlistId
262 const videoPlaylistElement = await VideoPlaylistElementModel.loadByPlaylistAndElementIdForAP(playlistId, playlistElementId)
263 if (!videoPlaylistElement) {
265 .json({ error: 'Video playlist element not found' })
271 if (videoPlaylistElement.VideoPlaylist.privacy === VideoPlaylistPrivacy.PRIVATE) {
272 return res.status(403).end()
275 res.locals.videoPlaylistElementAP = videoPlaylistElement
281 const videoPlaylistsReorderVideosValidator = [
283 .custom(isIdOrUUIDValid).withMessage('Should have a valid playlist id/uuid'),
284 body('startPosition')
285 .isInt({ min: 1 }).withMessage('Should have a valid start position'),
286 body('insertAfterPosition')
287 .isInt({ min: 0 }).withMessage('Should have a valid insert after position'),
288 body('reorderLength')
290 .isInt({ min: 1 }).withMessage('Should have a valid range length'),
292 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
293 logger.debug('Checking videoPlaylistsReorderVideosValidator parameters', { parameters: req.params })
295 if (areValidationErrors(req, res)) return
297 if (!await doesVideoPlaylistExist(req.params.playlistId, res, 'all')) return
299 const videoPlaylist = getPlaylist(res)
300 if (!checkUserCanManageVideoPlaylist(res.locals.oauth.token.User, videoPlaylist, UserRight.UPDATE_ANY_VIDEO_PLAYLIST, res)) return
302 const nextPosition = await VideoPlaylistElementModel.getNextPositionOf(videoPlaylist.id)
303 const startPosition: number = req.body.startPosition
304 const insertAfterPosition: number = req.body.insertAfterPosition
305 const reorderLength: number = req.body.reorderLength
307 if (startPosition >= nextPosition || insertAfterPosition >= nextPosition) {
309 .json({ error: `Start position or insert after position exceed the playlist limits (max: ${nextPosition - 1})` })
315 if (reorderLength && reorderLength + startPosition > nextPosition) {
317 .json({ error: `Reorder length with this start position exceeds the playlist limits (max: ${nextPosition - startPosition})` })
327 const commonVideoPlaylistFiltersValidator = [
328 query('playlistType')
330 .custom(isVideoPlaylistTypeValid).withMessage('Should have a valid playlist type'),
332 (req: express.Request, res: express.Response, next: express.NextFunction) => {
333 logger.debug('Checking commonVideoPlaylistFiltersValidator parameters', { parameters: req.params })
335 if (areValidationErrors(req, res)) return
341 const doVideosInPlaylistExistValidator = [
343 .customSanitizer(toIntArray)
344 .custom(v => isArrayOf(v, isIdValid)).withMessage('Should have a valid video ids array'),
346 (req: express.Request, res: express.Response, next: express.NextFunction) => {
347 logger.debug('Checking areVideosInPlaylistExistValidator parameters', { parameters: req.query })
349 if (areValidationErrors(req, res)) return
355 // ---------------------------------------------------------------------------
358 videoPlaylistsAddValidator,
359 videoPlaylistsUpdateValidator,
360 videoPlaylistsDeleteValidator,
361 videoPlaylistsGetValidator,
362 videoPlaylistsSearchValidator,
364 videoPlaylistsAddVideoValidator,
365 videoPlaylistsUpdateOrRemoveVideoValidator,
366 videoPlaylistsReorderVideosValidator,
368 videoPlaylistElementAPGetValidator,
370 commonVideoPlaylistFiltersValidator,
372 doVideosInPlaylistExistValidator
375 // ---------------------------------------------------------------------------
377 function getCommonPlaylistEditAttributes () {
379 body('thumbnailfile')
380 .custom((value, { req }) => isVideoImage(req.files, 'thumbnailfile'))
382 'This thumbnail file is not supported or too large. Please, make sure it is of the following type: ' +
383 CONSTRAINTS_FIELDS.VIDEO_PLAYLISTS.IMAGE.EXTNAME.join(', ')
388 .customSanitizer(toValueOrNull)
389 .custom(isVideoPlaylistDescriptionValid).withMessage('Should have a valid description'),
392 .customSanitizer(toIntOrNull)
393 .custom(isVideoPlaylistPrivacyValid).withMessage('Should have correct playlist privacy'),
394 body('videoChannelId')
396 .customSanitizer(toIntOrNull)
397 ] as (ValidationChain | express.Handler)[]
400 function checkUserCanManageVideoPlaylist (user: MUserAccountId, videoPlaylist: MVideoPlaylist, right: UserRight, res: express.Response) {
401 if (videoPlaylist.isOwned() === false) {
403 .json({ error: 'Cannot manage video playlist of another server.' })
409 // Check if the user can manage the video playlist
410 // The user can delete it if s/he is an admin
411 // Or if s/he is the video playlist's owner
412 if (user.hasRight(right) === false && videoPlaylist.ownerAccountId !== user.Account.id) {
414 .json({ error: 'Cannot manage video playlist of another user' })
423 function getPlaylist (res: express.Response) {
424 return res.locals.videoPlaylistFull || res.locals.videoPlaylistSummary