server/controllers/api/videos/index.ts

   1 import * as express from 'express'
   2 import * as multer from 'multer'
   3 import { extname, join } from 'path'
   4 import { VideoCreate, VideoPrivacy, VideoUpdate } from '../../../../shared'
   5 import {
   6   fetchRemoteVideoDescription,
   7   generateRandomString,
   8   getFormattedObjects,
   9   getVideoFileHeight,
  10   logger,
  11   renamePromise,
  12   resetSequelizeInstance,
  13   retryTransactionWrapper
  14 } from '../../../helpers'
  15 import { getActivityPubUrl, shareVideoByServer } from '../../../helpers/activitypub'
  16 import { CONFIG, VIDEO_CATEGORIES, VIDEO_LANGUAGES, VIDEO_LICENCES, VIDEO_MIMETYPE_EXT, VIDEO_PRIVACIES } from '../../../initializers'
  17 import { database as db } from '../../../initializers/database'
  18 import { sendAddVideo, sendUpdateVideo } from '../../../lib/activitypub/send-request'
  19 import { transcodingJobScheduler } from '../../../lib/jobs/transcoding-job-scheduler/transcoding-job-scheduler'
  20 import {
  21   asyncMiddleware,
  22   authenticate,
  23   paginationValidator,
  24   setPagination,
  25   setVideosSearch,
  26   setVideosSort,
  27   videosAddValidator,
  28   videosGetValidator,
  29   videosRemoveValidator,
  30   videosSearchValidator,
  31   videosSortValidator,
  32   videosUpdateValidator
  33 } from '../../../middlewares'
  34 import { VideoInstance } from '../../../models'
  35 import { abuseVideoRouter } from './abuse'
  36 import { blacklistRouter } from './blacklist'
  37 import { videoChannelRouter } from './channel'
  38 import { rateVideoRouter } from './rate'
  39
  40 const videosRouter = express.Router()
  41
  42 // multer configuration
  43 const storage = multer.diskStorage({
  44   destination: (req, file, cb) => {
  45     cb(null, CONFIG.STORAGE.VIDEOS_DIR)
  46   },
  47
  48   filename: async (req, file, cb) => {
  49     const extension = VIDEO_MIMETYPE_EXT[file.mimetype]
  50     let randomString = ''
  51
  52     try {
  53       randomString = await generateRandomString(16)
  54     } catch (err) {
  55       logger.error('Cannot generate random string for file name.', err)
  56       randomString = 'fake-random-string'
  57     }
  58
  59     cb(null, randomString + extension)
  60   }
  61 })
  62
  63 const reqFiles = multer({ storage: storage }).fields([{ name: 'videofile', maxCount: 1 }])
  64
  65 videosRouter.use('/', abuseVideoRouter)
  66 videosRouter.use('/', blacklistRouter)
  67 videosRouter.use('/', rateVideoRouter)
  68 videosRouter.use('/', videoChannelRouter)
  69
  70 videosRouter.get('/categories', listVideoCategories)
  71 videosRouter.get('/licences', listVideoLicences)
  72 videosRouter.get('/languages', listVideoLanguages)
  73 videosRouter.get('/privacies', listVideoPrivacies)
  74
  75 videosRouter.get('/',
  76   paginationValidator,
  77   videosSortValidator,
  78   setVideosSort,
  79   setPagination,
  80   asyncMiddleware(listVideos)
  81 )
  82 videosRouter.put('/:id',
  83   authenticate,
  84   videosUpdateValidator,
  85   asyncMiddleware(updateVideoRetryWrapper)
  86 )
  87 videosRouter.post('/upload',
  88   authenticate,
  89   reqFiles,
  90   videosAddValidator,
  91   asyncMiddleware(addVideoRetryWrapper)
  92 )
  93
  94 videosRouter.get('/:id/description',
  95   videosGetValidator,
  96   asyncMiddleware(getVideoDescription)
  97 )
  98 videosRouter.get('/:id',
  99   videosGetValidator,
 100   getVideo
 101 )
 102
 103 videosRouter.delete('/:id',
 104   authenticate,
 105   videosRemoveValidator,
 106   asyncMiddleware(removeVideoRetryWrapper)
 107 )
 108
 109 videosRouter.get('/search/:value',
 110   videosSearchValidator,
 111   paginationValidator,
 112   videosSortValidator,
 113   setVideosSort,
 114   setPagination,
 115   setVideosSearch,
 116   asyncMiddleware(searchVideos)
 117 )
 118
 119 // ---------------------------------------------------------------------------
 120
 121 export {
 122   videosRouter
 123 }
 124
 125 // ---------------------------------------------------------------------------
 126
 127 function listVideoCategories (req: express.Request, res: express.Response) {
 128   res.json(VIDEO_CATEGORIES)
 129 }
 130
 131 function listVideoLicences (req: express.Request, res: express.Response) {
 132   res.json(VIDEO_LICENCES)
 133 }
 134
 135 function listVideoLanguages (req: express.Request, res: express.Response) {
 136   res.json(VIDEO_LANGUAGES)
 137 }
 138
 139 function listVideoPrivacies (req: express.Request, res: express.Response) {
 140   res.json(VIDEO_PRIVACIES)
 141 }
 142
 143 // Wrapper to video add that retry the function if there is a database error
 144 // We need this because we run the transaction in SERIALIZABLE isolation that can fail
 145 async function addVideoRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
 146   const options = {
 147     arguments: [ req, res, req.files['videofile'][0] ],
 148     errorMessage: 'Cannot insert the video with many retries.'
 149   }
 150
 151   await retryTransactionWrapper(addVideo, options)
 152
 153   // TODO : include Location of the new video -> 201
 154   res.type('json').status(204).end()
 155 }
 156
 157 async function addVideo (req: express.Request, res: express.Response, videoPhysicalFile: Express.Multer.File) {
 158   const videoInfo: VideoCreate = req.body
 159   let videoUUID = ''
 160
 161   await db.sequelize.transaction(async t => {
 162     const sequelizeOptions = { transaction: t }
 163
 164     const videoData = {
 165       name: videoInfo.name,
 166       remote: false,
 167       extname: extname(videoPhysicalFile.filename),
 168       category: videoInfo.category,
 169       licence: videoInfo.licence,
 170       language: videoInfo.language,
 171       nsfw: videoInfo.nsfw,
 172       description: videoInfo.description,
 173       privacy: videoInfo.privacy,
 174       duration: videoPhysicalFile['duration'], // duration was added by a previous middleware
 175       channelId: res.locals.videoChannel.id
 176     }
 177     const video = db.Video.build(videoData)
 178     video.url = getActivityPubUrl('video', video.uuid)
 179
 180     const videoFilePath = join(CONFIG.STORAGE.VIDEOS_DIR, videoPhysicalFile.filename)
 181     const videoFileHeight = await getVideoFileHeight(videoFilePath)
 182
 183     const videoFileData = {
 184       extname: extname(videoPhysicalFile.filename),
 185       resolution: videoFileHeight,
 186       size: videoPhysicalFile.size
 187     }
 188     const videoFile = db.VideoFile.build(videoFileData)
 189     const videoDir = CONFIG.STORAGE.VIDEOS_DIR
 190     const source = join(videoDir, videoPhysicalFile.filename)
 191     const destination = join(videoDir, video.getVideoFilename(videoFile))
 192
 193     await renamePromise(source, destination)
 194     // This is important in case if there is another attempt in the retry process
 195     videoPhysicalFile.filename = video.getVideoFilename(videoFile)
 196
 197     const tasks = []
 198
 199     tasks.push(
 200       video.createTorrentAndSetInfoHash(videoFile),
 201       video.createThumbnail(videoFile),
 202       video.createPreview(videoFile)
 203     )
 204
 205     if (CONFIG.TRANSCODING.ENABLED === true) {
 206       // Put uuid because we don't have id auto incremented for now
 207       const dataInput = {
 208         videoUUID: video.uuid
 209       }
 210
 211       tasks.push(
 212         transcodingJobScheduler.createJob(t, 'videoFileOptimizer', dataInput)
 213       )
 214     }
 215     await Promise.all(tasks)
 216
 217     const videoCreated = await video.save(sequelizeOptions)
 218     // Do not forget to add video channel information to the created video
 219     videoCreated.VideoChannel = res.locals.videoChannel
 220     videoUUID = videoCreated.uuid
 221
 222     videoFile.videoId = video.id
 223
 224     await videoFile.save(sequelizeOptions)
 225     video.VideoFiles = [videoFile]
 226
 227     if (videoInfo.tags) {
 228       const tagInstances = await db.Tag.findOrCreateTags(videoInfo.tags, t)
 229
 230       await video.setTags(tagInstances, sequelizeOptions)
 231       video.Tags = tagInstances
 232     }
 233
 234     // Let transcoding job send the video to friends because the video file extension might change
 235     if (CONFIG.TRANSCODING.ENABLED === true) return undefined
 236     // Don't send video to remote servers, it is private
 237     if (video.privacy === VideoPrivacy.PRIVATE) return undefined
 238
 239     await sendAddVideo(video, t)
 240     await shareVideoByServer(video, t)
 241   })
 242
 243   logger.info('Video with name %s and uuid %s created.', videoInfo.name, videoUUID)
 244 }
 245
 246 async function updateVideoRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
 247   const options = {
 248     arguments: [ req, res ],
 249     errorMessage: 'Cannot update the video with many retries.'
 250   }
 251
 252   await retryTransactionWrapper(updateVideo, options)
 253
 254   return res.type('json').status(204).end()
 255 }
 256
 257 async function updateVideo (req: express.Request, res: express.Response) {
 258   const videoInstance: VideoInstance = res.locals.video
 259   const videoFieldsSave = videoInstance.toJSON()
 260   const videoInfoToUpdate: VideoUpdate = req.body
 261   const wasPrivateVideo = videoInstance.privacy === VideoPrivacy.PRIVATE
 262
 263   try {
 264     await db.sequelize.transaction(async t => {
 265       const sequelizeOptions = {
 266         transaction: t
 267       }
 268
 269       if (videoInfoToUpdate.name !== undefined) videoInstance.set('name', videoInfoToUpdate.name)
 270       if (videoInfoToUpdate.category !== undefined) videoInstance.set('category', videoInfoToUpdate.category)
 271       if (videoInfoToUpdate.licence !== undefined) videoInstance.set('licence', videoInfoToUpdate.licence)
 272       if (videoInfoToUpdate.language !== undefined) videoInstance.set('language', videoInfoToUpdate.language)
 273       if (videoInfoToUpdate.nsfw !== undefined) videoInstance.set('nsfw', videoInfoToUpdate.nsfw)
 274       if (videoInfoToUpdate.privacy !== undefined) videoInstance.set('privacy', videoInfoToUpdate.privacy)
 275       if (videoInfoToUpdate.description !== undefined) videoInstance.set('description', videoInfoToUpdate.description)
 276
 277       await videoInstance.save(sequelizeOptions)
 278
 279       if (videoInfoToUpdate.tags) {
 280         const tagInstances = await db.Tag.findOrCreateTags(videoInfoToUpdate.tags, t)
 281
 282         await videoInstance.setTags(tagInstances, sequelizeOptions)
 283         videoInstance.Tags = tagInstances
 284       }
 285
 286       // Now we'll update the video's meta data to our friends
 287       if (wasPrivateVideo === false) {
 288         await sendUpdateVideo(videoInstance, t)
 289       }
 290
 291       // Video is not private anymore, send a create action to remote servers
 292       if (wasPrivateVideo === true && videoInstance.privacy !== VideoPrivacy.PRIVATE) {
 293         await sendAddVideo(videoInstance, t)
 294       }
 295     })
 296
 297     logger.info('Video with name %s and uuid %s updated.', videoInstance.name, videoInstance.uuid)
 298   } catch (err) {
 299     // Force fields we want to update
 300     // If the transaction is retried, sequelize will think the object has not changed
 301     // So it will skip the SQL request, even if the last one was ROLLBACKed!
 302     resetSequelizeInstance(videoInstance, videoFieldsSave)
 303
 304     throw err
 305   }
 306 }
 307
 308 async function getVideo (req: express.Request, res: express.Response) {
 309   const videoInstance = res.locals.video
 310
 311   if (videoInstance.isOwned()) {
 312     // The increment is done directly in the database, not using the instance value
 313     // FIXME: make a real view system
 314     // For example, only add a view when a user watch a video during 30s etc
 315     videoInstance.increment('views')
 316       .then(() => {
 317         // TODO: send to followers a notification
 318       })
 319       .catch(err => logger.error('Cannot add view to video %s.', videoInstance.uuid, err))
 320   } else {
 321     // TODO: send view event to followers
 322   }
 323
 324   // Do not wait the view system
 325   return res.json(videoInstance.toFormattedDetailsJSON())
 326 }
 327
 328 async function getVideoDescription (req: express.Request, res: express.Response) {
 329   const videoInstance = res.locals.video
 330   let description = ''
 331
 332   if (videoInstance.isOwned()) {
 333     description = videoInstance.description
 334   } else {
 335     description = await fetchRemoteVideoDescription(videoInstance)
 336   }
 337
 338   return res.json({ description })
 339 }
 340
 341 async function listVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
 342   const resultList = await db.Video.listForApi(req.query.start, req.query.count, req.query.sort)
 343
 344   return res.json(getFormattedObjects(resultList.data, resultList.total))
 345 }
 346
 347 async function removeVideoRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
 348   const options = {
 349     arguments: [ req, res ],
 350     errorMessage: 'Cannot remove the video with many retries.'
 351   }
 352
 353   await retryTransactionWrapper(removeVideo, options)
 354
 355   return res.type('json').status(204).end()
 356 }
 357
 358 async function removeVideo (req: express.Request, res: express.Response) {
 359   const videoInstance: VideoInstance = res.locals.video
 360
 361   await db.sequelize.transaction(async t => {
 362     await videoInstance.destroy({ transaction: t })
 363   })
 364
 365   logger.info('Video with name %s and uuid %s deleted.', videoInstance.name, videoInstance.uuid)
 366 }
 367
 368 async function searchVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
 369   const resultList = await db.Video.searchAndPopulateAccountAndServerAndTags(
 370     req.params.value,
 371     req.query.field,
 372     req.query.start,
 373     req.query.count,
 374     req.query.sort
 375   )
 376
 377   return res.json(getFormattedObjects(resultList.data, resultList.total))
 378 }