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