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, 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
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 // FIXME: https://github.com/nfriedly/express-rate-limit/issues/138
55 const loginRateLimiter = RateLimit({
56 windowMs: RATES_LIMIT.LOGIN.WINDOW_MS,
57 max: RATES_LIMIT.LOGIN.MAX
61 const askSendEmailLimiter = new RateLimit({
62 windowMs: RATES_LIMIT.ASK_SEND_EMAIL.WINDOW_MS,
63 max: RATES_LIMIT.ASK_SEND_EMAIL.MAX
66 const usersRouter = express.Router()
67 usersRouter.use('/', myNotificationsRouter)
68 usersRouter.use('/', mySubscriptionsRouter)
69 usersRouter.use('/', myBlocklistRouter)
70 usersRouter.use('/', myVideosHistoryRouter)
71 usersRouter.use('/', myVideoPlaylistsRouter)
72 usersRouter.use('/', meRouter)
74 usersRouter.get('/autocomplete',
75 userAutocompleteValidator,
76 asyncMiddleware(autocompleteUsers)
81 ensureUserHasRight(UserRight.MANAGE_USERS),
86 asyncMiddleware(listUsers)
89 usersRouter.post('/:id/block',
91 ensureUserHasRight(UserRight.MANAGE_USERS),
92 asyncMiddleware(usersBlockingValidator),
93 asyncMiddleware(blockUser)
95 usersRouter.post('/:id/unblock',
97 ensureUserHasRight(UserRight.MANAGE_USERS),
98 asyncMiddleware(usersBlockingValidator),
99 asyncMiddleware(unblockUser)
102 usersRouter.get('/:id',
104 ensureUserHasRight(UserRight.MANAGE_USERS),
105 asyncMiddleware(usersGetValidator),
109 usersRouter.post('/',
111 ensureUserHasRight(UserRight.MANAGE_USERS),
112 asyncMiddleware(usersAddValidator),
113 asyncRetryTransactionMiddleware(createUser)
116 usersRouter.post('/register',
117 asyncMiddleware(ensureUserRegistrationAllowed),
118 ensureUserRegistrationAllowedForIP,
119 asyncMiddleware(usersRegisterValidator),
120 asyncRetryTransactionMiddleware(registerUser)
123 usersRouter.put('/:id',
125 ensureUserHasRight(UserRight.MANAGE_USERS),
126 asyncMiddleware(usersUpdateValidator),
127 asyncMiddleware(updateUser)
130 usersRouter.delete('/:id',
132 ensureUserHasRight(UserRight.MANAGE_USERS),
133 asyncMiddleware(usersRemoveValidator),
134 asyncMiddleware(removeUser)
137 usersRouter.post('/ask-reset-password',
138 asyncMiddleware(usersAskResetPasswordValidator),
139 asyncMiddleware(askResetUserPassword)
142 usersRouter.post('/:id/reset-password',
143 asyncMiddleware(usersResetPasswordValidator),
144 asyncMiddleware(resetUserPassword)
147 usersRouter.post('/ask-send-verify-email',
149 asyncMiddleware(usersAskSendVerifyEmailValidator),
150 asyncMiddleware(reSendVerifyUserEmail)
153 usersRouter.post('/:id/verify-email',
154 asyncMiddleware(usersVerifyEmailValidator),
155 asyncMiddleware(verifyUserEmail)
158 usersRouter.post('/token',
163 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
165 // ---------------------------------------------------------------------------
171 // ---------------------------------------------------------------------------
173 async function createUser (req: express.Request, res: express.Response) {
174 const body: UserCreate = req.body
175 const userToCreate = new UserModel({
176 username: body.username,
177 password: body.password,
179 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
182 videoQuota: body.videoQuota,
183 videoQuotaDaily: body.videoQuotaDaily,
184 adminFlags: body.adminFlags || UserAdminFlag.NONE
187 const { user, account } = await createUserAccountAndChannelAndPlaylist({ userToCreate: userToCreate })
189 auditLogger.create(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
190 logger.info('User %s with its channel and account created.', body.username)
202 async function registerUser (req: express.Request, res: express.Response) {
203 const body: UserRegister = req.body
205 const userToCreate = new UserModel({
206 username: body.username,
207 password: body.password,
209 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
212 videoQuota: CONFIG.USER.VIDEO_QUOTA,
213 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY,
214 emailVerified: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION ? false : null
217 const { user } = await createUserAccountAndChannelAndPlaylist({
218 userToCreate: userToCreate,
219 userDisplayName: body.displayName || undefined,
220 channelNames: body.channel
223 auditLogger.create(body.username, new UserAuditView(user.toFormattedJSON()))
224 logger.info('User %s with its channel and account registered.', body.username)
226 if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
227 await sendVerifyUserEmail(user)
230 Notifier.Instance.notifyOnNewUserRegistration(user)
232 return res.type('json').status(204).end()
235 async function unblockUser (req: express.Request, res: express.Response) {
236 const user = res.locals.user
238 await changeUserBlock(res, user, false)
240 return res.status(204).end()
243 async function blockUser (req: express.Request, res: express.Response) {
244 const user = res.locals.user
245 const reason = req.body.reason
247 await changeUserBlock(res, user, true, reason)
249 return res.status(204).end()
252 function getUser (req: express.Request, res: express.Response) {
253 return res.json(res.locals.user.toFormattedJSON({ withAdminFlags: true }))
256 async function autocompleteUsers (req: express.Request, res: express.Response) {
257 const resultList = await UserModel.autoComplete(req.query.search as string)
259 return res.json(resultList)
262 async function listUsers (req: express.Request, res: express.Response) {
263 const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort, req.query.search)
265 return res.json(getFormattedObjects(resultList.data, resultList.total, { withAdminFlags: true }))
268 async function removeUser (req: express.Request, res: express.Response) {
269 const user = res.locals.user
273 auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
275 return res.sendStatus(204)
278 async function updateUser (req: express.Request, res: express.Response) {
279 const body: UserUpdate = req.body
280 const userToUpdate = res.locals.user
281 const oldUserAuditView = new UserAuditView(userToUpdate.toFormattedJSON())
282 const roleChanged = body.role !== undefined && body.role !== userToUpdate.role
284 if (body.password !== undefined) userToUpdate.password = body.password
285 if (body.email !== undefined) userToUpdate.email = body.email
286 if (body.emailVerified !== undefined) userToUpdate.emailVerified = body.emailVerified
287 if (body.videoQuota !== undefined) userToUpdate.videoQuota = body.videoQuota
288 if (body.videoQuotaDaily !== undefined) userToUpdate.videoQuotaDaily = body.videoQuotaDaily
289 if (body.role !== undefined) userToUpdate.role = body.role
290 if (body.adminFlags !== undefined) userToUpdate.adminFlags = body.adminFlags
292 const user = await userToUpdate.save()
294 // Destroy user token to refresh rights
295 if (roleChanged || body.password !== undefined) await deleteUserToken(userToUpdate.id)
297 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)
299 // Don't need to send this update to followers, these attributes are not federated
301 return res.sendStatus(204)
304 async function askResetUserPassword (req: express.Request, res: express.Response) {
305 const user = res.locals.user
307 const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
308 const url = WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
309 await Emailer.Instance.addPasswordResetEmailJob(user.email, url)
311 return res.status(204).end()
314 async function resetUserPassword (req: express.Request, res: express.Response) {
315 const user = res.locals.user
316 user.password = req.body.password
320 return res.status(204).end()
323 async function reSendVerifyUserEmail (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
335 if (req.body.isPendingEmail === true) {
336 user.email = user.pendingEmail
337 user.pendingEmail = null
342 return res.status(204).end()
345 function success (req: express.Request, res: express.Response) {
349 async function changeUserBlock (res: express.Response, user: UserModel, block: boolean, reason?: string) {
350 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
353 user.blockedReason = reason || null
355 await sequelizeTypescript.transaction(async t => {
356 await deleteUserToken(user.id, t)
358 await user.save({ transaction: t })
361 await Emailer.Instance.addUserBlockJob(user, block, reason)
363 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)