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'
27 asyncRetryTransactionMiddleware,
33 } from '../../middlewares'
34 import { videoPlaylistsSortValidator } from '../../middlewares/validators'
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'
49 const reqThumbnailFile = createReqFiles([ 'thumbnailfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT, { thumbnailfile: CONFIG.STORAGE.TMP_DIR })
51 const videoPlaylistRouter = express.Router()
53 videoPlaylistRouter.get('/privacies', listVideoPlaylistPrivacies)
55 videoPlaylistRouter.get('/',
57 videoPlaylistsSortValidator,
60 commonVideoPlaylistFiltersValidator,
61 asyncMiddleware(listVideoPlaylists)
64 videoPlaylistRouter.get('/:playlistId',
65 asyncMiddleware(videoPlaylistsGetValidator('summary')),
69 videoPlaylistRouter.post('/',
72 asyncMiddleware(videoPlaylistsAddValidator),
73 asyncRetryTransactionMiddleware(addVideoPlaylist)
76 videoPlaylistRouter.put('/:playlistId',
79 asyncMiddleware(videoPlaylistsUpdateValidator),
80 asyncRetryTransactionMiddleware(updateVideoPlaylist)
83 videoPlaylistRouter.delete('/:playlistId',
85 asyncMiddleware(videoPlaylistsDeleteValidator),
86 asyncRetryTransactionMiddleware(removeVideoPlaylist)
89 videoPlaylistRouter.get('/:playlistId/videos',
90 asyncMiddleware(videoPlaylistsGetValidator('summary')),
94 asyncMiddleware(getVideoPlaylistVideos)
97 videoPlaylistRouter.post('/:playlistId/videos',
99 asyncMiddleware(videoPlaylistsAddVideoValidator),
100 asyncRetryTransactionMiddleware(addVideoInPlaylist)
103 videoPlaylistRouter.post('/:playlistId/videos/reorder',
105 asyncMiddleware(videoPlaylistsReorderVideosValidator),
106 asyncRetryTransactionMiddleware(reorderVideosPlaylist)
109 videoPlaylistRouter.put('/:playlistId/videos/:playlistElementId',
111 asyncMiddleware(videoPlaylistsUpdateOrRemoveVideoValidator),
112 asyncRetryTransactionMiddleware(updateVideoPlaylistElement)
115 videoPlaylistRouter.delete('/:playlistId/videos/:playlistElementId',
117 asyncMiddleware(videoPlaylistsUpdateOrRemoveVideoValidator),
118 asyncRetryTransactionMiddleware(removeVideoFromPlaylist)
121 // ---------------------------------------------------------------------------
127 // ---------------------------------------------------------------------------
129 function listVideoPlaylistPrivacies (req: express.Request, res: express.Response) {
130 res.json(VIDEO_PLAYLIST_PRIVACIES)
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,
143 return res.json(getFormattedObjects(resultList.data, resultList.total))
146 function getVideoPlaylist (req: express.Request, res: express.Response) {
147 const videoPlaylist = res.locals.videoPlaylistSummary
149 scheduleRefreshIfNeeded(videoPlaylist)
151 return res.json(videoPlaylist.toFormattedJSON())
154 async function addVideoPlaylist (req: express.Request, res: express.Response) {
155 const videoPlaylistInfo: VideoPlaylistCreate = req.body
156 const user = res.locals.oauth.token.User
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
165 videoPlaylist.url = getLocalVideoPlaylistActivityPubUrl(videoPlaylist) // We use the UUID, so set the URL after building the object
167 if (videoPlaylistInfo.videoChannelId) {
168 const videoChannel = res.locals.videoChannel
170 videoPlaylist.videoChannelId = videoChannel.id
171 videoPlaylist.VideoChannel = videoChannel
174 const thumbnailField = req.files['thumbnailfile']
175 const thumbnailModel = thumbnailField
176 ? await updatePlaylistMiniatureFromExisting({
177 inputPath: thumbnailField[0].path,
178 playlist: videoPlaylist,
179 automaticallyGenerated: false
183 const videoPlaylistCreated = await sequelizeTypescript.transaction(async t => {
184 const videoPlaylistCreated = await videoPlaylist.save({ transaction: t }) as MVideoPlaylistFull
186 if (thumbnailModel) {
187 thumbnailModel.automaticallyGenerated = false
188 await videoPlaylistCreated.setAndSaveThumbnail(thumbnailModel, t)
191 // We need more attributes for the federation
192 videoPlaylistCreated.OwnerAccount = await AccountModel.load(user.Account.id, t)
193 await sendCreateVideoPlaylist(videoPlaylistCreated, t)
195 return videoPlaylistCreated
198 logger.info('Video playlist with uuid %s created.', videoPlaylist.uuid)
202 id: videoPlaylistCreated.id,
203 shortUUID: uuidToShort(videoPlaylistCreated.uuid),
204 uuid: videoPlaylistCreated.uuid
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
214 const wasPrivatePlaylist = videoPlaylistInstance.privacy === VideoPlaylistPrivacy.PRIVATE
215 const wasNotPrivatePlaylist = videoPlaylistInstance.privacy !== VideoPlaylistPrivacy.PRIVATE
217 const thumbnailField = req.files['thumbnailfile']
218 const thumbnailModel = thumbnailField
219 ? await updatePlaylistMiniatureFromExisting({
220 inputPath: thumbnailField[0].path,
221 playlist: videoPlaylistInstance,
222 automaticallyGenerated: false
227 await sequelizeTypescript.transaction(async t => {
228 const sequelizeOptions = {
232 if (videoPlaylistInfoToUpdate.videoChannelId !== undefined) {
233 if (videoPlaylistInfoToUpdate.videoChannelId === null) {
234 videoPlaylistInstance.videoChannelId = null
236 const videoChannel = res.locals.videoChannel
238 videoPlaylistInstance.videoChannelId = videoChannel.id
239 videoPlaylistInstance.VideoChannel = videoChannel
243 if (videoPlaylistInfoToUpdate.displayName !== undefined) videoPlaylistInstance.name = videoPlaylistInfoToUpdate.displayName
244 if (videoPlaylistInfoToUpdate.description !== undefined) videoPlaylistInstance.description = videoPlaylistInfoToUpdate.description
246 if (videoPlaylistInfoToUpdate.privacy !== undefined) {
247 videoPlaylistInstance.privacy = parseInt(videoPlaylistInfoToUpdate.privacy.toString(), 10)
249 if (wasNotPrivatePlaylist === true && videoPlaylistInstance.privacy === VideoPlaylistPrivacy.PRIVATE) {
250 await sendDeleteVideoPlaylist(videoPlaylistInstance, t)
254 const playlistUpdated = await videoPlaylistInstance.save(sequelizeOptions)
256 if (thumbnailModel) {
257 thumbnailModel.automaticallyGenerated = false
258 await playlistUpdated.setAndSaveThumbnail(thumbnailModel, t)
261 const isNewPlaylist = wasPrivatePlaylist && playlistUpdated.privacy !== VideoPlaylistPrivacy.PRIVATE
264 await sendCreateVideoPlaylist(playlistUpdated, t)
266 await sendUpdateVideoPlaylist(playlistUpdated, t)
269 logger.info('Video playlist %s updated.', videoPlaylistInstance.uuid)
271 return playlistUpdated
274 logger.debug('Cannot update the video playlist.', { err })
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)
284 return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end()
287 async function removeVideoPlaylist (req: express.Request, res: express.Response) {
288 const videoPlaylistInstance = res.locals.videoPlaylistSummary
290 await sequelizeTypescript.transaction(async t => {
291 await videoPlaylistInstance.destroy({ transaction: t })
293 await sendDeleteVideoPlaylist(videoPlaylistInstance, t)
295 logger.info('Video playlist %s deleted.', videoPlaylistInstance.uuid)
298 return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end()
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
306 const playlistElement = await sequelizeTypescript.transaction(async t => {
307 const position = await VideoPlaylistElementModel.getNextPositionOf(videoPlaylist.id, t)
309 const playlistElement = await VideoPlaylistElementModel.create({
311 startTimestamp: body.startTimestamp || null,
312 stopTimestamp: body.stopTimestamp || null,
313 videoPlaylistId: videoPlaylist.id,
315 }, { transaction: t })
317 playlistElement.url = getLocalVideoPlaylistElementActivityPubUrl(videoPlaylist, playlistElement)
318 await playlistElement.save({ transaction: t })
320 videoPlaylist.changed('updatedAt', true)
321 await videoPlaylist.save({ transaction: t })
323 return playlistElement
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)
331 sendUpdateVideoPlaylist(videoPlaylist, undefined)
332 .catch(err => logger.error('Cannot send video playlist update.', { err }))
334 logger.info('Video added in playlist %s at position %d.', videoPlaylist.uuid, playlistElement.position)
336 Hooks.runAction('action:api.video-playlist-element.created', { playlistElement })
339 videoPlaylistElement: {
340 id: playlistElement.id
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
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
354 const element = await videoPlaylistElement.save({ transaction: t })
356 videoPlaylist.changed('updatedAt', true)
357 await videoPlaylist.save({ transaction: t })
359 await sendUpdateVideoPlaylist(videoPlaylist, t)
364 logger.info('Element of position %d of playlist %s updated.', playlistElement.position, videoPlaylist.uuid)
366 return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end()
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
374 await sequelizeTypescript.transaction(async t => {
375 await videoPlaylistElement.destroy({ transaction: t })
377 // Decrease position of the next elements
378 await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, positionToDelete, null, -1, t)
380 videoPlaylist.changed('updatedAt', true)
381 await videoPlaylist.save({ transaction: t })
383 logger.info('Video playlist element %d of playlist %s deleted.', videoPlaylistElement.position, videoPlaylist.uuid)
386 // Do we need to regenerate the default thumbnail?
387 if (positionToDelete === 1 && videoPlaylist.hasGeneratedThumbnail()) {
388 await regeneratePlaylistThumbnail(videoPlaylist)
391 sendUpdateVideoPlaylist(videoPlaylist, undefined)
392 .catch(err => logger.error('Cannot send video playlist update.', { err }))
394 return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end()
397 async function reorderVideosPlaylist (req: express.Request, res: express.Response) {
398 const videoPlaylist = res.locals.videoPlaylistFull
399 const body: VideoPlaylistReorder = req.body
401 const start: number = body.startPosition
402 const insertAfter: number = body.insertAfterPosition
403 const reorderLength: number = body.reorderLength || 1
405 if (start === insertAfter) {
406 return res.status(HttpStatusCode.NO_CONTENT_204).end()
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
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)
419 let oldPosition = start
421 // We incremented the position of the elements we want to reorder
422 if (start >= newPosition) oldPosition += reorderLength
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)
428 // Decrease positions of elements after the old position of our ordered elements (decrease)
429 await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, oldPosition, null, -reorderLength, t)
431 videoPlaylist.changed('updatedAt', true)
432 await videoPlaylist.save({ transaction: t })
434 await sendUpdateVideoPlaylist(videoPlaylist, t)
437 // The first element changed
438 if ((start === 1 || insertAfter === 0) && videoPlaylist.hasGeneratedThumbnail()) {
439 await regeneratePlaylistThumbnail(videoPlaylist)
443 'Reordered playlist %s (inserted after position %d elements %d - %d).',
444 videoPlaylist.uuid, insertAfter, start, start + reorderLength - 1
447 return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end()
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()
455 const resultList = await VideoPlaylistElementModel.listForApi({
456 start: req.query.start,
457 count: req.query.count,
458 videoPlaylistId: videoPlaylistInstance.id,
459 serverAccount: server.Account,
464 displayNSFW: buildNSFWFilter(res, req.query.nsfw),
465 accountId: user ? user.Account.id : undefined
467 return res.json(getFormattedObjects(resultList.data, resultList.total, options))
470 async function regeneratePlaylistThumbnail (videoPlaylist: MVideoPlaylistThumbnail) {
471 await videoPlaylist.Thumbnail.destroy()
472 videoPlaylist.Thumbnail = null
474 const firstElement = await VideoPlaylistElementModel.loadFirstElementWithVideoThumbnail(videoPlaylist.id)
475 if (firstElement) await generateThumbnailForPlaylist(videoPlaylist, firstElement.Video)
478 async function generateThumbnailForPlaylist (videoPlaylist: MVideoPlaylistThumbnail, video: MVideoThumbnail) {
479 logger.info('Generating default thumbnail to playlist %s.', videoPlaylist.url)
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)
487 const inputPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, videoMiniature.filename)
488 const thumbnailModel = await updatePlaylistMiniatureFromExisting({
490 playlist: videoPlaylist,
491 automaticallyGenerated: true,
495 thumbnailModel.videoPlaylistId = videoPlaylist.id
497 videoPlaylist.Thumbnail = await thumbnailModel.save()