server/controllers/api/video-channel.ts

   1 import * as express from 'express'
   2 import { getFormattedObjects } from '../../helpers/utils'
   3 import {
   4   asyncMiddleware,
   5   asyncRetryTransactionMiddleware,
   6   authenticate,
   7   commonVideosFiltersValidator,
   8   optionalAuthenticate,
   9   paginationValidator,
  10   setDefaultPagination,
  11   setDefaultSort,
  12   videoChannelsAddValidator,
  13   videoChannelsRemoveValidator,
  14   videoChannelsSortValidator,
  15   videoChannelsUpdateValidator,
  16   videoPlaylistsSortValidator
  17 } from '../../middlewares'
  18 import { VideoChannelModel } from '../../models/video/video-channel'
  19 import { videoChannelsNameWithHostValidator, videosSortValidator, videoChannelsOwnSearchValidator } from '../../middlewares/validators'
  20 import { sendUpdateActor } from '../../lib/activitypub/send'
  21 import { VideoChannelCreate, VideoChannelUpdate } from '../../../shared'
  22 import { createLocalVideoChannel, federateAllVideosOfChannel } from '../../lib/video-channel'
  23 import { buildNSFWFilter, createReqFiles, getCountVideos, isUserAbleToSearchRemoteURI } from '../../helpers/express-utils'
  24 import { setAsyncActorKeys } from '../../lib/activitypub/actor'
  25 import { AccountModel } from '../../models/account/account'
  26 import { MIMETYPES } from '../../initializers/constants'
  27 import { logger } from '../../helpers/logger'
  28 import { VideoModel } from '../../models/video/video'
  29 import { updateAvatarValidator } from '../../middlewares/validators/avatar'
  30 import { updateActorAvatarFile } from '../../lib/avatar'
  31 import { auditLoggerFactory, getAuditIdFromRes, VideoChannelAuditView } from '../../helpers/audit-logger'
  32 import { resetSequelizeInstance } from '../../helpers/database-utils'
  33 import { JobQueue } from '../../lib/job-queue'
  34 import { VideoPlaylistModel } from '../../models/video/video-playlist'
  35 import { commonVideoPlaylistFiltersValidator } from '../../middlewares/validators/videos/video-playlists'
  36 import { CONFIG } from '../../initializers/config'
  37 import { sequelizeTypescript } from '../../initializers/database'
  38 import { MChannelAccountDefault } from '@server/types/models'
  39 import { getServerActor } from '@server/models/application/application'
  40
  41 const auditLogger = auditLoggerFactory('channels')
  42 const reqAvatarFile = createReqFiles([ 'avatarfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT, { avatarfile: CONFIG.STORAGE.TMP_DIR })
  43
  44 const videoChannelRouter = express.Router()
  45
  46 videoChannelRouter.get('/',
  47   paginationValidator,
  48   videoChannelsSortValidator,
  49   setDefaultSort,
  50   setDefaultPagination,
  51   videoChannelsOwnSearchValidator,
  52   asyncMiddleware(listVideoChannels)
  53 )
  54
  55 videoChannelRouter.post('/',
  56   authenticate,
  57   asyncMiddleware(videoChannelsAddValidator),
  58   asyncRetryTransactionMiddleware(addVideoChannel)
  59 )
  60
  61 videoChannelRouter.post('/:nameWithHost/avatar/pick',
  62   authenticate,
  63   reqAvatarFile,
  64   // Check the rights
  65   asyncMiddleware(videoChannelsUpdateValidator),
  66   updateAvatarValidator,
  67   asyncMiddleware(updateVideoChannelAvatar)
  68 )
  69
  70 videoChannelRouter.put('/:nameWithHost',
  71   authenticate,
  72   asyncMiddleware(videoChannelsUpdateValidator),
  73   asyncRetryTransactionMiddleware(updateVideoChannel)
  74 )
  75
  76 videoChannelRouter.delete('/:nameWithHost',
  77   authenticate,
  78   asyncMiddleware(videoChannelsRemoveValidator),
  79   asyncRetryTransactionMiddleware(removeVideoChannel)
  80 )
  81
  82 videoChannelRouter.get('/:nameWithHost',
  83   asyncMiddleware(videoChannelsNameWithHostValidator),
  84   asyncMiddleware(getVideoChannel)
  85 )
  86
  87 videoChannelRouter.get('/:nameWithHost/video-playlists',
  88   asyncMiddleware(videoChannelsNameWithHostValidator),
  89   paginationValidator,
  90   videoPlaylistsSortValidator,
  91   setDefaultSort,
  92   setDefaultPagination,
  93   commonVideoPlaylistFiltersValidator,
  94   asyncMiddleware(listVideoChannelPlaylists)
  95 )
  96
  97 videoChannelRouter.get('/:nameWithHost/videos',
  98   asyncMiddleware(videoChannelsNameWithHostValidator),
  99   paginationValidator,
 100   videosSortValidator,
 101   setDefaultSort,
 102   setDefaultPagination,
 103   optionalAuthenticate,
 104   commonVideosFiltersValidator,
 105   asyncMiddleware(listVideoChannelVideos)
 106 )
 107
 108 // ---------------------------------------------------------------------------
 109
 110 export {
 111   videoChannelRouter
 112 }
 113
 114 // ---------------------------------------------------------------------------
 115
 116 async function listVideoChannels (req: express.Request, res: express.Response) {
 117   const serverActor = await getServerActor()
 118   const resultList = await VideoChannelModel.listForApi({
 119     actorId: serverActor.id,
 120     start: req.query.start,
 121     count: req.query.count,
 122     sort: req.query.sort
 123   })
 124
 125   return res.json(getFormattedObjects(resultList.data, resultList.total))
 126 }
 127
 128 async function updateVideoChannelAvatar (req: express.Request, res: express.Response) {
 129   const avatarPhysicalFile = req.files['avatarfile'][0]
 130   const videoChannel = res.locals.videoChannel
 131   const oldVideoChannelAuditKeys = new VideoChannelAuditView(videoChannel.toFormattedJSON())
 132
 133   const avatar = await updateActorAvatarFile(avatarPhysicalFile, videoChannel)
 134
 135   auditLogger.update(getAuditIdFromRes(res), new VideoChannelAuditView(videoChannel.toFormattedJSON()), oldVideoChannelAuditKeys)
 136
 137   return res
 138     .json({
 139       avatar: avatar.toFormattedJSON()
 140     })
 141     .end()
 142 }
 143
 144 async function addVideoChannel (req: express.Request, res: express.Response) {
 145   const videoChannelInfo: VideoChannelCreate = req.body
 146
 147   const videoChannelCreated = await sequelizeTypescript.transaction(async t => {
 148     const account = await AccountModel.load(res.locals.oauth.token.User.Account.id, t)
 149
 150     return createLocalVideoChannel(videoChannelInfo, account, t)
 151   })
 152
 153   setAsyncActorKeys(videoChannelCreated.Actor)
 154     .catch(err => logger.error('Cannot set async actor keys for account %s.', videoChannelCreated.Actor.url, { err }))
 155
 156   auditLogger.create(getAuditIdFromRes(res), new VideoChannelAuditView(videoChannelCreated.toFormattedJSON()))
 157   logger.info('Video channel %s created.', videoChannelCreated.Actor.url)
 158
 159   return res.json({
 160     videoChannel: {
 161       id: videoChannelCreated.id
 162     }
 163   }).end()
 164 }
 165
 166 async function updateVideoChannel (req: express.Request, res: express.Response) {
 167   const videoChannelInstance = res.locals.videoChannel
 168   const videoChannelFieldsSave = videoChannelInstance.toJSON()
 169   const oldVideoChannelAuditKeys = new VideoChannelAuditView(videoChannelInstance.toFormattedJSON())
 170   const videoChannelInfoToUpdate = req.body as VideoChannelUpdate
 171   let doBulkVideoUpdate = false
 172
 173   try {
 174     await sequelizeTypescript.transaction(async t => {
 175       const sequelizeOptions = {
 176         transaction: t
 177       }
 178
 179       if (videoChannelInfoToUpdate.displayName !== undefined) videoChannelInstance.name = videoChannelInfoToUpdate.displayName
 180       if (videoChannelInfoToUpdate.description !== undefined) videoChannelInstance.description = videoChannelInfoToUpdate.description
 181
 182       if (videoChannelInfoToUpdate.support !== undefined) {
 183         const oldSupportField = videoChannelInstance.support
 184         videoChannelInstance.support = videoChannelInfoToUpdate.support
 185
 186         if (videoChannelInfoToUpdate.bulkVideosSupportUpdate === true && oldSupportField !== videoChannelInfoToUpdate.support) {
 187           doBulkVideoUpdate = true
 188           await VideoModel.bulkUpdateSupportField(videoChannelInstance, t)
 189         }
 190       }
 191
 192       const videoChannelInstanceUpdated = await videoChannelInstance.save(sequelizeOptions) as MChannelAccountDefault
 193       await sendUpdateActor(videoChannelInstanceUpdated, t)
 194
 195       auditLogger.update(
 196         getAuditIdFromRes(res),
 197         new VideoChannelAuditView(videoChannelInstanceUpdated.toFormattedJSON()),
 198         oldVideoChannelAuditKeys
 199       )
 200
 201       logger.info('Video channel %s updated.', videoChannelInstance.Actor.url)
 202     })
 203   } catch (err) {
 204     logger.debug('Cannot update the video channel.', { err })
 205
 206     // Force fields we want to update
 207     // If the transaction is retried, sequelize will think the object has not changed
 208     // So it will skip the SQL request, even if the last one was ROLLBACKed!
 209     resetSequelizeInstance(videoChannelInstance, videoChannelFieldsSave)
 210
 211     throw err
 212   }
 213
 214   res.type('json').status(204).end()
 215
 216   // Don't process in a transaction, and after the response because it could be long
 217   if (doBulkVideoUpdate) {
 218     await federateAllVideosOfChannel(videoChannelInstance)
 219   }
 220 }
 221
 222 async function removeVideoChannel (req: express.Request, res: express.Response) {
 223   const videoChannelInstance = res.locals.videoChannel
 224
 225   await sequelizeTypescript.transaction(async t => {
 226     await VideoPlaylistModel.resetPlaylistsOfChannel(videoChannelInstance.id, t)
 227
 228     await videoChannelInstance.destroy({ transaction: t })
 229
 230     auditLogger.delete(getAuditIdFromRes(res), new VideoChannelAuditView(videoChannelInstance.toFormattedJSON()))
 231     logger.info('Video channel %s deleted.', videoChannelInstance.Actor.url)
 232   })
 233
 234   return res.type('json').status(204).end()
 235 }
 236
 237 async function getVideoChannel (req: express.Request, res: express.Response) {
 238   const videoChannelWithVideos = await VideoChannelModel.loadAndPopulateAccountAndVideos(res.locals.videoChannel.id)
 239
 240   if (videoChannelWithVideos.isOutdated()) {
 241     JobQueue.Instance.createJob({ type: 'activitypub-refresher', payload: { type: 'actor', url: videoChannelWithVideos.Actor.url } })
 242   }
 243
 244   return res.json(videoChannelWithVideos.toFormattedJSON())
 245 }
 246
 247 async function listVideoChannelPlaylists (req: express.Request, res: express.Response) {
 248   const serverActor = await getServerActor()
 249
 250   const resultList = await VideoPlaylistModel.listForApi({
 251     followerActorId: serverActor.id,
 252     start: req.query.start,
 253     count: req.query.count,
 254     sort: req.query.sort,
 255     videoChannelId: res.locals.videoChannel.id,
 256     type: req.query.playlistType
 257   })
 258
 259   return res.json(getFormattedObjects(resultList.data, resultList.total))
 260 }
 261
 262 async function listVideoChannelVideos (req: express.Request, res: express.Response) {
 263   const videoChannelInstance = res.locals.videoChannel
 264   const followerActorId = isUserAbleToSearchRemoteURI(res) ? null : undefined
 265   const countVideos = getCountVideos(req)
 266
 267   const resultList = await VideoModel.listForApi({
 268     followerActorId,
 269     start: req.query.start,
 270     count: req.query.count,
 271     sort: req.query.sort,
 272     includeLocalVideos: true,
 273     categoryOneOf: req.query.categoryOneOf,
 274     licenceOneOf: req.query.licenceOneOf,
 275     languageOneOf: req.query.languageOneOf,
 276     tagsOneOf: req.query.tagsOneOf,
 277     tagsAllOf: req.query.tagsAllOf,
 278     filter: req.query.filter,
 279     nsfw: buildNSFWFilter(res, req.query.nsfw),
 280     withFiles: false,
 281     videoChannelId: videoChannelInstance.id,
 282     user: res.locals.oauth ? res.locals.oauth.token.User : undefined,
 283     countVideos
 284   })
 285
 286   return res.json(getFormattedObjects(resultList.data, resultList.total))
 287 }