]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/controllers/api/videos/index.ts
Move activitypub functions from helpers/ to lib/
[github/Chocobozzz/PeerTube.git] / server / controllers / api / videos / index.ts
index b82b0936f13674fcae423411ebb73ec6a18053b2..0d114dcd2d37fcb983299faff9824ad96675fdfe 100644 (file)
@@ -1,68 +1,64 @@
 import * as express from 'express'
-import * as fs from 'fs'
 import * as multer from 'multer'
-import * as path from 'path'
-import { waterfall } from 'async'
-
-import { database as db } from '../../../initializers/database'
+import { extname, join } from 'path'
+import { VideoCreate, VideoPrivacy, VideoUpdate } from '../../../../shared'
 import {
-  CONFIG,
-  REQUEST_VIDEO_QADU_TYPES,
-  REQUEST_VIDEO_EVENT_TYPES,
-  VIDEO_CATEGORIES,
-  VIDEO_LICENCES,
-  VIDEO_LANGUAGES
-} from '../../../initializers'
-import {
-  addEventToRemoteVideo,
-  quickAndDirtyUpdateVideoToFriends,
-  addVideoToFriends,
-  updateVideoToFriends
-} from '../../../lib'
+  generateRandomString,
+  getFormattedObjects,
+  getVideoFileHeight,
+  logger,
+  renamePromise,
+  resetSequelizeInstance,
+  retryTransactionWrapper
+} from '../../../helpers'
+import { CONFIG, VIDEO_CATEGORIES, VIDEO_LANGUAGES, VIDEO_LICENCES, VIDEO_MIMETYPE_EXT, VIDEO_PRIVACIES } from '../../../initializers'
+import { database as db } from '../../../initializers/database'
+import { sendAddVideo } from '../../../lib/activitypub/send/send-add'
+import { sendUpdateVideo } from '../../../lib/activitypub/send/send-update'
+import { transcodingJobScheduler } from '../../../lib/jobs/transcoding-job-scheduler/transcoding-job-scheduler'
 import {
+  asyncMiddleware,
   authenticate,
   paginationValidator,
-  videosSortValidator,
-  setVideosSort,
   setPagination,
   setVideosSearch,
-  videosUpdateValidator,
-  videosSearchValidator,
+  setVideosSort,
   videosAddValidator,
   videosGetValidator,
-  videosRemoveValidator
+  videosRemoveValidator,
+  videosSearchValidator,
+  videosSortValidator,
+  videosUpdateValidator
 } from '../../../middlewares'
-import {
-  logger,
-  commitTransaction,
-  retryTransactionWrapper,
-  rollbackTransaction,
-  startSerializableTransaction,
-  generateRandomString,
-  getFormatedObjects
-} from '../../../helpers'
-
+import { VideoInstance } from '../../../models'
 import { abuseVideoRouter } from './abuse'
 import { blacklistRouter } from './blacklist'
+import { videoChannelRouter } from './channel'
 import { rateVideoRouter } from './rate'
+import { getVideoActivityPubUrl } from '../../../lib/activitypub/url'
+import { shareVideoByServer } from '../../../lib/activitypub/share'
+import { fetchRemoteVideoDescription } from '../../../lib/activitypub/videos'
 
 const videosRouter = express.Router()
 
 // multer configuration
 const storage = multer.diskStorage({
-  destination: function (req, file, cb) {
+  destination: (req, file, cb) => {
     cb(null, CONFIG.STORAGE.VIDEOS_DIR)
   },
 
-  filename: function (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, function (err, randomString) {
-      const fieldname = err ? undefined : randomString
-      cb(null, fieldname + '.' + extension)
-    })
+  filename: async (req, file, cb) => {
+    const extension = VIDEO_MIMETYPE_EXT[file.mimetype]
+    let randomString = ''
+
+    try {
+      randomString = await generateRandomString(16)
+    } catch (err) {
+      logger.error('Cannot generate random string for file name.', err)
+      randomString = 'fake-random-string'
+    }
+
+    cb(null, randomString + extension)
   }
 })
 
@@ -71,29 +67,35 @@ const reqFiles = multer({ storage: storage }).fields([{ name: 'videofile', maxCo
 videosRouter.use('/', abuseVideoRouter)
 videosRouter.use('/', blacklistRouter)
 videosRouter.use('/', rateVideoRouter)
+videosRouter.use('/', videoChannelRouter)
 
 videosRouter.get('/categories', listVideoCategories)
 videosRouter.get('/licences', listVideoLicences)
 videosRouter.get('/languages', listVideoLanguages)
+videosRouter.get('/privacies', listVideoPrivacies)
 
 videosRouter.get('/',
   paginationValidator,
   videosSortValidator,
   setVideosSort,
   setPagination,
-  listVideos
+  asyncMiddleware(listVideos)
 )
 videosRouter.put('/:id',
   authenticate,
-  reqFiles,
   videosUpdateValidator,
-  updateVideoRetryWrapper
+  asyncMiddleware(updateVideoRetryWrapper)
 )
-videosRouter.post('/',
+videosRouter.post('/upload',
   authenticate,
   reqFiles,
   videosAddValidator,
-  addVideoRetryWrapper
+  asyncMiddleware(addVideoRetryWrapper)
+)
+
+videosRouter.get('/:id/description',
+  videosGetValidator,
+  asyncMiddleware(getVideoDescription)
 )
 videosRouter.get('/:id',
   videosGetValidator,
@@ -103,7 +105,7 @@ videosRouter.get('/:id',
 videosRouter.delete('/:id',
   authenticate,
   videosRemoveValidator,
-  removeVideo
+  asyncMiddleware(removeVideoRetryWrapper)
 )
 
 videosRouter.get('/search/:value',
@@ -113,7 +115,7 @@ videosRouter.get('/search/:value',
   setVideosSort,
   setPagination,
   setVideosSearch,
-  searchVideos
+  asyncMiddleware(searchVideos)
 )
 
 // ---------------------------------------------------------------------------
@@ -124,303 +126,256 @@ export {
 
 // ---------------------------------------------------------------------------
 
-function listVideoCategories (req, res, next) {
+function listVideoCategories (req: express.Request, res: express.Response) {
   res.json(VIDEO_CATEGORIES)
 }
 
-function listVideoLicences (req, res, next) {
+function listVideoLicences (req: express.Request, res: express.Response) {
   res.json(VIDEO_LICENCES)
 }
 
-function listVideoLanguages (req, res, next) {
+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
-function addVideoRetryWrapper (req, res, next) {
+async function addVideoRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
   const options = {
-    arguments: [ req, res, req.files.videofile[0] ],
+    arguments: [ req, res, req.files['videofile'][0] ],
     errorMessage: 'Cannot insert the video with many retries.'
   }
 
-  retryTransactionWrapper(addVideo, options, function (err) {
-    if (err) return next(err)
+  await retryTransactionWrapper(addVideo, options)
 
-    // TODO : include Location of the new video -> 201
-    return res.type('json').status(204).end()
-  })
+  // TODO : include Location of the new video -> 201
+  res.type('json').status(204).end()
 }
 
-function addVideo (req, res, videoFile, finalCallback) {
-  const videoInfos = req.body
-
-  waterfall([
-
-    startSerializableTransaction,
-
-    function findOrCreateAuthor (t, callback) {
-      const user = res.locals.oauth.token.User
-
-      const name = user.username
-      // null because it is OUR pod
-      const podId = null
-      const userId = user.id
-
-      db.Author.findOrCreateAuthor(name, podId, userId, t, function (err, authorInstance) {
-        return callback(err, t, authorInstance)
-      })
-    },
+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 }
+
+    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,
+      privacy: videoInfo.privacy,
+      duration: videoPhysicalFile['duration'], // duration was added by a previous middleware
+      channelId: res.locals.videoChannel.id
+    }
+    const video = db.Video.build(videoData)
+    video.url = getVideoActivityPubUrl(video)
 
-    function findOrCreateTags (t, author, callback) {
-      const tags = videoInfos.tags
+    const videoFilePath = join(CONFIG.STORAGE.VIDEOS_DIR, videoPhysicalFile.filename)
+    const videoFileHeight = await getVideoFileHeight(videoFilePath)
 
-      db.Tag.findOrCreateTags(tags, t, function (err, tagInstances) {
-        return callback(err, t, author, tagInstances)
-      })
-    },
-
-    function createVideoObject (t, author, tagInstances, callback) {
-      const videoData = {
-        name: videoInfos.name,
-        remoteId: null,
-        extname: path.extname(videoFile.filename),
-        category: videoInfos.category,
-        licence: videoInfos.licence,
-        language: videoInfos.language,
-        nsfw: videoInfos.nsfw,
-        description: videoInfos.description,
-        duration: videoFile.duration,
-        authorId: author.id
+    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
       }
 
-      const video = db.Video.build(videoData)
-
-      return callback(null, t, author, tagInstances, video)
-    },
-
-     // Set the videoname the same as the id
-    function renameVideoFile (t, author, tagInstances, video, callback) {
-      const videoDir = CONFIG.STORAGE.VIDEOS_DIR
-      const source = path.join(videoDir, videoFile.filename)
-      const destination = path.join(videoDir, video.getVideoFilename())
-
-      fs.rename(source, destination, function (err) {
-        if (err) return callback(err)
-
-        // This is important in case if there is another attempt
-        videoFile.filename = video.getVideoFilename()
-        return callback(null, t, author, tagInstances, video)
-      })
-    },
-
-    function insertVideoIntoDB (t, author, tagInstances, video, callback) {
-      const options = { transaction: t }
-
-      // Add tags association
-      video.save(options).asCallback(function (err, videoCreated) {
-        if (err) return callback(err)
-
-        // Do not forget to add Author informations to the created video
-        videoCreated.Author = author
-
-        return callback(err, t, tagInstances, videoCreated)
-      })
-    },
-
-    function associateTagsToVideo (t, tagInstances, video, callback) {
-      const options = { transaction: t }
-
-      video.setTags(tagInstances, options).asCallback(function (err) {
-        video.Tags = tagInstances
+      tasks.push(
+        transcodingJobScheduler.createJob(t, 'videoFileOptimizer', dataInput)
+      )
+    }
+    await Promise.all(tasks)
 
-        return callback(err, t, video)
-      })
-    },
+    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
 
-    function sendToFriends (t, video, callback) {
-      // Let transcoding job send the video to friends because the videofile extension might change
-      if (CONFIG.TRANSCODING.ENABLED === true) return callback(null, t)
+    videoFile.videoId = video.id
 
-      video.toAddRemoteJSON(function (err, remoteVideo) {
-        if (err) return callback(err)
+    await videoFile.save(sequelizeOptions)
+    video.VideoFiles = [videoFile]
 
-        // Now we'll add the video's meta data to our friends
-        addVideoToFriends(remoteVideo, t, function (err) {
-          return callback(err, t)
-        })
-      })
-    },
+    if (videoInfo.tags) {
+      const tagInstances = await db.Tag.findOrCreateTags(videoInfo.tags, t)
 
-    commitTransaction
-
-  ], function andFinally (err, t) {
-    if (err) {
-      // This is just a debug because we will retry the insert
-      logger.debug('Cannot insert the video.', { error: err })
-      return rollbackTransaction(err, t, finalCallback)
+      await video.setTags(tagInstances, sequelizeOptions)
+      video.Tags = tagInstances
     }
 
-    logger.info('Video with name %s created.', videoInfos.name)
-    return finalCallback(null)
+    // Let transcoding job send the video to friends because the video file extension might change
+    if (CONFIG.TRANSCODING.ENABLED === true) return undefined
+    // Don't send video to remote servers, it is private
+    if (video.privacy === VideoPrivacy.PRIVATE) return undefined
+
+    await sendAddVideo(video, t)
+    await shareVideoByServer(video, t)
   })
+
+  logger.info('Video with name %s and uuid %s created.', videoInfo.name, videoUUID)
 }
 
-function updateVideoRetryWrapper (req, res, next) {
+async function updateVideoRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
   const options = {
     arguments: [ req, res ],
     errorMessage: 'Cannot update the video with many retries.'
   }
 
-  retryTransactionWrapper(updateVideo, options, function (err) {
-    if (err) return next(err)
+  await retryTransactionWrapper(updateVideo, options)
 
-    // TODO : include Location of the new video -> 201
-    return res.type('json').status(204).end()
-  })
+  return res.type('json').status(204).end()
 }
 
-function updateVideo (req, res, finalCallback) {
-  const videoInstance = res.locals.video
+async function updateVideo (req: express.Request, res: express.Response) {
+  const videoInstance: VideoInstance = res.locals.video
   const videoFieldsSave = videoInstance.toJSON()
-  const videoInfosToUpdate = req.body
-
-  waterfall([
-
-    startSerializableTransaction,
-
-    function findOrCreateTags (t, callback) {
-      if (videoInfosToUpdate.tags) {
-        db.Tag.findOrCreateTags(videoInfosToUpdate.tags, t, function (err, tagInstances) {
-          return callback(err, t, tagInstances)
-        })
-      } else {
-        return callback(null, t, null)
-      }
-    },
+  const videoInfoToUpdate: VideoUpdate = req.body
+  const wasPrivateVideo = videoInstance.privacy === VideoPrivacy.PRIVATE
 
-    function updateVideoIntoDB (t, tagInstances, callback) {
-      const options = {
+  try {
+    await db.sequelize.transaction(async t => {
+      const sequelizeOptions = {
         transaction: t
       }
 
-      if (videoInfosToUpdate.name !== undefined) videoInstance.set('name', videoInfosToUpdate.name)
-      if (videoInfosToUpdate.category !== undefined) videoInstance.set('category', videoInfosToUpdate.category)
-      if (videoInfosToUpdate.licence !== undefined) videoInstance.set('licence', videoInfosToUpdate.licence)
-      if (videoInfosToUpdate.language !== undefined) videoInstance.set('language', videoInfosToUpdate.language)
-      if (videoInfosToUpdate.nsfw !== undefined) videoInstance.set('nsfw', videoInfosToUpdate.nsfw)
-      if (videoInfosToUpdate.description !== undefined) videoInstance.set('description', videoInfosToUpdate.description)
+      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.privacy !== undefined) videoInstance.set('privacy', videoInfoToUpdate.privacy)
+      if (videoInfoToUpdate.description !== undefined) videoInstance.set('description', videoInfoToUpdate.description)
 
-      videoInstance.save(options).asCallback(function (err) {
-        return callback(err, t, tagInstances)
-      })
-    },
+      const videoInstanceUpdated = await videoInstance.save(sequelizeOptions)
 
-    function associateTagsToVideo (t, tagInstances, callback) {
-      if (tagInstances) {
-        const options = { transaction: t }
+      if (videoInfoToUpdate.tags) {
+        const tagInstances = await db.Tag.findOrCreateTags(videoInfoToUpdate.tags, t)
 
-        videoInstance.setTags(tagInstances, options).asCallback(function (err) {
-          videoInstance.Tags = tagInstances
+        await videoInstance.setTags(tagInstances, sequelizeOptions)
+        videoInstance.Tags = tagInstances
+      }
 
-          return callback(err, t)
-        })
-      } else {
-        return callback(null, t)
+      // Now we'll update the video's meta data to our friends
+      if (wasPrivateVideo === false) {
+        await sendUpdateVideo(videoInstanceUpdated, t)
       }
-    },
 
-    function sendToFriends (t, callback) {
-      const json = videoInstance.toUpdateRemoteJSON()
+      // Video is not private anymore, send a create action to remote servers
+      if (wasPrivateVideo === true && videoInstance.privacy !== VideoPrivacy.PRIVATE) {
+        await sendAddVideo(videoInstance, t)
+        await shareVideoByServer(videoInstance, t)
+      }
+    })
 
-      // Now we'll update the video's meta data to our friends
-      updateVideoToFriends(json, t, function (err) {
-        return callback(err, t)
-      })
-    },
+    logger.info('Video with name %s and uuid %s updated.', videoInstance.name, videoInstance.uuid)
+  } catch (err) {
+    // Force fields we want to update
+    // If the transaction is retried, sequelize will think the object has not changed
+    // So it will skip the SQL request, even if the last one was ROLLBACKed!
+    resetSequelizeInstance(videoInstance, videoFieldsSave)
 
-    commitTransaction
+    throw err
+  }
+}
 
-  ], function andFinally (err, t) {
-    if (err) {
-      logger.debug('Cannot update the video.', { error: err })
+async function getVideo (req: express.Request, res: express.Response) {
+  const videoInstance = res.locals.video
 
-      // Force fields we want to update
-      // If the transaction is retried, sequelize will think the object has not changed
-      // So it will skip the SQL request, even if the last one was ROLLBACKed!
-      Object.keys(videoFieldsSave).forEach(function (key) {
-        const value = videoFieldsSave[key]
-        videoInstance.set(key, value)
+  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(() => {
+        // TODO: send to followers a notification
       })
+      .catch(err => logger.error('Cannot add view to video %s.', videoInstance.uuid, err))
+  } else {
+    // TODO: send view event to followers
+  }
 
-      return rollbackTransaction(err, t, finalCallback)
-    }
-
-    logger.info('Video with name %s updated.', videoInfosToUpdate.name)
-    return finalCallback(null)
-  })
+  // Do not wait the view system
+  return res.json(videoInstance.toFormattedDetailsJSON())
 }
 
-function getVideo (req, res, next) {
+async function getVideoDescription (req: express.Request, res: express.Response) {
   const videoInstance = res.locals.video
+  let description = ''
 
   if (videoInstance.isOwned()) {
-    // The increment is done directly in the database, not using the instance value
-    videoInstance.increment('views').asCallback(function (err) {
-      if (err) {
-        logger.error('Cannot add view to video %d.', videoInstance.id)
-        return
-      }
-
-      // FIXME: make a real view system
-      // For example, only add a view when a user watch a video during 30s etc
-      const qaduParams = {
-        videoId: videoInstance.id,
-        type: REQUEST_VIDEO_QADU_TYPES.VIEWS
-      }
-      quickAndDirtyUpdateVideoToFriends(qaduParams)
-    })
+    description = videoInstance.description
   } else {
-    // Just send the event to our friends
-    const eventParams = {
-      videoId: videoInstance.id,
-      type: REQUEST_VIDEO_EVENT_TYPES.VIEWS
-    }
-    addEventToRemoteVideo(eventParams)
+    description = await fetchRemoteVideoDescription(videoInstance)
   }
 
-  // Do not wait the view system
-  res.json(videoInstance.toFormatedJSON())
+  return res.json({ description })
 }
 
-function listVideos (req, res, next) {
-  db.Video.listForApi(req.query.start, req.query.count, req.query.sort, function (err, videosList, videosTotal) {
-    if (err) return next(err)
+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)
 
-    res.json(getFormatedObjects(videosList, videosTotal))
-  })
+  return res.json(getFormattedObjects(resultList.data, resultList.total))
 }
 
-function removeVideo (req, res, next) {
-  const videoInstance = res.locals.video
+async function removeVideoRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
+  const options = {
+    arguments: [ req, res ],
+    errorMessage: 'Cannot remove the video with many retries.'
+  }
 
-  videoInstance.destroy().asCallback(function (err) {
-    if (err) {
-      logger.error('Errors when removed the video.', { error: err })
-      return next(err)
-    }
+  await retryTransactionWrapper(removeVideo, options)
 
-    return res.type('json').status(204).end()
-  })
+  return res.type('json').status(204).end()
 }
 
-function searchVideos (req, res, next) {
-  db.Video.searchAndPopulateAuthorAndPodAndTags(
-    req.params.value, req.query.field, req.query.start, req.query.count, req.query.sort,
-    function (err, videosList, videosTotal) {
-      if (err) return next(err)
+async function removeVideo (req: express.Request, res: express.Response) {
+  const videoInstance: VideoInstance = res.locals.video
 
-      res.json(getFormatedObjects(videosList, videosTotal))
-    }
+  await db.sequelize.transaction(async t => {
+    await videoInstance.destroy({ transaction: t })
+  })
+
+  logger.info('Video with name %s and uuid %s deleted.', videoInstance.name, videoInstance.uuid)
+}
+
+async function searchVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
+  const resultList = await db.Video.searchAndPopulateAccountAndServerAndTags(
+    req.params.value,
+    req.query.field,
+    req.query.start,
+    req.query.count,
+    req.query.sort
   )
+
+  return res.json(getFormattedObjects(resultList.data, resultList.total))
 }