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'
49 const auditLogger = auditLoggerFactory('users')
51 const loginRateLimiter = new RateLimit({
52 windowMs: RATES_LIMIT.LOGIN.WINDOW_MS,
53 max: RATES_LIMIT.LOGIN.MAX
56 const askSendEmailLimiter = new RateLimit({
57 windowMs: RATES_LIMIT.ASK_SEND_EMAIL.WINDOW_MS,
58 max: RATES_LIMIT.ASK_SEND_EMAIL.MAX
61 const usersRouter = express.Router()
62 usersRouter.use('/', myNotificationsRouter)
63 usersRouter.use('/', mySubscriptionsRouter)
64 usersRouter.use('/', myBlocklistRouter)
65 usersRouter.use('/', myVideosHistoryRouter)
66 usersRouter.use('/', myVideoPlaylistsRouter)
67 usersRouter.use('/', meRouter)
69 usersRouter.get('/autocomplete',
70 userAutocompleteValidator,
71 asyncMiddleware(autocompleteUsers)
76 ensureUserHasRight(UserRight.MANAGE_USERS),
81 asyncMiddleware(listUsers)
84 usersRouter.post('/:id/block',
86 ensureUserHasRight(UserRight.MANAGE_USERS),
87 asyncMiddleware(usersBlockingValidator),
88 asyncMiddleware(blockUser)
90 usersRouter.post('/:id/unblock',
92 ensureUserHasRight(UserRight.MANAGE_USERS),
93 asyncMiddleware(usersBlockingValidator),
94 asyncMiddleware(unblockUser)
97 usersRouter.get('/:id',
99 ensureUserHasRight(UserRight.MANAGE_USERS),
100 asyncMiddleware(usersGetValidator),
104 usersRouter.post('/',
106 ensureUserHasRight(UserRight.MANAGE_USERS),
107 asyncMiddleware(usersAddValidator),
108 asyncRetryTransactionMiddleware(createUser)
111 usersRouter.post('/register',
112 asyncMiddleware(ensureUserRegistrationAllowed),
113 ensureUserRegistrationAllowedForIP,
114 asyncMiddleware(usersRegisterValidator),
115 asyncRetryTransactionMiddleware(registerUser)
118 usersRouter.put('/:id',
120 ensureUserHasRight(UserRight.MANAGE_USERS),
121 asyncMiddleware(usersUpdateValidator),
122 asyncMiddleware(updateUser)
125 usersRouter.delete('/:id',
127 ensureUserHasRight(UserRight.MANAGE_USERS),
128 asyncMiddleware(usersRemoveValidator),
129 asyncMiddleware(removeUser)
132 usersRouter.post('/ask-reset-password',
133 asyncMiddleware(usersAskResetPasswordValidator),
134 asyncMiddleware(askResetUserPassword)
137 usersRouter.post('/:id/reset-password',
138 asyncMiddleware(usersResetPasswordValidator),
139 asyncMiddleware(resetUserPassword)
142 usersRouter.post('/ask-send-verify-email',
144 asyncMiddleware(usersAskSendVerifyEmailValidator),
145 asyncMiddleware(askSendVerifyUserEmail)
148 usersRouter.post('/:id/verify-email',
149 asyncMiddleware(usersVerifyEmailValidator),
150 asyncMiddleware(verifyUserEmail)
153 usersRouter.post('/token',
158 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
160 // ---------------------------------------------------------------------------
166 // ---------------------------------------------------------------------------
168 async function createUser (req: express.Request, res: express.Response) {
169 const body: UserCreate = req.body
170 const userToCreate = new UserModel({
171 username: body.username,
172 password: body.password,
174 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
177 videoQuota: body.videoQuota,
178 videoQuotaDaily: body.videoQuotaDaily
181 const { user, account } = await createUserAccountAndChannelAndPlaylist(userToCreate)
183 auditLogger.create(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
184 logger.info('User %s with its channel and account created.', body.username)
191 uuid: account.Actor.uuid
197 async function registerUser (req: express.Request, res: express.Response) {
198 const body: UserCreate = req.body
200 const userToCreate = new UserModel({
201 username: body.username,
202 password: body.password,
204 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
207 videoQuota: CONFIG.USER.VIDEO_QUOTA,
208 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY,
209 emailVerified: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION ? false : null
212 const { user } = await createUserAccountAndChannelAndPlaylist(userToCreate)
214 auditLogger.create(body.username, new UserAuditView(user.toFormattedJSON()))
215 logger.info('User %s with its channel and account registered.', body.username)
217 if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
218 await sendVerifyUserEmail(user)
221 Notifier.Instance.notifyOnNewUserRegistration(user)
223 return res.type('json').status(204).end()
226 async function unblockUser (req: express.Request, res: express.Response) {
227 const user = res.locals.user
229 await changeUserBlock(res, user, false)
231 return res.status(204).end()
234 async function blockUser (req: express.Request, res: express.Response) {
235 const user = res.locals.user
236 const reason = req.body.reason
238 await changeUserBlock(res, user, true, reason)
240 return res.status(204).end()
243 function getUser (req: express.Request, res: express.Response) {
244 return res.json(res.locals.user.toFormattedJSON())
247 async function autocompleteUsers (req: express.Request, res: express.Response) {
248 const resultList = await UserModel.autoComplete(req.query.search as string)
250 return res.json(resultList)
253 async function listUsers (req: express.Request, res: express.Response) {
254 const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort, req.query.search)
256 return res.json(getFormattedObjects(resultList.data, resultList.total))
259 async function removeUser (req: express.Request, res: express.Response) {
260 const user = res.locals.user
264 auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
266 return res.sendStatus(204)
269 async function updateUser (req: express.Request, res: express.Response) {
270 const body: UserUpdate = req.body
271 const userToUpdate = res.locals.user
272 const oldUserAuditView = new UserAuditView(userToUpdate.toFormattedJSON())
273 const roleChanged = body.role !== undefined && body.role !== userToUpdate.role
275 if (body.password !== undefined) userToUpdate.password = body.password
276 if (body.email !== undefined) userToUpdate.email = body.email
277 if (body.emailVerified !== undefined) userToUpdate.emailVerified = body.emailVerified
278 if (body.videoQuota !== undefined) userToUpdate.videoQuota = body.videoQuota
279 if (body.videoQuotaDaily !== undefined) userToUpdate.videoQuotaDaily = body.videoQuotaDaily
280 if (body.role !== undefined) userToUpdate.role = body.role
282 const user = await userToUpdate.save()
284 // Destroy user token to refresh rights
285 if (roleChanged || body.password !== undefined) await deleteUserToken(userToUpdate.id)
287 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)
289 // Don't need to send this update to followers, these attributes are not federated
291 return res.sendStatus(204)
294 async function askResetUserPassword (req: express.Request, res: express.Response) {
295 const user = res.locals.user
297 const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
298 const url = WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
299 await Emailer.Instance.addPasswordResetEmailJob(user.email, url)
301 return res.status(204).end()
304 async function resetUserPassword (req: express.Request, res: express.Response) {
305 const user = res.locals.user
306 user.password = req.body.password
310 return res.status(204).end()
313 async function sendVerifyUserEmail (user: UserModel) {
314 const verificationString = await Redis.Instance.setVerifyEmailVerificationString(user.id)
315 const url = WEBSERVER.URL + '/verify-account/email?userId=' + user.id + '&verificationString=' + verificationString
316 await Emailer.Instance.addVerifyEmailJob(user.email, url)
320 async function askSendVerifyUserEmail (req: express.Request, res: express.Response) {
321 const user = res.locals.user
323 await sendVerifyUserEmail(user)
325 return res.status(204).end()
328 async function verifyUserEmail (req: express.Request, res: express.Response) {
329 const user = res.locals.user
330 user.emailVerified = true
334 return res.status(204).end()
337 function success (req: express.Request, res: express.Response) {
341 async function changeUserBlock (res: express.Response, user: UserModel, block: boolean, reason?: string) {
342 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
345 user.blockedReason = reason || null
347 await sequelizeTypescript.transaction(async t => {
348 await deleteUserToken(user.id, t)
350 await user.save({ transaction: t })
353 await Emailer.Instance.addUserBlockJob(user, block, reason)
355 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)