X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fcontrollers%2Fapi%2Fvideos%2Fimport.ts;h=9d7b0260b464a64cca2cbd282d08c910650a2446;hb=3545e72c686ff1725bbdfd8d16d693e2f4aa75a3;hp=fb9d73140601dfeceaacfa96c1833e4a40f06def;hpb=652c64165b3d8d1c5d5fc646c29e5cd1c82a3330;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/controllers/api/videos/import.ts b/server/controllers/api/videos/import.ts index fb9d73140..9d7b0260b 100644 --- a/server/controllers/api/videos/import.ts +++ b/server/controllers/api/videos/import.ts @@ -1,60 +1,54 @@ -import * as express from 'express' -import * as magnetUtil from 'magnet-uri' -import { auditLoggerFactory, getAuditIdFromRes, VideoImportAuditView } from '../../../helpers/audit-logger' -import { asyncMiddleware, asyncRetryTransactionMiddleware, authenticate, videoImportAddValidator } from '../../../middlewares' -import { MIMETYPES } from '../../../initializers/constants' -import { getYoutubeDLInfo, YoutubeDLInfo, getYoutubeDLSubs } from '../../../helpers/youtube-dl' -import { createReqFiles } from '../../../helpers/express-utils' -import { logger } from '../../../helpers/logger' -import { VideoImportCreate, VideoImportState, VideoPrivacy, VideoState } from '../../../../shared' -import { VideoModel } from '../../../models/video/video' -import { VideoCaptionModel } from '../../../models/video/video-caption' -import { moveAndProcessCaptionFile } from '../../../helpers/captions-utils' -import { getVideoActivityPubUrl } from '../../../lib/activitypub' -import { TagModel } from '../../../models/video/tag' -import { VideoImportModel } from '../../../models/video/video-import' -import { JobQueue } from '../../../lib/job-queue/job-queue' +import express from 'express' +import { move, readFile } from 'fs-extra' +import { decode } from 'magnet-uri' +import parseTorrent, { Instance } from 'parse-torrent' import { join } from 'path' +import { buildYoutubeDLImport, buildVideoFromImport, insertFromImportIntoDB, YoutubeDlImportError } from '@server/lib/video-import' +import { MThumbnail, MVideoThumbnail } from '@server/types/models' +import { HttpStatusCode, ServerErrorCode, ThumbnailType, VideoImportCreate, VideoImportPayload, VideoImportState } from '@shared/models' +import { auditLoggerFactory, getAuditIdFromRes, VideoImportAuditView } from '../../../helpers/audit-logger' import { isArray } from '../../../helpers/custom-validators/misc' -import * as Bluebird from 'bluebird' -import * as parseTorrent from 'parse-torrent' +import { cleanUpReqFiles, createReqFiles } from '../../../helpers/express-utils' +import { logger } from '../../../helpers/logger' import { getSecureTorrentName } from '../../../helpers/utils' -import { move, readFile } from 'fs-extra' -import { autoBlacklistVideoIfNeeded } from '../../../lib/video-blacklist' import { CONFIG } from '../../../initializers/config' -import { sequelizeTypescript } from '../../../initializers/database' -import { createVideoMiniatureFromExisting } from '../../../lib/thumbnail' -import { ThumbnailType } from '../../../../shared/models/videos/thumbnail.type' +import { MIMETYPES } from '../../../initializers/constants' +import { JobQueue } from '../../../lib/job-queue/job-queue' +import { updateVideoMiniatureFromExisting } from '../../../lib/thumbnail' import { - MChannelAccountDefault, - MThumbnail, - MUser, - MVideoAccountDefault, - MVideoCaptionVideo, - MVideoTag, - MVideoThumbnailAccountDefault, - MVideoWithBlacklistLight -} from '@server/typings/models' -import { MVideoImport, MVideoImportFormattable } from '@server/typings/models/video/video-import' + asyncMiddleware, + asyncRetryTransactionMiddleware, + authenticate, + videoImportAddValidator, + videoImportCancelValidator, + videoImportDeleteValidator +} from '../../../middlewares' const auditLogger = auditLoggerFactory('video-imports') 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', authenticate, reqVideoFileImport, asyncMiddleware(videoImportAddValidator), - asyncRetryTransactionMiddleware(addVideoImport) + asyncRetryTransactionMiddleware(handleVideoImport) +) + +videoImportsRouter.post('/imports/:id/cancel', + authenticate, + asyncMiddleware(videoImportCancelValidator), + asyncRetryTransactionMiddleware(cancelVideoImport) +) + +videoImportsRouter.delete('/imports/:id', + authenticate, + asyncMiddleware(videoImportDeleteValidator), + asyncRetryTransactionMiddleware(deleteVideoImport) ) // --------------------------------------------------------------------------- @@ -65,14 +59,31 @@ export { // --------------------------------------------------------------------------- -function addVideoImport (req: express.Request, res: express.Response) { - if (req.body.targetUrl) return addYoutubeDLImport(req, res) +async function deleteVideoImport (req: express.Request, res: express.Response) { + const videoImport = res.locals.videoImport + + await videoImport.destroy() - const file = req.files && req.files['torrentfile'] ? req.files['torrentfile'][0] : undefined - if (req.body.magnetUri || file) return addTorrentImport(req, res, file) + return res.sendStatus(HttpStatusCode.NO_CONTENT_204) } -async function addTorrentImport (req: express.Request, res: express.Response, torrentfile: Express.Multer.File) { +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 handleVideoImport (req: express.Request, res: express.Response) { + if (req.body.targetUrl) return handleYoutubeDlImport(req, res) + + const file = req.files?.['torrentfile']?.[0] + if (req.body.magnetUri || file) return handleTorrentImport(req, res, file) +} + +async function handleTorrentImport (req: express.Request, res: express.Response, torrentfile: Express.Multer.File) { const body: VideoImportCreate = req.body const user = res.locals.oauth.token.User @@ -81,233 +92,170 @@ 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 buildVideoFromImport({ + channelId: res.locals.videoChannel.id, + importData: { name: videoName }, + importDataOverride: body, + importType: 'torrent' + }) 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({ + const videoImport = await insertFromImportIntoDB({ 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', + const payload: VideoImportPayload = { + type: torrentfile + ? 'torrent-file' + : 'magnet-uri', videoImportId: videoImport.id, - magnetUri + preventException: false } - await JobQueue.Instance.createJobWithPromise({ type: 'video-import', payload }) + await JobQueue.Instance.createJob({ type: 'video-import', payload }) auditLogger.create(getAuditIdFromRes(res), new VideoImportAuditView(videoImport.toFormattedJSON())) return res.json(videoImport.toFormattedJSON()).end() } -async function addYoutubeDLImport (req: express.Request, res: express.Response) { - const body: VideoImportCreate = req.body - const targetUrl = body.targetUrl - const user = res.locals.oauth.token.User +function statusFromYtDlImportError (err: YoutubeDlImportError): number { + switch (err.code) { + case YoutubeDlImportError.CODE.NOT_ONLY_UNICAST_URL: + return HttpStatusCode.FORBIDDEN_403 - // Get video infos - let youtubeDLInfo: YoutubeDLInfo - try { - youtubeDLInfo = await getYoutubeDLInfo(targetUrl) - } catch (err) { - logger.info('Cannot fetch information from import for URL %s.', targetUrl, { err }) + case YoutubeDlImportError.CODE.FETCH_ERROR: + return HttpStatusCode.BAD_REQUEST_400 - return res.status(400).json({ - error: 'Cannot fetch remote information of this URL.' - }).end() + default: + return HttpStatusCode.INTERNAL_SERVER_ERROR_500 } +} - const video = buildVideo(res.locals.videoChannel.id, body, youtubeDLInfo) - - const thumbnailModel = await processThumbnail(req, video) - const previewModel = await processPreview(req, video) - - 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 - }) +async function handleYoutubeDlImport (req: express.Request, res: express.Response) { + const body: VideoImportCreate = req.body + const targetUrl = body.targetUrl + const user = res.locals.oauth.token.User - // Get video subtitles try { - const subtitles = await getYoutubeDLSubs(targetUrl) - - 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 + const { job, videoImport } = await buildYoutubeDLImport({ + targetUrl, + channel: res.locals.videoChannel, + importDataOverride: body, + thumbnailFilePath: req.files?.['thumbnailfile']?.[0].path, + previewFilePath: req.files?.['previewfile']?.[0].path, + user + }) + await JobQueue.Instance.createJob(job) - // Move physical file - await moveAndProcessCaptionFile(subtitle, videoCaption) + auditLogger.create(getAuditIdFromRes(res), new VideoImportAuditView(videoImport.toFormattedJSON())) - await sequelizeTypescript.transaction(async t => { - await VideoCaptionModel.insertOrReplaceLanguage(video.id, subtitle.language, null, t) - }) - } + return res.json(videoImport.toFormattedJSON()).end() } catch (err) { - logger.warn('Cannot get video subtitles.', { err }) - } - - // Create job to import the video - const payload = { - type: 'youtube-dl' as 'youtube-dl', - videoImportId: videoImport.id, - thumbnailUrl: youtubeDLInfo.thumbnailUrl, - downloadThumbnail: !thumbnailModel, - downloadPreview: !previewModel, - fileExt: youtubeDLInfo.fileExt - ? `.${youtubeDLInfo.fileExt}` - : '.mp4' - } - await JobQueue.Instance.createJobWithPromise({ type: 'video-import', payload }) - - auditLogger.create(getAuditIdFromRes(res), new VideoImportAuditView(videoImport.toFormattedJSON())) - - return res.json(videoImport.toFormattedJSON()).end() -} - -function buildVideo (channelId: number, body: VideoImportCreate, importData: YoutubeDLInfo) { - const videoData = { - name: body.name || importData.name || 'Unknown name', - remote: false, - category: body.category || importData.category, - licence: body.licence || importData.licence, - language: body.language || undefined, - commentsEnabled: body.commentsEnabled !== false, // If the value is not "false", the default is "true" - downloadEnabled: body.downloadEnabled !== false, - waitTranscoding: body.waitTranscoding || false, - state: VideoState.TO_IMPORT, - nsfw: body.nsfw || importData.nsfw || false, - description: body.description || importData.description, - support: body.support || null, - privacy: body.privacy || VideoPrivacy.PRIVATE, - duration: 0, // duration will be set by the import job - channelId: channelId, - originallyPublishedAt: importData.originallyPublishedAt + logger.error('An error occurred while importing the video %s. ', targetUrl, { err }) + + return res.fail({ + message: err.message, + status: statusFromYtDlImportError(err), + data: { + targetUrl + } + }) } - const video = new VideoModel(videoData) - video.url = getVideoActivityPubUrl(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(thumbnailPhysicalFile.path, video, ThumbnailType.MINIATURE, false) + return updateVideoMiniatureFromExisting({ + inputPath: thumbnailPhysicalFile.path, + video, + type: ThumbnailType.MINIATURE, + automaticallyGenerated: false + }) } 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(previewPhysicalFile.path, video, ThumbnailType.PREVIEW, false) + return updateVideoMiniatureFromExisting({ + inputPath: previewPhysicalFile.path, + video, + type: ThumbnailType.PREVIEW, + automaticallyGenerated: false + }) } return undefined } -function insertIntoDB (parameters: { - video: MVideoThumbnailAccountDefault - thumbnailModel: MThumbnail - previewModel: MThumbnail - videoChannel: MChannelAccountDefault - tags: string[] - videoImportAttributes: Partial - user: MUser -}): Bluebird { - const { video, thumbnailModel, previewModel, videoChannel, tags, videoImportAttributes, user } = parameters - - return sequelizeTypescript.transaction(async t => { - const sequelizeOptions = { transaction: t } - - // Save video object in database - const videoCreated = await video.save(sequelizeOptions) as (MVideoAccountDefault & MVideoWithBlacklistLight & MVideoTag) - videoCreated.VideoChannel = videoChannel - - if (thumbnailModel) await videoCreated.addAndSaveThumbnail(thumbnailModel, t) - if (previewModel) await videoCreated.addAndSaveThumbnail(previewModel, t) - - await autoBlacklistVideoIfNeeded({ - video: videoCreated, - user, - notify: false, - isRemote: false, - isNew: true, - transaction: t +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 + } - // Set tags to the video - if (tags) { - const tagInstances = await TagModel.findOrCreateTags(tags, t) + return { + name: extractNameFromArray(parsedTorrent.name), + torrentName + } +} - await videoCreated.$set('Tags', tagInstances, sequelizeOptions) - videoCreated.Tags = tagInstances - } else { - videoCreated.Tags = [] - } +function processMagnetURI (body: VideoImportCreate) { + const magnetUri = body.magnetUri + const parsed = decode(magnetUri) - // Create video import object in database - const videoImport = await VideoImportModel.create( - Object.assign({ videoId: videoCreated.id }, videoImportAttributes), - sequelizeOptions - ) as MVideoImportFormattable - videoImport.Video = videoCreated + return { + name: extractNameFromArray(parsed.name), + magnetUri + } +} - return videoImport - }) +function extractNameFromArray (name: string | string[]) { + return isArray(name) ? name[0] : name }