X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fcontrollers%2Fapi%2Fusers%2Findex.ts;h=869f31d848ce739175d5288d3a02d1aaa52fabd0;hb=3d215dc5f978b58b8a6d0154c3feae27f13f1600;hp=c1d72087cc3a5508fa0f300f9c80c38c6b7b2231;hpb=b6a1dd4d1b3b0032f8b968e72cbd074f646e8827;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/controllers/api/users/index.ts b/server/controllers/api/users/index.ts index c1d72087c..869f31d84 100644 --- a/server/controllers/api/users/index.ts +++ b/server/controllers/api/users/index.ts @@ -1,10 +1,20 @@ import * as express from 'express' import * as RateLimit from 'express-rate-limit' +import { tokensRouter } from '@server/controllers/api/users/token' +import { Hooks } from '@server/lib/plugins/hooks' +import { MUser, MUserAccountDefault } from '@server/types/models' import { UserCreate, UserRight, UserRole, UserUpdate } from '../../../../shared' +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 { getFormattedObjects } from '../../../helpers/utils' -import { RATES_LIMIT, WEBSERVER } from '../../../initializers/constants' +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 { deleteUserToken } from '../../../lib/oauth-model' import { Redis } from '../../../lib/redis' import { createUserAccountAndChannelAndPlaylist, sendVerifyUserEmail } from '../../../lib/user' import { @@ -17,16 +27,17 @@ import { paginationValidator, setDefaultPagination, setDefaultSort, - token, userAutocompleteValidator, usersAddValidator, usersGetValidator, + usersListValidator, usersRegisterValidator, usersRemoveValidator, usersSortValidator, usersUpdateValidator } from '../../../middlewares' import { + ensureCanManageUser, usersAskResetPasswordValidator, usersAskSendVerifyEmailValidator, usersBlockingValidator, @@ -34,41 +45,35 @@ import { usersVerifyEmailValidator } from '../../../middlewares/validators' import { UserModel } from '../../../models/account/user' -import { auditLoggerFactory, getAuditIdFromRes, UserAuditView } from '../../../helpers/audit-logger' import { meRouter } from './me' -import { deleteUserToken } from '../../../lib/oauth-model' +import { myAbusesRouter } from './my-abuses' import { myBlocklistRouter } from './my-blocklist' -import { myVideoPlaylistsRouter } from './my-video-playlists' import { myVideosHistoryRouter } from './my-history' import { myNotificationsRouter } from './my-notifications' -import { Notifier } from '../../../lib/notifier' import { mySubscriptionsRouter } from './my-subscriptions' -import { CONFIG } from '../../../initializers/config' -import { sequelizeTypescript } from '../../../initializers/database' -import { UserAdminFlag } from '../../../../shared/models/users/user-flag.model' -import { UserRegister } from '../../../../shared/models/users/user-register.model' +import { myVideoPlaylistsRouter } from './my-video-playlists' const auditLogger = auditLoggerFactory('users') -// FIXME: https://github.com/nfriedly/express-rate-limit/issues/138 -// @ts-ignore -const loginRateLimiter = RateLimit({ - windowMs: RATES_LIMIT.LOGIN.WINDOW_MS, - max: RATES_LIMIT.LOGIN.MAX +const signupRateLimiter = RateLimit({ + windowMs: CONFIG.RATES_LIMIT.SIGNUP.WINDOW_MS, + max: CONFIG.RATES_LIMIT.SIGNUP.MAX, + skipFailedRequests: true }) -// @ts-ignore -const askSendEmailLimiter = new RateLimit({ - windowMs: RATES_LIMIT.ASK_SEND_EMAIL.WINDOW_MS, - max: RATES_LIMIT.ASK_SEND_EMAIL.MAX +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', @@ -83,6 +88,7 @@ usersRouter.get('/', usersSortValidator, setDefaultSort, setDefaultPagination, + usersListValidator, asyncMiddleware(listUsers) ) @@ -90,12 +96,14 @@ 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) ) @@ -114,6 +122,7 @@ usersRouter.post('/', ) usersRouter.post('/register', + signupRateLimiter, asyncMiddleware(ensureUserRegistrationAllowed), ensureUserRegistrationAllowedForIP, asyncMiddleware(usersRegisterValidator), @@ -124,6 +133,7 @@ usersRouter.put('/:id', authenticate, ensureUserHasRight(UserRight.MANAGE_USERS), asyncMiddleware(usersUpdateValidator), + ensureCanManageUser, asyncMiddleware(updateUser) ) @@ -131,6 +141,7 @@ usersRouter.delete('/:id', authenticate, ensureUserHasRight(UserRight.MANAGE_USERS), asyncMiddleware(usersRemoveValidator), + ensureCanManageUser, asyncMiddleware(removeUser) ) @@ -155,13 +166,6 @@ usersRouter.post('/:id/verify-email', asyncMiddleware(verifyUserEmail) ) -usersRouter.post('/token', - loginRateLimiter, - token, - success -) -// TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route - // --------------------------------------------------------------------------- export { @@ -172,6 +176,7 @@ export { async function createUser (req: express.Request, res: express.Response) { const body: UserCreate = req.body + const userToCreate = new UserModel({ username: body.username, password: body.password, @@ -182,13 +187,32 @@ async function createUser (req: express.Request, res: express.Response) { videoQuota: body.videoQuota, videoQuotaDaily: body.videoQuotaDaily, adminFlags: body.adminFlags || UserAdminFlag.NONE - }) + }) as MUser - const { user, account } = await createUserAccountAndChannelAndPlaylist({ userToCreate: userToCreate }) + // 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: { 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, @@ -214,7 +238,7 @@ async function registerUser (req: express.Request, res: express.Response) { emailVerified: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION ? false : null }) - const { user } = await createUserAccountAndChannelAndPlaylist({ + const { user, account, videoChannel } = await createUserAccountAndChannelAndPlaylist({ userToCreate: userToCreate, userDisplayName: body.displayName || undefined, channelNames: body.channel @@ -229,6 +253,8 @@ async function registerUser (req: express.Request, res: express.Response) { Notifier.Instance.notifyOnNewUserRegistration(user) + Hooks.runAction('action:api.user.registered', { body, user, account, videoChannel }) + return res.type('json').status(204).end() } @@ -237,6 +263,8 @@ async function unblockUser (req: express.Request, res: express.Response) { await changeUserBlock(res, user, false) + Hooks.runAction('action:api.user.unblocked', { user }) + return res.status(204).end() } @@ -246,6 +274,8 @@ async function blockUser (req: express.Request, res: express.Response) { await changeUserBlock(res, user, true, reason) + Hooks.runAction('action:api.user.blocked', { user }) + return res.status(204).end() } @@ -260,7 +290,13 @@ async function autocompleteUsers (req: express.Request, res: express.Response) { } async function listUsers (req: express.Request, res: express.Response) { - const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort, req.query.search) + 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 })) } @@ -272,6 +308,8 @@ async function removeUser (req: express.Request, res: express.Response) { auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON())) + Hooks.runAction('action:api.user.deleted', { user }) + return res.sendStatus(204) } @@ -296,6 +334,8 @@ async function updateUser (req: express.Request, res: express.Response) { 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.sendStatus(204) @@ -306,7 +346,7 @@ async function askResetUserPassword (req: express.Request, res: express.Response const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id) const url = WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString - await Emailer.Instance.addPasswordResetEmailJob(user.email, url) + await Emailer.Instance.addPasswordResetEmailJob(user.username, user.email, url) return res.status(204).end() } @@ -342,11 +382,7 @@ async function verifyUserEmail (req: express.Request, res: express.Response) { return res.status(204).end() } -function success (req: express.Request, res: express.Response) { - res.end() -} - -async function changeUserBlock (res: express.Response, user: UserModel, block: boolean, reason?: string) { +async function changeUserBlock (res: express.Response, user: MUserAccountDefault, block: boolean, reason?: string) { const oldUserAuditView = new UserAuditView(user.toFormattedJSON()) user.blocked = block