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'
51 import { MUser, MUserAccountDefault } from '@server/typings/models'
53 const auditLogger = auditLoggerFactory('users')
55 // FIXME: https://github.com/nfriedly/express-rate-limit/issues/138
57 const loginRateLimiter = RateLimit({
58 windowMs: CONFIG.RATES_LIMIT.LOGIN.WINDOW_MS,
59 max: CONFIG.RATES_LIMIT.LOGIN.MAX
63 const signupRateLimiter = RateLimit({
64 windowMs: CONFIG.RATES_LIMIT.SIGNUP.WINDOW_MS,
65 max: CONFIG.RATES_LIMIT.SIGNUP.MAX,
66 skipFailedRequests: true
70 const askSendEmailLimiter = new RateLimit({
71 windowMs: CONFIG.RATES_LIMIT.ASK_SEND_EMAIL.WINDOW_MS,
72 max: CONFIG.RATES_LIMIT.ASK_SEND_EMAIL.MAX
75 const usersRouter = express.Router()
76 usersRouter.use('/', myNotificationsRouter)
77 usersRouter.use('/', mySubscriptionsRouter)
78 usersRouter.use('/', myBlocklistRouter)
79 usersRouter.use('/', myVideosHistoryRouter)
80 usersRouter.use('/', myVideoPlaylistsRouter)
81 usersRouter.use('/', meRouter)
83 usersRouter.get('/autocomplete',
84 userAutocompleteValidator,
85 asyncMiddleware(autocompleteUsers)
90 ensureUserHasRight(UserRight.MANAGE_USERS),
95 asyncMiddleware(listUsers)
98 usersRouter.post('/:id/block',
100 ensureUserHasRight(UserRight.MANAGE_USERS),
101 asyncMiddleware(usersBlockingValidator),
103 asyncMiddleware(blockUser)
105 usersRouter.post('/:id/unblock',
107 ensureUserHasRight(UserRight.MANAGE_USERS),
108 asyncMiddleware(usersBlockingValidator),
110 asyncMiddleware(unblockUser)
113 usersRouter.get('/:id',
115 ensureUserHasRight(UserRight.MANAGE_USERS),
116 asyncMiddleware(usersGetValidator),
120 usersRouter.post('/',
122 ensureUserHasRight(UserRight.MANAGE_USERS),
123 asyncMiddleware(usersAddValidator),
124 asyncRetryTransactionMiddleware(createUser)
127 usersRouter.post('/register',
129 asyncMiddleware(ensureUserRegistrationAllowed),
130 ensureUserRegistrationAllowedForIP,
131 asyncMiddleware(usersRegisterValidator),
132 asyncRetryTransactionMiddleware(registerUser)
135 usersRouter.put('/:id',
137 ensureUserHasRight(UserRight.MANAGE_USERS),
138 asyncMiddleware(usersUpdateValidator),
140 asyncMiddleware(updateUser)
143 usersRouter.delete('/:id',
145 ensureUserHasRight(UserRight.MANAGE_USERS),
146 asyncMiddleware(usersRemoveValidator),
148 asyncMiddleware(removeUser)
151 usersRouter.post('/ask-reset-password',
152 asyncMiddleware(usersAskResetPasswordValidator),
153 asyncMiddleware(askResetUserPassword)
156 usersRouter.post('/:id/reset-password',
157 asyncMiddleware(usersResetPasswordValidator),
158 asyncMiddleware(resetUserPassword)
161 usersRouter.post('/ask-send-verify-email',
163 asyncMiddleware(usersAskSendVerifyEmailValidator),
164 asyncMiddleware(reSendVerifyUserEmail)
167 usersRouter.post('/:id/verify-email',
168 asyncMiddleware(usersVerifyEmailValidator),
169 asyncMiddleware(verifyUserEmail)
172 usersRouter.post('/token',
177 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
179 // ---------------------------------------------------------------------------
185 // ---------------------------------------------------------------------------
187 async function createUser (req: express.Request, res: express.Response) {
188 const body: UserCreate = req.body
189 const userToCreate = new UserModel({
190 username: body.username,
191 password: body.password,
193 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
196 videoQuota: body.videoQuota,
197 videoQuotaDaily: body.videoQuotaDaily,
198 adminFlags: body.adminFlags || UserAdminFlag.NONE
201 const { user, account } = await createUserAccountAndChannelAndPlaylist({ userToCreate: userToCreate })
203 auditLogger.create(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
204 logger.info('User %s with its channel and account created.', body.username)
216 async function registerUser (req: express.Request, res: express.Response) {
217 const body: UserRegister = req.body
219 const userToCreate = new UserModel({
220 username: body.username,
221 password: body.password,
223 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
226 videoQuota: CONFIG.USER.VIDEO_QUOTA,
227 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY,
228 emailVerified: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION ? false : null
231 const { user } = await createUserAccountAndChannelAndPlaylist({
232 userToCreate: userToCreate,
233 userDisplayName: body.displayName || undefined,
234 channelNames: body.channel
237 auditLogger.create(body.username, new UserAuditView(user.toFormattedJSON()))
238 logger.info('User %s with its channel and account registered.', body.username)
240 if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
241 await sendVerifyUserEmail(user)
244 Notifier.Instance.notifyOnNewUserRegistration(user)
246 return res.type('json').status(204).end()
249 async function unblockUser (req: express.Request, res: express.Response) {
250 const user = res.locals.user
252 await changeUserBlock(res, user, false)
254 return res.status(204).end()
257 async function blockUser (req: express.Request, res: express.Response) {
258 const user = res.locals.user
259 const reason = req.body.reason
261 await changeUserBlock(res, user, true, reason)
263 return res.status(204).end()
266 function getUser (req: express.Request, res: express.Response) {
267 return res.json(res.locals.user.toFormattedJSON({ withAdminFlags: true }))
270 async function autocompleteUsers (req: express.Request, res: express.Response) {
271 const resultList = await UserModel.autoComplete(req.query.search as string)
273 return res.json(resultList)
276 async function listUsers (req: express.Request, res: express.Response) {
277 const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort, req.query.search)
279 return res.json(getFormattedObjects(resultList.data, resultList.total, { withAdminFlags: true }))
282 async function removeUser (req: express.Request, res: express.Response) {
283 const user = res.locals.user
287 auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
289 return res.sendStatus(204)
292 async function updateUser (req: express.Request, res: express.Response) {
293 const body: UserUpdate = req.body
294 const userToUpdate = res.locals.user
295 const oldUserAuditView = new UserAuditView(userToUpdate.toFormattedJSON())
296 const roleChanged = body.role !== undefined && body.role !== userToUpdate.role
298 if (body.password !== undefined) userToUpdate.password = body.password
299 if (body.email !== undefined) userToUpdate.email = body.email
300 if (body.emailVerified !== undefined) userToUpdate.emailVerified = body.emailVerified
301 if (body.videoQuota !== undefined) userToUpdate.videoQuota = body.videoQuota
302 if (body.videoQuotaDaily !== undefined) userToUpdate.videoQuotaDaily = body.videoQuotaDaily
303 if (body.role !== undefined) userToUpdate.role = body.role
304 if (body.adminFlags !== undefined) userToUpdate.adminFlags = body.adminFlags
306 const user = await userToUpdate.save()
308 // Destroy user token to refresh rights
309 if (roleChanged || body.password !== undefined) await deleteUserToken(userToUpdate.id)
311 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)
313 // Don't need to send this update to followers, these attributes are not federated
315 return res.sendStatus(204)
318 async function askResetUserPassword (req: express.Request, res: express.Response) {
319 const user = res.locals.user
321 const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
322 const url = WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
323 await Emailer.Instance.addPasswordResetEmailJob(user.email, url)
325 return res.status(204).end()
328 async function resetUserPassword (req: express.Request, res: express.Response) {
329 const user = res.locals.user
330 user.password = req.body.password
334 return res.status(204).end()
337 async function reSendVerifyUserEmail (req: express.Request, res: express.Response) {
338 const user = res.locals.user
340 await sendVerifyUserEmail(user)
342 return res.status(204).end()
345 async function verifyUserEmail (req: express.Request, res: express.Response) {
346 const user = res.locals.user
347 user.emailVerified = true
349 if (req.body.isPendingEmail === true) {
350 user.email = user.pendingEmail
351 user.pendingEmail = null
356 return res.status(204).end()
359 function success (req: express.Request, res: express.Response) {
363 async function changeUserBlock (res: express.Response, user: MUserAccountDefault, block: boolean, reason?: string) {
364 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
367 user.blockedReason = reason || null
369 await sequelizeTypescript.transaction(async t => {
370 await deleteUserToken(user.id, t)
372 await user.save({ transaction: t })
375 await Emailer.Instance.addUserBlockJob(user, block, reason)
377 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)