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 { RATES_LIMIT, WEBSERVER } from '../../../initializers/constants'
7 import { Emailer } from '../../../lib/emailer'
8 import { Redis } from '../../../lib/redis'
9 import { createUserAccountAndChannelAndPlaylist } 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 { myVideoPlaylistsRouter } from './my-video-playlists'
42 import { myVideosHistoryRouter } from './my-history'
43 import { myNotificationsRouter } from './my-notifications'
44 import { Notifier } from '../../../lib/notifier'
45 import { mySubscriptionsRouter } from './my-subscriptions'
46 import { CONFIG } from '../../../initializers/config'
47 import { sequelizeTypescript } from '../../../initializers/database'
48 import { UserAdminFlag } from '../../../../shared/models/users/user-flag.model'
49 import { UserRegister } from '../../../../shared/models/users/user-register.model'
51 const auditLogger = auditLoggerFactory('users')
53 const loginRateLimiter = new RateLimit({
54 windowMs: RATES_LIMIT.LOGIN.WINDOW_MS,
55 max: RATES_LIMIT.LOGIN.MAX
58 const askSendEmailLimiter = new RateLimit({
59 windowMs: RATES_LIMIT.ASK_SEND_EMAIL.WINDOW_MS,
60 max: RATES_LIMIT.ASK_SEND_EMAIL.MAX
63 const usersRouter = express.Router()
64 usersRouter.use('/', myNotificationsRouter)
65 usersRouter.use('/', mySubscriptionsRouter)
66 usersRouter.use('/', myBlocklistRouter)
67 usersRouter.use('/', myVideosHistoryRouter)
68 usersRouter.use('/', myVideoPlaylistsRouter)
69 usersRouter.use('/', meRouter)
71 usersRouter.get('/autocomplete',
72 userAutocompleteValidator,
73 asyncMiddleware(autocompleteUsers)
78 ensureUserHasRight(UserRight.MANAGE_USERS),
83 asyncMiddleware(listUsers)
86 usersRouter.post('/:id/block',
88 ensureUserHasRight(UserRight.MANAGE_USERS),
89 asyncMiddleware(usersBlockingValidator),
90 asyncMiddleware(blockUser)
92 usersRouter.post('/:id/unblock',
94 ensureUserHasRight(UserRight.MANAGE_USERS),
95 asyncMiddleware(usersBlockingValidator),
96 asyncMiddleware(unblockUser)
99 usersRouter.get('/:id',
101 ensureUserHasRight(UserRight.MANAGE_USERS),
102 asyncMiddleware(usersGetValidator),
106 usersRouter.post('/',
108 ensureUserHasRight(UserRight.MANAGE_USERS),
109 asyncMiddleware(usersAddValidator),
110 asyncRetryTransactionMiddleware(createUser)
113 usersRouter.post('/register',
114 asyncMiddleware(ensureUserRegistrationAllowed),
115 ensureUserRegistrationAllowedForIP,
116 asyncMiddleware(usersRegisterValidator),
117 asyncRetryTransactionMiddleware(registerUser)
120 usersRouter.put('/:id',
122 ensureUserHasRight(UserRight.MANAGE_USERS),
123 asyncMiddleware(usersUpdateValidator),
124 asyncMiddleware(updateUser)
127 usersRouter.delete('/:id',
129 ensureUserHasRight(UserRight.MANAGE_USERS),
130 asyncMiddleware(usersRemoveValidator),
131 asyncMiddleware(removeUser)
134 usersRouter.post('/ask-reset-password',
135 asyncMiddleware(usersAskResetPasswordValidator),
136 asyncMiddleware(askResetUserPassword)
139 usersRouter.post('/:id/reset-password',
140 asyncMiddleware(usersResetPasswordValidator),
141 asyncMiddleware(resetUserPassword)
144 usersRouter.post('/ask-send-verify-email',
146 asyncMiddleware(usersAskSendVerifyEmailValidator),
147 asyncMiddleware(askSendVerifyUserEmail)
150 usersRouter.post('/:id/verify-email',
151 asyncMiddleware(usersVerifyEmailValidator),
152 asyncMiddleware(verifyUserEmail)
155 usersRouter.post('/token',
160 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
162 // ---------------------------------------------------------------------------
168 // ---------------------------------------------------------------------------
170 async function createUser (req: express.Request, res: express.Response) {
171 const body: UserCreate = req.body
172 const userToCreate = new UserModel({
173 username: body.username,
174 password: body.password,
176 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
179 videoQuota: body.videoQuota,
180 videoQuotaDaily: body.videoQuotaDaily,
181 adminFlags: body.adminFlags || UserAdminFlag.NONE
184 const { user, account } = await createUserAccountAndChannelAndPlaylist(userToCreate)
186 auditLogger.create(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
187 logger.info('User %s with its channel and account created.', body.username)
199 async function registerUser (req: express.Request, res: express.Response) {
200 const body: UserRegister = req.body
202 const userToCreate = new UserModel({
203 username: body.username,
204 password: body.password,
206 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
209 videoQuota: CONFIG.USER.VIDEO_QUOTA,
210 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY,
211 emailVerified: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION ? false : null
214 const { user } = await createUserAccountAndChannelAndPlaylist(userToCreate, body.channel)
216 auditLogger.create(body.username, new UserAuditView(user.toFormattedJSON()))
217 logger.info('User %s with its channel and account registered.', body.username)
219 if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
220 await sendVerifyUserEmail(user)
223 Notifier.Instance.notifyOnNewUserRegistration(user)
225 return res.type('json').status(204).end()
228 async function unblockUser (req: express.Request, res: express.Response) {
229 const user = res.locals.user
231 await changeUserBlock(res, user, false)
233 return res.status(204).end()
236 async function blockUser (req: express.Request, res: express.Response) {
237 const user = res.locals.user
238 const reason = req.body.reason
240 await changeUserBlock(res, user, true, reason)
242 return res.status(204).end()
245 function getUser (req: express.Request, res: express.Response) {
246 return res.json(res.locals.user.toFormattedJSON({ withAdminFlags: true }))
249 async function autocompleteUsers (req: express.Request, res: express.Response) {
250 const resultList = await UserModel.autoComplete(req.query.search as string)
252 return res.json(resultList)
255 async function listUsers (req: express.Request, res: express.Response) {
256 const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort, req.query.search)
258 return res.json(getFormattedObjects(resultList.data, resultList.total, { withAdminFlags: true }))
261 async function removeUser (req: express.Request, res: express.Response) {
262 const user = res.locals.user
266 auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
268 return res.sendStatus(204)
271 async function updateUser (req: express.Request, res: express.Response) {
272 const body: UserUpdate = req.body
273 const userToUpdate = res.locals.user
274 const oldUserAuditView = new UserAuditView(userToUpdate.toFormattedJSON())
275 const roleChanged = body.role !== undefined && body.role !== userToUpdate.role
277 if (body.password !== undefined) userToUpdate.password = body.password
278 if (body.email !== undefined) userToUpdate.email = body.email
279 if (body.emailVerified !== undefined) userToUpdate.emailVerified = body.emailVerified
280 if (body.videoQuota !== undefined) userToUpdate.videoQuota = body.videoQuota
281 if (body.videoQuotaDaily !== undefined) userToUpdate.videoQuotaDaily = body.videoQuotaDaily
282 if (body.role !== undefined) userToUpdate.role = body.role
283 if (body.adminFlags !== undefined) userToUpdate.adminFlags = body.adminFlags
285 const user = await userToUpdate.save()
287 // Destroy user token to refresh rights
288 if (roleChanged || body.password !== undefined) await deleteUserToken(userToUpdate.id)
290 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)
292 // Don't need to send this update to followers, these attributes are not federated
294 return res.sendStatus(204)
297 async function askResetUserPassword (req: express.Request, res: express.Response) {
298 const user = res.locals.user
300 const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
301 const url = WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
302 await Emailer.Instance.addPasswordResetEmailJob(user.email, url)
304 return res.status(204).end()
307 async function resetUserPassword (req: express.Request, res: express.Response) {
308 const user = res.locals.user
309 user.password = req.body.password
313 return res.status(204).end()
316 async function sendVerifyUserEmail (user: UserModel) {
317 const verificationString = await Redis.Instance.setVerifyEmailVerificationString(user.id)
318 const url = WEBSERVER.URL + '/verify-account/email?userId=' + user.id + '&verificationString=' + verificationString
319 await Emailer.Instance.addVerifyEmailJob(user.email, url)
323 async function askSendVerifyUserEmail (req: express.Request, res: express.Response) {
324 const user = res.locals.user
326 await sendVerifyUserEmail(user)
328 return res.status(204).end()
331 async function verifyUserEmail (req: express.Request, res: express.Response) {
332 const user = res.locals.user
333 user.emailVerified = true
337 return res.status(204).end()
340 function success (req: express.Request, res: express.Response) {
344 async function changeUserBlock (res: express.Response, user: UserModel, block: boolean, reason?: string) {
345 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
348 user.blockedReason = reason || null
350 await sequelizeTypescript.transaction(async t => {
351 await deleteUserToken(user.id, t)
353 await user.save({ transaction: t })
356 await Emailer.Instance.addUserBlockJob(user, block, reason)
358 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)