1 import * as express from 'express'
2 import 'express-validator'
3 import { body, param } from 'express-validator/check'
4 import { isIdOrUUIDValid } from '../../helpers/custom-validators/misc'
7 isUserAutoPlayVideoValid, isUserDisplayNSFWValid, isUserPasswordValid, isUserRoleValid, isUserUsernameValid,
9 } from '../../helpers/custom-validators/users'
10 import { isVideoExist, isVideoFile } from '../../helpers/custom-validators/videos'
11 import { logger } from '../../helpers/logger'
12 import { isSignupAllowed } from '../../helpers/utils'
13 import { CONSTRAINTS_FIELDS } from '../../initializers'
14 import { UserModel } from '../../models/account/user'
15 import { areValidationErrors } from './utils'
17 const usersAddValidator = [
18 body('username').custom(isUserUsernameValid).withMessage('Should have a valid username (lowercase alphanumeric characters)'),
19 body('password').custom(isUserPasswordValid).withMessage('Should have a valid password'),
20 body('email').isEmail().withMessage('Should have a valid email'),
21 body('videoQuota').custom(isUserVideoQuotaValid).withMessage('Should have a valid user quota'),
22 body('role').custom(isUserRoleValid).withMessage('Should have a valid role'),
24 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
25 logger.debug('Checking usersAdd parameters', { parameters: req.body })
27 if (areValidationErrors(req, res)) return
28 if (!await checkUserNameOrEmailDoesNotAlreadyExist(req.body.username, req.body.email, res)) return
34 const usersRegisterValidator = [
35 body('username').custom(isUserUsernameValid).withMessage('Should have a valid username'),
36 body('password').custom(isUserPasswordValid).withMessage('Should have a valid password'),
37 body('email').isEmail().withMessage('Should have a valid email'),
39 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
40 logger.debug('Checking usersRegister parameters', { parameters: req.body })
42 if (areValidationErrors(req, res)) return
43 if (!await checkUserNameOrEmailDoesNotAlreadyExist(req.body.username, req.body.email, res)) return
49 const usersRemoveValidator = [
50 param('id').isInt().not().isEmpty().withMessage('Should have a valid id'),
52 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
53 logger.debug('Checking usersRemove parameters', { parameters: req.params })
55 if (areValidationErrors(req, res)) return
56 if (!await checkUserIdExist(req.params.id, res)) return
58 const user = res.locals.user
59 if (user.username === 'root') {
60 return res.status(400)
61 .send({ error: 'Cannot remove the root user' })
69 const usersUpdateValidator = [
70 param('id').isInt().not().isEmpty().withMessage('Should have a valid id'),
71 body('email').optional().isEmail().withMessage('Should have a valid email attribute'),
72 body('videoQuota').optional().custom(isUserVideoQuotaValid).withMessage('Should have a valid user quota'),
73 body('role').optional().custom(isUserRoleValid).withMessage('Should have a valid role'),
75 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
76 logger.debug('Checking usersUpdate parameters', { parameters: req.body })
78 if (areValidationErrors(req, res)) return
79 if (!await checkUserIdExist(req.params.id, res)) return
85 const usersUpdateMeValidator = [
86 body('password').optional().custom(isUserPasswordValid).withMessage('Should have a valid password'),
87 body('email').optional().isEmail().withMessage('Should have a valid email attribute'),
88 body('displayNSFW').optional().custom(isUserDisplayNSFWValid).withMessage('Should have a valid display Not Safe For Work attribute'),
89 body('autoPlayVideo').optional().custom(isUserAutoPlayVideoValid).withMessage('Should have a valid automatically plays video attribute'),
91 (req: express.Request, res: express.Response, next: express.NextFunction) => {
92 // TODO: Add old password verification
93 logger.debug('Checking usersUpdateMe parameters', { parameters: req.body })
95 if (areValidationErrors(req, res)) return
101 const usersUpdateMyAvatarValidator = [
102 body('avatarfile').custom((value, { req }) => isAvatarFile(req.files)).withMessage(
103 'This file is not supported. Please, make sure it is of the following type : '
104 + CONSTRAINTS_FIELDS.ACTOR.AVATAR.EXTNAME.join(', ')
107 (req: express.Request, res: express.Response, next: express.NextFunction) => {
108 logger.debug('Checking usersUpdateMyAvatarValidator parameters', { parameters: req.body })
110 if (areValidationErrors(req, res)) return
116 const usersGetValidator = [
117 param('id').isInt().not().isEmpty().withMessage('Should have a valid id'),
119 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
120 logger.debug('Checking usersGet parameters', { parameters: req.body })
122 if (areValidationErrors(req, res)) return
123 if (!await checkUserIdExist(req.params.id, res)) return
129 const usersVideoRatingValidator = [
130 param('videoId').custom(isIdOrUUIDValid).not().isEmpty().withMessage('Should have a valid video id'),
132 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
133 logger.debug('Checking usersVideoRating parameters', { parameters: req.params })
135 if (areValidationErrors(req, res)) return
136 if (!await isVideoExist(req.params.videoId, res)) return
142 const ensureUserRegistrationAllowed = [
143 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
144 const allowed = await isSignupAllowed()
145 if (allowed === false) {
146 return res.status(403)
147 .send({ error: 'User registration is not enabled or user limit is reached.' })
155 // ---------------------------------------------------------------------------
159 usersRegisterValidator,
160 usersRemoveValidator,
161 usersUpdateValidator,
162 usersUpdateMeValidator,
163 usersVideoRatingValidator,
164 ensureUserRegistrationAllowed,
166 usersUpdateMyAvatarValidator
169 // ---------------------------------------------------------------------------
171 async function checkUserIdExist (id: number, res: express.Response) {
172 const user = await UserModel.loadById(id)
176 .send({ error: 'User not found' })
182 res.locals.user = user
186 async function checkUserNameOrEmailDoesNotAlreadyExist (username: string, email: string, res: express.Response) {
187 const user = await UserModel.loadByUsernameOrEmail(username, email)
191 .send({ error: 'User with this username of email already exists.' })