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