X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fcontrollers%2Fapi%2Fvideo-channel.ts;h=5b9fb794ae9bb94a7afba909efc060aa59e34a48;hb=4565774669bc3c1b11cc726d577946953dbe53c5;hp=d779f1aab5b187065a75a8459de01f40b6f2523a;hpb=e1c5503114deef954731904695cd40dccfcef555;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/controllers/api/video-channel.ts b/server/controllers/api/video-channel.ts index d779f1aab..5b9fb794a 100644 --- a/server/controllers/api/video-channel.ts +++ b/server/controllers/api/video-channel.ts @@ -1,45 +1,59 @@ -import * as express from 'express' +import express from 'express' +import { pickCommonVideoQuery } from '@server/helpers/query' +import { getBiggestActorImage } from '@server/lib/actor-image' +import { Hooks } from '@server/lib/plugins/hooks' +import { ActorFollowModel } from '@server/models/actor/actor-follow' +import { getServerActor } from '@server/models/application/application' +import { guessAdditionalAttributesFromQuery } from '@server/models/video/formatter/video-format-utils' +import { MChannelBannerAccountDefault } from '@server/types/models' +import { ActorImageType, HttpStatusCode, VideoChannelCreate, VideoChannelUpdate, VideosImportInChannelCreate } from '@shared/models' +import { auditLoggerFactory, getAuditIdFromRes, VideoChannelAuditView } from '../../helpers/audit-logger' +import { resetSequelizeInstance } from '../../helpers/database-utils' +import { buildNSFWFilter, createReqFiles, getCountVideos, isUserAbleToSearchRemoteURI } from '../../helpers/express-utils' +import { logger } from '../../helpers/logger' import { getFormattedObjects } from '../../helpers/utils' +import { MIMETYPES } from '../../initializers/constants' +import { sequelizeTypescript } from '../../initializers/database' +import { sendUpdateActor } from '../../lib/activitypub/send' +import { JobQueue } from '../../lib/job-queue' +import { deleteLocalActorImageFile, updateLocalActorImageFiles } from '../../lib/local-actor' +import { createLocalVideoChannel, federateAllVideosOfChannel } from '../../lib/video-channel' import { asyncMiddleware, asyncRetryTransactionMiddleware, authenticate, commonVideosFiltersValidator, + ensureCanManageChannelOrAccount, optionalAuthenticate, paginationValidator, setDefaultPagination, setDefaultSort, + setDefaultVideosSort, videoChannelsAddValidator, videoChannelsRemoveValidator, videoChannelsSortValidator, videoChannelsUpdateValidator, videoPlaylistsSortValidator } from '../../middlewares' -import { VideoChannelModel } from '../../models/video/video-channel' -import { videoChannelsNameWithHostValidator, videosSortValidator } from '../../middlewares/validators' -import { sendUpdateActor } from '../../lib/activitypub/send' -import { VideoChannelCreate, VideoChannelUpdate } from '../../../shared' -import { createLocalVideoChannel, federateAllVideosOfChannel } from '../../lib/video-channel' -import { buildNSFWFilter, createReqFiles, getCountVideos, isUserAbleToSearchRemoteURI } from '../../helpers/express-utils' -import { setAsyncActorKeys } from '../../lib/activitypub/actor' +import { + ensureChannelOwnerCanUpload, + ensureIsLocalChannel, + videoChannelImportVideosValidator, + videoChannelsFollowersSortValidator, + videoChannelsListValidator, + videoChannelsNameWithHostValidator, + videosSortValidator +} from '../../middlewares/validators' +import { updateAvatarValidator, updateBannerValidator } from '../../middlewares/validators/actor-image' +import { commonVideoPlaylistFiltersValidator } from '../../middlewares/validators/videos/video-playlists' import { AccountModel } from '../../models/account/account' -import { MIMETYPES } from '../../initializers/constants' -import { logger } from '../../helpers/logger' import { VideoModel } from '../../models/video/video' -import { updateAvatarValidator } from '../../middlewares/validators/avatar' -import { updateActorAvatarFile } from '../../lib/avatar' -import { auditLoggerFactory, getAuditIdFromRes, VideoChannelAuditView } from '../../helpers/audit-logger' -import { resetSequelizeInstance } from '../../helpers/database-utils' -import { JobQueue } from '../../lib/job-queue' +import { VideoChannelModel } from '../../models/video/video-channel' import { VideoPlaylistModel } from '../../models/video/video-playlist' -import { commonVideoPlaylistFiltersValidator } from '../../middlewares/validators/videos/video-playlists' -import { CONFIG } from '../../initializers/config' -import { sequelizeTypescript } from '../../initializers/database' -import { MChannelAccountDefault } from '@server/typings/models' -import { getServerActor } from '@server/models/application/application' const auditLogger = auditLoggerFactory('channels') -const reqAvatarFile = createReqFiles([ 'avatarfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT, { avatarfile: CONFIG.STORAGE.TMP_DIR }) +const reqAvatarFile = createReqFiles([ 'avatarfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT) +const reqBannerFile = createReqFiles([ 'bannerfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT) const videoChannelRouter = express.Router() @@ -48,6 +62,7 @@ videoChannelRouter.get('/', videoChannelsSortValidator, setDefaultSort, setDefaultPagination, + videoChannelsListValidator, asyncMiddleware(listVideoChannels) ) @@ -60,20 +75,53 @@ videoChannelRouter.post('/', videoChannelRouter.post('/:nameWithHost/avatar/pick', authenticate, reqAvatarFile, - // Check the rights - asyncMiddleware(videoChannelsUpdateValidator), + asyncMiddleware(videoChannelsNameWithHostValidator), + ensureIsLocalChannel, + ensureCanManageChannelOrAccount, updateAvatarValidator, asyncMiddleware(updateVideoChannelAvatar) ) +videoChannelRouter.post('/:nameWithHost/banner/pick', + authenticate, + reqBannerFile, + asyncMiddleware(videoChannelsNameWithHostValidator), + ensureIsLocalChannel, + ensureCanManageChannelOrAccount, + updateBannerValidator, + asyncMiddleware(updateVideoChannelBanner) +) + +videoChannelRouter.delete('/:nameWithHost/avatar', + authenticate, + asyncMiddleware(videoChannelsNameWithHostValidator), + ensureIsLocalChannel, + ensureCanManageChannelOrAccount, + asyncMiddleware(deleteVideoChannelAvatar) +) + +videoChannelRouter.delete('/:nameWithHost/banner', + authenticate, + asyncMiddleware(videoChannelsNameWithHostValidator), + ensureIsLocalChannel, + ensureCanManageChannelOrAccount, + asyncMiddleware(deleteVideoChannelBanner) +) + videoChannelRouter.put('/:nameWithHost', authenticate, - asyncMiddleware(videoChannelsUpdateValidator), + asyncMiddleware(videoChannelsNameWithHostValidator), + ensureIsLocalChannel, + ensureCanManageChannelOrAccount, + videoChannelsUpdateValidator, asyncRetryTransactionMiddleware(updateVideoChannel) ) videoChannelRouter.delete('/:nameWithHost', authenticate, + asyncMiddleware(videoChannelsNameWithHostValidator), + ensureIsLocalChannel, + ensureCanManageChannelOrAccount, asyncMiddleware(videoChannelsRemoveValidator), asyncRetryTransactionMiddleware(removeVideoChannel) ) @@ -97,13 +145,34 @@ videoChannelRouter.get('/:nameWithHost/videos', asyncMiddleware(videoChannelsNameWithHostValidator), paginationValidator, videosSortValidator, - setDefaultSort, + setDefaultVideosSort, setDefaultPagination, optionalAuthenticate, commonVideosFiltersValidator, asyncMiddleware(listVideoChannelVideos) ) +videoChannelRouter.get('/:nameWithHost/followers', + authenticate, + asyncMiddleware(videoChannelsNameWithHostValidator), + ensureCanManageChannelOrAccount, + paginationValidator, + videoChannelsFollowersSortValidator, + setDefaultSort, + setDefaultPagination, + asyncMiddleware(listVideoChannelFollowers) +) + +videoChannelRouter.post('/:nameWithHost/import-videos', + authenticate, + asyncMiddleware(videoChannelsNameWithHostValidator), + asyncMiddleware(videoChannelImportVideosValidator), + ensureIsLocalChannel, + ensureCanManageChannelOrAccount, + asyncMiddleware(ensureChannelOwnerCanUpload), + asyncMiddleware(importVideosInChannel) +) + // --------------------------------------------------------------------------- export { @@ -114,25 +183,68 @@ export { async function listVideoChannels (req: express.Request, res: express.Response) { const serverActor = await getServerActor() - const resultList = await VideoChannelModel.listForApi(serverActor.id, req.query.start, req.query.count, req.query.sort) + + const apiOptions = await Hooks.wrapObject({ + actorId: serverActor.id, + start: req.query.start, + count: req.query.count, + sort: req.query.sort + }, 'filter:api.video-channels.list.params') + + const resultList = await Hooks.wrapPromiseFun( + VideoChannelModel.listForApi, + apiOptions, + 'filter:api.video-channels.list.result' + ) return res.json(getFormattedObjects(resultList.data, resultList.total)) } +async function updateVideoChannelBanner (req: express.Request, res: express.Response) { + const bannerPhysicalFile = req.files['bannerfile'][0] + const videoChannel = res.locals.videoChannel + const oldVideoChannelAuditKeys = new VideoChannelAuditView(videoChannel.toFormattedJSON()) + + const banners = await updateLocalActorImageFiles(videoChannel, bannerPhysicalFile, ActorImageType.BANNER) + + auditLogger.update(getAuditIdFromRes(res), new VideoChannelAuditView(videoChannel.toFormattedJSON()), oldVideoChannelAuditKeys) + + return res.json({ + // TODO: remove, deprecated in 4.2 + banner: getBiggestActorImage(banners).toFormattedJSON(), + banners: banners.map(b => b.toFormattedJSON()) + }) +} + async function updateVideoChannelAvatar (req: express.Request, res: express.Response) { const avatarPhysicalFile = req.files['avatarfile'][0] const videoChannel = res.locals.videoChannel const oldVideoChannelAuditKeys = new VideoChannelAuditView(videoChannel.toFormattedJSON()) - const avatar = await updateActorAvatarFile(avatarPhysicalFile, videoChannel) - + const avatars = await updateLocalActorImageFiles(videoChannel, avatarPhysicalFile, ActorImageType.AVATAR) auditLogger.update(getAuditIdFromRes(res), new VideoChannelAuditView(videoChannel.toFormattedJSON()), oldVideoChannelAuditKeys) - return res - .json({ - avatar: avatar.toFormattedJSON() - }) - .end() + return res.json({ + // TODO: remove, deprecated in 4.2 + avatar: getBiggestActorImage(avatars).toFormattedJSON(), + avatars: avatars.map(a => a.toFormattedJSON()) + }) +} + +async function deleteVideoChannelAvatar (req: express.Request, res: express.Response) { + const videoChannel = res.locals.videoChannel + + await deleteLocalActorImageFile(videoChannel, ActorImageType.AVATAR) + + return res.status(HttpStatusCode.NO_CONTENT_204).end() +} + +async function deleteVideoChannelBanner (req: express.Request, res: express.Response) { + const videoChannel = res.locals.videoChannel + + await deleteLocalActorImageFile(videoChannel, ActorImageType.BANNER) + + return res.status(HttpStatusCode.NO_CONTENT_204).end() } async function addVideoChannel (req: express.Request, res: express.Response) { @@ -144,32 +256,29 @@ async function addVideoChannel (req: express.Request, res: express.Response) { return createLocalVideoChannel(videoChannelInfo, account, t) }) - setAsyncActorKeys(videoChannelCreated.Actor) - .catch(err => logger.error('Cannot set async actor keys for account %s.', videoChannelCreated.Actor.url, { err })) + const payload = { actorId: videoChannelCreated.actorId } + await JobQueue.Instance.createJob({ type: 'actor-keys', payload }) auditLogger.create(getAuditIdFromRes(res), new VideoChannelAuditView(videoChannelCreated.toFormattedJSON())) logger.info('Video channel %s created.', videoChannelCreated.Actor.url) + Hooks.runAction('action:api.video-channel.created', { videoChannel: videoChannelCreated, req, res }) + return res.json({ videoChannel: { id: videoChannelCreated.id } - }).end() + }) } async function updateVideoChannel (req: express.Request, res: express.Response) { const videoChannelInstance = res.locals.videoChannel - const videoChannelFieldsSave = videoChannelInstance.toJSON() const oldVideoChannelAuditKeys = new VideoChannelAuditView(videoChannelInstance.toFormattedJSON()) const videoChannelInfoToUpdate = req.body as VideoChannelUpdate let doBulkVideoUpdate = false try { await sequelizeTypescript.transaction(async t => { - const sequelizeOptions = { - transaction: t - } - if (videoChannelInfoToUpdate.displayName !== undefined) videoChannelInstance.name = videoChannelInfoToUpdate.displayName if (videoChannelInfoToUpdate.description !== undefined) videoChannelInstance.description = videoChannelInfoToUpdate.description @@ -183,7 +292,7 @@ async function updateVideoChannel (req: express.Request, res: express.Response) } } - const videoChannelInstanceUpdated = await videoChannelInstance.save(sequelizeOptions) as MChannelAccountDefault + const videoChannelInstanceUpdated = await videoChannelInstance.save({ transaction: t }) as MChannelBannerAccountDefault await sendUpdateActor(videoChannelInstanceUpdated, t) auditLogger.update( @@ -192,20 +301,21 @@ async function updateVideoChannel (req: express.Request, res: express.Response) oldVideoChannelAuditKeys ) + Hooks.runAction('action:api.video-channel.updated', { videoChannel: videoChannelInstanceUpdated, req, res }) + logger.info('Video channel %s updated.', videoChannelInstance.Actor.url) }) } catch (err) { logger.debug('Cannot update the video channel.', { 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(videoChannelInstance, videoChannelFieldsSave) + // So we need to restore the previous fields + resetSequelizeInstance(videoChannelInstance) throw err } - res.type('json').status(204).end() + res.type('json').status(HttpStatusCode.NO_CONTENT_204).end() // Don't process in a transaction, and after the response because it could be long if (doBulkVideoUpdate) { @@ -221,21 +331,24 @@ async function removeVideoChannel (req: express.Request, res: express.Response) await videoChannelInstance.destroy({ transaction: t }) + Hooks.runAction('action:api.video-channel.deleted', { videoChannel: videoChannelInstance, req, res }) + auditLogger.delete(getAuditIdFromRes(res), new VideoChannelAuditView(videoChannelInstance.toFormattedJSON())) logger.info('Video channel %s deleted.', videoChannelInstance.Actor.url) }) - return res.type('json').status(204).end() + return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end() } async function getVideoChannel (req: express.Request, res: express.Response) { - const videoChannelWithVideos = await VideoChannelModel.loadAndPopulateAccountAndVideos(res.locals.videoChannel.id) + const id = res.locals.videoChannel.id + const videoChannel = await Hooks.wrapObject(res.locals.videoChannel, 'filter:api.video-channel.get.result', { id }) - if (videoChannelWithVideos.isOutdated()) { - JobQueue.Instance.createJob({ type: 'activitypub-refresher', payload: { type: 'actor', url: videoChannelWithVideos.Actor.url } }) + if (videoChannel.isOutdated()) { + JobQueue.Instance.createJobAsync({ type: 'activitypub-refresher', payload: { type: 'actor', url: videoChannel.Actor.url } }) } - return res.json(videoChannelWithVideos.toFormattedJSON()) + return res.json(videoChannel.toFormattedJSON()) } async function listVideoChannelPlaylists (req: express.Request, res: express.Response) { @@ -254,28 +367,67 @@ async function listVideoChannelPlaylists (req: express.Request, res: express.Res } async function listVideoChannelVideos (req: express.Request, res: express.Response) { + const serverActor = await getServerActor() + const videoChannelInstance = res.locals.videoChannel - const followerActorId = isUserAbleToSearchRemoteURI(res) ? null : undefined + + const displayOnlyForFollower = isUserAbleToSearchRemoteURI(res) + ? null + : { + actorId: serverActor.id, + orLocalVideos: true + } + const countVideos = getCountVideos(req) + const query = pickCommonVideoQuery(req.query) - const resultList = await VideoModel.listForApi({ - followerActorId, - start: req.query.start, - count: req.query.count, - sort: req.query.sort, - 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, + const apiOptions = await Hooks.wrapObject({ + ...query, + + displayOnlyForFollower, + nsfw: buildNSFWFilter(res, query.nsfw), videoChannelId: videoChannelInstance.id, user: res.locals.oauth ? res.locals.oauth.token.User : undefined, countVideos + }, 'filter:api.video-channels.videos.list.params') + + const resultList = await Hooks.wrapPromiseFun( + VideoModel.listForApi, + apiOptions, + 'filter:api.video-channels.videos.list.result' + ) + + return res.json(getFormattedObjects(resultList.data, resultList.total, guessAdditionalAttributesFromQuery(query))) +} + +async function listVideoChannelFollowers (req: express.Request, res: express.Response) { + const channel = res.locals.videoChannel + + const resultList = await ActorFollowModel.listFollowersForApi({ + actorIds: [ channel.actorId ], + start: req.query.start, + count: req.query.count, + sort: req.query.sort, + search: req.query.search, + state: 'accepted' }) return res.json(getFormattedObjects(resultList.data, resultList.total)) } + +async function importVideosInChannel (req: express.Request, res: express.Response) { + const { externalChannelUrl } = req.body as VideosImportInChannelCreate + + await JobQueue.Instance.createJob({ + type: 'video-channel-import', + payload: { + externalChannelUrl, + videoChannelId: res.locals.videoChannel.id, + partOfChannelSyncId: res.locals.videoChannelSync?.id + } + }) + + logger.info('Video import job for channel "%s" with url "%s" created.', res.locals.videoChannel.name, externalChannelUrl) + + return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end() +}