1 import * as express from 'express'
2 import { move } from 'fs-extra'
3 import { extname } from 'path'
4 import toInt from 'validator/lib/toInt'
5 import { createTorrentAndSetInfoHash } from '@server/helpers/webtorrent'
6 import { changeVideoChannelShare } from '@server/lib/activitypub/share'
7 import { getLocalVideoActivityPubUrl } from '@server/lib/activitypub/url'
8 import { LiveManager } from '@server/lib/live-manager'
9 import { addOptimizeOrMergeAudioJob, buildLocalVideoFromReq, buildVideoThumbnailsFromReq, setVideoTags } from '@server/lib/video'
10 import { generateVideoFilename, getVideoFilePath } from '@server/lib/video-paths'
11 import { getServerActor } from '@server/models/application/application'
12 import { MVideo, MVideoFile, MVideoFullLight } from '@server/types/models'
13 import { VideoCreate, VideoState, VideoUpdate } from '../../../../shared'
14 import { HttpStatusCode } from '../../../../shared/core-utils/miscs/http-error-codes'
15 import { VideoFilter } from '../../../../shared/models/videos/video-query.type'
16 import { auditLoggerFactory, getAuditIdFromRes, VideoAuditView } from '../../../helpers/audit-logger'
17 import { resetSequelizeInstance, retryTransactionWrapper } from '../../../helpers/database-utils'
18 import { buildNSFWFilter, createReqFiles, getCountVideos } from '../../../helpers/express-utils'
19 import { getMetadataFromFile, getVideoFileFPS, getVideoFileResolution } from '../../../helpers/ffprobe-utils'
20 import { logger } from '../../../helpers/logger'
21 import { getFormattedObjects } from '../../../helpers/utils'
22 import { CONFIG } from '../../../initializers/config'
24 DEFAULT_AUDIO_RESOLUTION,
30 } from '../../../initializers/constants'
31 import { sequelizeTypescript } from '../../../initializers/database'
32 import { sendView } from '../../../lib/activitypub/send/send-view'
33 import { federateVideoIfNeeded, fetchRemoteVideoDescription } from '../../../lib/activitypub/videos'
34 import { JobQueue } from '../../../lib/job-queue'
35 import { Notifier } from '../../../lib/notifier'
36 import { Hooks } from '../../../lib/plugins/hooks'
37 import { Redis } from '../../../lib/redis'
38 import { generateVideoMiniature } from '../../../lib/thumbnail'
39 import { autoBlacklistVideoIfNeeded } from '../../../lib/video-blacklist'
42 asyncRetryTransactionMiddleware,
44 checkVideoFollowConstraints,
45 commonVideosFiltersValidator,
50 videoFileMetadataGetValidator,
52 videosCustomGetValidator,
54 videosRemoveValidator,
57 } from '../../../middlewares'
58 import { ScheduleVideoUpdateModel } from '../../../models/video/schedule-video-update'
59 import { VideoModel } from '../../../models/video/video'
60 import { VideoFileModel } from '../../../models/video/video-file'
61 import { blacklistRouter } from './blacklist'
62 import { videoCaptionsRouter } from './captions'
63 import { videoCommentRouter } from './comment'
64 import { videoImportsRouter } from './import'
65 import { liveRouter } from './live'
66 import { ownershipVideoRouter } from './ownership'
67 import { rateVideoRouter } from './rate'
68 import { watchingRouter } from './watching'
70 const auditLogger = auditLoggerFactory('videos')
71 const videosRouter = express.Router()
73 const reqVideoFileAdd = createReqFiles(
74 [ 'videofile', 'thumbnailfile', 'previewfile' ],
75 Object.assign({}, MIMETYPES.VIDEO.MIMETYPE_EXT, MIMETYPES.IMAGE.MIMETYPE_EXT),
77 videofile: CONFIG.STORAGE.TMP_DIR,
78 thumbnailfile: CONFIG.STORAGE.TMP_DIR,
79 previewfile: CONFIG.STORAGE.TMP_DIR
82 const reqVideoFileUpdate = createReqFiles(
83 [ 'thumbnailfile', 'previewfile' ],
84 MIMETYPES.IMAGE.MIMETYPE_EXT,
86 thumbnailfile: CONFIG.STORAGE.TMP_DIR,
87 previewfile: CONFIG.STORAGE.TMP_DIR
91 videosRouter.use('/', blacklistRouter)
92 videosRouter.use('/', rateVideoRouter)
93 videosRouter.use('/', videoCommentRouter)
94 videosRouter.use('/', videoCaptionsRouter)
95 videosRouter.use('/', videoImportsRouter)
96 videosRouter.use('/', ownershipVideoRouter)
97 videosRouter.use('/', watchingRouter)
98 videosRouter.use('/', liveRouter)
100 videosRouter.get('/categories', listVideoCategories)
101 videosRouter.get('/licences', listVideoLicences)
102 videosRouter.get('/languages', listVideoLanguages)
103 videosRouter.get('/privacies', listVideoPrivacies)
105 videosRouter.get('/',
108 setDefaultVideosSort,
109 setDefaultPagination,
110 optionalAuthenticate,
111 commonVideosFiltersValidator,
112 asyncMiddleware(listVideos)
114 videosRouter.put('/:id',
117 asyncMiddleware(videosUpdateValidator),
118 asyncRetryTransactionMiddleware(updateVideo)
120 videosRouter.post('/upload',
123 asyncMiddleware(videosAddValidator),
124 asyncRetryTransactionMiddleware(addVideo)
127 videosRouter.get('/:id/description',
128 asyncMiddleware(videosGetValidator),
129 asyncMiddleware(getVideoDescription)
131 videosRouter.get('/:id/metadata/:videoFileId',
132 asyncMiddleware(videoFileMetadataGetValidator),
133 asyncMiddleware(getVideoFileMetadata)
135 videosRouter.get('/:id',
136 optionalAuthenticate,
137 asyncMiddleware(videosCustomGetValidator('only-video-with-rights')),
138 asyncMiddleware(checkVideoFollowConstraints),
139 asyncMiddleware(getVideo)
141 videosRouter.post('/:id/views',
142 asyncMiddleware(videosCustomGetValidator('only-immutable-attributes')),
143 asyncMiddleware(viewVideo)
146 videosRouter.delete('/:id',
148 asyncMiddleware(videosRemoveValidator),
149 asyncRetryTransactionMiddleware(removeVideo)
152 // ---------------------------------------------------------------------------
158 // ---------------------------------------------------------------------------
160 function listVideoCategories (req: express.Request, res: express.Response) {
161 res.json(VIDEO_CATEGORIES)
164 function listVideoLicences (req: express.Request, res: express.Response) {
165 res.json(VIDEO_LICENCES)
168 function listVideoLanguages (req: express.Request, res: express.Response) {
169 res.json(VIDEO_LANGUAGES)
172 function listVideoPrivacies (req: express.Request, res: express.Response) {
173 res.json(VIDEO_PRIVACIES)
176 async function addVideo (req: express.Request, res: express.Response) {
177 // Uploading the video could be long
178 // Set timeout to 10 minutes, as Express's default is 2 minutes
179 req.setTimeout(1000 * 60 * 10, () => {
180 logger.error('Upload video has timed out.')
181 return res.sendStatus(HttpStatusCode.REQUEST_TIMEOUT_408)
184 const videoPhysicalFile = req.files['videofile'][0]
185 const videoInfo: VideoCreate = req.body
187 const videoData = buildLocalVideoFromReq(videoInfo, res.locals.videoChannel.id)
188 videoData.state = CONFIG.TRANSCODING.ENABLED ? VideoState.TO_TRANSCODE : VideoState.PUBLISHED
189 videoData.duration = videoPhysicalFile['duration'] // duration was added by a previous middleware
191 const video = new VideoModel(videoData) as MVideoFullLight
192 video.VideoChannel = res.locals.videoChannel
193 video.url = getLocalVideoActivityPubUrl(video) // We use the UUID, so set the URL after building the object
195 const videoFile = new VideoFileModel({
196 extname: extname(videoPhysicalFile.filename),
197 size: videoPhysicalFile.size,
198 videoStreamingPlaylistId: null,
199 metadata: await getMetadataFromFile(videoPhysicalFile.path)
202 if (videoFile.isAudio()) {
203 videoFile.resolution = DEFAULT_AUDIO_RESOLUTION
205 videoFile.fps = await getVideoFileFPS(videoPhysicalFile.path)
206 videoFile.resolution = (await getVideoFileResolution(videoPhysicalFile.path)).videoFileResolution
209 videoFile.filename = generateVideoFilename(video, false, videoFile.resolution, videoFile.extname)
211 // Move physical file
212 const destination = getVideoFilePath(video, videoFile)
213 await move(videoPhysicalFile.path, destination)
214 // This is important in case if there is another attempt in the retry process
215 videoPhysicalFile.filename = getVideoFilePath(video, videoFile)
216 videoPhysicalFile.path = destination
218 const [ thumbnailModel, previewModel ] = await buildVideoThumbnailsFromReq({
221 fallback: type => generateVideoMiniature({ video, videoFile, type })
224 const { videoCreated } = await sequelizeTypescript.transaction(async t => {
225 const sequelizeOptions = { transaction: t }
227 const videoCreated = await video.save(sequelizeOptions) as MVideoFullLight
229 await videoCreated.addAndSaveThumbnail(thumbnailModel, t)
230 await videoCreated.addAndSaveThumbnail(previewModel, t)
232 // Do not forget to add video channel information to the created video
233 videoCreated.VideoChannel = res.locals.videoChannel
235 videoFile.videoId = video.id
236 await videoFile.save(sequelizeOptions)
238 video.VideoFiles = [ videoFile ]
240 await setVideoTags({ video, tags: videoInfo.tags, transaction: t })
242 // Schedule an update in the future?
243 if (videoInfo.scheduleUpdate) {
244 await ScheduleVideoUpdateModel.create({
246 updateAt: videoInfo.scheduleUpdate.updateAt,
247 privacy: videoInfo.scheduleUpdate.privacy || null
248 }, { transaction: t })
251 await autoBlacklistVideoIfNeeded({
253 user: res.locals.oauth.token.User,
259 auditLogger.create(getAuditIdFromRes(res), new VideoAuditView(videoCreated.toFormattedDetailsJSON()))
260 logger.info('Video with name %s and uuid %s created.', videoInfo.name, videoCreated.uuid)
262 return { videoCreated }
265 // Create the torrent file in async way because it could be long
266 createTorrentAndSetInfoHashAsync(video, videoFile)
267 .catch(err => logger.error('Cannot create torrent file for video %s', video.url, { err }))
268 .then(() => VideoModel.loadAndPopulateAccountAndServerAndTags(video.id))
269 .then(refreshedVideo => {
270 if (!refreshedVideo) return
272 // Only federate and notify after the torrent creation
273 Notifier.Instance.notifyOnNewVideoIfNeeded(refreshedVideo)
275 return retryTransactionWrapper(() => {
276 return sequelizeTypescript.transaction(t => federateVideoIfNeeded(refreshedVideo, true, t))
279 .catch(err => logger.error('Cannot federate or notify video creation %s', video.url, { err }))
281 if (video.state === VideoState.TO_TRANSCODE) {
282 await addOptimizeOrMergeAudioJob(videoCreated, videoFile, res.locals.oauth.token.User)
285 Hooks.runAction('action:api.video.uploaded', { video: videoCreated })
290 uuid: videoCreated.uuid
295 async function updateVideo (req: express.Request, res: express.Response) {
296 const videoInstance = res.locals.videoAll
297 const videoFieldsSave = videoInstance.toJSON()
298 const oldVideoAuditView = new VideoAuditView(videoInstance.toFormattedDetailsJSON())
299 const videoInfoToUpdate: VideoUpdate = req.body
301 const wasConfidentialVideo = videoInstance.isConfidential()
302 const hadPrivacyForFederation = videoInstance.hasPrivacyForFederation()
304 const [ thumbnailModel, previewModel ] = await buildVideoThumbnailsFromReq({
305 video: videoInstance,
307 fallback: () => Promise.resolve(undefined),
308 automaticallyGenerated: false
312 const videoInstanceUpdated = await sequelizeTypescript.transaction(async t => {
313 const sequelizeOptions = { transaction: t }
314 const oldVideoChannel = videoInstance.VideoChannel
316 if (videoInfoToUpdate.name !== undefined) videoInstance.name = videoInfoToUpdate.name
317 if (videoInfoToUpdate.category !== undefined) videoInstance.category = videoInfoToUpdate.category
318 if (videoInfoToUpdate.licence !== undefined) videoInstance.licence = videoInfoToUpdate.licence
319 if (videoInfoToUpdate.language !== undefined) videoInstance.language = videoInfoToUpdate.language
320 if (videoInfoToUpdate.nsfw !== undefined) videoInstance.nsfw = videoInfoToUpdate.nsfw
321 if (videoInfoToUpdate.waitTranscoding !== undefined) videoInstance.waitTranscoding = videoInfoToUpdate.waitTranscoding
322 if (videoInfoToUpdate.support !== undefined) videoInstance.support = videoInfoToUpdate.support
323 if (videoInfoToUpdate.description !== undefined) videoInstance.description = videoInfoToUpdate.description
324 if (videoInfoToUpdate.commentsEnabled !== undefined) videoInstance.commentsEnabled = videoInfoToUpdate.commentsEnabled
325 if (videoInfoToUpdate.downloadEnabled !== undefined) videoInstance.downloadEnabled = videoInfoToUpdate.downloadEnabled
327 if (videoInfoToUpdate.originallyPublishedAt !== undefined && videoInfoToUpdate.originallyPublishedAt !== null) {
328 videoInstance.originallyPublishedAt = new Date(videoInfoToUpdate.originallyPublishedAt)
331 let isNewVideo = false
332 if (videoInfoToUpdate.privacy !== undefined) {
333 isNewVideo = videoInstance.isNewVideo(videoInfoToUpdate.privacy)
335 const newPrivacy = parseInt(videoInfoToUpdate.privacy.toString(), 10)
336 videoInstance.setPrivacy(newPrivacy)
338 // Unfederate the video if the new privacy is not compatible with federation
339 if (hadPrivacyForFederation && !videoInstance.hasPrivacyForFederation()) {
340 await VideoModel.sendDelete(videoInstance, { transaction: t })
344 const videoInstanceUpdated = await videoInstance.save(sequelizeOptions) as MVideoFullLight
346 if (thumbnailModel) await videoInstanceUpdated.addAndSaveThumbnail(thumbnailModel, t)
347 if (previewModel) await videoInstanceUpdated.addAndSaveThumbnail(previewModel, t)
349 // Video tags update?
350 if (videoInfoToUpdate.tags !== undefined) {
352 video: videoInstanceUpdated,
353 tags: videoInfoToUpdate.tags,
358 // Video channel update?
359 if (res.locals.videoChannel && videoInstanceUpdated.channelId !== res.locals.videoChannel.id) {
360 await videoInstanceUpdated.$set('VideoChannel', res.locals.videoChannel, { transaction: t })
361 videoInstanceUpdated.VideoChannel = res.locals.videoChannel
363 if (hadPrivacyForFederation === true) await changeVideoChannelShare(videoInstanceUpdated, oldVideoChannel, t)
366 // Schedule an update in the future?
367 if (videoInfoToUpdate.scheduleUpdate) {
368 await ScheduleVideoUpdateModel.upsert({
369 videoId: videoInstanceUpdated.id,
370 updateAt: videoInfoToUpdate.scheduleUpdate.updateAt,
371 privacy: videoInfoToUpdate.scheduleUpdate.privacy || null
372 }, { transaction: t })
373 } else if (videoInfoToUpdate.scheduleUpdate === null) {
374 await ScheduleVideoUpdateModel.deleteByVideoId(videoInstanceUpdated.id, t)
377 await autoBlacklistVideoIfNeeded({
378 video: videoInstanceUpdated,
379 user: res.locals.oauth.token.User,
385 await federateVideoIfNeeded(videoInstanceUpdated, isNewVideo, t)
388 getAuditIdFromRes(res),
389 new VideoAuditView(videoInstanceUpdated.toFormattedDetailsJSON()),
392 logger.info('Video with name %s and uuid %s updated.', videoInstance.name, videoInstance.uuid)
394 return videoInstanceUpdated
397 if (wasConfidentialVideo) {
398 Notifier.Instance.notifyOnNewVideoIfNeeded(videoInstanceUpdated)
401 Hooks.runAction('action:api.video.updated', { video: videoInstanceUpdated, body: req.body })
403 // Force fields we want to update
404 // If the transaction is retried, sequelize will think the object has not changed
405 // So it will skip the SQL request, even if the last one was ROLLBACKed!
406 resetSequelizeInstance(videoInstance, videoFieldsSave)
411 return res.type('json')
412 .status(HttpStatusCode.NO_CONTENT_204)
416 async function getVideo (req: express.Request, res: express.Response) {
417 // We need more attributes
418 const userId: number = res.locals.oauth ? res.locals.oauth.token.User.id : null
420 const video = await Hooks.wrapPromiseFun(
421 VideoModel.loadForGetAPI,
422 { id: res.locals.onlyVideoWithRights.id, userId },
423 'filter:api.video.get.result'
426 if (video.isOutdated()) {
427 JobQueue.Instance.createJob({ type: 'activitypub-refresher', payload: { type: 'video', url: video.url } })
430 return res.json(video.toFormattedDetailsJSON())
433 async function viewVideo (req: express.Request, res: express.Response) {
434 const immutableVideoAttrs = res.locals.onlyImmutableVideo
437 const exists = await Redis.Instance.doesVideoIPViewExist(ip, immutableVideoAttrs.uuid)
439 logger.debug('View for ip %s and video %s already exists.', ip, immutableVideoAttrs.uuid)
440 return res.sendStatus(HttpStatusCode.NO_CONTENT_204)
443 const video = await VideoModel.load(immutableVideoAttrs.id)
445 const promises: Promise<any>[] = [
446 Redis.Instance.setIPVideoView(ip, video.uuid, video.isLive)
449 let federateView = true
451 // Increment our live manager
452 if (video.isLive && video.isOwned()) {
453 LiveManager.Instance.addViewTo(video.id)
455 // Views of our local live will be sent by our live manager
459 // Increment our video views cache counter
461 promises.push(Redis.Instance.addVideoView(video.id))
465 const serverActor = await getServerActor()
466 promises.push(sendView(serverActor, video, undefined))
469 await Promise.all(promises)
471 Hooks.runAction('action:api.video.viewed', { video, ip })
473 return res.sendStatus(HttpStatusCode.NO_CONTENT_204)
476 async function getVideoDescription (req: express.Request, res: express.Response) {
477 const videoInstance = res.locals.videoAll
480 if (videoInstance.isOwned()) {
481 description = videoInstance.description
483 description = await fetchRemoteVideoDescription(videoInstance)
486 return res.json({ description })
489 async function getVideoFileMetadata (req: express.Request, res: express.Response) {
490 const videoFile = await VideoFileModel.loadWithMetadata(toInt(req.params.videoFileId))
492 return res.json(videoFile.metadata)
495 async function listVideos (req: express.Request, res: express.Response) {
496 const countVideos = getCountVideos(req)
498 const apiOptions = await Hooks.wrapObject({
499 start: req.query.start,
500 count: req.query.count,
501 sort: req.query.sort,
502 includeLocalVideos: true,
503 categoryOneOf: req.query.categoryOneOf,
504 licenceOneOf: req.query.licenceOneOf,
505 languageOneOf: req.query.languageOneOf,
506 tagsOneOf: req.query.tagsOneOf,
507 tagsAllOf: req.query.tagsAllOf,
508 nsfw: buildNSFWFilter(res, req.query.nsfw),
509 filter: req.query.filter as VideoFilter,
511 user: res.locals.oauth ? res.locals.oauth.token.User : undefined,
513 }, 'filter:api.videos.list.params')
515 const resultList = await Hooks.wrapPromiseFun(
516 VideoModel.listForApi,
518 'filter:api.videos.list.result'
521 return res.json(getFormattedObjects(resultList.data, resultList.total))
524 async function removeVideo (req: express.Request, res: express.Response) {
525 const videoInstance = res.locals.videoAll
527 await sequelizeTypescript.transaction(async t => {
528 await videoInstance.destroy({ transaction: t })
531 auditLogger.delete(getAuditIdFromRes(res), new VideoAuditView(videoInstance.toFormattedDetailsJSON()))
532 logger.info('Video with name %s and uuid %s deleted.', videoInstance.name, videoInstance.uuid)
534 Hooks.runAction('action:api.video.deleted', { video: videoInstance })
536 return res.type('json')
537 .status(HttpStatusCode.NO_CONTENT_204)
541 async function createTorrentAndSetInfoHashAsync (video: MVideo, fileArg: MVideoFile) {
542 await createTorrentAndSetInfoHash(video, fileArg)
544 // Refresh videoFile because the createTorrentAndSetInfoHash could be long
545 const refreshedFile = await VideoFileModel.loadWithVideo(fileArg.id)
546 // File does not exist anymore, remove the generated torrent
547 if (!refreshedFile) return fileArg.removeTorrent()
549 refreshedFile.infoHash = fileArg.infoHash
550 refreshedFile.torrentFilename = fileArg.torrentFilename
552 return refreshedFile.save()