server/controllers/api/videos/index.ts

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