1 import * as express from 'express'
2 import { getFormattedObjects, getServerActor } from '../../helpers/utils'
5 asyncRetryTransactionMiddleware,
7 commonVideosFiltersValidator,
12 } from '../../middlewares'
13 import { videoPlaylistsSortValidator } from '../../middlewares/validators'
14 import { buildNSFWFilter, createReqFiles, isUserAbleToSearchRemoteURI } from '../../helpers/express-utils'
15 import { MIMETYPES, VIDEO_PLAYLIST_PRIVACIES } from '../../initializers/constants'
16 import { logger } from '../../helpers/logger'
17 import { resetSequelizeInstance } from '../../helpers/database-utils'
18 import { VideoPlaylistModel } from '../../models/video/video-playlist'
20 commonVideoPlaylistFiltersValidator,
21 videoPlaylistsAddValidator,
22 videoPlaylistsAddVideoValidator,
23 videoPlaylistsDeleteValidator,
24 videoPlaylistsGetValidator,
25 videoPlaylistsReorderVideosValidator,
26 videoPlaylistsUpdateOrRemoveVideoValidator,
27 videoPlaylistsUpdateValidator
28 } from '../../middlewares/validators/videos/video-playlists'
29 import { VideoPlaylistCreate } from '../../../shared/models/videos/playlist/video-playlist-create.model'
30 import { VideoPlaylistPrivacy } from '../../../shared/models/videos/playlist/video-playlist-privacy.model'
31 import { join } from 'path'
32 import { sendCreateVideoPlaylist, sendDeleteVideoPlaylist, sendUpdateVideoPlaylist } from '../../lib/activitypub/send'
33 import { getVideoPlaylistActivityPubUrl, getVideoPlaylistElementActivityPubUrl } from '../../lib/activitypub/url'
34 import { VideoPlaylistUpdate } from '../../../shared/models/videos/playlist/video-playlist-update.model'
35 import { VideoModel } from '../../models/video/video'
36 import { VideoPlaylistElementModel } from '../../models/video/video-playlist-element'
37 import { VideoPlaylistElementCreate } from '../../../shared/models/videos/playlist/video-playlist-element-create.model'
38 import { VideoPlaylistElementUpdate } from '../../../shared/models/videos/playlist/video-playlist-element-update.model'
39 import { AccountModel } from '../../models/account/account'
40 import { VideoPlaylistReorder } from '../../../shared/models/videos/playlist/video-playlist-reorder.model'
41 import { JobQueue } from '../../lib/job-queue'
42 import { CONFIG } from '../../initializers/config'
43 import { sequelizeTypescript } from '../../initializers/database'
44 import { createPlaylistThumbnailFromExisting } from '../../lib/thumbnail'
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),
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),
91 commonVideosFiltersValidator,
92 asyncMiddleware(getVideoPlaylistVideos)
95 videoPlaylistRouter.post('/:playlistId/videos',
97 asyncMiddleware(videoPlaylistsAddVideoValidator),
98 asyncRetryTransactionMiddleware(addVideoInPlaylist)
101 videoPlaylistRouter.post('/:playlistId/videos/reorder',
103 asyncMiddleware(videoPlaylistsReorderVideosValidator),
104 asyncRetryTransactionMiddleware(reorderVideosPlaylist)
107 videoPlaylistRouter.put('/:playlistId/videos/:videoId',
109 asyncMiddleware(videoPlaylistsUpdateOrRemoveVideoValidator),
110 asyncRetryTransactionMiddleware(updateVideoPlaylistElement)
113 videoPlaylistRouter.delete('/:playlistId/videos/:videoId',
115 asyncMiddleware(videoPlaylistsUpdateOrRemoveVideoValidator),
116 asyncRetryTransactionMiddleware(removeVideoFromPlaylist)
119 // ---------------------------------------------------------------------------
125 // ---------------------------------------------------------------------------
127 function listVideoPlaylistPrivacies (req: express.Request, res: express.Response) {
128 res.json(VIDEO_PLAYLIST_PRIVACIES)
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,
141 return res.json(getFormattedObjects(resultList.data, resultList.total))
144 function getVideoPlaylist (req: express.Request, res: express.Response) {
145 const videoPlaylist = res.locals.videoPlaylist
147 if (videoPlaylist.isOutdated()) {
148 JobQueue.Instance.createJob({ type: 'activitypub-refresher', payload: { type: 'video-playlist', url: videoPlaylist.url } })
149 .catch(err => logger.error('Cannot create AP refresher job for playlist %s.', videoPlaylist.url, { err }))
152 return res.json(videoPlaylist.toFormattedJSON())
155 async function addVideoPlaylist (req: express.Request, res: express.Response) {
156 const videoPlaylistInfo: VideoPlaylistCreate = req.body
157 const user = res.locals.oauth.token.User
159 const videoPlaylist = new VideoPlaylistModel({
160 name: videoPlaylistInfo.displayName,
161 description: videoPlaylistInfo.description,
162 privacy: videoPlaylistInfo.privacy || VideoPlaylistPrivacy.PRIVATE,
163 ownerAccountId: user.Account.id
166 videoPlaylist.url = getVideoPlaylistActivityPubUrl(videoPlaylist) // We use the UUID, so set the URL after building the object
168 if (videoPlaylistInfo.videoChannelId) {
169 const videoChannel = res.locals.videoChannel
171 videoPlaylist.videoChannelId = videoChannel.id
172 videoPlaylist.VideoChannel = videoChannel
175 const thumbnailField = req.files['thumbnailfile']
176 const thumbnailModel = thumbnailField
177 ? await createPlaylistThumbnailFromExisting(thumbnailField[0].path, videoPlaylist)
180 const videoPlaylistCreated: VideoPlaylistModel = await sequelizeTypescript.transaction(async t => {
181 const videoPlaylistCreated = await videoPlaylist.save({ transaction: t })
183 if (thumbnailModel) {
184 thumbnailModel.videoPlaylistId = videoPlaylistCreated.id
185 videoPlaylistCreated.setThumbnail(await thumbnailModel.save({ transaction: t }))
188 // We need more attributes for the federation
189 videoPlaylistCreated.OwnerAccount = await AccountModel.load(user.Account.id, t)
190 await sendCreateVideoPlaylist(videoPlaylistCreated, t)
192 return videoPlaylistCreated
195 logger.info('Video playlist with uuid %s created.', videoPlaylist.uuid)
199 id: videoPlaylistCreated.id,
200 uuid: videoPlaylistCreated.uuid
205 async function updateVideoPlaylist (req: express.Request, res: express.Response) {
206 const videoPlaylistInstance = res.locals.videoPlaylist
207 const videoPlaylistFieldsSave = videoPlaylistInstance.toJSON()
208 const videoPlaylistInfoToUpdate = req.body as VideoPlaylistUpdate
209 const wasPrivatePlaylist = videoPlaylistInstance.privacy === VideoPlaylistPrivacy.PRIVATE
211 const thumbnailField = req.files['thumbnailfile']
212 const thumbnailModel = thumbnailField
213 ? await createPlaylistThumbnailFromExisting(thumbnailField[0].path, videoPlaylistInstance)
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)
240 const playlistUpdated = await videoPlaylistInstance.save(sequelizeOptions)
242 if (thumbnailModel) {
243 thumbnailModel.videoPlaylistId = playlistUpdated.id
244 playlistUpdated.setThumbnail(await thumbnailModel.save({ transaction: t }))
247 const isNewPlaylist = wasPrivatePlaylist && playlistUpdated.privacy !== VideoPlaylistPrivacy.PRIVATE
250 await sendCreateVideoPlaylist(playlistUpdated, t)
252 await sendUpdateVideoPlaylist(playlistUpdated, t)
255 logger.info('Video playlist %s updated.', videoPlaylistInstance.uuid)
257 return playlistUpdated
260 logger.debug('Cannot update the video playlist.', { err })
262 // Force fields we want to update
263 // If the transaction is retried, sequelize will think the object has not changed
264 // So it will skip the SQL request, even if the last one was ROLLBACKed!
265 resetSequelizeInstance(videoPlaylistInstance, videoPlaylistFieldsSave)
270 return res.type('json').status(204).end()
273 async function removeVideoPlaylist (req: express.Request, res: express.Response) {
274 const videoPlaylistInstance = res.locals.videoPlaylist
276 await sequelizeTypescript.transaction(async t => {
277 await videoPlaylistInstance.destroy({ transaction: t })
279 await sendDeleteVideoPlaylist(videoPlaylistInstance, t)
281 logger.info('Video playlist %s deleted.', videoPlaylistInstance.uuid)
284 return res.type('json').status(204).end()
287 async function addVideoInPlaylist (req: express.Request, res: express.Response) {
288 const body: VideoPlaylistElementCreate = req.body
289 const videoPlaylist = res.locals.videoPlaylist
290 const video = res.locals.video
292 const playlistElement: VideoPlaylistElementModel = await sequelizeTypescript.transaction(async t => {
293 const position = await VideoPlaylistElementModel.getNextPositionOf(videoPlaylist.id, t)
295 const playlistElement = await VideoPlaylistElementModel.create({
296 url: getVideoPlaylistElementActivityPubUrl(videoPlaylist, video),
298 startTimestamp: body.startTimestamp || null,
299 stopTimestamp: body.stopTimestamp || null,
300 videoPlaylistId: videoPlaylist.id,
302 }, { transaction: t })
304 videoPlaylist.changed('updatedAt', true)
305 await videoPlaylist.save({ transaction: t })
307 await sendUpdateVideoPlaylist(videoPlaylist, t)
309 return playlistElement
312 // If the user did not set a thumbnail, automatically take the video thumbnail
313 if (playlistElement.position === 1 && videoPlaylist.hasThumbnail() === false) {
314 logger.info('Generating default thumbnail to playlist %s.', videoPlaylist.url)
316 const inputPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, video.getThumbnail().filename)
317 const thumbnailModel = await createPlaylistThumbnailFromExisting(inputPath, videoPlaylist, true)
319 thumbnailModel.videoPlaylistId = videoPlaylist.id
321 await thumbnailModel.save()
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.videoPlaylist
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.videoPlaylist
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 await sendUpdateVideoPlaylist(videoPlaylist, t)
373 logger.info('Video playlist element %d of playlist %s deleted.', videoPlaylistElement.position, videoPlaylist.uuid)
376 return res.type('json').status(204).end()
379 async function reorderVideosPlaylist (req: express.Request, res: express.Response) {
380 const videoPlaylist = res.locals.videoPlaylist
381 const body: VideoPlaylistReorder = req.body
383 const start: number = body.startPosition
384 const insertAfter: number = body.insertAfterPosition
385 const reorderLength: number = body.reorderLength || 1
387 if (start === insertAfter) {
388 return res.status(204).end()
391 // Example: if we reorder position 2 and insert after position 5 (so at position 6): # 1 2 3 4 5 6 7 8 9
392 // * increase position when position > 5 # 1 2 3 4 5 7 8 9 10
393 // * update position 2 -> position 6 # 1 3 4 5 6 7 8 9 10
394 // * decrease position when position position > 2 # 1 2 3 4 5 6 7 8 9
395 await sequelizeTypescript.transaction(async t => {
396 const newPosition = insertAfter + 1
398 // Add space after the position when we want to insert our reordered elements (increase)
399 await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, newPosition, null, reorderLength, t)
401 let oldPosition = start
403 // We incremented the position of the elements we want to reorder
404 if (start >= newPosition) oldPosition += reorderLength
406 const endOldPosition = oldPosition + reorderLength - 1
407 // Insert our reordered elements in their place (update)
408 await VideoPlaylistElementModel.reassignPositionOf(videoPlaylist.id, oldPosition, endOldPosition, newPosition, t)
410 // Decrease positions of elements after the old position of our ordered elements (decrease)
411 await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, oldPosition, null, -reorderLength, t)
413 videoPlaylist.changed('updatedAt', true)
414 await videoPlaylist.save({ transaction: t })
416 await sendUpdateVideoPlaylist(videoPlaylist, t)
420 'Reordered playlist %s (inserted after %d elements %d - %d).',
421 videoPlaylist.uuid, insertAfter, start, start + reorderLength - 1
424 return res.type('json').status(204).end()
427 async function getVideoPlaylistVideos (req: express.Request, res: express.Response) {
428 const videoPlaylistInstance = res.locals.videoPlaylist
429 const followerActorId = isUserAbleToSearchRemoteURI(res) ? null : undefined
431 const resultList = await VideoModel.listForApi({
433 start: req.query.start,
434 count: req.query.count,
435 sort: 'VideoPlaylistElements.position',
436 includeLocalVideos: true,
437 categoryOneOf: req.query.categoryOneOf,
438 licenceOneOf: req.query.licenceOneOf,
439 languageOneOf: req.query.languageOneOf,
440 tagsOneOf: req.query.tagsOneOf,
441 tagsAllOf: req.query.tagsAllOf,
442 filter: req.query.filter,
443 nsfw: buildNSFWFilter(res, req.query.nsfw),
445 videoPlaylistId: videoPlaylistInstance.id,
446 user: res.locals.oauth ? res.locals.oauth.token.User : undefined
449 const additionalAttributes = { playlistInfo: true }
450 return res.json(getFormattedObjects(resultList.data, resultList.total, { additionalAttributes }))