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'
24 asyncRetryTransactionMiddleware,
30 } from '../../middlewares'
31 import { videoPlaylistsSortValidator } from '../../middlewares/validators'
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'
46 const reqThumbnailFile = createReqFiles([ 'thumbnailfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT, { thumbnailfile: CONFIG.STORAGE.TMP_DIR })
48 const videoPlaylistRouter = express.Router()
50 videoPlaylistRouter.get('/privacies', listVideoPlaylistPrivacies)
52 videoPlaylistRouter.get('/',
54 videoPlaylistsSortValidator,
57 commonVideoPlaylistFiltersValidator,
58 asyncMiddleware(listVideoPlaylists)
61 videoPlaylistRouter.get('/:playlistId',
62 asyncMiddleware(videoPlaylistsGetValidator('summary')),
66 videoPlaylistRouter.post('/',
69 asyncMiddleware(videoPlaylistsAddValidator),
70 asyncRetryTransactionMiddleware(addVideoPlaylist)
73 videoPlaylistRouter.put('/:playlistId',
76 asyncMiddleware(videoPlaylistsUpdateValidator),
77 asyncRetryTransactionMiddleware(updateVideoPlaylist)
80 videoPlaylistRouter.delete('/:playlistId',
82 asyncMiddleware(videoPlaylistsDeleteValidator),
83 asyncRetryTransactionMiddleware(removeVideoPlaylist)
86 videoPlaylistRouter.get('/:playlistId/videos',
87 asyncMiddleware(videoPlaylistsGetValidator('summary')),
91 asyncMiddleware(getVideoPlaylistVideos)
94 videoPlaylistRouter.post('/:playlistId/videos',
96 asyncMiddleware(videoPlaylistsAddVideoValidator),
97 asyncRetryTransactionMiddleware(addVideoInPlaylist)
100 videoPlaylistRouter.post('/:playlistId/videos/reorder',
102 asyncMiddleware(videoPlaylistsReorderVideosValidator),
103 asyncRetryTransactionMiddleware(reorderVideosPlaylist)
106 videoPlaylistRouter.put('/:playlistId/videos/:playlistElementId',
108 asyncMiddleware(videoPlaylistsUpdateOrRemoveVideoValidator),
109 asyncRetryTransactionMiddleware(updateVideoPlaylistElement)
112 videoPlaylistRouter.delete('/:playlistId/videos/:playlistElementId',
114 asyncMiddleware(videoPlaylistsUpdateOrRemoveVideoValidator),
115 asyncRetryTransactionMiddleware(removeVideoFromPlaylist)
118 // ---------------------------------------------------------------------------
124 // ---------------------------------------------------------------------------
126 function listVideoPlaylistPrivacies (req: express.Request, res: express.Response) {
127 res.json(VIDEO_PLAYLIST_PRIVACIES)
130 async function listVideoPlaylists (req: express.Request, res: express.Response) {
131 const serverActor = await getServerActor()
132 const resultList = await VideoPlaylistModel.listForApi({
133 followerActorId: serverActor.id,
134 start: req.query.start,
135 count: req.query.count,
136 sort: req.query.sort,
140 return res.json(getFormattedObjects(resultList.data, resultList.total))
143 function getVideoPlaylist (req: express.Request, res: express.Response) {
144 const videoPlaylist = res.locals.videoPlaylistSummary
146 if (videoPlaylist.isOutdated()) {
147 JobQueue.Instance.createJob({ type: 'activitypub-refresher', payload: { type: 'video-playlist', url: videoPlaylist.url } })
150 return res.json(videoPlaylist.toFormattedJSON())
153 async function addVideoPlaylist (req: express.Request, res: express.Response) {
154 const videoPlaylistInfo: VideoPlaylistCreate = req.body
155 const user = res.locals.oauth.token.User
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
164 videoPlaylist.url = getLocalVideoPlaylistActivityPubUrl(videoPlaylist) // We use the UUID, so set the URL after building the object
166 if (videoPlaylistInfo.videoChannelId) {
167 const videoChannel = res.locals.videoChannel
169 videoPlaylist.videoChannelId = videoChannel.id
170 videoPlaylist.VideoChannel = videoChannel
173 const thumbnailField = req.files['thumbnailfile']
174 const thumbnailModel = thumbnailField
175 ? await createPlaylistMiniatureFromExisting(thumbnailField[0].path, videoPlaylist, false)
178 const videoPlaylistCreated = await sequelizeTypescript.transaction(async t => {
179 const videoPlaylistCreated = await videoPlaylist.save({ transaction: t }) as MVideoPlaylistFull
181 if (thumbnailModel) {
182 thumbnailModel.automaticallyGenerated = false
183 await videoPlaylistCreated.setAndSaveThumbnail(thumbnailModel, t)
186 // We need more attributes for the federation
187 videoPlaylistCreated.OwnerAccount = await AccountModel.load(user.Account.id, t)
188 await sendCreateVideoPlaylist(videoPlaylistCreated, t)
190 return videoPlaylistCreated
193 logger.info('Video playlist with uuid %s created.', videoPlaylist.uuid)
197 id: videoPlaylistCreated.id,
198 uuid: videoPlaylistCreated.uuid
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
208 const wasPrivatePlaylist = videoPlaylistInstance.privacy === VideoPlaylistPrivacy.PRIVATE
209 const wasNotPrivatePlaylist = videoPlaylistInstance.privacy !== VideoPlaylistPrivacy.PRIVATE
211 const thumbnailField = req.files['thumbnailfile']
212 const thumbnailModel = thumbnailField
213 ? await createPlaylistMiniatureFromExisting(thumbnailField[0].path, videoPlaylistInstance, false)
217 await sequelizeTypescript.transaction(async t => {
218 const sequelizeOptions = {
222 if (videoPlaylistInfoToUpdate.videoChannelId !== undefined) {
223 if (videoPlaylistInfoToUpdate.videoChannelId === null) {
224 videoPlaylistInstance.videoChannelId = null
226 const videoChannel = res.locals.videoChannel
228 videoPlaylistInstance.videoChannelId = videoChannel.id
229 videoPlaylistInstance.VideoChannel = videoChannel
233 if (videoPlaylistInfoToUpdate.displayName !== undefined) videoPlaylistInstance.name = videoPlaylistInfoToUpdate.displayName
234 if (videoPlaylistInfoToUpdate.description !== undefined) videoPlaylistInstance.description = videoPlaylistInfoToUpdate.description
236 if (videoPlaylistInfoToUpdate.privacy !== undefined) {
237 videoPlaylistInstance.privacy = parseInt(videoPlaylistInfoToUpdate.privacy.toString(), 10)
239 if (wasNotPrivatePlaylist === true && videoPlaylistInstance.privacy === VideoPlaylistPrivacy.PRIVATE) {
240 await sendDeleteVideoPlaylist(videoPlaylistInstance, t)
244 const playlistUpdated = await videoPlaylistInstance.save(sequelizeOptions)
246 if (thumbnailModel) {
247 thumbnailModel.automaticallyGenerated = false
248 await playlistUpdated.setAndSaveThumbnail(thumbnailModel, t)
251 const isNewPlaylist = wasPrivatePlaylist && playlistUpdated.privacy !== VideoPlaylistPrivacy.PRIVATE
254 await sendCreateVideoPlaylist(playlistUpdated, t)
256 await sendUpdateVideoPlaylist(playlistUpdated, t)
259 logger.info('Video playlist %s updated.', videoPlaylistInstance.uuid)
261 return playlistUpdated
264 logger.debug('Cannot update the video playlist.', { err })
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)
274 return res.type('json').status(204).end()
277 async function removeVideoPlaylist (req: express.Request, res: express.Response) {
278 const videoPlaylistInstance = res.locals.videoPlaylistSummary
280 await sequelizeTypescript.transaction(async t => {
281 await videoPlaylistInstance.destroy({ transaction: t })
283 await sendDeleteVideoPlaylist(videoPlaylistInstance, t)
285 logger.info('Video playlist %s deleted.', videoPlaylistInstance.uuid)
288 return res.type('json').status(204).end()
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
296 const playlistElement = await sequelizeTypescript.transaction(async t => {
297 const position = await VideoPlaylistElementModel.getNextPositionOf(videoPlaylist.id, t)
299 const playlistElement = await VideoPlaylistElementModel.create({
301 startTimestamp: body.startTimestamp || null,
302 stopTimestamp: body.stopTimestamp || null,
303 videoPlaylistId: videoPlaylist.id,
305 }, { transaction: t })
307 playlistElement.url = getLocalVideoPlaylistElementActivityPubUrl(videoPlaylist, playlistElement)
308 await playlistElement.save({ transaction: t })
310 videoPlaylist.changed('updatedAt', true)
311 await videoPlaylist.save({ transaction: t })
313 return playlistElement
316 // If the user did not set a thumbnail, automatically take the video thumbnail
317 if (videoPlaylist.hasThumbnail() === false || (videoPlaylist.hasGeneratedThumbnail() && playlistElement.position === 1)) {
318 await generateThumbnailForPlaylist(videoPlaylist, video)
321 sendUpdateVideoPlaylist(videoPlaylist, undefined)
322 .catch(err => logger.error('Cannot send video playlist update.', { err }))
324 logger.info('Video added in playlist %s at position %d.', videoPlaylist.uuid, playlistElement.position)
327 videoPlaylistElement: {
328 id: playlistElement.id
333 async function updateVideoPlaylistElement (req: express.Request, res: express.Response) {
334 const body: VideoPlaylistElementUpdate = req.body
335 const videoPlaylist = res.locals.videoPlaylistFull
336 const videoPlaylistElement = res.locals.videoPlaylistElement
338 const playlistElement: VideoPlaylistElementModel = await sequelizeTypescript.transaction(async t => {
339 if (body.startTimestamp !== undefined) videoPlaylistElement.startTimestamp = body.startTimestamp
340 if (body.stopTimestamp !== undefined) videoPlaylistElement.stopTimestamp = body.stopTimestamp
342 const element = await videoPlaylistElement.save({ transaction: t })
344 videoPlaylist.changed('updatedAt', true)
345 await videoPlaylist.save({ transaction: t })
347 await sendUpdateVideoPlaylist(videoPlaylist, t)
352 logger.info('Element of position %d of playlist %s updated.', playlistElement.position, videoPlaylist.uuid)
354 return res.type('json').status(204).end()
357 async function removeVideoFromPlaylist (req: express.Request, res: express.Response) {
358 const videoPlaylistElement = res.locals.videoPlaylistElement
359 const videoPlaylist = res.locals.videoPlaylistFull
360 const positionToDelete = videoPlaylistElement.position
362 await sequelizeTypescript.transaction(async t => {
363 await videoPlaylistElement.destroy({ transaction: t })
365 // Decrease position of the next elements
366 await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, positionToDelete, null, -1, t)
368 videoPlaylist.changed('updatedAt', true)
369 await videoPlaylist.save({ transaction: t })
371 logger.info('Video playlist element %d of playlist %s deleted.', videoPlaylistElement.position, videoPlaylist.uuid)
374 // Do we need to regenerate the default thumbnail?
375 if (positionToDelete === 1 && videoPlaylist.hasGeneratedThumbnail()) {
376 await regeneratePlaylistThumbnail(videoPlaylist)
379 sendUpdateVideoPlaylist(videoPlaylist, undefined)
380 .catch(err => logger.error('Cannot send video playlist update.', { err }))
382 return res.type('json').status(204).end()
385 async function reorderVideosPlaylist (req: express.Request, res: express.Response) {
386 const videoPlaylist = res.locals.videoPlaylistFull
387 const body: VideoPlaylistReorder = req.body
389 const start: number = body.startPosition
390 const insertAfter: number = body.insertAfterPosition
391 const reorderLength: number = body.reorderLength || 1
393 if (start === insertAfter) {
394 return res.status(204).end()
397 // Example: if we reorder position 2 and insert after position 5 (so at position 6): # 1 2 3 4 5 6 7 8 9
398 // * increase position when position > 5 # 1 2 3 4 5 7 8 9 10
399 // * update position 2 -> position 6 # 1 3 4 5 6 7 8 9 10
400 // * decrease position when position position > 2 # 1 2 3 4 5 6 7 8 9
401 await sequelizeTypescript.transaction(async t => {
402 const newPosition = insertAfter + 1
404 // Add space after the position when we want to insert our reordered elements (increase)
405 await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, newPosition, null, reorderLength, t)
407 let oldPosition = start
409 // We incremented the position of the elements we want to reorder
410 if (start >= newPosition) oldPosition += reorderLength
412 const endOldPosition = oldPosition + reorderLength - 1
413 // Insert our reordered elements in their place (update)
414 await VideoPlaylistElementModel.reassignPositionOf(videoPlaylist.id, oldPosition, endOldPosition, newPosition, t)
416 // Decrease positions of elements after the old position of our ordered elements (decrease)
417 await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, oldPosition, null, -reorderLength, t)
419 videoPlaylist.changed('updatedAt', true)
420 await videoPlaylist.save({ transaction: t })
422 await sendUpdateVideoPlaylist(videoPlaylist, t)
425 // The first element changed
426 if ((start === 1 || insertAfter === 0) && videoPlaylist.hasGeneratedThumbnail()) {
427 await regeneratePlaylistThumbnail(videoPlaylist)
431 'Reordered playlist %s (inserted after position %d elements %d - %d).',
432 videoPlaylist.uuid, insertAfter, start, start + reorderLength - 1
435 return res.type('json').status(204).end()
438 async function getVideoPlaylistVideos (req: express.Request, res: express.Response) {
439 const videoPlaylistInstance = res.locals.videoPlaylistSummary
440 const user = res.locals.oauth ? res.locals.oauth.token.User : undefined
441 const server = await getServerActor()
443 const resultList = await VideoPlaylistElementModel.listForApi({
444 start: req.query.start,
445 count: req.query.count,
446 videoPlaylistId: videoPlaylistInstance.id,
447 serverAccount: server.Account,
452 displayNSFW: buildNSFWFilter(res, req.query.nsfw),
453 accountId: user ? user.Account.id : undefined
455 return res.json(getFormattedObjects(resultList.data, resultList.total, options))
458 async function regeneratePlaylistThumbnail (videoPlaylist: MVideoPlaylistThumbnail) {
459 await videoPlaylist.Thumbnail.destroy()
460 videoPlaylist.Thumbnail = null
462 const firstElement = await VideoPlaylistElementModel.loadFirstElementWithVideoThumbnail(videoPlaylist.id)
463 if (firstElement) await generateThumbnailForPlaylist(videoPlaylist, firstElement.Video)
466 async function generateThumbnailForPlaylist (videoPlaylist: MVideoPlaylistThumbnail, video: MVideoThumbnail) {
467 logger.info('Generating default thumbnail to playlist %s.', videoPlaylist.url)
469 const videoMiniature = video.getMiniature()
470 if (!videoMiniature) {
471 logger.info('Cannot generate thumbnail for playlist %s because video %s does not have any.', videoPlaylist.url, video.url)
475 const inputPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, videoMiniature.filename)
476 const thumbnailModel = await createPlaylistMiniatureFromExisting(inputPath, videoPlaylist, true, true)
478 thumbnailModel.videoPlaylistId = videoPlaylist.id
480 videoPlaylist.Thumbnail = await thumbnailModel.save()