X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Fjob-queue%2Fhandlers%2Fvideo-import.ts;h=2a063282cf2aef546c587bc012ff2b75a17488fe;hb=0c9668f77901e7540e2c7045eb0f2974a4842a69;hp=09f225cec8311b6c06fd3608e1b3cfceb7aeb16d;hpb=4c1def5fd8e9f483238eb38e221f555e2e6bbf07;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/job-queue/handlers/video-import.ts b/server/lib/job-queue/handlers/video-import.ts index 09f225cec..2a063282c 100644 --- a/server/lib/job-queue/handlers/video-import.ts +++ b/server/lib/job-queue/handlers/video-import.ts @@ -1,49 +1,70 @@ -import * as Bull from 'bull' +import { Job } from 'bullmq' +import { move, remove, stat } from 'fs-extra' +import { retryTransactionWrapper } from '@server/helpers/database-utils' +import { YoutubeDLWrapper } from '@server/helpers/youtube-dl' +import { CONFIG } from '@server/initializers/config' +import { isPostImportVideoAccepted } from '@server/lib/moderation' +import { generateWebTorrentVideoFilename } from '@server/lib/paths' +import { Hooks } from '@server/lib/plugins/hooks' +import { ServerConfigManager } from '@server/lib/server-config-manager' +import { createOptimizeOrMergeAudioJobs } from '@server/lib/transcoding/create-transcoding-job' +import { isAbleToUploadVideo } from '@server/lib/user' +import { buildMoveToObjectStorageJob } from '@server/lib/video' +import { VideoPathManager } from '@server/lib/video-path-manager' +import { buildNextVideoState } from '@server/lib/video-state' +import { ThumbnailModel } from '@server/models/video/thumbnail' +import { MUserId, MVideoFile, MVideoFullLight } from '@server/types/models' +import { MVideoImport, MVideoImportDefault, MVideoImportDefaultFiles, MVideoImportVideo } from '@server/types/models/video/video-import' +import { getLowercaseExtension } from '@shared/core-utils' +import { ffprobePromise, getVideoStreamDimensionsInfo, getVideoStreamDuration, getVideoStreamFPS, isAudioFile } from '@shared/ffmpeg' +import { + ThumbnailType, + VideoImportPayload, + VideoImportPreventExceptionResult, + VideoImportState, + VideoImportTorrentPayload, + VideoImportTorrentPayloadType, + VideoImportYoutubeDLPayload, + VideoImportYoutubeDLPayloadType, + VideoResolution, + VideoState +} from '@shared/models' import { logger } from '../../../helpers/logger' -import { downloadYoutubeDLVideo } from '../../../helpers/youtube-dl' -import { VideoImportModel } from '../../../models/video/video-import' -import { VideoImportState } from '../../../../shared/models/videos' -import { getDurationFromVideoFile, getVideoFileFPS, getVideoFileResolution } from '../../../helpers/ffmpeg-utils' -import { extname } from 'path' -import { VideoFileModel } from '../../../models/video/video-file' -import { VIDEO_IMPORT_TIMEOUT } from '../../../initializers/constants' -import { VideoState } from '../../../../shared' -import { JobQueue } from '../index' -import { federateVideoIfNeeded } from '../../activitypub' -import { VideoModel } from '../../../models/video/video' -import { createTorrentAndSetInfoHash, downloadWebTorrentVideo } from '../../../helpers/webtorrent' import { getSecureTorrentName } from '../../../helpers/utils' -import { move, remove, stat } from 'fs-extra' -import { Notifier } from '../../notifier' -import { CONFIG } from '../../../initializers/config' +import { createTorrentAndSetInfoHash, downloadWebTorrentVideo } from '../../../helpers/webtorrent' +import { JOB_TTL } from '../../../initializers/constants' import { sequelizeTypescript } from '../../../initializers/database' -import { createVideoMiniatureFromUrl, generateVideoMiniature } from '../../thumbnail' -import { ThumbnailType } from '../../../../shared/models/videos/thumbnail.type' -import { MThumbnail } from '../../../typings/models/video/thumbnail' -import { MVideoImportDefault, MVideoImportDefaultFiles, MVideoImportVideo } from '@server/typings/models/video/video-import' -import { getVideoFilePath } from '@server/lib/video-paths' - -type VideoImportYoutubeDLPayload = { - type: 'youtube-dl' - videoImportId: number +import { VideoModel } from '../../../models/video/video' +import { VideoFileModel } from '../../../models/video/video-file' +import { VideoImportModel } from '../../../models/video/video-import' +import { federateVideoIfNeeded } from '../../activitypub/videos' +import { Notifier } from '../../notifier' +import { generateVideoMiniature } from '../../thumbnail' +import { JobQueue } from '../job-queue' - thumbnailUrl: string - downloadThumbnail: boolean - downloadPreview: boolean -} +async function processVideoImport (job: Job): Promise { + const payload = job.data as VideoImportPayload -type VideoImportTorrentPayload = { - type: 'magnet-uri' | 'torrent-file' - videoImportId: number -} + const videoImport = await getVideoImportOrDie(payload) + if (videoImport.state === VideoImportState.CANCELLED) { + logger.info('Do not process import since it has been cancelled', { payload }) + return { resultType: 'success' } + } -export type VideoImportPayload = VideoImportYoutubeDLPayload | VideoImportTorrentPayload + videoImport.state = VideoImportState.PROCESSING + await videoImport.save() -async function processVideoImport (job: Bull.Job) { - const payload = job.data as VideoImportPayload + try { + if (payload.type === 'youtube-dl') await processYoutubeDLImport(job, videoImport, payload) + if (payload.type === 'magnet-uri' || payload.type === 'torrent-file') await processTorrentImport(job, videoImport, payload) - if (payload.type === 'youtube-dl') return processYoutubeDLImport(job, payload) - if (payload.type === 'magnet-uri' || payload.type === 'torrent-file') return processTorrentImport(job, payload) + return { resultType: 'success' } + } catch (err) { + if (!payload.preventException) throw err + + logger.warn('Catch error in video import to send value to parent job.', { payload, err }) + return { resultType: 'error' } + } } // --------------------------------------------------------------------------- @@ -54,67 +75,51 @@ export { // --------------------------------------------------------------------------- -async function processTorrentImport (job: Bull.Job, payload: VideoImportTorrentPayload) { - logger.info('Processing torrent video import in job %d.', job.id) +async function processTorrentImport (job: Job, videoImport: MVideoImportDefault, payload: VideoImportTorrentPayload) { + logger.info('Processing torrent video import in job %s.', job.id) - const videoImport = await getVideoImportOrDie(payload.videoImportId) + const options = { type: payload.type, videoImportId: payload.videoImportId } - const options = { - videoImportId: payload.videoImportId, - - downloadThumbnail: false, - downloadPreview: false, - - generateThumbnail: true, - generatePreview: true - } const target = { torrentName: videoImport.torrentName ? getSecureTorrentName(videoImport.torrentName) : undefined, - magnetUri: videoImport.magnetUri + uri: videoImport.magnetUri } - return processFile(() => downloadWebTorrentVideo(target, VIDEO_IMPORT_TIMEOUT), videoImport, options) + return processFile(() => downloadWebTorrentVideo(target, JOB_TTL['video-import']), videoImport, options) } -async function processYoutubeDLImport (job: Bull.Job, payload: VideoImportYoutubeDLPayload) { - logger.info('Processing youtubeDL video import in job %d.', job.id) - - const videoImport = await getVideoImportOrDie(payload.videoImportId) - const options = { - videoImportId: videoImport.id, +async function processYoutubeDLImport (job: Job, videoImport: MVideoImportDefault, payload: VideoImportYoutubeDLPayload) { + logger.info('Processing youtubeDL video import in job %s.', job.id) - downloadThumbnail: payload.downloadThumbnail, - downloadPreview: payload.downloadPreview, - thumbnailUrl: payload.thumbnailUrl, + const options = { type: payload.type, videoImportId: videoImport.id } - generateThumbnail: false, - generatePreview: false - } + const youtubeDL = new YoutubeDLWrapper( + videoImport.targetUrl, + ServerConfigManager.Instance.getEnabledResolutions('vod'), + CONFIG.TRANSCODING.ALWAYS_TRANSCODE_ORIGINAL_RESOLUTION + ) - return processFile(() => downloadYoutubeDLVideo(videoImport.targetUrl, VIDEO_IMPORT_TIMEOUT), videoImport, options) + return processFile( + () => youtubeDL.downloadVideo(payload.fileExt, JOB_TTL['video-import']), + videoImport, + options + ) } -async function getVideoImportOrDie (videoImportId: number) { - const videoImport = await VideoImportModel.loadAndPopulateVideo(videoImportId) - if (!videoImport || !videoImport.Video) { - throw new Error('Cannot import video %s: the video import or video linked to this import does not exist anymore.') +async function getVideoImportOrDie (payload: VideoImportPayload) { + const videoImport = await VideoImportModel.loadAndPopulateVideo(payload.videoImportId) + if (!videoImport?.Video) { + throw new Error(`Cannot import video ${payload.videoImportId}: the video import or video linked to this import does not exist anymore.`) } return videoImport } type ProcessFileOptions = { + type: VideoImportYoutubeDLPayloadType | VideoImportTorrentPayloadType videoImportId: number - - downloadThumbnail: boolean - downloadPreview: boolean - thumbnailUrl?: string - - generateThumbnail: boolean - generatePreview: boolean } async function processFile (downloader: () => Promise, videoImport: MVideoImportDefault, options: ProcessFileOptions) { let tempVideoPath: string - let videoDestFile: string let videoFile: VideoFileModel try { @@ -123,120 +128,207 @@ async function processFile (downloader: () => Promise, videoImport: MVid // Get information about this video const stats = await stat(tempVideoPath) - const isAble = await videoImport.User.isAbleToUploadVideo({ size: stats.size }) + const isAble = await isAbleToUploadVideo(videoImport.User.id, stats.size) if (isAble === false) { throw new Error('The user video quota is exceeded with this video to import.') } - const { videoFileResolution } = await getVideoFileResolution(tempVideoPath) - const fps = await getVideoFileFPS(tempVideoPath) - const duration = await getDurationFromVideoFile(tempVideoPath) + const probe = await ffprobePromise(tempVideoPath) + + const { resolution } = await isAudioFile(tempVideoPath, probe) + ? { resolution: VideoResolution.H_NOVIDEO } + : await getVideoStreamDimensionsInfo(tempVideoPath, probe) + + const fps = await getVideoStreamFPS(tempVideoPath, probe) + const duration = await getVideoStreamDuration(tempVideoPath, probe) - // Create video file object in database + // Prepare video file object for creation in database + const fileExt = getLowercaseExtension(tempVideoPath) const videoFileData = { - extname: extname(tempVideoPath), - resolution: videoFileResolution, + extname: fileExt, + resolution, size: stats.size, + filename: generateWebTorrentVideoFilename(resolution, fileExt), fps, videoId: videoImport.videoId } videoFile = new VideoFileModel(videoFileData) - const videoWithFiles = Object.assign(videoImport.Video, { VideoFiles: [ videoFile ], VideoStreamingPlaylists: [] }) - // To clean files if the import fails - const videoImportWithFiles: MVideoImportDefaultFiles = Object.assign(videoImport, { Video: videoWithFiles }) - - // Move file - videoDestFile = getVideoFilePath(videoImportWithFiles.Video, videoFile) - await move(tempVideoPath, videoDestFile) - tempVideoPath = null // This path is not used anymore - - // Process thumbnail - let thumbnailModel: MThumbnail - if (options.downloadThumbnail && options.thumbnailUrl) { - thumbnailModel = await createVideoMiniatureFromUrl(options.thumbnailUrl, videoImportWithFiles.Video, ThumbnailType.MINIATURE) - } else if (options.generateThumbnail || options.downloadThumbnail) { - thumbnailModel = await generateVideoMiniature(videoImportWithFiles.Video, videoFile, ThumbnailType.MINIATURE) + const hookName = options.type === 'youtube-dl' + ? 'filter:api.video.post-import-url.accept.result' + : 'filter:api.video.post-import-torrent.accept.result' + + // Check we accept this video + const acceptParameters = { + videoImport, + video: videoImport.Video, + videoFilePath: tempVideoPath, + videoFile, + user: videoImport.User } + const acceptedResult = await Hooks.wrapFun(isPostImportVideoAccepted, acceptParameters, hookName) - // Process preview - let previewModel: MThumbnail - if (options.downloadPreview && options.thumbnailUrl) { - previewModel = await createVideoMiniatureFromUrl(options.thumbnailUrl, videoImportWithFiles.Video, ThumbnailType.PREVIEW) - } else if (options.generatePreview || options.downloadPreview) { - previewModel = await generateVideoMiniature(videoImportWithFiles.Video, videoFile, ThumbnailType.PREVIEW) + if (acceptedResult.accepted !== true) { + logger.info('Refused imported video.', { acceptedResult, acceptParameters }) + + videoImport.state = VideoImportState.REJECTED + await videoImport.save() + + throw new Error(acceptedResult.errorMessage) } - // Create torrent - await createTorrentAndSetInfoHash(videoImportWithFiles.Video, videoFile) + // Video is accepted, resuming preparation + const videoFileLockReleaser = await VideoPathManager.Instance.lockFiles(videoImport.Video.uuid) - const { videoImportUpdated, video } = await sequelizeTypescript.transaction(async t => { - const videoImportToUpdate = videoImportWithFiles as MVideoImportVideo + try { + const videoImportWithFiles = await refreshVideoImportFromDB(videoImport, videoFile) - // Refresh video - const video = await VideoModel.load(videoImportToUpdate.videoId, t) - if (!video) throw new Error('Video linked to import ' + videoImportToUpdate.videoId + ' does not exist anymore.') + // Move file + const videoDestFile = VideoPathManager.Instance.getFSVideoFileOutputPath(videoImportWithFiles.Video, videoFile) + await move(tempVideoPath, videoDestFile) - const videoFileCreated = await videoFile.save({ transaction: t }) - videoImportToUpdate.Video = Object.assign(video, { VideoFiles: [ videoFileCreated ] }) + tempVideoPath = null // This path is not used anymore - // Update video DB object - video.duration = duration - video.state = CONFIG.TRANSCODING.ENABLED ? VideoState.TO_TRANSCODE : VideoState.PUBLISHED - await video.save({ transaction: t }) + let { + miniatureModel: thumbnailModel, + miniatureJSONSave: thumbnailSave + } = await generateMiniature(videoImportWithFiles, videoFile, ThumbnailType.MINIATURE) - if (thumbnailModel) await video.addAndSaveThumbnail(thumbnailModel, t) - if (previewModel) await video.addAndSaveThumbnail(previewModel, t) + let { + miniatureModel: previewModel, + miniatureJSONSave: previewSave + } = await generateMiniature(videoImportWithFiles, videoFile, ThumbnailType.PREVIEW) - // Now we can federate the video (reload from database, we need more attributes) - const videoForFederation = await VideoModel.loadAndPopulateAccountAndServerAndTags(video.uuid, t) - await federateVideoIfNeeded(videoForFederation, true, t) + // Create torrent + await createTorrentAndSetInfoHash(videoImportWithFiles.Video, videoFile) - // Update video import object - videoImportToUpdate.state = VideoImportState.SUCCESS - const videoImportUpdated = await videoImportToUpdate.save({ transaction: t }) as MVideoImportVideo - videoImportUpdated.Video = video + const videoFileSave = videoFile.toJSON() - logger.info('Video %s imported.', video.uuid) + const { videoImportUpdated, video } = await retryTransactionWrapper(() => { + return sequelizeTypescript.transaction(async t => { + // Refresh video + const video = await VideoModel.load(videoImportWithFiles.videoId, t) + if (!video) throw new Error('Video linked to import ' + videoImportWithFiles.videoId + ' does not exist anymore.') - return { videoImportUpdated, video: videoForFederation } - }) + await videoFile.save({ transaction: t }) - Notifier.Instance.notifyOnFinishedVideoImport(videoImportUpdated, true) + // Update video DB object + video.duration = duration + video.state = buildNextVideoState(video.state) + await video.save({ transaction: t }) - if (video.isBlacklisted()) { - const videoBlacklist = Object.assign(video.VideoBlacklist, { Video: video }) + if (thumbnailModel) await video.addAndSaveThumbnail(thumbnailModel, t) + if (previewModel) await video.addAndSaveThumbnail(previewModel, t) - Notifier.Instance.notifyOnVideoAutoBlacklist(videoBlacklist) - } else { - Notifier.Instance.notifyOnNewVideoIfNeeded(video) - } + // Now we can federate the video (reload from database, we need more attributes) + const videoForFederation = await VideoModel.loadFull(video.uuid, t) + await federateVideoIfNeeded(videoForFederation, true, t) - // Create transcoding jobs? - if (video.state === VideoState.TO_TRANSCODE) { - // Put uuid because we don't have id auto incremented for now - const dataInput = { - type: 'optimize' as 'optimize', - videoUUID: videoImportUpdated.Video.uuid, - isNewVideo: true - } + // Update video import object + videoImportWithFiles.state = VideoImportState.SUCCESS + const videoImportUpdated = await videoImportWithFiles.save({ transaction: t }) as MVideoImport - await JobQueue.Instance.createJobWithPromise({ type: 'video-transcoding', payload: dataInput }) - } + logger.info('Video %s imported.', video.uuid) + + return { videoImportUpdated, video: videoForFederation } + }).catch(err => { + // Reset fields + if (thumbnailModel) thumbnailModel = new ThumbnailModel(thumbnailSave) + if (previewModel) previewModel = new ThumbnailModel(previewSave) + + videoFile = new VideoFileModel(videoFileSave) + throw err + }) + }) + + await afterImportSuccess({ videoImport: videoImportUpdated, video, videoFile, user: videoImport.User }) + } finally { + videoFileLockReleaser() + } } catch (err) { - try { - if (tempVideoPath) await remove(tempVideoPath) - } catch (errUnlink) { - logger.warn('Cannot cleanup files after a video import error.', { err: errUnlink }) + await onImportError(err, tempVideoPath, videoImport) + + throw err + } +} + +async function refreshVideoImportFromDB (videoImport: MVideoImportDefault, videoFile: MVideoFile): Promise { + // Refresh video, privacy may have changed + const video = await videoImport.Video.reload() + const videoWithFiles = Object.assign(video, { VideoFiles: [ videoFile ], VideoStreamingPlaylists: [] }) + + return Object.assign(videoImport, { Video: videoWithFiles }) +} + +async function generateMiniature (videoImportWithFiles: MVideoImportDefaultFiles, videoFile: MVideoFile, thumbnailType: ThumbnailType) { + // Generate miniature if the import did not created it + const needsMiniature = thumbnailType === ThumbnailType.MINIATURE + ? !videoImportWithFiles.Video.getMiniature() + : !videoImportWithFiles.Video.getPreview() + + if (!needsMiniature) { + return { + miniatureModel: null, + miniatureJSONSave: null } + } - videoImport.error = err.message - videoImport.state = VideoImportState.FAILED - await videoImport.save() + const miniatureModel = await generateVideoMiniature({ + video: videoImportWithFiles.Video, + videoFile, + type: thumbnailType + }) + const miniatureJSONSave = miniatureModel.toJSON() - Notifier.Instance.notifyOnFinishedVideoImport(videoImport, false) + return { + miniatureModel, + miniatureJSONSave + } +} - throw err +async function afterImportSuccess (options: { + videoImport: MVideoImport + video: MVideoFullLight + videoFile: MVideoFile + user: MUserId +}) { + const { video, videoFile, videoImport, user } = options + + Notifier.Instance.notifyOnFinishedVideoImport({ videoImport: Object.assign(videoImport, { Video: video }), success: true }) + + if (video.isBlacklisted()) { + const videoBlacklist = Object.assign(video.VideoBlacklist, { Video: video }) + + Notifier.Instance.notifyOnVideoAutoBlacklist(videoBlacklist) + } else { + Notifier.Instance.notifyOnNewVideoIfNeeded(video) + } + + if (video.state === VideoState.TO_MOVE_TO_EXTERNAL_STORAGE) { + await JobQueue.Instance.createJob( + await buildMoveToObjectStorageJob({ video, previousVideoState: VideoState.TO_IMPORT }) + ) + return + } + + if (video.state === VideoState.TO_TRANSCODE) { // Create transcoding jobs? + await createOptimizeOrMergeAudioJobs({ video, videoFile, isNewVideo: true, user }) } } + +async function onImportError (err: Error, tempVideoPath: string, videoImport: MVideoImportVideo) { + try { + if (tempVideoPath) await remove(tempVideoPath) + } catch (errUnlink) { + logger.warn('Cannot cleanup files after a video import error.', { err: errUnlink }) + } + + videoImport.error = err.message + if (videoImport.state !== VideoImportState.REJECTED) { + videoImport.state = VideoImportState.FAILED + } + await videoImport.save() + + Notifier.Instance.notifyOnFinishedVideoImport({ videoImport, success: false }) +}