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 { 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,
36 } from '../../../middlewares/validators'
37 import { UserModel } from '../../../models/account/user'
38 import { auditLoggerFactory, getAuditIdFromRes, UserAuditView } from '../../../helpers/audit-logger'
39 import { meRouter } from './me'
40 import { deleteUserToken } from '../../../lib/oauth-model'
41 import { myBlocklistRouter } from './my-blocklist'
42 import { myVideoPlaylistsRouter } from './my-video-playlists'
43 import { myVideosHistoryRouter } from './my-history'
44 import { myNotificationsRouter } from './my-notifications'
45 import { Notifier } from '../../../lib/notifier'
46 import { mySubscriptionsRouter } from './my-subscriptions'
47 import { CONFIG } from '../../../initializers/config'
48 import { sequelizeTypescript } from '../../../initializers/database'
49 import { UserAdminFlag } from '../../../../shared/models/users/user-flag.model'
50 import { UserRegister } from '../../../../shared/models/users/user-register.model'
51 import { MUser, MUserAccountDefault } from '@server/typings/models'
52 import { Hooks } from '@server/lib/plugins/hooks'
54 const auditLogger = auditLoggerFactory('users')
56 // FIXME: https://github.com/nfriedly/express-rate-limit/issues/138
58 const loginRateLimiter = RateLimit({
59 windowMs: CONFIG.RATES_LIMIT.LOGIN.WINDOW_MS,
60 max: CONFIG.RATES_LIMIT.LOGIN.MAX
64 const signupRateLimiter = RateLimit({
65 windowMs: CONFIG.RATES_LIMIT.SIGNUP.WINDOW_MS,
66 max: CONFIG.RATES_LIMIT.SIGNUP.MAX,
67 skipFailedRequests: true
71 const askSendEmailLimiter = new RateLimit({
72 windowMs: CONFIG.RATES_LIMIT.ASK_SEND_EMAIL.WINDOW_MS,
73 max: CONFIG.RATES_LIMIT.ASK_SEND_EMAIL.MAX
76 const usersRouter = express.Router()
77 usersRouter.use('/', myNotificationsRouter)
78 usersRouter.use('/', mySubscriptionsRouter)
79 usersRouter.use('/', myBlocklistRouter)
80 usersRouter.use('/', myVideosHistoryRouter)
81 usersRouter.use('/', myVideoPlaylistsRouter)
82 usersRouter.use('/', meRouter)
84 usersRouter.get('/autocomplete',
85 userAutocompleteValidator,
86 asyncMiddleware(autocompleteUsers)
91 ensureUserHasRight(UserRight.MANAGE_USERS),
96 asyncMiddleware(listUsers)
99 usersRouter.post('/:id/block',
101 ensureUserHasRight(UserRight.MANAGE_USERS),
102 asyncMiddleware(usersBlockingValidator),
104 asyncMiddleware(blockUser)
106 usersRouter.post('/:id/unblock',
108 ensureUserHasRight(UserRight.MANAGE_USERS),
109 asyncMiddleware(usersBlockingValidator),
111 asyncMiddleware(unblockUser)
114 usersRouter.get('/:id',
116 ensureUserHasRight(UserRight.MANAGE_USERS),
117 asyncMiddleware(usersGetValidator),
121 usersRouter.post('/',
123 ensureUserHasRight(UserRight.MANAGE_USERS),
124 asyncMiddleware(usersAddValidator),
125 asyncRetryTransactionMiddleware(createUser)
128 usersRouter.post('/register',
130 asyncMiddleware(ensureUserRegistrationAllowed),
131 ensureUserRegistrationAllowedForIP,
132 asyncMiddleware(usersRegisterValidator),
133 asyncRetryTransactionMiddleware(registerUser)
136 usersRouter.put('/:id',
138 ensureUserHasRight(UserRight.MANAGE_USERS),
139 asyncMiddleware(usersUpdateValidator),
141 asyncMiddleware(updateUser)
144 usersRouter.delete('/:id',
146 ensureUserHasRight(UserRight.MANAGE_USERS),
147 asyncMiddleware(usersRemoveValidator),
149 asyncMiddleware(removeUser)
152 usersRouter.post('/ask-reset-password',
153 asyncMiddleware(usersAskResetPasswordValidator),
154 asyncMiddleware(askResetUserPassword)
157 usersRouter.post('/:id/reset-password',
158 asyncMiddleware(usersResetPasswordValidator),
159 asyncMiddleware(resetUserPassword)
162 usersRouter.post('/ask-send-verify-email',
164 asyncMiddleware(usersAskSendVerifyEmailValidator),
165 asyncMiddleware(reSendVerifyUserEmail)
168 usersRouter.post('/:id/verify-email',
169 asyncMiddleware(usersVerifyEmailValidator),
170 asyncMiddleware(verifyUserEmail)
173 usersRouter.post('/token',
178 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
180 // ---------------------------------------------------------------------------
186 // ---------------------------------------------------------------------------
188 async function createUser (req: express.Request, res: express.Response) {
189 const body: UserCreate = req.body
190 const userToCreate = new UserModel({
191 username: body.username,
192 password: body.password,
194 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
197 videoQuota: body.videoQuota,
198 videoQuotaDaily: body.videoQuotaDaily,
199 adminFlags: body.adminFlags || UserAdminFlag.NONE
202 const { user, account, videoChannel } = await createUserAccountAndChannelAndPlaylist({ userToCreate: userToCreate })
204 auditLogger.create(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
205 logger.info('User %s with its channel and account created.', body.username)
207 Hooks.runAction('action:api.user.created', { body, user, account, videoChannel })
219 async function registerUser (req: express.Request, res: express.Response) {
220 const body: UserRegister = req.body
222 const userToCreate = new UserModel({
223 username: body.username,
224 password: body.password,
226 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
229 videoQuota: CONFIG.USER.VIDEO_QUOTA,
230 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY,
231 emailVerified: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION ? false : null
234 const { user, account, videoChannel } = await createUserAccountAndChannelAndPlaylist({
235 userToCreate: userToCreate,
236 userDisplayName: body.displayName || undefined,
237 channelNames: body.channel
240 auditLogger.create(body.username, new UserAuditView(user.toFormattedJSON()))
241 logger.info('User %s with its channel and account registered.', body.username)
243 if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
244 await sendVerifyUserEmail(user)
247 Notifier.Instance.notifyOnNewUserRegistration(user)
249 Hooks.runAction('action:api.user.registered', { body, user, account, videoChannel })
251 return res.type('json').status(204).end()
254 async function unblockUser (req: express.Request, res: express.Response) {
255 const user = res.locals.user
257 await changeUserBlock(res, user, false)
259 Hooks.runAction('action:api.user.unblocked', { user })
261 return res.status(204).end()
264 async function blockUser (req: express.Request, res: express.Response) {
265 const user = res.locals.user
266 const reason = req.body.reason
268 await changeUserBlock(res, user, true, reason)
270 Hooks.runAction('action:api.user.blocked', { user })
272 return res.status(204).end()
275 function getUser (req: express.Request, res: express.Response) {
276 return res.json(res.locals.user.toFormattedJSON({ withAdminFlags: true }))
279 async function autocompleteUsers (req: express.Request, res: express.Response) {
280 const resultList = await UserModel.autoComplete(req.query.search as string)
282 return res.json(resultList)
285 async function listUsers (req: express.Request, res: express.Response) {
286 const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort, req.query.search)
288 return res.json(getFormattedObjects(resultList.data, resultList.total, { withAdminFlags: true }))
291 async function removeUser (req: express.Request, res: express.Response) {
292 const user = res.locals.user
296 auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
298 Hooks.runAction('action:api.user.deleted', { user })
300 return res.sendStatus(204)
303 async function updateUser (req: express.Request, res: express.Response) {
304 const body: UserUpdate = req.body
305 const userToUpdate = res.locals.user
306 const oldUserAuditView = new UserAuditView(userToUpdate.toFormattedJSON())
307 const roleChanged = body.role !== undefined && body.role !== userToUpdate.role
309 if (body.password !== undefined) userToUpdate.password = body.password
310 if (body.email !== undefined) userToUpdate.email = body.email
311 if (body.emailVerified !== undefined) userToUpdate.emailVerified = body.emailVerified
312 if (body.videoQuota !== undefined) userToUpdate.videoQuota = body.videoQuota
313 if (body.videoQuotaDaily !== undefined) userToUpdate.videoQuotaDaily = body.videoQuotaDaily
314 if (body.role !== undefined) userToUpdate.role = body.role
315 if (body.adminFlags !== undefined) userToUpdate.adminFlags = body.adminFlags
317 const user = await userToUpdate.save()
319 // Destroy user token to refresh rights
320 if (roleChanged || body.password !== undefined) await deleteUserToken(userToUpdate.id)
322 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)
324 Hooks.runAction('action:api.user.updated', { user })
326 // Don't need to send this update to followers, these attributes are not federated
328 return res.sendStatus(204)
331 async function askResetUserPassword (req: express.Request, res: express.Response) {
332 const user = res.locals.user
334 const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
335 const url = WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
336 await Emailer.Instance.addPasswordResetEmailJob(user.email, url)
338 return res.status(204).end()
341 async function resetUserPassword (req: express.Request, res: express.Response) {
342 const user = res.locals.user
343 user.password = req.body.password
347 return res.status(204).end()
350 async function reSendVerifyUserEmail (req: express.Request, res: express.Response) {
351 const user = res.locals.user
353 await sendVerifyUserEmail(user)
355 return res.status(204).end()
358 async function verifyUserEmail (req: express.Request, res: express.Response) {
359 const user = res.locals.user
360 user.emailVerified = true
362 if (req.body.isPendingEmail === true) {
363 user.email = user.pendingEmail
364 user.pendingEmail = null
369 return res.status(204).end()
372 function tokenSuccess (req: express.Request) {
373 const username = req.body.username
375 Hooks.runAction('action:api.user.oauth2-got-token', { username, ip: req.ip })
378 async function changeUserBlock (res: express.Response, user: MUserAccountDefault, block: boolean, reason?: string) {
379 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
382 user.blockedReason = reason || null
384 await sequelizeTypescript.transaction(async t => {
385 await deleteUserToken(user.id, t)
387 await user.save({ transaction: t })
390 await Emailer.Instance.addUserBlockJob(user, block, reason)
392 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)