server/controllers/api/videos/index.ts

   1 import express from 'express'
   2 import { pickCommonVideoQuery } from '@server/helpers/query'
   3 import { doJSONRequest } from '@server/helpers/requests'
   4 import { VideoViews } from '@server/lib/video-views'
   5 import { openapiOperationDoc } from '@server/middlewares/doc'
   6 import { getServerActor } from '@server/models/application/application'
   7 import { guessAdditionalAttributesFromQuery } from '@server/models/video/formatter/video-format-utils'
   8 import { MVideoAccountLight } from '@server/types/models'
   9 import { HttpStatusCode } from '../../../../shared/models'
  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 {
  20   asyncMiddleware,
  21   asyncRetryTransactionMiddleware,
  22   authenticate,
  23   checkVideoFollowConstraints,
  24   commonVideosFiltersValidator,
  25   optionalAuthenticate,
  26   paginationValidator,
  27   setDefaultPagination,
  28   setDefaultVideosSort,
  29   videosCustomGetValidator,
  30   videosGetValidator,
  31   videosRemoveValidator,
  32   videosSortValidator
  33 } from '../../../middlewares'
  34 import { VideoModel } from '../../../models/video/video'
  35 import { blacklistRouter } from './blacklist'
  36 import { videoCaptionsRouter } from './captions'
  37 import { videoCommentRouter } from './comment'
  38 import { filesRouter } from './files'
  39 import { videoImportsRouter } from './import'
  40 import { liveRouter } from './live'
  41 import { ownershipVideoRouter } from './ownership'
  42 import { rateVideoRouter } from './rate'
  43 import { updateRouter } from './update'
  44 import { uploadRouter } from './upload'
  45 import { watchingRouter } from './watching'
  46
  47 const auditLogger = auditLoggerFactory('videos')
  48 const videosRouter = express.Router()
  49
  50 videosRouter.use('/', blacklistRouter)
  51 videosRouter.use('/', rateVideoRouter)
  52 videosRouter.use('/', videoCommentRouter)
  53 videosRouter.use('/', videoCaptionsRouter)
  54 videosRouter.use('/', videoImportsRouter)
  55 videosRouter.use('/', ownershipVideoRouter)
  56 videosRouter.use('/', watchingRouter)
  57 videosRouter.use('/', liveRouter)
  58 videosRouter.use('/', uploadRouter)
  59 videosRouter.use('/', updateRouter)
  60 videosRouter.use('/', filesRouter)
  61
  62 videosRouter.get('/categories',
  63   openapiOperationDoc({ operationId: 'getCategories' }),
  64   listVideoCategories
  65 )
  66 videosRouter.get('/licences',
  67   openapiOperationDoc({ operationId: 'getLicences' }),
  68   listVideoLicences
  69 )
  70 videosRouter.get('/languages',
  71   openapiOperationDoc({ operationId: 'getLanguages' }),
  72   listVideoLanguages
  73 )
  74 videosRouter.get('/privacies',
  75   openapiOperationDoc({ operationId: 'getPrivacies' }),
  76   listVideoPrivacies
  77 )
  78
  79 videosRouter.get('/',
  80   openapiOperationDoc({ operationId: 'getVideos' }),
  81   paginationValidator,
  82   videosSortValidator,
  83   setDefaultVideosSort,
  84   setDefaultPagination,
  85   optionalAuthenticate,
  86   commonVideosFiltersValidator,
  87   asyncMiddleware(listVideos)
  88 )
  89
  90 videosRouter.get('/:id/description',
  91   openapiOperationDoc({ operationId: 'getVideoDesc' }),
  92   asyncMiddleware(videosGetValidator),
  93   asyncMiddleware(getVideoDescription)
  94 )
  95 videosRouter.get('/:id',
  96   openapiOperationDoc({ operationId: 'getVideo' }),
  97   optionalAuthenticate,
  98   asyncMiddleware(videosCustomGetValidator('for-api')),
  99   asyncMiddleware(checkVideoFollowConstraints),
 100   getVideo
 101 )
 102 videosRouter.post('/:id/views',
 103   openapiOperationDoc({ operationId: 'addView' }),
 104   asyncMiddleware(videosCustomGetValidator('only-video')),
 105   asyncMiddleware(viewVideo)
 106 )
 107
 108 videosRouter.delete('/:id',
 109   openapiOperationDoc({ operationId: 'delVideo' }),
 110   authenticate,
 111   asyncMiddleware(videosRemoveValidator),
 112   asyncRetryTransactionMiddleware(removeVideo)
 113 )
 114
 115 // ---------------------------------------------------------------------------
 116
 117 export {
 118   videosRouter
 119 }
 120
 121 // ---------------------------------------------------------------------------
 122
 123 function listVideoCategories (_req: express.Request, res: express.Response) {
 124   res.json(VIDEO_CATEGORIES)
 125 }
 126
 127 function listVideoLicences (_req: express.Request, res: express.Response) {
 128   res.json(VIDEO_LICENCES)
 129 }
 130
 131 function listVideoLanguages (_req: express.Request, res: express.Response) {
 132   res.json(VIDEO_LANGUAGES)
 133 }
 134
 135 function listVideoPrivacies (_req: express.Request, res: express.Response) {
 136   res.json(VIDEO_PRIVACIES)
 137 }
 138
 139 function getVideo (_req: express.Request, res: express.Response) {
 140   const video = res.locals.videoAPI
 141
 142   if (video.isOutdated()) {
 143     JobQueue.Instance.createJob({ type: 'activitypub-refresher', payload: { type: 'video', url: video.url } })
 144   }
 145
 146   return res.json(video.toFormattedDetailsJSON())
 147 }
 148
 149 async function viewVideo (req: express.Request, res: express.Response) {
 150   const video = res.locals.onlyVideo
 151
 152   const ip = req.ip
 153   const success = await VideoViews.Instance.processView({ video, ip })
 154
 155   if (success) {
 156     const serverActor = await getServerActor()
 157     await sendView(serverActor, video, undefined)
 158
 159     Hooks.runAction('action:api.video.viewed', { video: video, ip })
 160   }
 161
 162   return res.status(HttpStatusCode.NO_CONTENT_204).end()
 163 }
 164
 165 async function getVideoDescription (req: express.Request, res: express.Response) {
 166   const videoInstance = res.locals.videoAll
 167
 168   const description = videoInstance.isOwned()
 169     ? videoInstance.description
 170     : await fetchRemoteVideoDescription(videoInstance)
 171
 172   return res.json({ description })
 173 }
 174
 175 async function listVideos (req: express.Request, res: express.Response) {
 176   const serverActor = await getServerActor()
 177
 178   const query = pickCommonVideoQuery(req.query)
 179   const countVideos = getCountVideos(req)
 180
 181   const apiOptions = await Hooks.wrapObject({
 182     ...query,
 183
 184     displayOnlyForFollower: {
 185       actorId: serverActor.id,
 186       orLocalVideos: true
 187     },
 188     nsfw: buildNSFWFilter(res, query.nsfw),
 189     user: res.locals.oauth ? res.locals.oauth.token.User : undefined,
 190     countVideos
 191   }, 'filter:api.videos.list.params')
 192
 193   const resultList = await Hooks.wrapPromiseFun(
 194     VideoModel.listForApi,
 195     apiOptions,
 196     'filter:api.videos.list.result'
 197   )
 198
 199   return res.json(getFormattedObjects(resultList.data, resultList.total, guessAdditionalAttributesFromQuery(query)))
 200 }
 201
 202 async function removeVideo (_req: express.Request, res: express.Response) {
 203   const videoInstance = res.locals.videoAll
 204
 205   await sequelizeTypescript.transaction(async t => {
 206     await videoInstance.destroy({ transaction: t })
 207   })
 208
 209   auditLogger.delete(getAuditIdFromRes(res), new VideoAuditView(videoInstance.toFormattedDetailsJSON()))
 210   logger.info('Video with name %s and uuid %s deleted.', videoInstance.name, videoInstance.uuid)
 211
 212   Hooks.runAction('action:api.video.deleted', { video: videoInstance })
 213
 214   return res.type('json')
 215             .status(HttpStatusCode.NO_CONTENT_204)
 216             .end()
 217 }
 218
 219 // ---------------------------------------------------------------------------
 220
 221 // FIXME: Should not exist, we rely on specific API
 222 async function fetchRemoteVideoDescription (video: MVideoAccountLight) {
 223   const host = video.VideoChannel.Account.Actor.Server.host
 224   const path = video.getDescriptionAPIPath()
 225   const url = REMOTE_SCHEME.HTTP + '://' + host + path
 226
 227   const { body } = await doJSONRequest<any>(url)
 228   return body.description || ''
 229 }