X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fcontrollers%2Fapi%2Fvideo-playlist.ts;h=bcb60e26513ab46a21103c2abbdb837b60779acb;hb=4565774669bc3c1b11cc726d577946953dbe53c5;hp=b51490bf914f599c301c1796dfc89f3e25938158;hpb=a30a136c9896c656cab98d2c92cde32c534dc098;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/controllers/api/video-playlist.ts b/server/controllers/api/video-playlist.ts index b51490bf9..bcb60e265 100644 --- a/server/controllers/api/video-playlist.ts +++ b/server/controllers/api/video-playlist.ts @@ -1,5 +1,29 @@ -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, @@ -10,11 +34,6 @@ import { 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, @@ -25,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 { 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 { MVideoPlaylistFull, MVideoPlaylistThumbnail, MVideoThumbnail } from '@server/typings/models' +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() @@ -142,9 +148,7 @@ async function listVideoPlaylists (req: express.Request, res: express.Response) function getVideoPlaylist (req: express.Request, res: express.Response) { const videoPlaylist = res.locals.videoPlaylistSummary - if (videoPlaylist.isOutdated()) { - JobQueue.Instance.createJob({ type: 'activitypub-refresher', payload: { type: 'video-playlist', url: videoPlaylist.url } }) - } + scheduleRefreshIfNeeded(videoPlaylist) return res.json(videoPlaylist.toFormattedJSON()) } @@ -160,7 +164,7 @@ async function addVideoPlaylist (req: express.Request, res: express.Response) { 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 @@ -171,7 +175,11 @@ async function addVideoPlaylist (req: express.Request, res: express.Response) { const thumbnailField = req.files['thumbnailfile'] const thumbnailModel = thumbnailField - ? await createPlaylistMiniatureFromExisting(thumbnailField[0].path, videoPlaylist, false) + ? await updatePlaylistMiniatureFromExisting({ + inputPath: thumbnailField[0].path, + playlist: videoPlaylist, + automaticallyGenerated: false + }) : undefined const videoPlaylistCreated = await sequelizeTypescript.transaction(async t => { @@ -194,14 +202,14 @@ 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.videoPlaylistFull - const videoPlaylistFieldsSave = videoPlaylistInstance.toJSON() const videoPlaylistInfoToUpdate = req.body as VideoPlaylistUpdate const wasPrivatePlaylist = videoPlaylistInstance.privacy === VideoPlaylistPrivacy.PRIVATE @@ -209,7 +217,11 @@ async function updateVideoPlaylist (req: express.Request, res: express.Response) const thumbnailField = req.files['thumbnailfile'] const thumbnailModel = thumbnailField - ? await createPlaylistMiniatureFromExisting(thumbnailField[0].path, videoPlaylistInstance, false) + ? await updatePlaylistMiniatureFromExisting({ + inputPath: thumbnailField[0].path, + playlist: videoPlaylistInstance, + automaticallyGenerated: false + }) : undefined try { @@ -233,7 +245,7 @@ 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) @@ -262,15 +274,14 @@ 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 + 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) { @@ -284,7 +295,7 @@ 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) { @@ -296,7 +307,6 @@ async function addVideoInPlaylist (req: express.Request, res: express.Response) 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, @@ -304,6 +314,9 @@ 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 }) @@ -320,11 +333,13 @@ async function addVideoInPlaylist (req: express.Request, res: express.Response) 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) { @@ -348,7 +363,7 @@ 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) { @@ -360,7 +375,7 @@ async function removeVideoFromPlaylist (req: express.Request, res: express.Respo 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 }) @@ -376,7 +391,7 @@ async function removeVideoFromPlaylist (req: express.Request, res: express.Respo sendUpdateVideoPlaylist(videoPlaylist, undefined) .catch(err => logger.error('Cannot send video playlist update.', { err })) - return res.type('json').status(204).end() + return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end() } async function reorderVideosPlaylist (req: express.Request, res: express.Response) { @@ -388,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 @@ -399,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 @@ -408,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 }) @@ -429,7 +450,7 @@ async function reorderVideosPlaylist (req: express.Request, res: express.Respons 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) { @@ -437,18 +458,21 @@ async function getVideoPlaylistVideos (req: express.Request, res: express.Respon const user = res.locals.oauth ? res.locals.oauth.token.User : undefined const server = await getServerActor() - const resultList = await VideoPlaylistElementModel.listForApi({ + const apiOptions = await Hooks.wrapObject({ start: req.query.start, count: req.query.count, videoPlaylistId: videoPlaylistInstance.id, serverAccount: server.Account, user - }) + }, 'filter:api.video-playlist.videos.list.params') - const options = { - displayNSFW: buildNSFWFilter(res, req.query.nsfw), - accountId: user ? user.Account.id : undefined - } + 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)) } @@ -463,8 +487,19 @@ async function regeneratePlaylistThumbnail (videoPlaylist: MVideoPlaylistThumbna async function generateThumbnailForPlaylist (videoPlaylist: MVideoPlaylistThumbnail, video: MVideoThumbnail) { 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) + 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 + }) thumbnailModel.videoPlaylistId = videoPlaylist.id