1 import express from 'express'
2 import { body } from 'express-validator'
3 import { isLiveLatencyModeValid } from '@server/helpers/custom-validators/video-lives'
4 import { CONSTRAINTS_FIELDS } from '@server/initializers/constants'
5 import { isLocalLiveVideoAccepted } from '@server/lib/moderation'
6 import { Hooks } from '@server/lib/plugins/hooks'
7 import { VideoModel } from '@server/models/video/video'
8 import { VideoLiveModel } from '@server/models/video/video-live'
9 import { VideoLiveSessionModel } from '@server/models/video/video-live-session'
18 } from '@shared/models'
19 import { exists, isBooleanValid, isIdValid, toBooleanOrNull, toIntOrNull } from '../../../helpers/custom-validators/misc'
20 import { isVideoNameValid, isVideoPrivacyValid } from '../../../helpers/custom-validators/videos'
21 import { cleanUpReqFiles } from '../../../helpers/express-utils'
22 import { logger } from '../../../helpers/logger'
23 import { CONFIG } from '../../../initializers/config'
26 checkUserCanManageVideo,
27 doesVideoChannelOfAccountExist,
31 import { getCommonVideoEditAttributes } from './videos'
33 const videoLiveGetValidator = [
34 isValidVideoIdParam('videoId'),
36 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
37 if (areValidationErrors(req, res)) return
38 if (!await doesVideoExist(req.params.videoId, res, 'all')) return
40 const videoLive = await VideoLiveModel.loadByVideoId(res.locals.videoAll.id)
43 status: HttpStatusCode.NOT_FOUND_404,
44 message: 'Live video not found'
48 res.locals.videoLive = videoLive
54 const videoLiveAddValidator = getCommonVideoEditAttributes().concat([
56 .customSanitizer(toIntOrNull)
60 .custom(isVideoNameValid).withMessage(
61 `Should have a video name between ${CONSTRAINTS_FIELDS.VIDEOS.NAME.min} and ${CONSTRAINTS_FIELDS.VIDEOS.NAME.max} characters long`
66 .customSanitizer(toBooleanOrNull)
67 .custom(isBooleanValid).withMessage('Should have a valid saveReplay boolean'),
69 body('replaySettings.privacy')
71 .customSanitizer(toIntOrNull)
72 .custom(isVideoPrivacyValid),
76 .customSanitizer(toBooleanOrNull)
77 .custom(isBooleanValid).withMessage('Should have a valid permanentLive boolean'),
81 .customSanitizer(toIntOrNull)
82 .custom(isLiveLatencyModeValid),
84 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
85 if (areValidationErrors(req, res)) return cleanUpReqFiles(req)
87 if (CONFIG.LIVE.ENABLED !== true) {
91 status: HttpStatusCode.FORBIDDEN_403,
92 message: 'Live is not enabled on this instance',
93 type: ServerErrorCode.LIVE_NOT_ENABLED
97 const body: LiveVideoCreate = req.body
99 if (hasValidSaveReplay(body) !== true) {
103 status: HttpStatusCode.FORBIDDEN_403,
104 message: 'Saving live replay is not enabled on this instance',
105 type: ServerErrorCode.LIVE_NOT_ALLOWING_REPLAY
109 if (hasValidLatencyMode(body) !== true) {
113 status: HttpStatusCode.FORBIDDEN_403,
114 message: 'Custom latency mode is not allowed by this instance'
118 const user = res.locals.oauth.token.User
119 if (!await doesVideoChannelOfAccountExist(body.channelId, user, res)) return cleanUpReqFiles(req)
121 if (CONFIG.LIVE.MAX_INSTANCE_LIVES !== -1) {
122 const totalInstanceLives = await VideoModel.countLives({ remote: false, mode: 'not-ended' })
124 if (totalInstanceLives >= CONFIG.LIVE.MAX_INSTANCE_LIVES) {
128 status: HttpStatusCode.FORBIDDEN_403,
129 message: 'Cannot create this live because the max instance lives limit is reached.',
130 type: ServerErrorCode.MAX_INSTANCE_LIVES_LIMIT_REACHED
135 if (CONFIG.LIVE.MAX_USER_LIVES !== -1) {
136 const totalUserLives = await VideoModel.countLivesOfAccount(user.Account.id)
138 if (totalUserLives >= CONFIG.LIVE.MAX_USER_LIVES) {
142 status: HttpStatusCode.FORBIDDEN_403,
143 message: 'Cannot create this live because the max user lives limit is reached.',
144 type: ServerErrorCode.MAX_USER_LIVES_LIMIT_REACHED
149 if (!await isLiveVideoAccepted(req, res)) return cleanUpReqFiles(req)
155 const videoLiveUpdateValidator = [
158 .customSanitizer(toBooleanOrNull)
159 .custom(isBooleanValid).withMessage('Should have a valid saveReplay boolean'),
161 body('replaySettings.privacy')
163 .customSanitizer(toIntOrNull)
164 .custom(isVideoPrivacyValid),
168 .customSanitizer(toIntOrNull)
169 .custom(isLiveLatencyModeValid),
171 (req: express.Request, res: express.Response, next: express.NextFunction) => {
172 if (areValidationErrors(req, res)) return
174 const body: LiveVideoUpdate = req.body
176 if (hasValidSaveReplay(body) !== true) {
178 status: HttpStatusCode.FORBIDDEN_403,
179 message: 'Saving live replay is not allowed by this instance'
183 if (hasValidLatencyMode(body) !== true) {
185 status: HttpStatusCode.FORBIDDEN_403,
186 message: 'Custom latency mode is not allowed by this instance'
190 if (!checkLiveSettingsReplayConsistency({ res, body })) return
192 if (res.locals.videoAll.state !== VideoState.WAITING_FOR_LIVE) {
193 return res.fail({ message: 'Cannot update a live that has already started' })
196 // Check the user can manage the live
197 const user = res.locals.oauth.token.User
198 if (!checkUserCanManageVideo(user, res.locals.videoAll, UserRight.GET_ANY_LIVE, res)) return
204 const videoLiveListSessionsValidator = [
205 (req: express.Request, res: express.Response, next: express.NextFunction) => {
206 // Check the user can manage the live
207 const user = res.locals.oauth.token.User
208 if (!checkUserCanManageVideo(user, res.locals.videoAll, UserRight.GET_ANY_LIVE, res)) return
214 const videoLiveFindReplaySessionValidator = [
215 isValidVideoIdParam('videoId'),
217 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
218 if (areValidationErrors(req, res)) return
219 if (!await doesVideoExist(req.params.videoId, res, 'id')) return
221 const session = await VideoLiveSessionModel.findSessionOfReplay(res.locals.videoId.id)
224 status: HttpStatusCode.NOT_FOUND_404,
225 message: 'No live replay found'
229 res.locals.videoLiveSession = session
235 // ---------------------------------------------------------------------------
238 videoLiveAddValidator,
239 videoLiveUpdateValidator,
240 videoLiveListSessionsValidator,
241 videoLiveFindReplaySessionValidator,
242 videoLiveGetValidator
245 // ---------------------------------------------------------------------------
247 async function isLiveVideoAccepted (req: express.Request, res: express.Response) {
248 // Check we accept this video
249 const acceptParameters = {
250 liveVideoBody: req.body,
251 user: res.locals.oauth.token.User
253 const acceptedResult = await Hooks.wrapFun(
254 isLocalLiveVideoAccepted,
256 'filter:api.live-video.create.accept.result'
259 if (!acceptedResult || acceptedResult.accepted !== true) {
260 logger.info('Refused local live video.', { acceptedResult, acceptParameters })
263 status: HttpStatusCode.FORBIDDEN_403,
264 message: acceptedResult.errorMessage || 'Refused local live video'
272 function hasValidSaveReplay (body: LiveVideoUpdate | LiveVideoCreate) {
273 if (CONFIG.LIVE.ALLOW_REPLAY !== true && body.saveReplay === true) return false
278 function hasValidLatencyMode (body: LiveVideoUpdate | LiveVideoCreate) {
280 CONFIG.LIVE.LATENCY_SETTING.ENABLED !== true &&
281 exists(body.latencyMode) &&
282 body.latencyMode !== LiveVideoLatencyMode.DEFAULT
288 function checkLiveSettingsReplayConsistency (options: {
289 res: express.Response
290 body: LiveVideoUpdate
292 const { res, body } = options
294 // We now save replays of this live, so replay settings are mandatory
295 if (res.locals.videoLive.saveReplay !== true && body.saveReplay === true) {
297 if (!exists(body.replaySettings)) {
299 status: HttpStatusCode.BAD_REQUEST_400,
300 message: 'Replay settings are missing now the live replay is saved'
305 if (!exists(body.replaySettings.privacy)) {
307 status: HttpStatusCode.BAD_REQUEST_400,
308 message: 'Privacy replay setting is missing now the live replay is saved'
314 // Save replay was and is not enabled, so send an error the user if it specified replay settings
315 if ((!exists(body.saveReplay) && res.locals.videoLive.saveReplay === false) || body.saveReplay === false) {
316 if (exists(body.replaySettings)) {
318 status: HttpStatusCode.BAD_REQUEST_400,
319 message: 'Cannot save replay settings since live replay is not enabled'