X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fcontrollers%2Fapi%2Fvideo-playlist.ts;h=de32dec88d2a26015d8f11d2f1e0b0cc441cb303;hb=cb0eda5602a21d1626a7face32de6153ed07b5f9;hp=6a1d23529d376a0054312aa7fed57ff61648ba88;hpb=3acc50844047a37698f0618fa235c138e386a053;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/controllers/api/video-playlist.ts b/server/controllers/api/video-playlist.ts index 6a1d23529..de32dec88 100644 --- a/server/controllers/api/video-playlist.ts +++ b/server/controllers/api/video-playlist.ts @@ -1,21 +1,39 @@ -import * as express from 'express' -import { getFormattedObjects, getServerActor } from '../../helpers/utils' +import express from 'express' +import { join } from 'path' +import { scheduleRefreshIfNeeded } from '@server/lib/activitypub/playlists' +import { Hooks } from '@server/lib/plugins/hooks' +import { getServerActor } from '@server/models/application/application' +import { MVideoPlaylistFull, MVideoPlaylistThumbnail, MVideoThumbnail } from '@server/types/models' +import { forceNumber } from '@shared/core-utils' +import { uuidToShort } from '@shared/extra-utils' +import { VideoPlaylistCreateResult, VideoPlaylistElementCreateResult } from '@shared/models' +import { HttpStatusCode } from '../../../shared/models/http/http-error-codes' +import { VideoPlaylistCreate } from '../../../shared/models/videos/playlist/video-playlist-create.model' +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 { VideoPlaylistPrivacy } from '../../../shared/models/videos/playlist/video-playlist-privacy.model' +import { VideoPlaylistReorder } from '../../../shared/models/videos/playlist/video-playlist-reorder.model' +import { VideoPlaylistUpdate } from '../../../shared/models/videos/playlist/video-playlist-update.model' +import { resetSequelizeInstance } from '../../helpers/database-utils' +import { createReqFiles } from '../../helpers/express-utils' +import { logger } from '../../helpers/logger' +import { getFormattedObjects } from '../../helpers/utils' +import { CONFIG } from '../../initializers/config' +import { MIMETYPES, VIDEO_PLAYLIST_PRIVACIES } from '../../initializers/constants' +import { sequelizeTypescript } from '../../initializers/database' +import { sendCreateVideoPlaylist, sendDeleteVideoPlaylist, sendUpdateVideoPlaylist } from '../../lib/activitypub/send' +import { getLocalVideoPlaylistActivityPubUrl, getLocalVideoPlaylistElementActivityPubUrl } from '../../lib/activitypub/url' +import { updatePlaylistMiniatureFromExisting } from '../../lib/thumbnail' import { asyncMiddleware, asyncRetryTransactionMiddleware, authenticate, - commonVideosFiltersValidator, optionalAuthenticate, paginationValidator, setDefaultPagination, setDefaultSort } from '../../middlewares' import { videoPlaylistsSortValidator } from '../../middlewares/validators' -import { buildNSFWFilter, createReqFiles, isUserAbleToSearchRemoteURI } 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, @@ -26,24 +44,11 @@ import { 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 { VideoModel } from '../../models/video/video' -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 { VideoPlaylistModel } from '../../models/video/video-playlist' +import { VideoPlaylistElementModel } from '../../models/video/video-playlist-element' -const reqThumbnailFile = createReqFiles([ 'thumbnailfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT, { thumbnailfile: CONFIG.STORAGE.TMP_DIR }) +const reqThumbnailFile = createReqFiles([ 'thumbnailfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT) const videoPlaylistRouter = express.Router() @@ -59,7 +64,7 @@ videoPlaylistRouter.get('/', ) videoPlaylistRouter.get('/:playlistId', - asyncMiddleware(videoPlaylistsGetValidator), + asyncMiddleware(videoPlaylistsGetValidator('summary')), getVideoPlaylist ) @@ -84,11 +89,10 @@ videoPlaylistRouter.delete('/:playlistId', ) videoPlaylistRouter.get('/:playlistId/videos', - asyncMiddleware(videoPlaylistsGetValidator), + asyncMiddleware(videoPlaylistsGetValidator('summary')), paginationValidator, setDefaultPagination, optionalAuthenticate, - commonVideosFiltersValidator, asyncMiddleware(getVideoPlaylistVideos) ) @@ -104,13 +108,13 @@ videoPlaylistRouter.post('/:playlistId/videos/reorder', asyncRetryTransactionMiddleware(reorderVideosPlaylist) ) -videoPlaylistRouter.put('/:playlistId/videos/:videoId', +videoPlaylistRouter.put('/:playlistId/videos/:playlistElementId', authenticate, asyncMiddleware(videoPlaylistsUpdateOrRemoveVideoValidator), asyncRetryTransactionMiddleware(updateVideoPlaylistElement) ) -videoPlaylistRouter.delete('/:playlistId/videos/:videoId', +videoPlaylistRouter.delete('/:playlistId/videos/:playlistElementId', authenticate, asyncMiddleware(videoPlaylistsUpdateOrRemoveVideoValidator), asyncRetryTransactionMiddleware(removeVideoFromPlaylist) @@ -135,19 +139,16 @@ async function listVideoPlaylists (req: express.Request, res: express.Response) start: req.query.start, count: req.query.count, sort: req.query.sort, - type: req.query.type + type: req.query.playlistType }) return res.json(getFormattedObjects(resultList.data, resultList.total)) } function getVideoPlaylist (req: express.Request, res: express.Response) { - const videoPlaylist = res.locals.videoPlaylist + const videoPlaylist = res.locals.videoPlaylistSummary - 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 })) - } + scheduleRefreshIfNeeded(videoPlaylist) return res.json(videoPlaylist.toFormattedJSON()) } @@ -161,9 +162,9 @@ async function addVideoPlaylist (req: express.Request, res: express.Response) { description: videoPlaylistInfo.description, privacy: videoPlaylistInfo.privacy || VideoPlaylistPrivacy.PRIVATE, ownerAccountId: user.Account.id - }) + }) as MVideoPlaylistFull - videoPlaylist.url = getVideoPlaylistActivityPubUrl(videoPlaylist) // We use the UUID, so set the URL after building the object + videoPlaylist.url = getLocalVideoPlaylistActivityPubUrl(videoPlaylist) // We use the UUID, so set the URL after building the object if (videoPlaylistInfo.videoChannelId) { const videoChannel = res.locals.videoChannel @@ -174,13 +175,20 @@ async function addVideoPlaylist (req: express.Request, res: express.Response) { const thumbnailField = req.files['thumbnailfile'] const thumbnailModel = thumbnailField - ? await createPlaylistMiniatureFromExisting(thumbnailField[0].path, videoPlaylist) + ? await updatePlaylistMiniatureFromExisting({ + inputPath: thumbnailField[0].path, + playlist: videoPlaylist, + automaticallyGenerated: false + }) : undefined - const videoPlaylistCreated: VideoPlaylistModel = await sequelizeTypescript.transaction(async t => { - const videoPlaylistCreated = await videoPlaylist.save({ transaction: t }) + const videoPlaylistCreated = await sequelizeTypescript.transaction(async t => { + const videoPlaylistCreated = await videoPlaylist.save({ transaction: t }) as MVideoPlaylistFull - if (thumbnailModel) await videoPlaylistCreated.setAndSaveThumbnail(thumbnailModel, 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) @@ -194,20 +202,26 @@ async function addVideoPlaylist (req: express.Request, res: express.Response) { return res.json({ videoPlaylist: { id: videoPlaylistCreated.id, + shortUUID: uuidToShort(videoPlaylistCreated.uuid), uuid: videoPlaylistCreated.uuid - } - }).end() + } as VideoPlaylistCreateResult + }) } async function updateVideoPlaylist (req: express.Request, res: express.Response) { - const videoPlaylistInstance = res.locals.videoPlaylist - const videoPlaylistFieldsSave = videoPlaylistInstance.toJSON() + const videoPlaylistInstance = res.locals.videoPlaylistFull 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) + ? await updatePlaylistMiniatureFromExisting({ + inputPath: thumbnailField[0].path, + playlist: videoPlaylistInstance, + automaticallyGenerated: false + }) : undefined try { @@ -231,12 +245,19 @@ async function updateVideoPlaylist (req: express.Request, res: express.Response) if (videoPlaylistInfoToUpdate.description !== undefined) videoPlaylistInstance.description = videoPlaylistInfoToUpdate.description if (videoPlaylistInfoToUpdate.privacy !== undefined) { - videoPlaylistInstance.privacy = parseInt(videoPlaylistInfoToUpdate.privacy.toString(), 10) + videoPlaylistInstance.privacy = forceNumber(videoPlaylistInfoToUpdate.privacy) + + if (wasNotPrivatePlaylist === true && videoPlaylistInstance.privacy === VideoPlaylistPrivacy.PRIVATE) { + await sendDeleteVideoPlaylist(videoPlaylistInstance, t) + } } const playlistUpdated = await videoPlaylistInstance.save(sequelizeOptions) - if (thumbnailModel) await playlistUpdated.setAndSaveThumbnail(thumbnailModel, t) + if (thumbnailModel) { + thumbnailModel.automaticallyGenerated = false + await playlistUpdated.setAndSaveThumbnail(thumbnailModel, t) + } const isNewPlaylist = wasPrivatePlaylist && playlistUpdated.privacy !== VideoPlaylistPrivacy.PRIVATE @@ -253,19 +274,18 @@ async function updateVideoPlaylist (req: express.Request, res: express.Response) } 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) + // So we need to restore the previous fields + await resetSequelizeInstance(videoPlaylistInstance) throw err } - return res.type('json').status(204).end() + return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end() } async function removeVideoPlaylist (req: express.Request, res: express.Response) { - const videoPlaylistInstance = res.locals.videoPlaylist + const videoPlaylistInstance = res.locals.videoPlaylistSummary await sequelizeTypescript.transaction(async t => { await videoPlaylistInstance.destroy({ transaction: t }) @@ -275,19 +295,18 @@ async function removeVideoPlaylist (req: express.Request, res: express.Response) logger.info('Video playlist %s deleted.', videoPlaylistInstance.uuid) }) - return res.type('json').status(204).end() + return res.type('json').status(HttpStatusCode.NO_CONTENT_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 videoPlaylist = res.locals.videoPlaylistFull + const video = res.locals.onlyVideo - const playlistElement: VideoPlaylistElementModel = await sequelizeTypescript.transaction(async t => { + const playlistElement = 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, @@ -295,38 +314,37 @@ async function addVideoInPlaylist (req: express.Request, res: express.Response) videoId: video.id }, { transaction: t }) + playlistElement.url = getLocalVideoPlaylistElementActivityPubUrl(videoPlaylist, playlistElement) + await playlistElement.save({ transaction: t }) + videoPlaylist.changed('updatedAt', true) await videoPlaylist.save({ transaction: t }) - await sendUpdateVideoPlaylist(videoPlaylist, t) - return playlistElement }) // If the user did not set a thumbnail, automatically take the video thumbnail - if (playlistElement.position === 1 && videoPlaylist.hasThumbnail() === false) { - 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) - - thumbnailModel.videoPlaylistId = videoPlaylist.id - - await thumbnailModel.save() + 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) + Hooks.runAction('action:api.video-playlist-element.created', { playlistElement, req, res }) + return res.json({ videoPlaylistElement: { id: playlistElement.id - } - }).end() + } as VideoPlaylistElementCreateResult + }) } async function updateVideoPlaylistElement (req: express.Request, res: express.Response) { const body: VideoPlaylistElementUpdate = req.body - const videoPlaylist = res.locals.videoPlaylist + const videoPlaylist = res.locals.videoPlaylistFull const videoPlaylistElement = res.locals.videoPlaylistElement const playlistElement: VideoPlaylistElementModel = await sequelizeTypescript.transaction(async t => { @@ -345,33 +363,39 @@ async function updateVideoPlaylistElement (req: express.Request, res: express.Re logger.info('Element of position %d of playlist %s updated.', playlistElement.position, videoPlaylist.uuid) - return res.type('json').status(204).end() + return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end() } async function removeVideoFromPlaylist (req: express.Request, res: express.Response) { const videoPlaylistElement = res.locals.videoPlaylistElement - const videoPlaylist = res.locals.videoPlaylist + const videoPlaylist = res.locals.videoPlaylistFull 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) + await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, positionToDelete, -1, t) videoPlaylist.changed('updatedAt', true) await videoPlaylist.save({ transaction: t }) - await sendUpdateVideoPlaylist(videoPlaylist, t) - logger.info('Video playlist element %d of playlist %s deleted.', videoPlaylistElement.position, videoPlaylist.uuid) }) - return res.type('json').status(204).end() + // 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(HttpStatusCode.NO_CONTENT_204).end() } async function reorderVideosPlaylist (req: express.Request, res: express.Response) { - const videoPlaylist = res.locals.videoPlaylist + const videoPlaylist = res.locals.videoPlaylistFull const body: VideoPlaylistReorder = req.body const start: number = body.startPosition @@ -379,7 +403,7 @@ async function reorderVideosPlaylist (req: express.Request, res: express.Respons const reorderLength: number = body.reorderLength || 1 if (start === insertAfter) { - return res.status(204).end() + return res.status(HttpStatusCode.NO_CONTENT_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 @@ -390,7 +414,7 @@ async function reorderVideosPlaylist (req: express.Request, res: express.Respons 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) + await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, newPosition, reorderLength, t) let oldPosition = start @@ -399,10 +423,16 @@ async function reorderVideosPlaylist (req: express.Request, res: express.Respons const endOldPosition = oldPosition + reorderLength - 1 // Insert our reordered elements in their place (update) - await VideoPlaylistElementModel.reassignPositionOf(videoPlaylist.id, oldPosition, endOldPosition, newPosition, t) + await VideoPlaylistElementModel.reassignPositionOf({ + videoPlaylistId: videoPlaylist.id, + firstPosition: oldPosition, + endPosition: endOldPosition, + newPosition, + transaction: t + }) // Decrease positions of elements after the old position of our ordered elements (decrease) - await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, oldPosition, null, -reorderLength, t) + await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, oldPosition, -reorderLength, t) videoPlaylist.changed('updatedAt', true) await videoPlaylist.save({ transaction: t }) @@ -410,36 +440,68 @@ async function reorderVideosPlaylist (req: express.Request, res: express.Respons 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 %d elements %d - %d).', + 'Reordered playlist %s (inserted after position %d elements %d - %d).', videoPlaylist.uuid, insertAfter, start, start + reorderLength - 1 ) - return res.type('json').status(204).end() + return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end() } async function getVideoPlaylistVideos (req: express.Request, res: express.Response) { - const videoPlaylistInstance = res.locals.videoPlaylist - const followerActorId = isUserAbleToSearchRemoteURI(res) ? null : undefined + const videoPlaylistInstance = res.locals.videoPlaylistSummary + const user = res.locals.oauth ? res.locals.oauth.token.User : undefined + const server = await getServerActor() - const resultList = await VideoModel.listForApi({ - followerActorId, + const apiOptions = await Hooks.wrapObject({ start: req.query.start, count: req.query.count, - sort: 'VideoPlaylistElements.position', - includeLocalVideos: true, - categoryOneOf: req.query.categoryOneOf, - licenceOneOf: req.query.licenceOneOf, - languageOneOf: req.query.languageOneOf, - tagsOneOf: req.query.tagsOneOf, - tagsAllOf: req.query.tagsAllOf, - filter: req.query.filter, - nsfw: buildNSFWFilter(res, req.query.nsfw), - withFiles: false, videoPlaylistId: videoPlaylistInstance.id, - user: res.locals.oauth ? res.locals.oauth.token.User : undefined + serverAccount: server.Account, + user + }, 'filter:api.video-playlist.videos.list.params') + + const resultList = await Hooks.wrapPromiseFun( + VideoPlaylistElementModel.listForApi, + apiOptions, + 'filter:api.video-playlist.videos.list.result' + ) + + const options = { accountId: user?.Account?.id } + return res.json(getFormattedObjects(resultList.data, resultList.total, options)) +} + +async function regeneratePlaylistThumbnail (videoPlaylist: MVideoPlaylistThumbnail) { + 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: MVideoPlaylistThumbnail, video: MVideoThumbnail) { + logger.info('Generating default thumbnail to playlist %s.', videoPlaylist.url) + + const videoMiniature = video.getMiniature() + if (!videoMiniature) { + logger.info('Cannot generate thumbnail for playlist %s because video %s does not have any.', videoPlaylist.url, video.url) + return + } + + const inputPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, videoMiniature.filename) + const thumbnailModel = await updatePlaylistMiniatureFromExisting({ + inputPath, + playlist: videoPlaylist, + automaticallyGenerated: true, + keepOriginal: true }) - const additionalAttributes = { playlistInfo: true } - return res.json(getFormattedObjects(resultList.data, resultList.total, { additionalAttributes })) + thumbnailModel.videoPlaylistId = videoPlaylist.id + + videoPlaylist.Thumbnail = await thumbnailModel.save() }