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'
43 import { Notifier } from '../../../lib/notifier'
44 import { mySubscriptionsRouter } from './my-subscriptions'
46 const auditLogger = auditLoggerFactory('users')
48 const loginRateLimiter = new RateLimit({
49 windowMs: RATES_LIMIT.LOGIN.WINDOW_MS,
50 max: RATES_LIMIT.LOGIN.MAX,
54 const askSendEmailLimiter = new RateLimit({
55 windowMs: RATES_LIMIT.ASK_SEND_EMAIL.WINDOW_MS,
56 max: RATES_LIMIT.ASK_SEND_EMAIL.MAX,
60 const usersRouter = express.Router()
61 usersRouter.use('/', myNotificationsRouter)
62 usersRouter.use('/', mySubscriptionsRouter)
63 usersRouter.use('/', myBlocklistRouter)
64 usersRouter.use('/', myVideosHistoryRouter)
65 usersRouter.use('/', meRouter)
67 usersRouter.get('/autocomplete',
68 userAutocompleteValidator,
69 asyncMiddleware(autocompleteUsers)
74 ensureUserHasRight(UserRight.MANAGE_USERS),
79 asyncMiddleware(listUsers)
82 usersRouter.post('/:id/block',
84 ensureUserHasRight(UserRight.MANAGE_USERS),
85 asyncMiddleware(usersBlockingValidator),
86 asyncMiddleware(blockUser)
88 usersRouter.post('/:id/unblock',
90 ensureUserHasRight(UserRight.MANAGE_USERS),
91 asyncMiddleware(usersBlockingValidator),
92 asyncMiddleware(unblockUser)
95 usersRouter.get('/:id',
97 ensureUserHasRight(UserRight.MANAGE_USERS),
98 asyncMiddleware(usersGetValidator),
102 usersRouter.post('/',
104 ensureUserHasRight(UserRight.MANAGE_USERS),
105 asyncMiddleware(usersAddValidator),
106 asyncRetryTransactionMiddleware(createUser)
109 usersRouter.post('/register',
110 asyncMiddleware(ensureUserRegistrationAllowed),
111 ensureUserRegistrationAllowedForIP,
112 asyncMiddleware(usersRegisterValidator),
113 asyncRetryTransactionMiddleware(registerUser)
116 usersRouter.put('/:id',
118 ensureUserHasRight(UserRight.MANAGE_USERS),
119 asyncMiddleware(usersUpdateValidator),
120 asyncMiddleware(updateUser)
123 usersRouter.delete('/:id',
125 ensureUserHasRight(UserRight.MANAGE_USERS),
126 asyncMiddleware(usersRemoveValidator),
127 asyncMiddleware(removeUser)
130 usersRouter.post('/ask-reset-password',
131 asyncMiddleware(usersAskResetPasswordValidator),
132 asyncMiddleware(askResetUserPassword)
135 usersRouter.post('/:id/reset-password',
136 asyncMiddleware(usersResetPasswordValidator),
137 asyncMiddleware(resetUserPassword)
140 usersRouter.post('/ask-send-verify-email',
142 asyncMiddleware(usersAskSendVerifyEmailValidator),
143 asyncMiddleware(askSendVerifyUserEmail)
146 usersRouter.post('/:id/verify-email',
147 asyncMiddleware(usersVerifyEmailValidator),
148 asyncMiddleware(verifyUserEmail)
151 usersRouter.post('/token',
156 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
158 // ---------------------------------------------------------------------------
164 // ---------------------------------------------------------------------------
166 async function createUser (req: express.Request, res: express.Response) {
167 const body: UserCreate = req.body
168 const userToCreate = new UserModel({
169 username: body.username,
170 password: body.password,
172 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
175 videoQuota: body.videoQuota,
176 videoQuotaDaily: body.videoQuotaDaily
179 const { user, account } = await createUserAccountAndChannel(userToCreate)
181 auditLogger.create(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
182 logger.info('User %s with its channel and account created.', body.username)
189 uuid: account.Actor.uuid
195 async function registerUser (req: express.Request, res: express.Response) {
196 const body: UserCreate = req.body
198 const userToCreate = new UserModel({
199 username: body.username,
200 password: body.password,
202 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
205 videoQuota: CONFIG.USER.VIDEO_QUOTA,
206 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY,
207 emailVerified: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION ? false : null
210 const { user } = await createUserAccountAndChannel(userToCreate)
212 auditLogger.create(body.username, new UserAuditView(user.toFormattedJSON()))
213 logger.info('User %s with its channel and account registered.', body.username)
215 if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
216 await sendVerifyUserEmail(user)
219 Notifier.Instance.notifyOnNewUserRegistration(user)
221 return res.type('json').status(204).end()
224 async function unblockUser (req: express.Request, res: express.Response, next: express.NextFunction) {
225 const user: UserModel = res.locals.user
227 await changeUserBlock(res, user, false)
229 return res.status(204).end()
232 async function blockUser (req: express.Request, res: express.Response) {
233 const user: UserModel = res.locals.user
234 const reason = req.body.reason
236 await changeUserBlock(res, user, true, reason)
238 return res.status(204).end()
241 function getUser (req: express.Request, res: express.Response) {
242 return res.json((res.locals.user as UserModel).toFormattedJSON())
245 async function autocompleteUsers (req: express.Request, res: express.Response) {
246 const resultList = await UserModel.autoComplete(req.query.search as string)
248 return res.json(resultList)
251 async function listUsers (req: express.Request, res: express.Response) {
252 const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort, req.query.search)
254 return res.json(getFormattedObjects(resultList.data, resultList.total))
257 async function removeUser (req: express.Request, res: express.Response) {
258 const user: UserModel = res.locals.user
262 auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
264 return res.sendStatus(204)
267 async function updateUser (req: express.Request, res: express.Response) {
268 const body: UserUpdate = req.body
269 const userToUpdate = res.locals.user as UserModel
270 const oldUserAuditView = new UserAuditView(userToUpdate.toFormattedJSON())
271 const roleChanged = body.role !== undefined && body.role !== userToUpdate.role
273 if (body.password !== undefined) userToUpdate.password = body.password
274 if (body.email !== undefined) userToUpdate.email = body.email
275 if (body.emailVerified !== undefined) userToUpdate.emailVerified = body.emailVerified
276 if (body.videoQuota !== undefined) userToUpdate.videoQuota = body.videoQuota
277 if (body.videoQuotaDaily !== undefined) userToUpdate.videoQuotaDaily = body.videoQuotaDaily
278 if (body.role !== undefined) userToUpdate.role = body.role
280 const user = await userToUpdate.save()
282 // Destroy user token to refresh rights
283 if (roleChanged || body.password !== undefined) await deleteUserToken(userToUpdate.id)
285 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)
287 // Don't need to send this update to followers, these attributes are not federated
289 return res.sendStatus(204)
292 async function askResetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
293 const user = res.locals.user as UserModel
295 const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
296 const url = CONFIG.WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
297 await Emailer.Instance.addPasswordResetEmailJob(user.email, url)
299 return res.status(204).end()
302 async function resetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
303 const user = res.locals.user as UserModel
304 user.password = req.body.password
308 return res.status(204).end()
311 async function sendVerifyUserEmail (user: UserModel) {
312 const verificationString = await Redis.Instance.setVerifyEmailVerificationString(user.id)
313 const url = CONFIG.WEBSERVER.URL + '/verify-account/email?userId=' + user.id + '&verificationString=' + verificationString
314 await Emailer.Instance.addVerifyEmailJob(user.email, url)
318 async function askSendVerifyUserEmail (req: express.Request, res: express.Response, next: express.NextFunction) {
319 const user = res.locals.user as UserModel
321 await sendVerifyUserEmail(user)
323 return res.status(204).end()
326 async function verifyUserEmail (req: express.Request, res: express.Response, next: express.NextFunction) {
327 const user = res.locals.user as UserModel
328 user.emailVerified = true
332 return res.status(204).end()
335 function success (req: express.Request, res: express.Response, next: express.NextFunction) {
339 async function changeUserBlock (res: express.Response, user: UserModel, block: boolean, reason?: string) {
340 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
343 user.blockedReason = reason || null
345 await sequelizeTypescript.transaction(async t => {
346 await deleteUserToken(user.id, t)
348 await user.save({ transaction: t })
351 await Emailer.Instance.addUserBlockJob(user, block, reason)
353 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)