]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/controllers/api/videos/index.ts
Add ability to manually run transcoding job
[github/Chocobozzz/PeerTube.git] / server / controllers / api / videos / index.ts
index 49f0e4630d2c9ea313ab0a30c03c9ca9e7085964..7f5e74626e401714667d6be9c53d702e04116250 100644 (file)
 import * as express from 'express'
-import * as multer from 'multer'
 import { extname, join } from 'path'
-
-import { database as db } from '../../../initializers/database'
+import { VideoCreate, VideoPrivacy, VideoUpdate } from '../../../../shared'
+import { renamePromise } from '../../../helpers/core-utils'
+import { retryTransactionWrapper } from '../../../helpers/database-utils'
+import { getVideoFileResolution } from '../../../helpers/ffmpeg-utils'
+import { processImage } from '../../../helpers/image-utils'
+import { logger } from '../../../helpers/logger'
+import { getFormattedObjects, getServerActor, resetSequelizeInstance } from '../../../helpers/utils'
 import {
   CONFIG,
-  REQUEST_VIDEO_QADU_TYPES,
-  REQUEST_VIDEO_EVENT_TYPES,
+  IMAGE_MIMETYPE_EXT,
+  PREVIEWS_SIZE,
+  sequelizeTypescript,
+  THUMBNAILS_SIZE,
   VIDEO_CATEGORIES,
+  VIDEO_LANGUAGES,
   VIDEO_LICENCES,
-  VIDEO_LANGUAGES
+  VIDEO_MIMETYPE_EXT,
+  VIDEO_PRIVACIES
 } from '../../../initializers'
 import {
-  addEventToRemoteVideo,
-  quickAndDirtyUpdateVideoToFriends,
-  addVideoToFriends,
-  updateVideoToFriends,
-  JobScheduler,
-  fetchRemoteDescription
-} from '../../../lib'
+  changeVideoChannelShare,
+  fetchRemoteVideoDescription,
+  getVideoActivityPubUrl,
+  shareVideoByServerAndChannel
+} from '../../../lib/activitypub'
+import { sendCreateVideo, sendCreateView, sendUpdateVideo } from '../../../lib/activitypub/send'
+import { JobQueue } from '../../../lib/job-queue'
+import { Redis } from '../../../lib/redis'
 import {
+  asyncMiddleware,
   authenticate,
+  optionalAuthenticate,
   paginationValidator,
-  videosSortValidator,
-  setVideosSort,
-  setPagination,
-  setVideosSearch,
-  videosUpdateValidator,
-  videosSearchValidator,
+  setDefaultPagination,
+  setDefaultSort,
   videosAddValidator,
   videosGetValidator,
   videosRemoveValidator,
-  asyncMiddleware
+  videosSearchValidator,
+  videosSortValidator,
+  videosUpdateValidator
 } from '../../../middlewares'
-import {
-  logger,
-  retryTransactionWrapper,
-  generateRandomString,
-  getFormattedObjects,
-  renamePromise,
-  getVideoFileHeight,
-  resetSequelizeInstance
-} from '../../../helpers'
-import { VideoInstance } from '../../../models'
-import { VideoCreate, VideoUpdate } from '../../../../shared'
-
+import { TagModel } from '../../../models/video/tag'
+import { VideoModel } from '../../../models/video/video'
+import { VideoFileModel } from '../../../models/video/video-file'
 import { abuseVideoRouter } from './abuse'
 import { blacklistRouter } from './blacklist'
+import { videoCommentRouter } from './comment'
 import { rateVideoRouter } from './rate'
-import { videoChannelRouter } from './channel'
+import { VideoFilter } from '../../../../shared/models/videos/video-query.type'
+import { VideoSortField } from '../../../../client/src/app/shared/video/sort-field.type'
+import { isNSFWHidden, createReqFiles } from '../../../helpers/express-utils'
 
 const videosRouter = express.Router()
 
-// multer configuration
-const storage = multer.diskStorage({
-  destination: (req, file, cb) => {
-    cb(null, CONFIG.STORAGE.VIDEOS_DIR)
-  },
-
-  filename: (req, file, cb) => {
-    let extension = ''
-    if (file.mimetype === 'video/webm') extension = 'webm'
-    else if (file.mimetype === 'video/mp4') extension = 'mp4'
-    else if (file.mimetype === 'video/ogg') extension = 'ogv'
-    generateRandomString(16)
-      .then(randomString => {
-        cb(null, randomString + '.' + extension)
-      })
-      .catch(err => {
-        logger.error('Cannot generate random string for file name.', err)
-        throw err
-      })
+const reqVideoFileAdd = createReqFiles(
+  [ 'videofile', 'thumbnailfile', 'previewfile' ],
+  Object.assign({}, VIDEO_MIMETYPE_EXT, IMAGE_MIMETYPE_EXT),
+  {
+    videofile: CONFIG.STORAGE.VIDEOS_DIR,
+    thumbnailfile: CONFIG.STORAGE.THUMBNAILS_DIR,
+    previewfile: CONFIG.STORAGE.PREVIEWS_DIR
   }
-})
-
-const reqFiles = multer({ storage: storage }).fields([{ name: 'videofile', maxCount: 1 }])
+)
+const reqVideoFileUpdate = createReqFiles(
+  [ 'thumbnailfile', 'previewfile' ],
+  IMAGE_MIMETYPE_EXT,
+  {
+    thumbnailfile: CONFIG.STORAGE.THUMBNAILS_DIR,
+    previewfile: CONFIG.STORAGE.PREVIEWS_DIR
+  }
+)
 
 videosRouter.use('/', abuseVideoRouter)
 videosRouter.use('/', blacklistRouter)
 videosRouter.use('/', rateVideoRouter)
-videosRouter.use('/', videoChannelRouter)
+videosRouter.use('/', videoCommentRouter)
 
 videosRouter.get('/categories', listVideoCategories)
 videosRouter.get('/licences', listVideoLicences)
 videosRouter.get('/languages', listVideoLanguages)
+videosRouter.get('/privacies', listVideoPrivacies)
 
 videosRouter.get('/',
   paginationValidator,
   videosSortValidator,
-  setVideosSort,
-  setPagination,
+  setDefaultSort,
+  setDefaultPagination,
+  optionalAuthenticate,
   asyncMiddleware(listVideos)
 )
+videosRouter.get('/search',
+  videosSearchValidator,
+  paginationValidator,
+  videosSortValidator,
+  setDefaultSort,
+  setDefaultPagination,
+  optionalAuthenticate,
+  asyncMiddleware(searchVideos)
+)
 videosRouter.put('/:id',
   authenticate,
-  videosUpdateValidator,
+  reqVideoFileUpdate,
+  asyncMiddleware(videosUpdateValidator),
   asyncMiddleware(updateVideoRetryWrapper)
 )
 videosRouter.post('/upload',
   authenticate,
-  reqFiles,
-  videosAddValidator,
+  reqVideoFileAdd,
+  asyncMiddleware(videosAddValidator),
   asyncMiddleware(addVideoRetryWrapper)
 )
 
 videosRouter.get('/:id/description',
-  videosGetValidator,
+  asyncMiddleware(videosGetValidator),
   asyncMiddleware(getVideoDescription)
 )
 videosRouter.get('/:id',
-  videosGetValidator,
+  asyncMiddleware(videosGetValidator),
   getVideo
 )
+videosRouter.post('/:id/views',
+  asyncMiddleware(videosGetValidator),
+  asyncMiddleware(viewVideo)
+)
 
 videosRouter.delete('/:id',
   authenticate,
-  videosRemoveValidator,
+  asyncMiddleware(videosRemoveValidator),
   asyncMiddleware(removeVideoRetryWrapper)
 )
 
-videosRouter.get('/search/:value',
-  videosSearchValidator,
-  paginationValidator,
-  videosSortValidator,
-  setVideosSort,
-  setPagination,
-  setVideosSearch,
-  asyncMiddleware(searchVideos)
-)
-
 // ---------------------------------------------------------------------------
 
 export {
@@ -149,6 +152,10 @@ function listVideoLanguages (req: express.Request, res: express.Response) {
   res.json(VIDEO_LANGUAGES)
 }
 
+function listVideoPrivacies (req: express.Request, res: express.Response) {
+  res.json(VIDEO_PRIVACIES)
+}
+
 // Wrapper to video add that retry the function if there is a database error
 // We need this because we run the transaction in SERIALIZABLE isolation that can fail
 async function addVideoRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
@@ -157,96 +164,117 @@ async function addVideoRetryWrapper (req: express.Request, res: express.Response
     errorMessage: 'Cannot insert the video with many retries.'
   }
 
-  await retryTransactionWrapper(addVideo, options)
+  const video = await retryTransactionWrapper(addVideo, options)
 
-  // TODO : include Location of the new video -> 201
-  res.type('json').status(204).end()
+  res.json({
+    video: {
+      id: video.id,
+      uuid: video.uuid
+    }
+  }).end()
 }
 
 async function addVideo (req: express.Request, res: express.Response, videoPhysicalFile: Express.Multer.File) {
   const videoInfo: VideoCreate = req.body
-  let videoUUID = ''
 
-  await db.sequelize.transaction(async t => {
-    const sequelizeOptions = { transaction: t }
+  // Prepare data so we don't block the transaction
+  const videoData = {
+    name: videoInfo.name,
+    remote: false,
+    extname: extname(videoPhysicalFile.filename),
+    category: videoInfo.category,
+    licence: videoInfo.licence,
+    language: videoInfo.language,
+    commentsEnabled: videoInfo.commentsEnabled,
+    nsfw: videoInfo.nsfw,
+    description: videoInfo.description,
+    support: videoInfo.support,
+    privacy: videoInfo.privacy,
+    duration: videoPhysicalFile['duration'], // duration was added by a previous middleware
+    channelId: res.locals.videoChannel.id
+  }
+  const video = new VideoModel(videoData)
+  video.url = getVideoActivityPubUrl(video)
 
-    const videoData = {
-      name: videoInfo.name,
-      remote: false,
-      extname: extname(videoPhysicalFile.filename),
-      category: videoInfo.category,
-      licence: videoInfo.licence,
-      language: videoInfo.language,
-      nsfw: videoInfo.nsfw,
-      description: videoInfo.description,
-      duration: videoPhysicalFile['duration'], // duration was added by a previous middleware
-      channelId: res.locals.videoChannel.id
-    }
-    const video = db.Video.build(videoData)
+  const { videoFileResolution } = await getVideoFileResolution(videoPhysicalFile.path)
 
-    const videoFilePath = join(CONFIG.STORAGE.VIDEOS_DIR, videoPhysicalFile.filename)
-    const videoFileHeight = await getVideoFileHeight(videoFilePath)
+  const videoFileData = {
+    extname: extname(videoPhysicalFile.filename),
+    resolution: videoFileResolution,
+    size: videoPhysicalFile.size
+  }
+  const videoFile = new VideoFileModel(videoFileData)
+  const videoDir = CONFIG.STORAGE.VIDEOS_DIR
+  const destination = join(videoDir, video.getVideoFilename(videoFile))
+
+  await renamePromise(videoPhysicalFile.path, destination)
+  // This is important in case if there is another attempt in the retry process
+  videoPhysicalFile.filename = video.getVideoFilename(videoFile)
+  videoPhysicalFile.path = destination
+
+  // Process thumbnail or create it from the video
+  const thumbnailField = req.files['thumbnailfile']
+  if (thumbnailField) {
+    const thumbnailPhysicalFile = thumbnailField[0]
+    await processImage(thumbnailPhysicalFile, join(CONFIG.STORAGE.THUMBNAILS_DIR, video.getThumbnailName()), THUMBNAILS_SIZE)
+  } else {
+    await video.createThumbnail(videoFile)
+  }
 
-    const videoFileData = {
-      extname: extname(videoPhysicalFile.filename),
-      resolution: videoFileHeight,
-      size: videoPhysicalFile.size
-    }
-    const videoFile = db.VideoFile.build(videoFileData)
-    const videoDir = CONFIG.STORAGE.VIDEOS_DIR
-    const source = join(videoDir, videoPhysicalFile.filename)
-    const destination = join(videoDir, video.getVideoFilename(videoFile))
-
-    await renamePromise(source, destination)
-    // This is important in case if there is another attempt in the retry process
-    videoPhysicalFile.filename = video.getVideoFilename(videoFile)
-
-    const tasks = []
-
-    tasks.push(
-      video.createTorrentAndSetInfoHash(videoFile),
-      video.createThumbnail(videoFile),
-      video.createPreview(videoFile)
-    )
-
-    if (CONFIG.TRANSCODING.ENABLED === true) {
-      // Put uuid because we don't have id auto incremented for now
-      const dataInput = {
-        videoUUID: video.uuid
-      }
+  // Process preview or create it from the video
+  const previewField = req.files['previewfile']
+  if (previewField) {
+    const previewPhysicalFile = previewField[0]
+    await processImage(previewPhysicalFile, join(CONFIG.STORAGE.PREVIEWS_DIR, video.getPreviewName()), PREVIEWS_SIZE)
+  } else {
+    await video.createPreview(videoFile)
+  }
 
-      tasks.push(
-        JobScheduler.Instance.createJob(t, 'videoFileOptimizer', dataInput)
-      )
-    }
-    await Promise.all(tasks)
+  await video.createTorrentAndSetInfoHash(videoFile)
+
+  const videoCreated = await sequelizeTypescript.transaction(async t => {
+    const sequelizeOptions = { transaction: t }
 
     const videoCreated = await video.save(sequelizeOptions)
     // Do not forget to add video channel information to the created video
     videoCreated.VideoChannel = res.locals.videoChannel
-    videoUUID = videoCreated.uuid
 
     videoFile.videoId = video.id
-
     await videoFile.save(sequelizeOptions)
-    video.VideoFiles = [videoFile]
 
-    if (videoInfo.tags) {
-      const tagInstances = await db.Tag.findOrCreateTags(videoInfo.tags, t)
+    video.VideoFiles = [ videoFile ]
 
-      await video.setTags(tagInstances, sequelizeOptions)
+    if (videoInfo.tags !== undefined) {
+      const tagInstances = await TagModel.findOrCreateTags(videoInfo.tags, t)
+
+      await video.$set('Tags', tagInstances, sequelizeOptions)
       video.Tags = tagInstances
     }
 
     // Let transcoding job send the video to friends because the video file extension might change
-    if (CONFIG.TRANSCODING.ENABLED === true) return undefined
+    if (CONFIG.TRANSCODING.ENABLED === true) return videoCreated
+    // Don't send video to remote servers, it is private
+    if (video.privacy === VideoPrivacy.PRIVATE) return videoCreated
+
+    await sendCreateVideo(video, t)
+    await shareVideoByServerAndChannel(video, t)
+
+    logger.info('Video with name %s and uuid %s created.', videoInfo.name, videoCreated.uuid)
 
-    const remoteVideo = await video.toAddRemoteJSON()
-    // Now we'll add the video's meta data to our friends
-    return addVideoToFriends(remoteVideo, t)
+    return videoCreated
   })
 
-  logger.info('Video with name %s and uuid %s created.', videoInfo.name, videoUUID)
+  if (CONFIG.TRANSCODING.ENABLED === true) {
+    // Put uuid because we don't have id auto incremented for now
+    const dataInput = {
+      videoUUID: videoCreated.uuid,
+      isNewVideo: true
+    }
+
+    await JobQueue.Instance.createJob({ type: 'video-file', payload: dataInput })
+  }
+
+  return videoCreated
 }
 
 async function updateVideoRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
@@ -261,36 +289,73 @@ async function updateVideoRetryWrapper (req: express.Request, res: express.Respo
 }
 
 async function updateVideo (req: express.Request, res: express.Response) {
-  const videoInstance = res.locals.video
+  const videoInstance: VideoModel = res.locals.video
   const videoFieldsSave = videoInstance.toJSON()
   const videoInfoToUpdate: VideoUpdate = req.body
+  const wasPrivateVideo = videoInstance.privacy === VideoPrivacy.PRIVATE
+
+  // Process thumbnail or create it from the video
+  if (req.files && req.files['thumbnailfile']) {
+    const thumbnailPhysicalFile = req.files['thumbnailfile'][0]
+    await processImage(thumbnailPhysicalFile, join(CONFIG.STORAGE.THUMBNAILS_DIR, videoInstance.getThumbnailName()), THUMBNAILS_SIZE)
+  }
+
+  // Process preview or create it from the video
+  if (req.files && req.files['previewfile']) {
+    const previewPhysicalFile = req.files['previewfile'][0]
+    await processImage(previewPhysicalFile, join(CONFIG.STORAGE.PREVIEWS_DIR, videoInstance.getPreviewName()), PREVIEWS_SIZE)
+  }
 
   try {
-    await db.sequelize.transaction(async t => {
+    await sequelizeTypescript.transaction(async t => {
       const sequelizeOptions = {
         transaction: t
       }
+      const oldVideoChannel = videoInstance.VideoChannel
 
       if (videoInfoToUpdate.name !== undefined) videoInstance.set('name', videoInfoToUpdate.name)
       if (videoInfoToUpdate.category !== undefined) videoInstance.set('category', videoInfoToUpdate.category)
       if (videoInfoToUpdate.licence !== undefined) videoInstance.set('licence', videoInfoToUpdate.licence)
       if (videoInfoToUpdate.language !== undefined) videoInstance.set('language', videoInfoToUpdate.language)
       if (videoInfoToUpdate.nsfw !== undefined) videoInstance.set('nsfw', videoInfoToUpdate.nsfw)
+      if (videoInfoToUpdate.support !== undefined) videoInstance.set('support', videoInfoToUpdate.support)
       if (videoInfoToUpdate.description !== undefined) videoInstance.set('description', videoInfoToUpdate.description)
+      if (videoInfoToUpdate.commentsEnabled !== undefined) videoInstance.set('commentsEnabled', videoInfoToUpdate.commentsEnabled)
+      if (videoInfoToUpdate.privacy !== undefined) {
+        const newPrivacy = parseInt(videoInfoToUpdate.privacy.toString(), 10)
+        videoInstance.set('privacy', newPrivacy)
+
+        if (wasPrivateVideo === true && newPrivacy !== VideoPrivacy.PRIVATE) {
+          videoInstance.set('publishedAt', new Date())
+        }
+      }
 
-      await videoInstance.save(sequelizeOptions)
+      const videoInstanceUpdated = await videoInstance.save(sequelizeOptions)
 
-      if (videoInfoToUpdate.tags) {
-        const tagInstances = await db.Tag.findOrCreateTags(videoInfoToUpdate.tags, t)
+      // Video tags update?
+      if (videoInfoToUpdate.tags !== undefined) {
+        const tagInstances = await TagModel.findOrCreateTags(videoInfoToUpdate.tags, t)
 
-        await videoInstance.setTags(tagInstances, sequelizeOptions)
-        videoInstance.Tags = tagInstances
+        await videoInstanceUpdated.$set('Tags', tagInstances, sequelizeOptions)
+        videoInstanceUpdated.Tags = tagInstances
       }
 
-      const json = videoInstance.toUpdateRemoteJSON()
+      // Video channel update?
+      if (res.locals.videoChannel && videoInstanceUpdated.channelId !== res.locals.videoChannel.id) {
+        await videoInstanceUpdated.$set('VideoChannel', res.locals.videoChannel, { transaction: t })
+        videoInstance.VideoChannel = res.locals.videoChannel
+
+        if (wasPrivateVideo === false) await changeVideoChannelShare(videoInstanceUpdated, oldVideoChannel, t)
+      }
 
       // Now we'll update the video's meta data to our friends
-      return updateVideoToFriends(json, t)
+      if (wasPrivateVideo === false) await sendUpdateVideo(videoInstanceUpdated, t)
+
+      // Video is not private anymore, send a create action to remote servers
+      if (wasPrivateVideo === true && videoInstanceUpdated.privacy !== VideoPrivacy.PRIVATE) {
+        await sendCreateVideo(videoInstanceUpdated, t)
+        await shareVideoByServerAndChannel(videoInstanceUpdated, t)
+      }
     })
 
     logger.info('Video with name %s and uuid %s updated.', videoInstance.name, videoInstance.uuid)
@@ -307,31 +372,27 @@ async function updateVideo (req: express.Request, res: express.Response) {
 function getVideo (req: express.Request, res: express.Response) {
   const videoInstance = res.locals.video
 
-  if (videoInstance.isOwned()) {
-    // The increment is done directly in the database, not using the instance value
-    // FIXME: make a real view system
-    // For example, only add a view when a user watch a video during 30s etc
-    videoInstance.increment('views')
-      .then(() => {
-        const qaduParams = {
-          videoId: videoInstance.id,
-          type: REQUEST_VIDEO_QADU_TYPES.VIEWS
-        }
-        return quickAndDirtyUpdateVideoToFriends(qaduParams)
-      })
-      .catch(err => logger.error('Cannot add view to video %s.', videoInstance.uuid, err))
-  } else {
-    // Just send the event to our friends
-    const eventParams = {
-      videoId: videoInstance.id,
-      type: REQUEST_VIDEO_EVENT_TYPES.VIEWS
-    }
-    addEventToRemoteVideo(eventParams)
-      .catch(err => logger.error('Cannot add event to remote video %s.', videoInstance.uuid, err))
+  return res.json(videoInstance.toFormattedDetailsJSON())
+}
+
+async function viewVideo (req: express.Request, res: express.Response) {
+  const videoInstance = res.locals.video
+
+  const ip = req.ip
+  const exists = await Redis.Instance.isViewExists(ip, videoInstance.uuid)
+  if (exists) {
+    logger.debug('View for ip %s and video %s already exists.', ip, videoInstance.uuid)
+    return res.status(204).end()
   }
 
-  // Do not wait the view system
-  return res.json(videoInstance.toFormattedDetailsJSON())
+  await videoInstance.increment('views')
+  await Redis.Instance.setView(ip, videoInstance.uuid)
+
+  const serverAccount = await getServerActor()
+
+  await sendCreateView(serverAccount, videoInstance, undefined)
+
+  return res.status(204).end()
 }
 
 async function getVideoDescription (req: express.Request, res: express.Response) {
@@ -341,14 +402,21 @@ async function getVideoDescription (req: express.Request, res: express.Response)
   if (videoInstance.isOwned()) {
     description = videoInstance.description
   } else {
-    description = await fetchRemoteDescription(videoInstance)
+    description = await fetchRemoteVideoDescription(videoInstance)
   }
 
   return res.json({ description })
 }
 
 async function listVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
-  const resultList = await db.Video.listForApi(req.query.start, req.query.count, req.query.sort)
+  const resultList = await VideoModel.listForApi({
+    start: req.query.start,
+    count: req.query.count,
+    sort: req.query.sort,
+    hideNSFW: isNSFWHidden(res),
+    filter: req.query.filter as VideoFilter,
+    withFiles: false
+  })
 
   return res.json(getFormattedObjects(resultList.data, resultList.total))
 }
@@ -365,9 +433,9 @@ async function removeVideoRetryWrapper (req: express.Request, res: express.Respo
 }
 
 async function removeVideo (req: express.Request, res: express.Response) {
-  const videoInstance: VideoInstance = res.locals.video
+  const videoInstance: VideoModel = res.locals.video
 
-  await db.sequelize.transaction(async t => {
+  await sequelizeTypescript.transaction(async t => {
     await videoInstance.destroy({ transaction: t })
   })
 
@@ -375,12 +443,12 @@ async function removeVideo (req: express.Request, res: express.Response) {
 }
 
 async function searchVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
-  const resultList = await db.Video.searchAndPopulateAuthorAndPodAndTags(
-    req.params.value,
-    req.query.field,
-    req.query.start,
-    req.query.count,
-    req.query.sort
+  const resultList = await VideoModel.searchAndPopulateAccountAndServer(
+    req.query.search as string,
+    req.query.start as number,
+    req.query.count as number,
+    req.query.sort as VideoSortField,
+    isNSFWHidden(res)
   )
 
   return res.json(getFormattedObjects(resultList.data, resultList.total))