]>
Commit | Line | Data |
---|---|---|
4d4e5cd4 | 1 | import * as express from 'express' |
490b595a | 2 | import * as RateLimit from 'express-rate-limit' |
d03cd8bb C |
3 | import { UserCreate, UserRight, UserRole, UserUpdate } from '../../../../shared' |
4 | import { logger } from '../../../helpers/logger' | |
5 | import { getFormattedObjects } from '../../../helpers/utils' | |
74dc3bca | 6 | import { RATES_LIMIT, WEBSERVER } from '../../../initializers/constants' |
d03cd8bb C |
7 | import { Emailer } from '../../../lib/emailer' |
8 | import { Redis } from '../../../lib/redis' | |
df0b219d | 9 | import { createUserAccountAndChannelAndPlaylist } from '../../../lib/user' |
65fcc311 | 10 | import { |
f076daa7 | 11 | asyncMiddleware, |
90d4bb81 | 12 | asyncRetryTransactionMiddleware, |
f076daa7 C |
13 | authenticate, |
14 | ensureUserHasRight, | |
15 | ensureUserRegistrationAllowed, | |
ff2c1fe8 | 16 | ensureUserRegistrationAllowedForIP, |
f076daa7 C |
17 | paginationValidator, |
18 | setDefaultPagination, | |
19 | setDefaultSort, | |
20 | token, | |
74d63469 | 21 | userAutocompleteValidator, |
f076daa7 C |
22 | usersAddValidator, |
23 | usersGetValidator, | |
24 | usersRegisterValidator, | |
25 | usersRemoveValidator, | |
26 | usersSortValidator, | |
d03cd8bb C |
27 | usersUpdateValidator |
28 | } from '../../../middlewares' | |
d9eaee39 | 29 | import { |
993cef4b C |
30 | usersAskResetPasswordValidator, |
31 | usersAskSendVerifyEmailValidator, | |
32 | usersBlockingValidator, | |
33 | usersResetPasswordValidator, | |
34 | usersVerifyEmailValidator | |
d9eaee39 | 35 | } from '../../../middlewares/validators' |
d03cd8bb | 36 | import { UserModel } from '../../../models/account/user' |
993cef4b | 37 | import { auditLoggerFactory, getAuditIdFromRes, UserAuditView } from '../../../helpers/audit-logger' |
d03cd8bb | 38 | import { meRouter } from './me' |
f201a749 | 39 | import { deleteUserToken } from '../../../lib/oauth-model' |
7ad9b984 | 40 | import { myBlocklistRouter } from './my-blocklist' |
f0a39880 | 41 | import { myVideoPlaylistsRouter } from './my-video-playlists' |
8b9a525a | 42 | import { myVideosHistoryRouter } from './my-history' |
cef534ed | 43 | import { myNotificationsRouter } from './my-notifications' |
f7cc67b4 | 44 | import { Notifier } from '../../../lib/notifier' |
cf405589 | 45 | import { mySubscriptionsRouter } from './my-subscriptions' |
6dd9de95 | 46 | import { CONFIG } from '../../../initializers/config' |
74dc3bca | 47 | import { sequelizeTypescript } from '../../../initializers/database' |
1eddc9a7 | 48 | import { UserAdminFlag } from '../../../../shared/models/users/user-flag.model' |
e590b4a5 | 49 | import { UserRegister } from '../../../../shared/models/users/user-register.model' |
80e36cd9 AB |
50 | |
51 | const auditLogger = auditLoggerFactory('users') | |
65fcc311 | 52 | |
490b595a C |
53 | const loginRateLimiter = new RateLimit({ |
54 | windowMs: RATES_LIMIT.LOGIN.WINDOW_MS, | |
374c1db9 | 55 | max: RATES_LIMIT.LOGIN.MAX |
490b595a | 56 | }) |
c5911fd3 | 57 | |
288fe385 C |
58 | const askSendEmailLimiter = new RateLimit({ |
59 | windowMs: RATES_LIMIT.ASK_SEND_EMAIL.WINDOW_MS, | |
374c1db9 | 60 | max: RATES_LIMIT.ASK_SEND_EMAIL.MAX |
288fe385 C |
61 | }) |
62 | ||
65fcc311 | 63 | const usersRouter = express.Router() |
cef534ed | 64 | usersRouter.use('/', myNotificationsRouter) |
cf405589 | 65 | usersRouter.use('/', mySubscriptionsRouter) |
7ad9b984 | 66 | usersRouter.use('/', myBlocklistRouter) |
8b9a525a | 67 | usersRouter.use('/', myVideosHistoryRouter) |
f0a39880 | 68 | usersRouter.use('/', myVideoPlaylistsRouter) |
06a05d5f | 69 | usersRouter.use('/', meRouter) |
9bd26629 | 70 | |
74d63469 GR |
71 | usersRouter.get('/autocomplete', |
72 | userAutocompleteValidator, | |
73 | asyncMiddleware(autocompleteUsers) | |
74 | ) | |
75 | ||
65fcc311 | 76 | usersRouter.get('/', |
86d13ec2 C |
77 | authenticate, |
78 | ensureUserHasRight(UserRight.MANAGE_USERS), | |
65fcc311 C |
79 | paginationValidator, |
80 | usersSortValidator, | |
1174a847 | 81 | setDefaultSort, |
f05a1c30 | 82 | setDefaultPagination, |
eb080476 | 83 | asyncMiddleware(listUsers) |
5c39adb7 C |
84 | ) |
85 | ||
e6921918 C |
86 | usersRouter.post('/:id/block', |
87 | authenticate, | |
88 | ensureUserHasRight(UserRight.MANAGE_USERS), | |
89 | asyncMiddleware(usersBlockingValidator), | |
90 | asyncMiddleware(blockUser) | |
91 | ) | |
92 | usersRouter.post('/:id/unblock', | |
93 | authenticate, | |
94 | ensureUserHasRight(UserRight.MANAGE_USERS), | |
95 | asyncMiddleware(usersBlockingValidator), | |
96 | asyncMiddleware(unblockUser) | |
97 | ) | |
98 | ||
8094a898 | 99 | usersRouter.get('/:id', |
94ff4c23 C |
100 | authenticate, |
101 | ensureUserHasRight(UserRight.MANAGE_USERS), | |
a2431b7d | 102 | asyncMiddleware(usersGetValidator), |
8094a898 C |
103 | getUser |
104 | ) | |
105 | ||
65fcc311 C |
106 | usersRouter.post('/', |
107 | authenticate, | |
954605a8 | 108 | ensureUserHasRight(UserRight.MANAGE_USERS), |
a2431b7d | 109 | asyncMiddleware(usersAddValidator), |
90d4bb81 | 110 | asyncRetryTransactionMiddleware(createUser) |
9bd26629 C |
111 | ) |
112 | ||
65fcc311 | 113 | usersRouter.post('/register', |
a2431b7d | 114 | asyncMiddleware(ensureUserRegistrationAllowed), |
ff2c1fe8 | 115 | ensureUserRegistrationAllowedForIP, |
a2431b7d | 116 | asyncMiddleware(usersRegisterValidator), |
90d4bb81 | 117 | asyncRetryTransactionMiddleware(registerUser) |
2c2e9092 C |
118 | ) |
119 | ||
65fcc311 C |
120 | usersRouter.put('/:id', |
121 | authenticate, | |
954605a8 | 122 | ensureUserHasRight(UserRight.MANAGE_USERS), |
a2431b7d | 123 | asyncMiddleware(usersUpdateValidator), |
eb080476 | 124 | asyncMiddleware(updateUser) |
9bd26629 C |
125 | ) |
126 | ||
65fcc311 C |
127 | usersRouter.delete('/:id', |
128 | authenticate, | |
954605a8 | 129 | ensureUserHasRight(UserRight.MANAGE_USERS), |
a2431b7d | 130 | asyncMiddleware(usersRemoveValidator), |
eb080476 | 131 | asyncMiddleware(removeUser) |
9bd26629 | 132 | ) |
6606150c | 133 | |
ecb4e35f C |
134 | usersRouter.post('/ask-reset-password', |
135 | asyncMiddleware(usersAskResetPasswordValidator), | |
136 | asyncMiddleware(askResetUserPassword) | |
137 | ) | |
138 | ||
139 | usersRouter.post('/:id/reset-password', | |
140 | asyncMiddleware(usersResetPasswordValidator), | |
141 | asyncMiddleware(resetUserPassword) | |
142 | ) | |
143 | ||
d9eaee39 | 144 | usersRouter.post('/ask-send-verify-email', |
288fe385 | 145 | askSendEmailLimiter, |
d9eaee39 JM |
146 | asyncMiddleware(usersAskSendVerifyEmailValidator), |
147 | asyncMiddleware(askSendVerifyUserEmail) | |
148 | ) | |
149 | ||
150 | usersRouter.post('/:id/verify-email', | |
151 | asyncMiddleware(usersVerifyEmailValidator), | |
152 | asyncMiddleware(verifyUserEmail) | |
153 | ) | |
154 | ||
490b595a C |
155 | usersRouter.post('/token', |
156 | loginRateLimiter, | |
157 | token, | |
158 | success | |
159 | ) | |
9bd26629 | 160 | // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route |
9457bf88 C |
161 | |
162 | // --------------------------------------------------------------------------- | |
163 | ||
65fcc311 C |
164 | export { |
165 | usersRouter | |
166 | } | |
9457bf88 C |
167 | |
168 | // --------------------------------------------------------------------------- | |
169 | ||
90d4bb81 | 170 | async function createUser (req: express.Request, res: express.Response) { |
4771e000 | 171 | const body: UserCreate = req.body |
f05a1c30 | 172 | const userToCreate = new UserModel({ |
4771e000 C |
173 | username: body.username, |
174 | password: body.password, | |
175 | email: body.email, | |
0883b324 | 176 | nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, |
7efe153b | 177 | autoPlayVideo: true, |
954605a8 | 178 | role: body.role, |
bee0abff | 179 | videoQuota: body.videoQuota, |
1eddc9a7 C |
180 | videoQuotaDaily: body.videoQuotaDaily, |
181 | adminFlags: body.adminFlags || UserAdminFlag.NONE | |
9bd26629 C |
182 | }) |
183 | ||
df0b219d | 184 | const { user, account } = await createUserAccountAndChannelAndPlaylist(userToCreate) |
eb080476 | 185 | |
993cef4b | 186 | auditLogger.create(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON())) |
38fa2065 | 187 | logger.info('User %s with its channel and account created.', body.username) |
f05a1c30 | 188 | |
90d4bb81 C |
189 | return res.json({ |
190 | user: { | |
191 | id: user.id, | |
192 | account: { | |
193 | id: account.id, | |
194 | uuid: account.Actor.uuid | |
195 | } | |
196 | } | |
197 | }).end() | |
47e0652b C |
198 | } |
199 | ||
90d4bb81 | 200 | async function registerUser (req: express.Request, res: express.Response) { |
e590b4a5 | 201 | const body: UserRegister = req.body |
77a5501f | 202 | |
80e36cd9 | 203 | const userToCreate = new UserModel({ |
77a5501f C |
204 | username: body.username, |
205 | password: body.password, | |
206 | email: body.email, | |
0883b324 | 207 | nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, |
7efe153b | 208 | autoPlayVideo: true, |
954605a8 | 209 | role: UserRole.USER, |
bee0abff | 210 | videoQuota: CONFIG.USER.VIDEO_QUOTA, |
d9eaee39 JM |
211 | videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY, |
212 | emailVerified: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION ? false : null | |
77a5501f C |
213 | }) |
214 | ||
e590b4a5 | 215 | const { user } = await createUserAccountAndChannelAndPlaylist(userToCreate, body.channel) |
47e0652b | 216 | |
80e36cd9 | 217 | auditLogger.create(body.username, new UserAuditView(user.toFormattedJSON())) |
47e0652b | 218 | logger.info('User %s with its channel and account registered.', body.username) |
90d4bb81 | 219 | |
d9eaee39 JM |
220 | if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) { |
221 | await sendVerifyUserEmail(user) | |
222 | } | |
223 | ||
f7cc67b4 C |
224 | Notifier.Instance.notifyOnNewUserRegistration(user) |
225 | ||
90d4bb81 | 226 | return res.type('json').status(204).end() |
77a5501f C |
227 | } |
228 | ||
dae86118 C |
229 | async function unblockUser (req: express.Request, res: express.Response) { |
230 | const user = res.locals.user | |
e6921918 C |
231 | |
232 | await changeUserBlock(res, user, false) | |
233 | ||
234 | return res.status(204).end() | |
235 | } | |
236 | ||
b426edd4 | 237 | async function blockUser (req: express.Request, res: express.Response) { |
dae86118 | 238 | const user = res.locals.user |
eacb25c4 | 239 | const reason = req.body.reason |
e6921918 | 240 | |
eacb25c4 | 241 | await changeUserBlock(res, user, true, reason) |
e6921918 C |
242 | |
243 | return res.status(204).end() | |
244 | } | |
245 | ||
b426edd4 | 246 | function getUser (req: express.Request, res: express.Response) { |
1eddc9a7 | 247 | return res.json(res.locals.user.toFormattedJSON({ withAdminFlags: true })) |
8094a898 C |
248 | } |
249 | ||
b426edd4 | 250 | async function autocompleteUsers (req: express.Request, res: express.Response) { |
5cf84858 | 251 | const resultList = await UserModel.autoComplete(req.query.search as string) |
74d63469 GR |
252 | |
253 | return res.json(resultList) | |
254 | } | |
255 | ||
b426edd4 | 256 | async function listUsers (req: express.Request, res: express.Response) { |
24b9417c | 257 | const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort, req.query.search) |
eb080476 | 258 | |
1eddc9a7 | 259 | return res.json(getFormattedObjects(resultList.data, resultList.total, { withAdminFlags: true })) |
9bd26629 C |
260 | } |
261 | ||
b426edd4 | 262 | async function removeUser (req: express.Request, res: express.Response) { |
dae86118 | 263 | const user = res.locals.user |
eb080476 C |
264 | |
265 | await user.destroy() | |
266 | ||
993cef4b | 267 | auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON())) |
80e36cd9 | 268 | |
eb080476 | 269 | return res.sendStatus(204) |
9bd26629 C |
270 | } |
271 | ||
b426edd4 | 272 | async function updateUser (req: express.Request, res: express.Response) { |
8094a898 | 273 | const body: UserUpdate = req.body |
dae86118 | 274 | const userToUpdate = res.locals.user |
80e36cd9 AB |
275 | const oldUserAuditView = new UserAuditView(userToUpdate.toFormattedJSON()) |
276 | const roleChanged = body.role !== undefined && body.role !== userToUpdate.role | |
8094a898 | 277 | |
b426edd4 | 278 | if (body.password !== undefined) userToUpdate.password = body.password |
80e36cd9 | 279 | if (body.email !== undefined) userToUpdate.email = body.email |
fc2ec87a | 280 | if (body.emailVerified !== undefined) userToUpdate.emailVerified = body.emailVerified |
80e36cd9 | 281 | if (body.videoQuota !== undefined) userToUpdate.videoQuota = body.videoQuota |
bee0abff | 282 | if (body.videoQuotaDaily !== undefined) userToUpdate.videoQuotaDaily = body.videoQuotaDaily |
80e36cd9 | 283 | if (body.role !== undefined) userToUpdate.role = body.role |
1eddc9a7 | 284 | if (body.adminFlags !== undefined) userToUpdate.adminFlags = body.adminFlags |
8094a898 | 285 | |
80e36cd9 | 286 | const user = await userToUpdate.save() |
eb080476 | 287 | |
f8b8c36b | 288 | // Destroy user token to refresh rights |
b426edd4 | 289 | if (roleChanged || body.password !== undefined) await deleteUserToken(userToUpdate.id) |
f8b8c36b | 290 | |
91411dba | 291 | auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView) |
80e36cd9 | 292 | |
b426edd4 | 293 | // Don't need to send this update to followers, these attributes are not federated |
265ba139 | 294 | |
eb080476 | 295 | return res.sendStatus(204) |
8094a898 C |
296 | } |
297 | ||
dae86118 C |
298 | async function askResetUserPassword (req: express.Request, res: express.Response) { |
299 | const user = res.locals.user | |
ecb4e35f C |
300 | |
301 | const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id) | |
6dd9de95 | 302 | const url = WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString |
b426edd4 | 303 | await Emailer.Instance.addPasswordResetEmailJob(user.email, url) |
ecb4e35f C |
304 | |
305 | return res.status(204).end() | |
306 | } | |
307 | ||
dae86118 C |
308 | async function resetUserPassword (req: express.Request, res: express.Response) { |
309 | const user = res.locals.user | |
ecb4e35f C |
310 | user.password = req.body.password |
311 | ||
312 | await user.save() | |
313 | ||
314 | return res.status(204).end() | |
315 | } | |
316 | ||
d9eaee39 JM |
317 | async function sendVerifyUserEmail (user: UserModel) { |
318 | const verificationString = await Redis.Instance.setVerifyEmailVerificationString(user.id) | |
6dd9de95 | 319 | const url = WEBSERVER.URL + '/verify-account/email?userId=' + user.id + '&verificationString=' + verificationString |
d9eaee39 JM |
320 | await Emailer.Instance.addVerifyEmailJob(user.email, url) |
321 | return | |
322 | } | |
323 | ||
dae86118 C |
324 | async function askSendVerifyUserEmail (req: express.Request, res: express.Response) { |
325 | const user = res.locals.user | |
d9eaee39 JM |
326 | |
327 | await sendVerifyUserEmail(user) | |
328 | ||
329 | return res.status(204).end() | |
330 | } | |
331 | ||
dae86118 C |
332 | async function verifyUserEmail (req: express.Request, res: express.Response) { |
333 | const user = res.locals.user | |
d9eaee39 JM |
334 | user.emailVerified = true |
335 | ||
336 | await user.save() | |
337 | ||
338 | return res.status(204).end() | |
339 | } | |
340 | ||
dae86118 | 341 | function success (req: express.Request, res: express.Response) { |
9457bf88 C |
342 | res.end() |
343 | } | |
e6921918 | 344 | |
eacb25c4 | 345 | async function changeUserBlock (res: express.Response, user: UserModel, block: boolean, reason?: string) { |
e6921918 C |
346 | const oldUserAuditView = new UserAuditView(user.toFormattedJSON()) |
347 | ||
348 | user.blocked = block | |
eacb25c4 | 349 | user.blockedReason = reason || null |
e6921918 C |
350 | |
351 | await sequelizeTypescript.transaction(async t => { | |
f201a749 | 352 | await deleteUserToken(user.id, t) |
e6921918 C |
353 | |
354 | await user.save({ transaction: t }) | |
355 | }) | |
356 | ||
eacb25c4 C |
357 | await Emailer.Instance.addUserBlockJob(user, block, reason) |
358 | ||
91411dba | 359 | auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView) |
e6921918 | 360 | } |