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', listVideoCategories)
  64 videosRouter.get('/licences', listVideoLicences)
  65 videosRouter.get('/languages', listVideoLanguages)
  66 videosRouter.get('/privacies', listVideoPrivacies)
  67
  68 videosRouter.get('/',
  69   paginationValidator,
  70   videosSortValidator,
  71   setDefaultVideosSort,
  72   setDefaultPagination,
  73   optionalAuthenticate,
  74   commonVideosFiltersValidator,
  75   asyncMiddleware(listVideos)
  76 )
  77
  78 videosRouter.get('/:id/description',
  79   asyncMiddleware(videosGetValidator),
  80   asyncMiddleware(getVideoDescription)
  81 )
  82 videosRouter.get('/:id/metadata/:videoFileId',
  83   asyncMiddleware(videoFileMetadataGetValidator),
  84   asyncMiddleware(getVideoFileMetadata)
  85 )
  86 videosRouter.get('/:id',
  87   openapiOperationDoc({ operationId: 'getVideo' }),
  88   optionalAuthenticate,
  89   asyncMiddleware(videosCustomGetValidator('only-video-with-rights')),
  90   asyncMiddleware(checkVideoFollowConstraints),
  91   asyncMiddleware(getVideo)
  92 )
  93 videosRouter.post('/:id/views',
  94   asyncMiddleware(videosCustomGetValidator('only-immutable-attributes')),
  95   asyncMiddleware(viewVideo)
  96 )
  97
  98 videosRouter.delete('/:id',
  99   openapiOperationDoc({ operationId: 'delVideo' }),
 100   authenticate,
 101   asyncMiddleware(videosRemoveValidator),
 102   asyncRetryTransactionMiddleware(removeVideo)
 103 )
 104
 105 // ---------------------------------------------------------------------------
 106
 107 export {
 108   videosRouter
 109 }
 110
 111 // ---------------------------------------------------------------------------
 112
 113 function listVideoCategories (_req: express.Request, res: express.Response) {
 114   res.json(VIDEO_CATEGORIES)
 115 }
 116
 117 function listVideoLicences (_req: express.Request, res: express.Response) {
 118   res.json(VIDEO_LICENCES)
 119 }
 120
 121 function listVideoLanguages (_req: express.Request, res: express.Response) {
 122   res.json(VIDEO_LANGUAGES)
 123 }
 124
 125 function listVideoPrivacies (_req: express.Request, res: express.Response) {
 126   res.json(VIDEO_PRIVACIES)
 127 }
 128
 129 async function getVideo (_req: express.Request, res: express.Response) {
 130   // We need more attributes
 131   const userId: number = res.locals.oauth ? res.locals.oauth.token.User.id : null
 132
 133   const video = await Hooks.wrapPromiseFun(
 134     VideoModel.loadForGetAPI,
 135     { id: res.locals.onlyVideoWithRights.id, userId },
 136     'filter:api.video.get.result'
 137   )
 138
 139   if (video.isOutdated()) {
 140     JobQueue.Instance.createJob({ type: 'activitypub-refresher', payload: { type: 'video', url: video.url } })
 141   }
 142
 143   return res.json(video.toFormattedDetailsJSON())
 144 }
 145
 146 async function viewVideo (req: express.Request, res: express.Response) {
 147   const immutableVideoAttrs = res.locals.onlyImmutableVideo
 148
 149   const ip = req.ip
 150   const exists = await Redis.Instance.doesVideoIPViewExist(ip, immutableVideoAttrs.uuid)
 151   if (exists) {
 152     logger.debug('View for ip %s and video %s already exists.', ip, immutableVideoAttrs.uuid)
 153     return res.status(HttpStatusCode.NO_CONTENT_204).end()
 154   }
 155
 156   const video = await VideoModel.load(immutableVideoAttrs.id)
 157
 158   const promises: Promise<any>[] = [
 159     Redis.Instance.setIPVideoView(ip, video.uuid, video.isLive)
 160   ]
 161
 162   let federateView = true
 163
 164   // Increment our live manager
 165   if (video.isLive && video.isOwned()) {
 166     LiveManager.Instance.addViewTo(video.id)
 167
 168     // Views of our local live will be sent by our live manager
 169     federateView = false
 170   }
 171
 172   // Increment our video views cache counter
 173   if (!video.isLive) {
 174     promises.push(Redis.Instance.addVideoView(video.id))
 175   }
 176
 177   if (federateView) {
 178     const serverActor = await getServerActor()
 179     promises.push(sendView(serverActor, video, undefined))
 180   }
 181
 182   await Promise.all(promises)
 183
 184   Hooks.runAction('action:api.video.viewed', { video, ip })
 185
 186   return res.status(HttpStatusCode.NO_CONTENT_204).end()
 187 }
 188
 189 async function getVideoDescription (req: express.Request, res: express.Response) {
 190   const videoInstance = res.locals.videoAll
 191
 192   const description = videoInstance.isOwned()
 193     ? videoInstance.description
 194     : await fetchRemoteVideoDescription(videoInstance)
 195
 196   return res.json({ description })
 197 }
 198
 199 async function getVideoFileMetadata (req: express.Request, res: express.Response) {
 200   const videoFile = await VideoFileModel.loadWithMetadata(toInt(req.params.videoFileId))
 201
 202   return res.json(videoFile.metadata)
 203 }
 204
 205 async function listVideos (req: express.Request, res: express.Response) {
 206   const query = req.query as VideosCommonQuery
 207   const countVideos = getCountVideos(req)
 208
 209   const apiOptions = await Hooks.wrapObject({
 210     start: query.start,
 211     count: query.count,
 212     sort: query.sort,
 213     includeLocalVideos: true,
 214     categoryOneOf: query.categoryOneOf,
 215     licenceOneOf: query.licenceOneOf,
 216     languageOneOf: query.languageOneOf,
 217     tagsOneOf: query.tagsOneOf,
 218     tagsAllOf: query.tagsAllOf,
 219     nsfw: buildNSFWFilter(res, query.nsfw),
 220     isLive: query.isLive,
 221     filter: query.filter,
 222     withFiles: false,
 223     user: res.locals.oauth ? res.locals.oauth.token.User : undefined,
 224     countVideos
 225   }, 'filter:api.videos.list.params')
 226
 227   const resultList = await Hooks.wrapPromiseFun(
 228     VideoModel.listForApi,
 229     apiOptions,
 230     'filter:api.videos.list.result'
 231   )
 232
 233   return res.json(getFormattedObjects(resultList.data, resultList.total))
 234 }
 235
 236 async function removeVideo (_req: express.Request, res: express.Response) {
 237   const videoInstance = res.locals.videoAll
 238
 239   await sequelizeTypescript.transaction(async t => {
 240     await videoInstance.destroy({ transaction: t })
 241   })
 242
 243   auditLogger.delete(getAuditIdFromRes(res), new VideoAuditView(videoInstance.toFormattedDetailsJSON()))
 244   logger.info('Video with name %s and uuid %s deleted.', videoInstance.name, videoInstance.uuid)
 245
 246   Hooks.runAction('action:api.video.deleted', { video: videoInstance })
 247
 248   return res.type('json')
 249             .status(HttpStatusCode.NO_CONTENT_204)
 250             .end()
 251 }
 252
 253 // ---------------------------------------------------------------------------
 254
 255 // FIXME: Should not exist, we rely on specific API
 256 async function fetchRemoteVideoDescription (video: MVideoAccountLight) {
 257   const host = video.VideoChannel.Account.Actor.Server.host
 258   const path = video.getDescriptionAPIPath()
 259   const url = REMOTE_SCHEME.HTTP + '://' + host + path
 260
 261   const { body } = await doJSONRequest<any>(url)
 262   return body.description || ''
 263 }