]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/controllers/api/videos/import.ts
replace numbers with typed http status codes (#3409)
[github/Chocobozzz/PeerTube.git] / server / controllers / api / videos / import.ts
index 680d8665fdfcf0eaea0f4b2b5201d8dfef6b3714..cd9ba046deed1656f821c9112b557cc89e20fe0f 100644 (file)
@@ -1,34 +1,53 @@
+import * as Bluebird from 'bluebird'
 import * as express from 'express'
-import { auditLoggerFactory } from '../../../helpers/audit-logger'
+import { move, readFile } from 'fs-extra'
+import * as magnetUtil from 'magnet-uri'
+import * as parseTorrent from 'parse-torrent'
+import { join } from 'path'
+import { setVideoTags } from '@server/lib/video'
 import {
-  asyncMiddleware,
-  asyncRetryTransactionMiddleware,
-  authenticate,
-  videoImportAddValidator,
-  videoImportDeleteValidator
-} from '../../../middlewares'
-import { CONFIG, IMAGE_MIMETYPE_EXT, PREVIEWS_SIZE, sequelizeTypescript, THUMBNAILS_SIZE } from '../../../initializers'
-import { getYoutubeDLInfo, YoutubeDLInfo } from '../../../helpers/youtube-dl'
+  MChannelAccountDefault,
+  MThumbnail,
+  MUser,
+  MVideoAccountDefault,
+  MVideoCaptionVideo,
+  MVideoTag,
+  MVideoThumbnailAccountDefault,
+  MVideoWithBlacklistLight
+} from '@server/types/models'
+import { MVideoImport, MVideoImportFormattable } from '@server/types/models/video/video-import'
+import { VideoImportCreate, VideoImportState, VideoPrivacy, VideoState } from '../../../../shared'
+import { ThumbnailType } from '../../../../shared/models/videos/thumbnail.type'
+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 { logger } from '../../../helpers/logger'
-import { VideoImportCreate, VideoImportState, VideoPrivacy, VideoState } from '../../../../shared'
+import { getSecureTorrentName } from '../../../helpers/utils'
+import { getYoutubeDLInfo, getYoutubeDLSubs, YoutubeDLInfo } 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 { autoBlacklistVideoIfNeeded } from '../../../lib/video-blacklist'
+import { asyncMiddleware, asyncRetryTransactionMiddleware, authenticate, videoImportAddValidator } 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'
+import { HttpStatusCode } from '../../../../shared/core-utils/miscs/http-error-codes'
 
 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
   }
 )
 
@@ -39,12 +58,6 @@ videoImportsRouter.post('/imports',
   asyncRetryTransactionMiddleware(addVideoImport)
 )
 
-videoImportsRouter.delete('/imports/:id',
-  authenticate,
-  asyncMiddleware(videoImportDeleteValidator),
-  asyncRetryTransactionMiddleware(deleteVideoImport)
-)
-
 // ---------------------------------------------------------------------------
 
 export {
@@ -53,107 +66,285 @@ export {
 
 // ---------------------------------------------------------------------------
 
-async function addVideoImport (req: express.Request, res: express.Response) {
+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) {
+    torrentName = torrentfile.originalname
+
+    // 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
+  } else {
+    magnetUri = body.magnetUri
+
+    const parsed = magnetUtil.decode(magnetUri)
+    videoName = isArray(parsed.name) ? parsed.name[0] : parsed.name as string
+  }
+
+  const video = 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
+  })
+
+  // 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
 
+  // 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 })
 
-    return res.status(400).json({
+    return res.status(HttpStatusCode.BAD_REQUEST_400).json({
       error: 'Cannot fetch remote information of this URL.'
     }).end()
   }
 
-  // Create video DB object
+  const video = buildVideo(res.locals.videoChannel.id, body, youtubeDLInfo)
+
+  let thumbnailModel: MThumbnail
+
+  // Process video thumbnail from request.files
+  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)
+  }
+
+  let previewModel: MThumbnail
+
+  // Process video preview from request.files
+  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)
+  }
+
+  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
+  })
+
+  // 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
+
+      // 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 })
+  }
+
+  // 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'
+  }
+  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 || youtubeDLInfo.name,
+    name: body.name || importData.name || 'Unknown name',
     remote: false,
-    category: body.category || youtubeDLInfo.category,
-    licence: body.licence || youtubeDLInfo.licence,
-    language: undefined,
-    commentsEnabled: body.commentsEnabled || true,
+    category: body.category || importData.category,
+    licence: body.licence || importData.licence,
+    language: body.language || importData.language,
+    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 || 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 || importData.originallyPublishedAt
   }
   const video = new VideoModel(videoData)
-  video.url = getVideoActivityPubUrl(video)
+  video.url = getLocalVideoActivityPubUrl(video)
+
+  return video
+}
 
-  // Process thumbnail file?
-  const thumbnailField = req.files['thumbnailfile']
-  let downloadThumbnail = true
+async function processThumbnail (req: express.Request, video: VideoModel) {
+  const thumbnailField = req.files ? req.files['thumbnailfile'] : undefined
   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 createVideoMiniatureFromExisting({
+      inputPath: thumbnailPhysicalFile.path,
+      video,
+      type: ThumbnailType.MINIATURE,
+      automaticallyGenerated: false
+    })
   }
 
-  // Process preview file?
-  const previewField = req.files['previewfile']
-  let downloadPreview = true
+  return undefined
+}
+
+async function processPreview (req: express.Request, video: VideoModel) {
+  const previewField = req.files ? req.files['previewfile'] : undefined
   if (previewField) {
     const previewPhysicalFile = previewField[0]
-    await processImage(previewPhysicalFile, join(CONFIG.STORAGE.PREVIEWS_DIR, video.getPreviewName()), PREVIEWS_SIZE)
-    downloadPreview = false
+
+    return createVideoMiniatureFromExisting({
+      inputPath: previewPhysicalFile.path,
+      video,
+      type: ThumbnailType.PREVIEW,
+      automaticallyGenerated: false
+    })
   }
 
-  const videoImport: VideoImportModel = await sequelizeTypescript.transaction(async t => {
-    const sequelizeOptions = { transaction: t }
+  return undefined
+}
 
-    // Save video object in database
-    const videoCreated = await video.save(sequelizeOptions)
-    videoCreated.VideoChannel = res.locals.videoChannel
+async function processThumbnailFromUrl (url: string, video: VideoModel) {
+  try {
+    return createVideoMiniatureFromUrl(url, video, ThumbnailType.MINIATURE)
+  } catch (err) {
+    logger.warn('Cannot generate video thumbnail %s for %s.', url, video.url, { err })
+    return undefined
+  }
+}
 
-    // Set tags to the video
-    if (youtubeDLInfo.tags !== undefined) {
-      const tagInstances = await TagModel.findOrCreateTags(youtubeDLInfo.tags, t)
+async function processPreviewFromUrl (url: string, video: VideoModel) {
+  try {
+    return createVideoMiniatureFromUrl(url, video, ThumbnailType.PREVIEW)
+  } catch (err) {
+    logger.warn('Cannot generate video preview %s for %s.', url, video.url, { err })
+    return undefined
+  }
+}
 
-      await videoCreated.$set('Tags', tagInstances, sequelizeOptions)
-      videoCreated.Tags = tagInstances
-    }
+function insertIntoDB (parameters: {
+  video: MVideoThumbnailAccountDefault
+  thumbnailModel: MThumbnail
+  previewModel: MThumbnail
+  videoChannel: MChannelAccountDefault
+  tags: string[]
+  videoImportAttributes: Partial<MVideoImport>
+  user: MUser
+}): Bluebird<MVideoImportFormattable> {
+  const { video, thumbnailModel, previewModel, videoChannel, tags, videoImportAttributes, user } = parameters
 
-    // Create video import object in database
-    const videoImport = await VideoImportModel.create({
-      targetUrl,
-      state: VideoImportState.PENDING,
-      videoId: videoCreated.id
-    }, sequelizeOptions)
+  return sequelizeTypescript.transaction(async t => {
+    const sequelizeOptions = { transaction: t }
 
-    videoImport.Video = videoCreated
+    // Save video object in database
+    const videoCreated = await video.save(sequelizeOptions) as (MVideoAccountDefault & MVideoWithBlacklistLight & MVideoTag)
+    videoCreated.VideoChannel = videoChannel
 
-    return videoImport
-  })
+    if (thumbnailModel) await videoCreated.addAndSaveThumbnail(thumbnailModel, t)
+    if (previewModel) await videoCreated.addAndSaveThumbnail(previewModel, t)
 
-  // Create job to import the video
-  const payload = {
-    type: 'youtube-dl' as 'youtube-dl',
-    videoImportId: videoImport.id,
-    thumbnailUrl: youtubeDLInfo.thumbnailUrl,
-    downloadThumbnail,
-    downloadPreview
-  }
-  await JobQueue.Instance.createJob({ type: 'video-import', payload })
+    await autoBlacklistVideoIfNeeded({
+      video: videoCreated,
+      user,
+      notify: false,
+      isRemote: false,
+      isNew: true,
+      transaction: t
+    })
 
-  return res.json(videoImport.toFormattedJSON())
-}
+    await setVideoTags({ video: videoCreated, tags, transaction: t })
 
-async function deleteVideoImport (req: express.Request, res: express.Response) {
-  await sequelizeTypescript.transaction(async t => {
-    const videoImport = res.locals.videoImport
-    const video = videoImport.Video
+    // Create video import object in database
+    const videoImport = await VideoImportModel.create(
+      Object.assign({ videoId: videoCreated.id }, videoImportAttributes),
+      sequelizeOptions
+    ) as MVideoImportFormattable
+    videoImport.Video = videoCreated
 
-    await videoImport.destroy({ transaction: t })
-    await video.destroy({ transaction: t })
+    return videoImport
   })
-
-  return res.status(204).end()
 }