X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fcontrollers%2Fapi%2Fusers%2Findex.ts;h=d743a991210e33d5725c467181fafeb9cbad3f82;hb=afd4ee86ddb97f8d49585fddd318bedcd3ad55b8;hp=27351c1a954b8d68ed648fac005e5462bacc0962;hpb=5c5e587307a27e173333789b5b5167d35f468b01;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/controllers/api/users/index.ts b/server/controllers/api/users/index.ts index 27351c1a9..d743a9912 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 { 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,67 +27,54 @@ import { paginationValidator, setDefaultPagination, setDefaultSort, - token, userAutocompleteValidator, usersAddValidator, usersGetValidator, + usersListValidator, usersRegisterValidator, usersRemoveValidator, usersSortValidator, usersUpdateValidator } from '../../../middlewares' import { + ensureCanManageUser, usersAskResetPasswordValidator, usersAskSendVerifyEmailValidator, usersBlockingValidator, usersResetPasswordValidator, - usersVerifyEmailValidator, - ensureCanManageUser + 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 { MUser, MUserAccountDefault } from '@server/typings/models' +import { myVideoPlaylistsRouter } from './my-video-playlists' +import { HttpStatusCode } from '../../../../shared/core-utils/miscs/http-error-codes' const auditLogger = auditLoggerFactory('users') -// FIXME: https://github.com/nfriedly/express-rate-limit/issues/138 -// @ts-ignore -const loginRateLimiter = RateLimit({ - windowMs: CONFIG.RATES_LIMIT.LOGIN.WINDOW_MS, - max: CONFIG.RATES_LIMIT.LOGIN.MAX -}) - -// @ts-ignore const signupRateLimiter = RateLimit({ windowMs: CONFIG.RATES_LIMIT.SIGNUP.WINDOW_MS, max: CONFIG.RATES_LIMIT.SIGNUP.MAX, skipFailedRequests: true }) -// @ts-ignore -const askSendEmailLimiter = new RateLimit({ +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', @@ -92,6 +89,7 @@ usersRouter.get('/', usersSortValidator, setDefaultSort, setDefaultPagination, + usersListValidator, asyncMiddleware(listUsers) ) @@ -169,13 +167,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 { @@ -186,6 +177,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, @@ -198,11 +190,30 @@ async function createUser (req: express.Request, res: express.Response) { 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: 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, @@ -228,7 +239,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 @@ -243,7 +254,9 @@ async function registerUser (req: express.Request, res: express.Response) { Notifier.Instance.notifyOnNewUserRegistration(user) - return res.type('json').status(204).end() + 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) { @@ -251,7 +264,9 @@ async function unblockUser (req: express.Request, res: express.Response) { await changeUserBlock(res, user, false) - return res.status(204).end() + Hooks.runAction('action:api.user.unblocked', { user }) + + return res.status(HttpStatusCode.NO_CONTENT_204).end() } async function blockUser (req: express.Request, res: express.Response) { @@ -260,7 +275,9 @@ async function blockUser (req: express.Request, res: express.Response) { await changeUserBlock(res, user, true, reason) - return res.status(204).end() + Hooks.runAction('action:api.user.blocked', { user }) + + return res.status(HttpStatusCode.NO_CONTENT_204).end() } function getUser (req: express.Request, res: express.Response) { @@ -274,7 +291,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 })) } @@ -286,7 +309,9 @@ async function removeUser (req: express.Request, res: express.Response) { auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON())) - return res.sendStatus(204) + Hooks.runAction('action:api.user.deleted', { user }) + + return res.sendStatus(HttpStatusCode.NO_CONTENT_204) } async function updateUser (req: express.Request, res: express.Response) { @@ -310,9 +335,11 @@ 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) + return res.sendStatus(HttpStatusCode.NO_CONTENT_204) } async function askResetUserPassword (req: express.Request, res: express.Response) { @@ -320,9 +347,9 @@ 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() + return res.status(HttpStatusCode.NO_CONTENT_204).end() } async function resetUserPassword (req: express.Request, res: express.Response) { @@ -330,8 +357,9 @@ async function resetUserPassword (req: express.Request, res: express.Response) { user.password = req.body.password await user.save() + await Redis.Instance.removePasswordVerificationString(user.id) - return res.status(204).end() + return res.status(HttpStatusCode.NO_CONTENT_204).end() } async function reSendVerifyUserEmail (req: express.Request, res: express.Response) { @@ -339,7 +367,7 @@ async function reSendVerifyUserEmail (req: express.Request, res: express.Respons await sendVerifyUserEmail(user) - return res.status(204).end() + return res.status(HttpStatusCode.NO_CONTENT_204).end() } async function verifyUserEmail (req: express.Request, res: express.Response) { @@ -353,11 +381,7 @@ async function verifyUserEmail (req: express.Request, res: express.Response) { await user.save() - return res.status(204).end() -} - -function success (req: express.Request, res: express.Response) { - res.end() + return res.status(HttpStatusCode.NO_CONTENT_204).end() } async function changeUserBlock (res: express.Response, user: MUserAccountDefault, block: boolean, reason?: string) {