]>
Commit | Line | Data |
---|---|---|
41fb13c3 | 1 | import express from 'express' |
8054669f | 2 | import toInt from 'validator/lib/toInt' |
d6886027 | 3 | import { pickCommonVideoQuery } from '@server/helpers/query' |
304a84d5 | 4 | import { doJSONRequest } from '@server/helpers/requests' |
51353d9a | 5 | import { VideoViews } from '@server/lib/video-views' |
1c627fd8 | 6 | import { openapiOperationDoc } from '@server/middlewares/doc' |
8054669f | 7 | import { getServerActor } from '@server/models/application/application' |
2760b454 | 8 | import { guessAdditionalAttributesFromQuery } from '@server/models/video/formatter/video-format-utils' |
304a84d5 | 9 | import { MVideoAccountLight } from '@server/types/models' |
c0e8b12e | 10 | import { HttpStatusCode } from '../../../../shared/models' |
8054669f | 11 | import { auditLoggerFactory, getAuditIdFromRes, VideoAuditView } from '../../../helpers/audit-logger' |
c158a5fa C |
12 | import { buildNSFWFilter, getCountVideos } from '../../../helpers/express-utils' |
13 | import { logger } from '../../../helpers/logger' | |
8dc8a34e | 14 | import { getFormattedObjects } from '../../../helpers/utils' |
304a84d5 | 15 | import { REMOTE_SCHEME, VIDEO_CATEGORIES, VIDEO_LANGUAGES, VIDEO_LICENCES, VIDEO_PRIVACIES } from '../../../initializers/constants' |
8054669f C |
16 | import { sequelizeTypescript } from '../../../initializers/database' |
17 | import { sendView } from '../../../lib/activitypub/send/send-view' | |
94a5ff8a | 18 | import { JobQueue } from '../../../lib/job-queue' |
8054669f | 19 | import { Hooks } from '../../../lib/plugins/hooks' |
65fcc311 | 20 | import { |
ac81d1a0 | 21 | asyncMiddleware, |
90d4bb81 | 22 | asyncRetryTransactionMiddleware, |
ac81d1a0 | 23 | authenticate, |
8d427346 | 24 | checkVideoFollowConstraints, |
d525fc39 | 25 | commonVideosFiltersValidator, |
0883b324 | 26 | optionalAuthenticate, |
ac81d1a0 C |
27 | paginationValidator, |
28 | setDefaultPagination, | |
8054669f | 29 | setDefaultVideosSort, |
d57d1d83 | 30 | videoFileMetadataGetValidator, |
09209296 | 31 | videosCustomGetValidator, |
ac81d1a0 C |
32 | videosGetValidator, |
33 | videosRemoveValidator, | |
c158a5fa | 34 | videosSortValidator |
65fcc311 | 35 | } from '../../../middlewares' |
3fd3ab2d C |
36 | import { VideoModel } from '../../../models/video/video' |
37 | import { VideoFileModel } from '../../../models/video/video-file' | |
65fcc311 | 38 | import { blacklistRouter } from './blacklist' |
40e87e9e | 39 | import { videoCaptionsRouter } from './captions' |
8054669f | 40 | import { videoCommentRouter } from './comment' |
fbad87b0 | 41 | import { videoImportsRouter } from './import' |
c6c0fa6c | 42 | import { liveRouter } from './live' |
8054669f C |
43 | import { ownershipVideoRouter } from './ownership' |
44 | import { rateVideoRouter } from './rate' | |
c158a5fa C |
45 | import { updateRouter } from './update' |
46 | import { uploadRouter } from './upload' | |
6e46de09 | 47 | import { watchingRouter } from './watching' |
65fcc311 | 48 | |
80e36cd9 | 49 | const auditLogger = auditLoggerFactory('videos') |
65fcc311 | 50 | const videosRouter = express.Router() |
8c308c2b | 51 | |
65fcc311 C |
52 | videosRouter.use('/', blacklistRouter) |
53 | videosRouter.use('/', rateVideoRouter) | |
bf1f6508 | 54 | videosRouter.use('/', videoCommentRouter) |
40e87e9e | 55 | videosRouter.use('/', videoCaptionsRouter) |
fbad87b0 | 56 | videosRouter.use('/', videoImportsRouter) |
74d63469 | 57 | videosRouter.use('/', ownershipVideoRouter) |
6e46de09 | 58 | videosRouter.use('/', watchingRouter) |
c6c0fa6c | 59 | videosRouter.use('/', liveRouter) |
c158a5fa C |
60 | videosRouter.use('/', uploadRouter) |
61 | videosRouter.use('/', updateRouter) | |
d33242b0 | 62 | |
c756bae0 RK |
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 | ) | |
6e07c3de | 79 | |
65fcc311 | 80 | videosRouter.get('/', |
c756bae0 | 81 | openapiOperationDoc({ operationId: 'getVideos' }), |
65fcc311 C |
82 | paginationValidator, |
83 | videosSortValidator, | |
8054669f | 84 | setDefaultVideosSort, |
f05a1c30 | 85 | setDefaultPagination, |
0883b324 | 86 | optionalAuthenticate, |
d525fc39 | 87 | commonVideosFiltersValidator, |
eb080476 | 88 | asyncMiddleware(listVideos) |
fbf1134e | 89 | ) |
f6d6e7f8 | 90 | |
9567011b | 91 | videosRouter.get('/:id/description', |
c756bae0 | 92 | openapiOperationDoc({ operationId: 'getVideoDesc' }), |
a2431b7d | 93 | asyncMiddleware(videosGetValidator), |
9567011b C |
94 | asyncMiddleware(getVideoDescription) |
95 | ) | |
8319d6ae RK |
96 | videosRouter.get('/:id/metadata/:videoFileId', |
97 | asyncMiddleware(videoFileMetadataGetValidator), | |
98 | asyncMiddleware(getVideoFileMetadata) | |
99 | ) | |
65fcc311 | 100 | videosRouter.get('/:id', |
1c627fd8 | 101 | openapiOperationDoc({ operationId: 'getVideo' }), |
6e46de09 | 102 | optionalAuthenticate, |
ca4b4b2e | 103 | asyncMiddleware(videosCustomGetValidator('for-api')), |
8d427346 | 104 | asyncMiddleware(checkVideoFollowConstraints), |
98ab5dc8 | 105 | getVideo |
fbf1134e | 106 | ) |
1f3e9fec | 107 | videosRouter.post('/:id/views', |
c756bae0 | 108 | openapiOperationDoc({ operationId: 'addView' }), |
51353d9a | 109 | asyncMiddleware(videosCustomGetValidator('only-video')), |
1f3e9fec C |
110 | asyncMiddleware(viewVideo) |
111 | ) | |
198b205c | 112 | |
65fcc311 | 113 | videosRouter.delete('/:id', |
1c627fd8 | 114 | openapiOperationDoc({ operationId: 'delVideo' }), |
65fcc311 | 115 | authenticate, |
a2431b7d | 116 | asyncMiddleware(videosRemoveValidator), |
90d4bb81 | 117 | asyncRetryTransactionMiddleware(removeVideo) |
fbf1134e | 118 | ) |
198b205c | 119 | |
9f10b292 | 120 | // --------------------------------------------------------------------------- |
c45f7f84 | 121 | |
65fcc311 C |
122 | export { |
123 | videosRouter | |
124 | } | |
c45f7f84 | 125 | |
9f10b292 | 126 | // --------------------------------------------------------------------------- |
c45f7f84 | 127 | |
f6d6e7f8 | 128 | function listVideoCategories (_req: express.Request, res: express.Response) { |
65fcc311 | 129 | res.json(VIDEO_CATEGORIES) |
6e07c3de C |
130 | } |
131 | ||
f6d6e7f8 | 132 | function listVideoLicences (_req: express.Request, res: express.Response) { |
65fcc311 | 133 | res.json(VIDEO_LICENCES) |
6f0c39e2 C |
134 | } |
135 | ||
f6d6e7f8 | 136 | function listVideoLanguages (_req: express.Request, res: express.Response) { |
65fcc311 | 137 | res.json(VIDEO_LANGUAGES) |
3092476e C |
138 | } |
139 | ||
f6d6e7f8 | 140 | function listVideoPrivacies (_req: express.Request, res: express.Response) { |
fd45e8f4 C |
141 | res.json(VIDEO_PRIVACIES) |
142 | } | |
143 | ||
98ab5dc8 | 144 | function getVideo (_req: express.Request, res: express.Response) { |
ca4b4b2e | 145 | const video = res.locals.videoAPI |
1f3e9fec | 146 | |
09209296 C |
147 | if (video.isOutdated()) { |
148 | JobQueue.Instance.createJob({ type: 'activitypub-refresher', payload: { type: 'video', url: video.url } }) | |
04b8c3fb C |
149 | } |
150 | ||
09209296 | 151 | return res.json(video.toFormattedDetailsJSON()) |
1f3e9fec C |
152 | } |
153 | ||
154 | async function viewVideo (req: express.Request, res: express.Response) { | |
51353d9a | 155 | const video = res.locals.onlyVideo |
9e167724 | 156 | |
490b595a | 157 | const ip = req.ip |
51353d9a | 158 | const success = await VideoViews.Instance.processView({ video, ip }) |
e4bf7856 | 159 | |
51353d9a | 160 | if (success) { |
e4bf7856 | 161 | const serverActor = await getServerActor() |
51353d9a | 162 | await sendView(serverActor, video, undefined) |
e4bf7856 | 163 | |
51353d9a C |
164 | Hooks.runAction('action:api.video.viewed', { video: video, ip }) |
165 | } | |
e4bf7856 | 166 | |
76148b27 | 167 | return res.status(HttpStatusCode.NO_CONTENT_204).end() |
9f10b292 | 168 | } |
8c308c2b | 169 | |
9567011b | 170 | async function getVideoDescription (req: express.Request, res: express.Response) { |
453e83ea | 171 | const videoInstance = res.locals.videoAll |
9567011b | 172 | |
c158a5fa C |
173 | const description = videoInstance.isOwned() |
174 | ? videoInstance.description | |
175 | : await fetchRemoteVideoDescription(videoInstance) | |
9567011b C |
176 | |
177 | return res.json({ description }) | |
178 | } | |
179 | ||
8319d6ae RK |
180 | async function getVideoFileMetadata (req: express.Request, res: express.Response) { |
181 | const videoFile = await VideoFileModel.loadWithMetadata(toInt(req.params.videoFileId)) | |
583eb04b | 182 | |
8319d6ae RK |
183 | return res.json(videoFile.metadata) |
184 | } | |
185 | ||
04b8c3fb | 186 | async function listVideos (req: express.Request, res: express.Response) { |
2760b454 C |
187 | const serverActor = await getServerActor() |
188 | ||
d6886027 | 189 | const query = pickCommonVideoQuery(req.query) |
fe987656 C |
190 | const countVideos = getCountVideos(req) |
191 | ||
b4055e1c | 192 | const apiOptions = await Hooks.wrapObject({ |
d6886027 C |
193 | ...query, |
194 | ||
2760b454 C |
195 | displayOnlyForFollower: { |
196 | actorId: serverActor.id, | |
197 | orLocalVideos: true | |
198 | }, | |
1fd61899 | 199 | nsfw: buildNSFWFilter(res, query.nsfw), |
fe987656 C |
200 | user: res.locals.oauth ? res.locals.oauth.token.User : undefined, |
201 | countVideos | |
b4055e1c C |
202 | }, 'filter:api.videos.list.params') |
203 | ||
89cd1275 C |
204 | const resultList = await Hooks.wrapPromiseFun( |
205 | VideoModel.listForApi, | |
206 | apiOptions, | |
b4055e1c C |
207 | 'filter:api.videos.list.result' |
208 | ) | |
eb080476 | 209 | |
2760b454 | 210 | return res.json(getFormattedObjects(resultList.data, resultList.total, guessAdditionalAttributesFromQuery(query))) |
9f10b292 | 211 | } |
c45f7f84 | 212 | |
c158a5fa | 213 | async function removeVideo (_req: express.Request, res: express.Response) { |
453e83ea | 214 | const videoInstance = res.locals.videoAll |
91f6f169 | 215 | |
3fd3ab2d | 216 | await sequelizeTypescript.transaction(async t => { |
eb080476 | 217 | await videoInstance.destroy({ transaction: t }) |
91f6f169 | 218 | }) |
eb080476 | 219 | |
993cef4b | 220 | auditLogger.delete(getAuditIdFromRes(res), new VideoAuditView(videoInstance.toFormattedDetailsJSON())) |
eb080476 | 221 | logger.info('Video with name %s and uuid %s deleted.', videoInstance.name, videoInstance.uuid) |
90d4bb81 | 222 | |
b4055e1c C |
223 | Hooks.runAction('action:api.video.deleted', { video: videoInstance }) |
224 | ||
2d53be02 RK |
225 | return res.type('json') |
226 | .status(HttpStatusCode.NO_CONTENT_204) | |
227 | .end() | |
9f10b292 | 228 | } |
304a84d5 C |
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 | } |