-import * as Bluebird from 'bluebird'
-import * as express from 'express'
-import { body, param } from 'express-validator'
+import express from 'express'
+import { body, param, query } from 'express-validator'
import { omit } from 'lodash'
-import { isIdOrUUIDValid, toBooleanOrNull, toIntOrNull } from '../../helpers/custom-validators/misc'
+import { Hooks } from '@server/lib/plugins/hooks'
+import { MUserDefault } from '@server/types/models'
+import { HttpStatusCode, UserRegister, UserRight, UserRole } from '@shared/models'
+import { isBooleanValid, isIdValid, toBooleanOrNull, toIntOrNull } from '../../helpers/custom-validators/misc'
+import { isThemeNameValid } from '../../helpers/custom-validators/plugins'
import {
- isNoInstanceConfigWarningModal,
- isNoWelcomeModal,
isUserAdminFlagsValid,
isUserAutoPlayNextVideoValid,
isUserAutoPlayVideoValid,
isUserBlockedReasonValid,
isUserDescriptionValid,
isUserDisplayNameValid,
+ isUserNoModal,
isUserNSFWPolicyValid,
+ isUserP2PEnabledValid,
isUserPasswordValid,
+ isUserPasswordValidOrEmpty,
isUserRoleValid,
isUserUsernameValid,
isUserVideoLanguages,
isUserVideoQuotaValid,
isUserVideosHistoryEnabledValid
} from '../../helpers/custom-validators/users'
+import { isVideoChannelDisplayNameValid, isVideoChannelUsernameValid } from '../../helpers/custom-validators/video-channels'
import { logger } from '../../helpers/logger'
-import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../helpers/signup'
-import { Redis } from '../../lib/redis'
-import { UserModel } from '../../models/account/user'
-import { areValidationErrors } from './utils'
-import { ActorModel } from '../../models/activitypub/actor'
-import { isActorPreferredUsernameValid } from '../../helpers/custom-validators/activitypub/actor'
-import { isVideoChannelNameValid } from '../../helpers/custom-validators/video-channels'
-import { UserRegister } from '../../../shared/models/users/user-register.model'
-import { isThemeNameValid } from '../../helpers/custom-validators/plugins'
import { isThemeRegistered } from '../../lib/plugins/theme-utils'
-import { doesVideoExist } from '../../helpers/middlewares'
-import { UserRole } from '../../../shared/models/users'
-import { MUserDefault } from '@server/typings/models'
+import { Redis } from '../../lib/redis'
+import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../lib/signup'
+import { ActorModel } from '../../models/actor/actor'
+import { UserModel } from '../../models/user/user'
+import { areValidationErrors, doesVideoChannelIdExist, doesVideoExist, isValidVideoIdParam } from './shared'
+
+const usersListValidator = [
+ query('blocked')
+ .optional()
+ .customSanitizer(toBooleanOrNull)
+ .isBoolean().withMessage('Should be a valid boolean banned state'),
+
+ (req: express.Request, res: express.Response, next: express.NextFunction) => {
+ logger.debug('Checking usersList parameters', { parameters: req.query })
+
+ if (areValidationErrors(req, res)) return
+
+ return next()
+ }
+]
const usersAddValidator = [
body('username').custom(isUserUsernameValid).withMessage('Should have a valid username (lowercase alphanumeric characters)'),
- body('password').custom(isUserPasswordValid).withMessage('Should have a valid password'),
+ body('password').custom(isUserPasswordValidOrEmpty).withMessage('Should have a valid password'),
body('email').isEmail().withMessage('Should have a valid email'),
+
+ body('channelName').optional().custom(isVideoChannelUsernameValid).withMessage('Should have a valid channel name'),
+
body('videoQuota').custom(isUserVideoQuotaValid).withMessage('Should have a valid user quota'),
body('videoQuotaDaily').custom(isUserVideoQuotaDailyValid).withMessage('Should have a valid daily user quota'),
+
body('role')
.customSanitizer(toIntOrNull)
.custom(isUserRoleValid).withMessage('Should have a valid role'),
const authUser = res.locals.oauth.token.User
if (authUser.role !== UserRole.ADMINISTRATOR && req.body.role !== UserRole.USER) {
- return res.status(403)
- .json({ error: 'You can only create users (and not administrators or moderators)' })
+ return res.fail({
+ status: HttpStatusCode.FORBIDDEN_403,
+ message: 'You can only create users (and not administrators or moderators)'
+ })
+ }
+
+ if (req.body.channelName) {
+ if (req.body.channelName === req.body.username) {
+ return res.fail({ message: 'Channel name cannot be the same as user username.' })
+ }
+
+ const existing = await ActorModel.loadLocalByName(req.body.channelName)
+ if (existing) {
+ return res.fail({
+ status: HttpStatusCode.CONFLICT_409,
+ message: `Channel with name ${req.body.channelName} already exists.`
+ })
+ }
}
return next()
body('channel.name')
.optional()
- .custom(isActorPreferredUsernameValid).withMessage('Should have a valid channel name'),
+ .custom(isVideoChannelUsernameValid).withMessage('Should have a valid channel name'),
body('channel.displayName')
.optional()
- .custom(isVideoChannelNameValid).withMessage('Should have a valid display name'),
+ .custom(isVideoChannelDisplayNameValid).withMessage('Should have a valid display name'),
async (req: express.Request, res: express.Response, next: express.NextFunction) => {
logger.debug('Checking usersRegister parameters', { parameters: omit(req.body, 'password') })
const body: UserRegister = req.body
if (body.channel) {
if (!body.channel.name || !body.channel.displayName) {
- return res.status(400)
- .json({ error: 'Channel is optional but if you specify it, channel.name and channel.displayName are required.' })
+ return res.fail({ message: 'Channel is optional but if you specify it, channel.name and channel.displayName are required.' })
}
if (body.channel.name === body.username) {
- return res.status(400)
- .json({ error: 'Channel name cannot be the same as user username.' })
+ return res.fail({ message: 'Channel name cannot be the same as user username.' })
}
const existing = await ActorModel.loadLocalByName(body.channel.name)
if (existing) {
- return res.status(409)
- .json({ error: `Channel with name ${body.channel.name} already exists.` })
+ return res.fail({
+ status: HttpStatusCode.CONFLICT_409,
+ message: `Channel with name ${body.channel.name} already exists.`
+ })
}
}
const user = res.locals.user
if (user.username === 'root') {
- return res.status(400)
- .json({ error: 'Cannot remove the root user' })
+ return res.fail({ message: 'Cannot remove the root user' })
}
return next()
const user = res.locals.user
if (user.username === 'root') {
- return res.status(400)
- .json({ error: 'Cannot block the root user' })
+ return res.fail({ message: 'Cannot block the root user' })
}
return next()
]
const deleteMeValidator = [
- async (req: express.Request, res: express.Response, next: express.NextFunction) => {
+ (req: express.Request, res: express.Response, next: express.NextFunction) => {
const user = res.locals.oauth.token.User
if (user.username === 'root') {
- return res.status(400)
- .json({ error: 'You cannot delete your root account.' })
- .end()
+ return res.fail({ message: 'You cannot delete your root account.' })
}
return next()
const usersUpdateValidator = [
param('id').isInt().not().isEmpty().withMessage('Should have a valid id'),
+
body('password').optional().custom(isUserPasswordValid).withMessage('Should have a valid password'),
body('email').optional().isEmail().withMessage('Should have a valid email attribute'),
body('emailVerified').optional().isBoolean().withMessage('Should have a valid email verified attribute'),
body('videoQuota').optional().custom(isUserVideoQuotaValid).withMessage('Should have a valid user quota'),
body('videoQuotaDaily').optional().custom(isUserVideoQuotaDailyValid).withMessage('Should have a valid daily user quota'),
+ body('pluginAuth').optional(),
body('role')
.optional()
.customSanitizer(toIntOrNull)
const user = res.locals.user
if (user.username === 'root' && req.body.role !== undefined && user.role !== req.body.role) {
- return res.status(400)
- .json({ error: 'Cannot change root role.' })
+ return res.fail({ message: 'Cannot change root role.' })
}
return next()
body('autoPlayVideo')
.optional()
.custom(isUserAutoPlayVideoValid).withMessage('Should have a valid automatically plays video attribute'),
+ body('p2pEnabled')
+ .optional()
+ .custom(isUserP2PEnabledValid).withMessage('Should have a valid p2p enabled boolean'),
body('videoLanguages')
.optional()
.custom(isUserVideoLanguages).withMessage('Should have a valid video languages attribute'),
body('theme')
.optional()
.custom(v => isThemeNameValid(v) && isThemeRegistered(v)).withMessage('Should have a valid theme'),
+
body('noInstanceConfigWarningModal')
.optional()
- .custom(v => isNoInstanceConfigWarningModal(v)).withMessage('Should have a valid noInstanceConfigWarningModal boolean'),
+ .custom(v => isUserNoModal(v)).withMessage('Should have a valid noInstanceConfigWarningModal boolean'),
body('noWelcomeModal')
.optional()
- .custom(v => isNoWelcomeModal(v)).withMessage('Should have a valid noWelcomeModal boolean'),
+ .custom(v => isUserNoModal(v)).withMessage('Should have a valid noWelcomeModal boolean'),
+ body('noAccountSetupWarningModal')
+ .optional()
+ .custom(v => isUserNoModal(v)).withMessage('Should have a valid noAccountSetupWarningModal boolean'),
+
body('autoPlayNextVideo')
.optional()
.custom(v => isUserAutoPlayNextVideoValid(v)).withMessage('Should have a valid autoPlayNextVideo boolean'),
async (req: express.Request, res: express.Response, next: express.NextFunction) => {
logger.debug('Checking usersUpdateMe parameters', { parameters: omit(req.body, 'password') })
+ const user = res.locals.oauth.token.User
+
if (req.body.password || req.body.email) {
+ if (user.pluginAuth !== null) {
+ return res.fail({ message: 'You cannot update your email or password that is associated with an external auth system.' })
+ }
+
if (!req.body.currentPassword) {
- return res.status(400)
- .json({ error: 'currentPassword parameter is missing.' })
- .end()
+ return res.fail({ message: 'currentPassword parameter is missing.' })
}
- const user = res.locals.oauth.token.User
if (await user.isPasswordMatch(req.body.currentPassword) !== true) {
- return res.status(401)
- .json({ error: 'currentPassword is invalid.' })
+ return res.fail({
+ status: HttpStatusCode.UNAUTHORIZED_401,
+ message: 'currentPassword is invalid.'
+ })
}
}
const usersGetValidator = [
param('id').isInt().not().isEmpty().withMessage('Should have a valid id'),
+ query('withStats').optional().isBoolean().withMessage('Should have a valid stats flag'),
async (req: express.Request, res: express.Response, next: express.NextFunction) => {
logger.debug('Checking usersGet parameters', { parameters: req.params })
if (areValidationErrors(req, res)) return
- if (!await checkUserIdExist(req.params.id, res)) return
+ if (!await checkUserIdExist(req.params.id, res, req.query.withStats)) return
return next()
}
]
const usersVideoRatingValidator = [
- param('videoId').custom(isIdOrUUIDValid).not().isEmpty().withMessage('Should have a valid video id'),
+ isValidVideoIdParam('videoId'),
async (req: express.Request, res: express.Response, next: express.NextFunction) => {
logger.debug('Checking usersVideoRating parameters', { parameters: req.params })
}
]
+const usersVideosValidator = [
+ query('isLive')
+ .optional()
+ .customSanitizer(toBooleanOrNull)
+ .custom(isBooleanValid).withMessage('Should have a valid live boolean'),
+
+ query('channelId')
+ .optional()
+ .customSanitizer(toIntOrNull)
+ .custom(isIdValid).withMessage('Should have a valid channel id'),
+
+ async (req: express.Request, res: express.Response, next: express.NextFunction) => {
+ logger.debug('Checking usersVideosValidator parameters', { parameters: req.query })
+
+ if (areValidationErrors(req, res)) return
+
+ if (req.query.channelId && !await doesVideoChannelIdExist(req.query.channelId, res)) return
+
+ return next()
+ }
+]
+
const ensureUserRegistrationAllowed = [
async (req: express.Request, res: express.Response, next: express.NextFunction) => {
- const allowed = await isSignupAllowed()
- if (allowed === false) {
- return res.status(403)
- .json({ error: 'User registration is not enabled or user limit is reached.' })
+ const allowedParams = {
+ body: req.body,
+ ip: req.ip
+ }
+
+ const allowedResult = await Hooks.wrapPromiseFun(
+ isSignupAllowed,
+ allowedParams,
+ 'filter:api.user.signup.allowed.result'
+ )
+
+ if (allowedResult.allowed === false) {
+ return res.fail({
+ status: HttpStatusCode.FORBIDDEN_403,
+ message: allowedResult.errorMessage || 'User registration is not enabled or user limit is reached.'
+ })
}
return next()
]
const ensureUserRegistrationAllowedForIP = [
- async (req: express.Request, res: express.Response, next: express.NextFunction) => {
+ (req: express.Request, res: express.Response, next: express.NextFunction) => {
const allowed = isSignupAllowedForCurrentIP(req.ip)
if (allowed === false) {
- return res.status(403)
- .json({ error: 'You are not on a network authorized for registration.' })
+ return res.fail({
+ status: HttpStatusCode.FORBIDDEN_403,
+ message: 'You are not on a network authorized for registration.'
+ })
}
return next()
if (!exists) {
logger.debug('User with email %s does not exist (asking reset password).', req.body.email)
// Do not leak our emails
- return res.status(204).end()
+ return res.status(HttpStatusCode.NO_CONTENT_204).end()
}
return next()
const redisVerificationString = await Redis.Instance.getResetPasswordLink(user.id)
if (redisVerificationString !== req.body.verificationString) {
- return res
- .status(403)
- .json({ error: 'Invalid verification string.' })
+ return res.fail({
+ status: HttpStatusCode.FORBIDDEN_403,
+ message: 'Invalid verification string.'
+ })
}
return next()
if (!exists) {
logger.debug('User with email %s does not exist (asking verify email).', req.body.email)
// Do not leak our emails
- return res.status(204).end()
+ return res.status(HttpStatusCode.NO_CONTENT_204).end()
}
return next()
const redisVerificationString = await Redis.Instance.getVerifyEmailLink(user.id)
if (redisVerificationString !== req.body.verificationString) {
- return res
- .status(403)
- .json({ error: 'Invalid verification string.' })
+ return res.fail({
+ status: HttpStatusCode.FORBIDDEN_403,
+ message: 'Invalid verification string.'
+ })
}
return next()
]
const ensureAuthUserOwnsAccountValidator = [
- async (req: express.Request, res: express.Response, next: express.NextFunction) => {
+ (req: express.Request, res: express.Response, next: express.NextFunction) => {
const user = res.locals.oauth.token.User
if (res.locals.account.id !== user.Account.id) {
- return res.status(403)
- .json({ error: 'Only owner can access ratings list.' })
+ return res.fail({
+ status: HttpStatusCode.FORBIDDEN_403,
+ message: 'Only owner of this account can access this ressource.'
+ })
+ }
+
+ return next()
+ }
+]
+
+const ensureCanManageChannel = [
+ (req: express.Request, res: express.Response, next: express.NextFunction) => {
+ const user = res.locals.oauth.token.user
+ const isUserOwner = res.locals.videoChannel.Account.userId === user.id
+
+ if (!isUserOwner && user.hasRight(UserRight.MANAGE_ANY_VIDEO_CHANNEL) === false) {
+ const message = `User ${user.username} does not have right to manage channel ${req.params.nameWithHost}.`
+
+ return res.fail({
+ status: HttpStatusCode.FORBIDDEN_403,
+ message
+ })
}
return next()
if (authUser.role === UserRole.ADMINISTRATOR) return next()
if (authUser.role === UserRole.MODERATOR && onUser.role === UserRole.USER) return next()
- return res.status(403)
- .json({ error: 'A moderator can only manager users.' })
+ return res.fail({
+ status: HttpStatusCode.FORBIDDEN_403,
+ message: 'A moderator can only manager users.'
+ })
}
]
// ---------------------------------------------------------------------------
export {
+ usersListValidator,
usersAddValidator,
deleteMeValidator,
usersRegisterValidator,
ensureUserRegistrationAllowed,
ensureUserRegistrationAllowedForIP,
usersGetValidator,
+ usersVideosValidator,
usersAskResetPasswordValidator,
usersResetPasswordValidator,
usersAskSendVerifyEmailValidator,
usersVerifyEmailValidator,
userAutocompleteValidator,
ensureAuthUserOwnsAccountValidator,
- ensureCanManageUser
+ ensureCanManageUser,
+ ensureCanManageChannel
}
// ---------------------------------------------------------------------------
-function checkUserIdExist (idArg: number | string, res: express.Response) {
+function checkUserIdExist (idArg: number | string, res: express.Response, withStats = false) {
const id = parseInt(idArg + '', 10)
- return checkUserExist(() => UserModel.loadById(id), res)
+ return checkUserExist(() => UserModel.loadByIdWithChannels(id, withStats), res)
}
function checkUserEmailExist (email: string, res: express.Response, abortResponse = true) {
const user = await UserModel.loadByUsernameOrEmail(username, email)
if (user) {
- res.status(409)
- .json({ error: 'User with this username or email already exists.' })
+ res.fail({
+ status: HttpStatusCode.CONFLICT_409,
+ message: 'User with this username or email already exists.'
+ })
return false
}
const actor = await ActorModel.loadLocalByName(username)
if (actor) {
- res.status(409)
- .json({ error: 'Another actor (account/channel) with this name on this instance already exists or has already existed.' })
+ res.fail({
+ status: HttpStatusCode.CONFLICT_409,
+ message: 'Another actor (account/channel) with this name on this instance already exists or has already existed.'
+ })
return false
}
return true
}
-async function checkUserExist (finder: () => Bluebird<MUserDefault>, res: express.Response, abortResponse = true) {
+async function checkUserExist (finder: () => Promise<MUserDefault>, res: express.Response, abortResponse = true) {
const user = await finder()
if (!user) {
if (abortResponse === true) {
- res.status(404)
- .json({ error: 'User not found' })
+ res.fail({
+ status: HttpStatusCode.NOT_FOUND_404,
+ message: 'User not found'
+ })
}
return false
}
res.locals.user = user
-
return true
}
projects / github / Chocobozzz / PeerTube.git / blobdiff