server/lib/job-queue/handlers/video-import.ts

   1 import { Job } from 'bull'
   2 import { move, remove, stat } from 'fs-extra'
   3 import { retryTransactionWrapper } from '@server/helpers/database-utils'
   4 import { YoutubeDLWrapper } from '@server/helpers/youtube-dl'
   5 import { isPostImportVideoAccepted } from '@server/lib/moderation'
   6 import { generateWebTorrentVideoFilename } from '@server/lib/paths'
   7 import { Hooks } from '@server/lib/plugins/hooks'
   8 import { ServerConfigManager } from '@server/lib/server-config-manager'
   9 import { isAbleToUploadVideo } from '@server/lib/user'
  10 import { addMoveToObjectStorageJob, addOptimizeOrMergeAudioJob } from '@server/lib/video'
  11 import { VideoPathManager } from '@server/lib/video-path-manager'
  12 import { buildNextVideoState } from '@server/lib/video-state'
  13 import { ThumbnailModel } from '@server/models/video/thumbnail'
  14 import { MVideoImportDefault, MVideoImportDefaultFiles, MVideoImportVideo } from '@server/types/models/video/video-import'
  15 import { getLowercaseExtension } from '@shared/core-utils'
  16 import { isAudioFile } from '@shared/extra-utils'
  17 import {
  18   ThumbnailType,
  19   VideoImportPayload,
  20   VideoImportState,
  21   VideoImportTorrentPayload,
  22   VideoImportTorrentPayloadType,
  23   VideoImportYoutubeDLPayload,
  24   VideoImportYoutubeDLPayloadType,
  25   VideoResolution,
  26   VideoState
  27 } from '@shared/models'
  28 import { ffprobePromise, getVideoStreamDuration, getVideoStreamFPS, getVideoStreamDimensionsInfo } from '../../../helpers/ffmpeg'
  29 import { logger } from '../../../helpers/logger'
  30 import { getSecureTorrentName } from '../../../helpers/utils'
  31 import { createTorrentAndSetInfoHash, downloadWebTorrentVideo } from '../../../helpers/webtorrent'
  32 import { JOB_TTL } from '../../../initializers/constants'
  33 import { sequelizeTypescript } from '../../../initializers/database'
  34 import { VideoModel } from '../../../models/video/video'
  35 import { VideoFileModel } from '../../../models/video/video-file'
  36 import { VideoImportModel } from '../../../models/video/video-import'
  37 import { MThumbnail } from '../../../types/models/video/thumbnail'
  38 import { federateVideoIfNeeded } from '../../activitypub/videos'
  39 import { Notifier } from '../../notifier'
  40 import { generateVideoMiniature } from '../../thumbnail'
  41
  42 async function processVideoImport (job: Job) {
  43   const payload = job.data as VideoImportPayload
  44
  45   const videoImport = await getVideoImportOrDie(payload)
  46   if (videoImport.state === VideoImportState.CANCELLED) {
  47     logger.info('Do not process import since it has been cancelled', { payload })
  48     return
  49   }
  50
  51   videoImport.state = VideoImportState.PROCESSING
  52   await videoImport.save()
  53
  54   if (payload.type === 'youtube-dl') return processYoutubeDLImport(job, videoImport, payload)
  55   if (payload.type === 'magnet-uri' || payload.type === 'torrent-file') return processTorrentImport(job, videoImport, payload)
  56 }
  57
  58 // ---------------------------------------------------------------------------
  59
  60 export {
  61   processVideoImport
  62 }
  63
  64 // ---------------------------------------------------------------------------
  65
  66 async function processTorrentImport (job: Job, videoImport: MVideoImportDefault, payload: VideoImportTorrentPayload) {
  67   logger.info('Processing torrent video import in job %d.', job.id)
  68
  69   const options = { type: payload.type, videoImportId: payload.videoImportId }
  70
  71   const target = {
  72     torrentName: videoImport.torrentName ? getSecureTorrentName(videoImport.torrentName) : undefined,
  73     uri: videoImport.magnetUri
  74   }
  75   return processFile(() => downloadWebTorrentVideo(target, JOB_TTL['video-import']), videoImport, options)
  76 }
  77
  78 async function processYoutubeDLImport (job: Job, videoImport: MVideoImportDefault, payload: VideoImportYoutubeDLPayload) {
  79   logger.info('Processing youtubeDL video import in job %d.', job.id)
  80
  81   const options = { type: payload.type, videoImportId: videoImport.id }
  82
  83   const youtubeDL = new YoutubeDLWrapper(videoImport.targetUrl, ServerConfigManager.Instance.getEnabledResolutions('vod'))
  84
  85   return processFile(
  86     () => youtubeDL.downloadVideo(payload.fileExt, JOB_TTL['video-import']),
  87     videoImport,
  88     options
  89   )
  90 }
  91
  92 async function getVideoImportOrDie (payload: VideoImportPayload) {
  93   const videoImport = await VideoImportModel.loadAndPopulateVideo(payload.videoImportId)
  94   if (!videoImport || !videoImport.Video) {
  95     throw new Error(`Cannot import video ${payload.videoImportId}: the video import or video linked to this import does not exist anymore.`)
  96   }
  97
  98   return videoImport
  99 }
 100
 101 type ProcessFileOptions = {
 102   type: VideoImportYoutubeDLPayloadType | VideoImportTorrentPayloadType
 103   videoImportId: number
 104 }
 105 async function processFile (downloader: () => Promise<string>, videoImport: MVideoImportDefault, options: ProcessFileOptions) {
 106   let tempVideoPath: string
 107   let videoFile: VideoFileModel
 108
 109   try {
 110     // Download video from youtubeDL
 111     tempVideoPath = await downloader()
 112
 113     // Get information about this video
 114     const stats = await stat(tempVideoPath)
 115     const isAble = await isAbleToUploadVideo(videoImport.User.id, stats.size)
 116     if (isAble === false) {
 117       throw new Error('The user video quota is exceeded with this video to import.')
 118     }
 119
 120     const probe = await ffprobePromise(tempVideoPath)
 121
 122     const { resolution } = await isAudioFile(tempVideoPath, probe)
 123       ? { resolution: VideoResolution.H_NOVIDEO }
 124       : await getVideoStreamDimensionsInfo(tempVideoPath)
 125
 126     const fps = await getVideoStreamFPS(tempVideoPath, probe)
 127     const duration = await getVideoStreamDuration(tempVideoPath, probe)
 128
 129     // Prepare video file object for creation in database
 130     const fileExt = getLowercaseExtension(tempVideoPath)
 131     const videoFileData = {
 132       extname: fileExt,
 133       resolution,
 134       size: stats.size,
 135       filename: generateWebTorrentVideoFilename(resolution, fileExt),
 136       fps,
 137       videoId: videoImport.videoId
 138     }
 139     videoFile = new VideoFileModel(videoFileData)
 140
 141     const hookName = options.type === 'youtube-dl'
 142       ? 'filter:api.video.post-import-url.accept.result'
 143       : 'filter:api.video.post-import-torrent.accept.result'
 144
 145     // Check we accept this video
 146     const acceptParameters = {
 147       videoImport,
 148       video: videoImport.Video,
 149       videoFilePath: tempVideoPath,
 150       videoFile,
 151       user: videoImport.User
 152     }
 153     const acceptedResult = await Hooks.wrapFun(isPostImportVideoAccepted, acceptParameters, hookName)
 154
 155     if (acceptedResult.accepted !== true) {
 156       logger.info('Refused imported video.', { acceptedResult, acceptParameters })
 157
 158       videoImport.state = VideoImportState.REJECTED
 159       await videoImport.save()
 160
 161       throw new Error(acceptedResult.errorMessage)
 162     }
 163
 164     // Video is accepted, resuming preparation
 165     const videoWithFiles = Object.assign(videoImport.Video, { VideoFiles: [ videoFile ], VideoStreamingPlaylists: [] })
 166     // To clean files if the import fails
 167     const videoImportWithFiles: MVideoImportDefaultFiles = Object.assign(videoImport, { Video: videoWithFiles })
 168
 169     // Move file
 170     const videoDestFile = VideoPathManager.Instance.getFSVideoFileOutputPath(videoImportWithFiles.Video, videoFile)
 171     await move(tempVideoPath, videoDestFile)
 172     tempVideoPath = null // This path is not used anymore
 173
 174     // Generate miniature if the import did not created it
 175     let thumbnailModel: MThumbnail
 176     let thumbnailSave: object
 177     if (!videoImportWithFiles.Video.getMiniature()) {
 178       thumbnailModel = await generateVideoMiniature({
 179         video: videoImportWithFiles.Video,
 180         videoFile,
 181         type: ThumbnailType.MINIATURE
 182       })
 183       thumbnailSave = thumbnailModel.toJSON()
 184     }
 185
 186     // Generate preview if the import did not created it
 187     let previewModel: MThumbnail
 188     let previewSave: object
 189     if (!videoImportWithFiles.Video.getPreview()) {
 190       previewModel = await generateVideoMiniature({
 191         video: videoImportWithFiles.Video,
 192         videoFile,
 193         type: ThumbnailType.PREVIEW
 194       })
 195       previewSave = previewModel.toJSON()
 196     }
 197
 198     // Create torrent
 199     await createTorrentAndSetInfoHash(videoImportWithFiles.Video, videoFile)
 200
 201     const videoFileSave = videoFile.toJSON()
 202
 203     const { videoImportUpdated, video } = await retryTransactionWrapper(() => {
 204       return sequelizeTypescript.transaction(async t => {
 205         const videoImportToUpdate = videoImportWithFiles as MVideoImportVideo
 206
 207         // Refresh video
 208         const video = await VideoModel.load(videoImportToUpdate.videoId, t)
 209         if (!video) throw new Error('Video linked to import ' + videoImportToUpdate.videoId + ' does not exist anymore.')
 210
 211         const videoFileCreated = await videoFile.save({ transaction: t })
 212
 213         // Update video DB object
 214         video.duration = duration
 215         video.state = buildNextVideoState(video.state)
 216         await video.save({ transaction: t })
 217
 218         if (thumbnailModel) await video.addAndSaveThumbnail(thumbnailModel, t)
 219         if (previewModel) await video.addAndSaveThumbnail(previewModel, t)
 220
 221         // Now we can federate the video (reload from database, we need more attributes)
 222         const videoForFederation = await VideoModel.loadFull(video.uuid, t)
 223         await federateVideoIfNeeded(videoForFederation, true, t)
 224
 225         // Update video import object
 226         videoImportToUpdate.state = VideoImportState.SUCCESS
 227         const videoImportUpdated = await videoImportToUpdate.save({ transaction: t }) as MVideoImportVideo
 228         videoImportUpdated.Video = video
 229
 230         videoImportToUpdate.Video = Object.assign(video, { VideoFiles: [ videoFileCreated ] })
 231
 232         logger.info('Video %s imported.', video.uuid)
 233
 234         return { videoImportUpdated, video: videoForFederation }
 235       }).catch(err => {
 236         // Reset fields
 237         if (thumbnailModel) thumbnailModel = new ThumbnailModel(thumbnailSave)
 238         if (previewModel) previewModel = new ThumbnailModel(previewSave)
 239
 240         videoFile = new VideoFileModel(videoFileSave)
 241
 242         throw err
 243       })
 244     })
 245
 246     Notifier.Instance.notifyOnFinishedVideoImport({ videoImport: videoImportUpdated, success: true })
 247
 248     if (video.isBlacklisted()) {
 249       const videoBlacklist = Object.assign(video.VideoBlacklist, { Video: video })
 250
 251       Notifier.Instance.notifyOnVideoAutoBlacklist(videoBlacklist)
 252     } else {
 253       Notifier.Instance.notifyOnNewVideoIfNeeded(video)
 254     }
 255
 256     if (video.state === VideoState.TO_MOVE_TO_EXTERNAL_STORAGE) {
 257       return addMoveToObjectStorageJob({ video: videoImportUpdated.Video, previousVideoState: VideoState.TO_IMPORT })
 258     }
 259
 260     // Create transcoding jobs?
 261     if (video.state === VideoState.TO_TRANSCODE) {
 262       await addOptimizeOrMergeAudioJob({ video: videoImportUpdated.Video, videoFile, user: videoImport.User })
 263     }
 264
 265   } catch (err) {
 266     try {
 267       if (tempVideoPath) await remove(tempVideoPath)
 268     } catch (errUnlink) {
 269       logger.warn('Cannot cleanup files after a video import error.', { err: errUnlink })
 270     }
 271
 272     videoImport.error = err.message
 273     if (videoImport.state !== VideoImportState.REJECTED) {
 274       videoImport.state = VideoImportState.FAILED
 275     }
 276     await videoImport.save()
 277
 278     Notifier.Instance.notifyOnFinishedVideoImport({ videoImport, success: false })
 279
 280     throw err
 281   }
 282 }