1 import express from 'express'
2 import { tokensRouter } from '@server/controllers/api/users/token'
3 import { Hooks } from '@server/lib/plugins/hooks'
4 import { OAuthTokenModel } from '@server/models/oauth/oauth-token'
5 import { MUserAccountDefault } from '@server/types/models'
6 import { pick } from '@shared/core-utils'
7 import { HttpStatusCode, UserCreate, UserCreateResult, UserRight, UserUpdate } from '@shared/models'
8 import { auditLoggerFactory, getAuditIdFromRes, UserAuditView } from '../../../helpers/audit-logger'
9 import { logger } from '../../../helpers/logger'
10 import { generateRandomString, getFormattedObjects } from '../../../helpers/utils'
11 import { WEBSERVER } from '../../../initializers/constants'
12 import { sequelizeTypescript } from '../../../initializers/database'
13 import { Emailer } from '../../../lib/emailer'
14 import { Redis } from '../../../lib/redis'
15 import { buildUser, createUserAccountAndChannelAndPlaylist } from '../../../lib/user'
17 adminUsersSortValidator,
20 asyncRetryTransactionMiddleware,
26 userAutocompleteValidator,
32 } from '../../../middlewares'
34 ensureCanModerateUser,
35 usersAskResetPasswordValidator,
36 usersBlockingValidator,
37 usersResetPasswordValidator
38 } from '../../../middlewares/validators'
39 import { UserModel } from '../../../models/user/user'
40 import { emailVerificationRouter } from './email-verification'
41 import { meRouter } from './me'
42 import { myAbusesRouter } from './my-abuses'
43 import { myBlocklistRouter } from './my-blocklist'
44 import { myVideosHistoryRouter } from './my-history'
45 import { myNotificationsRouter } from './my-notifications'
46 import { mySubscriptionsRouter } from './my-subscriptions'
47 import { myVideoPlaylistsRouter } from './my-video-playlists'
48 import { registrationsRouter } from './registrations'
49 import { twoFactorRouter } from './two-factor'
51 const auditLogger = auditLoggerFactory('users')
53 const usersRouter = express.Router()
55 usersRouter.use(apiRateLimiter)
57 usersRouter.use('/', emailVerificationRouter)
58 usersRouter.use('/', registrationsRouter)
59 usersRouter.use('/', twoFactorRouter)
60 usersRouter.use('/', tokensRouter)
61 usersRouter.use('/', myNotificationsRouter)
62 usersRouter.use('/', mySubscriptionsRouter)
63 usersRouter.use('/', myBlocklistRouter)
64 usersRouter.use('/', myVideosHistoryRouter)
65 usersRouter.use('/', myVideoPlaylistsRouter)
66 usersRouter.use('/', myAbusesRouter)
67 usersRouter.use('/', meRouter)
69 usersRouter.get('/autocomplete',
70 userAutocompleteValidator,
71 asyncMiddleware(autocompleteUsers)
76 ensureUserHasRight(UserRight.MANAGE_USERS),
78 adminUsersSortValidator,
82 asyncMiddleware(listUsers)
85 usersRouter.post('/:id/block',
87 ensureUserHasRight(UserRight.MANAGE_USERS),
88 asyncMiddleware(usersBlockingValidator),
89 ensureCanModerateUser,
90 asyncMiddleware(blockUser)
92 usersRouter.post('/:id/unblock',
94 ensureUserHasRight(UserRight.MANAGE_USERS),
95 asyncMiddleware(usersBlockingValidator),
96 ensureCanModerateUser,
97 asyncMiddleware(unblockUser)
100 usersRouter.get('/:id',
102 ensureUserHasRight(UserRight.MANAGE_USERS),
103 asyncMiddleware(usersGetValidator),
107 usersRouter.post('/',
109 ensureUserHasRight(UserRight.MANAGE_USERS),
110 asyncMiddleware(usersAddValidator),
111 asyncRetryTransactionMiddleware(createUser)
114 usersRouter.put('/:id',
116 ensureUserHasRight(UserRight.MANAGE_USERS),
117 asyncMiddleware(usersUpdateValidator),
118 ensureCanModerateUser,
119 asyncMiddleware(updateUser)
122 usersRouter.delete('/:id',
124 ensureUserHasRight(UserRight.MANAGE_USERS),
125 asyncMiddleware(usersRemoveValidator),
126 ensureCanModerateUser,
127 asyncMiddleware(removeUser)
130 usersRouter.post('/ask-reset-password',
131 asyncMiddleware(usersAskResetPasswordValidator),
132 asyncMiddleware(askResetUserPassword)
135 usersRouter.post('/:id/reset-password',
136 asyncMiddleware(usersResetPasswordValidator),
137 asyncMiddleware(resetUserPassword)
140 // ---------------------------------------------------------------------------
146 // ---------------------------------------------------------------------------
148 async function createUser (req: express.Request, res: express.Response) {
149 const body: UserCreate = req.body
151 const userToCreate = buildUser({
152 ...pick(body, [ 'username', 'password', 'email', 'role', 'videoQuota', 'videoQuotaDaily', 'adminFlags' ]),
157 // NB: due to the validator usersAddValidator, password==='' can only be true if we can send the mail.
158 const createPassword = userToCreate.password === ''
159 if (createPassword) {
160 userToCreate.password = await generateRandomString(20)
163 const { user, account, videoChannel } = await createUserAccountAndChannelAndPlaylist({
165 channelNames: body.channelName && { name: body.channelName, displayName: body.channelName }
168 auditLogger.create(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
169 logger.info('User %s with its channel and account created.', body.username)
171 if (createPassword) {
172 // this will send an email for newly created users, so then can set their first password.
173 logger.info('Sending to user %s a create password email', body.username)
174 const verificationString = await Redis.Instance.setCreatePasswordVerificationString(user.id)
175 const url = WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
176 Emailer.Instance.addPasswordCreateEmailJob(userToCreate.username, user.email, url)
179 Hooks.runAction('action:api.user.created', { body, user, account, videoChannel, req, res })
187 } as UserCreateResult
191 async function unblockUser (req: express.Request, res: express.Response) {
192 const user = res.locals.user
194 await changeUserBlock(res, user, false)
196 Hooks.runAction('action:api.user.unblocked', { user, req, res })
198 return res.status(HttpStatusCode.NO_CONTENT_204).end()
201 async function blockUser (req: express.Request, res: express.Response) {
202 const user = res.locals.user
203 const reason = req.body.reason
205 await changeUserBlock(res, user, true, reason)
207 Hooks.runAction('action:api.user.blocked', { user, req, res })
209 return res.status(HttpStatusCode.NO_CONTENT_204).end()
212 function getUser (req: express.Request, res: express.Response) {
213 return res.json(res.locals.user.toFormattedJSON({ withAdminFlags: true }))
216 async function autocompleteUsers (req: express.Request, res: express.Response) {
217 const resultList = await UserModel.autoComplete(req.query.search as string)
219 return res.json(resultList)
222 async function listUsers (req: express.Request, res: express.Response) {
223 const resultList = await UserModel.listForAdminApi({
224 start: req.query.start,
225 count: req.query.count,
226 sort: req.query.sort,
227 search: req.query.search,
228 blocked: req.query.blocked
231 return res.json(getFormattedObjects(resultList.data, resultList.total, { withAdminFlags: true }))
234 async function removeUser (req: express.Request, res: express.Response) {
235 const user = res.locals.user
237 auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
239 await sequelizeTypescript.transaction(async t => {
240 // Use a transaction to avoid inconsistencies with hooks (account/channel deletion & federation)
241 await user.destroy({ transaction: t })
244 Hooks.runAction('action:api.user.deleted', { user, req, res })
246 return res.status(HttpStatusCode.NO_CONTENT_204).end()
249 async function updateUser (req: express.Request, res: express.Response) {
250 const body: UserUpdate = req.body
251 const userToUpdate = res.locals.user
252 const oldUserAuditView = new UserAuditView(userToUpdate.toFormattedJSON())
253 const roleChanged = body.role !== undefined && body.role !== userToUpdate.role
255 const keysToUpdate: (keyof UserUpdate)[] = [
266 for (const key of keysToUpdate) {
267 if (body[key] !== undefined) userToUpdate.set(key, body[key])
270 const user = await userToUpdate.save()
272 // Destroy user token to refresh rights
273 if (roleChanged || body.password !== undefined) await OAuthTokenModel.deleteUserToken(userToUpdate.id)
275 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)
277 Hooks.runAction('action:api.user.updated', { user, req, res })
279 // Don't need to send this update to followers, these attributes are not federated
281 return res.status(HttpStatusCode.NO_CONTENT_204).end()
284 async function askResetUserPassword (req: express.Request, res: express.Response) {
285 const user = res.locals.user
287 const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
288 const url = WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
289 Emailer.Instance.addPasswordResetEmailJob(user.username, user.email, url)
291 return res.status(HttpStatusCode.NO_CONTENT_204).end()
294 async function resetUserPassword (req: express.Request, res: express.Response) {
295 const user = res.locals.user
296 user.password = req.body.password
299 await Redis.Instance.removePasswordVerificationString(user.id)
301 return res.status(HttpStatusCode.NO_CONTENT_204).end()
304 async function changeUserBlock (res: express.Response, user: MUserAccountDefault, block: boolean, reason?: string) {
305 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
308 user.blockedReason = reason || null
310 await sequelizeTypescript.transaction(async t => {
311 await OAuthTokenModel.deleteUserToken(user.id, t)
313 await user.save({ transaction: t })
316 Emailer.Instance.addUserBlockJob(user, block, reason)
318 auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)