1 import express from 'express'
2 import { pickCommonVideoQuery } from '@server/helpers/query'
3 import { Hooks } from '@server/lib/plugins/hooks'
4 import { ActorFollowModel } from '@server/models/actor/actor-follow'
5 import { getServerActor } from '@server/models/application/application'
6 import { guessAdditionalAttributesFromQuery } from '@server/models/video/formatter/video-format-utils'
7 import { MChannelBannerAccountDefault } from '@server/types/models'
8 import { ActorImageType, VideoChannelCreate, VideoChannelUpdate } from '../../../shared'
9 import { HttpStatusCode } from '../../../shared/models/http/http-error-codes'
10 import { auditLoggerFactory, getAuditIdFromRes, VideoChannelAuditView } from '../../helpers/audit-logger'
11 import { resetSequelizeInstance } from '../../helpers/database-utils'
12 import { buildNSFWFilter, createReqFiles, getCountVideos, isUserAbleToSearchRemoteURI } from '../../helpers/express-utils'
13 import { logger } from '../../helpers/logger'
14 import { getFormattedObjects } from '../../helpers/utils'
15 import { CONFIG } from '../../initializers/config'
16 import { MIMETYPES } from '../../initializers/constants'
17 import { sequelizeTypescript } from '../../initializers/database'
18 import { sendUpdateActor } from '../../lib/activitypub/send'
19 import { JobQueue } from '../../lib/job-queue'
20 import { deleteLocalActorImageFile, updateLocalActorImageFile } from '../../lib/local-actor'
21 import { createLocalVideoChannel, federateAllVideosOfChannel } from '../../lib/video-channel'
24 asyncRetryTransactionMiddleware,
26 commonVideosFiltersValidator,
32 videoChannelsAddValidator,
33 videoChannelsRemoveValidator,
34 videoChannelsSortValidator,
35 videoChannelsUpdateValidator,
36 videoPlaylistsSortValidator
37 } from '../../middlewares'
39 ensureAuthUserOwnsChannelValidator,
40 videoChannelsFollowersSortValidator,
41 videoChannelsListValidator,
42 videoChannelsNameWithHostValidator,
44 } from '../../middlewares/validators'
45 import { updateAvatarValidator, updateBannerValidator } from '../../middlewares/validators/actor-image'
46 import { commonVideoPlaylistFiltersValidator } from '../../middlewares/validators/videos/video-playlists'
47 import { AccountModel } from '../../models/account/account'
48 import { VideoModel } from '../../models/video/video'
49 import { VideoChannelModel } from '../../models/video/video-channel'
50 import { VideoPlaylistModel } from '../../models/video/video-playlist'
52 const auditLogger = auditLoggerFactory('channels')
53 const reqAvatarFile = createReqFiles([ 'avatarfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT, { avatarfile: CONFIG.STORAGE.TMP_DIR })
54 const reqBannerFile = createReqFiles([ 'bannerfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT, { bannerfile: CONFIG.STORAGE.TMP_DIR })
56 const videoChannelRouter = express.Router()
58 videoChannelRouter.get('/',
60 videoChannelsSortValidator,
63 videoChannelsListValidator,
64 asyncMiddleware(listVideoChannels)
67 videoChannelRouter.post('/',
69 asyncMiddleware(videoChannelsAddValidator),
70 asyncRetryTransactionMiddleware(addVideoChannel)
73 videoChannelRouter.post('/:nameWithHost/avatar/pick',
76 asyncMiddleware(videoChannelsNameWithHostValidator),
77 ensureAuthUserOwnsChannelValidator,
78 updateAvatarValidator,
79 asyncMiddleware(updateVideoChannelAvatar)
82 videoChannelRouter.post('/:nameWithHost/banner/pick',
85 asyncMiddleware(videoChannelsNameWithHostValidator),
86 ensureAuthUserOwnsChannelValidator,
87 updateBannerValidator,
88 asyncMiddleware(updateVideoChannelBanner)
91 videoChannelRouter.delete('/:nameWithHost/avatar',
93 asyncMiddleware(videoChannelsNameWithHostValidator),
94 ensureAuthUserOwnsChannelValidator,
95 asyncMiddleware(deleteVideoChannelAvatar)
98 videoChannelRouter.delete('/:nameWithHost/banner',
100 asyncMiddleware(videoChannelsNameWithHostValidator),
101 ensureAuthUserOwnsChannelValidator,
102 asyncMiddleware(deleteVideoChannelBanner)
105 videoChannelRouter.put('/:nameWithHost',
107 asyncMiddleware(videoChannelsNameWithHostValidator),
108 ensureAuthUserOwnsChannelValidator,
109 videoChannelsUpdateValidator,
110 asyncRetryTransactionMiddleware(updateVideoChannel)
113 videoChannelRouter.delete('/:nameWithHost',
115 asyncMiddleware(videoChannelsRemoveValidator),
116 asyncRetryTransactionMiddleware(removeVideoChannel)
119 videoChannelRouter.get('/:nameWithHost',
120 asyncMiddleware(videoChannelsNameWithHostValidator),
124 videoChannelRouter.get('/:nameWithHost/video-playlists',
125 asyncMiddleware(videoChannelsNameWithHostValidator),
127 videoPlaylistsSortValidator,
129 setDefaultPagination,
130 commonVideoPlaylistFiltersValidator,
131 asyncMiddleware(listVideoChannelPlaylists)
134 videoChannelRouter.get('/:nameWithHost/videos',
135 asyncMiddleware(videoChannelsNameWithHostValidator),
138 setDefaultVideosSort,
139 setDefaultPagination,
140 optionalAuthenticate,
141 commonVideosFiltersValidator,
142 asyncMiddleware(listVideoChannelVideos)
145 videoChannelRouter.get('/:nameWithHost/followers',
147 asyncMiddleware(videoChannelsNameWithHostValidator),
148 ensureAuthUserOwnsChannelValidator,
150 videoChannelsFollowersSortValidator,
152 setDefaultPagination,
153 asyncMiddleware(listVideoChannelFollowers)
156 // ---------------------------------------------------------------------------
162 // ---------------------------------------------------------------------------
164 async function listVideoChannels (req: express.Request, res: express.Response) {
165 const serverActor = await getServerActor()
166 const resultList = await VideoChannelModel.listForApi({
167 actorId: serverActor.id,
168 start: req.query.start,
169 count: req.query.count,
173 return res.json(getFormattedObjects(resultList.data, resultList.total))
176 async function updateVideoChannelBanner (req: express.Request, res: express.Response) {
177 const bannerPhysicalFile = req.files['bannerfile'][0]
178 const videoChannel = res.locals.videoChannel
179 const oldVideoChannelAuditKeys = new VideoChannelAuditView(videoChannel.toFormattedJSON())
181 const banner = await updateLocalActorImageFile(videoChannel, bannerPhysicalFile, ActorImageType.BANNER)
183 auditLogger.update(getAuditIdFromRes(res), new VideoChannelAuditView(videoChannel.toFormattedJSON()), oldVideoChannelAuditKeys)
185 return res.json({ banner: banner.toFormattedJSON() })
188 async function updateVideoChannelAvatar (req: express.Request, res: express.Response) {
189 const avatarPhysicalFile = req.files['avatarfile'][0]
190 const videoChannel = res.locals.videoChannel
191 const oldVideoChannelAuditKeys = new VideoChannelAuditView(videoChannel.toFormattedJSON())
193 const avatar = await updateLocalActorImageFile(videoChannel, avatarPhysicalFile, ActorImageType.AVATAR)
195 auditLogger.update(getAuditIdFromRes(res), new VideoChannelAuditView(videoChannel.toFormattedJSON()), oldVideoChannelAuditKeys)
197 return res.json({ avatar: avatar.toFormattedJSON() })
200 async function deleteVideoChannelAvatar (req: express.Request, res: express.Response) {
201 const videoChannel = res.locals.videoChannel
203 await deleteLocalActorImageFile(videoChannel, ActorImageType.AVATAR)
205 return res.status(HttpStatusCode.NO_CONTENT_204).end()
208 async function deleteVideoChannelBanner (req: express.Request, res: express.Response) {
209 const videoChannel = res.locals.videoChannel
211 await deleteLocalActorImageFile(videoChannel, ActorImageType.BANNER)
213 return res.status(HttpStatusCode.NO_CONTENT_204).end()
216 async function addVideoChannel (req: express.Request, res: express.Response) {
217 const videoChannelInfo: VideoChannelCreate = req.body
219 const videoChannelCreated = await sequelizeTypescript.transaction(async t => {
220 const account = await AccountModel.load(res.locals.oauth.token.User.Account.id, t)
222 return createLocalVideoChannel(videoChannelInfo, account, t)
225 const payload = { actorId: videoChannelCreated.actorId }
226 await JobQueue.Instance.createJobWithPromise({ type: 'actor-keys', payload })
228 auditLogger.create(getAuditIdFromRes(res), new VideoChannelAuditView(videoChannelCreated.toFormattedJSON()))
229 logger.info('Video channel %s created.', videoChannelCreated.Actor.url)
233 id: videoChannelCreated.id
238 async function updateVideoChannel (req: express.Request, res: express.Response) {
239 const videoChannelInstance = res.locals.videoChannel
240 const videoChannelFieldsSave = videoChannelInstance.toJSON()
241 const oldVideoChannelAuditKeys = new VideoChannelAuditView(videoChannelInstance.toFormattedJSON())
242 const videoChannelInfoToUpdate = req.body as VideoChannelUpdate
243 let doBulkVideoUpdate = false
246 await sequelizeTypescript.transaction(async t => {
247 if (videoChannelInfoToUpdate.displayName !== undefined) videoChannelInstance.name = videoChannelInfoToUpdate.displayName
248 if (videoChannelInfoToUpdate.description !== undefined) videoChannelInstance.description = videoChannelInfoToUpdate.description
250 if (videoChannelInfoToUpdate.support !== undefined) {
251 const oldSupportField = videoChannelInstance.support
252 videoChannelInstance.support = videoChannelInfoToUpdate.support
254 if (videoChannelInfoToUpdate.bulkVideosSupportUpdate === true && oldSupportField !== videoChannelInfoToUpdate.support) {
255 doBulkVideoUpdate = true
256 await VideoModel.bulkUpdateSupportField(videoChannelInstance, t)
260 const videoChannelInstanceUpdated = await videoChannelInstance.save({ transaction: t }) as MChannelBannerAccountDefault
261 await sendUpdateActor(videoChannelInstanceUpdated, t)
264 getAuditIdFromRes(res),
265 new VideoChannelAuditView(videoChannelInstanceUpdated.toFormattedJSON()),
266 oldVideoChannelAuditKeys
269 logger.info('Video channel %s updated.', videoChannelInstance.Actor.url)
272 logger.debug('Cannot update the video channel.', { err })
274 // Force fields we want to update
275 // If the transaction is retried, sequelize will think the object has not changed
276 // So it will skip the SQL request, even if the last one was ROLLBACKed!
277 resetSequelizeInstance(videoChannelInstance, videoChannelFieldsSave)
282 res.type('json').status(HttpStatusCode.NO_CONTENT_204).end()
284 // Don't process in a transaction, and after the response because it could be long
285 if (doBulkVideoUpdate) {
286 await federateAllVideosOfChannel(videoChannelInstance)
290 async function removeVideoChannel (req: express.Request, res: express.Response) {
291 const videoChannelInstance = res.locals.videoChannel
293 await sequelizeTypescript.transaction(async t => {
294 await VideoPlaylistModel.resetPlaylistsOfChannel(videoChannelInstance.id, t)
296 await videoChannelInstance.destroy({ transaction: t })
298 auditLogger.delete(getAuditIdFromRes(res), new VideoChannelAuditView(videoChannelInstance.toFormattedJSON()))
299 logger.info('Video channel %s deleted.', videoChannelInstance.Actor.url)
302 return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end()
305 function getVideoChannel (req: express.Request, res: express.Response) {
306 const videoChannel = res.locals.videoChannel
308 if (videoChannel.isOutdated()) {
309 JobQueue.Instance.createJob({ type: 'activitypub-refresher', payload: { type: 'actor', url: videoChannel.Actor.url } })
312 return res.json(videoChannel.toFormattedJSON())
315 async function listVideoChannelPlaylists (req: express.Request, res: express.Response) {
316 const serverActor = await getServerActor()
318 const resultList = await VideoPlaylistModel.listForApi({
319 followerActorId: serverActor.id,
320 start: req.query.start,
321 count: req.query.count,
322 sort: req.query.sort,
323 videoChannelId: res.locals.videoChannel.id,
324 type: req.query.playlistType
327 return res.json(getFormattedObjects(resultList.data, resultList.total))
330 async function listVideoChannelVideos (req: express.Request, res: express.Response) {
331 const serverActor = await getServerActor()
333 const videoChannelInstance = res.locals.videoChannel
335 const displayOnlyForFollower = isUserAbleToSearchRemoteURI(res)
338 actorId: serverActor.id,
342 const countVideos = getCountVideos(req)
343 const query = pickCommonVideoQuery(req.query)
345 const apiOptions = await Hooks.wrapObject({
348 displayOnlyForFollower,
349 nsfw: buildNSFWFilter(res, query.nsfw),
350 videoChannelId: videoChannelInstance.id,
351 user: res.locals.oauth ? res.locals.oauth.token.User : undefined,
353 }, 'filter:api.video-channels.videos.list.params')
355 const resultList = await Hooks.wrapPromiseFun(
356 VideoModel.listForApi,
358 'filter:api.video-channels.videos.list.result'
361 return res.json(getFormattedObjects(resultList.data, resultList.total, guessAdditionalAttributesFromQuery(query)))
364 async function listVideoChannelFollowers (req: express.Request, res: express.Response) {
365 const channel = res.locals.videoChannel
367 const resultList = await ActorFollowModel.listFollowersForApi({
368 actorIds: [ channel.actorId ],
369 start: req.query.start,
370 count: req.query.count,
371 sort: req.query.sort,
372 search: req.query.search,
376 return res.json(getFormattedObjects(resultList.data, resultList.total))