server/middlewares/validators/config.ts

   1 import * as express from 'express'
   2 import { body } from 'express-validator'
   3 import { isIntOrNull } from '@server/helpers/custom-validators/misc'
   4 import { isEmailEnabled } from '@server/initializers/config'
   5 import { CustomConfig } from '../../../shared/models/server/custom-config.model'
   6 import { isThemeNameValid } from '../../helpers/custom-validators/plugins'
   7 import { isUserNSFWPolicyValid, isUserVideoQuotaDailyValid, isUserVideoQuotaValid } from '../../helpers/custom-validators/users'
   8 import { logger } from '../../helpers/logger'
   9 import { isThemeRegistered } from '../../lib/plugins/theme-utils'
  10 import { areValidationErrors } from './utils'
  11
  12 const customConfigUpdateValidator = [
  13   body('instance.name').exists().withMessage('Should have a valid instance name'),
  14   body('instance.shortDescription').exists().withMessage('Should have a valid instance short description'),
  15   body('instance.description').exists().withMessage('Should have a valid instance description'),
  16   body('instance.terms').exists().withMessage('Should have a valid instance terms'),
  17   body('instance.defaultClientRoute').exists().withMessage('Should have a valid instance default client route'),
  18   body('instance.defaultNSFWPolicy').custom(isUserNSFWPolicyValid).withMessage('Should have a valid NSFW policy'),
  19   body('instance.customizations.css').exists().withMessage('Should have a valid instance CSS customization'),
  20   body('instance.customizations.javascript').exists().withMessage('Should have a valid instance JavaScript customization'),
  21
  22   body('services.twitter.username').exists().withMessage('Should have a valid twitter username'),
  23   body('services.twitter.whitelisted').isBoolean().withMessage('Should have a valid twitter whitelisted boolean'),
  24
  25   body('cache.previews.size').isInt().withMessage('Should have a valid previews cache size'),
  26   body('cache.captions.size').isInt().withMessage('Should have a valid captions cache size'),
  27
  28   body('signup.enabled').isBoolean().withMessage('Should have a valid signup enabled boolean'),
  29   body('signup.limit').isInt().withMessage('Should have a valid signup limit'),
  30   body('signup.requiresEmailVerification').isBoolean().withMessage('Should have a valid requiresEmailVerification boolean'),
  31
  32   body('admin.email').isEmail().withMessage('Should have a valid administrator email'),
  33   body('contactForm.enabled').isBoolean().withMessage('Should have a valid contact form enabled boolean'),
  34
  35   body('user.videoQuota').custom(isUserVideoQuotaValid).withMessage('Should have a valid video quota'),
  36   body('user.videoQuotaDaily').custom(isUserVideoQuotaDailyValid).withMessage('Should have a valid daily video quota'),
  37
  38   body('transcoding.enabled').isBoolean().withMessage('Should have a valid transcoding enabled boolean'),
  39   body('transcoding.allowAdditionalExtensions').isBoolean().withMessage('Should have a valid additional extensions boolean'),
  40   body('transcoding.threads').isInt().withMessage('Should have a valid transcoding threads number'),
  41   body('transcoding.resolutions.0p').isBoolean().withMessage('Should have a valid transcoding 0p resolution enabled boolean'),
  42   body('transcoding.resolutions.240p').isBoolean().withMessage('Should have a valid transcoding 240p resolution enabled boolean'),
  43   body('transcoding.resolutions.360p').isBoolean().withMessage('Should have a valid transcoding 360p resolution enabled boolean'),
  44   body('transcoding.resolutions.480p').isBoolean().withMessage('Should have a valid transcoding 480p resolution enabled boolean'),
  45   body('transcoding.resolutions.720p').isBoolean().withMessage('Should have a valid transcoding 720p resolution enabled boolean'),
  46   body('transcoding.resolutions.1080p').isBoolean().withMessage('Should have a valid transcoding 1080p resolution enabled boolean'),
  47   body('transcoding.resolutions.2160p').isBoolean().withMessage('Should have a valid transcoding 2160p resolution enabled boolean'),
  48
  49   body('transcoding.webtorrent.enabled').isBoolean().withMessage('Should have a valid webtorrent transcoding enabled boolean'),
  50   body('transcoding.hls.enabled').isBoolean().withMessage('Should have a valid hls transcoding enabled boolean'),
  51
  52   body('import.videos.http.enabled').isBoolean().withMessage('Should have a valid import video http enabled boolean'),
  53   body('import.videos.torrent.enabled').isBoolean().withMessage('Should have a valid import video torrent enabled boolean'),
  54
  55   body('followers.instance.enabled').isBoolean().withMessage('Should have a valid followers of instance boolean'),
  56   body('followers.instance.manualApproval').isBoolean().withMessage('Should have a valid manual approval boolean'),
  57
  58   body('theme.default').custom(v => isThemeNameValid(v) && isThemeRegistered(v)).withMessage('Should have a valid theme'),
  59
  60   body('broadcastMessage.enabled').isBoolean().withMessage('Should have a valid broadcast message enabled boolean'),
  61   body('broadcastMessage.message').exists().withMessage('Should have a valid broadcast message'),
  62   body('broadcastMessage.level').exists().withMessage('Should have a valid broadcast level'),
  63   body('broadcastMessage.dismissable').isBoolean().withMessage('Should have a valid broadcast dismissable boolean'),
  64
  65   body('live.enabled').isBoolean().withMessage('Should have a valid live enabled boolean'),
  66   body('live.allowReplay').isBoolean().withMessage('Should have a valid live allow replay boolean'),
  67   body('live.maxDuration').custom(isIntOrNull).withMessage('Should have a valid live max duration'),
  68   body('live.maxInstanceLives').custom(isIntOrNull).withMessage('Should have a valid max instance lives'),
  69   body('live.maxUserLives').custom(isIntOrNull).withMessage('Should have a valid max user lives'),
  70   body('live.transcoding.enabled').isBoolean().withMessage('Should have a valid live transcoding enabled boolean'),
  71   body('live.transcoding.threads').isInt().withMessage('Should have a valid live transcoding threads'),
  72   body('live.transcoding.resolutions.240p').isBoolean().withMessage('Should have a valid transcoding 240p resolution enabled boolean'),
  73   body('live.transcoding.resolutions.360p').isBoolean().withMessage('Should have a valid transcoding 360p resolution enabled boolean'),
  74   body('live.transcoding.resolutions.480p').isBoolean().withMessage('Should have a valid transcoding 480p resolution enabled boolean'),
  75   body('live.transcoding.resolutions.720p').isBoolean().withMessage('Should have a valid transcoding 720p resolution enabled boolean'),
  76   body('live.transcoding.resolutions.1080p').isBoolean().withMessage('Should have a valid transcoding 1080p resolution enabled boolean'),
  77   body('live.transcoding.resolutions.2160p').isBoolean().withMessage('Should have a valid transcoding 2160p resolution enabled boolean'),
  78
  79   body('search.remoteUri.users').isBoolean().withMessage('Should have a remote URI search for users boolean'),
  80   body('search.remoteUri.anonymous').isBoolean().withMessage('Should have a valid remote URI search for anonymous boolean'),
  81   body('search.searchIndex.enabled').isBoolean().withMessage('Should have a valid search index enabled boolean'),
  82   body('search.searchIndex.url').exists().withMessage('Should have a valid search index URL'),
  83   body('search.searchIndex.disableLocalSearch').isBoolean().withMessage('Should have a valid search index disable local search boolean'),
  84   body('search.searchIndex.isDefaultSearch').isBoolean().withMessage('Should have a valid search index default enabled boolean'),
  85
  86   (req: express.Request, res: express.Response, next: express.NextFunction) => {
  87     logger.debug('Checking customConfigUpdateValidator parameters', { parameters: req.body })
  88
  89     if (areValidationErrors(req, res)) return
  90     if (!checkInvalidConfigIfEmailDisabled(req.body, res)) return
  91     if (!checkInvalidTranscodingConfig(req.body, res)) return
  92     if (!checkInvalidLiveConfig(req.body, res)) return
  93
  94     return next()
  95   }
  96 ]
  97
  98 // ---------------------------------------------------------------------------
  99
 100 export {
 101   customConfigUpdateValidator
 102 }
 103
 104 function checkInvalidConfigIfEmailDisabled (customConfig: CustomConfig, res: express.Response) {
 105   if (isEmailEnabled()) return true
 106
 107   if (customConfig.signup.requiresEmailVerification === true) {
 108     res.status(400)
 109       .send({ error: 'Emailer is disabled but you require signup email verification.' })
 110       .end()
 111     return false
 112   }
 113
 114   return true
 115 }
 116
 117 function checkInvalidTranscodingConfig (customConfig: CustomConfig, res: express.Response) {
 118   if (customConfig.transcoding.enabled === false) return true
 119
 120   if (customConfig.transcoding.webtorrent.enabled === false && customConfig.transcoding.hls.enabled === false) {
 121     res.status(400)
 122        .send({ error: 'You need to enable at least webtorrent transcoding or hls transcoding' })
 123        .end()
 124     return false
 125   }
 126
 127   return true
 128 }
 129
 130 function checkInvalidLiveConfig (customConfig: CustomConfig, res: express.Response) {
 131   if (customConfig.live.enabled === false) return true
 132
 133   if (customConfig.live.allowReplay === true && customConfig.transcoding.enabled === false) {
 134     res.status(400)
 135        .send({ error: 'You cannot allow live replay if transcoding is not enabled' })
 136        .end()
 137     return false
 138   }
 139
 140   return true
 141 }