]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/controllers/api/videos/import.ts
Add ability to cancel & delete video imports
[github/Chocobozzz/PeerTube.git] / server / controllers / api / videos / import.ts
index 30a7d816c48ff6342e4c8615f37ab146048090c3..8cbfd3286458fa61e8fc6c054191dcad7a2e4841 100644 (file)
@@ -1,28 +1,69 @@
-import * as express from 'express'
-import { auditLoggerFactory, VideoImportAuditView } from '../../../helpers/audit-logger'
-import { asyncMiddleware, asyncRetryTransactionMiddleware, authenticate, videoImportAddValidator } from '../../../middlewares'
-import { CONFIG, IMAGE_MIMETYPE_EXT, PREVIEWS_SIZE, sequelizeTypescript, THUMBNAILS_SIZE } from '../../../initializers'
-import { getYoutubeDLInfo, YoutubeDLInfo } from '../../../helpers/youtube-dl'
-import { createReqFiles } from '../../../helpers/express-utils'
+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 { isVideoFileExtnameValid } from '@server/helpers/custom-validators/videos'
+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,
+  MVideoCaption,
+  MVideoTag,
+  MVideoThumbnail,
+  MVideoWithBlacklistLight
+} from '@server/types/models'
+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 { cleanUpReqFiles, createReqFiles } from '../../../helpers/express-utils'
 import { logger } from '../../../helpers/logger'
-import { VideoImportCreate, VideoImportState, VideoPrivacy, VideoState } from '../../../../shared'
+import { getSecureTorrentName } from '../../../helpers/utils'
+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 { updateVideoMiniatureFromExisting, updateVideoMiniatureFromUrl } from '../../../lib/thumbnail'
+import { autoBlacklistVideoIfNeeded } from '../../../lib/video-blacklist'
+import {
+  asyncMiddleware,
+  asyncRetryTransactionMiddleware,
+  authenticate,
+  videoImportAddValidator,
+  videoImportCancelValidator,
+  videoImportDeleteValidator
+} from '../../../middlewares'
 import { VideoModel } from '../../../models/video/video'
-import { getVideoActivityPubUrl } from '../../../lib/activitypub'
-import { TagModel } from '../../../models/video/tag'
+import { VideoCaptionModel } from '../../../models/video/video-caption'
 import { VideoImportModel } from '../../../models/video/video-import'
-import { JobQueue } from '../../../lib/job-queue/job-queue'
-import { processImage } from '../../../helpers/image-utils'
-import { join } from 'path'
 
 const auditLogger = auditLoggerFactory('video-imports')
 const videoImportsRouter = express.Router()
 
 const reqVideoFileImport = createReqFiles(
-  [ 'thumbnailfile', 'previewfile' ],
-  IMAGE_MIMETYPE_EXT,
+  [ 'thumbnailfile', 'previewfile', 'torrentfile' ],
+  Object.assign({}, MIMETYPES.TORRENT.MIMETYPE_EXT, MIMETYPES.IMAGE.MIMETYPE_EXT),
   {
-    thumbnailfile: CONFIG.STORAGE.THUMBNAILS_DIR,
-    previewfile: CONFIG.STORAGE.PREVIEWS_DIR
+    thumbnailfile: CONFIG.STORAGE.TMP_DIR,
+    previewfile: CONFIG.STORAGE.TMP_DIR,
+    torrentfile: CONFIG.STORAGE.TMP_DIR
   }
 )
 
@@ -33,6 +74,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 {
@@ -41,98 +94,358 @@ export {
 
 // ---------------------------------------------------------------------------
 
-async function addVideoImport (req: express.Request, res: express.Response) {
+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)
+
+  const file = req.files?.['torrentfile']?.[0]
+  if (req.body.magnetUri || file) return addTorrentImport(req, res, file)
+}
+
+async function addTorrentImport (req: express.Request, res: express.Response, torrentfile: Express.Multer.File) {
+  const body: VideoImportCreate = req.body
+  const user = res.locals.oauth.token.User
+
+  let videoName: string
+  let torrentName: string
+  let magnetUri: string
+
+  if (torrentfile) {
+    const result = await processTorrentOrAbortRequest(req, res, torrentfile)
+    if (!result) return
+
+    videoName = result.name
+    torrentName = result.torrentName
+  } else {
+    const result = processMagnetURI(body)
+    magnetUri = result.magnetUri
+    videoName = result.name
+  }
+
+  const video = await buildVideo(res.locals.videoChannel.id, body, { name: videoName })
+
+  const thumbnailModel = await processThumbnail(req, video)
+  const previewModel = await processPreview(req, video)
+
+  const videoImport = await insertIntoDB({
+    video,
+    thumbnailModel,
+    previewModel,
+    videoChannel: res.locals.videoChannel,
+    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',
+    videoImportId: videoImport.id,
+    magnetUri
+  }
+  await JobQueue.Instance.createJobWithPromise({ 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
 
+  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(400).json({
-      error: 'Cannot fetch remote information of this URL.'
-    }).end()
+    return res.fail({
+      message: 'Cannot fetch remote information of this URL.',
+      data: {
+        targetUrl
+      }
+    })
   }
 
-  // Create video DB object
-  const videoData = {
-    name: body.name || youtubeDLInfo.name,
+  const video = await buildVideo(res.locals.videoChannel.id, body, youtubeDLInfo)
+
+  // Process video thumbnail from request.files
+  let thumbnailModel = await processThumbnail(req, video)
+
+  // Process video thumbnail from url if processing from request.files failed
+  if (!thumbnailModel && youtubeDLInfo.thumbnailUrl) {
+    try {
+      thumbnailModel = await processThumbnailFromUrl(youtubeDLInfo.thumbnailUrl, video)
+    } catch (err) {
+      logger.warn('Cannot process thumbnail %s from youtubedl.', youtubeDLInfo.thumbnailUrl, { err })
+    }
+  }
+
+  // Process video preview from request.files
+  let previewModel = await processPreview(req, video)
+
+  // Process video preview from url if processing from request.files failed
+  if (!previewModel && youtubeDLInfo.thumbnailUrl) {
+    try {
+      previewModel = await processPreviewFromUrl(youtubeDLInfo.thumbnailUrl, video)
+    } catch (err) {
+      logger.warn('Cannot process preview %s from youtubedl.', youtubeDLInfo.thumbnailUrl, { err })
+    }
+  }
+
+  const videoImport = await insertIntoDB({
+    video,
+    thumbnailModel,
+    previewModel,
+    videoChannel: res.locals.videoChannel,
+    tags: body.tags || youtubeDLInfo.tags,
+    user,
+    videoImportAttributes: {
+      targetUrl,
+      state: VideoImportState.PENDING,
+      userId: user.id
+    }
+  })
+
+  // Get video subtitles
+  await processYoutubeSubtitles(youtubeDL, targetUrl, video.id)
+
+  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,
+    fileExt
+  }
+  await JobQueue.Instance.createJobWithPromise({ type: 'video-import', payload })
+
+  auditLogger.create(getAuditIdFromRes(res), new VideoImportAuditView(videoImport.toFormattedJSON()))
+
+  return res.json(videoImport.toFormattedJSON()).end()
+}
+
+async function buildVideo (channelId: number, body: VideoImportCreate, importData: YoutubeDLInfo): Promise<MVideoThumbnail> {
+  let videoData = {
+    name: body.name || importData.name || 'Unknown name',
     remote: false,
-    category: body.category || youtubeDLInfo.category,
-    licence: body.licence || youtubeDLInfo.licence,
-    language: body.language || undefined,
-    commentsEnabled: body.commentsEnabled || true,
+    category: body.category || importData.category,
+    licence: body.licence ?? importData.licence ?? CONFIG.DEFAULTS.PUBLISH.LICENCE,
+    language: body.language || importData.language,
+    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 || youtubeDLInfo.nsfw || false,
-    description: body.description || youtubeDLInfo.description,
+    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: res.locals.videoChannel.id
+    channelId: 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 = getVideoActivityPubUrl(video)
+  video.url = getLocalVideoActivityPubUrl(video)
+
+  return video
+}
 
-  // Process thumbnail file?
+async function processThumbnail (req: express.Request, video: MVideoThumbnail) {
   const thumbnailField = req.files ? req.files['thumbnailfile'] : undefined
-  let downloadThumbnail = true
   if (thumbnailField) {
-    const thumbnailPhysicalFile = thumbnailField[ 0 ]
-    await processImage(thumbnailPhysicalFile, join(CONFIG.STORAGE.THUMBNAILS_DIR, video.getThumbnailName()), THUMBNAILS_SIZE)
-    downloadThumbnail = false
+    const thumbnailPhysicalFile = thumbnailField[0]
+
+    return updateVideoMiniatureFromExisting({
+      inputPath: thumbnailPhysicalFile.path,
+      video,
+      type: ThumbnailType.MINIATURE,
+      automaticallyGenerated: false
+    })
   }
 
-  // Process preview file?
+  return undefined
+}
+
+async function processPreview (req: express.Request, video: MVideoThumbnail): Promise<MThumbnail> {
   const previewField = req.files ? req.files['previewfile'] : undefined
-  let downloadPreview = true
   if (previewField) {
     const previewPhysicalFile = previewField[0]
-    await processImage(previewPhysicalFile, join(CONFIG.STORAGE.PREVIEWS_DIR, video.getPreviewName()), PREVIEWS_SIZE)
-    downloadPreview = false
+
+    return updateVideoMiniatureFromExisting({
+      inputPath: previewPhysicalFile.path,
+      video,
+      type: ThumbnailType.PREVIEW,
+      automaticallyGenerated: false
+    })
   }
 
-  const videoImport: VideoImportModel = await sequelizeTypescript.transaction(async t => {
+  return undefined
+}
+
+async function processThumbnailFromUrl (url: string, video: MVideoThumbnail) {
+  try {
+    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: MVideoThumbnail) {
+  try {
+    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
+  }
+}
+
+async function insertIntoDB (parameters: {
+  video: MVideoThumbnail
+  thumbnailModel: MThumbnail
+  previewModel: MThumbnail
+  videoChannel: MChannelAccountDefault
+  tags: string[]
+  videoImportAttributes: FilteredModelAttributes<VideoImportModel>
+  user: MUser
+}): Promise<MVideoImportFormattable> {
+  const { video, thumbnailModel, previewModel, videoChannel, tags, videoImportAttributes, user } = parameters
+
+  const videoImport = await sequelizeTypescript.transaction(async t => {
     const sequelizeOptions = { transaction: t }
 
     // Save video object in database
-    const videoCreated = await video.save(sequelizeOptions)
-    videoCreated.VideoChannel = res.locals.videoChannel
+    const videoCreated = await video.save(sequelizeOptions) as (MVideoAccountDefault & MVideoWithBlacklistLight & MVideoTag)
+    videoCreated.VideoChannel = videoChannel
 
-    // Set tags to the video
-    const tags = body.tags ? body.tags : youtubeDLInfo.tags
-    if (tags !== undefined) {
-      const tagInstances = await TagModel.findOrCreateTags(tags, t)
+    if (thumbnailModel) await videoCreated.addAndSaveThumbnail(thumbnailModel, t)
+    if (previewModel) await videoCreated.addAndSaveThumbnail(previewModel, t)
 
-      await videoCreated.$set('Tags', tagInstances, sequelizeOptions)
-      videoCreated.Tags = tagInstances
-    }
+    await autoBlacklistVideoIfNeeded({
+      video: videoCreated,
+      user,
+      notify: false,
+      isRemote: false,
+      isNew: true,
+      transaction: t
+    })
 
-    // Create video import object in database
-    const videoImport = await VideoImportModel.create({
-      targetUrl,
-      state: VideoImportState.PENDING,
-      videoId: videoCreated.id
-    }, sequelizeOptions)
+    await setVideoTags({ video: videoCreated, tags, transaction: t })
 
+    // Create video import object in database
+    const videoImport = await VideoImportModel.create(
+      Object.assign({ videoId: videoCreated.id }, videoImportAttributes),
+      sequelizeOptions
+    ) as MVideoImportFormattable
     videoImport.Video = videoCreated
 
     return videoImport
   })
 
-  // Create job to import the video
-  const payload = {
-    type: 'youtube-dl' as 'youtube-dl',
-    videoImportId: videoImport.id,
-    thumbnailUrl: youtubeDLInfo.thumbnailUrl,
-    downloadThumbnail,
-    downloadPreview
+  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
   }
-  await JobQueue.Instance.createJob({ type: 'video-import', payload })
+}
 
-  auditLogger.create(res.locals.oauth.token.User.Account.Actor.getIdentifier(), new VideoImportAuditView(videoImport.toFormattedJSON()))
+function processMagnetURI (body: VideoImportCreate) {
+  const magnetUri = body.magnetUri
+  const parsed = decode(magnetUri)
 
-  return res.json(videoImport.toFormattedJSON()).end()
+  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) {
+      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 })
+  }
 }