diff options
Diffstat (limited to 'server/controllers/api/videos')
-rw-r--r-- | server/controllers/api/videos/index.ts | 31 | ||||
-rw-r--r-- | server/controllers/api/videos/stats.ts | 66 | ||||
-rw-r--r-- | server/controllers/api/videos/view.ts | 68 | ||||
-rw-r--r-- | server/controllers/api/videos/watching.ts | 44 |
4 files changed, 139 insertions, 70 deletions
diff --git a/server/controllers/api/videos/index.ts b/server/controllers/api/videos/index.ts index c7617093c..be233722c 100644 --- a/server/controllers/api/videos/index.ts +++ b/server/controllers/api/videos/index.ts | |||
@@ -1,7 +1,6 @@ | |||
1 | import express from 'express' | 1 | import express from 'express' |
2 | import { pickCommonVideoQuery } from '@server/helpers/query' | 2 | import { pickCommonVideoQuery } from '@server/helpers/query' |
3 | import { doJSONRequest } from '@server/helpers/requests' | 3 | import { doJSONRequest } from '@server/helpers/requests' |
4 | import { VideoViews } from '@server/lib/video-views' | ||
5 | import { openapiOperationDoc } from '@server/middlewares/doc' | 4 | import { openapiOperationDoc } from '@server/middlewares/doc' |
6 | import { getServerActor } from '@server/models/application/application' | 5 | import { getServerActor } from '@server/models/application/application' |
7 | import { guessAdditionalAttributesFromQuery } from '@server/models/video/formatter/video-format-utils' | 6 | import { guessAdditionalAttributesFromQuery } from '@server/models/video/formatter/video-format-utils' |
@@ -13,7 +12,6 @@ import { logger } from '../../../helpers/logger' | |||
13 | import { getFormattedObjects } from '../../../helpers/utils' | 12 | import { getFormattedObjects } from '../../../helpers/utils' |
14 | import { REMOTE_SCHEME, VIDEO_CATEGORIES, VIDEO_LANGUAGES, VIDEO_LICENCES, VIDEO_PRIVACIES } from '../../../initializers/constants' | 13 | import { REMOTE_SCHEME, VIDEO_CATEGORIES, VIDEO_LANGUAGES, VIDEO_LICENCES, VIDEO_PRIVACIES } from '../../../initializers/constants' |
15 | import { sequelizeTypescript } from '../../../initializers/database' | 14 | import { sequelizeTypescript } from '../../../initializers/database' |
16 | import { sendView } from '../../../lib/activitypub/send/send-view' | ||
17 | import { JobQueue } from '../../../lib/job-queue' | 15 | import { JobQueue } from '../../../lib/job-queue' |
18 | import { Hooks } from '../../../lib/plugins/hooks' | 16 | import { Hooks } from '../../../lib/plugins/hooks' |
19 | import { | 17 | import { |
@@ -35,28 +33,30 @@ import { VideoModel } from '../../../models/video/video' | |||
35 | import { blacklistRouter } from './blacklist' | 33 | import { blacklistRouter } from './blacklist' |
36 | import { videoCaptionsRouter } from './captions' | 34 | import { videoCaptionsRouter } from './captions' |
37 | import { videoCommentRouter } from './comment' | 35 | import { videoCommentRouter } from './comment' |
38 | import { studioRouter } from './studio' | ||
39 | import { filesRouter } from './files' | 36 | import { filesRouter } from './files' |
40 | import { videoImportsRouter } from './import' | 37 | import { videoImportsRouter } from './import' |
41 | import { liveRouter } from './live' | 38 | import { liveRouter } from './live' |
42 | import { ownershipVideoRouter } from './ownership' | 39 | import { ownershipVideoRouter } from './ownership' |
43 | import { rateVideoRouter } from './rate' | 40 | import { rateVideoRouter } from './rate' |
41 | import { statsRouter } from './stats' | ||
42 | import { studioRouter } from './studio' | ||
44 | import { transcodingRouter } from './transcoding' | 43 | import { transcodingRouter } from './transcoding' |
45 | import { updateRouter } from './update' | 44 | import { updateRouter } from './update' |
46 | import { uploadRouter } from './upload' | 45 | import { uploadRouter } from './upload' |
47 | import { watchingRouter } from './watching' | 46 | import { viewRouter } from './view' |
48 | 47 | ||
49 | const auditLogger = auditLoggerFactory('videos') | 48 | const auditLogger = auditLoggerFactory('videos') |
50 | const videosRouter = express.Router() | 49 | const videosRouter = express.Router() |
51 | 50 | ||
52 | videosRouter.use('/', blacklistRouter) | 51 | videosRouter.use('/', blacklistRouter) |
52 | videosRouter.use('/', statsRouter) | ||
53 | videosRouter.use('/', rateVideoRouter) | 53 | videosRouter.use('/', rateVideoRouter) |
54 | videosRouter.use('/', videoCommentRouter) | 54 | videosRouter.use('/', videoCommentRouter) |
55 | videosRouter.use('/', studioRouter) | 55 | videosRouter.use('/', studioRouter) |
56 | videosRouter.use('/', videoCaptionsRouter) | 56 | videosRouter.use('/', videoCaptionsRouter) |
57 | videosRouter.use('/', videoImportsRouter) | 57 | videosRouter.use('/', videoImportsRouter) |
58 | videosRouter.use('/', ownershipVideoRouter) | 58 | videosRouter.use('/', ownershipVideoRouter) |
59 | videosRouter.use('/', watchingRouter) | 59 | videosRouter.use('/', viewRouter) |
60 | videosRouter.use('/', liveRouter) | 60 | videosRouter.use('/', liveRouter) |
61 | videosRouter.use('/', uploadRouter) | 61 | videosRouter.use('/', uploadRouter) |
62 | videosRouter.use('/', updateRouter) | 62 | videosRouter.use('/', updateRouter) |
@@ -103,11 +103,6 @@ videosRouter.get('/:id', | |||
103 | asyncMiddleware(checkVideoFollowConstraints), | 103 | asyncMiddleware(checkVideoFollowConstraints), |
104 | getVideo | 104 | getVideo |
105 | ) | 105 | ) |
106 | videosRouter.post('/:id/views', | ||
107 | openapiOperationDoc({ operationId: 'addView' }), | ||
108 | asyncMiddleware(videosCustomGetValidator('only-video')), | ||
109 | asyncMiddleware(viewVideo) | ||
110 | ) | ||
111 | 106 | ||
112 | videosRouter.delete('/:id', | 107 | videosRouter.delete('/:id', |
113 | openapiOperationDoc({ operationId: 'delVideo' }), | 108 | openapiOperationDoc({ operationId: 'delVideo' }), |
@@ -150,22 +145,6 @@ function getVideo (_req: express.Request, res: express.Response) { | |||
150 | return res.json(video.toFormattedDetailsJSON()) | 145 | return res.json(video.toFormattedDetailsJSON()) |
151 | } | 146 | } |
152 | 147 | ||
153 | async function viewVideo (req: express.Request, res: express.Response) { | ||
154 | const video = res.locals.onlyVideo | ||
155 | |||
156 | const ip = req.ip | ||
157 | const success = await VideoViews.Instance.processView({ video, ip }) | ||
158 | |||
159 | if (success) { | ||
160 | const serverActor = await getServerActor() | ||
161 | await sendView(serverActor, video, undefined) | ||
162 | |||
163 | Hooks.runAction('action:api.video.viewed', { video: video, ip, req, res }) | ||
164 | } | ||
165 | |||
166 | return res.status(HttpStatusCode.NO_CONTENT_204).end() | ||
167 | } | ||
168 | |||
169 | async function getVideoDescription (req: express.Request, res: express.Response) { | 148 | async function getVideoDescription (req: express.Request, res: express.Response) { |
170 | const videoInstance = res.locals.videoAll | 149 | const videoInstance = res.locals.videoAll |
171 | 150 | ||
diff --git a/server/controllers/api/videos/stats.ts b/server/controllers/api/videos/stats.ts new file mode 100644 index 000000000..5f8513e9e --- /dev/null +++ b/server/controllers/api/videos/stats.ts | |||
@@ -0,0 +1,66 @@ | |||
1 | import express from 'express' | ||
2 | import { LocalVideoViewerModel } from '@server/models/view/local-video-viewer' | ||
3 | import { VideoStatsTimeserieMetric } from '@shared/models' | ||
4 | import { | ||
5 | asyncMiddleware, | ||
6 | authenticate, | ||
7 | videoOverallStatsValidator, | ||
8 | videoRetentionStatsValidator, | ||
9 | videoTimeserieStatsValidator | ||
10 | } from '../../../middlewares' | ||
11 | |||
12 | const statsRouter = express.Router() | ||
13 | |||
14 | statsRouter.get('/:videoId/stats/overall', | ||
15 | authenticate, | ||
16 | asyncMiddleware(videoOverallStatsValidator), | ||
17 | asyncMiddleware(getOverallStats) | ||
18 | ) | ||
19 | |||
20 | statsRouter.get('/:videoId/stats/timeseries/:metric', | ||
21 | authenticate, | ||
22 | asyncMiddleware(videoTimeserieStatsValidator), | ||
23 | asyncMiddleware(getTimeserieStats) | ||
24 | ) | ||
25 | |||
26 | statsRouter.get('/:videoId/stats/retention', | ||
27 | authenticate, | ||
28 | asyncMiddleware(videoRetentionStatsValidator), | ||
29 | asyncMiddleware(getRetentionStats) | ||
30 | ) | ||
31 | |||
32 | // --------------------------------------------------------------------------- | ||
33 | |||
34 | export { | ||
35 | statsRouter | ||
36 | } | ||
37 | |||
38 | // --------------------------------------------------------------------------- | ||
39 | |||
40 | async function getOverallStats (req: express.Request, res: express.Response) { | ||
41 | const video = res.locals.videoAll | ||
42 | |||
43 | const stats = await LocalVideoViewerModel.getOverallStats(video) | ||
44 | |||
45 | return res.json(stats) | ||
46 | } | ||
47 | |||
48 | async function getRetentionStats (req: express.Request, res: express.Response) { | ||
49 | const video = res.locals.videoAll | ||
50 | |||
51 | const stats = await LocalVideoViewerModel.getRetentionStats(video) | ||
52 | |||
53 | return res.json(stats) | ||
54 | } | ||
55 | |||
56 | async function getTimeserieStats (req: express.Request, res: express.Response) { | ||
57 | const video = res.locals.videoAll | ||
58 | const metric = req.params.metric as VideoStatsTimeserieMetric | ||
59 | |||
60 | const stats = await LocalVideoViewerModel.getTimeserieStats({ | ||
61 | video, | ||
62 | metric | ||
63 | }) | ||
64 | |||
65 | return res.json(stats) | ||
66 | } | ||
diff --git a/server/controllers/api/videos/view.ts b/server/controllers/api/videos/view.ts new file mode 100644 index 000000000..e28cf371a --- /dev/null +++ b/server/controllers/api/videos/view.ts | |||
@@ -0,0 +1,68 @@ | |||
1 | import express from 'express' | ||
2 | import { sendView } from '@server/lib/activitypub/send/send-view' | ||
3 | import { Hooks } from '@server/lib/plugins/hooks' | ||
4 | import { VideoViewsManager } from '@server/lib/views/video-views-manager' | ||
5 | import { getServerActor } from '@server/models/application/application' | ||
6 | import { MVideoId } from '@server/types/models' | ||
7 | import { HttpStatusCode, VideoView } from '@shared/models' | ||
8 | import { asyncMiddleware, methodsValidator, openapiOperationDoc, optionalAuthenticate, videoViewValidator } from '../../../middlewares' | ||
9 | import { UserVideoHistoryModel } from '../../../models/user/user-video-history' | ||
10 | |||
11 | const viewRouter = express.Router() | ||
12 | |||
13 | viewRouter.all( | ||
14 | [ '/:videoId/views', '/:videoId/watching' ], | ||
15 | openapiOperationDoc({ operationId: 'addView' }), | ||
16 | methodsValidator([ 'PUT', 'POST' ]), | ||
17 | optionalAuthenticate, | ||
18 | asyncMiddleware(videoViewValidator), | ||
19 | asyncMiddleware(viewVideo) | ||
20 | ) | ||
21 | |||
22 | // --------------------------------------------------------------------------- | ||
23 | |||
24 | export { | ||
25 | viewRouter | ||
26 | } | ||
27 | |||
28 | // --------------------------------------------------------------------------- | ||
29 | |||
30 | async function viewVideo (req: express.Request, res: express.Response) { | ||
31 | const video = res.locals.onlyVideo | ||
32 | |||
33 | const body = req.body as VideoView | ||
34 | |||
35 | const ip = req.ip | ||
36 | const { successView, successViewer } = await VideoViewsManager.Instance.processLocalView({ | ||
37 | video, | ||
38 | ip, | ||
39 | currentTime: body.currentTime, | ||
40 | viewEvent: body.viewEvent | ||
41 | }) | ||
42 | |||
43 | if (successView) { | ||
44 | await sendView({ byActor: await getServerActor(), video, type: 'view' }) | ||
45 | |||
46 | Hooks.runAction('action:api.video.viewed', { video: video, ip, req, res }) | ||
47 | } | ||
48 | |||
49 | if (successViewer) { | ||
50 | await sendView({ byActor: await getServerActor(), video, type: 'viewer' }) | ||
51 | } | ||
52 | |||
53 | await updateUserHistoryIfNeeded(body, video, res) | ||
54 | |||
55 | return res.status(HttpStatusCode.NO_CONTENT_204).end() | ||
56 | } | ||
57 | |||
58 | async function updateUserHistoryIfNeeded (body: VideoView, video: MVideoId, res: express.Response) { | ||
59 | const user = res.locals.oauth?.token.User | ||
60 | if (!user) return | ||
61 | if (user.videosHistoryEnabled !== true) return | ||
62 | |||
63 | await UserVideoHistoryModel.upsert({ | ||
64 | videoId: video.id, | ||
65 | userId: user.id, | ||
66 | currentTime: body.currentTime | ||
67 | }) | ||
68 | } | ||
diff --git a/server/controllers/api/videos/watching.ts b/server/controllers/api/videos/watching.ts deleted file mode 100644 index 3fd22caac..000000000 --- a/server/controllers/api/videos/watching.ts +++ /dev/null | |||
@@ -1,44 +0,0 @@ | |||
1 | import express from 'express' | ||
2 | import { HttpStatusCode, UserWatchingVideo } from '@shared/models' | ||
3 | import { | ||
4 | asyncMiddleware, | ||
5 | asyncRetryTransactionMiddleware, | ||
6 | authenticate, | ||
7 | openapiOperationDoc, | ||
8 | videoWatchingValidator | ||
9 | } from '../../../middlewares' | ||
10 | import { UserVideoHistoryModel } from '../../../models/user/user-video-history' | ||
11 | |||
12 | const watchingRouter = express.Router() | ||
13 | |||
14 | watchingRouter.put('/:videoId/watching', | ||
15 | openapiOperationDoc({ operationId: 'setProgress' }), | ||
16 | authenticate, | ||
17 | asyncMiddleware(videoWatchingValidator), | ||
18 | asyncRetryTransactionMiddleware(userWatchVideo) | ||
19 | ) | ||
20 | |||
21 | // --------------------------------------------------------------------------- | ||
22 | |||
23 | export { | ||
24 | watchingRouter | ||
25 | } | ||
26 | |||
27 | // --------------------------------------------------------------------------- | ||
28 | |||
29 | async function userWatchVideo (req: express.Request, res: express.Response) { | ||
30 | const user = res.locals.oauth.token.User | ||
31 | |||
32 | const body: UserWatchingVideo = req.body | ||
33 | const { id: videoId } = res.locals.videoId | ||
34 | |||
35 | await UserVideoHistoryModel.upsert({ | ||
36 | videoId, | ||
37 | userId: user.id, | ||
38 | currentTime: body.currentTime | ||
39 | }) | ||
40 | |||
41 | return res.type('json') | ||
42 | .status(HttpStatusCode.NO_CONTENT_204) | ||
43 | .end() | ||
44 | } | ||