server/controllers/api/video-playlist.ts

   1 import * as express from 'express'
   2 import { join } from 'path'
   3 import { getServerActor } from '@server/models/application/application'
   4 import { MVideoPlaylistFull, MVideoPlaylistThumbnail, MVideoThumbnail } from '@server/types/models'
   5 import { VideoPlaylistCreate } from '../../../shared/models/videos/playlist/video-playlist-create.model'
   6 import { VideoPlaylistElementCreate } from '../../../shared/models/videos/playlist/video-playlist-element-create.model'
   7 import { VideoPlaylistElementUpdate } from '../../../shared/models/videos/playlist/video-playlist-element-update.model'
   8 import { VideoPlaylistPrivacy } from '../../../shared/models/videos/playlist/video-playlist-privacy.model'
   9 import { VideoPlaylistReorder } from '../../../shared/models/videos/playlist/video-playlist-reorder.model'
  10 import { VideoPlaylistUpdate } from '../../../shared/models/videos/playlist/video-playlist-update.model'
  11 import { resetSequelizeInstance } from '../../helpers/database-utils'
  12 import { buildNSFWFilter, createReqFiles } from '../../helpers/express-utils'
  13 import { logger } from '../../helpers/logger'
  14 import { getFormattedObjects } from '../../helpers/utils'
  15 import { CONFIG } from '../../initializers/config'
  16 import { MIMETYPES, VIDEO_PLAYLIST_PRIVACIES } from '../../initializers/constants'
  17 import { sequelizeTypescript } from '../../initializers/database'
  18 import { sendCreateVideoPlaylist, sendDeleteVideoPlaylist, sendUpdateVideoPlaylist } from '../../lib/activitypub/send'
  19 import { getLocalVideoPlaylistActivityPubUrl, getLocalVideoPlaylistElementActivityPubUrl } from '../../lib/activitypub/url'
  20 import { JobQueue } from '../../lib/job-queue'
  21 import { createPlaylistMiniatureFromExisting } from '../../lib/thumbnail'
  22 import {
  23   asyncMiddleware,
  24   asyncRetryTransactionMiddleware,
  25   authenticate,
  26   optionalAuthenticate,
  27   paginationValidator,
  28   setDefaultPagination,
  29   setDefaultSort
  30 } from '../../middlewares'
  31 import { videoPlaylistsSortValidator } from '../../middlewares/validators'
  32 import {
  33   commonVideoPlaylistFiltersValidator,
  34   videoPlaylistsAddValidator,
  35   videoPlaylistsAddVideoValidator,
  36   videoPlaylistsDeleteValidator,
  37   videoPlaylistsGetValidator,
  38   videoPlaylistsReorderVideosValidator,
  39   videoPlaylistsUpdateOrRemoveVideoValidator,
  40   videoPlaylistsUpdateValidator
  41 } from '../../middlewares/validators/videos/video-playlists'
  42 import { AccountModel } from '../../models/account/account'
  43 import { VideoPlaylistModel } from '../../models/video/video-playlist'
  44 import { VideoPlaylistElementModel } from '../../models/video/video-playlist-element'
  45 import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes'
  46
  47 const reqThumbnailFile = createReqFiles([ 'thumbnailfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT, { thumbnailfile: CONFIG.STORAGE.TMP_DIR })
  48
  49 const videoPlaylistRouter = express.Router()
  50
  51 videoPlaylistRouter.get('/privacies', listVideoPlaylistPrivacies)
  52
  53 videoPlaylistRouter.get('/',
  54   paginationValidator,
  55   videoPlaylistsSortValidator,
  56   setDefaultSort,
  57   setDefaultPagination,
  58   commonVideoPlaylistFiltersValidator,
  59   asyncMiddleware(listVideoPlaylists)
  60 )
  61
  62 videoPlaylistRouter.get('/:playlistId',
  63   asyncMiddleware(videoPlaylistsGetValidator('summary')),
  64   getVideoPlaylist
  65 )
  66
  67 videoPlaylistRouter.post('/',
  68   authenticate,
  69   reqThumbnailFile,
  70   asyncMiddleware(videoPlaylistsAddValidator),
  71   asyncRetryTransactionMiddleware(addVideoPlaylist)
  72 )
  73
  74 videoPlaylistRouter.put('/:playlistId',
  75   authenticate,
  76   reqThumbnailFile,
  77   asyncMiddleware(videoPlaylistsUpdateValidator),
  78   asyncRetryTransactionMiddleware(updateVideoPlaylist)
  79 )
  80
  81 videoPlaylistRouter.delete('/:playlistId',
  82   authenticate,
  83   asyncMiddleware(videoPlaylistsDeleteValidator),
  84   asyncRetryTransactionMiddleware(removeVideoPlaylist)
  85 )
  86
  87 videoPlaylistRouter.get('/:playlistId/videos',
  88   asyncMiddleware(videoPlaylistsGetValidator('summary')),
  89   paginationValidator,
  90   setDefaultPagination,
  91   optionalAuthenticate,
  92   asyncMiddleware(getVideoPlaylistVideos)
  93 )
  94
  95 videoPlaylistRouter.post('/:playlistId/videos',
  96   authenticate,
  97   asyncMiddleware(videoPlaylistsAddVideoValidator),
  98   asyncRetryTransactionMiddleware(addVideoInPlaylist)
  99 )
 100
 101 videoPlaylistRouter.post('/:playlistId/videos/reorder',
 102   authenticate,
 103   asyncMiddleware(videoPlaylistsReorderVideosValidator),
 104   asyncRetryTransactionMiddleware(reorderVideosPlaylist)
 105 )
 106
 107 videoPlaylistRouter.put('/:playlistId/videos/:playlistElementId',
 108   authenticate,
 109   asyncMiddleware(videoPlaylistsUpdateOrRemoveVideoValidator),
 110   asyncRetryTransactionMiddleware(updateVideoPlaylistElement)
 111 )
 112
 113 videoPlaylistRouter.delete('/:playlistId/videos/:playlistElementId',
 114   authenticate,
 115   asyncMiddleware(videoPlaylistsUpdateOrRemoveVideoValidator),
 116   asyncRetryTransactionMiddleware(removeVideoFromPlaylist)
 117 )
 118
 119 // ---------------------------------------------------------------------------
 120
 121 export {
 122   videoPlaylistRouter
 123 }
 124
 125 // ---------------------------------------------------------------------------
 126
 127 function listVideoPlaylistPrivacies (req: express.Request, res: express.Response) {
 128   res.json(VIDEO_PLAYLIST_PRIVACIES)
 129 }
 130
 131 async function listVideoPlaylists (req: express.Request, res: express.Response) {
 132   const serverActor = await getServerActor()
 133   const resultList = await VideoPlaylistModel.listForApi({
 134     followerActorId: serverActor.id,
 135     start: req.query.start,
 136     count: req.query.count,
 137     sort: req.query.sort,
 138     type: req.query.type
 139   })
 140
 141   return res.json(getFormattedObjects(resultList.data, resultList.total))
 142 }
 143
 144 function getVideoPlaylist (req: express.Request, res: express.Response) {
 145   const videoPlaylist = res.locals.videoPlaylistSummary
 146
 147   if (videoPlaylist.isOutdated()) {
 148     JobQueue.Instance.createJob({ type: 'activitypub-refresher', payload: { type: 'video-playlist', url: videoPlaylist.url } })
 149   }
 150
 151   return res.json(videoPlaylist.toFormattedJSON())
 152 }
 153
 154 async function addVideoPlaylist (req: express.Request, res: express.Response) {
 155   const videoPlaylistInfo: VideoPlaylistCreate = req.body
 156   const user = res.locals.oauth.token.User
 157
 158   const videoPlaylist = new VideoPlaylistModel({
 159     name: videoPlaylistInfo.displayName,
 160     description: videoPlaylistInfo.description,
 161     privacy: videoPlaylistInfo.privacy || VideoPlaylistPrivacy.PRIVATE,
 162     ownerAccountId: user.Account.id
 163   }) as MVideoPlaylistFull
 164
 165   videoPlaylist.url = getLocalVideoPlaylistActivityPubUrl(videoPlaylist) // We use the UUID, so set the URL after building the object
 166
 167   if (videoPlaylistInfo.videoChannelId) {
 168     const videoChannel = res.locals.videoChannel
 169
 170     videoPlaylist.videoChannelId = videoChannel.id
 171     videoPlaylist.VideoChannel = videoChannel
 172   }
 173
 174   const thumbnailField = req.files['thumbnailfile']
 175   const thumbnailModel = thumbnailField
 176     ? await createPlaylistMiniatureFromExisting({
 177       inputPath: thumbnailField[0].path,
 178       playlist: videoPlaylist,
 179       automaticallyGenerated: false
 180     })
 181     : undefined
 182
 183   const videoPlaylistCreated = await sequelizeTypescript.transaction(async t => {
 184     const videoPlaylistCreated = await videoPlaylist.save({ transaction: t }) as MVideoPlaylistFull
 185
 186     if (thumbnailModel) {
 187       thumbnailModel.automaticallyGenerated = false
 188       await videoPlaylistCreated.setAndSaveThumbnail(thumbnailModel, t)
 189     }
 190
 191     // We need more attributes for the federation
 192     videoPlaylistCreated.OwnerAccount = await AccountModel.load(user.Account.id, t)
 193     await sendCreateVideoPlaylist(videoPlaylistCreated, t)
 194
 195     return videoPlaylistCreated
 196   })
 197
 198   logger.info('Video playlist with uuid %s created.', videoPlaylist.uuid)
 199
 200   return res.json({
 201     videoPlaylist: {
 202       id: videoPlaylistCreated.id,
 203       uuid: videoPlaylistCreated.uuid
 204     }
 205   })
 206 }
 207
 208 async function updateVideoPlaylist (req: express.Request, res: express.Response) {
 209   const videoPlaylistInstance = res.locals.videoPlaylistFull
 210   const videoPlaylistFieldsSave = videoPlaylistInstance.toJSON()
 211   const videoPlaylistInfoToUpdate = req.body as VideoPlaylistUpdate
 212
 213   const wasPrivatePlaylist = videoPlaylistInstance.privacy === VideoPlaylistPrivacy.PRIVATE
 214   const wasNotPrivatePlaylist = videoPlaylistInstance.privacy !== VideoPlaylistPrivacy.PRIVATE
 215
 216   const thumbnailField = req.files['thumbnailfile']
 217   const thumbnailModel = thumbnailField
 218     ? await createPlaylistMiniatureFromExisting({
 219       inputPath: thumbnailField[0].path,
 220       playlist: videoPlaylistInstance,
 221       automaticallyGenerated: false
 222     })
 223     : undefined
 224
 225   try {
 226     await sequelizeTypescript.transaction(async t => {
 227       const sequelizeOptions = {
 228         transaction: t
 229       }
 230
 231       if (videoPlaylistInfoToUpdate.videoChannelId !== undefined) {
 232         if (videoPlaylistInfoToUpdate.videoChannelId === null) {
 233           videoPlaylistInstance.videoChannelId = null
 234         } else {
 235           const videoChannel = res.locals.videoChannel
 236
 237           videoPlaylistInstance.videoChannelId = videoChannel.id
 238           videoPlaylistInstance.VideoChannel = videoChannel
 239         }
 240       }
 241
 242       if (videoPlaylistInfoToUpdate.displayName !== undefined) videoPlaylistInstance.name = videoPlaylistInfoToUpdate.displayName
 243       if (videoPlaylistInfoToUpdate.description !== undefined) videoPlaylistInstance.description = videoPlaylistInfoToUpdate.description
 244
 245       if (videoPlaylistInfoToUpdate.privacy !== undefined) {
 246         videoPlaylistInstance.privacy = parseInt(videoPlaylistInfoToUpdate.privacy.toString(), 10)
 247
 248         if (wasNotPrivatePlaylist === true && videoPlaylistInstance.privacy === VideoPlaylistPrivacy.PRIVATE) {
 249           await sendDeleteVideoPlaylist(videoPlaylistInstance, t)
 250         }
 251       }
 252
 253       const playlistUpdated = await videoPlaylistInstance.save(sequelizeOptions)
 254
 255       if (thumbnailModel) {
 256         thumbnailModel.automaticallyGenerated = false
 257         await playlistUpdated.setAndSaveThumbnail(thumbnailModel, t)
 258       }
 259
 260       const isNewPlaylist = wasPrivatePlaylist && playlistUpdated.privacy !== VideoPlaylistPrivacy.PRIVATE
 261
 262       if (isNewPlaylist) {
 263         await sendCreateVideoPlaylist(playlistUpdated, t)
 264       } else {
 265         await sendUpdateVideoPlaylist(playlistUpdated, t)
 266       }
 267
 268       logger.info('Video playlist %s updated.', videoPlaylistInstance.uuid)
 269
 270       return playlistUpdated
 271     })
 272   } catch (err) {
 273     logger.debug('Cannot update the video playlist.', { err })
 274
 275     // Force fields we want to update
 276     // If the transaction is retried, sequelize will think the object has not changed
 277     // So it will skip the SQL request, even if the last one was ROLLBACKed!
 278     resetSequelizeInstance(videoPlaylistInstance, videoPlaylistFieldsSave)
 279
 280     throw err
 281   }
 282
 283   return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end()
 284 }
 285
 286 async function removeVideoPlaylist (req: express.Request, res: express.Response) {
 287   const videoPlaylistInstance = res.locals.videoPlaylistSummary
 288
 289   await sequelizeTypescript.transaction(async t => {
 290     await videoPlaylistInstance.destroy({ transaction: t })
 291
 292     await sendDeleteVideoPlaylist(videoPlaylistInstance, t)
 293
 294     logger.info('Video playlist %s deleted.', videoPlaylistInstance.uuid)
 295   })
 296
 297   return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end()
 298 }
 299
 300 async function addVideoInPlaylist (req: express.Request, res: express.Response) {
 301   const body: VideoPlaylistElementCreate = req.body
 302   const videoPlaylist = res.locals.videoPlaylistFull
 303   const video = res.locals.onlyVideo
 304
 305   const playlistElement = await sequelizeTypescript.transaction(async t => {
 306     const position = await VideoPlaylistElementModel.getNextPositionOf(videoPlaylist.id, t)
 307
 308     const playlistElement = await VideoPlaylistElementModel.create({
 309       position,
 310       startTimestamp: body.startTimestamp || null,
 311       stopTimestamp: body.stopTimestamp || null,
 312       videoPlaylistId: videoPlaylist.id,
 313       videoId: video.id
 314     }, { transaction: t })
 315
 316     playlistElement.url = getLocalVideoPlaylistElementActivityPubUrl(videoPlaylist, playlistElement)
 317     await playlistElement.save({ transaction: t })
 318
 319     videoPlaylist.changed('updatedAt', true)
 320     await videoPlaylist.save({ transaction: t })
 321
 322     return playlistElement
 323   })
 324
 325   // If the user did not set a thumbnail, automatically take the video thumbnail
 326   if (videoPlaylist.hasThumbnail() === false || (videoPlaylist.hasGeneratedThumbnail() && playlistElement.position === 1)) {
 327     await generateThumbnailForPlaylist(videoPlaylist, video)
 328   }
 329
 330   sendUpdateVideoPlaylist(videoPlaylist, undefined)
 331     .catch(err => logger.error('Cannot send video playlist update.', { err }))
 332
 333   logger.info('Video added in playlist %s at position %d.', videoPlaylist.uuid, playlistElement.position)
 334
 335   return res.json({
 336     videoPlaylistElement: {
 337       id: playlistElement.id
 338     }
 339   }).end()
 340 }
 341
 342 async function updateVideoPlaylistElement (req: express.Request, res: express.Response) {
 343   const body: VideoPlaylistElementUpdate = req.body
 344   const videoPlaylist = res.locals.videoPlaylistFull
 345   const videoPlaylistElement = res.locals.videoPlaylistElement
 346
 347   const playlistElement: VideoPlaylistElementModel = await sequelizeTypescript.transaction(async t => {
 348     if (body.startTimestamp !== undefined) videoPlaylistElement.startTimestamp = body.startTimestamp
 349     if (body.stopTimestamp !== undefined) videoPlaylistElement.stopTimestamp = body.stopTimestamp
 350
 351     const element = await videoPlaylistElement.save({ transaction: t })
 352
 353     videoPlaylist.changed('updatedAt', true)
 354     await videoPlaylist.save({ transaction: t })
 355
 356     await sendUpdateVideoPlaylist(videoPlaylist, t)
 357
 358     return element
 359   })
 360
 361   logger.info('Element of position %d of playlist %s updated.', playlistElement.position, videoPlaylist.uuid)
 362
 363   return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end()
 364 }
 365
 366 async function removeVideoFromPlaylist (req: express.Request, res: express.Response) {
 367   const videoPlaylistElement = res.locals.videoPlaylistElement
 368   const videoPlaylist = res.locals.videoPlaylistFull
 369   const positionToDelete = videoPlaylistElement.position
 370
 371   await sequelizeTypescript.transaction(async t => {
 372     await videoPlaylistElement.destroy({ transaction: t })
 373
 374     // Decrease position of the next elements
 375     await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, positionToDelete, null, -1, t)
 376
 377     videoPlaylist.changed('updatedAt', true)
 378     await videoPlaylist.save({ transaction: t })
 379
 380     logger.info('Video playlist element %d of playlist %s deleted.', videoPlaylistElement.position, videoPlaylist.uuid)
 381   })
 382
 383   // Do we need to regenerate the default thumbnail?
 384   if (positionToDelete === 1 && videoPlaylist.hasGeneratedThumbnail()) {
 385     await regeneratePlaylistThumbnail(videoPlaylist)
 386   }
 387
 388   sendUpdateVideoPlaylist(videoPlaylist, undefined)
 389     .catch(err => logger.error('Cannot send video playlist update.', { err }))
 390
 391   return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end()
 392 }
 393
 394 async function reorderVideosPlaylist (req: express.Request, res: express.Response) {
 395   const videoPlaylist = res.locals.videoPlaylistFull
 396   const body: VideoPlaylistReorder = req.body
 397
 398   const start: number = body.startPosition
 399   const insertAfter: number = body.insertAfterPosition
 400   const reorderLength: number = body.reorderLength || 1
 401
 402   if (start === insertAfter) {
 403     return res.status(HttpStatusCode.NO_CONTENT_204).end()
 404   }
 405
 406   // Example: if we reorder position 2 and insert after position 5 (so at position 6): # 1 2 3 4 5 6 7 8 9
 407   //  * increase position when position > 5 # 1 2 3 4 5 7 8 9 10
 408   //  * update position 2 -> position 6 # 1 3 4 5 6 7 8 9 10
 409   //  * decrease position when position position > 2 # 1 2 3 4 5 6 7 8 9
 410   await sequelizeTypescript.transaction(async t => {
 411     const newPosition = insertAfter + 1
 412
 413     // Add space after the position when we want to insert our reordered elements (increase)
 414     await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, newPosition, null, reorderLength, t)
 415
 416     let oldPosition = start
 417
 418     // We incremented the position of the elements we want to reorder
 419     if (start >= newPosition) oldPosition += reorderLength
 420
 421     const endOldPosition = oldPosition + reorderLength - 1
 422     // Insert our reordered elements in their place (update)
 423     await VideoPlaylistElementModel.reassignPositionOf(videoPlaylist.id, oldPosition, endOldPosition, newPosition, t)
 424
 425     // Decrease positions of elements after the old position of our ordered elements (decrease)
 426     await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, oldPosition, null, -reorderLength, t)
 427
 428     videoPlaylist.changed('updatedAt', true)
 429     await videoPlaylist.save({ transaction: t })
 430
 431     await sendUpdateVideoPlaylist(videoPlaylist, t)
 432   })
 433
 434   // The first element changed
 435   if ((start === 1 || insertAfter === 0) && videoPlaylist.hasGeneratedThumbnail()) {
 436     await regeneratePlaylistThumbnail(videoPlaylist)
 437   }
 438
 439   logger.info(
 440     'Reordered playlist %s (inserted after position %d elements %d - %d).',
 441     videoPlaylist.uuid, insertAfter, start, start + reorderLength - 1
 442   )
 443
 444   return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end()
 445 }
 446
 447 async function getVideoPlaylistVideos (req: express.Request, res: express.Response) {
 448   const videoPlaylistInstance = res.locals.videoPlaylistSummary
 449   const user = res.locals.oauth ? res.locals.oauth.token.User : undefined
 450   const server = await getServerActor()
 451
 452   const resultList = await VideoPlaylistElementModel.listForApi({
 453     start: req.query.start,
 454     count: req.query.count,
 455     videoPlaylistId: videoPlaylistInstance.id,
 456     serverAccount: server.Account,
 457     user
 458   })
 459
 460   const options = {
 461     displayNSFW: buildNSFWFilter(res, req.query.nsfw),
 462     accountId: user ? user.Account.id : undefined
 463   }
 464   return res.json(getFormattedObjects(resultList.data, resultList.total, options))
 465 }
 466
 467 async function regeneratePlaylistThumbnail (videoPlaylist: MVideoPlaylistThumbnail) {
 468   await videoPlaylist.Thumbnail.destroy()
 469   videoPlaylist.Thumbnail = null
 470
 471   const firstElement = await VideoPlaylistElementModel.loadFirstElementWithVideoThumbnail(videoPlaylist.id)
 472   if (firstElement) await generateThumbnailForPlaylist(videoPlaylist, firstElement.Video)
 473 }
 474
 475 async function generateThumbnailForPlaylist (videoPlaylist: MVideoPlaylistThumbnail, video: MVideoThumbnail) {
 476   logger.info('Generating default thumbnail to playlist %s.', videoPlaylist.url)
 477
 478   const videoMiniature = video.getMiniature()
 479   if (!videoMiniature) {
 480     logger.info('Cannot generate thumbnail for playlist %s because video %s does not have any.', videoPlaylist.url, video.url)
 481     return
 482   }
 483
 484   const inputPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, videoMiniature.filename)
 485   const thumbnailModel = await createPlaylistMiniatureFromExisting({
 486     inputPath,
 487     playlist: videoPlaylist,
 488     automaticallyGenerated: true,
 489     keepOriginal: true
 490   })
 491
 492   thumbnailModel.videoPlaylistId = videoPlaylist.id
 493
 494   videoPlaylist.Thumbnail = await thumbnailModel.save()
 495 }