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 { WEBSERVER } from '../../../initializers/constants'
7 import { Emailer } from '../../../lib/emailer'
8 import { Redis } from '../../../lib/redis'
9 import { createUserAccountAndChannelAndPlaylist, sendVerifyUserEmail } 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,
36 } from '../../../middlewares/validators'
37 import { UserModel } from '../../../models/account/user'
38 import { auditLoggerFactory, getAuditIdFromRes, UserAuditView } from '../../../helpers/audit-logger'
39 import { meRouter } from './me'
40 import { deleteUserToken } from '../../../lib/oauth-model'
41 import { myBlocklistRouter } from './my-blocklist'
42 import { myVideoPlaylistsRouter } from './my-video-playlists'
43 import { myVideosHistoryRouter } from './my-history'
44 import { myNotificationsRouter } from './my-notifications'
45 import { Notifier } from '../../../lib/notifier'
46 import { mySubscriptionsRouter } from './my-subscriptions'
47 import { CONFIG } from '../../../initializers/config'
48 import { sequelizeTypescript } from '../../../initializers/database'
49 import { UserAdminFlag } from '../../../../shared/models/users/user-flag.model'
50 import { UserRegister } from '../../../../shared/models/users/user-register.model'
52 const auditLogger = auditLoggerFactory('users')
54 // FIXME: https://github.com/nfriedly/express-rate-limit/issues/138
56 const loginRateLimiter = RateLimit({
57 windowMs: CONFIG.RATES_LIMIT.LOGIN.WINDOW_MS,
58 max: CONFIG.RATES_LIMIT.LOGIN.MAX
62 const signupRateLimiter = RateLimit({
63 windowMs: CONFIG.RATES_LIMIT.SIGNUP.WINDOW_MS,
64 max: CONFIG.RATES_LIMIT.SIGNUP.MAX,
65 skipFailedRequests: true
69 const askSendEmailLimiter = new RateLimit({
70 windowMs: CONFIG.RATES_LIMIT.ASK_SEND_EMAIL.WINDOW_MS,
71 max: CONFIG.RATES_LIMIT.ASK_SEND_EMAIL.MAX
74 const usersRouter = express.Router()
75 usersRouter.use('/', myNotificationsRouter)
76 usersRouter.use('/', mySubscriptionsRouter)
77 usersRouter.use('/', myBlocklistRouter)
78 usersRouter.use('/', myVideosHistoryRouter)
79 usersRouter.use('/', myVideoPlaylistsRouter)
80 usersRouter.use('/', meRouter)
82 usersRouter.get('/autocomplete',
83 userAutocompleteValidator,
84 asyncMiddleware(autocompleteUsers)
89 ensureUserHasRight(UserRight.MANAGE_USERS),
94 asyncMiddleware(listUsers)
97 usersRouter.post('/:id/block',
99 ensureUserHasRight(UserRight.MANAGE_USERS),
100 asyncMiddleware(usersBlockingValidator),
102 asyncMiddleware(blockUser)
104 usersRouter.post('/:id/unblock',
106 ensureUserHasRight(UserRight.MANAGE_USERS),
107 asyncMiddleware(usersBlockingValidator),
109 asyncMiddleware(unblockUser)
112 usersRouter.get('/:id',
114 ensureUserHasRight(UserRight.MANAGE_USERS),
115 asyncMiddleware(usersGetValidator),
119 usersRouter.post('/',
121 ensureUserHasRight(UserRight.MANAGE_USERS),
122 asyncMiddleware(usersAddValidator),
123 asyncRetryTransactionMiddleware(createUser)
126 usersRouter.post('/register',
128 asyncMiddleware(ensureUserRegistrationAllowed),
129 ensureUserRegistrationAllowedForIP,
130 asyncMiddleware(usersRegisterValidator),
131 asyncRetryTransactionMiddleware(registerUser)
134 usersRouter.put('/:id',
136 ensureUserHasRight(UserRight.MANAGE_USERS),
137 asyncMiddleware(usersUpdateValidator),
139 asyncMiddleware(updateUser)
142 usersRouter.delete('/:id',
144 ensureUserHasRight(UserRight.MANAGE_USERS),
145 asyncMiddleware(usersRemoveValidator),
147 asyncMiddleware(removeUser)
150 usersRouter.post('/ask-reset-password',
151 asyncMiddleware(usersAskResetPasswordValidator),
152 asyncMiddleware(askResetUserPassword)
155 usersRouter.post('/:id/reset-password',
156 asyncMiddleware(usersResetPasswordValidator),
157 asyncMiddleware(resetUserPassword)
160 usersRouter.post('/ask-send-verify-email',
162 asyncMiddleware(usersAskSendVerifyEmailValidator),
163 asyncMiddleware(reSendVerifyUserEmail)
166 usersRouter.post('/:id/verify-email',
167 asyncMiddleware(usersVerifyEmailValidator),
168 asyncMiddleware(verifyUserEmail)
171 usersRouter.post('/token',
176 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
178 // ---------------------------------------------------------------------------
184 // ---------------------------------------------------------------------------
186 async function createUser (req: express.Request, res: express.Response) {
187 const body: UserCreate = req.body
188 const userToCreate = new UserModel({
189 username: body.username,
190 password: body.password,
192 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
195 videoQuota: body.videoQuota,
196 videoQuotaDaily: body.videoQuotaDaily,
197 adminFlags: body.adminFlags || UserAdminFlag.NONE
200 const { user, account } = await createUserAccountAndChannelAndPlaylist({ userToCreate: userToCreate })
202 auditLogger.create(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
203 logger.info('User %s with its channel and account created.', body.username)
215 async function registerUser (req: express.Request, res: express.Response) {
216 const body: UserRegister = req.body
218 const userToCreate = new UserModel({
219 username: body.username,
220 password: body.password,
222 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
225 videoQuota: CONFIG.USER.VIDEO_QUOTA,
226 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY,
227 emailVerified: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION ? false : null
230 const { user } = await createUserAccountAndChannelAndPlaylist({
231 userToCreate: userToCreate,
232 userDisplayName: body.displayName || undefined,
233 channelNames: body.channel
236 auditLogger.create(body.username, new UserAuditView(user.toFormattedJSON()))
237 logger.info('User %s with its channel and account registered.', body.username)
239 if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
240 await sendVerifyUserEmail(user)
243 Notifier.Instance.notifyOnNewUserRegistration(user)
245 return res.type('json').status(204).end()
248 async function unblockUser (req: express.Request, res: express.Response) {
249 const user = res.locals.user
251 await changeUserBlock(res, user, false)
253 return res.status(204).end()
256 async function blockUser (req: express.Request, res: express.Response) {
257 const user = res.locals.user
258 const reason = req.body.reason
260 await changeUserBlock(res, user, true, reason)
262 return res.status(204).end()
265 function getUser (req: express.Request, res: express.Response) {
266 return res.json(res.locals.user.toFormattedJSON({ withAdminFlags: true }))
269 async function autocompleteUsers (req: express.Request, res: express.Response) {
270 const resultList = await UserModel.autoComplete(req.query.search as string)
272 return res.json(resultList)
275 async function listUsers (req: express.Request, res: express.Response) {
276 const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort, req.query.search)
278 return res.json(getFormattedObjects(resultList.data, resultList.total, { withAdminFlags: true }))
281 async function removeUser (req: express.Request, res: express.Response) {
282 const user = res.locals.user
286 auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
288 return res.sendStatus(204)
291 async function updateUser (req: express.Request, res: express.Response) {
292 const body: UserUpdate = req.body
293 const userToUpdate = res.locals.user
294 const oldUserAuditView = new UserAuditView(userToUpdate.toFormattedJSON())
295 const roleChanged = body.role !== undefined && body.role !== userToUpdate.role
297 if (body.password !== undefined) userToUpdate.password = body.password
298 if (body.email !== undefined) userToUpdate.email = body.email
299 if (body.emailVerified !== undefined) userToUpdate.emailVerified = body.emailVerified
300 if (body.videoQuota !== undefined) userToUpdate.videoQuota = body.videoQuota
301 if (body.videoQuotaDaily !== undefined) userToUpdate.videoQuotaDaily = body.videoQuotaDaily
302 if (body.role !== undefined) userToUpdate.role = body.role
303 if (body.adminFlags !== undefined) userToUpdate.adminFlags = body.adminFlags
305 const user = await userToUpdate.save()
307 // Destroy user token to refresh rights
308 if (roleChanged || body.password !== undefined) await deleteUserToken(userToUpdate.id)
310 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)
312 // Don't need to send this update to followers, these attributes are not federated
314 return res.sendStatus(204)
317 async function askResetUserPassword (req: express.Request, res: express.Response) {
318 const user = res.locals.user
320 const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
321 const url = WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
322 await Emailer.Instance.addPasswordResetEmailJob(user.email, url)
324 return res.status(204).end()
327 async function resetUserPassword (req: express.Request, res: express.Response) {
328 const user = res.locals.user
329 user.password = req.body.password
333 return res.status(204).end()
336 async function reSendVerifyUserEmail (req: express.Request, res: express.Response) {
337 const user = res.locals.user
339 await sendVerifyUserEmail(user)
341 return res.status(204).end()
344 async function verifyUserEmail (req: express.Request, res: express.Response) {
345 const user = res.locals.user
346 user.emailVerified = true
348 if (req.body.isPendingEmail === true) {
349 user.email = user.pendingEmail
350 user.pendingEmail = null
355 return res.status(204).end()
358 function success (req: express.Request, res: express.Response) {
362 async function changeUserBlock (res: express.Response, user: UserModel, block: boolean, reason?: string) {
363 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
366 user.blockedReason = reason || null
368 await sequelizeTypescript.transaction(async t => {
369 await deleteUserToken(user.id, t)
371 await user.save({ transaction: t })
374 await Emailer.Instance.addUserBlockJob(user, block, reason)
376 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)