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