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'
23 asyncRetryTransactionMiddleware,
25 checkVideoFollowConstraints,
26 commonVideosFiltersValidator,
31 videoFileMetadataGetValidator,
32 videosCustomGetValidator,
34 videosRemoveValidator,
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'
50 const auditLogger = auditLoggerFactory('videos')
51 const videosRouter = express.Router()
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)
64 videosRouter.get('/categories',
65 openapiOperationDoc({ operationId: 'getCategories' }),
68 videosRouter.get('/licences',
69 openapiOperationDoc({ operationId: 'getLicences' }),
72 videosRouter.get('/languages',
73 openapiOperationDoc({ operationId: 'getLanguages' }),
76 videosRouter.get('/privacies',
77 openapiOperationDoc({ operationId: 'getPrivacies' }),
82 openapiOperationDoc({ operationId: 'getVideos' }),
88 commonVideosFiltersValidator,
89 asyncMiddleware(listVideos)
92 videosRouter.get('/:id/description',
93 openapiOperationDoc({ operationId: 'getVideoDesc' }),
94 asyncMiddleware(videosGetValidator),
95 asyncMiddleware(getVideoDescription)
97 videosRouter.get('/:id/metadata/:videoFileId',
98 asyncMiddleware(videoFileMetadataGetValidator),
99 asyncMiddleware(getVideoFileMetadata)
101 videosRouter.get('/:id',
102 openapiOperationDoc({ operationId: 'getVideo' }),
103 optionalAuthenticate,
104 asyncMiddleware(videosCustomGetValidator('for-api')),
105 asyncMiddleware(checkVideoFollowConstraints),
108 videosRouter.post('/:id/views',
109 openapiOperationDoc({ operationId: 'addView' }),
110 asyncMiddleware(videosCustomGetValidator('only-immutable-attributes')),
111 asyncMiddleware(viewVideo)
114 videosRouter.delete('/:id',
115 openapiOperationDoc({ operationId: 'delVideo' }),
117 asyncMiddleware(videosRemoveValidator),
118 asyncRetryTransactionMiddleware(removeVideo)
121 // ---------------------------------------------------------------------------
127 // ---------------------------------------------------------------------------
129 function listVideoCategories (_req: express.Request, res: express.Response) {
130 res.json(VIDEO_CATEGORIES)
133 function listVideoLicences (_req: express.Request, res: express.Response) {
134 res.json(VIDEO_LICENCES)
137 function listVideoLanguages (_req: express.Request, res: express.Response) {
138 res.json(VIDEO_LANGUAGES)
141 function listVideoPrivacies (_req: express.Request, res: express.Response) {
142 res.json(VIDEO_PRIVACIES)
145 function getVideo (_req: express.Request, res: express.Response) {
146 const video = res.locals.videoAPI
148 if (video.isOutdated()) {
149 JobQueue.Instance.createJob({ type: 'activitypub-refresher', payload: { type: 'video', url: video.url } })
152 return res.json(video.toFormattedDetailsJSON())
155 async function viewVideo (req: express.Request, res: express.Response) {
156 const immutableVideoAttrs = res.locals.onlyImmutableVideo
159 const exists = await Redis.Instance.doesVideoIPViewExist(ip, immutableVideoAttrs.uuid)
161 logger.debug('View for ip %s and video %s already exists.', ip, immutableVideoAttrs.uuid)
162 return res.status(HttpStatusCode.NO_CONTENT_204).end()
165 const video = await VideoModel.load(immutableVideoAttrs.id)
167 const promises: Promise<any>[] = [
168 Redis.Instance.setIPVideoView(ip, video.uuid, video.isLive)
171 let federateView = true
173 // Increment our live manager
174 if (video.isLive && video.isOwned()) {
175 LiveManager.Instance.addViewTo(video.id)
177 // Views of our local live will be sent by our live manager
181 // Increment our video views cache counter
183 promises.push(Redis.Instance.addVideoView(video.id))
187 const serverActor = await getServerActor()
188 promises.push(sendView(serverActor, video, undefined))
191 await Promise.all(promises)
193 Hooks.runAction('action:api.video.viewed', { video, ip })
195 return res.status(HttpStatusCode.NO_CONTENT_204).end()
198 async function getVideoDescription (req: express.Request, res: express.Response) {
199 const videoInstance = res.locals.videoAll
201 const description = videoInstance.isOwned()
202 ? videoInstance.description
203 : await fetchRemoteVideoDescription(videoInstance)
205 return res.json({ description })
208 async function getVideoFileMetadata (req: express.Request, res: express.Response) {
209 const videoFile = await VideoFileModel.loadWithMetadata(toInt(req.params.videoFileId))
211 return res.json(videoFile.metadata)
214 async function listVideos (req: express.Request, res: express.Response) {
215 const serverActor = await getServerActor()
217 const query = pickCommonVideoQuery(req.query)
218 const countVideos = getCountVideos(req)
220 const apiOptions = await Hooks.wrapObject({
223 displayOnlyForFollower: {
224 actorId: serverActor.id,
227 nsfw: buildNSFWFilter(res, query.nsfw),
228 user: res.locals.oauth ? res.locals.oauth.token.User : undefined,
230 }, 'filter:api.videos.list.params')
232 const resultList = await Hooks.wrapPromiseFun(
233 VideoModel.listForApi,
235 'filter:api.videos.list.result'
238 return res.json(getFormattedObjects(resultList.data, resultList.total, guessAdditionalAttributesFromQuery(query)))
241 async function removeVideo (_req: express.Request, res: express.Response) {
242 const videoInstance = res.locals.videoAll
244 await sequelizeTypescript.transaction(async t => {
245 await videoInstance.destroy({ transaction: t })
248 auditLogger.delete(getAuditIdFromRes(res), new VideoAuditView(videoInstance.toFormattedDetailsJSON()))
249 logger.info('Video with name %s and uuid %s deleted.', videoInstance.name, videoInstance.uuid)
251 Hooks.runAction('action:api.video.deleted', { video: videoInstance })
253 return res.type('json')
254 .status(HttpStatusCode.NO_CONTENT_204)
258 // ---------------------------------------------------------------------------
260 // FIXME: Should not exist, we rely on specific API
261 async function fetchRemoteVideoDescription (video: MVideoAccountLight) {
262 const host = video.VideoChannel.Account.Actor.Server.host
263 const path = video.getDescriptionAPIPath()
264 const url = REMOTE_SCHEME.HTTP + '://' + host + path
266 const { body } = await doJSONRequest<any>(url)
267 return body.description || ''