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 { VideoViews } from '@server/lib/video-views'
   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 {
  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('for-api')),
 104   asyncMiddleware(checkVideoFollowConstraints),
 105   getVideo
 106 )
 107 videosRouter.post('/:id/views',
 108   openapiOperationDoc({ operationId: 'addView' }),
 109   asyncMiddleware(videosCustomGetValidator('only-video')),
 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 function getVideo (_req: express.Request, res: express.Response) {
 145   const video = res.locals.videoAPI
 146
 147   if (video.isOutdated()) {
 148     JobQueue.Instance.createJob({ type: 'activitypub-refresher', payload: { type: 'video', url: video.url } })
 149   }
 150
 151   return res.json(video.toFormattedDetailsJSON())
 152 }
 153
 154 async function viewVideo (req: express.Request, res: express.Response) {
 155   const video = res.locals.onlyVideo
 156
 157   const ip = req.ip
 158   const success = await VideoViews.Instance.processView({ video, ip })
 159
 160   if (success) {
 161     const serverActor = await getServerActor()
 162     await sendView(serverActor, video, undefined)
 163
 164     Hooks.runAction('action:api.video.viewed', { video: video, ip })
 165   }
 166
 167   return res.status(HttpStatusCode.NO_CONTENT_204).end()
 168 }
 169
 170 async function getVideoDescription (req: express.Request, res: express.Response) {
 171   const videoInstance = res.locals.videoAll
 172
 173   const description = videoInstance.isOwned()
 174     ? videoInstance.description
 175     : await fetchRemoteVideoDescription(videoInstance)
 176
 177   return res.json({ description })
 178 }
 179
 180 async function getVideoFileMetadata (req: express.Request, res: express.Response) {
 181   const videoFile = await VideoFileModel.loadWithMetadata(toInt(req.params.videoFileId))
 182
 183   return res.json(videoFile.metadata)
 184 }
 185
 186 async function listVideos (req: express.Request, res: express.Response) {
 187   const serverActor = await getServerActor()
 188
 189   const query = pickCommonVideoQuery(req.query)
 190   const countVideos = getCountVideos(req)
 191
 192   const apiOptions = await Hooks.wrapObject({
 193     ...query,
 194
 195     displayOnlyForFollower: {
 196       actorId: serverActor.id,
 197       orLocalVideos: true
 198     },
 199     nsfw: buildNSFWFilter(res, query.nsfw),
 200     user: res.locals.oauth ? res.locals.oauth.token.User : undefined,
 201     countVideos
 202   }, 'filter:api.videos.list.params')
 203
 204   const resultList = await Hooks.wrapPromiseFun(
 205     VideoModel.listForApi,
 206     apiOptions,
 207     'filter:api.videos.list.result'
 208   )
 209
 210   return res.json(getFormattedObjects(resultList.data, resultList.total, guessAdditionalAttributesFromQuery(query)))
 211 }
 212
 213 async function removeVideo (_req: express.Request, res: express.Response) {
 214   const videoInstance = res.locals.videoAll
 215
 216   await sequelizeTypescript.transaction(async t => {
 217     await videoInstance.destroy({ transaction: t })
 218   })
 219
 220   auditLogger.delete(getAuditIdFromRes(res), new VideoAuditView(videoInstance.toFormattedDetailsJSON()))
 221   logger.info('Video with name %s and uuid %s deleted.', videoInstance.name, videoInstance.uuid)
 222
 223   Hooks.runAction('action:api.video.deleted', { video: videoInstance })
 224
 225   return res.type('json')
 226             .status(HttpStatusCode.NO_CONTENT_204)
 227             .end()
 228 }
 229
 230 // ---------------------------------------------------------------------------
 231
 232 // FIXME: Should not exist, we rely on specific API
 233 async function fetchRemoteVideoDescription (video: MVideoAccountLight) {
 234   const host = video.VideoChannel.Account.Actor.Server.host
 235   const path = video.getDescriptionAPIPath()
 236   const url = REMOTE_SCHEME.HTTP + '://' + host + path
 237
 238   const { body } = await doJSONRequest<any>(url)
 239   return body.description || ''
 240 }