473 lines
18 KiB
TypeScript
473 lines
18 KiB
TypeScript
import * as express from 'express'
|
|
import { getFormattedObjects, getServerActor } from '../../helpers/utils'
|
|
import {
|
|
asyncMiddleware,
|
|
asyncRetryTransactionMiddleware,
|
|
authenticate,
|
|
optionalAuthenticate,
|
|
paginationValidator,
|
|
setDefaultPagination,
|
|
setDefaultSort
|
|
} from '../../middlewares'
|
|
import { videoPlaylistsSortValidator } from '../../middlewares/validators'
|
|
import { buildNSFWFilter, createReqFiles } from '../../helpers/express-utils'
|
|
import { MIMETYPES, VIDEO_PLAYLIST_PRIVACIES } from '../../initializers/constants'
|
|
import { logger } from '../../helpers/logger'
|
|
import { resetSequelizeInstance } from '../../helpers/database-utils'
|
|
import { VideoPlaylistModel } from '../../models/video/video-playlist'
|
|
import {
|
|
commonVideoPlaylistFiltersValidator,
|
|
videoPlaylistsAddValidator,
|
|
videoPlaylistsAddVideoValidator,
|
|
videoPlaylistsDeleteValidator,
|
|
videoPlaylistsGetValidator,
|
|
videoPlaylistsReorderVideosValidator,
|
|
videoPlaylistsUpdateOrRemoveVideoValidator,
|
|
videoPlaylistsUpdateValidator
|
|
} from '../../middlewares/validators/videos/video-playlists'
|
|
import { VideoPlaylistCreate } from '../../../shared/models/videos/playlist/video-playlist-create.model'
|
|
import { VideoPlaylistPrivacy } from '../../../shared/models/videos/playlist/video-playlist-privacy.model'
|
|
import { join } from 'path'
|
|
import { sendCreateVideoPlaylist, sendDeleteVideoPlaylist, sendUpdateVideoPlaylist } from '../../lib/activitypub/send'
|
|
import { getVideoPlaylistActivityPubUrl, getVideoPlaylistElementActivityPubUrl } from '../../lib/activitypub/url'
|
|
import { VideoPlaylistUpdate } from '../../../shared/models/videos/playlist/video-playlist-update.model'
|
|
import { VideoPlaylistElementModel } from '../../models/video/video-playlist-element'
|
|
import { VideoPlaylistElementCreate } from '../../../shared/models/videos/playlist/video-playlist-element-create.model'
|
|
import { VideoPlaylistElementUpdate } from '../../../shared/models/videos/playlist/video-playlist-element-update.model'
|
|
import { AccountModel } from '../../models/account/account'
|
|
import { VideoPlaylistReorder } from '../../../shared/models/videos/playlist/video-playlist-reorder.model'
|
|
import { JobQueue } from '../../lib/job-queue'
|
|
import { CONFIG } from '../../initializers/config'
|
|
import { sequelizeTypescript } from '../../initializers/database'
|
|
import { createPlaylistMiniatureFromExisting } from '../../lib/thumbnail'
|
|
import { VideoModel } from '../../models/video/video'
|
|
|
|
const reqThumbnailFile = createReqFiles([ 'thumbnailfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT, { thumbnailfile: CONFIG.STORAGE.TMP_DIR })
|
|
|
|
const videoPlaylistRouter = express.Router()
|
|
|
|
videoPlaylistRouter.get('/privacies', listVideoPlaylistPrivacies)
|
|
|
|
videoPlaylistRouter.get('/',
|
|
paginationValidator,
|
|
videoPlaylistsSortValidator,
|
|
setDefaultSort,
|
|
setDefaultPagination,
|
|
commonVideoPlaylistFiltersValidator,
|
|
asyncMiddleware(listVideoPlaylists)
|
|
)
|
|
|
|
videoPlaylistRouter.get('/:playlistId',
|
|
asyncMiddleware(videoPlaylistsGetValidator),
|
|
getVideoPlaylist
|
|
)
|
|
|
|
videoPlaylistRouter.post('/',
|
|
authenticate,
|
|
reqThumbnailFile,
|
|
asyncMiddleware(videoPlaylistsAddValidator),
|
|
asyncRetryTransactionMiddleware(addVideoPlaylist)
|
|
)
|
|
|
|
videoPlaylistRouter.put('/:playlistId',
|
|
authenticate,
|
|
reqThumbnailFile,
|
|
asyncMiddleware(videoPlaylistsUpdateValidator),
|
|
asyncRetryTransactionMiddleware(updateVideoPlaylist)
|
|
)
|
|
|
|
videoPlaylistRouter.delete('/:playlistId',
|
|
authenticate,
|
|
asyncMiddleware(videoPlaylistsDeleteValidator),
|
|
asyncRetryTransactionMiddleware(removeVideoPlaylist)
|
|
)
|
|
|
|
videoPlaylistRouter.get('/:playlistId/videos',
|
|
asyncMiddleware(videoPlaylistsGetValidator),
|
|
paginationValidator,
|
|
setDefaultPagination,
|
|
optionalAuthenticate,
|
|
asyncMiddleware(getVideoPlaylistVideos)
|
|
)
|
|
|
|
videoPlaylistRouter.post('/:playlistId/videos',
|
|
authenticate,
|
|
asyncMiddleware(videoPlaylistsAddVideoValidator),
|
|
asyncRetryTransactionMiddleware(addVideoInPlaylist)
|
|
)
|
|
|
|
videoPlaylistRouter.post('/:playlistId/videos/reorder',
|
|
authenticate,
|
|
asyncMiddleware(videoPlaylistsReorderVideosValidator),
|
|
asyncRetryTransactionMiddleware(reorderVideosPlaylist)
|
|
)
|
|
|
|
videoPlaylistRouter.put('/:playlistId/videos/:playlistElementId',
|
|
authenticate,
|
|
asyncMiddleware(videoPlaylistsUpdateOrRemoveVideoValidator),
|
|
asyncRetryTransactionMiddleware(updateVideoPlaylistElement)
|
|
)
|
|
|
|
videoPlaylistRouter.delete('/:playlistId/videos/:playlistElementId',
|
|
authenticate,
|
|
asyncMiddleware(videoPlaylistsUpdateOrRemoveVideoValidator),
|
|
asyncRetryTransactionMiddleware(removeVideoFromPlaylist)
|
|
)
|
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
export {
|
|
videoPlaylistRouter
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
function listVideoPlaylistPrivacies (req: express.Request, res: express.Response) {
|
|
res.json(VIDEO_PLAYLIST_PRIVACIES)
|
|
}
|
|
|
|
async function listVideoPlaylists (req: express.Request, res: express.Response) {
|
|
const serverActor = await getServerActor()
|
|
const resultList = await VideoPlaylistModel.listForApi({
|
|
followerActorId: serverActor.id,
|
|
start: req.query.start,
|
|
count: req.query.count,
|
|
sort: req.query.sort,
|
|
type: req.query.type
|
|
})
|
|
|
|
return res.json(getFormattedObjects(resultList.data, resultList.total))
|
|
}
|
|
|
|
function getVideoPlaylist (req: express.Request, res: express.Response) {
|
|
const videoPlaylist = res.locals.videoPlaylist
|
|
|
|
if (videoPlaylist.isOutdated()) {
|
|
JobQueue.Instance.createJob({ type: 'activitypub-refresher', payload: { type: 'video-playlist', url: videoPlaylist.url } })
|
|
.catch(err => logger.error('Cannot create AP refresher job for playlist %s.', videoPlaylist.url, { err }))
|
|
}
|
|
|
|
return res.json(videoPlaylist.toFormattedJSON())
|
|
}
|
|
|
|
async function addVideoPlaylist (req: express.Request, res: express.Response) {
|
|
const videoPlaylistInfo: VideoPlaylistCreate = req.body
|
|
const user = res.locals.oauth.token.User
|
|
|
|
const videoPlaylist = new VideoPlaylistModel({
|
|
name: videoPlaylistInfo.displayName,
|
|
description: videoPlaylistInfo.description,
|
|
privacy: videoPlaylistInfo.privacy || VideoPlaylistPrivacy.PRIVATE,
|
|
ownerAccountId: user.Account.id
|
|
})
|
|
|
|
videoPlaylist.url = getVideoPlaylistActivityPubUrl(videoPlaylist) // We use the UUID, so set the URL after building the object
|
|
|
|
if (videoPlaylistInfo.videoChannelId) {
|
|
const videoChannel = res.locals.videoChannel
|
|
|
|
videoPlaylist.videoChannelId = videoChannel.id
|
|
videoPlaylist.VideoChannel = videoChannel
|
|
}
|
|
|
|
const thumbnailField = req.files['thumbnailfile']
|
|
const thumbnailModel = thumbnailField
|
|
? await createPlaylistMiniatureFromExisting(thumbnailField[0].path, videoPlaylist, false)
|
|
: undefined
|
|
|
|
const videoPlaylistCreated: VideoPlaylistModel = await sequelizeTypescript.transaction(async t => {
|
|
const videoPlaylistCreated = await videoPlaylist.save({ transaction: t })
|
|
|
|
if (thumbnailModel) {
|
|
thumbnailModel.automaticallyGenerated = false
|
|
await videoPlaylistCreated.setAndSaveThumbnail(thumbnailModel, t)
|
|
}
|
|
|
|
// We need more attributes for the federation
|
|
videoPlaylistCreated.OwnerAccount = await AccountModel.load(user.Account.id, t)
|
|
await sendCreateVideoPlaylist(videoPlaylistCreated, t)
|
|
|
|
return videoPlaylistCreated
|
|
})
|
|
|
|
logger.info('Video playlist with uuid %s created.', videoPlaylist.uuid)
|
|
|
|
return res.json({
|
|
videoPlaylist: {
|
|
id: videoPlaylistCreated.id,
|
|
uuid: videoPlaylistCreated.uuid
|
|
}
|
|
}).end()
|
|
}
|
|
|
|
async function updateVideoPlaylist (req: express.Request, res: express.Response) {
|
|
const videoPlaylistInstance = res.locals.videoPlaylist
|
|
const videoPlaylistFieldsSave = videoPlaylistInstance.toJSON()
|
|
const videoPlaylistInfoToUpdate = req.body as VideoPlaylistUpdate
|
|
|
|
const wasPrivatePlaylist = videoPlaylistInstance.privacy === VideoPlaylistPrivacy.PRIVATE
|
|
const wasNotPrivatePlaylist = videoPlaylistInstance.privacy !== VideoPlaylistPrivacy.PRIVATE
|
|
|
|
const thumbnailField = req.files['thumbnailfile']
|
|
const thumbnailModel = thumbnailField
|
|
? await createPlaylistMiniatureFromExisting(thumbnailField[0].path, videoPlaylistInstance, false)
|
|
: undefined
|
|
|
|
try {
|
|
await sequelizeTypescript.transaction(async t => {
|
|
const sequelizeOptions = {
|
|
transaction: t
|
|
}
|
|
|
|
if (videoPlaylistInfoToUpdate.videoChannelId !== undefined) {
|
|
if (videoPlaylistInfoToUpdate.videoChannelId === null) {
|
|
videoPlaylistInstance.videoChannelId = null
|
|
} else {
|
|
const videoChannel = res.locals.videoChannel
|
|
|
|
videoPlaylistInstance.videoChannelId = videoChannel.id
|
|
videoPlaylistInstance.VideoChannel = videoChannel
|
|
}
|
|
}
|
|
|
|
if (videoPlaylistInfoToUpdate.displayName !== undefined) videoPlaylistInstance.name = videoPlaylistInfoToUpdate.displayName
|
|
if (videoPlaylistInfoToUpdate.description !== undefined) videoPlaylistInstance.description = videoPlaylistInfoToUpdate.description
|
|
|
|
if (videoPlaylistInfoToUpdate.privacy !== undefined) {
|
|
videoPlaylistInstance.privacy = parseInt(videoPlaylistInfoToUpdate.privacy.toString(), 10)
|
|
|
|
if (wasNotPrivatePlaylist === true && videoPlaylistInstance.privacy === VideoPlaylistPrivacy.PRIVATE) {
|
|
await sendDeleteVideoPlaylist(videoPlaylistInstance, t)
|
|
}
|
|
}
|
|
|
|
const playlistUpdated = await videoPlaylistInstance.save(sequelizeOptions)
|
|
|
|
if (thumbnailModel) {
|
|
thumbnailModel.automaticallyGenerated = false
|
|
await playlistUpdated.setAndSaveThumbnail(thumbnailModel, t)
|
|
}
|
|
|
|
const isNewPlaylist = wasPrivatePlaylist && playlistUpdated.privacy !== VideoPlaylistPrivacy.PRIVATE
|
|
|
|
if (isNewPlaylist) {
|
|
await sendCreateVideoPlaylist(playlistUpdated, t)
|
|
} else {
|
|
await sendUpdateVideoPlaylist(playlistUpdated, t)
|
|
}
|
|
|
|
logger.info('Video playlist %s updated.', videoPlaylistInstance.uuid)
|
|
|
|
return playlistUpdated
|
|
})
|
|
} catch (err) {
|
|
logger.debug('Cannot update the video playlist.', { err })
|
|
|
|
// Force fields we want to update
|
|
// If the transaction is retried, sequelize will think the object has not changed
|
|
// So it will skip the SQL request, even if the last one was ROLLBACKed!
|
|
resetSequelizeInstance(videoPlaylistInstance, videoPlaylistFieldsSave)
|
|
|
|
throw err
|
|
}
|
|
|
|
return res.type('json').status(204).end()
|
|
}
|
|
|
|
async function removeVideoPlaylist (req: express.Request, res: express.Response) {
|
|
const videoPlaylistInstance = res.locals.videoPlaylist
|
|
|
|
await sequelizeTypescript.transaction(async t => {
|
|
await videoPlaylistInstance.destroy({ transaction: t })
|
|
|
|
await sendDeleteVideoPlaylist(videoPlaylistInstance, t)
|
|
|
|
logger.info('Video playlist %s deleted.', videoPlaylistInstance.uuid)
|
|
})
|
|
|
|
return res.type('json').status(204).end()
|
|
}
|
|
|
|
async function addVideoInPlaylist (req: express.Request, res: express.Response) {
|
|
const body: VideoPlaylistElementCreate = req.body
|
|
const videoPlaylist = res.locals.videoPlaylist
|
|
const video = res.locals.video
|
|
|
|
const playlistElement: VideoPlaylistElementModel = await sequelizeTypescript.transaction(async t => {
|
|
const position = await VideoPlaylistElementModel.getNextPositionOf(videoPlaylist.id, t)
|
|
|
|
const playlistElement = await VideoPlaylistElementModel.create({
|
|
url: getVideoPlaylistElementActivityPubUrl(videoPlaylist, video),
|
|
position,
|
|
startTimestamp: body.startTimestamp || null,
|
|
stopTimestamp: body.stopTimestamp || null,
|
|
videoPlaylistId: videoPlaylist.id,
|
|
videoId: video.id
|
|
}, { transaction: t })
|
|
|
|
videoPlaylist.changed('updatedAt', true)
|
|
await videoPlaylist.save({ transaction: t })
|
|
|
|
return playlistElement
|
|
})
|
|
|
|
// If the user did not set a thumbnail, automatically take the video thumbnail
|
|
if (videoPlaylist.hasThumbnail() === false || (videoPlaylist.hasGeneratedThumbnail() && playlistElement.position === 1)) {
|
|
await generateThumbnailForPlaylist(videoPlaylist, video)
|
|
}
|
|
|
|
sendUpdateVideoPlaylist(videoPlaylist, undefined)
|
|
.catch(err => logger.error('Cannot send video playlist update.', { err }))
|
|
|
|
logger.info('Video added in playlist %s at position %d.', videoPlaylist.uuid, playlistElement.position)
|
|
|
|
return res.json({
|
|
videoPlaylistElement: {
|
|
id: playlistElement.id
|
|
}
|
|
}).end()
|
|
}
|
|
|
|
async function updateVideoPlaylistElement (req: express.Request, res: express.Response) {
|
|
const body: VideoPlaylistElementUpdate = req.body
|
|
const videoPlaylist = res.locals.videoPlaylist
|
|
const videoPlaylistElement = res.locals.videoPlaylistElement
|
|
|
|
const playlistElement: VideoPlaylistElementModel = await sequelizeTypescript.transaction(async t => {
|
|
if (body.startTimestamp !== undefined) videoPlaylistElement.startTimestamp = body.startTimestamp
|
|
if (body.stopTimestamp !== undefined) videoPlaylistElement.stopTimestamp = body.stopTimestamp
|
|
|
|
const element = await videoPlaylistElement.save({ transaction: t })
|
|
|
|
videoPlaylist.changed('updatedAt', true)
|
|
await videoPlaylist.save({ transaction: t })
|
|
|
|
await sendUpdateVideoPlaylist(videoPlaylist, t)
|
|
|
|
return element
|
|
})
|
|
|
|
logger.info('Element of position %d of playlist %s updated.', playlistElement.position, videoPlaylist.uuid)
|
|
|
|
return res.type('json').status(204).end()
|
|
}
|
|
|
|
async function removeVideoFromPlaylist (req: express.Request, res: express.Response) {
|
|
const videoPlaylistElement = res.locals.videoPlaylistElement
|
|
const videoPlaylist = res.locals.videoPlaylist
|
|
const positionToDelete = videoPlaylistElement.position
|
|
|
|
await sequelizeTypescript.transaction(async t => {
|
|
await videoPlaylistElement.destroy({ transaction: t })
|
|
|
|
// Decrease position of the next elements
|
|
await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, positionToDelete, null, -1, t)
|
|
|
|
videoPlaylist.changed('updatedAt', true)
|
|
await videoPlaylist.save({ transaction: t })
|
|
|
|
logger.info('Video playlist element %d of playlist %s deleted.', videoPlaylistElement.position, videoPlaylist.uuid)
|
|
})
|
|
|
|
// Do we need to regenerate the default thumbnail?
|
|
if (positionToDelete === 1 && videoPlaylist.hasGeneratedThumbnail()) {
|
|
await regeneratePlaylistThumbnail(videoPlaylist)
|
|
}
|
|
|
|
sendUpdateVideoPlaylist(videoPlaylist, undefined)
|
|
.catch(err => logger.error('Cannot send video playlist update.', { err }))
|
|
|
|
return res.type('json').status(204).end()
|
|
}
|
|
|
|
async function reorderVideosPlaylist (req: express.Request, res: express.Response) {
|
|
const videoPlaylist = res.locals.videoPlaylist
|
|
const body: VideoPlaylistReorder = req.body
|
|
|
|
const start: number = body.startPosition
|
|
const insertAfter: number = body.insertAfterPosition
|
|
const reorderLength: number = body.reorderLength || 1
|
|
|
|
if (start === insertAfter) {
|
|
return res.status(204).end()
|
|
}
|
|
|
|
// Example: if we reorder position 2 and insert after position 5 (so at position 6): # 1 2 3 4 5 6 7 8 9
|
|
// * increase position when position > 5 # 1 2 3 4 5 7 8 9 10
|
|
// * update position 2 -> position 6 # 1 3 4 5 6 7 8 9 10
|
|
// * decrease position when position position > 2 # 1 2 3 4 5 6 7 8 9
|
|
await sequelizeTypescript.transaction(async t => {
|
|
const newPosition = insertAfter + 1
|
|
|
|
// Add space after the position when we want to insert our reordered elements (increase)
|
|
await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, newPosition, null, reorderLength, t)
|
|
|
|
let oldPosition = start
|
|
|
|
// We incremented the position of the elements we want to reorder
|
|
if (start >= newPosition) oldPosition += reorderLength
|
|
|
|
const endOldPosition = oldPosition + reorderLength - 1
|
|
// Insert our reordered elements in their place (update)
|
|
await VideoPlaylistElementModel.reassignPositionOf(videoPlaylist.id, oldPosition, endOldPosition, newPosition, t)
|
|
|
|
// Decrease positions of elements after the old position of our ordered elements (decrease)
|
|
await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, oldPosition, null, -reorderLength, t)
|
|
|
|
videoPlaylist.changed('updatedAt', true)
|
|
await videoPlaylist.save({ transaction: t })
|
|
|
|
await sendUpdateVideoPlaylist(videoPlaylist, t)
|
|
})
|
|
|
|
// The first element changed
|
|
if ((start === 1 || insertAfter === 0) && videoPlaylist.hasGeneratedThumbnail()) {
|
|
await regeneratePlaylistThumbnail(videoPlaylist)
|
|
}
|
|
|
|
logger.info(
|
|
'Reordered playlist %s (inserted after position %d elements %d - %d).',
|
|
videoPlaylist.uuid, insertAfter, start, start + reorderLength - 1
|
|
)
|
|
|
|
return res.type('json').status(204).end()
|
|
}
|
|
|
|
async function getVideoPlaylistVideos (req: express.Request, res: express.Response) {
|
|
const videoPlaylistInstance = res.locals.videoPlaylist
|
|
const user = res.locals.oauth ? res.locals.oauth.token.User : undefined
|
|
const server = await getServerActor()
|
|
|
|
const resultList = await VideoPlaylistElementModel.listForApi({
|
|
start: req.query.start,
|
|
count: req.query.count,
|
|
videoPlaylistId: videoPlaylistInstance.id,
|
|
serverAccount: server.Account,
|
|
user
|
|
})
|
|
|
|
const options = {
|
|
displayNSFW: buildNSFWFilter(res, req.query.nsfw),
|
|
accountId: user ? user.Account.id : undefined
|
|
}
|
|
return res.json(getFormattedObjects(resultList.data, resultList.total, options))
|
|
}
|
|
|
|
async function regeneratePlaylistThumbnail (videoPlaylist: VideoPlaylistModel) {
|
|
await videoPlaylist.Thumbnail.destroy()
|
|
videoPlaylist.Thumbnail = null
|
|
|
|
const firstElement = await VideoPlaylistElementModel.loadFirstElementWithVideoThumbnail(videoPlaylist.id)
|
|
if (firstElement) await generateThumbnailForPlaylist(videoPlaylist, firstElement.Video)
|
|
}
|
|
|
|
async function generateThumbnailForPlaylist (videoPlaylist: VideoPlaylistModel, video: VideoModel) {
|
|
logger.info('Generating default thumbnail to playlist %s.', videoPlaylist.url)
|
|
|
|
const inputPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, video.getMiniature().filename)
|
|
const thumbnailModel = await createPlaylistMiniatureFromExisting(inputPath, videoPlaylist, true, true)
|
|
|
|
thumbnailModel.videoPlaylistId = videoPlaylist.id
|
|
|
|
videoPlaylist.Thumbnail = await thumbnailModel.save()
|
|
}
|