server/controllers/api/server/follows.ts

   1 import * as express from 'express'
   2 import { UserRight } from '../../../../shared/models/users'
   3 import { sanitizeHost } from '../../../helpers/core-utils'
   4 import { retryTransactionWrapper } from '../../../helpers/database-utils'
   5 import { logger } from '../../../helpers/logger'
   6 import { getFormattedObjects, getServerActor } from '../../../helpers/utils'
   7 import { loadActorUrlOrGetFromWebfinger } from '../../../helpers/webfinger'
   8 import { REMOTE_SCHEME, sequelizeTypescript, SERVER_ACTOR_NAME } from '../../../initializers'
   9 import { getOrCreateActorAndServerAndModel } from '../../../lib/activitypub/actor'
  10 import { sendFollow, sendUndoFollow } from '../../../lib/activitypub/send'
  11 import {
  12   asyncMiddleware, authenticate, ensureUserHasRight, paginationValidator, removeFollowingValidator, setBodyHostsPort, setDefaultSort,
  13   setDefaultPagination
  14 } from '../../../middlewares'
  15 import { followersSortValidator, followingSortValidator, followValidator } from '../../../middlewares/validators'
  16 import { ActorModel } from '../../../models/activitypub/actor'
  17 import { ActorFollowModel } from '../../../models/activitypub/actor-follow'
  18
  19 const serverFollowsRouter = express.Router()
  20 serverFollowsRouter.get('/following',
  21   paginationValidator,
  22   followingSortValidator,
  23   setDefaultSort,
  24   setDefaultPagination,
  25   asyncMiddleware(listFollowing)
  26 )
  27
  28 serverFollowsRouter.post('/following',
  29   authenticate,
  30   ensureUserHasRight(UserRight.MANAGE_SERVER_FOLLOW),
  31   followValidator,
  32   setBodyHostsPort,
  33   asyncMiddleware(followRetry)
  34 )
  35
  36 serverFollowsRouter.delete('/following/:host',
  37   authenticate,
  38   ensureUserHasRight(UserRight.MANAGE_SERVER_FOLLOW),
  39   asyncMiddleware(removeFollowingValidator),
  40   asyncMiddleware(removeFollow)
  41 )
  42
  43 serverFollowsRouter.get('/followers',
  44   paginationValidator,
  45   followersSortValidator,
  46   setDefaultSort,
  47   setDefaultPagination,
  48   asyncMiddleware(listFollowers)
  49 )
  50
  51 // ---------------------------------------------------------------------------
  52
  53 export {
  54   serverFollowsRouter
  55 }
  56
  57 // ---------------------------------------------------------------------------
  58
  59 async function listFollowing (req: express.Request, res: express.Response, next: express.NextFunction) {
  60   const serverActor = await getServerActor()
  61   const resultList = await ActorFollowModel.listFollowingForApi(serverActor.id, req.query.start, req.query.count, req.query.sort)
  62
  63   return res.json(getFormattedObjects(resultList.data, resultList.total))
  64 }
  65
  66 async function listFollowers (req: express.Request, res: express.Response, next: express.NextFunction) {
  67   const serverActor = await getServerActor()
  68   const resultList = await ActorFollowModel.listFollowersForApi(serverActor.id, req.query.start, req.query.count, req.query.sort)
  69
  70   return res.json(getFormattedObjects(resultList.data, resultList.total))
  71 }
  72
  73 async function followRetry (req: express.Request, res: express.Response, next: express.NextFunction) {
  74   const hosts = req.body.hosts as string[]
  75   const fromActor = await getServerActor()
  76
  77   const tasks: Promise<any>[] = []
  78   const actorName = SERVER_ACTOR_NAME
  79
  80   for (const host of hosts) {
  81     const sanitizedHost = sanitizeHost(host, REMOTE_SCHEME.HTTP)
  82
  83     // We process each host in a specific transaction
  84     // First, we add the follow request in the database
  85     // Then we send the follow request to other actor
  86     const p = loadActorUrlOrGetFromWebfinger(actorName, sanitizedHost)
  87       .then(actorUrl => getOrCreateActorAndServerAndModel(actorUrl))
  88       .then(targetActor => {
  89         const options = {
  90           arguments: [ fromActor, targetActor ],
  91           errorMessage: 'Cannot follow with many retries.'
  92         }
  93
  94         return retryTransactionWrapper(follow, options)
  95       })
  96       .catch(err => logger.warn('Cannot follow server %s.', sanitizedHost, { err }))
  97
  98     tasks.push(p)
  99   }
 100
 101   // Don't make the client wait the tasks
 102   Promise.all(tasks)
 103     .catch(err => logger.error('Error in follow.', { err }))
 104
 105   return res.status(204).end()
 106 }
 107
 108 function follow (fromActor: ActorModel, targetActor: ActorModel) {
 109   if (fromActor.id === targetActor.id) {
 110     throw new Error('Follower is the same than target actor.')
 111   }
 112
 113   return sequelizeTypescript.transaction(async t => {
 114     const [ actorFollow ] = await ActorFollowModel.findOrCreate({
 115       where: {
 116         actorId: fromActor.id,
 117         targetActorId: targetActor.id
 118       },
 119       defaults: {
 120         state: 'pending',
 121         actorId: fromActor.id,
 122         targetActorId: targetActor.id
 123       },
 124       transaction: t
 125     })
 126     actorFollow.ActorFollowing = targetActor
 127     actorFollow.ActorFollower = fromActor
 128
 129     // Send a notification to remote server
 130     await sendFollow(actorFollow)
 131   })
 132 }
 133
 134 async function removeFollow (req: express.Request, res: express.Response, next: express.NextFunction) {
 135   const follow: ActorFollowModel = res.locals.follow
 136
 137   await sequelizeTypescript.transaction(async t => {
 138     if (follow.state === 'accepted') await sendUndoFollow(follow, t)
 139
 140     await follow.destroy({ transaction: t })
 141   })
 142
 143   // Destroy the actor that will destroy video channels, videos and video files too
 144   // This could be long so don't wait this task
 145   const following = follow.ActorFollowing
 146   following.destroy()
 147     .catch(err => logger.error('Cannot destroy actor that we do not follow anymore %s.', following.url, { err }))
 148
 149   return res.status(204).end()
 150 }