server/lib/activitypub/send/utils.ts

   1 import { Transaction } from 'sequelize'
   2 import { Activity, ActivityAudience } from '../../../../shared/models/activitypub'
   3 import { logger } from '../../../helpers/logger'
   4 import { ActorModel } from '../../../models/activitypub/actor'
   5 import { ActorFollowModel } from '../../../models/activitypub/actor-follow'
   6 import { JobQueue } from '../../job-queue'
   7 import { VideoModel } from '../../../models/video/video'
   8 import { getActorsInvolvedInVideo, getAudienceFromFollowersOf, getRemoteVideoAudience } from '../audience'
   9 import { getServerActor } from '../../../helpers/utils'
  10 import { afterCommitIfTransaction } from '../../../helpers/database-utils'
  11
  12 async function sendVideoRelatedActivity (activityBuilder: (audience: ActivityAudience) => Activity, options: {
  13   byActor: ActorModel,
  14   video: VideoModel,
  15   transaction?: Transaction
  16 }) {
  17   const actorsInvolvedInVideo = await getActorsInvolvedInVideo(options.video, options.transaction)
  18
  19   // Send to origin
  20   if (options.video.isOwned() === false) {
  21     const audience = getRemoteVideoAudience(options.video, actorsInvolvedInVideo)
  22     const activity = activityBuilder(audience)
  23
  24     return afterCommitIfTransaction(options.transaction, () => {
  25       return unicastTo(activity, options.byActor, options.video.VideoChannel.Account.Actor.sharedInboxUrl)
  26     })
  27   }
  28
  29   // Send to followers
  30   const audience = getAudienceFromFollowersOf(actorsInvolvedInVideo)
  31   const activity = activityBuilder(audience)
  32
  33   const actorsException = [ options.byActor ]
  34
  35   return broadcastToFollowers(activity, options.byActor, actorsInvolvedInVideo, options.transaction, actorsException)
  36 }
  37
  38 async function forwardVideoRelatedActivity (
  39   activity: Activity,
  40   t: Transaction,
  41   followersException: ActorModel[] = [],
  42   video: VideoModel
  43 ) {
  44   // Mastodon does not add our announces in audience, so we forward to them manually
  45   const additionalActors = await getActorsInvolvedInVideo(video, t)
  46   const additionalFollowerUrls = additionalActors.map(a => a.followersUrl)
  47
  48   return forwardActivity(activity, t, followersException, additionalFollowerUrls)
  49 }
  50
  51 async function forwardActivity (
  52   activity: Activity,
  53   t: Transaction,
  54   followersException: ActorModel[] = [],
  55   additionalFollowerUrls: string[] = []
  56 ) {
  57   logger.info('Forwarding activity %s.', activity.id)
  58
  59   const to = activity.to || []
  60   const cc = activity.cc || []
  61
  62   const followersUrls = additionalFollowerUrls
  63   for (const dest of to.concat(cc)) {
  64     if (dest.endsWith('/followers')) {
  65       followersUrls.push(dest)
  66     }
  67   }
  68
  69   const toActorFollowers = await ActorModel.listByFollowersUrls(followersUrls, t)
  70   const uris = await computeFollowerUris(toActorFollowers, followersException, t)
  71
  72   if (uris.length === 0) {
  73     logger.info('0 followers for %s, no forwarding.', toActorFollowers.map(a => a.id).join(', '))
  74     return undefined
  75   }
  76
  77   logger.debug('Creating forwarding job.', { uris })
  78
  79   const payload = {
  80     uris,
  81     body: activity
  82   }
  83   return afterCommitIfTransaction(t, () => JobQueue.Instance.createJob({ type: 'activitypub-http-broadcast', payload }))
  84 }
  85
  86 async function broadcastToFollowers (
  87   data: any,
  88   byActor: ActorModel,
  89   toFollowersOf: ActorModel[],
  90   t: Transaction,
  91   actorsException: ActorModel[] = []
  92 ) {
  93   const uris = await computeFollowerUris(toFollowersOf, actorsException, t)
  94
  95   return afterCommitIfTransaction(t, () => broadcastTo(uris, data, byActor))
  96 }
  97
  98 async function broadcastToActors (
  99   data: any,
 100   byActor: ActorModel,
 101   toActors: ActorModel[],
 102   t?: Transaction,
 103   actorsException: ActorModel[] = []
 104 ) {
 105   const uris = await computeUris(toActors, actorsException)
 106   return afterCommitIfTransaction(t, () => broadcastTo(uris, data, byActor))
 107 }
 108
 109 function broadcastTo (uris: string[], data: any, byActor: ActorModel) {
 110   if (uris.length === 0) return undefined
 111
 112   logger.debug('Creating broadcast job.', { uris })
 113
 114   const payload = {
 115     uris,
 116     signatureActorId: byActor.id,
 117     body: data
 118   }
 119
 120   return JobQueue.Instance.createJob({ type: 'activitypub-http-broadcast', payload })
 121 }
 122
 123 function unicastTo (data: any, byActor: ActorModel, toActorUrl: string) {
 124   logger.debug('Creating unicast job.', { uri: toActorUrl })
 125
 126   const payload = {
 127     uri: toActorUrl,
 128     signatureActorId: byActor.id,
 129     body: data
 130   }
 131
 132   JobQueue.Instance.createJob({ type: 'activitypub-http-unicast', payload })
 133 }
 134
 135 // ---------------------------------------------------------------------------
 136
 137 export {
 138   broadcastToFollowers,
 139   unicastTo,
 140   forwardActivity,
 141   broadcastToActors,
 142   forwardVideoRelatedActivity,
 143   sendVideoRelatedActivity
 144 }
 145
 146 // ---------------------------------------------------------------------------
 147
 148 async function computeFollowerUris (toFollowersOf: ActorModel[], actorsException: ActorModel[], t: Transaction) {
 149   const toActorFollowerIds = toFollowersOf.map(a => a.id)
 150
 151   const result = await ActorFollowModel.listAcceptedFollowerSharedInboxUrls(toActorFollowerIds, t)
 152   const sharedInboxesException = await buildSharedInboxesException(actorsException)
 153
 154   return result.data.filter(sharedInbox => sharedInboxesException.indexOf(sharedInbox) === -1)
 155 }
 156
 157 async function computeUris (toActors: ActorModel[], actorsException: ActorModel[] = []) {
 158   const serverActor = await getServerActor()
 159   const targetUrls = toActors
 160     .filter(a => a.id !== serverActor.id) // Don't send to ourselves
 161     .map(a => a.sharedInboxUrl || a.inboxUrl)
 162
 163   const toActorSharedInboxesSet = new Set(targetUrls)
 164
 165   const sharedInboxesException = await buildSharedInboxesException(actorsException)
 166   return Array.from(toActorSharedInboxesSet)
 167               .filter(sharedInbox => sharedInboxesException.indexOf(sharedInbox) === -1)
 168 }
 169
 170 async function buildSharedInboxesException (actorsException: ActorModel[]) {
 171   const serverActor = await getServerActor()
 172
 173   return actorsException
 174     .map(f => f.sharedInboxUrl || f.inboxUrl)
 175     .concat([ serverActor.sharedInboxUrl ])
 176 }