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   let videoData = buildLocalVideoFromReq(videoInfo, videoChannel.id)
 157   videoData = await Hooks.wrapObject(videoData, 'filter:api.video.upload.video-attribute.result')
 158
 159   videoData.state = buildNextVideoState()
 160   videoData.duration = videoPhysicalFile.duration // duration was added by a previous middleware
 161
 162   const video = new VideoModel(videoData) as MVideoFullLight
 163   video.VideoChannel = videoChannel
 164   video.url = getLocalVideoActivityPubUrl(video) // We use the UUID, so set the URL after building the object
 165
 166   const videoFile = await buildNewFile(videoPhysicalFile)
 167
 168   // Move physical file
 169   const destination = VideoPathManager.Instance.getFSVideoFileOutputPath(video, videoFile)
 170   await move(videoPhysicalFile.path, destination)
 171   // This is important in case if there is another attempt in the retry process
 172   videoPhysicalFile.filename = basename(destination)
 173   videoPhysicalFile.path = destination
 174
 175   const [ thumbnailModel, previewModel ] = await buildVideoThumbnailsFromReq({
 176     video,
 177     files,
 178     fallback: type => generateVideoMiniature({ video, videoFile, type })
 179   })
 180
 181   const { videoCreated } = await sequelizeTypescript.transaction(async t => {
 182     const sequelizeOptions = { transaction: t }
 183
 184     const videoCreated = await video.save(sequelizeOptions) as MVideoFullLight
 185
 186     await videoCreated.addAndSaveThumbnail(thumbnailModel, t)
 187     await videoCreated.addAndSaveThumbnail(previewModel, t)
 188
 189     // Do not forget to add video channel information to the created video
 190     videoCreated.VideoChannel = res.locals.videoChannel
 191
 192     videoFile.videoId = video.id
 193     await videoFile.save(sequelizeOptions)
 194
 195     video.VideoFiles = [ videoFile ]
 196
 197     await setVideoTags({ video, tags: videoInfo.tags, transaction: t })
 198
 199     // Schedule an update in the future?
 200     if (videoInfo.scheduleUpdate) {
 201       await ScheduleVideoUpdateModel.create({
 202         videoId: video.id,
 203         updateAt: new Date(videoInfo.scheduleUpdate.updateAt),
 204         privacy: videoInfo.scheduleUpdate.privacy || null
 205       }, sequelizeOptions)
 206     }
 207
 208     await autoBlacklistVideoIfNeeded({
 209       video,
 210       user,
 211       isRemote: false,
 212       isNew: true,
 213       transaction: t
 214     })
 215
 216     auditLogger.create(getAuditIdFromRes(res), new VideoAuditView(videoCreated.toFormattedDetailsJSON()))
 217     logger.info('Video with name %s and uuid %s created.', videoInfo.name, videoCreated.uuid, lTags(videoCreated.uuid))
 218
 219     return { videoCreated }
 220   })
 221
 222   // Channel has a new content, set as updated
 223   await videoCreated.VideoChannel.setAsUpdated()
 224
 225   createTorrentFederate(video, videoFile)
 226     .then(() => {
 227       if (video.state === VideoState.TO_MOVE_TO_EXTERNAL_STORAGE) {
 228         return addMoveToObjectStorageJob(video)
 229       }
 230
 231       if (video.state === VideoState.TO_TRANSCODE) {
 232         return addOptimizeOrMergeAudioJob(videoCreated, videoFile, user)
 233       }
 234     })
 235     .catch(err => logger.error('Cannot add optimize/merge audio job for %s.', videoCreated.uuid, { err, ...lTags(videoCreated.uuid) }))
 236
 237   Hooks.runAction('action:api.video.uploaded', { video: videoCreated, req, res })
 238
 239   return {
 240     video: {
 241       id: videoCreated.id,
 242       shortUUID: uuidToShort(videoCreated.uuid),
 243       uuid: videoCreated.uuid
 244     }
 245   }
 246 }
 247
 248 async function buildNewFile (videoPhysicalFile: express.VideoUploadFile) {
 249   const videoFile = new VideoFileModel({
 250     extname: getLowercaseExtension(videoPhysicalFile.filename),
 251     size: videoPhysicalFile.size,
 252     videoStreamingPlaylistId: null,
 253     metadata: await getMetadataFromFile(videoPhysicalFile.path)
 254   })
 255
 256   if (videoFile.isAudio()) {
 257     videoFile.resolution = DEFAULT_AUDIO_RESOLUTION
 258   } else {
 259     videoFile.fps = await getVideoFileFPS(videoPhysicalFile.path)
 260     videoFile.resolution = (await getVideoFileResolution(videoPhysicalFile.path)).resolution
 261   }
 262
 263   videoFile.filename = generateWebTorrentVideoFilename(videoFile.resolution, videoFile.extname)
 264
 265   return videoFile
 266 }
 267
 268 async function createTorrentAndSetInfoHashAsync (video: MVideo, fileArg: MVideoFile) {
 269   await createTorrentAndSetInfoHash(video, fileArg)
 270
 271   // Refresh videoFile because the createTorrentAndSetInfoHash could be long
 272   const refreshedFile = await VideoFileModel.loadWithVideo(fileArg.id)
 273   // File does not exist anymore, remove the generated torrent
 274   if (!refreshedFile) return fileArg.removeTorrent()
 275
 276   refreshedFile.infoHash = fileArg.infoHash
 277   refreshedFile.torrentFilename = fileArg.torrentFilename
 278
 279   return refreshedFile.save()
 280 }
 281
 282 function createTorrentFederate (video: MVideoFullLight, videoFile: MVideoFile) {
 283   // Create the torrent file in async way because it could be long
 284   return createTorrentAndSetInfoHashAsync(video, videoFile)
 285     .catch(err => logger.error('Cannot create torrent file for video %s', video.url, { err, ...lTags(video.uuid) }))
 286     .then(() => VideoModel.loadAndPopulateAccountAndServerAndTags(video.id))
 287     .then(refreshedVideo => {
 288       if (!refreshedVideo) return
 289
 290       // Only federate and notify after the torrent creation
 291       Notifier.Instance.notifyOnNewVideoIfNeeded(refreshedVideo)
 292
 293       return retryTransactionWrapper(() => {
 294         return sequelizeTypescript.transaction(t => federateVideoIfNeeded(refreshedVideo, true, t))
 295       })
 296     })
 297     .catch(err => logger.error('Cannot federate or notify video creation %s', video.url, { err, ...lTags(video.uuid) }))
 298 }
 299
 300 async function deleteUploadResumableCache (req: express.Request, res: express.Response, next: express.NextFunction) {
 301   await Redis.Instance.deleteUploadSession(req.query.upload_id)
 302
 303   return next()
 304 }