1 import * as Bluebird from 'bluebird'
2 import * as express from 'express'
3 import { body, param, query } from 'express-validator'
4 import { omit } from 'lodash'
5 import { isIdOrUUIDValid, toBooleanOrNull, toIntOrNull } from '../../helpers/custom-validators/misc'
7 isNoInstanceConfigWarningModal,
10 isUserAutoPlayNextVideoValid,
11 isUserAutoPlayVideoValid,
12 isUserBlockedReasonValid,
13 isUserDescriptionValid,
14 isUserDisplayNameValid,
15 isUserNSFWPolicyValid,
17 isUserPasswordValidOrEmpty,
21 isUserVideoQuotaDailyValid,
22 isUserVideoQuotaValid,
23 isUserVideosHistoryEnabledValid
24 } from '../../helpers/custom-validators/users'
25 import { logger } from '../../helpers/logger'
26 import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../helpers/signup'
27 import { Redis } from '../../lib/redis'
28 import { UserModel } from '../../models/account/user'
29 import { areValidationErrors } from './utils'
30 import { ActorModel } from '../../models/activitypub/actor'
31 import { isActorPreferredUsernameValid } from '../../helpers/custom-validators/activitypub/actor'
32 import { isVideoChannelNameValid } from '../../helpers/custom-validators/video-channels'
33 import { UserRegister } from '../../../shared/models/users/user-register.model'
34 import { isThemeNameValid } from '../../helpers/custom-validators/plugins'
35 import { isThemeRegistered } from '../../lib/plugins/theme-utils'
36 import { doesVideoExist } from '../../helpers/middlewares'
37 import { UserRole } from '../../../shared/models/users'
38 import { MUserDefault } from '@server/typings/models'
39 import { Hooks } from '@server/lib/plugins/hooks'
41 const usersAddValidator = [
42 body('username').custom(isUserUsernameValid).withMessage('Should have a valid username (lowercase alphanumeric characters)'),
43 body('password').custom(isUserPasswordValidOrEmpty).withMessage('Should have a valid password'),
44 body('email').isEmail().withMessage('Should have a valid email'),
45 body('videoQuota').custom(isUserVideoQuotaValid).withMessage('Should have a valid user quota'),
46 body('videoQuotaDaily').custom(isUserVideoQuotaDailyValid).withMessage('Should have a valid daily user quota'),
48 .customSanitizer(toIntOrNull)
49 .custom(isUserRoleValid).withMessage('Should have a valid role'),
50 body('adminFlags').optional().custom(isUserAdminFlagsValid).withMessage('Should have a valid admin flags'),
52 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
53 logger.debug('Checking usersAdd parameters', { parameters: omit(req.body, 'password') })
55 if (areValidationErrors(req, res)) return
56 if (!await checkUserNameOrEmailDoesNotAlreadyExist(req.body.username, req.body.email, res)) return
58 const authUser = res.locals.oauth.token.User
59 if (authUser.role !== UserRole.ADMINISTRATOR && req.body.role !== UserRole.USER) {
60 return res.status(403)
61 .json({ error: 'You can only create users (and not administrators or moderators)' })
68 const usersRegisterValidator = [
69 body('username').custom(isUserUsernameValid).withMessage('Should have a valid username'),
70 body('password').custom(isUserPasswordValid).withMessage('Should have a valid password'),
71 body('email').isEmail().withMessage('Should have a valid email'),
74 .custom(isUserDisplayNameValid).withMessage('Should have a valid display name'),
78 .custom(isActorPreferredUsernameValid).withMessage('Should have a valid channel name'),
79 body('channel.displayName')
81 .custom(isVideoChannelNameValid).withMessage('Should have a valid display name'),
83 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
84 logger.debug('Checking usersRegister parameters', { parameters: omit(req.body, 'password') })
86 if (areValidationErrors(req, res)) return
87 if (!await checkUserNameOrEmailDoesNotAlreadyExist(req.body.username, req.body.email, res)) return
89 const body: UserRegister = req.body
91 if (!body.channel.name || !body.channel.displayName) {
92 return res.status(400)
93 .json({ error: 'Channel is optional but if you specify it, channel.name and channel.displayName are required.' })
96 if (body.channel.name === body.username) {
97 return res.status(400)
98 .json({ error: 'Channel name cannot be the same as user username.' })
101 const existing = await ActorModel.loadLocalByName(body.channel.name)
103 return res.status(409)
104 .json({ error: `Channel with name ${body.channel.name} already exists.` })
112 const usersRemoveValidator = [
113 param('id').isInt().not().isEmpty().withMessage('Should have a valid id'),
115 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
116 logger.debug('Checking usersRemove parameters', { parameters: req.params })
118 if (areValidationErrors(req, res)) return
119 if (!await checkUserIdExist(req.params.id, res)) return
121 const user = res.locals.user
122 if (user.username === 'root') {
123 return res.status(400)
124 .json({ error: 'Cannot remove the root user' })
131 const usersBlockingValidator = [
132 param('id').isInt().not().isEmpty().withMessage('Should have a valid id'),
133 body('reason').optional().custom(isUserBlockedReasonValid).withMessage('Should have a valid blocking reason'),
135 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
136 logger.debug('Checking usersBlocking parameters', { parameters: req.params })
138 if (areValidationErrors(req, res)) return
139 if (!await checkUserIdExist(req.params.id, res)) return
141 const user = res.locals.user
142 if (user.username === 'root') {
143 return res.status(400)
144 .json({ error: 'Cannot block the root user' })
151 const deleteMeValidator = [
152 (req: express.Request, res: express.Response, next: express.NextFunction) => {
153 const user = res.locals.oauth.token.User
154 if (user.username === 'root') {
155 return res.status(400)
156 .json({ error: 'You cannot delete your root account.' })
164 const usersUpdateValidator = [
165 param('id').isInt().not().isEmpty().withMessage('Should have a valid id'),
166 body('password').optional().custom(isUserPasswordValid).withMessage('Should have a valid password'),
167 body('email').optional().isEmail().withMessage('Should have a valid email attribute'),
168 body('emailVerified').optional().isBoolean().withMessage('Should have a valid email verified attribute'),
169 body('videoQuota').optional().custom(isUserVideoQuotaValid).withMessage('Should have a valid user quota'),
170 body('videoQuotaDaily').optional().custom(isUserVideoQuotaDailyValid).withMessage('Should have a valid daily user quota'),
173 .customSanitizer(toIntOrNull)
174 .custom(isUserRoleValid).withMessage('Should have a valid role'),
175 body('adminFlags').optional().custom(isUserAdminFlagsValid).withMessage('Should have a valid admin flags'),
177 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
178 logger.debug('Checking usersUpdate parameters', { parameters: req.body })
180 if (areValidationErrors(req, res)) return
181 if (!await checkUserIdExist(req.params.id, res)) return
183 const user = res.locals.user
184 if (user.username === 'root' && req.body.role !== undefined && user.role !== req.body.role) {
185 return res.status(400)
186 .json({ error: 'Cannot change root role.' })
193 const usersUpdateMeValidator = [
196 .custom(isUserDisplayNameValid).withMessage('Should have a valid display name'),
199 .custom(isUserDescriptionValid).withMessage('Should have a valid description'),
200 body('currentPassword')
202 .custom(isUserPasswordValid).withMessage('Should have a valid current password'),
205 .custom(isUserPasswordValid).withMessage('Should have a valid password'),
208 .isEmail().withMessage('Should have a valid email attribute'),
211 .custom(isUserNSFWPolicyValid).withMessage('Should have a valid display Not Safe For Work policy'),
212 body('autoPlayVideo')
214 .custom(isUserAutoPlayVideoValid).withMessage('Should have a valid automatically plays video attribute'),
215 body('videoLanguages')
217 .custom(isUserVideoLanguages).withMessage('Should have a valid video languages attribute'),
218 body('videosHistoryEnabled')
220 .custom(isUserVideosHistoryEnabledValid).withMessage('Should have a valid videos history enabled attribute'),
223 .custom(v => isThemeNameValid(v) && isThemeRegistered(v)).withMessage('Should have a valid theme'),
224 body('noInstanceConfigWarningModal')
226 .custom(v => isNoInstanceConfigWarningModal(v)).withMessage('Should have a valid noInstanceConfigWarningModal boolean'),
227 body('noWelcomeModal')
229 .custom(v => isNoWelcomeModal(v)).withMessage('Should have a valid noWelcomeModal boolean'),
230 body('autoPlayNextVideo')
232 .custom(v => isUserAutoPlayNextVideoValid(v)).withMessage('Should have a valid autoPlayNextVideo boolean'),
234 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
235 logger.debug('Checking usersUpdateMe parameters', { parameters: omit(req.body, 'password') })
237 if (req.body.password || req.body.email) {
238 if (!req.body.currentPassword) {
239 return res.status(400)
240 .json({ error: 'currentPassword parameter is missing.' })
244 const user = res.locals.oauth.token.User
245 if (await user.isPasswordMatch(req.body.currentPassword) !== true) {
246 return res.status(401)
247 .json({ error: 'currentPassword is invalid.' })
251 if (areValidationErrors(req, res)) return
257 const usersGetValidator = [
258 param('id').isInt().not().isEmpty().withMessage('Should have a valid id'),
259 query('withStats').optional().isBoolean().withMessage('Should have a valid stats flag'),
261 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
262 logger.debug('Checking usersGet parameters', { parameters: req.params })
264 if (areValidationErrors(req, res)) return
265 if (!await checkUserIdExist(req.params.id, res, req.query.withStats)) return
271 const usersVideoRatingValidator = [
272 param('videoId').custom(isIdOrUUIDValid).not().isEmpty().withMessage('Should have a valid video id'),
274 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
275 logger.debug('Checking usersVideoRating parameters', { parameters: req.params })
277 if (areValidationErrors(req, res)) return
278 if (!await doesVideoExist(req.params.videoId, res, 'id')) return
284 const ensureUserRegistrationAllowed = [
285 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
286 const allowedParams = {
291 const allowedResult = await Hooks.wrapPromiseFun(
294 'filter:api.user.signup.allowed.result'
297 if (allowedResult.allowed === false) {
298 return res.status(403)
299 .json({ error: allowedResult.errorMessage || 'User registration is not enabled or user limit is reached.' })
306 const ensureUserRegistrationAllowedForIP = [
307 (req: express.Request, res: express.Response, next: express.NextFunction) => {
308 const allowed = isSignupAllowedForCurrentIP(req.ip)
310 if (allowed === false) {
311 return res.status(403)
312 .json({ error: 'You are not on a network authorized for registration.' })
319 const usersAskResetPasswordValidator = [
320 body('email').isEmail().not().isEmpty().withMessage('Should have a valid email'),
322 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
323 logger.debug('Checking usersAskResetPassword parameters', { parameters: req.body })
325 if (areValidationErrors(req, res)) return
327 const exists = await checkUserEmailExist(req.body.email, res, false)
329 logger.debug('User with email %s does not exist (asking reset password).', req.body.email)
330 // Do not leak our emails
331 return res.status(204).end()
338 const usersResetPasswordValidator = [
339 param('id').isInt().not().isEmpty().withMessage('Should have a valid id'),
340 body('verificationString').not().isEmpty().withMessage('Should have a valid verification string'),
341 body('password').custom(isUserPasswordValid).withMessage('Should have a valid password'),
343 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
344 logger.debug('Checking usersResetPassword parameters', { parameters: req.params })
346 if (areValidationErrors(req, res)) return
347 if (!await checkUserIdExist(req.params.id, res)) return
349 const user = res.locals.user
350 const redisVerificationString = await Redis.Instance.getResetPasswordLink(user.id)
352 if (redisVerificationString !== req.body.verificationString) {
355 .json({ error: 'Invalid verification string.' })
362 const usersAskSendVerifyEmailValidator = [
363 body('email').isEmail().not().isEmpty().withMessage('Should have a valid email'),
365 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
366 logger.debug('Checking askUsersSendVerifyEmail parameters', { parameters: req.body })
368 if (areValidationErrors(req, res)) return
369 const exists = await checkUserEmailExist(req.body.email, res, false)
371 logger.debug('User with email %s does not exist (asking verify email).', req.body.email)
372 // Do not leak our emails
373 return res.status(204).end()
380 const usersVerifyEmailValidator = [
382 .isInt().not().isEmpty().withMessage('Should have a valid id'),
384 body('verificationString')
385 .not().isEmpty().withMessage('Should have a valid verification string'),
386 body('isPendingEmail')
388 .customSanitizer(toBooleanOrNull),
390 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
391 logger.debug('Checking usersVerifyEmail parameters', { parameters: req.params })
393 if (areValidationErrors(req, res)) return
394 if (!await checkUserIdExist(req.params.id, res)) return
396 const user = res.locals.user
397 const redisVerificationString = await Redis.Instance.getVerifyEmailLink(user.id)
399 if (redisVerificationString !== req.body.verificationString) {
402 .json({ error: 'Invalid verification string.' })
409 const userAutocompleteValidator = [
410 param('search').isString().not().isEmpty().withMessage('Should have a search parameter')
413 const ensureAuthUserOwnsAccountValidator = [
414 (req: express.Request, res: express.Response, next: express.NextFunction) => {
415 const user = res.locals.oauth.token.User
417 if (res.locals.account.id !== user.Account.id) {
418 return res.status(403)
419 .json({ error: 'Only owner can access ratings list.' })
426 const ensureCanManageUser = [
427 (req: express.Request, res: express.Response, next: express.NextFunction) => {
428 const authUser = res.locals.oauth.token.User
429 const onUser = res.locals.user
431 if (authUser.role === UserRole.ADMINISTRATOR) return next()
432 if (authUser.role === UserRole.MODERATOR && onUser.role === UserRole.USER) return next()
434 return res.status(403)
435 .json({ error: 'A moderator can only manager users.' })
439 // ---------------------------------------------------------------------------
444 usersRegisterValidator,
445 usersBlockingValidator,
446 usersRemoveValidator,
447 usersUpdateValidator,
448 usersUpdateMeValidator,
449 usersVideoRatingValidator,
450 ensureUserRegistrationAllowed,
451 ensureUserRegistrationAllowedForIP,
453 usersAskResetPasswordValidator,
454 usersResetPasswordValidator,
455 usersAskSendVerifyEmailValidator,
456 usersVerifyEmailValidator,
457 userAutocompleteValidator,
458 ensureAuthUserOwnsAccountValidator,
462 // ---------------------------------------------------------------------------
464 function checkUserIdExist (idArg: number | string, res: express.Response, withStats = false) {
465 const id = parseInt(idArg + '', 10)
466 return checkUserExist(() => UserModel.loadById(id, withStats), res)
469 function checkUserEmailExist (email: string, res: express.Response, abortResponse = true) {
470 return checkUserExist(() => UserModel.loadByEmail(email), res, abortResponse)
473 async function checkUserNameOrEmailDoesNotAlreadyExist (username: string, email: string, res: express.Response) {
474 const user = await UserModel.loadByUsernameOrEmail(username, email)
478 .json({ error: 'User with this username or email already exists.' })
482 const actor = await ActorModel.loadLocalByName(username)
485 .json({ error: 'Another actor (account/channel) with this name on this instance already exists or has already existed.' })
492 async function checkUserExist (finder: () => Bluebird<MUserDefault>, res: express.Response, abortResponse = true) {
493 const user = await finder()
496 if (abortResponse === true) {
498 .json({ error: 'User not found' })
504 res.locals.user = user