server/middlewares/validators/config.ts

   1 import express from 'express'
   2 import { body } from 'express-validator'
   3 import { isIntOrNull } from '@server/helpers/custom-validators/misc'
   4 import { CONFIG, 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 './shared'
  11 import { HttpStatusCode } from '@shared/models/http/http-error-codes'
  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.customizations.css').exists().withMessage('Should have a valid instance CSS customization'),
  21   body('instance.customizations.javascript').exists().withMessage('Should have a valid instance JavaScript customization'),
  22
  23   body('services.twitter.username').exists().withMessage('Should have a valid twitter username'),
  24   body('services.twitter.whitelisted').isBoolean().withMessage('Should have a valid twitter whitelisted boolean'),
  25
  26   body('cache.previews.size').isInt().withMessage('Should have a valid previews cache size'),
  27   body('cache.captions.size').isInt().withMessage('Should have a valid captions cache size'),
  28   body('cache.torrents.size').isInt().withMessage('Should have a valid torrents 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   body('signup.minimumAge').isInt().withMessage("Should have a valid minimum age required"),
  34
  35   body('admin.email').isEmail().withMessage('Should have a valid administrator email'),
  36   body('contactForm.enabled').isBoolean().withMessage('Should have a valid contact form enabled boolean'),
  37
  38   body('user.videoQuota').custom(isUserVideoQuotaValid).withMessage('Should have a valid video quota'),
  39   body('user.videoQuotaDaily').custom(isUserVideoQuotaDailyValid).withMessage('Should have a valid daily video quota'),
  40
  41   body('transcoding.enabled').isBoolean().withMessage('Should have a valid transcoding enabled boolean'),
  42   body('transcoding.allowAdditionalExtensions').isBoolean().withMessage('Should have a valid additional extensions boolean'),
  43   body('transcoding.threads').isInt().withMessage('Should have a valid transcoding threads number'),
  44   body('transcoding.concurrency').isInt({ min: 1 }).withMessage('Should have a valid transcoding concurrency number'),
  45   body('transcoding.resolutions.0p').isBoolean().withMessage('Should have a valid transcoding 0p resolution enabled boolean'),
  46   body('transcoding.resolutions.240p').isBoolean().withMessage('Should have a valid transcoding 240p resolution enabled boolean'),
  47   body('transcoding.resolutions.360p').isBoolean().withMessage('Should have a valid transcoding 360p resolution enabled boolean'),
  48   body('transcoding.resolutions.480p').isBoolean().withMessage('Should have a valid transcoding 480p resolution enabled boolean'),
  49   body('transcoding.resolutions.720p').isBoolean().withMessage('Should have a valid transcoding 720p resolution enabled boolean'),
  50   body('transcoding.resolutions.1080p').isBoolean().withMessage('Should have a valid transcoding 1080p resolution enabled boolean'),
  51   body('transcoding.resolutions.1440p').isBoolean().withMessage('Should have a valid transcoding 1440p resolution enabled boolean'),
  52   body('transcoding.resolutions.2160p').isBoolean().withMessage('Should have a valid transcoding 2160p resolution enabled boolean'),
  53
  54   body('transcoding.webtorrent.enabled').isBoolean().withMessage('Should have a valid webtorrent transcoding enabled boolean'),
  55   body('transcoding.hls.enabled').isBoolean().withMessage('Should have a valid hls transcoding enabled boolean'),
  56
  57   body('import.videos.concurrency').isInt({ min: 0 }).withMessage('Should have a valid import concurrency number'),
  58   body('import.videos.http.enabled').isBoolean().withMessage('Should have a valid import video http enabled boolean'),
  59   body('import.videos.torrent.enabled').isBoolean().withMessage('Should have a valid import video torrent enabled boolean'),
  60
  61   body('trending.videos.algorithms.default').exists().withMessage('Should have a valid default trending algorithm'),
  62   body('trending.videos.algorithms.enabled').exists().withMessage('Should have a valid array of enabled trending algorithms'),
  63
  64   body('followers.instance.enabled').isBoolean().withMessage('Should have a valid followers of instance boolean'),
  65   body('followers.instance.manualApproval').isBoolean().withMessage('Should have a valid manual approval boolean'),
  66
  67   body('theme.default').custom(v => isThemeNameValid(v) && isThemeRegistered(v)).withMessage('Should have a valid theme'),
  68
  69   body('broadcastMessage.enabled').isBoolean().withMessage('Should have a valid broadcast message enabled boolean'),
  70   body('broadcastMessage.message').exists().withMessage('Should have a valid broadcast message'),
  71   body('broadcastMessage.level').exists().withMessage('Should have a valid broadcast level'),
  72   body('broadcastMessage.dismissable').isBoolean().withMessage('Should have a valid broadcast dismissable boolean'),
  73
  74   body('live.enabled').isBoolean().withMessage('Should have a valid live enabled boolean'),
  75   body('live.allowReplay').isBoolean().withMessage('Should have a valid live allow replay boolean'),
  76   body('live.maxDuration').isInt().withMessage('Should have a valid live max duration'),
  77   body('live.maxInstanceLives').custom(isIntOrNull).withMessage('Should have a valid max instance lives'),
  78   body('live.maxUserLives').custom(isIntOrNull).withMessage('Should have a valid max user lives'),
  79   body('live.transcoding.enabled').isBoolean().withMessage('Should have a valid live transcoding enabled boolean'),
  80   body('live.transcoding.threads').isInt().withMessage('Should have a valid live transcoding threads'),
  81   body('live.transcoding.resolutions.240p').isBoolean().withMessage('Should have a valid transcoding 240p resolution enabled boolean'),
  82   body('live.transcoding.resolutions.360p').isBoolean().withMessage('Should have a valid transcoding 360p resolution enabled boolean'),
  83   body('live.transcoding.resolutions.480p').isBoolean().withMessage('Should have a valid transcoding 480p resolution enabled boolean'),
  84   body('live.transcoding.resolutions.720p').isBoolean().withMessage('Should have a valid transcoding 720p resolution enabled boolean'),
  85   body('live.transcoding.resolutions.1080p').isBoolean().withMessage('Should have a valid transcoding 1080p resolution enabled boolean'),
  86   body('live.transcoding.resolutions.1440p').isBoolean().withMessage('Should have a valid transcoding 1440p resolution enabled boolean'),
  87   body('live.transcoding.resolutions.2160p').isBoolean().withMessage('Should have a valid transcoding 2160p resolution enabled boolean'),
  88
  89   body('search.remoteUri.users').isBoolean().withMessage('Should have a remote URI search for users boolean'),
  90   body('search.remoteUri.anonymous').isBoolean().withMessage('Should have a valid remote URI search for anonymous boolean'),
  91   body('search.searchIndex.enabled').isBoolean().withMessage('Should have a valid search index enabled boolean'),
  92   body('search.searchIndex.url').exists().withMessage('Should have a valid search index URL'),
  93   body('search.searchIndex.disableLocalSearch').isBoolean().withMessage('Should have a valid search index disable local search boolean'),
  94   body('search.searchIndex.isDefaultSearch').isBoolean().withMessage('Should have a valid search index default enabled boolean'),
  95
  96   (req: express.Request, res: express.Response, next: express.NextFunction) => {
  97     logger.debug('Checking customConfigUpdateValidator parameters', { parameters: req.body })
  98
  99     if (areValidationErrors(req, res)) return
 100     if (!checkInvalidConfigIfEmailDisabled(req.body, res)) return
 101     if (!checkInvalidTranscodingConfig(req.body, res)) return
 102     if (!checkInvalidLiveConfig(req.body, res)) return
 103
 104     return next()
 105   }
 106 ]
 107
 108 function ensureConfigIsEditable (req: express.Request, res: express.Response, next: express.NextFunction) {
 109   if (!CONFIG.WEBADMIN.CONFIGURATION.EDITION.ALLOWED) {
 110     return res.fail({
 111       status: HttpStatusCode.METHOD_NOT_ALLOWED_405,
 112       message: 'Server configuration is static and cannot be edited'
 113     })
 114   }
 115
 116   return next()
 117 }
 118
 119 // ---------------------------------------------------------------------------
 120
 121 export {
 122   customConfigUpdateValidator,
 123   ensureConfigIsEditable
 124 }
 125
 126 function checkInvalidConfigIfEmailDisabled (customConfig: CustomConfig, res: express.Response) {
 127   if (isEmailEnabled()) return true
 128
 129   if (customConfig.signup.requiresEmailVerification === true) {
 130     res.fail({ message: 'Emailer is disabled but you require signup email verification.' })
 131     return false
 132   }
 133
 134   return true
 135 }
 136
 137 function checkInvalidTranscodingConfig (customConfig: CustomConfig, res: express.Response) {
 138   if (customConfig.transcoding.enabled === false) return true
 139
 140   if (customConfig.transcoding.webtorrent.enabled === false && customConfig.transcoding.hls.enabled === false) {
 141     res.fail({ message: 'You need to enable at least webtorrent transcoding or hls transcoding' })
 142     return false
 143   }
 144
 145   return true
 146 }
 147
 148 function checkInvalidLiveConfig (customConfig: CustomConfig, res: express.Response) {
 149   if (customConfig.live.enabled === false) return true
 150
 151   if (customConfig.live.allowReplay === true && customConfig.transcoding.enabled === false) {
 152     res.fail({ message: 'You cannot allow live replay if transcoding is not enabled' })
 153     return false
 154   }
 155
 156   return true
 157 }