server/controllers/activitypub/client.ts

   1 // Intercept ActivityPub client requests
   2 import * as express from 'express'
   3 import { VideoPrivacy, VideoRateType } from '../../../shared/models/videos'
   4 import { activityPubCollectionPagination, activityPubContextify } from '../../helpers/activitypub'
   5 import { CONFIG, ROUTE_CACHE_LIFETIME } from '../../initializers'
   6 import { buildAnnounceWithVideoAudience, buildDislikeActivity, buildLikeActivity } from '../../lib/activitypub/send'
   7 import { audiencify, getAudience } from '../../lib/activitypub/audience'
   8 import { buildCreateActivity } from '../../lib/activitypub/send/send-create'
   9 import {
  10   asyncMiddleware,
  11   videosShareValidator,
  12   executeIfActivityPub,
  13   localAccountValidator,
  14   localVideoChannelValidator,
  15   videosCustomGetValidator
  16 } from '../../middlewares'
  17 import {
  18   getAccountVideoRateValidator,
  19   videoCommentGetValidator,
  20   videosGetValidator
  21 } from '../../middlewares/validators'
  22 import { AccountModel } from '../../models/account/account'
  23 import { ActorModel } from '../../models/activitypub/actor'
  24 import { ActorFollowModel } from '../../models/activitypub/actor-follow'
  25 import { VideoModel } from '../../models/video/video'
  26 import { VideoChannelModel } from '../../models/video/video-channel'
  27 import { VideoCommentModel } from '../../models/video/video-comment'
  28 import { VideoShareModel } from '../../models/video/video-share'
  29 import { cacheRoute } from '../../middlewares/cache'
  30 import { activityPubResponse } from './utils'
  31 import { AccountVideoRateModel } from '../../models/account/account-video-rate'
  32 import {
  33   getRateUrl,
  34   getVideoCommentsActivityPubUrl,
  35   getVideoDislikesActivityPubUrl,
  36   getVideoLikesActivityPubUrl,
  37   getVideoSharesActivityPubUrl
  38 } from '../../lib/activitypub'
  39 import { VideoCaptionModel } from '../../models/video/video-caption'
  40 import { videoRedundancyGetValidator } from '../../middlewares/validators/redundancy'
  41 import { getServerActor } from '../../helpers/utils'
  42
  43 const activityPubClientRouter = express.Router()
  44
  45 activityPubClientRouter.get('/accounts?/:name',
  46   executeIfActivityPub(asyncMiddleware(localAccountValidator)),
  47   executeIfActivityPub(accountController)
  48 )
  49 activityPubClientRouter.get('/accounts?/:name/followers',
  50   executeIfActivityPub(asyncMiddleware(localAccountValidator)),
  51   executeIfActivityPub(asyncMiddleware(accountFollowersController))
  52 )
  53 activityPubClientRouter.get('/accounts?/:name/following',
  54   executeIfActivityPub(asyncMiddleware(localAccountValidator)),
  55   executeIfActivityPub(asyncMiddleware(accountFollowingController))
  56 )
  57 activityPubClientRouter.get('/accounts?/:name/likes/:videoId',
  58   executeIfActivityPub(asyncMiddleware(getAccountVideoRateValidator('like'))),
  59   executeIfActivityPub(getAccountVideoRate('like'))
  60 )
  61 activityPubClientRouter.get('/accounts?/:name/dislikes/:videoId',
  62   executeIfActivityPub(asyncMiddleware(getAccountVideoRateValidator('dislike'))),
  63   executeIfActivityPub(getAccountVideoRate('dislike'))
  64 )
  65
  66 activityPubClientRouter.get('/videos/watch/:id',
  67   executeIfActivityPub(asyncMiddleware(cacheRoute(ROUTE_CACHE_LIFETIME.ACTIVITY_PUB.VIDEOS))),
  68   executeIfActivityPub(asyncMiddleware(videosGetValidator)),
  69   executeIfActivityPub(asyncMiddleware(videoController))
  70 )
  71 activityPubClientRouter.get('/videos/watch/:id/activity',
  72   executeIfActivityPub(asyncMiddleware(videosGetValidator)),
  73   executeIfActivityPub(asyncMiddleware(videoController))
  74 )
  75 activityPubClientRouter.get('/videos/watch/:id/announces',
  76   executeIfActivityPub(asyncMiddleware(videosCustomGetValidator('only-video'))),
  77   executeIfActivityPub(asyncMiddleware(videoAnnouncesController))
  78 )
  79 activityPubClientRouter.get('/videos/watch/:id/announces/:actorId',
  80   executeIfActivityPub(asyncMiddleware(videosShareValidator)),
  81   executeIfActivityPub(asyncMiddleware(videoAnnounceController))
  82 )
  83 activityPubClientRouter.get('/videos/watch/:id/likes',
  84   executeIfActivityPub(asyncMiddleware(videosCustomGetValidator('only-video'))),
  85   executeIfActivityPub(asyncMiddleware(videoLikesController))
  86 )
  87 activityPubClientRouter.get('/videos/watch/:id/dislikes',
  88   executeIfActivityPub(asyncMiddleware(videosCustomGetValidator('only-video'))),
  89   executeIfActivityPub(asyncMiddleware(videoDislikesController))
  90 )
  91 activityPubClientRouter.get('/videos/watch/:id/comments',
  92   executeIfActivityPub(asyncMiddleware(videosCustomGetValidator('only-video'))),
  93   executeIfActivityPub(asyncMiddleware(videoCommentsController))
  94 )
  95 activityPubClientRouter.get('/videos/watch/:videoId/comments/:commentId',
  96   executeIfActivityPub(asyncMiddleware(videoCommentGetValidator)),
  97   executeIfActivityPub(asyncMiddleware(videoCommentController))
  98 )
  99 activityPubClientRouter.get('/videos/watch/:videoId/comments/:commentId/activity',
 100   executeIfActivityPub(asyncMiddleware(videoCommentGetValidator)),
 101   executeIfActivityPub(asyncMiddleware(videoCommentController))
 102 )
 103
 104 activityPubClientRouter.get('/video-channels/:name',
 105   executeIfActivityPub(asyncMiddleware(localVideoChannelValidator)),
 106   executeIfActivityPub(asyncMiddleware(videoChannelController))
 107 )
 108 activityPubClientRouter.get('/video-channels/:name/followers',
 109   executeIfActivityPub(asyncMiddleware(localVideoChannelValidator)),
 110   executeIfActivityPub(asyncMiddleware(videoChannelFollowersController))
 111 )
 112 activityPubClientRouter.get('/video-channels/:name/following',
 113   executeIfActivityPub(asyncMiddleware(localVideoChannelValidator)),
 114   executeIfActivityPub(asyncMiddleware(videoChannelFollowingController))
 115 )
 116
 117 activityPubClientRouter.get('/redundancy/videos/:videoId/:resolution([0-9]+)(-:fps([0-9]+))?',
 118   executeIfActivityPub(asyncMiddleware(videoRedundancyGetValidator)),
 119   executeIfActivityPub(asyncMiddleware(videoRedundancyController))
 120 )
 121
 122 // ---------------------------------------------------------------------------
 123
 124 export {
 125   activityPubClientRouter
 126 }
 127
 128 // ---------------------------------------------------------------------------
 129
 130 function accountController (req: express.Request, res: express.Response, next: express.NextFunction) {
 131   const account: AccountModel = res.locals.account
 132
 133   return activityPubResponse(activityPubContextify(account.toActivityPubObject()), res)
 134 }
 135
 136 async function accountFollowersController (req: express.Request, res: express.Response, next: express.NextFunction) {
 137   const account: AccountModel = res.locals.account
 138   const activityPubResult = await actorFollowers(req, account.Actor)
 139
 140   return activityPubResponse(activityPubContextify(activityPubResult), res)
 141 }
 142
 143 async function accountFollowingController (req: express.Request, res: express.Response, next: express.NextFunction) {
 144   const account: AccountModel = res.locals.account
 145   const activityPubResult = await actorFollowing(req, account.Actor)
 146
 147   return activityPubResponse(activityPubContextify(activityPubResult), res)
 148 }
 149
 150 function getAccountVideoRate (rateType: VideoRateType) {
 151   return (req: express.Request, res: express.Response) => {
 152     const accountVideoRate: AccountVideoRateModel = res.locals.accountVideoRate
 153
 154     const byActor = accountVideoRate.Account.Actor
 155     const url = getRateUrl(rateType, byActor, accountVideoRate.Video)
 156     const APObject = rateType === 'like'
 157       ? buildLikeActivity(url, byActor, accountVideoRate.Video)
 158       : buildCreateActivity(url, byActor, buildDislikeActivity(url, byActor, accountVideoRate.Video))
 159
 160     return activityPubResponse(activityPubContextify(APObject), res)
 161   }
 162 }
 163
 164 async function videoController (req: express.Request, res: express.Response, next: express.NextFunction) {
 165   const video: VideoModel = res.locals.video
 166
 167   // We need captions to render AP object
 168   video.VideoCaptions = await VideoCaptionModel.listVideoCaptions(video.id)
 169
 170   const audience = getAudience(video.VideoChannel.Account.Actor, video.privacy === VideoPrivacy.PUBLIC)
 171   const videoObject = audiencify(video.toActivityPubObject(), audience)
 172
 173   if (req.path.endsWith('/activity')) {
 174     const data = buildCreateActivity(video.url, video.VideoChannel.Account.Actor, videoObject, audience)
 175     return activityPubResponse(activityPubContextify(data), res)
 176   }
 177
 178   return activityPubResponse(activityPubContextify(videoObject), res)
 179 }
 180
 181 async function videoAnnounceController (req: express.Request, res: express.Response, next: express.NextFunction) {
 182   const share = res.locals.videoShare as VideoShareModel
 183   const { activity } = await buildAnnounceWithVideoAudience(share.Actor, share, res.locals.video, undefined)
 184
 185   return activityPubResponse(activityPubContextify(activity), res)
 186 }
 187
 188 async function videoAnnouncesController (req: express.Request, res: express.Response, next: express.NextFunction) {
 189   const video: VideoModel = res.locals.video
 190
 191   const handler = async (start: number, count: number) => {
 192     const result = await VideoShareModel.listAndCountByVideoId(video.id, start, count)
 193     return {
 194       total: result.count,
 195       data: result.rows.map(r => r.url)
 196     }
 197   }
 198   const json = await activityPubCollectionPagination(getVideoSharesActivityPubUrl(video), handler, req.query.page)
 199
 200   return activityPubResponse(activityPubContextify(json), res)
 201 }
 202
 203 async function videoLikesController (req: express.Request, res: express.Response, next: express.NextFunction) {
 204   const video: VideoModel = res.locals.video
 205   const json = await videoRates(req, 'like', video, getVideoLikesActivityPubUrl(video))
 206
 207   return activityPubResponse(activityPubContextify(json), res)
 208 }
 209
 210 async function videoDislikesController (req: express.Request, res: express.Response, next: express.NextFunction) {
 211   const video: VideoModel = res.locals.video
 212   const json = await videoRates(req, 'dislike', video, getVideoDislikesActivityPubUrl(video))
 213
 214   return activityPubResponse(activityPubContextify(json), res)
 215 }
 216
 217 async function videoCommentsController (req: express.Request, res: express.Response, next: express.NextFunction) {
 218   const video: VideoModel = res.locals.video
 219
 220   const handler = async (start: number, count: number) => {
 221     const result = await VideoCommentModel.listAndCountByVideoId(video.id, start, count)
 222     return {
 223       total: result.count,
 224       data: result.rows.map(r => r.url)
 225     }
 226   }
 227   const json = await activityPubCollectionPagination(getVideoCommentsActivityPubUrl(video), handler, req.query.page)
 228
 229   return activityPubResponse(activityPubContextify(json), res)
 230 }
 231
 232 async function videoChannelController (req: express.Request, res: express.Response, next: express.NextFunction) {
 233   const videoChannel: VideoChannelModel = res.locals.videoChannel
 234
 235   return activityPubResponse(activityPubContextify(videoChannel.toActivityPubObject()), res)
 236 }
 237
 238 async function videoChannelFollowersController (req: express.Request, res: express.Response, next: express.NextFunction) {
 239   const videoChannel: VideoChannelModel = res.locals.videoChannel
 240   const activityPubResult = await actorFollowers(req, videoChannel.Actor)
 241
 242   return activityPubResponse(activityPubContextify(activityPubResult), res)
 243 }
 244
 245 async function videoChannelFollowingController (req: express.Request, res: express.Response, next: express.NextFunction) {
 246   const videoChannel: VideoChannelModel = res.locals.videoChannel
 247   const activityPubResult = await actorFollowing(req, videoChannel.Actor)
 248
 249   return activityPubResponse(activityPubContextify(activityPubResult), res)
 250 }
 251
 252 async function videoCommentController (req: express.Request, res: express.Response, next: express.NextFunction) {
 253   const videoComment: VideoCommentModel = res.locals.videoComment
 254
 255   const threadParentComments = await VideoCommentModel.listThreadParentComments(videoComment, undefined)
 256   const isPublic = true // Comments are always public
 257   const audience = getAudience(videoComment.Account.Actor, isPublic)
 258
 259   const videoCommentObject = audiencify(videoComment.toActivityPubObject(threadParentComments), audience)
 260
 261   if (req.path.endsWith('/activity')) {
 262     const data = buildCreateActivity(videoComment.url, videoComment.Account.Actor, videoCommentObject, audience)
 263     return activityPubResponse(activityPubContextify(data), res)
 264   }
 265
 266   return activityPubResponse(activityPubContextify(videoCommentObject), res)
 267 }
 268
 269 async function videoRedundancyController (req: express.Request, res: express.Response) {
 270   const videoRedundancy = res.locals.videoRedundancy
 271   const serverActor = await getServerActor()
 272
 273   const audience = getAudience(serverActor)
 274   const object = audiencify(videoRedundancy.toActivityPubObject(), audience)
 275
 276   if (req.path.endsWith('/activity')) {
 277     const data = buildCreateActivity(videoRedundancy.url, serverActor, object, audience)
 278     return activityPubResponse(activityPubContextify(data), res)
 279   }
 280
 281   return activityPubResponse(activityPubContextify(object), res)
 282 }
 283
 284 // ---------------------------------------------------------------------------
 285
 286 async function actorFollowing (req: express.Request, actor: ActorModel) {
 287   const handler = (start: number, count: number) => {
 288     return ActorFollowModel.listAcceptedFollowingUrlsForApi([ actor.id ], undefined, start, count)
 289   }
 290
 291   return activityPubCollectionPagination(CONFIG.WEBSERVER.URL + req.url, handler, req.query.page)
 292 }
 293
 294 async function actorFollowers (req: express.Request, actor: ActorModel) {
 295   const handler = (start: number, count: number) => {
 296     return ActorFollowModel.listAcceptedFollowerUrlsForApi([ actor.id ], undefined, start, count)
 297   }
 298
 299   return activityPubCollectionPagination(CONFIG.WEBSERVER.URL + req.url, handler, req.query.page)
 300 }
 301
 302 function videoRates (req: express.Request, rateType: VideoRateType, video: VideoModel, url: string) {
 303   const handler = async (start: number, count: number) => {
 304     const result = await AccountVideoRateModel.listAndCountAccountUrlsByVideoId(rateType, video.id, start, count)
 305     return {
 306       total: result.count,
 307       data: result.rows.map(r => r.url)
 308     }
 309   }
 310   return activityPubCollectionPagination(url, handler, req.query.page)
 311 }