1 import * as cors from 'cors'
2 import * as express from 'express'
3 import { getServerActor } from '@server/models/application/application'
4 import { MAccountId, MActorId, MChannelId, MVideoId } from '@server/types/models'
5 import { VideoPrivacy, VideoRateType } from '../../../shared/models/videos'
6 import { VideoPlaylistPrivacy } from '../../../shared/models/videos/playlist/video-playlist-privacy.model'
7 import { activityPubCollectionPagination, activityPubContextify } from '../../helpers/activitypub'
8 import { ROUTE_CACHE_LIFETIME, WEBSERVER } from '../../initializers/constants'
9 import { audiencify, getAudience } from '../../lib/activitypub/audience'
10 import { buildAnnounceWithVideoAudience, buildLikeActivity } from '../../lib/activitypub/send'
11 import { buildCreateActivity } from '../../lib/activitypub/send/send-create'
12 import { buildDislikeActivity } from '../../lib/activitypub/send/send-dislike'
14 getLocalVideoCommentsActivityPubUrl,
15 getLocalVideoDislikesActivityPubUrl,
16 getLocalVideoLikesActivityPubUrl,
17 getLocalVideoSharesActivityPubUrl
18 } from '../../lib/activitypub/url'
22 localAccountValidator,
23 localVideoChannelValidator,
24 videosCustomGetValidator,
26 } from '../../middlewares'
27 import { cacheRoute } from '../../middlewares/cache'
28 import { getAccountVideoRateValidatorFactory, videoCommentGetValidator } from '../../middlewares/validators'
29 import { videoFileRedundancyGetValidator, videoPlaylistRedundancyGetValidator } from '../../middlewares/validators/redundancy'
30 import { videoPlaylistElementAPGetValidator, videoPlaylistsGetValidator } from '../../middlewares/validators/videos/video-playlists'
31 import { AccountModel } from '../../models/account/account'
32 import { AccountVideoRateModel } from '../../models/account/account-video-rate'
33 import { ActorFollowModel } from '../../models/actor/actor-follow'
34 import { VideoCaptionModel } from '../../models/video/video-caption'
35 import { VideoCommentModel } from '../../models/video/video-comment'
36 import { VideoPlaylistModel } from '../../models/video/video-playlist'
37 import { VideoShareModel } from '../../models/video/video-share'
38 import { activityPubResponse } from './utils'
40 const activityPubClientRouter = express.Router()
41 activityPubClientRouter.use(cors())
43 // Intercept ActivityPub client requests
45 activityPubClientRouter.get(
46 [ '/accounts?/:name', '/accounts?/:name/video-channels', '/a/:name', '/a/:name/video-channels' ],
48 asyncMiddleware(localAccountValidator),
51 activityPubClientRouter.get('/accounts?/:name/followers',
53 asyncMiddleware(localAccountValidator),
54 asyncMiddleware(accountFollowersController)
56 activityPubClientRouter.get('/accounts?/:name/following',
58 asyncMiddleware(localAccountValidator),
59 asyncMiddleware(accountFollowingController)
61 activityPubClientRouter.get('/accounts?/:name/playlists',
63 asyncMiddleware(localAccountValidator),
64 asyncMiddleware(accountPlaylistsController)
66 activityPubClientRouter.get('/accounts?/:name/likes/:videoId',
68 asyncMiddleware(getAccountVideoRateValidatorFactory('like')),
69 getAccountVideoRateFactory('like')
71 activityPubClientRouter.get('/accounts?/:name/dislikes/:videoId',
73 asyncMiddleware(getAccountVideoRateValidatorFactory('dislike')),
74 getAccountVideoRateFactory('dislike')
77 activityPubClientRouter.get(
78 [ '/videos/watch/:id', '/w/:id' ],
80 asyncMiddleware(cacheRoute()(ROUTE_CACHE_LIFETIME.ACTIVITY_PUB.VIDEOS)),
81 asyncMiddleware(videosCustomGetValidator('all')),
82 asyncMiddleware(videoController)
84 activityPubClientRouter.get('/videos/watch/:id/activity',
86 asyncMiddleware(videosCustomGetValidator('all')),
87 asyncMiddleware(videoController)
89 activityPubClientRouter.get('/videos/watch/:id/announces',
91 asyncMiddleware(videosCustomGetValidator('only-immutable-attributes')),
92 asyncMiddleware(videoAnnouncesController)
94 activityPubClientRouter.get('/videos/watch/:id/announces/:actorId',
96 asyncMiddleware(videosShareValidator),
97 asyncMiddleware(videoAnnounceController)
99 activityPubClientRouter.get('/videos/watch/:id/likes',
100 executeIfActivityPub,
101 asyncMiddleware(videosCustomGetValidator('only-immutable-attributes')),
102 asyncMiddleware(videoLikesController)
104 activityPubClientRouter.get('/videos/watch/:id/dislikes',
105 executeIfActivityPub,
106 asyncMiddleware(videosCustomGetValidator('only-immutable-attributes')),
107 asyncMiddleware(videoDislikesController)
109 activityPubClientRouter.get('/videos/watch/:id/comments',
110 executeIfActivityPub,
111 asyncMiddleware(videosCustomGetValidator('only-immutable-attributes')),
112 asyncMiddleware(videoCommentsController)
114 activityPubClientRouter.get('/videos/watch/:videoId/comments/:commentId',
115 executeIfActivityPub,
116 asyncMiddleware(videoCommentGetValidator),
117 asyncMiddleware(videoCommentController)
119 activityPubClientRouter.get('/videos/watch/:videoId/comments/:commentId/activity',
120 executeIfActivityPub,
121 asyncMiddleware(videoCommentGetValidator),
122 asyncMiddleware(videoCommentController)
125 activityPubClientRouter.get(
126 [ '/video-channels/:name', '/video-channels/:name/videos', '/c/:name', '/c/:name/videos' ],
127 executeIfActivityPub,
128 asyncMiddleware(localVideoChannelValidator),
129 videoChannelController
131 activityPubClientRouter.get('/video-channels/:name/followers',
132 executeIfActivityPub,
133 asyncMiddleware(localVideoChannelValidator),
134 asyncMiddleware(videoChannelFollowersController)
136 activityPubClientRouter.get('/video-channels/:name/following',
137 executeIfActivityPub,
138 asyncMiddleware(localVideoChannelValidator),
139 asyncMiddleware(videoChannelFollowingController)
141 activityPubClientRouter.get('/video-channels/:name/playlists',
142 executeIfActivityPub,
143 asyncMiddleware(localVideoChannelValidator),
144 asyncMiddleware(videoChannelPlaylistsController)
147 activityPubClientRouter.get('/redundancy/videos/:videoId/:resolution([0-9]+)(-:fps([0-9]+))?',
148 executeIfActivityPub,
149 asyncMiddleware(videoFileRedundancyGetValidator),
150 asyncMiddleware(videoRedundancyController)
152 activityPubClientRouter.get('/redundancy/streaming-playlists/:streamingPlaylistType/:videoId',
153 executeIfActivityPub,
154 asyncMiddleware(videoPlaylistRedundancyGetValidator),
155 asyncMiddleware(videoRedundancyController)
158 activityPubClientRouter.get('/video-playlists/:playlistId',
159 executeIfActivityPub,
160 asyncMiddleware(videoPlaylistsGetValidator('all')),
161 asyncMiddleware(videoPlaylistController)
163 activityPubClientRouter.get('/video-playlists/:playlistId/videos/:playlistElementId',
164 executeIfActivityPub,
165 asyncMiddleware(videoPlaylistElementAPGetValidator),
166 videoPlaylistElementController
169 // ---------------------------------------------------------------------------
172 activityPubClientRouter
175 // ---------------------------------------------------------------------------
177 function accountController (req: express.Request, res: express.Response) {
178 const account = res.locals.account
180 return activityPubResponse(activityPubContextify(account.toActivityPubObject()), res)
183 async function accountFollowersController (req: express.Request, res: express.Response) {
184 const account = res.locals.account
185 const activityPubResult = await actorFollowers(req, account.Actor)
187 return activityPubResponse(activityPubContextify(activityPubResult), res)
190 async function accountFollowingController (req: express.Request, res: express.Response) {
191 const account = res.locals.account
192 const activityPubResult = await actorFollowing(req, account.Actor)
194 return activityPubResponse(activityPubContextify(activityPubResult), res)
197 async function accountPlaylistsController (req: express.Request, res: express.Response) {
198 const account = res.locals.account
199 const activityPubResult = await actorPlaylists(req, { account })
201 return activityPubResponse(activityPubContextify(activityPubResult), res)
204 async function videoChannelPlaylistsController (req: express.Request, res: express.Response) {
205 const channel = res.locals.videoChannel
206 const activityPubResult = await actorPlaylists(req, { channel })
208 return activityPubResponse(activityPubContextify(activityPubResult), res)
211 function getAccountVideoRateFactory (rateType: VideoRateType) {
212 return (req: express.Request, res: express.Response) => {
213 const accountVideoRate = res.locals.accountVideoRate
215 const byActor = accountVideoRate.Account.Actor
216 const APObject = rateType === 'like'
217 ? buildLikeActivity(accountVideoRate.url, byActor, accountVideoRate.Video)
218 : buildDislikeActivity(accountVideoRate.url, byActor, accountVideoRate.Video)
220 return activityPubResponse(activityPubContextify(APObject), res)
224 async function videoController (req: express.Request, res: express.Response) {
225 const video = res.locals.videoAll
227 if (redirectIfNotOwned(video.url, res)) return
229 // We need captions to render AP object
230 const captions = await VideoCaptionModel.listVideoCaptions(video.id)
231 const videoWithCaptions = Object.assign(video, { VideoCaptions: captions })
233 const audience = getAudience(videoWithCaptions.VideoChannel.Account.Actor, videoWithCaptions.privacy === VideoPrivacy.PUBLIC)
234 const videoObject = audiencify(videoWithCaptions.toActivityPubObject(), audience)
236 if (req.path.endsWith('/activity')) {
237 const data = buildCreateActivity(videoWithCaptions.url, video.VideoChannel.Account.Actor, videoObject, audience)
238 return activityPubResponse(activityPubContextify(data), res)
241 return activityPubResponse(activityPubContextify(videoObject), res)
244 async function videoAnnounceController (req: express.Request, res: express.Response) {
245 const share = res.locals.videoShare
247 if (redirectIfNotOwned(share.url, res)) return
249 const { activity } = await buildAnnounceWithVideoAudience(share.Actor, share, res.locals.videoAll, undefined)
251 return activityPubResponse(activityPubContextify(activity, 'Announce'), res)
254 async function videoAnnouncesController (req: express.Request, res: express.Response) {
255 const video = res.locals.onlyImmutableVideo
257 if (redirectIfNotOwned(video.url, res)) return
259 const handler = async (start: number, count: number) => {
260 const result = await VideoShareModel.listAndCountByVideoId(video.id, start, count)
263 data: result.rows.map(r => r.url)
266 const json = await activityPubCollectionPagination(getLocalVideoSharesActivityPubUrl(video), handler, req.query.page)
268 return activityPubResponse(activityPubContextify(json), res)
271 async function videoLikesController (req: express.Request, res: express.Response) {
272 const video = res.locals.onlyImmutableVideo
274 if (redirectIfNotOwned(video.url, res)) return
276 const json = await videoRates(req, 'like', video, getLocalVideoLikesActivityPubUrl(video))
278 return activityPubResponse(activityPubContextify(json), res)
281 async function videoDislikesController (req: express.Request, res: express.Response) {
282 const video = res.locals.onlyImmutableVideo
284 if (redirectIfNotOwned(video.url, res)) return
286 const json = await videoRates(req, 'dislike', video, getLocalVideoDislikesActivityPubUrl(video))
288 return activityPubResponse(activityPubContextify(json), res)
291 async function videoCommentsController (req: express.Request, res: express.Response) {
292 const video = res.locals.onlyImmutableVideo
294 if (redirectIfNotOwned(video.url, res)) return
296 const handler = async (start: number, count: number) => {
297 const result = await VideoCommentModel.listAndCountByVideoForAP(video, start, count)
300 data: result.rows.map(r => r.url)
303 const json = await activityPubCollectionPagination(getLocalVideoCommentsActivityPubUrl(video), handler, req.query.page)
305 return activityPubResponse(activityPubContextify(json), res)
308 function videoChannelController (req: express.Request, res: express.Response) {
309 const videoChannel = res.locals.videoChannel
311 return activityPubResponse(activityPubContextify(videoChannel.toActivityPubObject()), res)
314 async function videoChannelFollowersController (req: express.Request, res: express.Response) {
315 const videoChannel = res.locals.videoChannel
316 const activityPubResult = await actorFollowers(req, videoChannel.Actor)
318 return activityPubResponse(activityPubContextify(activityPubResult), res)
321 async function videoChannelFollowingController (req: express.Request, res: express.Response) {
322 const videoChannel = res.locals.videoChannel
323 const activityPubResult = await actorFollowing(req, videoChannel.Actor)
325 return activityPubResponse(activityPubContextify(activityPubResult), res)
328 async function videoCommentController (req: express.Request, res: express.Response) {
329 const videoComment = res.locals.videoCommentFull
331 if (redirectIfNotOwned(videoComment.url, res)) return
333 const threadParentComments = await VideoCommentModel.listThreadParentComments(videoComment, undefined)
334 const isPublic = true // Comments are always public
335 let videoCommentObject = videoComment.toActivityPubObject(threadParentComments)
337 if (videoComment.Account) {
338 const audience = getAudience(videoComment.Account.Actor, isPublic)
339 videoCommentObject = audiencify(videoCommentObject, audience)
341 if (req.path.endsWith('/activity')) {
342 const data = buildCreateActivity(videoComment.url, videoComment.Account.Actor, videoCommentObject, audience)
343 return activityPubResponse(activityPubContextify(data), res)
347 return activityPubResponse(activityPubContextify(videoCommentObject), res)
350 async function videoRedundancyController (req: express.Request, res: express.Response) {
351 const videoRedundancy = res.locals.videoRedundancy
353 if (redirectIfNotOwned(videoRedundancy.url, res)) return
355 const serverActor = await getServerActor()
357 const audience = getAudience(serverActor)
358 const object = audiencify(videoRedundancy.toActivityPubObject(), audience)
360 if (req.path.endsWith('/activity')) {
361 const data = buildCreateActivity(videoRedundancy.url, serverActor, object, audience)
362 return activityPubResponse(activityPubContextify(data, 'CacheFile'), res)
365 return activityPubResponse(activityPubContextify(object, 'CacheFile'), res)
368 async function videoPlaylistController (req: express.Request, res: express.Response) {
369 const playlist = res.locals.videoPlaylistFull
371 if (redirectIfNotOwned(playlist.url, res)) return
373 // We need more attributes
374 playlist.OwnerAccount = await AccountModel.load(playlist.ownerAccountId)
376 const json = await playlist.toActivityPubObject(req.query.page, null)
377 const audience = getAudience(playlist.OwnerAccount.Actor, playlist.privacy === VideoPlaylistPrivacy.PUBLIC)
378 const object = audiencify(json, audience)
380 return activityPubResponse(activityPubContextify(object), res)
383 function videoPlaylistElementController (req: express.Request, res: express.Response) {
384 const videoPlaylistElement = res.locals.videoPlaylistElementAP
386 if (redirectIfNotOwned(videoPlaylistElement.url, res)) return
388 const json = videoPlaylistElement.toActivityPubObject()
389 return activityPubResponse(activityPubContextify(json), res)
392 // ---------------------------------------------------------------------------
394 async function actorFollowing (req: express.Request, actor: MActorId) {
395 const handler = (start: number, count: number) => {
396 return ActorFollowModel.listAcceptedFollowingUrlsForApi([ actor.id ], undefined, start, count)
399 return activityPubCollectionPagination(WEBSERVER.URL + req.path, handler, req.query.page)
402 async function actorFollowers (req: express.Request, actor: MActorId) {
403 const handler = (start: number, count: number) => {
404 return ActorFollowModel.listAcceptedFollowerUrlsForAP([ actor.id ], undefined, start, count)
407 return activityPubCollectionPagination(WEBSERVER.URL + req.path, handler, req.query.page)
410 async function actorPlaylists (req: express.Request, options: { account: MAccountId } | { channel: MChannelId }) {
411 const handler = (start: number, count: number) => {
412 return VideoPlaylistModel.listPublicUrlsOfForAP(options, start, count)
415 return activityPubCollectionPagination(WEBSERVER.URL + req.path, handler, req.query.page)
418 function videoRates (req: express.Request, rateType: VideoRateType, video: MVideoId, url: string) {
419 const handler = async (start: number, count: number) => {
420 const result = await AccountVideoRateModel.listAndCountAccountUrlsByVideoId(rateType, video.id, start, count)
423 data: result.rows.map(r => r.url)
426 return activityPubCollectionPagination(url, handler, req.query.page)
429 function redirectIfNotOwned (url: string, res: express.Response) {
430 if (url.startsWith(WEBSERVER.URL) === false) {