1 import * as express from 'express'
2 import { body, param, query } from 'express-validator'
3 import { omit } from 'lodash'
4 import { Hooks } from '@server/lib/plugins/hooks'
5 import { MUserDefault } from '@server/types/models'
6 import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes'
7 import { UserRole } from '../../../shared/models/users'
8 import { UserRegister } from '../../../shared/models/users/user-register.model'
9 import { isActorPreferredUsernameValid } from '../../helpers/custom-validators/activitypub/actor'
10 import { isIdOrUUIDValid, toBooleanOrNull, toIntOrNull } from '../../helpers/custom-validators/misc'
11 import { isThemeNameValid } from '../../helpers/custom-validators/plugins'
13 isNoInstanceConfigWarningModal,
15 isUserAdminFlagsValid,
16 isUserAutoPlayNextVideoValid,
17 isUserAutoPlayVideoValid,
18 isUserBlockedReasonValid,
19 isUserDescriptionValid,
20 isUserDisplayNameValid,
21 isUserNSFWPolicyValid,
23 isUserPasswordValidOrEmpty,
27 isUserVideoQuotaDailyValid,
28 isUserVideoQuotaValid,
29 isUserVideosHistoryEnabledValid
30 } from '../../helpers/custom-validators/users'
31 import { isVideoChannelNameValid } from '../../helpers/custom-validators/video-channels'
32 import { logger } from '../../helpers/logger'
33 import { doesVideoExist } from '../../helpers/middlewares'
34 import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../helpers/signup'
35 import { isThemeRegistered } from '../../lib/plugins/theme-utils'
36 import { Redis } from '../../lib/redis'
37 import { UserModel } from '../../models/account/user'
38 import { ActorModel } from '../../models/activitypub/actor'
39 import { areValidationErrors } from './utils'
41 const usersListValidator = [
44 .customSanitizer(toBooleanOrNull)
45 .isBoolean().withMessage('Should be a valid boolean banned state'),
47 (req: express.Request, res: express.Response, next: express.NextFunction) => {
48 logger.debug('Checking usersList parameters', { parameters: req.query })
50 if (areValidationErrors(req, res)) return
56 const usersAddValidator = [
57 body('username').custom(isUserUsernameValid).withMessage('Should have a valid username (lowercase alphanumeric characters)'),
58 body('password').custom(isUserPasswordValidOrEmpty).withMessage('Should have a valid password'),
59 body('email').isEmail().withMessage('Should have a valid email'),
60 body('channelName').optional().custom(isActorPreferredUsernameValid).withMessage('Should have a valid channel name'),
61 body('videoQuota').custom(isUserVideoQuotaValid).withMessage('Should have a valid user quota'),
62 body('videoQuotaDaily').custom(isUserVideoQuotaDailyValid).withMessage('Should have a valid daily user quota'),
64 .customSanitizer(toIntOrNull)
65 .custom(isUserRoleValid).withMessage('Should have a valid role'),
66 body('adminFlags').optional().custom(isUserAdminFlagsValid).withMessage('Should have a valid admin flags'),
68 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
69 logger.debug('Checking usersAdd parameters', { parameters: omit(req.body, 'password') })
71 if (areValidationErrors(req, res)) return
72 if (!await checkUserNameOrEmailDoesNotAlreadyExist(req.body.username, req.body.email, res)) return
74 const authUser = res.locals.oauth.token.User
75 if (authUser.role !== UserRole.ADMINISTRATOR && req.body.role !== UserRole.USER) {
77 .status(HttpStatusCode.FORBIDDEN_403)
78 .json({ error: 'You can only create users (and not administrators or moderators)' })
81 if (req.body.channelName) {
82 if (req.body.channelName === req.body.username) {
84 .status(HttpStatusCode.BAD_REQUEST_400)
85 .json({ error: 'Channel name cannot be the same as user username.' })
88 const existing = await ActorModel.loadLocalByName(req.body.channelName)
91 .status(HttpStatusCode.CONFLICT_409)
92 .json({ error: `Channel with name ${req.body.channelName} already exists.` })
100 const usersRegisterValidator = [
101 body('username').custom(isUserUsernameValid).withMessage('Should have a valid username'),
102 body('password').custom(isUserPasswordValid).withMessage('Should have a valid password'),
103 body('email').isEmail().withMessage('Should have a valid email'),
106 .custom(isUserDisplayNameValid).withMessage('Should have a valid display name'),
110 .custom(isActorPreferredUsernameValid).withMessage('Should have a valid channel name'),
111 body('channel.displayName')
113 .custom(isVideoChannelNameValid).withMessage('Should have a valid display name'),
115 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
116 logger.debug('Checking usersRegister parameters', { parameters: omit(req.body, 'password') })
118 if (areValidationErrors(req, res)) return
119 if (!await checkUserNameOrEmailDoesNotAlreadyExist(req.body.username, req.body.email, res)) return
121 const body: UserRegister = req.body
123 if (!body.channel.name || !body.channel.displayName) {
125 .status(HttpStatusCode.BAD_REQUEST_400)
126 .json({ error: 'Channel is optional but if you specify it, channel.name and channel.displayName are required.' })
129 if (body.channel.name === body.username) {
130 return res.status(HttpStatusCode.BAD_REQUEST_400)
131 .json({ error: 'Channel name cannot be the same as user username.' })
134 const existing = await ActorModel.loadLocalByName(body.channel.name)
136 return res.status(HttpStatusCode.CONFLICT_409)
137 .json({ error: `Channel with name ${body.channel.name} already exists.` })
145 const usersRemoveValidator = [
146 param('id').isInt().not().isEmpty().withMessage('Should have a valid id'),
148 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
149 logger.debug('Checking usersRemove parameters', { parameters: req.params })
151 if (areValidationErrors(req, res)) return
152 if (!await checkUserIdExist(req.params.id, res)) return
154 const user = res.locals.user
155 if (user.username === 'root') {
156 return res.status(HttpStatusCode.BAD_REQUEST_400)
157 .json({ error: 'Cannot remove the root user' })
164 const usersBlockingValidator = [
165 param('id').isInt().not().isEmpty().withMessage('Should have a valid id'),
166 body('reason').optional().custom(isUserBlockedReasonValid).withMessage('Should have a valid blocking reason'),
168 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
169 logger.debug('Checking usersBlocking parameters', { parameters: req.params })
171 if (areValidationErrors(req, res)) return
172 if (!await checkUserIdExist(req.params.id, res)) return
174 const user = res.locals.user
175 if (user.username === 'root') {
176 return res.status(HttpStatusCode.BAD_REQUEST_400)
177 .json({ error: 'Cannot block the root user' })
184 const deleteMeValidator = [
185 (req: express.Request, res: express.Response, next: express.NextFunction) => {
186 const user = res.locals.oauth.token.User
187 if (user.username === 'root') {
188 return res.status(HttpStatusCode.BAD_REQUEST_400)
189 .json({ error: 'You cannot delete your root account.' })
197 const usersUpdateValidator = [
198 param('id').isInt().not().isEmpty().withMessage('Should have a valid id'),
199 body('password').optional().custom(isUserPasswordValid).withMessage('Should have a valid password'),
200 body('email').optional().isEmail().withMessage('Should have a valid email attribute'),
201 body('emailVerified').optional().isBoolean().withMessage('Should have a valid email verified attribute'),
202 body('videoQuota').optional().custom(isUserVideoQuotaValid).withMessage('Should have a valid user quota'),
203 body('videoQuotaDaily').optional().custom(isUserVideoQuotaDailyValid).withMessage('Should have a valid daily user quota'),
206 .customSanitizer(toIntOrNull)
207 .custom(isUserRoleValid).withMessage('Should have a valid role'),
208 body('adminFlags').optional().custom(isUserAdminFlagsValid).withMessage('Should have a valid admin flags'),
210 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
211 logger.debug('Checking usersUpdate parameters', { parameters: req.body })
213 if (areValidationErrors(req, res)) return
214 if (!await checkUserIdExist(req.params.id, res)) return
216 const user = res.locals.user
217 if (user.username === 'root' && req.body.role !== undefined && user.role !== req.body.role) {
218 return res.status(HttpStatusCode.BAD_REQUEST_400)
219 .json({ error: 'Cannot change root role.' })
226 const usersUpdateMeValidator = [
229 .custom(isUserDisplayNameValid).withMessage('Should have a valid display name'),
232 .custom(isUserDescriptionValid).withMessage('Should have a valid description'),
233 body('currentPassword')
235 .custom(isUserPasswordValid).withMessage('Should have a valid current password'),
238 .custom(isUserPasswordValid).withMessage('Should have a valid password'),
241 .isEmail().withMessage('Should have a valid email attribute'),
244 .custom(isUserNSFWPolicyValid).withMessage('Should have a valid display Not Safe For Work policy'),
245 body('autoPlayVideo')
247 .custom(isUserAutoPlayVideoValid).withMessage('Should have a valid automatically plays video attribute'),
248 body('videoLanguages')
250 .custom(isUserVideoLanguages).withMessage('Should have a valid video languages attribute'),
251 body('videosHistoryEnabled')
253 .custom(isUserVideosHistoryEnabledValid).withMessage('Should have a valid videos history enabled attribute'),
256 .custom(v => isThemeNameValid(v) && isThemeRegistered(v)).withMessage('Should have a valid theme'),
257 body('noInstanceConfigWarningModal')
259 .custom(v => isNoInstanceConfigWarningModal(v)).withMessage('Should have a valid noInstanceConfigWarningModal boolean'),
260 body('noWelcomeModal')
262 .custom(v => isNoWelcomeModal(v)).withMessage('Should have a valid noWelcomeModal boolean'),
263 body('autoPlayNextVideo')
265 .custom(v => isUserAutoPlayNextVideoValid(v)).withMessage('Should have a valid autoPlayNextVideo boolean'),
267 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
268 logger.debug('Checking usersUpdateMe parameters', { parameters: omit(req.body, 'password') })
270 const user = res.locals.oauth.token.User
272 if (req.body.password || req.body.email) {
273 if (user.pluginAuth !== null) {
274 return res.status(HttpStatusCode.BAD_REQUEST_400)
275 .json({ error: 'You cannot update your email or password that is associated with an external auth system.' })
278 if (!req.body.currentPassword) {
279 return res.status(HttpStatusCode.BAD_REQUEST_400)
280 .json({ error: 'currentPassword parameter is missing.' })
283 if (await user.isPasswordMatch(req.body.currentPassword) !== true) {
284 return res.status(HttpStatusCode.UNAUTHORIZED_401)
285 .json({ error: 'currentPassword is invalid.' })
289 if (areValidationErrors(req, res)) return
295 const usersGetValidator = [
296 param('id').isInt().not().isEmpty().withMessage('Should have a valid id'),
297 query('withStats').optional().isBoolean().withMessage('Should have a valid stats flag'),
299 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
300 logger.debug('Checking usersGet parameters', { parameters: req.params })
302 if (areValidationErrors(req, res)) return
303 if (!await checkUserIdExist(req.params.id, res, req.query.withStats)) return
309 const usersVideoRatingValidator = [
310 param('videoId').custom(isIdOrUUIDValid).not().isEmpty().withMessage('Should have a valid video id'),
312 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
313 logger.debug('Checking usersVideoRating parameters', { parameters: req.params })
315 if (areValidationErrors(req, res)) return
316 if (!await doesVideoExist(req.params.videoId, res, 'id')) return
322 const ensureUserRegistrationAllowed = [
323 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
324 const allowedParams = {
329 const allowedResult = await Hooks.wrapPromiseFun(
332 'filter:api.user.signup.allowed.result'
335 if (allowedResult.allowed === false) {
336 return res.status(HttpStatusCode.FORBIDDEN_403)
337 .json({ error: allowedResult.errorMessage || 'User registration is not enabled or user limit is reached.' })
344 const ensureUserRegistrationAllowedForIP = [
345 (req: express.Request, res: express.Response, next: express.NextFunction) => {
346 const allowed = isSignupAllowedForCurrentIP(req.ip)
348 if (allowed === false) {
349 return res.status(HttpStatusCode.FORBIDDEN_403)
350 .json({ error: 'You are not on a network authorized for registration.' })
357 const usersAskResetPasswordValidator = [
358 body('email').isEmail().not().isEmpty().withMessage('Should have a valid email'),
360 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
361 logger.debug('Checking usersAskResetPassword parameters', { parameters: req.body })
363 if (areValidationErrors(req, res)) return
365 const exists = await checkUserEmailExist(req.body.email, res, false)
367 logger.debug('User with email %s does not exist (asking reset password).', req.body.email)
368 // Do not leak our emails
369 return res.status(HttpStatusCode.NO_CONTENT_204).end()
376 const usersResetPasswordValidator = [
377 param('id').isInt().not().isEmpty().withMessage('Should have a valid id'),
378 body('verificationString').not().isEmpty().withMessage('Should have a valid verification string'),
379 body('password').custom(isUserPasswordValid).withMessage('Should have a valid password'),
381 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
382 logger.debug('Checking usersResetPassword parameters', { parameters: req.params })
384 if (areValidationErrors(req, res)) return
385 if (!await checkUserIdExist(req.params.id, res)) return
387 const user = res.locals.user
388 const redisVerificationString = await Redis.Instance.getResetPasswordLink(user.id)
390 if (redisVerificationString !== req.body.verificationString) {
392 .status(HttpStatusCode.FORBIDDEN_403)
393 .json({ error: 'Invalid verification string.' })
400 const usersAskSendVerifyEmailValidator = [
401 body('email').isEmail().not().isEmpty().withMessage('Should have a valid email'),
403 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
404 logger.debug('Checking askUsersSendVerifyEmail parameters', { parameters: req.body })
406 if (areValidationErrors(req, res)) return
407 const exists = await checkUserEmailExist(req.body.email, res, false)
409 logger.debug('User with email %s does not exist (asking verify email).', req.body.email)
410 // Do not leak our emails
411 return res.status(HttpStatusCode.NO_CONTENT_204).end()
418 const usersVerifyEmailValidator = [
420 .isInt().not().isEmpty().withMessage('Should have a valid id'),
422 body('verificationString')
423 .not().isEmpty().withMessage('Should have a valid verification string'),
424 body('isPendingEmail')
426 .customSanitizer(toBooleanOrNull),
428 async (req: express.Request, res: express.Response, next: express.NextFunction) => {
429 logger.debug('Checking usersVerifyEmail parameters', { parameters: req.params })
431 if (areValidationErrors(req, res)) return
432 if (!await checkUserIdExist(req.params.id, res)) return
434 const user = res.locals.user
435 const redisVerificationString = await Redis.Instance.getVerifyEmailLink(user.id)
437 if (redisVerificationString !== req.body.verificationString) {
439 .status(HttpStatusCode.FORBIDDEN_403)
440 .json({ error: 'Invalid verification string.' })
447 const userAutocompleteValidator = [
448 param('search').isString().not().isEmpty().withMessage('Should have a search parameter')
451 const ensureAuthUserOwnsAccountValidator = [
452 (req: express.Request, res: express.Response, next: express.NextFunction) => {
453 const user = res.locals.oauth.token.User
455 if (res.locals.account.id !== user.Account.id) {
456 return res.status(HttpStatusCode.FORBIDDEN_403)
457 .json({ error: 'Only owner can access ratings list.' })
464 const ensureCanManageUser = [
465 (req: express.Request, res: express.Response, next: express.NextFunction) => {
466 const authUser = res.locals.oauth.token.User
467 const onUser = res.locals.user
469 if (authUser.role === UserRole.ADMINISTRATOR) return next()
470 if (authUser.role === UserRole.MODERATOR && onUser.role === UserRole.USER) return next()
472 return res.status(HttpStatusCode.FORBIDDEN_403)
473 .json({ error: 'A moderator can only manager users.' })
477 // ---------------------------------------------------------------------------
483 usersRegisterValidator,
484 usersBlockingValidator,
485 usersRemoveValidator,
486 usersUpdateValidator,
487 usersUpdateMeValidator,
488 usersVideoRatingValidator,
489 ensureUserRegistrationAllowed,
490 ensureUserRegistrationAllowedForIP,
492 usersAskResetPasswordValidator,
493 usersResetPasswordValidator,
494 usersAskSendVerifyEmailValidator,
495 usersVerifyEmailValidator,
496 userAutocompleteValidator,
497 ensureAuthUserOwnsAccountValidator,
501 // ---------------------------------------------------------------------------
503 function checkUserIdExist (idArg: number | string, res: express.Response, withStats = false) {
504 const id = parseInt(idArg + '', 10)
505 return checkUserExist(() => UserModel.loadByIdWithChannels(id, withStats), res)
508 function checkUserEmailExist (email: string, res: express.Response, abortResponse = true) {
509 return checkUserExist(() => UserModel.loadByEmail(email), res, abortResponse)
512 async function checkUserNameOrEmailDoesNotAlreadyExist (username: string, email: string, res: express.Response) {
513 const user = await UserModel.loadByUsernameOrEmail(username, email)
516 res.status(HttpStatusCode.CONFLICT_409)
517 .json({ error: 'User with this username or email already exists.' })
521 const actor = await ActorModel.loadLocalByName(username)
523 res.status(HttpStatusCode.CONFLICT_409)
524 .json({ error: 'Another actor (account/channel) with this name on this instance already exists or has already existed.' })
531 async function checkUserExist (finder: () => Promise<MUserDefault>, res: express.Response, abortResponse = true) {
532 const user = await finder()
535 if (abortResponse === true) {
536 res.status(HttpStatusCode.NOT_FOUND_404)
537 .json({ error: 'User not found' })
543 res.locals.user = user