1 import * as express from 'express'
2 import * as RateLimit from 'express-rate-limit'
3 import { UserCreate, UserRight, UserRole, UserUpdate } from '../../../../shared'
4 import { logger } from '../../../helpers/logger'
5 import { getFormattedObjects } from '../../../helpers/utils'
6 import { CONFIG, RATES_LIMIT, sequelizeTypescript } from '../../../initializers'
7 import { Emailer } from '../../../lib/emailer'
8 import { Redis } from '../../../lib/redis'
9 import { createUserAccountAndChannel } from '../../../lib/user'
12 asyncRetryTransactionMiddleware,
15 ensureUserRegistrationAllowed,
16 ensureUserRegistrationAllowedForIP,
21 userAutocompleteValidator,
24 usersRegisterValidator,
28 } from '../../../middlewares'
30 usersAskResetPasswordValidator,
31 usersAskSendVerifyEmailValidator,
32 usersBlockingValidator,
33 usersResetPasswordValidator,
34 usersVerifyEmailValidator
35 } from '../../../middlewares/validators'
36 import { UserModel } from '../../../models/account/user'
37 import { auditLoggerFactory, getAuditIdFromRes, UserAuditView } from '../../../helpers/audit-logger'
38 import { meRouter } from './me'
39 import { deleteUserToken } from '../../../lib/oauth-model'
40 import { myBlocklistRouter } from './my-blocklist'
41 import { myVideosHistoryRouter } from './my-history'
42 import { myNotificationsRouter } from './my-notifications'
44 const auditLogger = auditLoggerFactory('users')
46 const loginRateLimiter = new RateLimit({
47 windowMs: RATES_LIMIT.LOGIN.WINDOW_MS,
48 max: RATES_LIMIT.LOGIN.MAX,
52 const askSendEmailLimiter = new RateLimit({
53 windowMs: RATES_LIMIT.ASK_SEND_EMAIL.WINDOW_MS,
54 max: RATES_LIMIT.ASK_SEND_EMAIL.MAX,
58 const usersRouter = express.Router()
59 usersRouter.use('/', myNotificationsRouter)
60 usersRouter.use('/', myBlocklistRouter)
61 usersRouter.use('/', myVideosHistoryRouter)
62 usersRouter.use('/', meRouter)
64 usersRouter.get('/autocomplete',
65 userAutocompleteValidator,
66 asyncMiddleware(autocompleteUsers)
71 ensureUserHasRight(UserRight.MANAGE_USERS),
76 asyncMiddleware(listUsers)
79 usersRouter.post('/:id/block',
81 ensureUserHasRight(UserRight.MANAGE_USERS),
82 asyncMiddleware(usersBlockingValidator),
83 asyncMiddleware(blockUser)
85 usersRouter.post('/:id/unblock',
87 ensureUserHasRight(UserRight.MANAGE_USERS),
88 asyncMiddleware(usersBlockingValidator),
89 asyncMiddleware(unblockUser)
92 usersRouter.get('/:id',
94 ensureUserHasRight(UserRight.MANAGE_USERS),
95 asyncMiddleware(usersGetValidator),
101 ensureUserHasRight(UserRight.MANAGE_USERS),
102 asyncMiddleware(usersAddValidator),
103 asyncRetryTransactionMiddleware(createUser)
106 usersRouter.post('/register',
107 asyncMiddleware(ensureUserRegistrationAllowed),
108 ensureUserRegistrationAllowedForIP,
109 asyncMiddleware(usersRegisterValidator),
110 asyncRetryTransactionMiddleware(registerUser)
113 usersRouter.put('/:id',
115 ensureUserHasRight(UserRight.MANAGE_USERS),
116 asyncMiddleware(usersUpdateValidator),
117 asyncMiddleware(updateUser)
120 usersRouter.delete('/:id',
122 ensureUserHasRight(UserRight.MANAGE_USERS),
123 asyncMiddleware(usersRemoveValidator),
124 asyncMiddleware(removeUser)
127 usersRouter.post('/ask-reset-password',
128 asyncMiddleware(usersAskResetPasswordValidator),
129 asyncMiddleware(askResetUserPassword)
132 usersRouter.post('/:id/reset-password',
133 asyncMiddleware(usersResetPasswordValidator),
134 asyncMiddleware(resetUserPassword)
137 usersRouter.post('/ask-send-verify-email',
139 asyncMiddleware(usersAskSendVerifyEmailValidator),
140 asyncMiddleware(askSendVerifyUserEmail)
143 usersRouter.post('/:id/verify-email',
144 asyncMiddleware(usersVerifyEmailValidator),
145 asyncMiddleware(verifyUserEmail)
148 usersRouter.post('/token',
153 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
155 // ---------------------------------------------------------------------------
161 // ---------------------------------------------------------------------------
163 async function createUser (req: express.Request, res: express.Response) {
164 const body: UserCreate = req.body
165 const userToCreate = new UserModel({
166 username: body.username,
167 password: body.password,
169 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
172 videoQuota: body.videoQuota,
173 videoQuotaDaily: body.videoQuotaDaily
176 const { user, account } = await createUserAccountAndChannel(userToCreate)
178 auditLogger.create(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
179 logger.info('User %s with its channel and account created.', body.username)
186 uuid: account.Actor.uuid
192 async function registerUser (req: express.Request, res: express.Response) {
193 const body: UserCreate = req.body
195 const userToCreate = new UserModel({
196 username: body.username,
197 password: body.password,
199 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
202 videoQuota: CONFIG.USER.VIDEO_QUOTA,
203 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY,
204 emailVerified: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION ? false : null
207 const { user } = await createUserAccountAndChannel(userToCreate)
209 auditLogger.create(body.username, new UserAuditView(user.toFormattedJSON()))
210 logger.info('User %s with its channel and account registered.', body.username)
212 if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
213 await sendVerifyUserEmail(user)
216 return res.type('json').status(204).end()
219 async function unblockUser (req: express.Request, res: express.Response, next: express.NextFunction) {
220 const user: UserModel = res.locals.user
222 await changeUserBlock(res, user, false)
224 return res.status(204).end()
227 async function blockUser (req: express.Request, res: express.Response, next: express.NextFunction) {
228 const user: UserModel = res.locals.user
229 const reason = req.body.reason
231 await changeUserBlock(res, user, true, reason)
233 return res.status(204).end()
236 function getUser (req: express.Request, res: express.Response, next: express.NextFunction) {
237 return res.json((res.locals.user as UserModel).toFormattedJSON())
240 async function autocompleteUsers (req: express.Request, res: express.Response, next: express.NextFunction) {
241 const resultList = await UserModel.autoComplete(req.query.search as string)
243 return res.json(resultList)
246 async function listUsers (req: express.Request, res: express.Response, next: express.NextFunction) {
247 const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort, req.query.search)
249 return res.json(getFormattedObjects(resultList.data, resultList.total))
252 async function removeUser (req: express.Request, res: express.Response, next: express.NextFunction) {
253 const user: UserModel = res.locals.user
257 auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
259 return res.sendStatus(204)
262 async function updateUser (req: express.Request, res: express.Response, next: express.NextFunction) {
263 const body: UserUpdate = req.body
264 const userToUpdate = res.locals.user as UserModel
265 const oldUserAuditView = new UserAuditView(userToUpdate.toFormattedJSON())
266 const roleChanged = body.role !== undefined && body.role !== userToUpdate.role
268 if (body.email !== undefined) userToUpdate.email = body.email
269 if (body.emailVerified !== undefined) userToUpdate.emailVerified = body.emailVerified
270 if (body.videoQuota !== undefined) userToUpdate.videoQuota = body.videoQuota
271 if (body.videoQuotaDaily !== undefined) userToUpdate.videoQuotaDaily = body.videoQuotaDaily
272 if (body.role !== undefined) userToUpdate.role = body.role
274 const user = await userToUpdate.save()
276 // Destroy user token to refresh rights
277 if (roleChanged) await deleteUserToken(userToUpdate.id)
279 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)
281 // Don't need to send this update to followers, these attributes are not propagated
283 return res.sendStatus(204)
286 async function askResetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
287 const user = res.locals.user as UserModel
289 const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
290 const url = CONFIG.WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
291 await Emailer.Instance.addForgetPasswordEmailJob(user.email, url)
293 return res.status(204).end()
296 async function resetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
297 const user = res.locals.user as UserModel
298 user.password = req.body.password
302 return res.status(204).end()
305 async function sendVerifyUserEmail (user: UserModel) {
306 const verificationString = await Redis.Instance.setVerifyEmailVerificationString(user.id)
307 const url = CONFIG.WEBSERVER.URL + '/verify-account/email?userId=' + user.id + '&verificationString=' + verificationString
308 await Emailer.Instance.addVerifyEmailJob(user.email, url)
312 async function askSendVerifyUserEmail (req: express.Request, res: express.Response, next: express.NextFunction) {
313 const user = res.locals.user as UserModel
315 await sendVerifyUserEmail(user)
317 return res.status(204).end()
320 async function verifyUserEmail (req: express.Request, res: express.Response, next: express.NextFunction) {
321 const user = res.locals.user as UserModel
322 user.emailVerified = true
326 return res.status(204).end()
329 function success (req: express.Request, res: express.Response, next: express.NextFunction) {
333 async function changeUserBlock (res: express.Response, user: UserModel, block: boolean, reason?: string) {
334 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
337 user.blockedReason = reason || null
339 await sequelizeTypescript.transaction(async t => {
340 await deleteUserToken(user.id, t)
342 await user.save({ transaction: t })
345 await Emailer.Instance.addUserBlockJob(user, block, reason)
347 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)