PeerTube/server/controllers/api/video-channel.ts

407 lines
14 KiB
TypeScript
Raw Normal View History

2021-08-27 14:32:44 +02:00
import express from 'express'
2021-07-29 11:54:38 +02:00
import { pickCommonVideoQuery } from '@server/helpers/query'
import { getBiggestActorImage } from '@server/lib/actor-image'
import { Hooks } from '@server/lib/plugins/hooks'
2021-10-19 09:44:43 +02:00
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'
2021-04-06 17:01:35 +02:00
import { MChannelBannerAccountDefault } from '@server/types/models'
2021-12-24 10:14:47 +01:00
import { ActorImageType, HttpStatusCode, VideoChannelCreate, VideoChannelUpdate } 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'
2018-04-24 17:05:32 +02:00
import {
asyncMiddleware,
2018-06-13 14:27:40 +02:00
asyncRetryTransactionMiddleware,
2018-08-14 15:28:30 +02:00
authenticate,
commonVideosFiltersValidator,
ensureCanManageChannel,
optionalAuthenticate,
2018-04-24 17:05:32 +02:00
paginationValidator,
setDefaultPagination,
setDefaultSort,
setDefaultVideosSort,
videoChannelsAddValidator,
videoChannelsRemoveValidator,
videoChannelsSortValidator,
2019-02-26 10:55:40 +01:00
videoChannelsUpdateValidator,
videoPlaylistsSortValidator
2018-04-24 17:05:32 +02:00
} from '../../middlewares'
2021-10-19 09:44:43 +02:00
import {
ensureIsLocalChannel,
2021-10-19 09:44:43 +02:00
videoChannelsFollowersSortValidator,
videoChannelsListValidator,
videoChannelsNameWithHostValidator,
videosSortValidator
} from '../../middlewares/validators'
2021-04-07 10:36:13 +02:00
import { updateAvatarValidator, updateBannerValidator } from '../../middlewares/validators/actor-image'
import { commonVideoPlaylistFiltersValidator } from '../../middlewares/validators/videos/video-playlists'
import { AccountModel } from '../../models/account/account'
import { VideoModel } from '../../models/video/video'
import { VideoChannelModel } from '../../models/video/video-channel'
2019-02-26 10:55:40 +01:00
import { VideoPlaylistModel } from '../../models/video/video-playlist'
const auditLogger = auditLoggerFactory('channels')
const reqAvatarFile = createReqFiles([ 'avatarfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT)
const reqBannerFile = createReqFiles([ 'bannerfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT)
2018-04-24 17:05:32 +02:00
const videoChannelRouter = express.Router()
videoChannelRouter.get('/',
paginationValidator,
videoChannelsSortValidator,
setDefaultSort,
setDefaultPagination,
2021-06-17 16:02:38 +02:00
videoChannelsListValidator,
2018-04-24 17:05:32 +02:00
asyncMiddleware(listVideoChannels)
)
videoChannelRouter.post('/',
authenticate,
asyncMiddleware(videoChannelsAddValidator),
2018-06-13 14:27:40 +02:00
asyncRetryTransactionMiddleware(addVideoChannel)
)
2018-08-17 15:45:42 +02:00
videoChannelRouter.post('/:nameWithHost/avatar/pick',
authenticate,
reqAvatarFile,
2021-10-19 09:44:43 +02:00
asyncMiddleware(videoChannelsNameWithHostValidator),
ensureIsLocalChannel,
ensureCanManageChannel,
updateAvatarValidator,
2018-09-26 10:15:50 +02:00
asyncMiddleware(updateVideoChannelAvatar)
)
2021-04-06 17:01:35 +02:00
videoChannelRouter.post('/:nameWithHost/banner/pick',
authenticate,
reqBannerFile,
2021-10-19 09:44:43 +02:00
asyncMiddleware(videoChannelsNameWithHostValidator),
ensureIsLocalChannel,
ensureCanManageChannel,
2021-04-06 17:01:35 +02:00
updateBannerValidator,
asyncMiddleware(updateVideoChannelBanner)
)
videoChannelRouter.delete('/:nameWithHost/avatar',
authenticate,
2021-10-19 09:44:43 +02:00
asyncMiddleware(videoChannelsNameWithHostValidator),
ensureIsLocalChannel,
ensureCanManageChannel,
asyncMiddleware(deleteVideoChannelAvatar)
)
2021-04-06 17:01:35 +02:00
videoChannelRouter.delete('/:nameWithHost/banner',
authenticate,
2021-10-19 09:44:43 +02:00
asyncMiddleware(videoChannelsNameWithHostValidator),
ensureIsLocalChannel,
ensureCanManageChannel,
2021-04-06 17:01:35 +02:00
asyncMiddleware(deleteVideoChannelBanner)
)
2018-08-17 15:45:42 +02:00
videoChannelRouter.put('/:nameWithHost',
authenticate,
2021-10-19 09:44:43 +02:00
asyncMiddleware(videoChannelsNameWithHostValidator),
ensureIsLocalChannel,
ensureCanManageChannel,
2021-10-19 09:44:43 +02:00
videoChannelsUpdateValidator,
2018-06-13 14:27:40 +02:00
asyncRetryTransactionMiddleware(updateVideoChannel)
)
2018-08-17 15:45:42 +02:00
videoChannelRouter.delete('/:nameWithHost',
authenticate,
asyncMiddleware(videoChannelsNameWithHostValidator),
ensureIsLocalChannel,
ensureCanManageChannel,
asyncMiddleware(videoChannelsRemoveValidator),
2018-06-13 14:27:40 +02:00
asyncRetryTransactionMiddleware(removeVideoChannel)
)
2018-08-17 15:45:42 +02:00
videoChannelRouter.get('/:nameWithHost',
asyncMiddleware(videoChannelsNameWithHostValidator),
2022-08-03 11:17:57 +02:00
asyncMiddleware(getVideoChannel)
)
2019-02-26 10:55:40 +01:00
videoChannelRouter.get('/:nameWithHost/video-playlists',
asyncMiddleware(videoChannelsNameWithHostValidator),
paginationValidator,
videoPlaylistsSortValidator,
setDefaultSort,
setDefaultPagination,
2019-03-05 10:58:44 +01:00
commonVideoPlaylistFiltersValidator,
2019-02-26 10:55:40 +01:00
asyncMiddleware(listVideoChannelPlaylists)
)
2018-08-17 15:45:42 +02:00
videoChannelRouter.get('/:nameWithHost/videos',
asyncMiddleware(videoChannelsNameWithHostValidator),
paginationValidator,
videosSortValidator,
setDefaultVideosSort,
setDefaultPagination,
optionalAuthenticate,
2018-07-20 14:35:18 +02:00
commonVideosFiltersValidator,
asyncMiddleware(listVideoChannelVideos)
)
2021-10-19 09:44:43 +02:00
videoChannelRouter.get('/:nameWithHost/followers',
authenticate,
asyncMiddleware(videoChannelsNameWithHostValidator),
ensureCanManageChannel,
2021-10-19 09:44:43 +02:00
paginationValidator,
videoChannelsFollowersSortValidator,
setDefaultSort,
setDefaultPagination,
asyncMiddleware(listVideoChannelFollowers)
)
2018-04-24 17:05:32 +02:00
// ---------------------------------------------------------------------------
export {
videoChannelRouter
}
// ---------------------------------------------------------------------------
2019-03-19 10:35:15 +01:00
async function listVideoChannels (req: express.Request, res: express.Response) {
2018-08-23 17:58:39 +02:00
const serverActor = await getServerActor()
2022-08-03 11:17:57 +02:00
const apiOptions = await Hooks.wrapObject({
actorId: serverActor.id,
start: req.query.start,
count: req.query.count,
2020-07-23 21:30:04 +02:00
sort: req.query.sort
2022-08-03 11:17:57 +02:00
}, 'filter:api.video-channels.list.params')
const resultList = await Hooks.wrapPromiseFun(
VideoChannelModel.listForApi,
apiOptions,
'filter:api.video-channels.list.result'
)
2018-04-24 17:05:32 +02:00
return res.json(getFormattedObjects(resultList.data, resultList.total))
}
2021-04-06 17:01:35 +02:00
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)
2021-04-06 17:01:35 +02:00
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())
})
2021-04-06 17:01:35 +02:00
}
2021-05-12 14:51:17 +02:00
2019-03-19 10:35:15 +01:00
async function updateVideoChannelAvatar (req: express.Request, res: express.Response) {
2020-01-31 16:56:52 +01:00
const avatarPhysicalFile = req.files['avatarfile'][0]
2019-03-19 10:35:15 +01:00
const videoChannel = res.locals.videoChannel
const oldVideoChannelAuditKeys = new VideoChannelAuditView(videoChannel.toFormattedJSON())
const avatars = await updateLocalActorImageFiles(videoChannel, avatarPhysicalFile, ActorImageType.AVATAR)
2018-09-20 11:31:48 +02:00
auditLogger.update(getAuditIdFromRes(res), new VideoChannelAuditView(videoChannel.toFormattedJSON()), oldVideoChannelAuditKeys)
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
2021-04-06 17:01:35 +02:00
await deleteLocalActorImageFile(videoChannel, ActorImageType.AVATAR)
return res.status(HttpStatusCode.NO_CONTENT_204).end()
2021-04-06 17:01:35 +02:00
}
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) {
const videoChannelInfo: VideoChannelCreate = req.body
2019-08-15 11:53:26 +02:00
const videoChannelCreated = await sequelizeTypescript.transaction(async t => {
2019-03-19 10:35:15 +01:00
const account = await AccountModel.load(res.locals.oauth.token.User.Account.id, t)
2019-08-20 19:05:31 +02:00
return createLocalVideoChannel(videoChannelInfo, account, t)
})
const payload = { actorId: videoChannelCreated.actorId }
await JobQueue.Instance.createJobWithPromise({ type: 'actor-keys', payload })
auditLogger.create(getAuditIdFromRes(res), new VideoChannelAuditView(videoChannelCreated.toFormattedJSON()))
2019-05-31 14:02:26 +02:00
logger.info('Video channel %s created.', videoChannelCreated.Actor.url)
2022-08-03 11:17:57 +02:00
Hooks.runAction('action:api.video-channel.created', { videoChannel: videoChannelCreated, req, res })
2018-06-13 14:27:40 +02:00
return res.json({
videoChannel: {
2019-05-31 14:02:26 +02:00
id: videoChannelCreated.id
2018-06-13 14:27:40 +02:00
}
2021-04-06 17:01:35 +02:00
})
}
async function updateVideoChannel (req: express.Request, res: express.Response) {
2019-03-19 10:35:15 +01:00
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 => {
if (videoChannelInfoToUpdate.displayName !== undefined) videoChannelInstance.name = videoChannelInfoToUpdate.displayName
if (videoChannelInfoToUpdate.description !== undefined) videoChannelInstance.description = videoChannelInfoToUpdate.description
if (videoChannelInfoToUpdate.support !== undefined) {
const oldSupportField = videoChannelInstance.support
videoChannelInstance.support = videoChannelInfoToUpdate.support
if (videoChannelInfoToUpdate.bulkVideosSupportUpdate === true && oldSupportField !== videoChannelInfoToUpdate.support) {
doBulkVideoUpdate = true
await VideoModel.bulkUpdateSupportField(videoChannelInstance, t)
}
}
2021-05-12 14:51:17 +02:00
const videoChannelInstanceUpdated = await videoChannelInstance.save({ transaction: t }) as MChannelBannerAccountDefault
await sendUpdateActor(videoChannelInstanceUpdated, t)
auditLogger.update(
2018-09-19 17:02:16 +02:00
getAuditIdFromRes(res),
new VideoChannelAuditView(videoChannelInstanceUpdated.toFormattedJSON()),
oldVideoChannelAuditKeys
)
2022-08-03 11:17:57 +02:00
Hooks.runAction('action:api.video-channel.updated', { videoChannel: videoChannelInstanceUpdated, req, res })
2019-05-31 14:02:26 +02:00
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)
throw err
}
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) {
await federateAllVideosOfChannel(videoChannelInstance)
}
}
async function removeVideoChannel (req: express.Request, res: express.Response) {
2019-03-19 10:35:15 +01:00
const videoChannelInstance = res.locals.videoChannel
2018-06-13 14:27:40 +02:00
await sequelizeTypescript.transaction(async t => {
2019-03-05 10:58:44 +01:00
await VideoPlaylistModel.resetPlaylistsOfChannel(videoChannelInstance.id, t)
await videoChannelInstance.destroy({ transaction: t })
2022-08-03 11:17:57 +02:00
Hooks.runAction('action:api.video-channel.deleted', { videoChannel: videoChannelInstance, req, res })
2018-09-19 17:02:16 +02:00
auditLogger.delete(getAuditIdFromRes(res), new VideoChannelAuditView(videoChannelInstance.toFormattedJSON()))
2019-05-31 14:02:26 +02:00
logger.info('Video channel %s deleted.', videoChannelInstance.Actor.url)
})
return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end()
}
2022-08-03 11:17:57 +02:00
async function getVideoChannel (req: express.Request, res: express.Response) {
const id = res.locals.videoChannel.id
const videoChannel = await Hooks.wrapObject(res.locals.videoChannel, 'filter:api.video-channel.get.result', { id })
2021-04-06 17:01:35 +02:00
if (videoChannel.isOutdated()) {
JobQueue.Instance.createJob({ type: 'activitypub-refresher', payload: { type: 'actor', url: videoChannel.Actor.url } })
2019-01-14 11:30:15 +01:00
}
2021-04-06 17:01:35 +02:00
return res.json(videoChannel.toFormattedJSON())
}
2019-02-26 10:55:40 +01:00
async function listVideoChannelPlaylists (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,
2019-03-05 10:58:44 +01:00
videoChannelId: res.locals.videoChannel.id,
type: req.query.playlistType
2019-02-26 10:55:40 +01:00
})
return res.json(getFormattedObjects(resultList.data, resultList.total))
}
2019-03-19 10:35:15 +01:00
async function listVideoChannelVideos (req: express.Request, res: express.Response) {
const serverActor = await getServerActor()
2019-03-19 10:35:15 +01:00
const videoChannelInstance = res.locals.videoChannel
const displayOnlyForFollower = isUserAbleToSearchRemoteURI(res)
? null
: {
actorId: serverActor.id,
orLocalVideos: true
}
2020-01-08 14:15:16 +01:00
const countVideos = getCountVideos(req)
2021-07-29 11:54:38 +02:00
const query = pickCommonVideoQuery(req.query)
const apiOptions = await Hooks.wrapObject({
2021-07-29 11:54:38 +02:00
...query,
displayOnlyForFollower,
nsfw: buildNSFWFilter(res, query.nsfw),
videoChannelId: videoChannelInstance.id,
2020-01-08 14:15:16 +01:00
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)))
}
2021-10-19 09:44:43 +02:00
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,
2021-10-19 15:02:43 +02:00
state: 'accepted'
2021-10-19 09:44:43 +02:00
})
return res.json(getFormattedObjects(resultList.data, resultList.total))
}