server/controllers/api/video-playlist.ts

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