1 import express from 'express'
2 import { body, header, param, query, ValidationChain } from 'express-validator'
3 import { isTestInstance } from '@server/helpers/core-utils'
4 import { getResumableUploadPath } from '@server/helpers/upload'
5 import { Redis } from '@server/lib/redis'
6 import { getServerActor } from '@server/models/application/application'
7 import { ExpressPromiseHandler } from '@server/types/express-handler'
8 import { MUserAccountId, MVideoFullLight } from '@server/types/models'
9 import { getAllPrivacies } from '@shared/core-utils'
10 import { HttpStatusCode, ServerErrorCode, UserRight, VideoInclude } from '@shared/models'
21 } from '../../../helpers/custom-validators/misc'
22 import { isBooleanBothQueryValid, isNumberArray, isStringArray } from '../../../helpers/custom-validators/search'
25 isScheduleVideoUpdatePrivacyValid,
27 isVideoDescriptionValid,
28 isVideoFileMimeTypeValid,
36 isVideoOriginallyPublishedAtValid,
39 } from '../../../helpers/custom-validators/videos'
40 import { cleanUpReqFiles } from '../../../helpers/express-utils'
41 import { getVideoStreamDuration } from '../../../helpers/ffmpeg'
42 import { logger } from '../../../helpers/logger'
43 import { deleteFileAndCatch } from '../../../helpers/utils'
44 import { getVideoWithAttributes } from '../../../helpers/video'
45 import { CONFIG } from '../../../initializers/config'
46 import { CONSTRAINTS_FIELDS, OVERVIEWS } from '../../../initializers/constants'
47 import { isLocalVideoAccepted } from '../../../lib/moderation'
48 import { Hooks } from '../../../lib/plugins/hooks'
49 import { VideoModel } from '../../../models/video/video'
53 checkUserCanManageVideo,
55 doesVideoChannelOfAccountExist,
57 doesVideoFileOfVideoExist,
61 const videosAddLegacyValidator = getCommonVideoEditAttributes().concat([
63 .custom((_, { req }) => isFileValid({ files: req.files, field: 'videofile', mimeTypeRegex: null, maxSize: null }))
64 .withMessage('Should have a file'),
67 .custom(isVideoNameValid).withMessage(
68 `Should have a video name between ${CONSTRAINTS_FIELDS.VIDEOS.NAME.min} and ${CONSTRAINTS_FIELDS.VIDEOS.NAME.max} characters long`
71 .customSanitizer(toIntOrNull)
72 .custom(isIdValid).withMessage('Should have correct video channel id'),
74 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
75 logger.debug('Checking videosAdd parameters', { parameters: req.body, files: req.files })
77 if (areValidationErrors(req, res)) return cleanUpReqFiles(req)
79 const videoFile: express.VideoUploadFile = req.files['videofile'][0]
80 const user = res.locals.oauth.token.User
82 if (!await commonVideoChecksPass({ req, res, user, videoFileSize: videoFile.size, files: req.files })) {
83 return cleanUpReqFiles(req)
87 if (!videoFile.duration) await addDurationToVideo(videoFile)
89 logger.error('Invalid input file in videosAddLegacyValidator.', { err })
92 status: HttpStatusCode.UNPROCESSABLE_ENTITY_422,
93 message: 'Video file unreadable.'
95 return cleanUpReqFiles(req)
98 if (!await isVideoAccepted(req, res, videoFile)) return cleanUpReqFiles(req)
105 * Gets called after the last PUT request
107 const videosAddResumableValidator = [
108 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
109 const user = res.locals.oauth.token.User
110 const body: express.CustomUploadXFile<express.UploadXFileMetadata> = req.body
111 const file = { ...body, duration: undefined, path: getResumableUploadPath(body.name), filename: body.metadata.filename }
112 const cleanup = () => deleteFileAndCatch(file.path)
114 const uploadId = req.query.upload_id
115 const sessionExists = await Redis.Instance.doesUploadSessionExist(uploadId)
118 const sessionResponse = await Redis.Instance.getUploadSession(uploadId)
120 if (!sessionResponse) {
121 res.setHeader('Retry-After', 300) // ask to retry after 5 min, knowing the upload_id is kept for up to 15 min after completion
124 status: HttpStatusCode.SERVICE_UNAVAILABLE_503,
125 message: 'The upload is already being processed'
129 if (isTestInstance()) {
130 res.setHeader('x-resumable-upload-cached', 'true')
133 return res.json(sessionResponse)
136 await Redis.Instance.setUploadSession(uploadId)
138 if (!await doesVideoChannelOfAccountExist(file.metadata.channelId, user, res)) return cleanup()
141 if (!file.duration) await addDurationToVideo(file)
143 logger.error('Invalid input file in videosAddResumableValidator.', { err })
146 status: HttpStatusCode.UNPROCESSABLE_ENTITY_422,
147 message: 'Video file unreadable.'
152 if (!await isVideoAccepted(req, res, file)) return cleanup()
154 res.locals.videoFileResumable = { ...file, originalname: file.filename }
161 * File is created in POST initialisation, and its body is saved as a 'metadata' field is saved by uploadx for later use.
162 * see https://github.com/kukhariev/node-uploadx/blob/dc9fb4a8ac5a6f481902588e93062f591ec6ef03/packages/core/src/handlers/uploadx.ts
164 * Uploadx doesn't use next() until the upload completes, so this middleware has to be placed before uploadx
165 * see https://github.com/kukhariev/node-uploadx/blob/dc9fb4a8ac5a6f481902588e93062f591ec6ef03/packages/core/src/handlers/base-handler.ts
168 const videosAddResumableInitValidator = getCommonVideoEditAttributes().concat([
172 .withMessage('Should have a valid filename'),
175 .custom(isVideoNameValid).withMessage(
176 `Should have a video name between ${CONSTRAINTS_FIELDS.VIDEOS.NAME.min} and ${CONSTRAINTS_FIELDS.VIDEOS.NAME.max} characters long`
179 .customSanitizer(toIntOrNull)
180 .custom(isIdValid).withMessage('Should have correct video channel id'),
182 header('x-upload-content-length')
185 .withMessage('Should specify the file length'),
186 header('x-upload-content-type')
189 .withMessage('Should specify the file mimetype'),
191 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
192 const videoFileMetadata = {
193 mimetype: req.headers['x-upload-content-type'] as string,
194 size: +req.headers['x-upload-content-length'],
195 originalname: req.body.filename
198 const user = res.locals.oauth.token.User
199 const cleanup = () => cleanUpReqFiles(req)
201 logger.debug('Checking videosAddResumableInitValidator parameters and headers', {
202 parameters: req.body,
203 headers: req.headers,
207 if (areValidationErrors(req, res)) return cleanup()
209 const files = { videofile: [ videoFileMetadata ] }
210 if (!await commonVideoChecksPass({ req, res, user, videoFileSize: videoFileMetadata.size, files })) return cleanup()
212 // multer required unsetting the Content-Type, now we can set it for node-uploadx
213 req.headers['content-type'] = 'application/json; charset=utf-8'
214 // place previewfile in metadata so that uploadx saves it in .META
215 if (req.files?.['previewfile']) req.body.previewfile = req.files['previewfile']
221 const videosUpdateValidator = getCommonVideoEditAttributes().concat([
222 isValidVideoIdParam('id'),
227 .custom(isVideoNameValid).withMessage(
228 `Should have a video name between ${CONSTRAINTS_FIELDS.VIDEOS.NAME.min} and ${CONSTRAINTS_FIELDS.VIDEOS.NAME.max} characters long`
232 .customSanitizer(toIntOrNull)
233 .custom(isIdValid).withMessage('Should have correct video channel id'),
235 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
236 logger.debug('Checking videosUpdate parameters', { parameters: req.body })
238 if (areValidationErrors(req, res)) return cleanUpReqFiles(req)
239 if (areErrorsInScheduleUpdate(req, res)) return cleanUpReqFiles(req)
240 if (!await doesVideoExist(req.params.id, res)) return cleanUpReqFiles(req)
242 // Check if the user who did the request is able to update the video
243 const user = res.locals.oauth.token.User
244 if (!checkUserCanManageVideo(user, res.locals.videoAll, UserRight.UPDATE_ANY_VIDEO, res)) return cleanUpReqFiles(req)
246 if (req.body.channelId && !await doesVideoChannelOfAccountExist(req.body.channelId, user, res)) return cleanUpReqFiles(req)
252 async function checkVideoFollowConstraints (req: express.Request, res: express.Response, next: express.NextFunction) {
253 const video = getVideoWithAttributes(res)
255 // Anybody can watch local videos
256 if (video.isOwned() === true) return next()
259 if (res.locals.oauth) {
260 // Users can search or watch remote videos
261 if (CONFIG.SEARCH.REMOTE_URI.USERS === true) return next()
264 // Anybody can search or watch remote videos
265 if (CONFIG.SEARCH.REMOTE_URI.ANONYMOUS === true) return next()
267 // Check our instance follows an actor that shared this video
268 const serverActor = await getServerActor()
269 if (await VideoModel.checkVideoHasInstanceFollow(video.id, serverActor.id) === true) return next()
272 status: HttpStatusCode.FORBIDDEN_403,
273 message: 'Cannot get this video regarding follow constraints',
274 type: ServerErrorCode.DOES_NOT_RESPECT_FOLLOW_CONSTRAINTS,
281 const videosCustomGetValidator = (
282 fetchType: 'for-api' | 'all' | 'only-video' | 'only-immutable-attributes',
283 authenticateInQuery = false
286 isValidVideoIdParam('id'),
288 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
289 logger.debug('Checking videosGet parameters', { parameters: req.params })
291 if (areValidationErrors(req, res)) return
292 if (!await doesVideoExist(req.params.id, res, fetchType)) return
294 // Controllers does not need to check video rights
295 if (fetchType === 'only-immutable-attributes') return next()
297 const video = getVideoWithAttributes(res) as MVideoFullLight
299 if (!await checkCanSeeVideo({ req, res, video, paramId: req.params.id, authenticateInQuery })) return
306 const videosGetValidator = videosCustomGetValidator('all')
307 const videosDownloadValidator = videosCustomGetValidator('all', true)
309 const videoFileMetadataGetValidator = getCommonVideoEditAttributes().concat([
310 isValidVideoIdParam('id'),
313 .custom(isIdValid).not().isEmpty().withMessage('Should have a valid videoFileId'),
315 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
316 logger.debug('Checking videoFileMetadataGet parameters', { parameters: req.params })
318 if (areValidationErrors(req, res)) return
319 if (!await doesVideoFileOfVideoExist(+req.params.videoFileId, req.params.id, res)) return
325 const videosRemoveValidator = [
326 isValidVideoIdParam('id'),
328 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
329 logger.debug('Checking videosRemove parameters', { parameters: req.params })
331 if (areValidationErrors(req, res)) return
332 if (!await doesVideoExist(req.params.id, res)) return
334 // Check if the user who did the request is able to delete the video
335 if (!checkUserCanManageVideo(res.locals.oauth.token.User, res.locals.videoAll, UserRight.REMOVE_ANY_VIDEO, res)) return
341 const videosOverviewValidator = [
344 .isInt({ min: 1, max: OVERVIEWS.VIDEOS.SAMPLES_COUNT })
345 .withMessage('Should have a valid pagination'),
347 (req: express.Request, res: express.Response, next: express.NextFunction) => {
348 if (areValidationErrors(req, res)) return
354 function getCommonVideoEditAttributes () {
356 body('thumbnailfile')
357 .custom((value, { req }) => isVideoImageValid(req.files, 'thumbnailfile')).withMessage(
358 'This thumbnail file is not supported or too large. Please, make sure it is of the following type: ' +
359 CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME.join(', ')
362 .custom((value, { req }) => isVideoImageValid(req.files, 'previewfile')).withMessage(
363 'This preview file is not supported or too large. Please, make sure it is of the following type: ' +
364 CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME.join(', ')
369 .customSanitizer(toIntOrNull)
370 .custom(isVideoCategoryValid).withMessage('Should have a valid category'),
373 .customSanitizer(toIntOrNull)
374 .custom(isVideoLicenceValid).withMessage('Should have a valid licence'),
377 .customSanitizer(toValueOrNull)
378 .custom(isVideoLanguageValid).withMessage('Should have a valid language'),
381 .customSanitizer(toBooleanOrNull)
382 .custom(isBooleanValid).withMessage('Should have a valid NSFW attribute'),
383 body('waitTranscoding')
385 .customSanitizer(toBooleanOrNull)
386 .custom(isBooleanValid).withMessage('Should have a valid wait transcoding attribute'),
389 .customSanitizer(toValueOrNull)
390 .custom(isVideoPrivacyValid).withMessage('Should have correct video privacy'),
393 .customSanitizer(toValueOrNull)
394 .custom(isVideoDescriptionValid).withMessage('Should have a valid description'),
397 .customSanitizer(toValueOrNull)
398 .custom(isVideoSupportValid).withMessage('Should have a valid support text'),
401 .customSanitizer(toValueOrNull)
402 .custom(areVideoTagsValid)
404 `Should have an array of up to ${CONSTRAINTS_FIELDS.VIDEOS.TAGS.max} tags between ` +
405 `${CONSTRAINTS_FIELDS.VIDEOS.TAG.min} and ${CONSTRAINTS_FIELDS.VIDEOS.TAG.max} characters each`
407 body('commentsEnabled')
409 .customSanitizer(toBooleanOrNull)
410 .custom(isBooleanValid).withMessage('Should have comments enabled boolean'),
411 body('downloadEnabled')
413 .customSanitizer(toBooleanOrNull)
414 .custom(isBooleanValid).withMessage('Should have downloading enabled boolean'),
415 body('originallyPublishedAt')
417 .customSanitizer(toValueOrNull)
418 .custom(isVideoOriginallyPublishedAtValid).withMessage('Should have a valid original publication date'),
419 body('scheduleUpdate')
421 .customSanitizer(toValueOrNull),
422 body('scheduleUpdate.updateAt')
424 .custom(isDateValid).withMessage('Should have a schedule update date that conforms to ISO 8601'),
425 body('scheduleUpdate.privacy')
427 .customSanitizer(toIntOrNull)
428 .custom(isScheduleVideoUpdatePrivacyValid).withMessage('Should have correct schedule update privacy')
429 ] as (ValidationChain | ExpressPromiseHandler)[]
432 const commonVideosFiltersValidator = [
433 query('categoryOneOf')
435 .customSanitizer(toArray)
436 .custom(isNumberArray).withMessage('Should have a valid one of category array'),
437 query('licenceOneOf')
439 .customSanitizer(toArray)
440 .custom(isNumberArray).withMessage('Should have a valid one of licence array'),
441 query('languageOneOf')
443 .customSanitizer(toArray)
444 .custom(isStringArray).withMessage('Should have a valid one of language array'),
445 query('privacyOneOf')
447 .customSanitizer(toArray)
448 .custom(isNumberArray).withMessage('Should have a valid one of privacy array'),
451 .customSanitizer(toArray)
452 .custom(isStringArray).withMessage('Should have a valid one of tags array'),
455 .customSanitizer(toArray)
456 .custom(isStringArray).withMessage('Should have a valid all of tags array'),
459 .custom(isBooleanBothQueryValid).withMessage('Should have a valid NSFW attribute'),
462 .customSanitizer(toBooleanOrNull)
463 .custom(isBooleanValid).withMessage('Should have a valid live boolean'),
466 .custom(isVideoFilterValid).withMessage('Should have a valid filter attribute'),
469 .custom(isVideoIncludeValid).withMessage('Should have a valid include attribute'),
472 .customSanitizer(toBooleanOrNull)
473 .custom(isBooleanValid).withMessage('Should have a valid local boolean'),
476 .customSanitizer(toBooleanOrNull)
477 .custom(isBooleanValid).withMessage('Should have a valid has hls boolean'),
478 query('hasWebtorrentFiles')
480 .customSanitizer(toBooleanOrNull)
481 .custom(isBooleanValid).withMessage('Should have a valid has webtorrent boolean'),
484 .customSanitizer(toBooleanOrNull)
485 .custom(isBooleanValid).withMessage('Should have a valid skip count boolean'),
488 .custom(exists).withMessage('Should have a valid search'),
490 (req: express.Request, res: express.Response, next: express.NextFunction) => {
491 logger.debug('Checking commons video filters query', { parameters: req.query })
493 if (areValidationErrors(req, res)) return
495 // FIXME: deprecated in 4.0, to remove
497 if (req.query.filter === 'all-local') {
498 req.query.include = VideoInclude.NOT_PUBLISHED_STATE
499 req.query.isLocal = true
500 req.query.privacyOneOf = getAllPrivacies()
501 } else if (req.query.filter === 'all') {
502 req.query.include = VideoInclude.NOT_PUBLISHED_STATE
503 req.query.privacyOneOf = getAllPrivacies()
504 } else if (req.query.filter === 'local') {
505 req.query.isLocal = true
508 req.query.filter = undefined
511 const user = res.locals.oauth?.token.User
513 if ((!user || user.hasRight(UserRight.SEE_ALL_VIDEOS) !== true)) {
514 if (req.query.include || req.query.privacyOneOf) {
516 status: HttpStatusCode.UNAUTHORIZED_401,
517 message: 'You are not allowed to see all videos.'
526 // ---------------------------------------------------------------------------
529 videosAddLegacyValidator,
530 videosAddResumableValidator,
531 videosAddResumableInitValidator,
533 videosUpdateValidator,
535 videoFileMetadataGetValidator,
536 videosDownloadValidator,
537 checkVideoFollowConstraints,
538 videosCustomGetValidator,
539 videosRemoveValidator,
541 getCommonVideoEditAttributes,
543 commonVideosFiltersValidator,
545 videosOverviewValidator
548 // ---------------------------------------------------------------------------
550 function areErrorsInScheduleUpdate (req: express.Request, res: express.Response) {
551 if (req.body.scheduleUpdate) {
552 if (!req.body.scheduleUpdate.updateAt) {
553 logger.warn('Invalid parameters: scheduleUpdate.updateAt is mandatory.')
555 res.fail({ message: 'Schedule update at is mandatory.' })
563 async function commonVideoChecksPass (parameters: {
565 res: express.Response
567 videoFileSize: number
568 files: express.UploadFilesForCheck
569 }): Promise<boolean> {
570 const { req, res, user, videoFileSize, files } = parameters
572 if (areErrorsInScheduleUpdate(req, res)) return false
574 if (!await doesVideoChannelOfAccountExist(req.body.channelId, user, res)) return false
576 if (!isVideoFileMimeTypeValid(files)) {
578 status: HttpStatusCode.UNSUPPORTED_MEDIA_TYPE_415,
579 message: 'This file is not supported. Please, make sure it is of the following type: ' +
580 CONSTRAINTS_FIELDS.VIDEOS.EXTNAME.join(', ')
585 if (!isVideoFileSizeValid(videoFileSize.toString())) {
587 status: HttpStatusCode.PAYLOAD_TOO_LARGE_413,
588 message: 'This file is too large. It exceeds the maximum file size authorized.',
589 type: ServerErrorCode.MAX_FILE_SIZE_REACHED
594 if (await checkUserQuota(user, videoFileSize, res) === false) return false
599 export async function isVideoAccepted (
600 req: express.Request,
601 res: express.Response,
602 videoFile: express.VideoUploadFile
604 // Check we accept this video
605 const acceptParameters = {
608 user: res.locals.oauth.token.User
610 const acceptedResult = await Hooks.wrapFun(
611 isLocalVideoAccepted,
613 'filter:api.video.upload.accept.result'
616 if (!acceptedResult || acceptedResult.accepted !== true) {
617 logger.info('Refused local video.', { acceptedResult, acceptParameters })
619 status: HttpStatusCode.FORBIDDEN_403,
620 message: acceptedResult.errorMessage || 'Refused local video'
628 async function addDurationToVideo (videoFile: { path: string, duration?: number }) {
629 const duration = await getVideoStreamDuration(videoFile.path)
631 // FFmpeg may not be able to guess video duration
632 // For example with m2v files: https://trac.ffmpeg.org/ticket/9726#comment:2
633 if (isNaN(duration)) videoFile.duration = 0
634 else videoFile.duration = duration