1 import * as Bluebird from 'bluebird'
2 import * as express from 'express'
3 import { body, param } 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,
20 isUserVideoQuotaDailyValid,
21 isUserVideoQuotaValid,
22 isUserVideosHistoryEnabledValid
23 } from '../../helpers/custom-validators/users'
24 import { logger } from '../../helpers/logger'
25 import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../helpers/signup'
26 import { Redis } from '../../lib/redis'
27 import { UserModel } from '../../models/account/user'
28 import { areValidationErrors } from './utils'
29 import { ActorModel } from '../../models/activitypub/actor'
30 import { isActorPreferredUsernameValid } from '../../helpers/custom-validators/activitypub/actor'
31 import { isVideoChannelNameValid } from '../../helpers/custom-validators/video-channels'
32 import { UserRegister } from '../../../shared/models/users/user-register.model'
33 import { isThemeNameValid } from '../../helpers/custom-validators/plugins'
34 import { isThemeRegistered } from '../../lib/plugins/theme-utils'
35 import { doesVideoExist } from '../../helpers/middlewares'
36 import { UserRole } from '../../../shared/models/users'
37 import { MUserDefault } from '@server/typings/models'
38 import { Hooks } from '@server/lib/plugins/hooks'
39 import { isLocalVideoAccepted } from '@server/lib/moderation'
41 const usersAddValidator = [
42 body('username').custom(isUserUsernameValid).withMessage('Should have a valid username (lowercase alphanumeric characters)'),
43 body('password').custom(isUserPasswordValid).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 async (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'),
260 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
261 logger.debug('Checking usersGet parameters', { parameters: req.params })
263 if (areValidationErrors(req, res)) return
264 if (!await checkUserIdExist(req.params.id, res)) return
270 const usersVideoRatingValidator = [
271 param('videoId').custom(isIdOrUUIDValid).not().isEmpty().withMessage('Should have a valid video id'),
273 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
274 logger.debug('Checking usersVideoRating parameters', { parameters: req.params })
276 if (areValidationErrors(req, res)) return
277 if (!await doesVideoExist(req.params.videoId, res, 'id')) return
283 const ensureUserRegistrationAllowed = [
284 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
285 const allowedParams = {
290 const allowedResult = await Hooks.wrapPromiseFun(
293 'filter:api.user.signup.allowed.result'
296 if (allowedResult.allowed === false) {
297 return res.status(403)
298 .json({ error: allowedResult.errorMessage || 'User registration is not enabled or user limit is reached.' })
305 const ensureUserRegistrationAllowedForIP = [
306 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
307 const allowed = isSignupAllowedForCurrentIP(req.ip)
309 if (allowed === false) {
310 return res.status(403)
311 .json({ error: 'You are not on a network authorized for registration.' })
318 const usersAskResetPasswordValidator = [
319 body('email').isEmail().not().isEmpty().withMessage('Should have a valid email'),
321 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
322 logger.debug('Checking usersAskResetPassword parameters', { parameters: req.body })
324 if (areValidationErrors(req, res)) return
326 const exists = await checkUserEmailExist(req.body.email, res, false)
328 logger.debug('User with email %s does not exist (asking reset password).', req.body.email)
329 // Do not leak our emails
330 return res.status(204).end()
337 const usersResetPasswordValidator = [
338 param('id').isInt().not().isEmpty().withMessage('Should have a valid id'),
339 body('verificationString').not().isEmpty().withMessage('Should have a valid verification string'),
340 body('password').custom(isUserPasswordValid).withMessage('Should have a valid password'),
342 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
343 logger.debug('Checking usersResetPassword parameters', { parameters: req.params })
345 if (areValidationErrors(req, res)) return
346 if (!await checkUserIdExist(req.params.id, res)) return
348 const user = res.locals.user
349 const redisVerificationString = await Redis.Instance.getResetPasswordLink(user.id)
351 if (redisVerificationString !== req.body.verificationString) {
354 .json({ error: 'Invalid verification string.' })
361 const usersAskSendVerifyEmailValidator = [
362 body('email').isEmail().not().isEmpty().withMessage('Should have a valid email'),
364 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
365 logger.debug('Checking askUsersSendVerifyEmail parameters', { parameters: req.body })
367 if (areValidationErrors(req, res)) return
368 const exists = await checkUserEmailExist(req.body.email, res, false)
370 logger.debug('User with email %s does not exist (asking verify email).', req.body.email)
371 // Do not leak our emails
372 return res.status(204).end()
379 const usersVerifyEmailValidator = [
381 .isInt().not().isEmpty().withMessage('Should have a valid id'),
383 body('verificationString')
384 .not().isEmpty().withMessage('Should have a valid verification string'),
385 body('isPendingEmail')
387 .customSanitizer(toBooleanOrNull),
389 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
390 logger.debug('Checking usersVerifyEmail parameters', { parameters: req.params })
392 if (areValidationErrors(req, res)) return
393 if (!await checkUserIdExist(req.params.id, res)) return
395 const user = res.locals.user
396 const redisVerificationString = await Redis.Instance.getVerifyEmailLink(user.id)
398 if (redisVerificationString !== req.body.verificationString) {
401 .json({ error: 'Invalid verification string.' })
408 const userAutocompleteValidator = [
409 param('search').isString().not().isEmpty().withMessage('Should have a search parameter')
412 const ensureAuthUserOwnsAccountValidator = [
413 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
414 const user = res.locals.oauth.token.User
416 if (res.locals.account.id !== user.Account.id) {
417 return res.status(403)
418 .json({ error: 'Only owner can access ratings list.' })
425 const ensureCanManageUser = [
426 (req: express.Request, res: express.Response, next: express.NextFunction) => {
427 const authUser = res.locals.oauth.token.User
428 const onUser = res.locals.user
430 if (authUser.role === UserRole.ADMINISTRATOR) return next()
431 if (authUser.role === UserRole.MODERATOR && onUser.role === UserRole.USER) return next()
433 return res.status(403)
434 .json({ error: 'A moderator can only manager users.' })
438 // ---------------------------------------------------------------------------
443 usersRegisterValidator,
444 usersBlockingValidator,
445 usersRemoveValidator,
446 usersUpdateValidator,
447 usersUpdateMeValidator,
448 usersVideoRatingValidator,
449 ensureUserRegistrationAllowed,
450 ensureUserRegistrationAllowedForIP,
452 usersAskResetPasswordValidator,
453 usersResetPasswordValidator,
454 usersAskSendVerifyEmailValidator,
455 usersVerifyEmailValidator,
456 userAutocompleteValidator,
457 ensureAuthUserOwnsAccountValidator,
461 // ---------------------------------------------------------------------------
463 function checkUserIdExist (idArg: number | string, res: express.Response) {
464 const id = parseInt(idArg + '', 10)
465 return checkUserExist(() => UserModel.loadById(id), res)
468 function checkUserEmailExist (email: string, res: express.Response, abortResponse = true) {
469 return checkUserExist(() => UserModel.loadByEmail(email), res, abortResponse)
472 async function checkUserNameOrEmailDoesNotAlreadyExist (username: string, email: string, res: express.Response) {
473 const user = await UserModel.loadByUsernameOrEmail(username, email)
477 .json({ error: 'User with this username or email already exists.' })
481 const actor = await ActorModel.loadLocalByName(username)
484 .json({ error: 'Another actor (account/channel) with this name on this instance already exists or has already existed.' })
491 async function checkUserExist (finder: () => Bluebird<MUserDefault>, res: express.Response, abortResponse = true) {
492 const user = await finder()
495 if (abortResponse === true) {
497 .json({ error: 'User not found' })
503 res.locals.user = user