X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=server%2Fcontrollers%2Fapi%2Fusers%2Findex.ts;h=06a43d7a313ea7e83877a7d18c23b774d1c7a5ce;hb=faa9d434b4d681837ff2a87603337c2623419669;hp=4f8137c03943b2717bf0fad4b2c2e2aaecc67a08;hpb=71e318b4fe66175d03c7c82357d60062eb68af81;p=oweals%2Fpeertube.git diff --git a/server/controllers/api/users/index.ts b/server/controllers/api/users/index.ts index 4f8137c03..06a43d7a3 100644 --- a/server/controllers/api/users/index.ts +++ b/server/controllers/api/users/index.ts @@ -2,11 +2,11 @@ import * as express from 'express' import * as RateLimit from 'express-rate-limit' import { UserCreate, UserRight, UserRole, UserUpdate } from '../../../../shared' import { logger } from '../../../helpers/logger' -import { getFormattedObjects } from '../../../helpers/utils' -import { CONFIG, RATES_LIMIT, sequelizeTypescript } from '../../../initializers' +import { generateRandomString, getFormattedObjects } from '../../../helpers/utils' +import { WEBSERVER } from '../../../initializers/constants' import { Emailer } from '../../../lib/emailer' import { Redis } from '../../../lib/redis' -import { createUserAccountAndChannel } from '../../../lib/user' +import { createUserAccountAndChannelAndPlaylist, sendVerifyUserEmail } from '../../../lib/user' import { asyncMiddleware, asyncRetryTransactionMiddleware, @@ -17,7 +17,6 @@ import { paginationValidator, setDefaultPagination, setDefaultSort, - token, userAutocompleteValidator, usersAddValidator, usersGetValidator, @@ -27,6 +26,7 @@ import { usersUpdateValidator } from '../../../middlewares' import { + ensureCanManageUser, usersAskResetPasswordValidator, usersAskSendVerifyEmailValidator, usersBlockingValidator, @@ -37,22 +37,40 @@ 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 { 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 { Hooks } from '@server/lib/plugins/hooks' +import { tokensRouter } from '@server/controllers/api/users/token' const auditLogger = auditLoggerFactory('users') -const loginRateLimiter = new RateLimit({ - windowMs: RATES_LIMIT.LOGIN.WINDOW_MS, - max: RATES_LIMIT.LOGIN.MAX, - delayMs: 0 +const signupRateLimiter = RateLimit({ + windowMs: CONFIG.RATES_LIMIT.SIGNUP.WINDOW_MS, + max: CONFIG.RATES_LIMIT.SIGNUP.MAX, + skipFailedRequests: true }) -const askSendEmailLimiter = new RateLimit({ - windowMs: RATES_LIMIT.ASK_SEND_EMAIL.WINDOW_MS, - max: RATES_LIMIT.ASK_SEND_EMAIL.MAX, - delayMs: 0 +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('/', meRouter) usersRouter.get('/autocomplete', @@ -74,12 +92,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) ) @@ -98,6 +118,7 @@ usersRouter.post('/', ) usersRouter.post('/register', + signupRateLimiter, asyncMiddleware(ensureUserRegistrationAllowed), ensureUserRegistrationAllowedForIP, asyncMiddleware(usersRegisterValidator), @@ -108,6 +129,7 @@ usersRouter.put('/:id', authenticate, ensureUserHasRight(UserRight.MANAGE_USERS), asyncMiddleware(usersUpdateValidator), + ensureCanManageUser, asyncMiddleware(updateUser) ) @@ -115,6 +137,7 @@ usersRouter.delete('/:id', authenticate, ensureUserHasRight(UserRight.MANAGE_USERS), asyncMiddleware(usersRemoveValidator), + ensureCanManageUser, asyncMiddleware(removeUser) ) @@ -131,7 +154,7 @@ usersRouter.post('/:id/reset-password', usersRouter.post('/ask-send-verify-email', askSendEmailLimiter, asyncMiddleware(usersAskSendVerifyEmailValidator), - asyncMiddleware(askSendVerifyUserEmail) + asyncMiddleware(reSendVerifyUserEmail) ) usersRouter.post('/:id/verify-email', @@ -139,13 +162,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 { @@ -164,27 +180,43 @@ async function createUser (req: express.Request, res: express.Response) { autoPlayVideo: true, role: body.role, videoQuota: body.videoQuota, - videoQuotaDaily: body.videoQuotaDaily - }) + 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 } = await createUserAccountAndChannel(userToCreate) + const { user, account, videoChannel } = await createUserAccountAndChannelAndPlaylist({ userToCreate: userToCreate }) 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, - uuid: account.Actor.uuid + id: account.id } } }).end() } async function registerUser (req: express.Request, res: express.Response) { - const body: UserCreate = req.body + const body: UserRegister = req.body const userToCreate = new UserModel({ username: body.username, @@ -198,7 +230,11 @@ async function registerUser (req: express.Request, res: express.Response) { emailVerified: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION ? false : null }) - const { user } = await createUserAccountAndChannel(userToCreate) + 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) @@ -207,87 +243,102 @@ async function registerUser (req: express.Request, res: express.Response) { await sendVerifyUserEmail(user) } + Notifier.Instance.notifyOnNewUserRegistration(user) + + Hooks.runAction('action:api.user.registered', { body, user, account, videoChannel }) + return res.type('json').status(204).end() } -async function unblockUser (req: express.Request, res: express.Response, next: express.NextFunction) { - const user: UserModel = res.locals.user +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(204).end() } -async function blockUser (req: express.Request, res: express.Response, next: express.NextFunction) { - const user: UserModel = res.locals.user +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(204).end() } -function getUser (req: express.Request, res: express.Response, next: express.NextFunction) { - return res.json((res.locals.user as UserModel).toFormattedJSON()) +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, next: express.NextFunction) { +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, next: express.NextFunction) { +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) - return res.json(getFormattedObjects(resultList.data, resultList.total)) + return res.json(getFormattedObjects(resultList.data, resultList.total, { withAdminFlags: true })) } -async function removeUser (req: express.Request, res: express.Response, next: express.NextFunction) { - const user: UserModel = res.locals.user +async function removeUser (req: express.Request, res: express.Response) { + const user = res.locals.user await user.destroy() auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON())) + Hooks.runAction('action:api.user.deleted', { user }) + return res.sendStatus(204) } -async function updateUser (req: express.Request, res: express.Response, next: express.NextFunction) { +async function updateUser (req: express.Request, res: express.Response) { const body: UserUpdate = req.body - const userToUpdate = res.locals.user as UserModel + const userToUpdate = res.locals.user const oldUserAuditView = new UserAuditView(userToUpdate.toFormattedJSON()) const roleChanged = body.role !== undefined && body.role !== userToUpdate.role + if (body.password !== undefined) userToUpdate.password = body.password if (body.email !== undefined) userToUpdate.email = body.email + if (body.emailVerified !== undefined) userToUpdate.emailVerified = body.emailVerified if (body.videoQuota !== undefined) userToUpdate.videoQuota = body.videoQuota if (body.videoQuotaDaily !== undefined) userToUpdate.videoQuotaDaily = body.videoQuotaDaily if (body.role !== undefined) userToUpdate.role = body.role + if (body.adminFlags !== undefined) userToUpdate.adminFlags = body.adminFlags const user = await userToUpdate.save() // Destroy user token to refresh rights - if (roleChanged) await deleteUserToken(userToUpdate.id) + if (roleChanged || body.password !== undefined) await deleteUserToken(userToUpdate.id) auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView) - // Don't need to send this update to followers, these attributes are not propagated + 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) } -async function askResetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) { - const user = res.locals.user as UserModel +async function askResetUserPassword (req: express.Request, res: express.Response) { + const user = res.locals.user const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id) - const url = CONFIG.WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString - await Emailer.Instance.addForgetPasswordEmailJob(user.email, url) + const url = WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString + await Emailer.Instance.addPasswordResetEmailJob(user.email, url) return res.status(204).end() } -async function resetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) { - const user = res.locals.user as UserModel +async function resetUserPassword (req: express.Request, res: express.Response) { + const user = res.locals.user user.password = req.body.password await user.save() @@ -295,35 +346,29 @@ async function resetUserPassword (req: express.Request, res: express.Response, n return res.status(204).end() } -async function sendVerifyUserEmail (user: UserModel) { - const verificationString = await Redis.Instance.setVerifyEmailVerificationString(user.id) - const url = CONFIG.WEBSERVER.URL + '/verify-account/email?userId=' + user.id + '&verificationString=' + verificationString - await Emailer.Instance.addVerifyEmailJob(user.email, url) - return -} - -async function askSendVerifyUserEmail (req: express.Request, res: express.Response, next: express.NextFunction) { - const user = res.locals.user as UserModel +async function reSendVerifyUserEmail (req: express.Request, res: express.Response) { + const user = res.locals.user await sendVerifyUserEmail(user) return res.status(204).end() } -async function verifyUserEmail (req: express.Request, res: express.Response, next: express.NextFunction) { - const user = res.locals.user as UserModel +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(204).end() } -function success (req: express.Request, res: express.Response, next: express.NextFunction) { - 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