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, sequelizeTypescript, WEBSERVER } from '../../../initializers'
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'
48 const auditLogger = auditLoggerFactory('users')
50 const loginRateLimiter = new RateLimit({
51 windowMs: RATES_LIMIT.LOGIN.WINDOW_MS,
52 max: RATES_LIMIT.LOGIN.MAX
55 const askSendEmailLimiter = new RateLimit({
56 windowMs: RATES_LIMIT.ASK_SEND_EMAIL.WINDOW_MS,
57 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('/', myVideoPlaylistsRouter)
66 usersRouter.use('/', meRouter)
68 usersRouter.get('/autocomplete',
69 userAutocompleteValidator,
70 asyncMiddleware(autocompleteUsers)
75 ensureUserHasRight(UserRight.MANAGE_USERS),
80 asyncMiddleware(listUsers)
83 usersRouter.post('/:id/block',
85 ensureUserHasRight(UserRight.MANAGE_USERS),
86 asyncMiddleware(usersBlockingValidator),
87 asyncMiddleware(blockUser)
89 usersRouter.post('/:id/unblock',
91 ensureUserHasRight(UserRight.MANAGE_USERS),
92 asyncMiddleware(usersBlockingValidator),
93 asyncMiddleware(unblockUser)
96 usersRouter.get('/:id',
98 ensureUserHasRight(UserRight.MANAGE_USERS),
99 asyncMiddleware(usersGetValidator),
103 usersRouter.post('/',
105 ensureUserHasRight(UserRight.MANAGE_USERS),
106 asyncMiddleware(usersAddValidator),
107 asyncRetryTransactionMiddleware(createUser)
110 usersRouter.post('/register',
111 asyncMiddleware(ensureUserRegistrationAllowed),
112 ensureUserRegistrationAllowedForIP,
113 asyncMiddleware(usersRegisterValidator),
114 asyncRetryTransactionMiddleware(registerUser)
117 usersRouter.put('/:id',
119 ensureUserHasRight(UserRight.MANAGE_USERS),
120 asyncMiddleware(usersUpdateValidator),
121 asyncMiddleware(updateUser)
124 usersRouter.delete('/:id',
126 ensureUserHasRight(UserRight.MANAGE_USERS),
127 asyncMiddleware(usersRemoveValidator),
128 asyncMiddleware(removeUser)
131 usersRouter.post('/ask-reset-password',
132 asyncMiddleware(usersAskResetPasswordValidator),
133 asyncMiddleware(askResetUserPassword)
136 usersRouter.post('/:id/reset-password',
137 asyncMiddleware(usersResetPasswordValidator),
138 asyncMiddleware(resetUserPassword)
141 usersRouter.post('/ask-send-verify-email',
143 asyncMiddleware(usersAskSendVerifyEmailValidator),
144 asyncMiddleware(askSendVerifyUserEmail)
147 usersRouter.post('/:id/verify-email',
148 asyncMiddleware(usersVerifyEmailValidator),
149 asyncMiddleware(verifyUserEmail)
152 usersRouter.post('/token',
157 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
159 // ---------------------------------------------------------------------------
165 // ---------------------------------------------------------------------------
167 async function createUser (req: express.Request, res: express.Response) {
168 const body: UserCreate = req.body
169 const userToCreate = new UserModel({
170 username: body.username,
171 password: body.password,
173 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
176 videoQuota: body.videoQuota,
177 videoQuotaDaily: body.videoQuotaDaily
180 const { user, account } = await createUserAccountAndChannelAndPlaylist(userToCreate)
182 auditLogger.create(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
183 logger.info('User %s with its channel and account created.', body.username)
190 uuid: account.Actor.uuid
196 async function registerUser (req: express.Request, res: express.Response) {
197 const body: UserCreate = req.body
199 const userToCreate = new UserModel({
200 username: body.username,
201 password: body.password,
203 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
206 videoQuota: CONFIG.USER.VIDEO_QUOTA,
207 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY,
208 emailVerified: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION ? false : null
211 const { user } = await createUserAccountAndChannelAndPlaylist(userToCreate)
213 auditLogger.create(body.username, new UserAuditView(user.toFormattedJSON()))
214 logger.info('User %s with its channel and account registered.', body.username)
216 if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
217 await sendVerifyUserEmail(user)
220 Notifier.Instance.notifyOnNewUserRegistration(user)
222 return res.type('json').status(204).end()
225 async function unblockUser (req: express.Request, res: express.Response) {
226 const user = res.locals.user
228 await changeUserBlock(res, user, false)
230 return res.status(204).end()
233 async function blockUser (req: express.Request, res: express.Response) {
234 const user = res.locals.user
235 const reason = req.body.reason
237 await changeUserBlock(res, user, true, reason)
239 return res.status(204).end()
242 function getUser (req: express.Request, res: express.Response) {
243 return res.json(res.locals.user.toFormattedJSON())
246 async function autocompleteUsers (req: express.Request, res: express.Response) {
247 const resultList = await UserModel.autoComplete(req.query.search as string)
249 return res.json(resultList)
252 async function listUsers (req: express.Request, res: express.Response) {
253 const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort, req.query.search)
255 return res.json(getFormattedObjects(resultList.data, resultList.total))
258 async function removeUser (req: express.Request, res: express.Response) {
259 const user = res.locals.user
263 auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
265 return res.sendStatus(204)
268 async function updateUser (req: express.Request, res: express.Response) {
269 const body: UserUpdate = req.body
270 const userToUpdate = res.locals.user
271 const oldUserAuditView = new UserAuditView(userToUpdate.toFormattedJSON())
272 const roleChanged = body.role !== undefined && body.role !== userToUpdate.role
274 if (body.password !== undefined) userToUpdate.password = body.password
275 if (body.email !== undefined) userToUpdate.email = body.email
276 if (body.emailVerified !== undefined) userToUpdate.emailVerified = body.emailVerified
277 if (body.videoQuota !== undefined) userToUpdate.videoQuota = body.videoQuota
278 if (body.videoQuotaDaily !== undefined) userToUpdate.videoQuotaDaily = body.videoQuotaDaily
279 if (body.role !== undefined) userToUpdate.role = body.role
281 const user = await userToUpdate.save()
283 // Destroy user token to refresh rights
284 if (roleChanged || body.password !== undefined) await deleteUserToken(userToUpdate.id)
286 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)
288 // Don't need to send this update to followers, these attributes are not federated
290 return res.sendStatus(204)
293 async function askResetUserPassword (req: express.Request, res: express.Response) {
294 const user = res.locals.user
296 const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
297 const url = WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
298 await Emailer.Instance.addPasswordResetEmailJob(user.email, url)
300 return res.status(204).end()
303 async function resetUserPassword (req: express.Request, res: express.Response) {
304 const user = res.locals.user
305 user.password = req.body.password
309 return res.status(204).end()
312 async function sendVerifyUserEmail (user: UserModel) {
313 const verificationString = await Redis.Instance.setVerifyEmailVerificationString(user.id)
314 const url = WEBSERVER.URL + '/verify-account/email?userId=' + user.id + '&verificationString=' + verificationString
315 await Emailer.Instance.addVerifyEmailJob(user.email, url)
319 async function askSendVerifyUserEmail (req: express.Request, res: express.Response) {
320 const user = res.locals.user
322 await sendVerifyUserEmail(user)
324 return res.status(204).end()
327 async function verifyUserEmail (req: express.Request, res: express.Response) {
328 const user = res.locals.user
329 user.emailVerified = true
333 return res.status(204).end()
336 function success (req: express.Request, res: express.Response) {
340 async function changeUserBlock (res: express.Response, user: UserModel, block: boolean, reason?: string) {
341 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
344 user.blockedReason = reason || null
346 await sequelizeTypescript.transaction(async t => {
347 await deleteUserToken(user.id, t)
349 await user.save({ transaction: t })
352 await Emailer.Instance.addUserBlockJob(user, block, reason)
354 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)