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,
23 usersRegisterValidator,
27 } from '../../../middlewares'
28 import { usersAskResetPasswordValidator, usersBlockingValidator, usersResetPasswordValidator } from '../../../middlewares/validators'
29 import { UserModel } from '../../../models/account/user'
30 import { OAuthTokenModel } from '../../../models/oauth/oauth-token'
31 import { auditLoggerFactory, UserAuditView } from '../../../helpers/audit-logger'
32 import { meRouter } from './me'
34 const auditLogger = auditLoggerFactory('users')
36 const loginRateLimiter = new RateLimit({
37 windowMs: RATES_LIMIT.LOGIN.WINDOW_MS,
38 max: RATES_LIMIT.LOGIN.MAX,
42 const usersRouter = express.Router()
43 usersRouter.use('/', meRouter)
47 ensureUserHasRight(UserRight.MANAGE_USERS),
52 asyncMiddleware(listUsers)
55 usersRouter.post('/:id/block',
57 ensureUserHasRight(UserRight.MANAGE_USERS),
58 asyncMiddleware(usersBlockingValidator),
59 asyncMiddleware(blockUser)
61 usersRouter.post('/:id/unblock',
63 ensureUserHasRight(UserRight.MANAGE_USERS),
64 asyncMiddleware(usersBlockingValidator),
65 asyncMiddleware(unblockUser)
68 usersRouter.get('/:id',
70 ensureUserHasRight(UserRight.MANAGE_USERS),
71 asyncMiddleware(usersGetValidator),
77 ensureUserHasRight(UserRight.MANAGE_USERS),
78 asyncMiddleware(usersAddValidator),
79 asyncRetryTransactionMiddleware(createUser)
82 usersRouter.post('/register',
83 asyncMiddleware(ensureUserRegistrationAllowed),
84 ensureUserRegistrationAllowedForIP,
85 asyncMiddleware(usersRegisterValidator),
86 asyncRetryTransactionMiddleware(registerUser)
89 usersRouter.put('/:id',
91 ensureUserHasRight(UserRight.MANAGE_USERS),
92 asyncMiddleware(usersUpdateValidator),
93 asyncMiddleware(updateUser)
96 usersRouter.delete('/:id',
98 ensureUserHasRight(UserRight.MANAGE_USERS),
99 asyncMiddleware(usersRemoveValidator),
100 asyncMiddleware(removeUser)
103 usersRouter.post('/ask-reset-password',
104 asyncMiddleware(usersAskResetPasswordValidator),
105 asyncMiddleware(askResetUserPassword)
108 usersRouter.post('/:id/reset-password',
109 asyncMiddleware(usersResetPasswordValidator),
110 asyncMiddleware(resetUserPassword)
113 usersRouter.post('/token',
118 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
120 // ---------------------------------------------------------------------------
126 // ---------------------------------------------------------------------------
128 async function createUser (req: express.Request, res: express.Response) {
129 const body: UserCreate = req.body
130 const userToCreate = new UserModel({
131 username: body.username,
132 password: body.password,
134 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
137 videoQuota: body.videoQuota
140 const { user, account } = await createUserAccountAndChannel(userToCreate)
142 auditLogger.create(res.locals.oauth.token.User.Account.Actor.getIdentifier(), new UserAuditView(user.toFormattedJSON()))
143 logger.info('User %s with its channel and account created.', body.username)
150 uuid: account.Actor.uuid
156 async function registerUser (req: express.Request, res: express.Response) {
157 const body: UserCreate = req.body
159 const userToCreate = new UserModel({
160 username: body.username,
161 password: body.password,
163 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
166 videoQuota: CONFIG.USER.VIDEO_QUOTA
169 const { user } = await createUserAccountAndChannel(userToCreate)
171 auditLogger.create(body.username, new UserAuditView(user.toFormattedJSON()))
172 logger.info('User %s with its channel and account registered.', body.username)
174 return res.type('json').status(204).end()
177 async function unblockUser (req: express.Request, res: express.Response, next: express.NextFunction) {
178 const user: UserModel = res.locals.user
180 await changeUserBlock(res, user, false)
182 return res.status(204).end()
185 async function blockUser (req: express.Request, res: express.Response, next: express.NextFunction) {
186 const user: UserModel = res.locals.user
187 const reason = req.body.reason
189 await changeUserBlock(res, user, true, reason)
191 return res.status(204).end()
194 function getUser (req: express.Request, res: express.Response, next: express.NextFunction) {
195 return res.json((res.locals.user as UserModel).toFormattedJSON())
198 async function listUsers (req: express.Request, res: express.Response, next: express.NextFunction) {
199 const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort)
201 return res.json(getFormattedObjects(resultList.data, resultList.total))
204 async function removeUser (req: express.Request, res: express.Response, next: express.NextFunction) {
205 const user: UserModel = res.locals.user
209 auditLogger.delete(res.locals.oauth.token.User.Account.Actor.getIdentifier(), new UserAuditView(user.toFormattedJSON()))
211 return res.sendStatus(204)
214 async function updateUser (req: express.Request, res: express.Response, next: express.NextFunction) {
215 const body: UserUpdate = req.body
216 const userToUpdate = res.locals.user as UserModel
217 const oldUserAuditView = new UserAuditView(userToUpdate.toFormattedJSON())
218 const roleChanged = body.role !== undefined && body.role !== userToUpdate.role
220 if (body.email !== undefined) userToUpdate.email = body.email
221 if (body.videoQuota !== undefined) userToUpdate.videoQuota = body.videoQuota
222 if (body.role !== undefined) userToUpdate.role = body.role
224 const user = await userToUpdate.save()
226 // Destroy user token to refresh rights
228 await OAuthTokenModel.deleteUserToken(userToUpdate.id)
232 res.locals.oauth.token.User.Account.Actor.getIdentifier(),
233 new UserAuditView(user.toFormattedJSON()),
237 // Don't need to send this update to followers, these attributes are not propagated
239 return res.sendStatus(204)
242 async function askResetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
243 const user = res.locals.user as UserModel
245 const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
246 const url = CONFIG.WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
247 await Emailer.Instance.addForgetPasswordEmailJob(user.email, url)
249 return res.status(204).end()
252 async function resetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
253 const user = res.locals.user as UserModel
254 user.password = req.body.password
258 return res.status(204).end()
261 function success (req: express.Request, res: express.Response, next: express.NextFunction) {
265 async function changeUserBlock (res: express.Response, user: UserModel, block: boolean, reason?: string) {
266 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
269 user.blockedReason = reason || null
271 await sequelizeTypescript.transaction(async t => {
272 await OAuthTokenModel.deleteUserToken(user.id, t)
274 await user.save({ transaction: t })
277 await Emailer.Instance.addUserBlockJob(user, block, reason)
280 res.locals.oauth.token.User.Account.Actor.getIdentifier(),
281 new UserAuditView(user.toFormattedJSON()),