server/controllers/api/videos/index.ts

   1 import * as express from 'express'
   2 import { extname, join } from 'path'
   3 import { VideoCreate, VideoPrivacy, VideoUpdate } from '../../../../shared'
   4 import { renamePromise } from '../../../helpers/core-utils'
   5 import { retryTransactionWrapper } from '../../../helpers/database-utils'
   6 import { getVideoFileHeight } from '../../../helpers/ffmpeg-utils'
   7 import { processImage } from '../../../helpers/image-utils'
   8 import { logger } from '../../../helpers/logger'
   9 import { createReqFiles, getFormattedObjects, getServerActor, resetSequelizeInstance } from '../../../helpers/utils'
  10 import {
  11   CONFIG,
  12   IMAGE_MIMETYPE_EXT,
  13   PREVIEWS_SIZE,
  14   sequelizeTypescript,
  15   THUMBNAILS_SIZE,
  16   VIDEO_CATEGORIES,
  17   VIDEO_LANGUAGES,
  18   VIDEO_LICENCES,
  19   VIDEO_MIMETYPE_EXT,
  20   VIDEO_PRIVACIES
  21 } from '../../../initializers'
  22 import { fetchRemoteVideoDescription, getVideoActivityPubUrl, shareVideoByServerAndChannel } from '../../../lib/activitypub'
  23 import { sendCreateVideo, sendCreateViewToOrigin, sendCreateViewToVideoFollowers, sendUpdateVideo } from '../../../lib/activitypub/send'
  24 import { JobQueue } from '../../../lib/job-queue'
  25 import {
  26   asyncMiddleware,
  27   authenticate,
  28   paginationValidator,
  29   setDefaultPagination,
  30   setDefaultSort,
  31   videosAddValidator,
  32   videosGetValidator,
  33   videosRemoveValidator,
  34   videosSearchValidator,
  35   videosSortValidator,
  36   videosUpdateValidator
  37 } from '../../../middlewares'
  38 import { TagModel } from '../../../models/video/tag'
  39 import { VideoModel } from '../../../models/video/video'
  40 import { VideoFileModel } from '../../../models/video/video-file'
  41 import { abuseVideoRouter } from './abuse'
  42 import { blacklistRouter } from './blacklist'
  43 import { videoChannelRouter } from './channel'
  44 import { videoCommentRouter } from './comment'
  45 import { rateVideoRouter } from './rate'
  46
  47 const videosRouter = express.Router()
  48
  49 const reqVideoFileAdd = createReqFiles(
  50   [ 'videofile', 'thumbnailfile', 'previewfile' ],
  51   Object.assign({}, VIDEO_MIMETYPE_EXT, IMAGE_MIMETYPE_EXT),
  52   {
  53     videofile: CONFIG.STORAGE.VIDEOS_DIR,
  54     thumbnailfile: CONFIG.STORAGE.THUMBNAILS_DIR,
  55     previewfile: CONFIG.STORAGE.PREVIEWS_DIR
  56   }
  57 )
  58 const reqVideoFileUpdate = createReqFiles(
  59   [ 'thumbnailfile', 'previewfile' ],
  60   IMAGE_MIMETYPE_EXT,
  61   {
  62     thumbnailfile: CONFIG.STORAGE.THUMBNAILS_DIR,
  63     previewfile: CONFIG.STORAGE.PREVIEWS_DIR
  64   }
  65 )
  66
  67 videosRouter.use('/', abuseVideoRouter)
  68 videosRouter.use('/', blacklistRouter)
  69 videosRouter.use('/', rateVideoRouter)
  70 videosRouter.use('/', videoChannelRouter)
  71 videosRouter.use('/', videoCommentRouter)
  72
  73 videosRouter.get('/categories', listVideoCategories)
  74 videosRouter.get('/licences', listVideoLicences)
  75 videosRouter.get('/languages', listVideoLanguages)
  76 videosRouter.get('/privacies', listVideoPrivacies)
  77
  78 videosRouter.get('/',
  79   paginationValidator,
  80   videosSortValidator,
  81   setDefaultSort,
  82   setDefaultPagination,
  83   asyncMiddleware(listVideos)
  84 )
  85 videosRouter.get('/search',
  86   videosSearchValidator,
  87   paginationValidator,
  88   videosSortValidator,
  89   setDefaultSort,
  90   setDefaultPagination,
  91   asyncMiddleware(searchVideos)
  92 )
  93 videosRouter.put('/:id',
  94   authenticate,
  95   reqVideoFileUpdate,
  96   asyncMiddleware(videosUpdateValidator),
  97   asyncMiddleware(updateVideoRetryWrapper)
  98 )
  99 videosRouter.post('/upload',
 100   authenticate,
 101   reqVideoFileAdd,
 102   asyncMiddleware(videosAddValidator),
 103   asyncMiddleware(addVideoRetryWrapper)
 104 )
 105
 106 videosRouter.get('/:id/description',
 107   asyncMiddleware(videosGetValidator),
 108   asyncMiddleware(getVideoDescription)
 109 )
 110 videosRouter.get('/:id',
 111   asyncMiddleware(videosGetValidator),
 112   getVideo
 113 )
 114 videosRouter.post('/:id/views',
 115   asyncMiddleware(videosGetValidator),
 116   asyncMiddleware(viewVideo)
 117 )
 118
 119 videosRouter.delete('/:id',
 120   authenticate,
 121   asyncMiddleware(videosRemoveValidator),
 122   asyncMiddleware(removeVideoRetryWrapper)
 123 )
 124
 125 // ---------------------------------------------------------------------------
 126
 127 export {
 128   videosRouter
 129 }
 130
 131 // ---------------------------------------------------------------------------
 132
 133 function listVideoCategories (req: express.Request, res: express.Response) {
 134   res.json(VIDEO_CATEGORIES)
 135 }
 136
 137 function listVideoLicences (req: express.Request, res: express.Response) {
 138   res.json(VIDEO_LICENCES)
 139 }
 140
 141 function listVideoLanguages (req: express.Request, res: express.Response) {
 142   res.json(VIDEO_LANGUAGES)
 143 }
 144
 145 function listVideoPrivacies (req: express.Request, res: express.Response) {
 146   res.json(VIDEO_PRIVACIES)
 147 }
 148
 149 // Wrapper to video add that retry the function if there is a database error
 150 // We need this because we run the transaction in SERIALIZABLE isolation that can fail
 151 async function addVideoRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
 152   const options = {
 153     arguments: [ req, res, req.files['videofile'][0] ],
 154     errorMessage: 'Cannot insert the video with many retries.'
 155   }
 156
 157   const video = await retryTransactionWrapper(addVideo, options)
 158
 159   res.json({
 160     video: {
 161       id: video.id,
 162       uuid: video.uuid
 163     }
 164   }).end()
 165 }
 166
 167 async function addVideo (req: express.Request, res: express.Response, videoPhysicalFile: Express.Multer.File) {
 168   const videoInfo: VideoCreate = req.body
 169
 170   // Prepare data so we don't block the transaction
 171   const videoData = {
 172     name: videoInfo.name,
 173     remote: false,
 174     extname: extname(videoPhysicalFile.filename),
 175     category: videoInfo.category,
 176     licence: videoInfo.licence,
 177     language: videoInfo.language,
 178     commentsEnabled: videoInfo.commentsEnabled,
 179     nsfw: videoInfo.nsfw,
 180     description: videoInfo.description,
 181     privacy: videoInfo.privacy,
 182     duration: videoPhysicalFile['duration'], // duration was added by a previous middleware
 183     channelId: res.locals.videoChannel.id
 184   }
 185   const video = new VideoModel(videoData)
 186   video.url = getVideoActivityPubUrl(video)
 187
 188   const videoFileHeight = await getVideoFileHeight(videoPhysicalFile.path)
 189
 190   const videoFileData = {
 191     extname: extname(videoPhysicalFile.filename),
 192     resolution: videoFileHeight,
 193     size: videoPhysicalFile.size
 194   }
 195   const videoFile = new VideoFileModel(videoFileData)
 196   const videoDir = CONFIG.STORAGE.VIDEOS_DIR
 197   const destination = join(videoDir, video.getVideoFilename(videoFile))
 198   await renamePromise(videoPhysicalFile.path, destination)
 199
 200   // Process thumbnail or create it from the video
 201   const thumbnailField = req.files['thumbnailfile']
 202   if (thumbnailField) {
 203     const thumbnailPhysicalFile = thumbnailField[0]
 204     await processImage(thumbnailPhysicalFile, join(CONFIG.STORAGE.THUMBNAILS_DIR, video.getThumbnailName()), THUMBNAILS_SIZE)
 205   } else {
 206     await video.createThumbnail(videoFile)
 207   }
 208
 209   // Process preview or create it from the video
 210   const previewField = req.files['previewfile']
 211   if (previewField) {
 212     const previewPhysicalFile = previewField[0]
 213     await processImage(previewPhysicalFile, join(CONFIG.STORAGE.PREVIEWS_DIR, video.getPreviewName()), PREVIEWS_SIZE)
 214   } else {
 215     await video.createPreview(videoFile)
 216   }
 217
 218   await video.createTorrentAndSetInfoHash(videoFile)
 219
 220   const videoCreated = await sequelizeTypescript.transaction(async t => {
 221     const sequelizeOptions = { transaction: t }
 222
 223     const videoCreated = await video.save(sequelizeOptions)
 224     // Do not forget to add video channel information to the created video
 225     videoCreated.VideoChannel = res.locals.videoChannel
 226
 227     videoFile.videoId = video.id
 228     await videoFile.save(sequelizeOptions)
 229
 230     video.VideoFiles = [ videoFile ]
 231
 232     if (videoInfo.tags) {
 233       const tagInstances = await TagModel.findOrCreateTags(videoInfo.tags, t)
 234
 235       await video.$set('Tags', tagInstances, sequelizeOptions)
 236       video.Tags = tagInstances
 237     }
 238
 239     // Let transcoding job send the video to friends because the video file extension might change
 240     if (CONFIG.TRANSCODING.ENABLED === true) return videoCreated
 241     // Don't send video to remote servers, it is private
 242     if (video.privacy === VideoPrivacy.PRIVATE) return videoCreated
 243
 244     await sendCreateVideo(video, t)
 245     await shareVideoByServerAndChannel(video, t)
 246
 247     logger.info('Video with name %s and uuid %s created.', videoInfo.name, videoCreated.uuid)
 248
 249     return videoCreated
 250   })
 251
 252   if (CONFIG.TRANSCODING.ENABLED === true) {
 253     // Put uuid because we don't have id auto incremented for now
 254     const dataInput = {
 255       videoUUID: videoCreated.uuid
 256     }
 257
 258     await JobQueue.Instance.createJob({ type: 'video-file', payload: dataInput })
 259   }
 260
 261   return videoCreated
 262 }
 263
 264 async function updateVideoRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
 265   const options = {
 266     arguments: [ req, res ],
 267     errorMessage: 'Cannot update the video with many retries.'
 268   }
 269
 270   await retryTransactionWrapper(updateVideo, options)
 271
 272   return res.type('json').status(204).end()
 273 }
 274
 275 async function updateVideo (req: express.Request, res: express.Response) {
 276   const videoInstance: VideoModel = res.locals.video
 277   const videoFieldsSave = videoInstance.toJSON()
 278   const videoInfoToUpdate: VideoUpdate = req.body
 279   const wasPrivateVideo = videoInstance.privacy === VideoPrivacy.PRIVATE
 280
 281   // Process thumbnail or create it from the video
 282   if (req.files && req.files['thumbnailfile']) {
 283     const thumbnailPhysicalFile = req.files['thumbnailfile'][0]
 284     await processImage(thumbnailPhysicalFile, join(CONFIG.STORAGE.THUMBNAILS_DIR, videoInstance.getThumbnailName()), THUMBNAILS_SIZE)
 285   }
 286
 287   // Process preview or create it from the video
 288   if (req.files && req.files['previewfile']) {
 289     const previewPhysicalFile = req.files['previewfile'][0]
 290     await processImage(previewPhysicalFile, join(CONFIG.STORAGE.PREVIEWS_DIR, videoInstance.getPreviewName()), PREVIEWS_SIZE)
 291   }
 292
 293   try {
 294     await sequelizeTypescript.transaction(async t => {
 295       const sequelizeOptions = {
 296         transaction: t
 297       }
 298
 299       if (videoInfoToUpdate.name !== undefined) videoInstance.set('name', videoInfoToUpdate.name)
 300       if (videoInfoToUpdate.category !== undefined) videoInstance.set('category', videoInfoToUpdate.category)
 301       if (videoInfoToUpdate.licence !== undefined) videoInstance.set('licence', videoInfoToUpdate.licence)
 302       if (videoInfoToUpdate.language !== undefined) videoInstance.set('language', videoInfoToUpdate.language)
 303       if (videoInfoToUpdate.nsfw !== undefined) videoInstance.set('nsfw', videoInfoToUpdate.nsfw)
 304       if (videoInfoToUpdate.privacy !== undefined) videoInstance.set('privacy', parseInt(videoInfoToUpdate.privacy.toString(), 10))
 305       if (videoInfoToUpdate.description !== undefined) videoInstance.set('description', videoInfoToUpdate.description)
 306       if (videoInfoToUpdate.commentsEnabled !== undefined) videoInstance.set('commentsEnabled', videoInfoToUpdate.commentsEnabled)
 307
 308       const videoInstanceUpdated = await videoInstance.save(sequelizeOptions)
 309
 310       if (videoInfoToUpdate.tags) {
 311         const tagInstances = await TagModel.findOrCreateTags(videoInfoToUpdate.tags, t)
 312
 313         await videoInstance.$set('Tags', tagInstances, sequelizeOptions)
 314         videoInstance.Tags = tagInstances
 315       }
 316
 317       // Now we'll update the video's meta data to our friends
 318       if (wasPrivateVideo === false) {
 319         await sendUpdateVideo(videoInstanceUpdated, t)
 320       }
 321
 322       // Video is not private anymore, send a create action to remote servers
 323       if (wasPrivateVideo === true && videoInstanceUpdated.privacy !== VideoPrivacy.PRIVATE) {
 324         await sendCreateVideo(videoInstanceUpdated, t)
 325         await shareVideoByServerAndChannel(videoInstanceUpdated, t)
 326       }
 327     })
 328
 329     logger.info('Video with name %s and uuid %s updated.', videoInstance.name, videoInstance.uuid)
 330   } catch (err) {
 331     // Force fields we want to update
 332     // If the transaction is retried, sequelize will think the object has not changed
 333     // So it will skip the SQL request, even if the last one was ROLLBACKed!
 334     resetSequelizeInstance(videoInstance, videoFieldsSave)
 335
 336     throw err
 337   }
 338 }
 339
 340 function getVideo (req: express.Request, res: express.Response) {
 341   const videoInstance = res.locals.video
 342
 343   return res.json(videoInstance.toFormattedDetailsJSON())
 344 }
 345
 346 async function viewVideo (req: express.Request, res: express.Response) {
 347   const videoInstance = res.locals.video
 348
 349   await videoInstance.increment('views')
 350   const serverAccount = await getServerActor()
 351
 352   if (videoInstance.isOwned()) {
 353     await sendCreateViewToVideoFollowers(serverAccount, videoInstance, undefined)
 354   } else {
 355     await sendCreateViewToOrigin(serverAccount, videoInstance, undefined)
 356   }
 357
 358   return res.status(204).end()
 359 }
 360
 361 async function getVideoDescription (req: express.Request, res: express.Response) {
 362   const videoInstance = res.locals.video
 363   let description = ''
 364
 365   if (videoInstance.isOwned()) {
 366     description = videoInstance.description
 367   } else {
 368     description = await fetchRemoteVideoDescription(videoInstance)
 369   }
 370
 371   return res.json({ description })
 372 }
 373
 374 async function listVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
 375   const resultList = await VideoModel.listForApi(req.query.start, req.query.count, req.query.sort)
 376
 377   return res.json(getFormattedObjects(resultList.data, resultList.total))
 378 }
 379
 380 async function removeVideoRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
 381   const options = {
 382     arguments: [ req, res ],
 383     errorMessage: 'Cannot remove the video with many retries.'
 384   }
 385
 386   await retryTransactionWrapper(removeVideo, options)
 387
 388   return res.type('json').status(204).end()
 389 }
 390
 391 async function removeVideo (req: express.Request, res: express.Response) {
 392   const videoInstance: VideoModel = res.locals.video
 393
 394   await sequelizeTypescript.transaction(async t => {
 395     await videoInstance.destroy({ transaction: t })
 396   })
 397
 398   logger.info('Video with name %s and uuid %s deleted.', videoInstance.name, videoInstance.uuid)
 399 }
 400
 401 async function searchVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
 402   const resultList = await VideoModel.searchAndPopulateAccountAndServerAndTags(
 403     req.query.search,
 404     req.query.start,
 405     req.query.count,
 406     req.query.sort
 407   )
 408
 409   return res.json(getFormattedObjects(resultList.data, resultList.total))
 410 }