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 { createPlaylistMiniatureFromExisting } 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 createPlaylistMiniatureFromExisting(thumbnailField[0].path, videoPlaylist)
180 const videoPlaylistCreated: VideoPlaylistModel = await sequelizeTypescript.transaction(async t => {
181 const videoPlaylistCreated = await videoPlaylist.save({ transaction: t })
183 if (thumbnailModel) await videoPlaylistCreated.setAndSaveThumbnail(thumbnailModel, t)
185 // We need more attributes for the federation
186 videoPlaylistCreated.OwnerAccount = await AccountModel.load(user.Account.id, t)
187 await sendCreateVideoPlaylist(videoPlaylistCreated, t)
189 return videoPlaylistCreated
192 logger.info('Video playlist with uuid %s created.', videoPlaylist.uuid)
196 id: videoPlaylistCreated.id,
197 uuid: videoPlaylistCreated.uuid
202 async function updateVideoPlaylist (req: express.Request, res: express.Response) {
203 const videoPlaylistInstance = res.locals.videoPlaylist
204 const videoPlaylistFieldsSave = videoPlaylistInstance.toJSON()
205 const videoPlaylistInfoToUpdate = req.body as VideoPlaylistUpdate
206 const wasPrivatePlaylist = videoPlaylistInstance.privacy === VideoPlaylistPrivacy.PRIVATE
208 const thumbnailField = req.files['thumbnailfile']
209 const thumbnailModel = thumbnailField
210 ? await createPlaylistMiniatureFromExisting(thumbnailField[0].path, videoPlaylistInstance)
214 await sequelizeTypescript.transaction(async t => {
215 const sequelizeOptions = {
219 if (videoPlaylistInfoToUpdate.videoChannelId !== undefined) {
220 if (videoPlaylistInfoToUpdate.videoChannelId === null) {
221 videoPlaylistInstance.videoChannelId = null
223 const videoChannel = res.locals.videoChannel
225 videoPlaylistInstance.videoChannelId = videoChannel.id
226 videoPlaylistInstance.VideoChannel = videoChannel
230 if (videoPlaylistInfoToUpdate.displayName !== undefined) videoPlaylistInstance.name = videoPlaylistInfoToUpdate.displayName
231 if (videoPlaylistInfoToUpdate.description !== undefined) videoPlaylistInstance.description = videoPlaylistInfoToUpdate.description
233 if (videoPlaylistInfoToUpdate.privacy !== undefined) {
234 videoPlaylistInstance.privacy = parseInt(videoPlaylistInfoToUpdate.privacy.toString(), 10)
237 const playlistUpdated = await videoPlaylistInstance.save(sequelizeOptions)
239 if (thumbnailModel) await playlistUpdated.setAndSaveThumbnail(thumbnailModel, t)
241 const isNewPlaylist = wasPrivatePlaylist && playlistUpdated.privacy !== VideoPlaylistPrivacy.PRIVATE
244 await sendCreateVideoPlaylist(playlistUpdated, t)
246 await sendUpdateVideoPlaylist(playlistUpdated, t)
249 logger.info('Video playlist %s updated.', videoPlaylistInstance.uuid)
251 return playlistUpdated
254 logger.debug('Cannot update the video playlist.', { err })
256 // Force fields we want to update
257 // If the transaction is retried, sequelize will think the object has not changed
258 // So it will skip the SQL request, even if the last one was ROLLBACKed!
259 resetSequelizeInstance(videoPlaylistInstance, videoPlaylistFieldsSave)
264 return res.type('json').status(204).end()
267 async function removeVideoPlaylist (req: express.Request, res: express.Response) {
268 const videoPlaylistInstance = res.locals.videoPlaylist
270 await sequelizeTypescript.transaction(async t => {
271 await videoPlaylistInstance.destroy({ transaction: t })
273 await sendDeleteVideoPlaylist(videoPlaylistInstance, t)
275 logger.info('Video playlist %s deleted.', videoPlaylistInstance.uuid)
278 return res.type('json').status(204).end()
281 async function addVideoInPlaylist (req: express.Request, res: express.Response) {
282 const body: VideoPlaylistElementCreate = req.body
283 const videoPlaylist = res.locals.videoPlaylist
284 const video = res.locals.video
286 const playlistElement: VideoPlaylistElementModel = await sequelizeTypescript.transaction(async t => {
287 const position = await VideoPlaylistElementModel.getNextPositionOf(videoPlaylist.id, t)
289 const playlistElement = await VideoPlaylistElementModel.create({
290 url: getVideoPlaylistElementActivityPubUrl(videoPlaylist, video),
292 startTimestamp: body.startTimestamp || null,
293 stopTimestamp: body.stopTimestamp || null,
294 videoPlaylistId: videoPlaylist.id,
296 }, { transaction: t })
298 videoPlaylist.changed('updatedAt', true)
299 await videoPlaylist.save({ transaction: t })
301 await sendUpdateVideoPlaylist(videoPlaylist, t)
303 return playlistElement
306 // If the user did not set a thumbnail, automatically take the video thumbnail
307 if (playlistElement.position === 1 && videoPlaylist.hasThumbnail() === false) {
308 logger.info('Generating default thumbnail to playlist %s.', videoPlaylist.url)
310 const inputPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, video.getMiniature().filename)
311 const thumbnailModel = await createPlaylistMiniatureFromExisting(inputPath, videoPlaylist, true)
313 thumbnailModel.videoPlaylistId = videoPlaylist.id
315 await thumbnailModel.save()
318 logger.info('Video added in playlist %s at position %d.', videoPlaylist.uuid, playlistElement.position)
321 videoPlaylistElement: {
322 id: playlistElement.id
327 async function updateVideoPlaylistElement (req: express.Request, res: express.Response) {
328 const body: VideoPlaylistElementUpdate = req.body
329 const videoPlaylist = res.locals.videoPlaylist
330 const videoPlaylistElement = res.locals.videoPlaylistElement
332 const playlistElement: VideoPlaylistElementModel = await sequelizeTypescript.transaction(async t => {
333 if (body.startTimestamp !== undefined) videoPlaylistElement.startTimestamp = body.startTimestamp
334 if (body.stopTimestamp !== undefined) videoPlaylistElement.stopTimestamp = body.stopTimestamp
336 const element = await videoPlaylistElement.save({ transaction: t })
338 videoPlaylist.changed('updatedAt', true)
339 await videoPlaylist.save({ transaction: t })
341 await sendUpdateVideoPlaylist(videoPlaylist, t)
346 logger.info('Element of position %d of playlist %s updated.', playlistElement.position, videoPlaylist.uuid)
348 return res.type('json').status(204).end()
351 async function removeVideoFromPlaylist (req: express.Request, res: express.Response) {
352 const videoPlaylistElement = res.locals.videoPlaylistElement
353 const videoPlaylist = res.locals.videoPlaylist
354 const positionToDelete = videoPlaylistElement.position
356 await sequelizeTypescript.transaction(async t => {
357 await videoPlaylistElement.destroy({ transaction: t })
359 // Decrease position of the next elements
360 await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, positionToDelete, null, -1, t)
362 videoPlaylist.changed('updatedAt', true)
363 await videoPlaylist.save({ transaction: t })
365 await sendUpdateVideoPlaylist(videoPlaylist, t)
367 logger.info('Video playlist element %d of playlist %s deleted.', videoPlaylistElement.position, videoPlaylist.uuid)
370 return res.type('json').status(204).end()
373 async function reorderVideosPlaylist (req: express.Request, res: express.Response) {
374 const videoPlaylist = res.locals.videoPlaylist
375 const body: VideoPlaylistReorder = req.body
377 const start: number = body.startPosition
378 const insertAfter: number = body.insertAfterPosition
379 const reorderLength: number = body.reorderLength || 1
381 if (start === insertAfter) {
382 return res.status(204).end()
385 // Example: if we reorder position 2 and insert after position 5 (so at position 6): # 1 2 3 4 5 6 7 8 9
386 // * increase position when position > 5 # 1 2 3 4 5 7 8 9 10
387 // * update position 2 -> position 6 # 1 3 4 5 6 7 8 9 10
388 // * decrease position when position position > 2 # 1 2 3 4 5 6 7 8 9
389 await sequelizeTypescript.transaction(async t => {
390 const newPosition = insertAfter + 1
392 // Add space after the position when we want to insert our reordered elements (increase)
393 await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, newPosition, null, reorderLength, t)
395 let oldPosition = start
397 // We incremented the position of the elements we want to reorder
398 if (start >= newPosition) oldPosition += reorderLength
400 const endOldPosition = oldPosition + reorderLength - 1
401 // Insert our reordered elements in their place (update)
402 await VideoPlaylistElementModel.reassignPositionOf(videoPlaylist.id, oldPosition, endOldPosition, newPosition, t)
404 // Decrease positions of elements after the old position of our ordered elements (decrease)
405 await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, oldPosition, null, -reorderLength, t)
407 videoPlaylist.changed('updatedAt', true)
408 await videoPlaylist.save({ transaction: t })
410 await sendUpdateVideoPlaylist(videoPlaylist, t)
414 'Reordered playlist %s (inserted after %d elements %d - %d).',
415 videoPlaylist.uuid, insertAfter, start, start + reorderLength - 1
418 return res.type('json').status(204).end()
421 async function getVideoPlaylistVideos (req: express.Request, res: express.Response) {
422 const videoPlaylistInstance = res.locals.videoPlaylist
423 const followerActorId = isUserAbleToSearchRemoteURI(res) ? null : undefined
425 const resultList = await VideoModel.listForApi({
427 start: req.query.start,
428 count: req.query.count,
429 sort: 'VideoPlaylistElements.position',
430 includeLocalVideos: true,
431 categoryOneOf: req.query.categoryOneOf,
432 licenceOneOf: req.query.licenceOneOf,
433 languageOneOf: req.query.languageOneOf,
434 tagsOneOf: req.query.tagsOneOf,
435 tagsAllOf: req.query.tagsAllOf,
436 filter: req.query.filter,
437 nsfw: buildNSFWFilter(res, req.query.nsfw),
439 videoPlaylistId: videoPlaylistInstance.id,
440 user: res.locals.oauth ? res.locals.oauth.token.User : undefined
443 const additionalAttributes = { playlistInfo: true }
444 return res.json(getFormattedObjects(resultList.data, resultList.total, { additionalAttributes }))