123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412 |
- import express from 'express'
- import RateLimit from 'express-rate-limit'
- import { tokensRouter } from '@server/controllers/api/users/token'
- import { Hooks } from '@server/lib/plugins/hooks'
- import { OAuthTokenModel } from '@server/models/oauth/oauth-token'
- import { MUser, MUserAccountDefault } from '@server/types/models'
- import { UserCreate, UserCreateResult, UserRight, UserRole, UserUpdate } from '../../../../shared'
- import { HttpStatusCode } from '../../../../shared/models/http/http-error-codes'
- import { UserAdminFlag } from '../../../../shared/models/users/user-flag.model'
- import { UserRegister } from '../../../../shared/models/users/user-register.model'
- import { auditLoggerFactory, getAuditIdFromRes, UserAuditView } from '../../../helpers/audit-logger'
- import { logger } from '../../../helpers/logger'
- import { generateRandomString, getFormattedObjects } from '../../../helpers/utils'
- import { CONFIG } from '../../../initializers/config'
- import { WEBSERVER } from '../../../initializers/constants'
- import { sequelizeTypescript } from '../../../initializers/database'
- import { Emailer } from '../../../lib/emailer'
- import { Notifier } from '../../../lib/notifier'
- import { Redis } from '../../../lib/redis'
- import { createUserAccountAndChannelAndPlaylist, sendVerifyUserEmail } from '../../../lib/user'
- import {
- asyncMiddleware,
- asyncRetryTransactionMiddleware,
- authenticate,
- ensureUserHasRight,
- ensureUserRegistrationAllowed,
- ensureUserRegistrationAllowedForIP,
- paginationValidator,
- setDefaultPagination,
- setDefaultSort,
- userAutocompleteValidator,
- usersAddValidator,
- usersGetValidator,
- usersListValidator,
- usersRegisterValidator,
- usersRemoveValidator,
- usersSortValidator,
- usersUpdateValidator
- } from '../../../middlewares'
- import {
- ensureCanManageUser,
- usersAskResetPasswordValidator,
- usersAskSendVerifyEmailValidator,
- usersBlockingValidator,
- usersResetPasswordValidator,
- usersVerifyEmailValidator
- } from '../../../middlewares/validators'
- import { UserModel } from '../../../models/user/user'
- import { meRouter } from './me'
- import { myAbusesRouter } from './my-abuses'
- import { myBlocklistRouter } from './my-blocklist'
- import { myVideosHistoryRouter } from './my-history'
- import { myNotificationsRouter } from './my-notifications'
- import { mySubscriptionsRouter } from './my-subscriptions'
- import { myVideoPlaylistsRouter } from './my-video-playlists'
- const auditLogger = auditLoggerFactory('users')
- const signupRateLimiter = RateLimit({
- windowMs: CONFIG.RATES_LIMIT.SIGNUP.WINDOW_MS,
- max: CONFIG.RATES_LIMIT.SIGNUP.MAX,
- skipFailedRequests: true
- })
- const askSendEmailLimiter = RateLimit({
- windowMs: CONFIG.RATES_LIMIT.ASK_SEND_EMAIL.WINDOW_MS,
- max: CONFIG.RATES_LIMIT.ASK_SEND_EMAIL.MAX
- })
- const usersRouter = express.Router()
- usersRouter.use('/', tokensRouter)
- usersRouter.use('/', myNotificationsRouter)
- usersRouter.use('/', mySubscriptionsRouter)
- usersRouter.use('/', myBlocklistRouter)
- usersRouter.use('/', myVideosHistoryRouter)
- usersRouter.use('/', myVideoPlaylistsRouter)
- usersRouter.use('/', myAbusesRouter)
- usersRouter.use('/', meRouter)
- usersRouter.get('/autocomplete',
- userAutocompleteValidator,
- asyncMiddleware(autocompleteUsers)
- )
- usersRouter.get('/',
- authenticate,
- ensureUserHasRight(UserRight.MANAGE_USERS),
- paginationValidator,
- usersSortValidator,
- setDefaultSort,
- setDefaultPagination,
- usersListValidator,
- asyncMiddleware(listUsers)
- )
- usersRouter.post('/:id/block',
- authenticate,
- ensureUserHasRight(UserRight.MANAGE_USERS),
- asyncMiddleware(usersBlockingValidator),
- ensureCanManageUser,
- asyncMiddleware(blockUser)
- )
- usersRouter.post('/:id/unblock',
- authenticate,
- ensureUserHasRight(UserRight.MANAGE_USERS),
- asyncMiddleware(usersBlockingValidator),
- ensureCanManageUser,
- asyncMiddleware(unblockUser)
- )
- usersRouter.get('/:id',
- authenticate,
- ensureUserHasRight(UserRight.MANAGE_USERS),
- asyncMiddleware(usersGetValidator),
- getUser
- )
- usersRouter.post('/',
- authenticate,
- ensureUserHasRight(UserRight.MANAGE_USERS),
- asyncMiddleware(usersAddValidator),
- asyncRetryTransactionMiddleware(createUser)
- )
- usersRouter.post('/register',
- signupRateLimiter,
- asyncMiddleware(ensureUserRegistrationAllowed),
- ensureUserRegistrationAllowedForIP,
- asyncMiddleware(usersRegisterValidator),
- asyncRetryTransactionMiddleware(registerUser)
- )
- usersRouter.put('/:id',
- authenticate,
- ensureUserHasRight(UserRight.MANAGE_USERS),
- asyncMiddleware(usersUpdateValidator),
- ensureCanManageUser,
- asyncMiddleware(updateUser)
- )
- usersRouter.delete('/:id',
- authenticate,
- ensureUserHasRight(UserRight.MANAGE_USERS),
- asyncMiddleware(usersRemoveValidator),
- ensureCanManageUser,
- asyncMiddleware(removeUser)
- )
- usersRouter.post('/ask-reset-password',
- asyncMiddleware(usersAskResetPasswordValidator),
- asyncMiddleware(askResetUserPassword)
- )
- usersRouter.post('/:id/reset-password',
- asyncMiddleware(usersResetPasswordValidator),
- asyncMiddleware(resetUserPassword)
- )
- usersRouter.post('/ask-send-verify-email',
- askSendEmailLimiter,
- asyncMiddleware(usersAskSendVerifyEmailValidator),
- asyncMiddleware(reSendVerifyUserEmail)
- )
- usersRouter.post('/:id/verify-email',
- asyncMiddleware(usersVerifyEmailValidator),
- asyncMiddleware(verifyUserEmail)
- )
- // ---------------------------------------------------------------------------
- export {
- usersRouter
- }
- // ---------------------------------------------------------------------------
- async function createUser (req: express.Request, res: express.Response) {
- const body: UserCreate = req.body
- const userToCreate = new UserModel({
- username: body.username,
- password: body.password,
- email: body.email,
- nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
- autoPlayVideo: true,
- role: body.role,
- videoQuota: body.videoQuota,
- videoQuotaDaily: body.videoQuotaDaily,
- adminFlags: body.adminFlags || UserAdminFlag.NONE
- }) as MUser
- // NB: due to the validator usersAddValidator, password==='' can only be true if we can send the mail.
- const createPassword = userToCreate.password === ''
- if (createPassword) {
- userToCreate.password = await generateRandomString(20)
- }
- const { user, account, videoChannel } = await createUserAccountAndChannelAndPlaylist({
- userToCreate,
- channelNames: body.channelName && { name: body.channelName, displayName: body.channelName }
- })
- auditLogger.create(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
- logger.info('User %s with its channel and account created.', body.username)
- if (createPassword) {
- // this will send an email for newly created users, so then can set their first password.
- logger.info('Sending to user %s a create password email', body.username)
- const verificationString = await Redis.Instance.setCreatePasswordVerificationString(user.id)
- const url = WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
- await Emailer.Instance.addPasswordCreateEmailJob(userToCreate.username, user.email, url)
- }
- Hooks.runAction('action:api.user.created', { body, user, account, videoChannel })
- return res.json({
- user: {
- id: user.id,
- account: {
- id: account.id
- }
- } as UserCreateResult
- })
- }
- async function registerUser (req: express.Request, res: express.Response) {
- const body: UserRegister = req.body
- const userToCreate = new UserModel({
- username: body.username,
- password: body.password,
- email: body.email,
- nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
- autoPlayVideo: true,
- role: UserRole.USER,
- videoQuota: CONFIG.USER.VIDEO_QUOTA,
- videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY,
- emailVerified: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION ? false : null
- })
- const { user, account, videoChannel } = await createUserAccountAndChannelAndPlaylist({
- userToCreate: userToCreate,
- userDisplayName: body.displayName || undefined,
- channelNames: body.channel
- })
- auditLogger.create(body.username, new UserAuditView(user.toFormattedJSON()))
- logger.info('User %s with its channel and account registered.', body.username)
- if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
- await sendVerifyUserEmail(user)
- }
- Notifier.Instance.notifyOnNewUserRegistration(user)
- Hooks.runAction('action:api.user.registered', { body, user, account, videoChannel })
- return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end()
- }
- async function unblockUser (req: express.Request, res: express.Response) {
- const user = res.locals.user
- await changeUserBlock(res, user, false)
- Hooks.runAction('action:api.user.unblocked', { user })
- return res.status(HttpStatusCode.NO_CONTENT_204).end()
- }
- async function blockUser (req: express.Request, res: express.Response) {
- const user = res.locals.user
- const reason = req.body.reason
- await changeUserBlock(res, user, true, reason)
- Hooks.runAction('action:api.user.blocked', { user })
- return res.status(HttpStatusCode.NO_CONTENT_204).end()
- }
- function getUser (req: express.Request, res: express.Response) {
- return res.json(res.locals.user.toFormattedJSON({ withAdminFlags: true }))
- }
- async function autocompleteUsers (req: express.Request, res: express.Response) {
- const resultList = await UserModel.autoComplete(req.query.search as string)
- return res.json(resultList)
- }
- async function listUsers (req: express.Request, res: express.Response) {
- const resultList = await UserModel.listForApi({
- start: req.query.start,
- count: req.query.count,
- sort: req.query.sort,
- search: req.query.search,
- blocked: req.query.blocked
- })
- return res.json(getFormattedObjects(resultList.data, resultList.total, { withAdminFlags: true }))
- }
- async function removeUser (req: express.Request, res: express.Response) {
- const user = res.locals.user
- auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
- await sequelizeTypescript.transaction(async t => {
- // Use a transaction to avoid inconsistencies with hooks (account/channel deletion & federation)
- await user.destroy({ transaction: t })
- })
- Hooks.runAction('action:api.user.deleted', { user })
- return res.status(HttpStatusCode.NO_CONTENT_204).end()
- }
- async function updateUser (req: express.Request, res: express.Response) {
- const body: UserUpdate = req.body
- const userToUpdate = res.locals.user
- const oldUserAuditView = new UserAuditView(userToUpdate.toFormattedJSON())
- const roleChanged = body.role !== undefined && body.role !== userToUpdate.role
- const keysToUpdate: (keyof UserUpdate)[] = [
- 'password',
- 'email',
- 'emailVerified',
- 'videoQuota',
- 'videoQuotaDaily',
- 'role',
- 'adminFlags',
- 'pluginAuth'
- ]
- for (const key of keysToUpdate) {
- if (body[key] !== undefined) userToUpdate.set(key, body[key])
- }
- const user = await userToUpdate.save()
- // Destroy user token to refresh rights
- if (roleChanged || body.password !== undefined) await OAuthTokenModel.deleteUserToken(userToUpdate.id)
- auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)
- Hooks.runAction('action:api.user.updated', { user })
- // Don't need to send this update to followers, these attributes are not federated
- return res.status(HttpStatusCode.NO_CONTENT_204).end()
- }
- async function askResetUserPassword (req: express.Request, res: express.Response) {
- const user = res.locals.user
- const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
- const url = WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
- await Emailer.Instance.addPasswordResetEmailJob(user.username, user.email, url)
- return res.status(HttpStatusCode.NO_CONTENT_204).end()
- }
- async function resetUserPassword (req: express.Request, res: express.Response) {
- const user = res.locals.user
- user.password = req.body.password
- await user.save()
- await Redis.Instance.removePasswordVerificationString(user.id)
- return res.status(HttpStatusCode.NO_CONTENT_204).end()
- }
- async function reSendVerifyUserEmail (req: express.Request, res: express.Response) {
- const user = res.locals.user
- await sendVerifyUserEmail(user)
- return res.status(HttpStatusCode.NO_CONTENT_204).end()
- }
- async function verifyUserEmail (req: express.Request, res: express.Response) {
- const user = res.locals.user
- user.emailVerified = true
- if (req.body.isPendingEmail === true) {
- user.email = user.pendingEmail
- user.pendingEmail = null
- }
- await user.save()
- return res.status(HttpStatusCode.NO_CONTENT_204).end()
- }
- async function changeUserBlock (res: express.Response, user: MUserAccountDefault, block: boolean, reason?: string) {
- const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
- user.blocked = block
- user.blockedReason = reason || null
- await sequelizeTypescript.transaction(async t => {
- await OAuthTokenModel.deleteUserToken(user.id, t)
- await user.save({ transaction: t })
- })
- await Emailer.Instance.addUserBlockJob(user, block, reason)
- auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)
- }
|