server/controllers/api/videos/captions.ts

   1 import * as express from 'express'
   2 import { asyncMiddleware, asyncRetryTransactionMiddleware, authenticate } from '../../../middlewares'
   3 import { addVideoCaptionValidator, deleteVideoCaptionValidator, listVideoCaptionsValidator } from '../../../middlewares/validators'
   4 import { createReqFiles } from '../../../helpers/express-utils'
   5 import { MIMETYPES } from '../../../initializers/constants'
   6 import { getFormattedObjects } from '../../../helpers/utils'
   7 import { VideoCaptionModel } from '../../../models/video/video-caption'
   8 import { logger } from '../../../helpers/logger'
   9 import { federateVideoIfNeeded } from '../../../lib/activitypub/videos'
  10 import { moveAndProcessCaptionFile } from '../../../helpers/captions-utils'
  11 import { CONFIG } from '../../../initializers/config'
  12 import { sequelizeTypescript } from '../../../initializers/database'
  13 import { MVideoCaptionVideo } from '@server/types/models'
  14 import { HttpStatusCode } from '../../../../shared/core-utils/miscs/http-error-codes'
  15
  16 const reqVideoCaptionAdd = createReqFiles(
  17   [ 'captionfile' ],
  18   MIMETYPES.VIDEO_CAPTIONS.MIMETYPE_EXT,
  19   {
  20     captionfile: CONFIG.STORAGE.CAPTIONS_DIR
  21   }
  22 )
  23
  24 const videoCaptionsRouter = express.Router()
  25
  26 videoCaptionsRouter.get('/:videoId/captions',
  27   asyncMiddleware(listVideoCaptionsValidator),
  28   asyncMiddleware(listVideoCaptions)
  29 )
  30 videoCaptionsRouter.put('/:videoId/captions/:captionLanguage',
  31   authenticate,
  32   reqVideoCaptionAdd,
  33   asyncMiddleware(addVideoCaptionValidator),
  34   asyncRetryTransactionMiddleware(addVideoCaption)
  35 )
  36 videoCaptionsRouter.delete('/:videoId/captions/:captionLanguage',
  37   authenticate,
  38   asyncMiddleware(deleteVideoCaptionValidator),
  39   asyncRetryTransactionMiddleware(deleteVideoCaption)
  40 )
  41
  42 // ---------------------------------------------------------------------------
  43
  44 export {
  45   videoCaptionsRouter
  46 }
  47
  48 // ---------------------------------------------------------------------------
  49
  50 async function listVideoCaptions (req: express.Request, res: express.Response) {
  51   const data = await VideoCaptionModel.listVideoCaptions(res.locals.videoId.id)
  52
  53   return res.json(getFormattedObjects(data, data.length))
  54 }
  55
  56 async function addVideoCaption (req: express.Request, res: express.Response) {
  57   const videoCaptionPhysicalFile = req.files['captionfile'][0]
  58   const video = res.locals.videoAll
  59
  60   const videoCaption = new VideoCaptionModel({
  61     videoId: video.id,
  62     language: req.params.captionLanguage
  63   }) as MVideoCaptionVideo
  64   videoCaption.Video = video
  65
  66   // Move physical file
  67   await moveAndProcessCaptionFile(videoCaptionPhysicalFile, videoCaption)
  68
  69   await sequelizeTypescript.transaction(async t => {
  70     await VideoCaptionModel.insertOrReplaceLanguage(video.id, req.params.captionLanguage, null, t)
  71
  72     // Update video update
  73     await federateVideoIfNeeded(video, false, t)
  74   })
  75
  76   return res.status(HttpStatusCode.NO_CONTENT_204).end()
  77 }
  78
  79 async function deleteVideoCaption (req: express.Request, res: express.Response) {
  80   const video = res.locals.videoAll
  81   const videoCaption = res.locals.videoCaption
  82
  83   await sequelizeTypescript.transaction(async t => {
  84     await videoCaption.destroy({ transaction: t })
  85
  86     // Send video update
  87     await federateVideoIfNeeded(video, false, t)
  88   })
  89
  90   logger.info('Video caption %s of video %s deleted.', videoCaption.language, video.uuid)
  91
  92   return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end()
  93 }