X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fcontrollers%2Fapi%2Fvideos%2Fimport.ts;h=7576e77e73808bc052ea82811dfecbabfee18937;hb=ba2684ceddf9b76312635b9cddc6bf6975ce436a;hp=82e084c546b68b05e186c63c90c1e45984cac17c;hpb=b49f22d8f9a52ab75fd38db2d377249eb58fa678;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/controllers/api/videos/import.ts b/server/controllers/api/videos/import.ts index 82e084c54..7576e77e7 100644 --- a/server/controllers/api/videos/import.ts +++ b/server/controllers/api/videos/import.ts @@ -1,38 +1,57 @@ -import * as express from 'express' -import { move, readFile } from 'fs-extra' -import * as magnetUtil from 'magnet-uri' -import * as parseTorrent from 'parse-torrent' +import express from 'express' +import { move, readFile, remove } from 'fs-extra' +import { decode } from 'magnet-uri' +import parseTorrent, { Instance } from 'parse-torrent' import { join } from 'path' +import { isVTTFileValid } from '@server/helpers/custom-validators/video-captions' +import { isVideoFileExtnameValid } from '@server/helpers/custom-validators/videos' +import { isResolvingToUnicastOnly } from '@server/helpers/dns' +import { Hooks } from '@server/lib/plugins/hooks' +import { ServerConfigManager } from '@server/lib/server-config-manager' import { setVideoTags } from '@server/lib/video' +import { FilteredModelAttributes } from '@server/types' import { MChannelAccountDefault, MThumbnail, MUser, MVideoAccountDefault, - MVideoCaptionVideo, + MVideoCaption, MVideoTag, - MVideoThumbnailAccountDefault, + MVideoThumbnail, MVideoWithBlacklistLight } from '@server/types/models' -import { MVideoImport, MVideoImportFormattable } from '@server/types/models/video/video-import' -import { VideoImportCreate, VideoImportState, VideoPrivacy, VideoState } from '../../../../shared' -import { HttpStatusCode } from '../../../../shared/core-utils/miscs/http-error-codes' -import { ThumbnailType } from '../../../../shared/models/videos/thumbnail.type' +import { MVideoImportFormattable } from '@server/types/models/video/video-import' +import { + HttpStatusCode, + ServerErrorCode, + ThumbnailType, + VideoImportCreate, + VideoImportState, + VideoPrivacy, + VideoState +} from '@shared/models' import { auditLoggerFactory, getAuditIdFromRes, VideoImportAuditView } from '../../../helpers/audit-logger' import { moveAndProcessCaptionFile } from '../../../helpers/captions-utils' import { isArray } from '../../../helpers/custom-validators/misc' -import { createReqFiles } from '../../../helpers/express-utils' +import { cleanUpReqFiles, createReqFiles } from '../../../helpers/express-utils' import { logger } from '../../../helpers/logger' import { getSecureTorrentName } from '../../../helpers/utils' -import { getYoutubeDLInfo, getYoutubeDLSubs, YoutubeDLInfo } from '../../../helpers/youtube-dl' +import { YoutubeDLInfo, YoutubeDLWrapper } from '../../../helpers/youtube-dl' import { CONFIG } from '../../../initializers/config' import { MIMETYPES } from '../../../initializers/constants' import { sequelizeTypescript } from '../../../initializers/database' import { getLocalVideoActivityPubUrl } from '../../../lib/activitypub/url' import { JobQueue } from '../../../lib/job-queue/job-queue' -import { createVideoMiniatureFromExisting, createVideoMiniatureFromUrl } from '../../../lib/thumbnail' +import { updateVideoMiniatureFromExisting, updateVideoMiniatureFromUrl } from '../../../lib/thumbnail' import { autoBlacklistVideoIfNeeded } from '../../../lib/video-blacklist' -import { asyncMiddleware, asyncRetryTransactionMiddleware, authenticate, videoImportAddValidator } from '../../../middlewares' +import { + asyncMiddleware, + asyncRetryTransactionMiddleware, + authenticate, + videoImportAddValidator, + videoImportCancelValidator, + videoImportDeleteValidator +} from '../../../middlewares' import { VideoModel } from '../../../models/video/video' import { VideoCaptionModel } from '../../../models/video/video-caption' import { VideoImportModel } from '../../../models/video/video-import' @@ -42,12 +61,7 @@ const videoImportsRouter = express.Router() const reqVideoFileImport = createReqFiles( [ 'thumbnailfile', 'previewfile', 'torrentfile' ], - Object.assign({}, MIMETYPES.TORRENT.MIMETYPE_EXT, MIMETYPES.IMAGE.MIMETYPE_EXT), - { - thumbnailfile: CONFIG.STORAGE.TMP_DIR, - previewfile: CONFIG.STORAGE.TMP_DIR, - torrentfile: CONFIG.STORAGE.TMP_DIR - } + { ...MIMETYPES.TORRENT.MIMETYPE_EXT, ...MIMETYPES.IMAGE.MIMETYPE_EXT } ) videoImportsRouter.post('/imports', @@ -57,6 +71,18 @@ videoImportsRouter.post('/imports', asyncRetryTransactionMiddleware(addVideoImport) ) +videoImportsRouter.post('/imports/:id/cancel', + authenticate, + asyncMiddleware(videoImportCancelValidator), + asyncRetryTransactionMiddleware(cancelVideoImport) +) + +videoImportsRouter.delete('/imports/:id', + authenticate, + asyncMiddleware(videoImportDeleteValidator), + asyncRetryTransactionMiddleware(deleteVideoImport) +) + // --------------------------------------------------------------------------- export { @@ -65,6 +91,23 @@ export { // --------------------------------------------------------------------------- +async function deleteVideoImport (req: express.Request, res: express.Response) { + const videoImport = res.locals.videoImport + + await videoImport.destroy() + + return res.sendStatus(HttpStatusCode.NO_CONTENT_204) +} + +async function cancelVideoImport (req: express.Request, res: express.Response) { + const videoImport = res.locals.videoImport + + videoImport.state = VideoImportState.CANCELLED + await videoImport.save() + + return res.sendStatus(HttpStatusCode.NO_CONTENT_204) +} + function addVideoImport (req: express.Request, res: express.Response) { if (req.body.targetUrl) return addYoutubeDLImport(req, res) @@ -81,49 +124,42 @@ async function addTorrentImport (req: express.Request, res: express.Response, to let magnetUri: string if (torrentfile) { - torrentName = torrentfile.originalname + const result = await processTorrentOrAbortRequest(req, res, torrentfile) + if (!result) return - // Rename the torrent to a secured name - const newTorrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, getSecureTorrentName(torrentName)) - await move(torrentfile.path, newTorrentPath) - torrentfile.path = newTorrentPath - - const buf = await readFile(torrentfile.path) - const parsedTorrent = parseTorrent(buf) - - videoName = isArray(parsedTorrent.name) ? parsedTorrent.name[0] : parsedTorrent.name as string + videoName = result.name + torrentName = result.torrentName } else { - magnetUri = body.magnetUri - - const parsed = magnetUtil.decode(magnetUri) - videoName = isArray(parsed.name) ? parsed.name[0] : parsed.name as string + const result = processMagnetURI(body) + magnetUri = result.magnetUri + videoName = result.name } - const video = buildVideo(res.locals.videoChannel.id, body, { name: videoName }) + const video = await buildVideo(res.locals.videoChannel.id, body, { name: videoName }) const thumbnailModel = await processThumbnail(req, video) const previewModel = await processPreview(req, video) - const tags = body.tags || undefined - const videoImportAttributes = { - magnetUri, - torrentName, - state: VideoImportState.PENDING, - userId: user.id - } const videoImport = await insertIntoDB({ video, thumbnailModel, previewModel, videoChannel: res.locals.videoChannel, - tags, - videoImportAttributes, - user + tags: body.tags || undefined, + user, + videoImportAttributes: { + magnetUri, + torrentName, + state: VideoImportState.PENDING, + userId: user.id + } }) // Create job to import the video const payload = { - type: torrentfile ? 'torrent-file' as 'torrent-file' : 'magnet-uri' as 'magnet-uri', + type: torrentfile + ? 'torrent-file' as 'torrent-file' + : 'magnet-uri' as 'magnet-uri', videoImportId: videoImport.id, magnetUri } @@ -139,89 +175,81 @@ async function addYoutubeDLImport (req: express.Request, res: express.Response) const targetUrl = body.targetUrl const user = res.locals.oauth.token.User + const youtubeDL = new YoutubeDLWrapper(targetUrl, ServerConfigManager.Instance.getEnabledResolutions('vod')) + // Get video infos let youtubeDLInfo: YoutubeDLInfo try { - youtubeDLInfo = await getYoutubeDLInfo(targetUrl) + youtubeDLInfo = await youtubeDL.getInfoForDownload() } catch (err) { logger.info('Cannot fetch information from import for URL %s.', targetUrl, { err }) - return res.status(HttpStatusCode.BAD_REQUEST_400).json({ - error: 'Cannot fetch remote information of this URL.' - }).end() + return res.fail({ + message: 'Cannot fetch remote information of this URL.', + data: { + targetUrl + } + }) } - const video = buildVideo(res.locals.videoChannel.id, body, youtubeDLInfo) + if (!await hasUnicastURLsOnly(youtubeDLInfo)) { + return res.fail({ + status: HttpStatusCode.FORBIDDEN_403, + message: 'Cannot use non unicast IP as targetUrl.' + }) + } - let thumbnailModel: MThumbnail + const video = await buildVideo(res.locals.videoChannel.id, body, youtubeDLInfo) // Process video thumbnail from request.files - thumbnailModel = await processThumbnail(req, video) + let thumbnailModel = await processThumbnail(req, video) // Process video thumbnail from url if processing from request.files failed if (!thumbnailModel && youtubeDLInfo.thumbnailUrl) { - thumbnailModel = await processThumbnailFromUrl(youtubeDLInfo.thumbnailUrl, video) + try { + thumbnailModel = await processThumbnailFromUrl(youtubeDLInfo.thumbnailUrl, video) + } catch (err) { + logger.warn('Cannot process thumbnail %s from youtubedl.', youtubeDLInfo.thumbnailUrl, { err }) + } } - let previewModel: MThumbnail - // Process video preview from request.files - previewModel = await processPreview(req, video) + let previewModel = await processPreview(req, video) // Process video preview from url if processing from request.files failed if (!previewModel && youtubeDLInfo.thumbnailUrl) { - previewModel = await processPreviewFromUrl(youtubeDLInfo.thumbnailUrl, video) + try { + previewModel = await processPreviewFromUrl(youtubeDLInfo.thumbnailUrl, video) + } catch (err) { + logger.warn('Cannot process preview %s from youtubedl.', youtubeDLInfo.thumbnailUrl, { err }) + } } - const tags = body.tags || youtubeDLInfo.tags - const videoImportAttributes = { - targetUrl, - state: VideoImportState.PENDING, - userId: user.id - } const videoImport = await insertIntoDB({ video, thumbnailModel, previewModel, videoChannel: res.locals.videoChannel, - tags, - videoImportAttributes, - user + tags: body.tags || youtubeDLInfo.tags, + user, + videoImportAttributes: { + targetUrl, + state: VideoImportState.PENDING, + userId: user.id + } }) // Get video subtitles - try { - const subtitles = await getYoutubeDLSubs(targetUrl) + await processYoutubeSubtitles(youtubeDL, targetUrl, video.id) - logger.info('Will create %s subtitles from youtube import %s.', subtitles.length, targetUrl) - - for (const subtitle of subtitles) { - const videoCaption = new VideoCaptionModel({ - videoId: video.id, - language: subtitle.language - }) as MVideoCaptionVideo - videoCaption.Video = video - - // Move physical file - await moveAndProcessCaptionFile(subtitle, videoCaption) - - await sequelizeTypescript.transaction(async t => { - await VideoCaptionModel.insertOrReplaceLanguage(video.id, subtitle.language, null, t) - }) - } - } catch (err) { - logger.warn('Cannot get video subtitles.', { err }) - } + let fileExt = `.${youtubeDLInfo.ext}` + if (!isVideoFileExtnameValid(fileExt)) fileExt = '.mp4' // Create job to import the video const payload = { type: 'youtube-dl' as 'youtube-dl', videoImportId: videoImport.id, - generateThumbnail: !thumbnailModel, - generatePreview: !previewModel, - fileExt: youtubeDLInfo.fileExt - ? `.${youtubeDLInfo.fileExt}` - : '.mp4' + fileExt } await JobQueue.Instance.createJobWithPromise({ type: 'video-import', payload }) @@ -230,15 +258,15 @@ async function addYoutubeDLImport (req: express.Request, res: express.Response) return res.json(videoImport.toFormattedJSON()).end() } -function buildVideo (channelId: number, body: VideoImportCreate, importData: YoutubeDLInfo) { - const videoData = { +async function buildVideo (channelId: number, body: VideoImportCreate, importData: YoutubeDLInfo): Promise { + let videoData = { name: body.name || importData.name || 'Unknown name', remote: false, category: body.category || importData.category, - licence: body.licence || importData.licence, + licence: body.licence ?? importData.licence ?? CONFIG.DEFAULTS.PUBLISH.LICENCE, language: body.language || importData.language, - commentsEnabled: body.commentsEnabled !== false, // If the value is not "false", the default is "true" - downloadEnabled: body.downloadEnabled !== false, + commentsEnabled: body.commentsEnabled ?? CONFIG.DEFAULTS.PUBLISH.COMMENTS_ENABLED, + downloadEnabled: body.downloadEnabled ?? CONFIG.DEFAULTS.PUBLISH.DOWNLOAD_ENABLED, waitTranscoding: body.waitTranscoding || false, state: VideoState.TO_IMPORT, nsfw: body.nsfw || importData.nsfw || false, @@ -246,21 +274,31 @@ function buildVideo (channelId: number, body: VideoImportCreate, importData: You support: body.support || null, privacy: body.privacy || VideoPrivacy.PRIVATE, duration: 0, // duration will be set by the import job - channelId: channelId, - originallyPublishedAt: body.originallyPublishedAt || importData.originallyPublishedAt + channelId, + originallyPublishedAt: body.originallyPublishedAt + ? new Date(body.originallyPublishedAt) + : importData.originallyPublishedAt } + + videoData = await Hooks.wrapObject( + videoData, + body.targetUrl + ? 'filter:api.video.import-url.video-attribute.result' + : 'filter:api.video.import-torrent.video-attribute.result' + ) + const video = new VideoModel(videoData) video.url = getLocalVideoActivityPubUrl(video) return video } -async function processThumbnail (req: express.Request, video: VideoModel) { +async function processThumbnail (req: express.Request, video: MVideoThumbnail) { const thumbnailField = req.files ? req.files['thumbnailfile'] : undefined if (thumbnailField) { const thumbnailPhysicalFile = thumbnailField[0] - return createVideoMiniatureFromExisting({ + return updateVideoMiniatureFromExisting({ inputPath: thumbnailPhysicalFile.path, video, type: ThumbnailType.MINIATURE, @@ -271,12 +309,12 @@ async function processThumbnail (req: express.Request, video: VideoModel) { return undefined } -async function processPreview (req: express.Request, video: VideoModel) { +async function processPreview (req: express.Request, video: MVideoThumbnail): Promise { const previewField = req.files ? req.files['previewfile'] : undefined if (previewField) { const previewPhysicalFile = previewField[0] - return createVideoMiniatureFromExisting({ + return updateVideoMiniatureFromExisting({ inputPath: previewPhysicalFile.path, video, type: ThumbnailType.PREVIEW, @@ -287,36 +325,36 @@ async function processPreview (req: express.Request, video: VideoModel) { return undefined } -async function processThumbnailFromUrl (url: string, video: VideoModel) { +async function processThumbnailFromUrl (url: string, video: MVideoThumbnail) { try { - return createVideoMiniatureFromUrl(url, video, ThumbnailType.MINIATURE) + return updateVideoMiniatureFromUrl({ downloadUrl: url, video, type: ThumbnailType.MINIATURE }) } catch (err) { logger.warn('Cannot generate video thumbnail %s for %s.', url, video.url, { err }) return undefined } } -async function processPreviewFromUrl (url: string, video: VideoModel) { +async function processPreviewFromUrl (url: string, video: MVideoThumbnail) { try { - return createVideoMiniatureFromUrl(url, video, ThumbnailType.PREVIEW) + return updateVideoMiniatureFromUrl({ downloadUrl: url, video, type: ThumbnailType.PREVIEW }) } catch (err) { logger.warn('Cannot generate video preview %s for %s.', url, video.url, { err }) return undefined } } -function insertIntoDB (parameters: { - video: MVideoThumbnailAccountDefault +async function insertIntoDB (parameters: { + video: MVideoThumbnail thumbnailModel: MThumbnail previewModel: MThumbnail videoChannel: MChannelAccountDefault tags: string[] - videoImportAttributes: Partial + videoImportAttributes: FilteredModelAttributes user: MUser }): Promise { const { video, thumbnailModel, previewModel, videoChannel, tags, videoImportAttributes, user } = parameters - return sequelizeTypescript.transaction(async t => { + const videoImport = await sequelizeTypescript.transaction(async t => { const sequelizeOptions = { transaction: t } // Save video object in database @@ -346,4 +384,90 @@ function insertIntoDB (parameters: { return videoImport }) + + return videoImport +} + +async function processTorrentOrAbortRequest (req: express.Request, res: express.Response, torrentfile: Express.Multer.File) { + const torrentName = torrentfile.originalname + + // Rename the torrent to a secured name + const newTorrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, getSecureTorrentName(torrentName)) + await move(torrentfile.path, newTorrentPath, { overwrite: true }) + torrentfile.path = newTorrentPath + + const buf = await readFile(torrentfile.path) + const parsedTorrent = parseTorrent(buf) as Instance + + if (parsedTorrent.files.length !== 1) { + cleanUpReqFiles(req) + + res.fail({ + type: ServerErrorCode.INCORRECT_FILES_IN_TORRENT, + message: 'Torrents with only 1 file are supported.' + }) + return undefined + } + + return { + name: extractNameFromArray(parsedTorrent.name), + torrentName + } +} + +function processMagnetURI (body: VideoImportCreate) { + const magnetUri = body.magnetUri + const parsed = decode(magnetUri) + + return { + name: extractNameFromArray(parsed.name), + magnetUri + } +} + +function extractNameFromArray (name: string | string[]) { + return isArray(name) ? name[0] : name +} + +async function processYoutubeSubtitles (youtubeDL: YoutubeDLWrapper, targetUrl: string, videoId: number) { + try { + const subtitles = await youtubeDL.getSubtitles() + + logger.info('Will create %s subtitles from youtube import %s.', subtitles.length, targetUrl) + + for (const subtitle of subtitles) { + if (!await isVTTFileValid(subtitle.path)) { + await remove(subtitle.path) + continue + } + + const videoCaption = new VideoCaptionModel({ + videoId, + language: subtitle.language, + filename: VideoCaptionModel.generateCaptionName(subtitle.language) + }) as MVideoCaption + + // Move physical file + await moveAndProcessCaptionFile(subtitle, videoCaption) + + await sequelizeTypescript.transaction(async t => { + await VideoCaptionModel.insertOrReplaceLanguage(videoCaption, t) + }) + } + } catch (err) { + logger.warn('Cannot get video subtitles.', { err }) + } +} + +async function hasUnicastURLsOnly (youtubeDLInfo: YoutubeDLInfo) { + const hosts = youtubeDLInfo.urls.map(u => new URL(u).hostname) + const uniqHosts = new Set(hosts) + + for (const h of uniqHosts) { + if (await isResolvingToUnicastOnly(h) !== true) { + return false + } + } + + return true }