server/controllers/api/videos/upload.ts

   1 import express from 'express'
   2 import { move } from 'fs-extra'
   3 import { basename } from 'path'
   4 import { getLowercaseExtension } from '@server/helpers/core-utils'
   5 import { getResumableUploadPath } from '@server/helpers/upload'
   6 import { uuidToShort } from '@server/helpers/uuid'
   7 import { createTorrentAndSetInfoHash } from '@server/helpers/webtorrent'
   8 import { getLocalVideoActivityPubUrl } from '@server/lib/activitypub/url'
   9 import { generateWebTorrentVideoFilename } from '@server/lib/paths'
  10 import { Redis } from '@server/lib/redis'
  11 import { uploadx } from '@server/lib/uploadx'
  12 import {
  13   addMoveToObjectStorageJob,
  14   addOptimizeOrMergeAudioJob,
  15   buildLocalVideoFromReq,
  16   buildVideoThumbnailsFromReq,
  17   setVideoTags
  18 } from '@server/lib/video'
  19 import { VideoPathManager } from '@server/lib/video-path-manager'
  20 import { buildNextVideoState } from '@server/lib/video-state'
  21 import { openapiOperationDoc } from '@server/middlewares/doc'
  22 import { MVideo, MVideoFile, MVideoFullLight } from '@server/types/models'
  23 import { VideoCreate, VideoState } from '../../../../shared'
  24 import { HttpStatusCode } from '../../../../shared/models'
  25 import { auditLoggerFactory, getAuditIdFromRes, VideoAuditView } from '../../../helpers/audit-logger'
  26 import { retryTransactionWrapper } from '../../../helpers/database-utils'
  27 import { createReqFiles } from '../../../helpers/express-utils'
  28 import { getMetadataFromFile, getVideoFileFPS, getVideoFileResolution } from '../../../helpers/ffprobe-utils'
  29 import { logger, loggerTagsFactory } from '../../../helpers/logger'
  30 import { CONFIG } from '../../../initializers/config'
  31 import { DEFAULT_AUDIO_RESOLUTION, MIMETYPES } from '../../../initializers/constants'
  32 import { sequelizeTypescript } from '../../../initializers/database'
  33 import { federateVideoIfNeeded } from '../../../lib/activitypub/videos'
  34 import { Notifier } from '../../../lib/notifier'
  35 import { Hooks } from '../../../lib/plugins/hooks'
  36 import { generateVideoMiniature } from '../../../lib/thumbnail'
  37 import { autoBlacklistVideoIfNeeded } from '../../../lib/video-blacklist'
  38 import {
  39   asyncMiddleware,
  40   asyncRetryTransactionMiddleware,
  41   authenticate,
  42   videosAddLegacyValidator,
  43   videosAddResumableInitValidator,
  44   videosAddResumableValidator,
  45   videosResumableUploadIdValidator
  46 } from '../../../middlewares'
  47 import { ScheduleVideoUpdateModel } from '../../../models/video/schedule-video-update'
  48 import { VideoModel } from '../../../models/video/video'
  49 import { VideoFileModel } from '../../../models/video/video-file'
  50
  51 const lTags = loggerTagsFactory('api', 'video')
  52 const auditLogger = auditLoggerFactory('videos')
  53 const uploadRouter = express.Router()
  54
  55 const reqVideoFileAdd = createReqFiles(
  56   [ 'videofile', 'thumbnailfile', 'previewfile' ],
  57   Object.assign({}, MIMETYPES.VIDEO.MIMETYPE_EXT, MIMETYPES.IMAGE.MIMETYPE_EXT),
  58   {
  59     videofile: CONFIG.STORAGE.TMP_DIR,
  60     thumbnailfile: CONFIG.STORAGE.TMP_DIR,
  61     previewfile: CONFIG.STORAGE.TMP_DIR
  62   }
  63 )
  64
  65 const reqVideoFileAddResumable = createReqFiles(
  66   [ 'thumbnailfile', 'previewfile' ],
  67   MIMETYPES.IMAGE.MIMETYPE_EXT,
  68   {
  69     thumbnailfile: getResumableUploadPath(),
  70     previewfile: getResumableUploadPath()
  71   }
  72 )
  73
  74 uploadRouter.post('/upload',
  75   openapiOperationDoc({ operationId: 'uploadLegacy' }),
  76   authenticate,
  77   reqVideoFileAdd,
  78   asyncMiddleware(videosAddLegacyValidator),
  79   asyncRetryTransactionMiddleware(addVideoLegacy)
  80 )
  81
  82 uploadRouter.post('/upload-resumable',
  83   openapiOperationDoc({ operationId: 'uploadResumableInit' }),
  84   authenticate,
  85   reqVideoFileAddResumable,
  86   asyncMiddleware(videosAddResumableInitValidator),
  87   uploadx.upload
  88 )
  89
  90 uploadRouter.delete('/upload-resumable',
  91   authenticate,
  92   videosResumableUploadIdValidator,
  93   asyncMiddleware(deleteUploadResumableCache),
  94   uploadx.upload
  95 )
  96
  97 uploadRouter.put('/upload-resumable',
  98   openapiOperationDoc({ operationId: 'uploadResumable' }),
  99   authenticate,
 100   videosResumableUploadIdValidator,
 101   uploadx.upload, // uploadx doesn't next() before the file upload completes
 102   asyncMiddleware(videosAddResumableValidator),
 103   asyncMiddleware(addVideoResumable)
 104 )
 105
 106 // ---------------------------------------------------------------------------
 107
 108 export {
 109   uploadRouter
 110 }
 111
 112 // ---------------------------------------------------------------------------
 113
 114 async function addVideoLegacy (req: express.Request, res: express.Response) {
 115   // Uploading the video could be long
 116   // Set timeout to 10 minutes, as Express's default is 2 minutes
 117   req.setTimeout(1000 * 60 * 10, () => {
 118     logger.error('Video upload has timed out.')
 119     return res.fail({
 120       status: HttpStatusCode.REQUEST_TIMEOUT_408,
 121       message: 'Video upload has timed out.'
 122     })
 123   })
 124
 125   const videoPhysicalFile = req.files['videofile'][0]
 126   const videoInfo: VideoCreate = req.body
 127   const files = req.files
 128
 129   const response = await addVideo({ req, res, videoPhysicalFile, videoInfo, files })
 130
 131   return res.json(response)
 132 }
 133
 134 async function addVideoResumable (req: express.Request, res: express.Response) {
 135   const videoPhysicalFile = res.locals.videoFileResumable
 136   const videoInfo = videoPhysicalFile.metadata
 137   const files = { previewfile: videoInfo.previewfile }
 138
 139   const response = await addVideo({ req, res, videoPhysicalFile, videoInfo, files })
 140   await Redis.Instance.setUploadSession(req.query.upload_id, response)
 141
 142   return res.json(response)
 143 }
 144
 145 async function addVideo (options: {
 146   req: express.Request
 147   res: express.Response
 148   videoPhysicalFile: express.VideoUploadFile
 149   videoInfo: VideoCreate
 150   files: express.UploadFiles
 151 }) {
 152   const { req, res, videoPhysicalFile, videoInfo, files } = options
 153   const videoChannel = res.locals.videoChannel
 154   const user = res.locals.oauth.token.User
 155
 156   const videoData = buildLocalVideoFromReq(videoInfo, videoChannel.id)
 157
 158   videoData.state = buildNextVideoState()
 159   videoData.duration = videoPhysicalFile.duration // duration was added by a previous middleware
 160
 161   const video = new VideoModel(videoData) as MVideoFullLight
 162   video.VideoChannel = videoChannel
 163   video.url = getLocalVideoActivityPubUrl(video) // We use the UUID, so set the URL after building the object
 164
 165   const videoFile = await buildNewFile(videoPhysicalFile)
 166
 167   // Move physical file
 168   const destination = VideoPathManager.Instance.getFSVideoFileOutputPath(video, videoFile)
 169   await move(videoPhysicalFile.path, destination)
 170   // This is important in case if there is another attempt in the retry process
 171   videoPhysicalFile.filename = basename(destination)
 172   videoPhysicalFile.path = destination
 173
 174   const [ thumbnailModel, previewModel ] = await buildVideoThumbnailsFromReq({
 175     video,
 176     files,
 177     fallback: type => generateVideoMiniature({ video, videoFile, type })
 178   })
 179
 180   const { videoCreated } = await sequelizeTypescript.transaction(async t => {
 181     const sequelizeOptions = { transaction: t }
 182
 183     const videoCreated = await video.save(sequelizeOptions) as MVideoFullLight
 184
 185     await videoCreated.addAndSaveThumbnail(thumbnailModel, t)
 186     await videoCreated.addAndSaveThumbnail(previewModel, t)
 187
 188     // Do not forget to add video channel information to the created video
 189     videoCreated.VideoChannel = res.locals.videoChannel
 190
 191     videoFile.videoId = video.id
 192     await videoFile.save(sequelizeOptions)
 193
 194     video.VideoFiles = [ videoFile ]
 195
 196     await setVideoTags({ video, tags: videoInfo.tags, transaction: t })
 197
 198     // Schedule an update in the future?
 199     if (videoInfo.scheduleUpdate) {
 200       await ScheduleVideoUpdateModel.create({
 201         videoId: video.id,
 202         updateAt: new Date(videoInfo.scheduleUpdate.updateAt),
 203         privacy: videoInfo.scheduleUpdate.privacy || null
 204       }, sequelizeOptions)
 205     }
 206
 207     await autoBlacklistVideoIfNeeded({
 208       video,
 209       user,
 210       isRemote: false,
 211       isNew: true,
 212       transaction: t
 213     })
 214
 215     auditLogger.create(getAuditIdFromRes(res), new VideoAuditView(videoCreated.toFormattedDetailsJSON()))
 216     logger.info('Video with name %s and uuid %s created.', videoInfo.name, videoCreated.uuid, lTags(videoCreated.uuid))
 217
 218     return { videoCreated }
 219   })
 220
 221   // Channel has a new content, set as updated
 222   await videoCreated.VideoChannel.setAsUpdated()
 223
 224   createTorrentFederate(video, videoFile)
 225     .then(() => {
 226       if (video.state === VideoState.TO_MOVE_TO_EXTERNAL_STORAGE) {
 227         return addMoveToObjectStorageJob(video)
 228       }
 229
 230       if (video.state === VideoState.TO_TRANSCODE) {
 231         return addOptimizeOrMergeAudioJob(videoCreated, videoFile, user)
 232       }
 233     })
 234     .catch(err => logger.error('Cannot add optimize/merge audio job for %s.', videoCreated.uuid, { err, ...lTags(videoCreated.uuid) }))
 235
 236   Hooks.runAction('action:api.video.uploaded', { video: videoCreated, req, res })
 237
 238   return {
 239     video: {
 240       id: videoCreated.id,
 241       shortUUID: uuidToShort(videoCreated.uuid),
 242       uuid: videoCreated.uuid
 243     }
 244   }
 245 }
 246
 247 async function buildNewFile (videoPhysicalFile: express.VideoUploadFile) {
 248   const videoFile = new VideoFileModel({
 249     extname: getLowercaseExtension(videoPhysicalFile.filename),
 250     size: videoPhysicalFile.size,
 251     videoStreamingPlaylistId: null,
 252     metadata: await getMetadataFromFile(videoPhysicalFile.path)
 253   })
 254
 255   if (videoFile.isAudio()) {
 256     videoFile.resolution = DEFAULT_AUDIO_RESOLUTION
 257   } else {
 258     videoFile.fps = await getVideoFileFPS(videoPhysicalFile.path)
 259     videoFile.resolution = (await getVideoFileResolution(videoPhysicalFile.path)).resolution
 260   }
 261
 262   videoFile.filename = generateWebTorrentVideoFilename(videoFile.resolution, videoFile.extname)
 263
 264   return videoFile
 265 }
 266
 267 async function createTorrentAndSetInfoHashAsync (video: MVideo, fileArg: MVideoFile) {
 268   await createTorrentAndSetInfoHash(video, fileArg)
 269
 270   // Refresh videoFile because the createTorrentAndSetInfoHash could be long
 271   const refreshedFile = await VideoFileModel.loadWithVideo(fileArg.id)
 272   // File does not exist anymore, remove the generated torrent
 273   if (!refreshedFile) return fileArg.removeTorrent()
 274
 275   refreshedFile.infoHash = fileArg.infoHash
 276   refreshedFile.torrentFilename = fileArg.torrentFilename
 277
 278   return refreshedFile.save()
 279 }
 280
 281 function createTorrentFederate (video: MVideoFullLight, videoFile: MVideoFile) {
 282   // Create the torrent file in async way because it could be long
 283   return createTorrentAndSetInfoHashAsync(video, videoFile)
 284     .catch(err => logger.error('Cannot create torrent file for video %s', video.url, { err, ...lTags(video.uuid) }))
 285     .then(() => VideoModel.loadAndPopulateAccountAndServerAndTags(video.id))
 286     .then(refreshedVideo => {
 287       if (!refreshedVideo) return
 288
 289       // Only federate and notify after the torrent creation
 290       Notifier.Instance.notifyOnNewVideoIfNeeded(refreshedVideo)
 291
 292       return retryTransactionWrapper(() => {
 293         return sequelizeTypescript.transaction(t => federateVideoIfNeeded(refreshedVideo, true, t))
 294       })
 295     })
 296     .catch(err => logger.error('Cannot federate or notify video creation %s', video.url, { err, ...lTags(video.uuid) }))
 297 }
 298
 299 async function deleteUploadResumableCache (req: express.Request, res: express.Response, next: express.NextFunction) {
 300   await Redis.Instance.deleteUploadSession(req.query.upload_id)
 301
 302   return next()
 303 }