-import * as express from 'express'
-import * as RateLimit from 'express-rate-limit'
-import { UserCreate, UserRight, UserRole, UserUpdate } from '../../../../shared'
+import express from 'express'
+import { tokensRouter } from '@server/controllers/api/users/token'
+import { Hooks } from '@server/lib/plugins/hooks'
+import { OAuthTokenModel } from '@server/models/oauth/oauth-token'
+import { MUserAccountDefault } from '@server/types/models'
+import { pick } from '@shared/core-utils'
+import { HttpStatusCode, UserCreate, UserCreateResult, UserRegister, UserRight, UserUpdate } from '@shared/models'
+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 { Redis } from '../../../lib/redis'
-import { createUserAccountAndChannelAndPlaylist, sendVerifyUserEmail } from '../../../lib/user'
+import { buildUser, createUserAccountAndChannelAndPlaylist, sendVerifyUserEmail } from '../../../lib/user'
import {
+ adminUsersSortValidator,
asyncMiddleware,
asyncRetryTransactionMiddleware,
authenticate,
+ buildRateLimiter,
ensureUserHasRight,
ensureUserRegistrationAllowed,
ensureUserRegistrationAllowedForIP,
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 { UserModel } from '../../../models/user/user'
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'
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({
+const signupRateLimiter = buildRateLimiter({
windowMs: CONFIG.RATES_LIMIT.SIGNUP.WINDOW_MS,
max: CONFIG.RATES_LIMIT.SIGNUP.MAX,
skipFailedRequests: true
})
-// @ts-ignore
-const askSendEmailLimiter = new RateLimit({
+const askSendEmailLimiter = buildRateLimiter({
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',
authenticate,
ensureUserHasRight(UserRight.MANAGE_USERS),
paginationValidator,
- usersSortValidator,
+ adminUsersSortValidator,
setDefaultSort,
setDefaultPagination,
+ usersListValidator,
asyncMiddleware(listUsers)
)
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 {
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
-
- const { user, account } = await createUserAccountAndChannelAndPlaylist({ userToCreate: userToCreate })
+
+ const userToCreate = buildUser({
+ ...pick(body, [ 'username', 'password', 'email', 'role', 'videoQuota', 'videoQuotaDaily', 'adminFlags' ]),
+
+ emailVerified: null
+ })
+
+ // 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
+ Emailer.Instance.addPasswordCreateEmailJob(userToCreate.username, user.email, url)
+ }
+
+ Hooks.runAction('action:api.user.created', { body, user, account, videoChannel, req, res })
+
return res.json({
user: {
id: user.id,
account: {
id: account.id
}
- }
- }).end()
+ } 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,
+ const userToCreate = buildUser({
+ ...pick(body, [ 'username', 'password', 'email' ]),
+
emailVerified: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION ? false : null
})
- const { user } = await createUserAccountAndChannelAndPlaylist({
- userToCreate: userToCreate,
+ const { user, account, videoChannel } = await createUserAccountAndChannelAndPlaylist({
+ userToCreate,
userDisplayName: body.displayName || undefined,
channelNames: body.channel
})
Notifier.Instance.notifyOnNewUserRegistration(user)
- return res.type('json').status(204).end()
+ Hooks.runAction('action:api.user.registered', { body, user, account, videoChannel, req, res })
+
+ return res.type('json').status(HttpStatusCode.NO_CONTENT_204).end()
}
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, req, res })
+
+ return res.status(HttpStatusCode.NO_CONTENT_204).end()
}
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, req, res })
+
+ return res.status(HttpStatusCode.NO_CONTENT_204).end()
}
function getUser (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.listForAdminApi({
+ 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
- await user.destroy()
-
auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
- return res.sendStatus(204)
+ 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, req, res })
+
+ return res.status(HttpStatusCode.NO_CONTENT_204).end()
}
async function updateUser (req: express.Request, res: express.Response) {
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 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 deleteUserToken(userToUpdate.id)
+ 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, req, res })
+
// Don't need to send this update to followers, these attributes are not federated
- return res.sendStatus(204)
+ return res.status(HttpStatusCode.NO_CONTENT_204).end()
}
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) {
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) {
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) {
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) {
user.blockedReason = reason || null
await sequelizeTypescript.transaction(async t => {
- await deleteUserToken(user.id, t)
+ await OAuthTokenModel.deleteUserToken(user.id, t)
await user.save({ transaction: t })
})
projects / github / Chocobozzz / PeerTube.git / blobdiff