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 { 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 { 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
53 const askSendEmailLimiter = new RateLimit({
54 windowMs: RATES_LIMIT.ASK_SEND_EMAIL.WINDOW_MS,
55 max: RATES_LIMIT.ASK_SEND_EMAIL.MAX
58 const usersRouter = express.Router()
59 usersRouter.use('/', myNotificationsRouter)
60 usersRouter.use('/', mySubscriptionsRouter)
61 usersRouter.use('/', myBlocklistRouter)
62 usersRouter.use('/', myVideosHistoryRouter)
63 usersRouter.use('/', meRouter)
65 usersRouter.get('/autocomplete',
66 userAutocompleteValidator,
67 asyncMiddleware(autocompleteUsers)
72 ensureUserHasRight(UserRight.MANAGE_USERS),
77 asyncMiddleware(listUsers)
80 usersRouter.post('/:id/block',
82 ensureUserHasRight(UserRight.MANAGE_USERS),
83 asyncMiddleware(usersBlockingValidator),
84 asyncMiddleware(blockUser)
86 usersRouter.post('/:id/unblock',
88 ensureUserHasRight(UserRight.MANAGE_USERS),
89 asyncMiddleware(usersBlockingValidator),
90 asyncMiddleware(unblockUser)
93 usersRouter.get('/:id',
95 ensureUserHasRight(UserRight.MANAGE_USERS),
96 asyncMiddleware(usersGetValidator),
100 usersRouter.post('/',
102 ensureUserHasRight(UserRight.MANAGE_USERS),
103 asyncMiddleware(usersAddValidator),
104 asyncRetryTransactionMiddleware(createUser)
107 usersRouter.post('/register',
108 asyncMiddleware(ensureUserRegistrationAllowed),
109 ensureUserRegistrationAllowedForIP,
110 asyncMiddleware(usersRegisterValidator),
111 asyncRetryTransactionMiddleware(registerUser)
114 usersRouter.put('/:id',
116 ensureUserHasRight(UserRight.MANAGE_USERS),
117 asyncMiddleware(usersUpdateValidator),
118 asyncMiddleware(updateUser)
121 usersRouter.delete('/:id',
123 ensureUserHasRight(UserRight.MANAGE_USERS),
124 asyncMiddleware(usersRemoveValidator),
125 asyncMiddleware(removeUser)
128 usersRouter.post('/ask-reset-password',
129 asyncMiddleware(usersAskResetPasswordValidator),
130 asyncMiddleware(askResetUserPassword)
133 usersRouter.post('/:id/reset-password',
134 asyncMiddleware(usersResetPasswordValidator),
135 asyncMiddleware(resetUserPassword)
138 usersRouter.post('/ask-send-verify-email',
140 asyncMiddleware(usersAskSendVerifyEmailValidator),
141 asyncMiddleware(askSendVerifyUserEmail)
144 usersRouter.post('/:id/verify-email',
145 asyncMiddleware(usersVerifyEmailValidator),
146 asyncMiddleware(verifyUserEmail)
149 usersRouter.post('/token',
154 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
156 // ---------------------------------------------------------------------------
162 // ---------------------------------------------------------------------------
164 async function createUser (req: express.Request, res: express.Response) {
165 const body: UserCreate = req.body
166 const userToCreate = new UserModel({
167 username: body.username,
168 password: body.password,
170 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
173 videoQuota: body.videoQuota,
174 videoQuotaDaily: body.videoQuotaDaily
177 const { user, account } = await createUserAccountAndChannelAndPlaylist(userToCreate)
179 auditLogger.create(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
180 logger.info('User %s with its channel and account created.', body.username)
187 uuid: account.Actor.uuid
193 async function registerUser (req: express.Request, res: express.Response) {
194 const body: UserCreate = req.body
196 const userToCreate = new UserModel({
197 username: body.username,
198 password: body.password,
200 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
203 videoQuota: CONFIG.USER.VIDEO_QUOTA,
204 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY,
205 emailVerified: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION ? false : null
208 const { user } = await createUserAccountAndChannelAndPlaylist(userToCreate)
210 auditLogger.create(body.username, new UserAuditView(user.toFormattedJSON()))
211 logger.info('User %s with its channel and account registered.', body.username)
213 if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
214 await sendVerifyUserEmail(user)
217 Notifier.Instance.notifyOnNewUserRegistration(user)
219 return res.type('json').status(204).end()
222 async function unblockUser (req: express.Request, res: express.Response, next: express.NextFunction) {
223 const user: UserModel = res.locals.user
225 await changeUserBlock(res, user, false)
227 return res.status(204).end()
230 async function blockUser (req: express.Request, res: express.Response) {
231 const user: UserModel = res.locals.user
232 const reason = req.body.reason
234 await changeUserBlock(res, user, true, reason)
236 return res.status(204).end()
239 function getUser (req: express.Request, res: express.Response) {
240 return res.json((res.locals.user as UserModel).toFormattedJSON())
243 async function autocompleteUsers (req: express.Request, res: express.Response) {
244 const resultList = await UserModel.autoComplete(req.query.search as string)
246 return res.json(resultList)
249 async function listUsers (req: express.Request, res: express.Response) {
250 const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort, req.query.search)
252 return res.json(getFormattedObjects(resultList.data, resultList.total))
255 async function removeUser (req: express.Request, res: express.Response) {
256 const user: UserModel = res.locals.user
260 auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
262 return res.sendStatus(204)
265 async function updateUser (req: express.Request, res: express.Response) {
266 const body: UserUpdate = req.body
267 const userToUpdate = res.locals.user as UserModel
268 const oldUserAuditView = new UserAuditView(userToUpdate.toFormattedJSON())
269 const roleChanged = body.role !== undefined && body.role !== userToUpdate.role
271 if (body.password !== undefined) userToUpdate.password = body.password
272 if (body.email !== undefined) userToUpdate.email = body.email
273 if (body.emailVerified !== undefined) userToUpdate.emailVerified = body.emailVerified
274 if (body.videoQuota !== undefined) userToUpdate.videoQuota = body.videoQuota
275 if (body.videoQuotaDaily !== undefined) userToUpdate.videoQuotaDaily = body.videoQuotaDaily
276 if (body.role !== undefined) userToUpdate.role = body.role
278 const user = await userToUpdate.save()
280 // Destroy user token to refresh rights
281 if (roleChanged || body.password !== undefined) await deleteUserToken(userToUpdate.id)
283 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)
285 // Don't need to send this update to followers, these attributes are not federated
287 return res.sendStatus(204)
290 async function askResetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
291 const user = res.locals.user as UserModel
293 const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
294 const url = CONFIG.WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
295 await Emailer.Instance.addPasswordResetEmailJob(user.email, url)
297 return res.status(204).end()
300 async function resetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
301 const user = res.locals.user as UserModel
302 user.password = req.body.password
306 return res.status(204).end()
309 async function sendVerifyUserEmail (user: UserModel) {
310 const verificationString = await Redis.Instance.setVerifyEmailVerificationString(user.id)
311 const url = CONFIG.WEBSERVER.URL + '/verify-account/email?userId=' + user.id + '&verificationString=' + verificationString
312 await Emailer.Instance.addVerifyEmailJob(user.email, url)
316 async function askSendVerifyUserEmail (req: express.Request, res: express.Response, next: express.NextFunction) {
317 const user = res.locals.user as UserModel
319 await sendVerifyUserEmail(user)
321 return res.status(204).end()
324 async function verifyUserEmail (req: express.Request, res: express.Response, next: express.NextFunction) {
325 const user = res.locals.user as UserModel
326 user.emailVerified = true
330 return res.status(204).end()
333 function success (req: express.Request, res: express.Response, next: express.NextFunction) {
337 async function changeUserBlock (res: express.Response, user: UserModel, block: boolean, reason?: string) {
338 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
341 user.blockedReason = reason || null
343 await sequelizeTypescript.transaction(async t => {
344 await deleteUserToken(user.id, t)
346 await user.save({ transaction: t })
349 await Emailer.Instance.addUserBlockJob(user, block, reason)
351 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)