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