server/controllers/api/video-playlist.ts

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