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