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'
22 VideoImportTorrentPayload,
23 VideoImportTorrentPayloadType,
24 VideoImportYoutubeDLPayload,
25 VideoImportYoutubeDLPayloadType,
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'
44 async function processVideoImport (job: Job) {
45 const payload = job.data as VideoImportPayload
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 })
53 videoImport.state = VideoImportState.PROCESSING
54 await videoImport.save()
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)
60 // ---------------------------------------------------------------------------
66 // ---------------------------------------------------------------------------
68 async function processTorrentImport (job: Job, videoImport: MVideoImportDefault, payload: VideoImportTorrentPayload) {
69 logger.info('Processing torrent video import in job %s.', job.id)
71 const options = { type: payload.type, videoImportId: payload.videoImportId }
74 torrentName: videoImport.torrentName ? getSecureTorrentName(videoImport.torrentName) : undefined,
75 uri: videoImport.magnetUri
77 return processFile(() => downloadWebTorrentVideo(target, JOB_TTL['video-import']), videoImport, options)
80 async function processYoutubeDLImport (job: Job, videoImport: MVideoImportDefault, payload: VideoImportYoutubeDLPayload) {
81 logger.info('Processing youtubeDL video import in job %s.', job.id)
83 const options = { type: payload.type, videoImportId: videoImport.id }
85 const youtubeDL = new YoutubeDLWrapper(
86 videoImport.targetUrl,
87 ServerConfigManager.Instance.getEnabledResolutions('vod'),
88 CONFIG.TRANSCODING.ALWAYS_TRANSCODE_ORIGINAL_RESOLUTION
92 () => youtubeDL.downloadVideo(payload.fileExt, JOB_TTL['video-import']),
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.`)
107 type ProcessFileOptions = {
108 type: VideoImportYoutubeDLPayloadType | VideoImportTorrentPayloadType
109 videoImportId: number
111 async function processFile (downloader: () => Promise<string>, videoImport: MVideoImportDefault, options: ProcessFileOptions) {
112 let tempVideoPath: string
113 let videoFile: VideoFileModel
116 // Download video from youtubeDL
117 tempVideoPath = await downloader()
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.')
126 const probe = await ffprobePromise(tempVideoPath)
128 const { resolution } = await isAudioFile(tempVideoPath, probe)
129 ? { resolution: VideoResolution.H_NOVIDEO }
130 : await getVideoStreamDimensionsInfo(tempVideoPath)
132 const fps = await getVideoStreamFPS(tempVideoPath, probe)
133 const duration = await getVideoStreamDuration(tempVideoPath, probe)
135 // Prepare video file object for creation in database
136 const fileExt = getLowercaseExtension(tempVideoPath)
137 const videoFileData = {
141 filename: generateWebTorrentVideoFilename(resolution, fileExt),
143 videoId: videoImport.videoId
145 videoFile = new VideoFileModel(videoFileData)
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'
151 // Check we accept this video
152 const acceptParameters = {
154 video: videoImport.Video,
155 videoFilePath: tempVideoPath,
157 user: videoImport.User
159 const acceptedResult = await Hooks.wrapFun(isPostImportVideoAccepted, acceptParameters, hookName)
161 if (acceptedResult.accepted !== true) {
162 logger.info('Refused imported video.', { acceptedResult, acceptParameters })
164 videoImport.state = VideoImportState.REJECTED
165 await videoImport.save()
167 throw new Error(acceptedResult.errorMessage)
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 })
176 const videoDestFile = VideoPathManager.Instance.getFSVideoFileOutputPath(videoImportWithFiles.Video, videoFile)
177 await move(tempVideoPath, videoDestFile)
178 tempVideoPath = null // This path is not used anymore
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,
187 type: ThumbnailType.MINIATURE
189 thumbnailSave = thumbnailModel.toJSON()
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,
199 type: ThumbnailType.PREVIEW
201 previewSave = previewModel.toJSON()
205 await createTorrentAndSetInfoHash(videoImportWithFiles.Video, videoFile)
207 const videoFileSave = videoFile.toJSON()
209 const { videoImportUpdated, video } = await retryTransactionWrapper(() => {
210 return sequelizeTypescript.transaction(async t => {
211 const videoImportToUpdate = videoImportWithFiles as MVideoImportVideo
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.')
217 const videoFileCreated = await videoFile.save({ transaction: t })
219 // Update video DB object
220 video.duration = duration
221 video.state = buildNextVideoState(video.state)
222 await video.save({ transaction: t })
224 if (thumbnailModel) await video.addAndSaveThumbnail(thumbnailModel, t)
225 if (previewModel) await video.addAndSaveThumbnail(previewModel, t)
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)
231 // Update video import object
232 videoImportToUpdate.state = VideoImportState.SUCCESS
233 const videoImportUpdated = await videoImportToUpdate.save({ transaction: t }) as MVideoImportVideo
234 videoImportUpdated.Video = video
236 videoImportToUpdate.Video = Object.assign(video, { VideoFiles: [ videoFileCreated ] })
238 logger.info('Video %s imported.', video.uuid)
240 return { videoImportUpdated, video: videoForFederation }
243 if (thumbnailModel) thumbnailModel = new ThumbnailModel(thumbnailSave)
244 if (previewModel) previewModel = new ThumbnailModel(previewSave)
246 videoFile = new VideoFileModel(videoFileSave)
252 Notifier.Instance.notifyOnFinishedVideoImport({ videoImport: videoImportUpdated, success: true })
254 if (video.isBlacklisted()) {
255 const videoBlacklist = Object.assign(video.VideoBlacklist, { Video: video })
257 Notifier.Instance.notifyOnVideoAutoBlacklist(videoBlacklist)
259 Notifier.Instance.notifyOnNewVideoIfNeeded(video)
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 })
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 })
277 if (tempVideoPath) await remove(tempVideoPath)
278 } catch (errUnlink) {
279 logger.warn('Cannot cleanup files after a video import error.', { err: errUnlink })
282 videoImport.error = err.message
283 if (videoImport.state !== VideoImportState.REJECTED) {
284 videoImport.state = VideoImportState.FAILED
286 await videoImport.save()
288 Notifier.Instance.notifyOnFinishedVideoImport({ videoImport, success: false })