Add ability to list redundancies
[oweals/peertube.git] / server / controllers / api / server / follows.ts
1 import * as express from 'express'
2 import { UserRight } from '../../../../shared/models/users'
3 import { logger } from '../../../helpers/logger'
4 import { getFormattedObjects, getServerActor } from '../../../helpers/utils'
5 import { SERVER_ACTOR_NAME } from '../../../initializers/constants'
6 import { sendAccept, sendReject, sendUndoFollow } from '../../../lib/activitypub/send'
7 import {
8   asyncMiddleware,
9   authenticate,
10   ensureUserHasRight,
11   paginationValidator,
12   setBodyHostsPort,
13   setDefaultPagination,
14   setDefaultSort
15 } from '../../../middlewares'
16 import {
17   acceptOrRejectFollowerValidator,
18   followersSortValidator,
19   followingSortValidator,
20   followValidator,
21   getFollowerValidator,
22   removeFollowingValidator,
23   listFollowsValidator
24 } from '../../../middlewares/validators'
25 import { ActorFollowModel } from '../../../models/activitypub/actor-follow'
26 import { JobQueue } from '../../../lib/job-queue'
27 import { removeRedundanciesOfServer } from '../../../lib/redundancy'
28 import { sequelizeTypescript } from '../../../initializers/database'
29 import { autoFollowBackIfNeeded } from '../../../lib/activitypub/follow'
30
31 const serverFollowsRouter = express.Router()
32 serverFollowsRouter.get('/following',
33   listFollowsValidator,
34   paginationValidator,
35   followingSortValidator,
36   setDefaultSort,
37   setDefaultPagination,
38   asyncMiddleware(listFollowing)
39 )
40
41 serverFollowsRouter.post('/following',
42   authenticate,
43   ensureUserHasRight(UserRight.MANAGE_SERVER_FOLLOW),
44   followValidator,
45   setBodyHostsPort,
46   asyncMiddleware(followInstance)
47 )
48
49 serverFollowsRouter.delete('/following/:host',
50   authenticate,
51   ensureUserHasRight(UserRight.MANAGE_SERVER_FOLLOW),
52   asyncMiddleware(removeFollowingValidator),
53   asyncMiddleware(removeFollowing)
54 )
55
56 serverFollowsRouter.get('/followers',
57   listFollowsValidator,
58   paginationValidator,
59   followersSortValidator,
60   setDefaultSort,
61   setDefaultPagination,
62   asyncMiddleware(listFollowers)
63 )
64
65 serverFollowsRouter.delete('/followers/:nameWithHost',
66   authenticate,
67   ensureUserHasRight(UserRight.MANAGE_SERVER_FOLLOW),
68   asyncMiddleware(getFollowerValidator),
69   asyncMiddleware(removeOrRejectFollower)
70 )
71
72 serverFollowsRouter.post('/followers/:nameWithHost/reject',
73   authenticate,
74   ensureUserHasRight(UserRight.MANAGE_SERVER_FOLLOW),
75   asyncMiddleware(getFollowerValidator),
76   acceptOrRejectFollowerValidator,
77   asyncMiddleware(removeOrRejectFollower)
78 )
79
80 serverFollowsRouter.post('/followers/:nameWithHost/accept',
81   authenticate,
82   ensureUserHasRight(UserRight.MANAGE_SERVER_FOLLOW),
83   asyncMiddleware(getFollowerValidator),
84   acceptOrRejectFollowerValidator,
85   asyncMiddleware(acceptFollower)
86 )
87
88 // ---------------------------------------------------------------------------
89
90 export {
91   serverFollowsRouter
92 }
93
94 // ---------------------------------------------------------------------------
95
96 async function listFollowing (req: express.Request, res: express.Response) {
97   const serverActor = await getServerActor()
98   const resultList = await ActorFollowModel.listFollowingForApi({
99     id: serverActor.id,
100     start: req.query.start,
101     count: req.query.count,
102     sort: req.query.sort,
103     search: req.query.search,
104     actorType: req.query.actorType,
105     state: req.query.state
106   })
107
108   return res.json(getFormattedObjects(resultList.data, resultList.total))
109 }
110
111 async function listFollowers (req: express.Request, res: express.Response) {
112   const serverActor = await getServerActor()
113   const resultList = await ActorFollowModel.listFollowersForApi({
114     actorId: serverActor.id,
115     start: req.query.start,
116     count: req.query.count,
117     sort: req.query.sort,
118     search: req.query.search,
119     actorType: req.query.actorType,
120     state: req.query.state
121   })
122
123   return res.json(getFormattedObjects(resultList.data, resultList.total))
124 }
125
126 async function followInstance (req: express.Request, res: express.Response) {
127   const hosts = req.body.hosts as string[]
128   const follower = await getServerActor()
129
130   for (const host of hosts) {
131     const payload = {
132       host,
133       name: SERVER_ACTOR_NAME,
134       followerActorId: follower.id
135     }
136
137     JobQueue.Instance.createJob({ type: 'activitypub-follow', payload })
138       .catch(err => logger.error('Cannot create follow job for %s.', host, err))
139   }
140
141   return res.status(204).end()
142 }
143
144 async function removeFollowing (req: express.Request, res: express.Response) {
145   const follow = res.locals.follow
146
147   await sequelizeTypescript.transaction(async t => {
148     if (follow.state === 'accepted') await sendUndoFollow(follow, t)
149
150     // Disable redundancy on unfollowed instances
151     const server = follow.ActorFollowing.Server
152     server.redundancyAllowed = false
153     await server.save({ transaction: t })
154
155     // Async, could be long
156     removeRedundanciesOfServer(server.id)
157       .catch(err => logger.error('Cannot remove redundancy of %s.', server.host, err))
158
159     await follow.destroy({ transaction: t })
160   })
161
162   return res.status(204).end()
163 }
164
165 async function removeOrRejectFollower (req: express.Request, res: express.Response) {
166   const follow = res.locals.follow
167
168   await sendReject(follow.ActorFollower, follow.ActorFollowing)
169
170   await follow.destroy()
171
172   return res.status(204).end()
173 }
174
175 async function acceptFollower (req: express.Request, res: express.Response) {
176   const follow = res.locals.follow
177
178   await sendAccept(follow)
179
180   follow.state = 'accepted'
181   await follow.save()
182
183   await autoFollowBackIfNeeded(follow)
184
185   return res.status(204).end()
186 }