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, usersBlockingValidator, usersResetPasswordValidator,
31 usersAskSendVerifyEmailValidator, usersVerifyEmailValidator
32 } from '../../../middlewares/validators'
33 import { UserModel } from '../../../models/account/user'
34 import { OAuthTokenModel } from '../../../models/oauth/oauth-token'
35 import { auditLoggerFactory, UserAuditView } from '../../../helpers/audit-logger'
36 import { meRouter } from './me'
38 const auditLogger = auditLoggerFactory('users')
40 const loginRateLimiter = new RateLimit({
41 windowMs: RATES_LIMIT.LOGIN.WINDOW_MS,
42 max: RATES_LIMIT.LOGIN.MAX,
46 const askSendEmailLimiter = new RateLimit({
47 windowMs: RATES_LIMIT.ASK_SEND_EMAIL.WINDOW_MS,
48 max: RATES_LIMIT.ASK_SEND_EMAIL.MAX,
52 const usersRouter = express.Router()
53 usersRouter.use('/', meRouter)
55 usersRouter.get('/autocomplete',
56 userAutocompleteValidator,
57 asyncMiddleware(autocompleteUsers)
62 ensureUserHasRight(UserRight.MANAGE_USERS),
67 asyncMiddleware(listUsers)
70 usersRouter.post('/:id/block',
72 ensureUserHasRight(UserRight.MANAGE_USERS),
73 asyncMiddleware(usersBlockingValidator),
74 asyncMiddleware(blockUser)
76 usersRouter.post('/:id/unblock',
78 ensureUserHasRight(UserRight.MANAGE_USERS),
79 asyncMiddleware(usersBlockingValidator),
80 asyncMiddleware(unblockUser)
83 usersRouter.get('/:id',
85 ensureUserHasRight(UserRight.MANAGE_USERS),
86 asyncMiddleware(usersGetValidator),
92 ensureUserHasRight(UserRight.MANAGE_USERS),
93 asyncMiddleware(usersAddValidator),
94 asyncRetryTransactionMiddleware(createUser)
97 usersRouter.post('/register',
98 asyncMiddleware(ensureUserRegistrationAllowed),
99 ensureUserRegistrationAllowedForIP,
100 asyncMiddleware(usersRegisterValidator),
101 asyncRetryTransactionMiddleware(registerUser)
104 usersRouter.put('/:id',
106 ensureUserHasRight(UserRight.MANAGE_USERS),
107 asyncMiddleware(usersUpdateValidator),
108 asyncMiddleware(updateUser)
111 usersRouter.delete('/:id',
113 ensureUserHasRight(UserRight.MANAGE_USERS),
114 asyncMiddleware(usersRemoveValidator),
115 asyncMiddleware(removeUser)
118 usersRouter.post('/ask-reset-password',
119 asyncMiddleware(usersAskResetPasswordValidator),
120 asyncMiddleware(askResetUserPassword)
123 usersRouter.post('/:id/reset-password',
124 asyncMiddleware(usersResetPasswordValidator),
125 asyncMiddleware(resetUserPassword)
128 usersRouter.post('/ask-send-verify-email',
130 asyncMiddleware(usersAskSendVerifyEmailValidator),
131 asyncMiddleware(askSendVerifyUserEmail)
134 usersRouter.post('/:id/verify-email',
135 asyncMiddleware(usersVerifyEmailValidator),
136 asyncMiddleware(verifyUserEmail)
139 usersRouter.post('/token',
144 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
146 // ---------------------------------------------------------------------------
152 // ---------------------------------------------------------------------------
154 async function createUser (req: express.Request, res: express.Response) {
155 const body: UserCreate = req.body
156 const userToCreate = new UserModel({
157 username: body.username,
158 password: body.password,
160 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
163 videoQuota: body.videoQuota,
164 videoQuotaDaily: body.videoQuotaDaily
167 const { user, account } = await createUserAccountAndChannel(userToCreate)
169 auditLogger.create(res.locals.oauth.token.User.Account.Actor.getIdentifier(), new UserAuditView(user.toFormattedJSON()))
170 logger.info('User %s with its channel and account created.', body.username)
177 uuid: account.Actor.uuid
183 async function registerUser (req: express.Request, res: express.Response) {
184 const body: UserCreate = req.body
186 const userToCreate = new UserModel({
187 username: body.username,
188 password: body.password,
190 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
193 videoQuota: CONFIG.USER.VIDEO_QUOTA,
194 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY,
195 emailVerified: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION ? false : null
198 const { user } = await createUserAccountAndChannel(userToCreate)
200 auditLogger.create(body.username, new UserAuditView(user.toFormattedJSON()))
201 logger.info('User %s with its channel and account registered.', body.username)
203 if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
204 await sendVerifyUserEmail(user)
207 return res.type('json').status(204).end()
210 async function unblockUser (req: express.Request, res: express.Response, next: express.NextFunction) {
211 const user: UserModel = res.locals.user
213 await changeUserBlock(res, user, false)
215 return res.status(204).end()
218 async function blockUser (req: express.Request, res: express.Response, next: express.NextFunction) {
219 const user: UserModel = res.locals.user
220 const reason = req.body.reason
222 await changeUserBlock(res, user, true, reason)
224 return res.status(204).end()
227 function getUser (req: express.Request, res: express.Response, next: express.NextFunction) {
228 return res.json((res.locals.user as UserModel).toFormattedJSON())
231 async function autocompleteUsers (req: express.Request, res: express.Response, next: express.NextFunction) {
232 const resultList = await UserModel.autocomplete(req.query.search as string)
234 return res.json(resultList)
237 async function listUsers (req: express.Request, res: express.Response, next: express.NextFunction) {
238 const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort)
240 return res.json(getFormattedObjects(resultList.data, resultList.total))
243 async function removeUser (req: express.Request, res: express.Response, next: express.NextFunction) {
244 const user: UserModel = res.locals.user
248 auditLogger.delete(res.locals.oauth.token.User.Account.Actor.getIdentifier(), new UserAuditView(user.toFormattedJSON()))
250 return res.sendStatus(204)
253 async function updateUser (req: express.Request, res: express.Response, next: express.NextFunction) {
254 const body: UserUpdate = req.body
255 const userToUpdate = res.locals.user as UserModel
256 const oldUserAuditView = new UserAuditView(userToUpdate.toFormattedJSON())
257 const roleChanged = body.role !== undefined && body.role !== userToUpdate.role
259 if (body.email !== undefined) userToUpdate.email = body.email
260 if (body.videoQuota !== undefined) userToUpdate.videoQuota = body.videoQuota
261 if (body.videoQuotaDaily !== undefined) userToUpdate.videoQuotaDaily = body.videoQuotaDaily
262 if (body.role !== undefined) userToUpdate.role = body.role
264 const user = await userToUpdate.save()
266 // Destroy user token to refresh rights
268 await OAuthTokenModel.deleteUserToken(userToUpdate.id)
272 res.locals.oauth.token.User.Account.Actor.getIdentifier(),
273 new UserAuditView(user.toFormattedJSON()),
277 // Don't need to send this update to followers, these attributes are not propagated
279 return res.sendStatus(204)
282 async function askResetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
283 const user = res.locals.user as UserModel
285 const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
286 const url = CONFIG.WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
287 await Emailer.Instance.addForgetPasswordEmailJob(user.email, url)
289 return res.status(204).end()
292 async function resetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
293 const user = res.locals.user as UserModel
294 user.password = req.body.password
298 return res.status(204).end()
301 async function sendVerifyUserEmail (user: UserModel) {
302 const verificationString = await Redis.Instance.setVerifyEmailVerificationString(user.id)
303 const url = CONFIG.WEBSERVER.URL + '/verify-account/email?userId=' + user.id + '&verificationString=' + verificationString
304 await Emailer.Instance.addVerifyEmailJob(user.email, url)
308 async function askSendVerifyUserEmail (req: express.Request, res: express.Response, next: express.NextFunction) {
309 const user = res.locals.user as UserModel
311 await sendVerifyUserEmail(user)
313 return res.status(204).end()
316 async function verifyUserEmail (req: express.Request, res: express.Response, next: express.NextFunction) {
317 const user = res.locals.user as UserModel
318 user.emailVerified = true
322 return res.status(204).end()
325 function success (req: express.Request, res: express.Response, next: express.NextFunction) {
329 async function changeUserBlock (res: express.Response, user: UserModel, block: boolean, reason?: string) {
330 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
333 user.blockedReason = reason || null
335 await sequelizeTypescript.transaction(async t => {
336 await OAuthTokenModel.deleteUserToken(user.id, t)
338 await user.save({ transaction: t })
341 await Emailer.Instance.addUserBlockJob(user, block, reason)
344 res.locals.oauth.token.User.Account.Actor.getIdentifier(),
345 new UserAuditView(user.toFormattedJSON()),