1 import * as express from 'express'
2 import { getServerActor } from '@server/models/application/application'
3 import { MChannelAccountDefault } from '@server/types/models'
4 import { VideoChannelCreate, VideoChannelUpdate } from '../../../shared'
5 import { auditLoggerFactory, getAuditIdFromRes, VideoChannelAuditView } from '../../helpers/audit-logger'
6 import { resetSequelizeInstance } from '../../helpers/database-utils'
7 import { buildNSFWFilter, createReqFiles, getCountVideos, isUserAbleToSearchRemoteURI } from '../../helpers/express-utils'
8 import { logger } from '../../helpers/logger'
9 import { getFormattedObjects } from '../../helpers/utils'
10 import { CONFIG } from '../../initializers/config'
11 import { MIMETYPES } from '../../initializers/constants'
12 import { sequelizeTypescript } from '../../initializers/database'
13 import { setAsyncActorKeys } from '../../lib/activitypub/actor'
14 import { sendUpdateActor } from '../../lib/activitypub/send'
15 import { updateActorAvatarFile } from '../../lib/avatar'
16 import { JobQueue } from '../../lib/job-queue'
17 import { createLocalVideoChannel, federateAllVideosOfChannel } from '../../lib/video-channel'
20 asyncRetryTransactionMiddleware,
22 commonVideosFiltersValidator,
28 videoChannelsAddValidator,
29 videoChannelsRemoveValidator,
30 videoChannelsSortValidator,
31 videoChannelsUpdateValidator,
32 videoPlaylistsSortValidator
33 } from '../../middlewares'
34 import { videoChannelsNameWithHostValidator, videoChannelsOwnSearchValidator, videosSortValidator } from '../../middlewares/validators'
35 import { updateAvatarValidator } from '../../middlewares/validators/avatar'
36 import { commonVideoPlaylistFiltersValidator } from '../../middlewares/validators/videos/video-playlists'
37 import { AccountModel } from '../../models/account/account'
38 import { VideoModel } from '../../models/video/video'
39 import { VideoChannelModel } from '../../models/video/video-channel'
40 import { VideoPlaylistModel } from '../../models/video/video-playlist'
42 const auditLogger = auditLoggerFactory('channels')
43 const reqAvatarFile = createReqFiles([ 'avatarfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT, { avatarfile: CONFIG.STORAGE.TMP_DIR })
45 const videoChannelRouter = express.Router()
47 videoChannelRouter.get('/',
49 videoChannelsSortValidator,
52 videoChannelsOwnSearchValidator,
53 asyncMiddleware(listVideoChannels)
56 videoChannelRouter.post('/',
58 asyncMiddleware(videoChannelsAddValidator),
59 asyncRetryTransactionMiddleware(addVideoChannel)
62 videoChannelRouter.post('/:nameWithHost/avatar/pick',
66 asyncMiddleware(videoChannelsUpdateValidator),
67 updateAvatarValidator,
68 asyncMiddleware(updateVideoChannelAvatar)
71 videoChannelRouter.put('/:nameWithHost',
73 asyncMiddleware(videoChannelsUpdateValidator),
74 asyncRetryTransactionMiddleware(updateVideoChannel)
77 videoChannelRouter.delete('/:nameWithHost',
79 asyncMiddleware(videoChannelsRemoveValidator),
80 asyncRetryTransactionMiddleware(removeVideoChannel)
83 videoChannelRouter.get('/:nameWithHost',
84 asyncMiddleware(videoChannelsNameWithHostValidator),
85 asyncMiddleware(getVideoChannel)
88 videoChannelRouter.get('/:nameWithHost/video-playlists',
89 asyncMiddleware(videoChannelsNameWithHostValidator),
91 videoPlaylistsSortValidator,
94 commonVideoPlaylistFiltersValidator,
95 asyncMiddleware(listVideoChannelPlaylists)
98 videoChannelRouter.get('/:nameWithHost/videos',
99 asyncMiddleware(videoChannelsNameWithHostValidator),
102 setDefaultVideosSort,
103 setDefaultPagination,
104 optionalAuthenticate,
105 commonVideosFiltersValidator,
106 asyncMiddleware(listVideoChannelVideos)
109 // ---------------------------------------------------------------------------
115 // ---------------------------------------------------------------------------
117 async function listVideoChannels (req: express.Request, res: express.Response) {
118 const serverActor = await getServerActor()
119 const resultList = await VideoChannelModel.listForApi({
120 actorId: serverActor.id,
121 start: req.query.start,
122 count: req.query.count,
126 return res.json(getFormattedObjects(resultList.data, resultList.total))
129 async function updateVideoChannelAvatar (req: express.Request, res: express.Response) {
130 const avatarPhysicalFile = req.files['avatarfile'][0]
131 const videoChannel = res.locals.videoChannel
132 const oldVideoChannelAuditKeys = new VideoChannelAuditView(videoChannel.toFormattedJSON())
134 const avatar = await updateActorAvatarFile(avatarPhysicalFile, videoChannel)
136 auditLogger.update(getAuditIdFromRes(res), new VideoChannelAuditView(videoChannel.toFormattedJSON()), oldVideoChannelAuditKeys)
140 avatar: avatar.toFormattedJSON()
145 async function addVideoChannel (req: express.Request, res: express.Response) {
146 const videoChannelInfo: VideoChannelCreate = req.body
148 const videoChannelCreated = await sequelizeTypescript.transaction(async t => {
149 const account = await AccountModel.load(res.locals.oauth.token.User.Account.id, t)
151 return createLocalVideoChannel(videoChannelInfo, account, t)
154 setAsyncActorKeys(videoChannelCreated.Actor)
155 .catch(err => logger.error('Cannot set async actor keys for account %s.', videoChannelCreated.Actor.url, { err }))
157 auditLogger.create(getAuditIdFromRes(res), new VideoChannelAuditView(videoChannelCreated.toFormattedJSON()))
158 logger.info('Video channel %s created.', videoChannelCreated.Actor.url)
162 id: videoChannelCreated.id
167 async function updateVideoChannel (req: express.Request, res: express.Response) {
168 const videoChannelInstance = res.locals.videoChannel
169 const videoChannelFieldsSave = videoChannelInstance.toJSON()
170 const oldVideoChannelAuditKeys = new VideoChannelAuditView(videoChannelInstance.toFormattedJSON())
171 const videoChannelInfoToUpdate = req.body as VideoChannelUpdate
172 let doBulkVideoUpdate = false
175 await sequelizeTypescript.transaction(async t => {
176 const sequelizeOptions = {
180 if (videoChannelInfoToUpdate.displayName !== undefined) videoChannelInstance.name = videoChannelInfoToUpdate.displayName
181 if (videoChannelInfoToUpdate.description !== undefined) videoChannelInstance.description = videoChannelInfoToUpdate.description
183 if (videoChannelInfoToUpdate.support !== undefined) {
184 const oldSupportField = videoChannelInstance.support
185 videoChannelInstance.support = videoChannelInfoToUpdate.support
187 if (videoChannelInfoToUpdate.bulkVideosSupportUpdate === true && oldSupportField !== videoChannelInfoToUpdate.support) {
188 doBulkVideoUpdate = true
189 await VideoModel.bulkUpdateSupportField(videoChannelInstance, t)
193 const videoChannelInstanceUpdated = await videoChannelInstance.save(sequelizeOptions) as MChannelAccountDefault
194 await sendUpdateActor(videoChannelInstanceUpdated, t)
197 getAuditIdFromRes(res),
198 new VideoChannelAuditView(videoChannelInstanceUpdated.toFormattedJSON()),
199 oldVideoChannelAuditKeys
202 logger.info('Video channel %s updated.', videoChannelInstance.Actor.url)
205 logger.debug('Cannot update the video channel.', { err })
207 // Force fields we want to update
208 // If the transaction is retried, sequelize will think the object has not changed
209 // So it will skip the SQL request, even if the last one was ROLLBACKed!
210 resetSequelizeInstance(videoChannelInstance, videoChannelFieldsSave)
215 res.type('json').status(204).end()
217 // Don't process in a transaction, and after the response because it could be long
218 if (doBulkVideoUpdate) {
219 await federateAllVideosOfChannel(videoChannelInstance)
223 async function removeVideoChannel (req: express.Request, res: express.Response) {
224 const videoChannelInstance = res.locals.videoChannel
226 await sequelizeTypescript.transaction(async t => {
227 await VideoPlaylistModel.resetPlaylistsOfChannel(videoChannelInstance.id, t)
229 await videoChannelInstance.destroy({ transaction: t })
231 auditLogger.delete(getAuditIdFromRes(res), new VideoChannelAuditView(videoChannelInstance.toFormattedJSON()))
232 logger.info('Video channel %s deleted.', videoChannelInstance.Actor.url)
235 return res.type('json').status(204).end()
238 async function getVideoChannel (req: express.Request, res: express.Response) {
239 const videoChannelWithVideos = await VideoChannelModel.loadAndPopulateAccountAndVideos(res.locals.videoChannel.id)
241 if (videoChannelWithVideos.isOutdated()) {
242 JobQueue.Instance.createJob({ type: 'activitypub-refresher', payload: { type: 'actor', url: videoChannelWithVideos.Actor.url } })
245 return res.json(videoChannelWithVideos.toFormattedJSON())
248 async function listVideoChannelPlaylists (req: express.Request, res: express.Response) {
249 const serverActor = await getServerActor()
251 const resultList = await VideoPlaylistModel.listForApi({
252 followerActorId: serverActor.id,
253 start: req.query.start,
254 count: req.query.count,
255 sort: req.query.sort,
256 videoChannelId: res.locals.videoChannel.id,
257 type: req.query.playlistType
260 return res.json(getFormattedObjects(resultList.data, resultList.total))
263 async function listVideoChannelVideos (req: express.Request, res: express.Response) {
264 const videoChannelInstance = res.locals.videoChannel
265 const followerActorId = isUserAbleToSearchRemoteURI(res) ? null : undefined
266 const countVideos = getCountVideos(req)
268 const resultList = await VideoModel.listForApi({
270 start: req.query.start,
271 count: req.query.count,
272 sort: req.query.sort,
273 includeLocalVideos: true,
274 categoryOneOf: req.query.categoryOneOf,
275 licenceOneOf: req.query.licenceOneOf,
276 languageOneOf: req.query.languageOneOf,
277 tagsOneOf: req.query.tagsOneOf,
278 tagsAllOf: req.query.tagsAllOf,
279 filter: req.query.filter,
280 nsfw: buildNSFWFilter(res, req.query.nsfw),
282 videoChannelId: videoChannelInstance.id,
283 user: res.locals.oauth ? res.locals.oauth.token.User : undefined,
287 return res.json(getFormattedObjects(resultList.data, resultList.total))