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 { addMoveToObjectStorageJob, addOptimizeOrMergeAudioJob } 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'
43 async function processVideoImport (job: Job) {
44 const payload = job.data as VideoImportPayload
46 const videoImport = await getVideoImportOrDie(payload)
47 if (videoImport.state === VideoImportState.CANCELLED) {
48 logger.info('Do not process import since it has been cancelled', { payload })
52 videoImport.state = VideoImportState.PROCESSING
53 await videoImport.save()
55 if (payload.type === 'youtube-dl') return processYoutubeDLImport(job, videoImport, payload)
56 if (payload.type === 'magnet-uri' || payload.type === 'torrent-file') return processTorrentImport(job, videoImport, payload)
59 // ---------------------------------------------------------------------------
65 // ---------------------------------------------------------------------------
67 async function processTorrentImport (job: Job, videoImport: MVideoImportDefault, payload: VideoImportTorrentPayload) {
68 logger.info('Processing torrent video import in job %d.', job.id)
70 const options = { type: payload.type, videoImportId: payload.videoImportId }
73 torrentName: videoImport.torrentName ? getSecureTorrentName(videoImport.torrentName) : undefined,
74 uri: videoImport.magnetUri
76 return processFile(() => downloadWebTorrentVideo(target, JOB_TTL['video-import']), videoImport, options)
79 async function processYoutubeDLImport (job: Job, videoImport: MVideoImportDefault, payload: VideoImportYoutubeDLPayload) {
80 logger.info('Processing youtubeDL video import in job %d.', job.id)
82 const options = { type: payload.type, videoImportId: videoImport.id }
84 const youtubeDL = new YoutubeDLWrapper(
85 videoImport.targetUrl,
86 ServerConfigManager.Instance.getEnabledResolutions('vod'),
87 CONFIG.TRANSCODING.ALWAYS_TRANSCODE_ORIGINAL_RESOLUTION
91 () => youtubeDL.downloadVideo(payload.fileExt, JOB_TTL['video-import']),
97 async function getVideoImportOrDie (payload: VideoImportPayload) {
98 const videoImport = await VideoImportModel.loadAndPopulateVideo(payload.videoImportId)
99 if (!videoImport || !videoImport.Video) {
100 throw new Error(`Cannot import video ${payload.videoImportId}: the video import or video linked to this import does not exist anymore.`)
106 type ProcessFileOptions = {
107 type: VideoImportYoutubeDLPayloadType | VideoImportTorrentPayloadType
108 videoImportId: number
110 async function processFile (downloader: () => Promise<string>, videoImport: MVideoImportDefault, options: ProcessFileOptions) {
111 let tempVideoPath: string
112 let videoFile: VideoFileModel
115 // Download video from youtubeDL
116 tempVideoPath = await downloader()
118 // Get information about this video
119 const stats = await stat(tempVideoPath)
120 const isAble = await isAbleToUploadVideo(videoImport.User.id, stats.size)
121 if (isAble === false) {
122 throw new Error('The user video quota is exceeded with this video to import.')
125 const probe = await ffprobePromise(tempVideoPath)
127 const { resolution } = await isAudioFile(tempVideoPath, probe)
128 ? { resolution: VideoResolution.H_NOVIDEO }
129 : await getVideoStreamDimensionsInfo(tempVideoPath)
131 const fps = await getVideoStreamFPS(tempVideoPath, probe)
132 const duration = await getVideoStreamDuration(tempVideoPath, probe)
134 // Prepare video file object for creation in database
135 const fileExt = getLowercaseExtension(tempVideoPath)
136 const videoFileData = {
140 filename: generateWebTorrentVideoFilename(resolution, fileExt),
142 videoId: videoImport.videoId
144 videoFile = new VideoFileModel(videoFileData)
146 const hookName = options.type === 'youtube-dl'
147 ? 'filter:api.video.post-import-url.accept.result'
148 : 'filter:api.video.post-import-torrent.accept.result'
150 // Check we accept this video
151 const acceptParameters = {
153 video: videoImport.Video,
154 videoFilePath: tempVideoPath,
156 user: videoImport.User
158 const acceptedResult = await Hooks.wrapFun(isPostImportVideoAccepted, acceptParameters, hookName)
160 if (acceptedResult.accepted !== true) {
161 logger.info('Refused imported video.', { acceptedResult, acceptParameters })
163 videoImport.state = VideoImportState.REJECTED
164 await videoImport.save()
166 throw new Error(acceptedResult.errorMessage)
169 // Video is accepted, resuming preparation
170 const videoWithFiles = Object.assign(videoImport.Video, { VideoFiles: [ videoFile ], VideoStreamingPlaylists: [] })
171 // To clean files if the import fails
172 const videoImportWithFiles: MVideoImportDefaultFiles = Object.assign(videoImport, { Video: videoWithFiles })
175 const videoDestFile = VideoPathManager.Instance.getFSVideoFileOutputPath(videoImportWithFiles.Video, videoFile)
176 await move(tempVideoPath, videoDestFile)
177 tempVideoPath = null // This path is not used anymore
179 // Generate miniature if the import did not created it
180 let thumbnailModel: MThumbnail
181 let thumbnailSave: object
182 if (!videoImportWithFiles.Video.getMiniature()) {
183 thumbnailModel = await generateVideoMiniature({
184 video: videoImportWithFiles.Video,
186 type: ThumbnailType.MINIATURE
188 thumbnailSave = thumbnailModel.toJSON()
191 // Generate preview if the import did not created it
192 let previewModel: MThumbnail
193 let previewSave: object
194 if (!videoImportWithFiles.Video.getPreview()) {
195 previewModel = await generateVideoMiniature({
196 video: videoImportWithFiles.Video,
198 type: ThumbnailType.PREVIEW
200 previewSave = previewModel.toJSON()
204 await createTorrentAndSetInfoHash(videoImportWithFiles.Video, videoFile)
206 const videoFileSave = videoFile.toJSON()
208 const { videoImportUpdated, video } = await retryTransactionWrapper(() => {
209 return sequelizeTypescript.transaction(async t => {
210 const videoImportToUpdate = videoImportWithFiles as MVideoImportVideo
213 const video = await VideoModel.load(videoImportToUpdate.videoId, t)
214 if (!video) throw new Error('Video linked to import ' + videoImportToUpdate.videoId + ' does not exist anymore.')
216 const videoFileCreated = await videoFile.save({ transaction: t })
218 // Update video DB object
219 video.duration = duration
220 video.state = buildNextVideoState(video.state)
221 await video.save({ transaction: t })
223 if (thumbnailModel) await video.addAndSaveThumbnail(thumbnailModel, t)
224 if (previewModel) await video.addAndSaveThumbnail(previewModel, t)
226 // Now we can federate the video (reload from database, we need more attributes)
227 const videoForFederation = await VideoModel.loadFull(video.uuid, t)
228 await federateVideoIfNeeded(videoForFederation, true, t)
230 // Update video import object
231 videoImportToUpdate.state = VideoImportState.SUCCESS
232 const videoImportUpdated = await videoImportToUpdate.save({ transaction: t }) as MVideoImportVideo
233 videoImportUpdated.Video = video
235 videoImportToUpdate.Video = Object.assign(video, { VideoFiles: [ videoFileCreated ] })
237 logger.info('Video %s imported.', video.uuid)
239 return { videoImportUpdated, video: videoForFederation }
242 if (thumbnailModel) thumbnailModel = new ThumbnailModel(thumbnailSave)
243 if (previewModel) previewModel = new ThumbnailModel(previewSave)
245 videoFile = new VideoFileModel(videoFileSave)
251 Notifier.Instance.notifyOnFinishedVideoImport({ videoImport: videoImportUpdated, success: true })
253 if (video.isBlacklisted()) {
254 const videoBlacklist = Object.assign(video.VideoBlacklist, { Video: video })
256 Notifier.Instance.notifyOnVideoAutoBlacklist(videoBlacklist)
258 Notifier.Instance.notifyOnNewVideoIfNeeded(video)
261 if (video.state === VideoState.TO_MOVE_TO_EXTERNAL_STORAGE) {
262 return addMoveToObjectStorageJob({ video: videoImportUpdated.Video, previousVideoState: VideoState.TO_IMPORT })
265 // Create transcoding jobs?
266 if (video.state === VideoState.TO_TRANSCODE) {
267 await addOptimizeOrMergeAudioJob({ video: videoImportUpdated.Video, videoFile, user: videoImport.User })
272 if (tempVideoPath) await remove(tempVideoPath)
273 } catch (errUnlink) {
274 logger.warn('Cannot cleanup files after a video import error.', { err: errUnlink })
277 videoImport.error = err.message
278 if (videoImport.state !== VideoImportState.REJECTED) {
279 videoImport.state = VideoImportState.FAILED
281 await videoImport.save()
283 Notifier.Instance.notifyOnFinishedVideoImport({ videoImport, success: false })