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

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