server/controllers/api/videos/index.ts

   1 import express from 'express'
   2 import toInt from 'validator/lib/toInt'
   3 import { pickCommonVideoQuery } from '@server/helpers/query'
   4 import { doJSONRequest } from '@server/helpers/requests'
   5 import { LiveManager } from '@server/lib/live'
   6 import { openapiOperationDoc } from '@server/middlewares/doc'
   7 import { getServerActor } from '@server/models/application/application'
   8 import { guessAdditionalAttributesFromQuery } from '@server/models/video/formatter/video-format-utils'
   9 import { MVideoAccountLight } from '@server/types/models'
  10 import { HttpStatusCode } from '../../../../shared/models'
  11 import { auditLoggerFactory, getAuditIdFromRes, VideoAuditView } from '../../../helpers/audit-logger'
  12 import { buildNSFWFilter, getCountVideos } from '../../../helpers/express-utils'
  13 import { logger } from '../../../helpers/logger'
  14 import { getFormattedObjects } from '../../../helpers/utils'
  15 import { REMOTE_SCHEME, VIDEO_CATEGORIES, VIDEO_LANGUAGES, VIDEO_LICENCES, VIDEO_PRIVACIES } from '../../../initializers/constants'
  16 import { sequelizeTypescript } from '../../../initializers/database'
  17 import { sendView } from '../../../lib/activitypub/send/send-view'
  18 import { JobQueue } from '../../../lib/job-queue'
  19 import { Hooks } from '../../../lib/plugins/hooks'
  20 import { Redis } from '../../../lib/redis'
  21 import {
  22   asyncMiddleware,
  23   asyncRetryTransactionMiddleware,
  24   authenticate,
  25   checkVideoFollowConstraints,
  26   commonVideosFiltersValidator,
  27   optionalAuthenticate,
  28   paginationValidator,
  29   setDefaultPagination,
  30   setDefaultVideosSort,
  31   videoFileMetadataGetValidator,
  32   videosCustomGetValidator,
  33   videosGetValidator,
  34   videosRemoveValidator,
  35   videosSortValidator
  36 } from '../../../middlewares'
  37 import { VideoModel } from '../../../models/video/video'
  38 import { VideoFileModel } from '../../../models/video/video-file'
  39 import { blacklistRouter } from './blacklist'
  40 import { videoCaptionsRouter } from './captions'
  41 import { videoCommentRouter } from './comment'
  42 import { videoImportsRouter } from './import'
  43 import { liveRouter } from './live'
  44 import { ownershipVideoRouter } from './ownership'
  45 import { rateVideoRouter } from './rate'
  46 import { updateRouter } from './update'
  47 import { uploadRouter } from './upload'
  48 import { watchingRouter } from './watching'
  49
  50 const auditLogger = auditLoggerFactory('videos')
  51 const videosRouter = express.Router()
  52
  53 videosRouter.use('/', blacklistRouter)
  54 videosRouter.use('/', rateVideoRouter)
  55 videosRouter.use('/', videoCommentRouter)
  56 videosRouter.use('/', videoCaptionsRouter)
  57 videosRouter.use('/', videoImportsRouter)
  58 videosRouter.use('/', ownershipVideoRouter)
  59 videosRouter.use('/', watchingRouter)
  60 videosRouter.use('/', liveRouter)
  61 videosRouter.use('/', uploadRouter)
  62 videosRouter.use('/', updateRouter)
  63
  64 videosRouter.get('/categories',
  65   openapiOperationDoc({ operationId: 'getCategories' }),
  66   listVideoCategories
  67 )
  68 videosRouter.get('/licences',
  69   openapiOperationDoc({ operationId: 'getLicences' }),
  70   listVideoLicences
  71 )
  72 videosRouter.get('/languages',
  73   openapiOperationDoc({ operationId: 'getLanguages' }),
  74   listVideoLanguages
  75 )
  76 videosRouter.get('/privacies',
  77   openapiOperationDoc({ operationId: 'getPrivacies' }),
  78   listVideoPrivacies
  79 )
  80
  81 videosRouter.get('/',
  82   openapiOperationDoc({ operationId: 'getVideos' }),
  83   paginationValidator,
  84   videosSortValidator,
  85   setDefaultVideosSort,
  86   setDefaultPagination,
  87   optionalAuthenticate,
  88   commonVideosFiltersValidator,
  89   asyncMiddleware(listVideos)
  90 )
  91
  92 videosRouter.get('/:id/description',
  93   openapiOperationDoc({ operationId: 'getVideoDesc' }),
  94   asyncMiddleware(videosGetValidator),
  95   asyncMiddleware(getVideoDescription)
  96 )
  97 videosRouter.get('/:id/metadata/:videoFileId',
  98   asyncMiddleware(videoFileMetadataGetValidator),
  99   asyncMiddleware(getVideoFileMetadata)
 100 )
 101 videosRouter.get('/:id',
 102   openapiOperationDoc({ operationId: 'getVideo' }),
 103   optionalAuthenticate,
 104   asyncMiddleware(videosCustomGetValidator('for-api')),
 105   asyncMiddleware(checkVideoFollowConstraints),
 106   getVideo
 107 )
 108 videosRouter.post('/:id/views',
 109   openapiOperationDoc({ operationId: 'addView' }),
 110   asyncMiddleware(videosCustomGetValidator('only-immutable-attributes')),
 111   asyncMiddleware(viewVideo)
 112 )
 113
 114 videosRouter.delete('/:id',
 115   openapiOperationDoc({ operationId: 'delVideo' }),
 116   authenticate,
 117   asyncMiddleware(videosRemoveValidator),
 118   asyncRetryTransactionMiddleware(removeVideo)
 119 )
 120
 121 // ---------------------------------------------------------------------------
 122
 123 export {
 124   videosRouter
 125 }
 126
 127 // ---------------------------------------------------------------------------
 128
 129 function listVideoCategories (_req: express.Request, res: express.Response) {
 130   res.json(VIDEO_CATEGORIES)
 131 }
 132
 133 function listVideoLicences (_req: express.Request, res: express.Response) {
 134   res.json(VIDEO_LICENCES)
 135 }
 136
 137 function listVideoLanguages (_req: express.Request, res: express.Response) {
 138   res.json(VIDEO_LANGUAGES)
 139 }
 140
 141 function listVideoPrivacies (_req: express.Request, res: express.Response) {
 142   res.json(VIDEO_PRIVACIES)
 143 }
 144
 145 function getVideo (_req: express.Request, res: express.Response) {
 146   const video = res.locals.videoAPI
 147
 148   if (video.isOutdated()) {
 149     JobQueue.Instance.createJob({ type: 'activitypub-refresher', payload: { type: 'video', url: video.url } })
 150   }
 151
 152   return res.json(video.toFormattedDetailsJSON())
 153 }
 154
 155 async function viewVideo (req: express.Request, res: express.Response) {
 156   const immutableVideoAttrs = res.locals.onlyImmutableVideo
 157
 158   const ip = req.ip
 159   const exists = await Redis.Instance.doesVideoIPViewExist(ip, immutableVideoAttrs.uuid)
 160   if (exists) {
 161     logger.debug('View for ip %s and video %s already exists.', ip, immutableVideoAttrs.uuid)
 162     return res.status(HttpStatusCode.NO_CONTENT_204).end()
 163   }
 164
 165   const video = await VideoModel.load(immutableVideoAttrs.id)
 166
 167   const promises: Promise<any>[] = [
 168     Redis.Instance.setIPVideoView(ip, video.uuid, video.isLive)
 169   ]
 170
 171   let federateView = true
 172
 173   // Increment our live manager
 174   if (video.isLive && video.isOwned()) {
 175     LiveManager.Instance.addViewTo(video.id)
 176
 177     // Views of our local live will be sent by our live manager
 178     federateView = false
 179   }
 180
 181   // Increment our video views cache counter
 182   if (!video.isLive) {
 183     promises.push(Redis.Instance.addVideoView(video.id))
 184   }
 185
 186   if (federateView) {
 187     const serverActor = await getServerActor()
 188     promises.push(sendView(serverActor, video, undefined))
 189   }
 190
 191   await Promise.all(promises)
 192
 193   Hooks.runAction('action:api.video.viewed', { video, ip })
 194
 195   return res.status(HttpStatusCode.NO_CONTENT_204).end()
 196 }
 197
 198 async function getVideoDescription (req: express.Request, res: express.Response) {
 199   const videoInstance = res.locals.videoAll
 200
 201   const description = videoInstance.isOwned()
 202     ? videoInstance.description
 203     : await fetchRemoteVideoDescription(videoInstance)
 204
 205   return res.json({ description })
 206 }
 207
 208 async function getVideoFileMetadata (req: express.Request, res: express.Response) {
 209   const videoFile = await VideoFileModel.loadWithMetadata(toInt(req.params.videoFileId))
 210
 211   return res.json(videoFile.metadata)
 212 }
 213
 214 async function listVideos (req: express.Request, res: express.Response) {
 215   const serverActor = await getServerActor()
 216
 217   const query = pickCommonVideoQuery(req.query)
 218   const countVideos = getCountVideos(req)
 219
 220   const apiOptions = await Hooks.wrapObject({
 221     ...query,
 222
 223     displayOnlyForFollower: {
 224       actorId: serverActor.id,
 225       orLocalVideos: true
 226     },
 227     nsfw: buildNSFWFilter(res, query.nsfw),
 228     withFiles: false,
 229     user: res.locals.oauth ? res.locals.oauth.token.User : undefined,
 230     countVideos
 231   }, 'filter:api.videos.list.params')
 232
 233   const resultList = await Hooks.wrapPromiseFun(
 234     VideoModel.listForApi,
 235     apiOptions,
 236     'filter:api.videos.list.result'
 237   )
 238
 239   return res.json(getFormattedObjects(resultList.data, resultList.total, guessAdditionalAttributesFromQuery(query)))
 240 }
 241
 242 async function removeVideo (_req: express.Request, res: express.Response) {
 243   const videoInstance = res.locals.videoAll
 244
 245   await sequelizeTypescript.transaction(async t => {
 246     await videoInstance.destroy({ transaction: t })
 247   })
 248
 249   auditLogger.delete(getAuditIdFromRes(res), new VideoAuditView(videoInstance.toFormattedDetailsJSON()))
 250   logger.info('Video with name %s and uuid %s deleted.', videoInstance.name, videoInstance.uuid)
 251
 252   Hooks.runAction('action:api.video.deleted', { video: videoInstance })
 253
 254   return res.type('json')
 255             .status(HttpStatusCode.NO_CONTENT_204)
 256             .end()
 257 }
 258
 259 // ---------------------------------------------------------------------------
 260
 261 // FIXME: Should not exist, we rely on specific API
 262 async function fetchRemoteVideoDescription (video: MVideoAccountLight) {
 263   const host = video.VideoChannel.Account.Actor.Server.host
 264   const path = video.getDescriptionAPIPath()
 265   const url = REMOTE_SCHEME.HTTP + '://' + host + path
 266
 267   const { body } = await doJSONRequest<any>(url)
 268   return body.description || ''
 269 }