]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - server/middlewares/validators/config.ts
Don't guess remote tracker URL
[github/Chocobozzz/PeerTube.git] / server / middlewares / validators / config.ts
CommitLineData
fd206f0b 1import * as express from 'express'
c8861d5d 2import { body } from 'express-validator'
fb719404
C
3import { isIntOrNull } from '@server/helpers/custom-validators/misc'
4import { isEmailEnabled } from '@server/initializers/config'
c9bc850e 5import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes'
576ad67a 6import { CustomConfig } from '../../../shared/models/server/custom-config.model'
503c6f44 7import { isThemeNameValid } from '../../helpers/custom-validators/plugins'
fb719404
C
8import { isUserNSFWPolicyValid, isUserVideoQuotaDailyValid, isUserVideoQuotaValid } from '../../helpers/custom-validators/users'
9import { logger } from '../../helpers/logger'
503c6f44 10import { isThemeRegistered } from '../../lib/plugins/theme-utils'
fb719404 11import { areValidationErrors } from './utils'
fd206f0b
C
12
13const customConfigUpdateValidator = [
901637bb 14 body('instance.name').exists().withMessage('Should have a valid instance name'),
a4101923 15 body('instance.shortDescription').exists().withMessage('Should have a valid instance short description'),
901637bb
C
16 body('instance.description').exists().withMessage('Should have a valid instance description'),
17 body('instance.terms').exists().withMessage('Should have a valid instance terms'),
0883b324 18 body('instance.defaultNSFWPolicy').custom(isUserNSFWPolicyValid).withMessage('Should have a valid NSFW policy'),
3da68f0a 19 body('instance.defaultClientRoute').exists().withMessage('Should have a valid instance default client route'),
901637bb
C
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'),
a4101923
C
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
fd206f0b
C
29 body('signup.enabled').isBoolean().withMessage('Should have a valid signup enabled boolean'),
30 body('signup.limit').isInt().withMessage('Should have a valid signup limit'),
a4101923
C
31 body('signup.requiresEmailVerification').isBoolean().withMessage('Should have a valid requiresEmailVerification boolean'),
32
fd206f0b 33 body('admin.email').isEmail().withMessage('Should have a valid administrator email'),
a4101923
C
34 body('contactForm.enabled').isBoolean().withMessage('Should have a valid contact form enabled boolean'),
35
fd206f0b 36 body('user.videoQuota').custom(isUserVideoQuotaValid).withMessage('Should have a valid video quota'),
a4101923
C
37 body('user.videoQuotaDaily').custom(isUserVideoQuotaDailyValid).withMessage('Should have a valid daily video quota'),
38
fd206f0b 39 body('transcoding.enabled').isBoolean().withMessage('Should have a valid transcoding enabled boolean'),
a4101923 40 body('transcoding.allowAdditionalExtensions').isBoolean().withMessage('Should have a valid additional extensions boolean'),
fd206f0b 41 body('transcoding.threads').isInt().withMessage('Should have a valid transcoding threads number'),
9129b769 42 body('transcoding.concurrency').isInt({ min: 1 }).withMessage('Should have a valid transcoding concurrency number'),
5c7d6508 43 body('transcoding.resolutions.0p').isBoolean().withMessage('Should have a valid transcoding 0p resolution enabled boolean'),
fd206f0b
C
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'),
b7085c71 49 body('transcoding.resolutions.1440p').isBoolean().withMessage('Should have a valid transcoding 1440p resolution enabled boolean'),
fb719404 50 body('transcoding.resolutions.2160p').isBoolean().withMessage('Should have a valid transcoding 2160p resolution enabled boolean'),
a4101923 51
d7a25329 52 body('transcoding.webtorrent.enabled').isBoolean().withMessage('Should have a valid webtorrent transcoding enabled boolean'),
04cda1d7 53 body('transcoding.hls.enabled').isBoolean().withMessage('Should have a valid hls transcoding enabled boolean'),
d7a25329 54
9129b769 55 body('import.videos.concurrency').isInt({ min: 0 }).withMessage('Should have a valid import concurrency number'),
5d08a6a7 56 body('import.videos.http.enabled').isBoolean().withMessage('Should have a valid import video http enabled boolean'),
a84b8fa5 57 body('import.videos.torrent.enabled').isBoolean().withMessage('Should have a valid import video torrent enabled boolean'),
fd206f0b 58
ba5d4a84
RK
59 body('trending.videos.algorithms.default').exists().withMessage('Should have a valid default trending algorithm'),
60 body('trending.videos.algorithms.enabled').exists().withMessage('Should have a valid array of enabled trending algorithms'),
61
14893eb7
C
62 body('followers.instance.enabled').isBoolean().withMessage('Should have a valid followers of instance boolean'),
63 body('followers.instance.manualApproval').isBoolean().withMessage('Should have a valid manual approval boolean'),
64
503c6f44 65 body('theme.default').custom(v => isThemeNameValid(v) && isThemeRegistered(v)).withMessage('Should have a valid theme'),
7cd4d2ba 66
72c33e71
C
67 body('broadcastMessage.enabled').isBoolean().withMessage('Should have a valid broadcast message enabled boolean'),
68 body('broadcastMessage.message').exists().withMessage('Should have a valid broadcast message'),
69 body('broadcastMessage.level').exists().withMessage('Should have a valid broadcast level'),
5fb2e288
C
70 body('broadcastMessage.dismissable').isBoolean().withMessage('Should have a valid broadcast dismissable boolean'),
71
fb719404
C
72 body('live.enabled').isBoolean().withMessage('Should have a valid live enabled boolean'),
73 body('live.allowReplay').isBoolean().withMessage('Should have a valid live allow replay boolean'),
c9bc850e 74 body('live.maxDuration').isInt().withMessage('Should have a valid live max duration'),
a056ca48
C
75 body('live.maxInstanceLives').custom(isIntOrNull).withMessage('Should have a valid max instance lives'),
76 body('live.maxUserLives').custom(isIntOrNull).withMessage('Should have a valid max user lives'),
fb719404
C
77 body('live.transcoding.enabled').isBoolean().withMessage('Should have a valid live transcoding enabled boolean'),
78 body('live.transcoding.threads').isInt().withMessage('Should have a valid live transcoding threads'),
79 body('live.transcoding.resolutions.240p').isBoolean().withMessage('Should have a valid transcoding 240p resolution enabled boolean'),
80 body('live.transcoding.resolutions.360p').isBoolean().withMessage('Should have a valid transcoding 360p resolution enabled boolean'),
81 body('live.transcoding.resolutions.480p').isBoolean().withMessage('Should have a valid transcoding 480p resolution enabled boolean'),
82 body('live.transcoding.resolutions.720p').isBoolean().withMessage('Should have a valid transcoding 720p resolution enabled boolean'),
83 body('live.transcoding.resolutions.1080p').isBoolean().withMessage('Should have a valid transcoding 1080p resolution enabled boolean'),
b7085c71 84 body('live.transcoding.resolutions.1440p').isBoolean().withMessage('Should have a valid transcoding 1440p resolution enabled boolean'),
fb719404
C
85 body('live.transcoding.resolutions.2160p').isBoolean().withMessage('Should have a valid transcoding 2160p resolution enabled boolean'),
86
5fb2e288
C
87 body('search.remoteUri.users').isBoolean().withMessage('Should have a remote URI search for users boolean'),
88 body('search.remoteUri.anonymous').isBoolean().withMessage('Should have a valid remote URI search for anonymous boolean'),
89 body('search.searchIndex.enabled').isBoolean().withMessage('Should have a valid search index enabled boolean'),
90 body('search.searchIndex.url').exists().withMessage('Should have a valid search index URL'),
91 body('search.searchIndex.disableLocalSearch').isBoolean().withMessage('Should have a valid search index disable local search boolean'),
92 body('search.searchIndex.isDefaultSearch').isBoolean().withMessage('Should have a valid search index default enabled boolean'),
72c33e71 93
a1587156 94 (req: express.Request, res: express.Response, next: express.NextFunction) => {
fd206f0b
C
95 logger.debug('Checking customConfigUpdateValidator parameters', { parameters: req.body })
96
97 if (areValidationErrors(req, res)) return
fb719404
C
98 if (!checkInvalidConfigIfEmailDisabled(req.body, res)) return
99 if (!checkInvalidTranscodingConfig(req.body, res)) return
100 if (!checkInvalidLiveConfig(req.body, res)) return
fd206f0b
C
101
102 return next()
103 }
104]
105
576ad67a
JM
106// ---------------------------------------------------------------------------
107
fd206f0b
C
108export {
109 customConfigUpdateValidator
110}
576ad67a
JM
111
112function checkInvalidConfigIfEmailDisabled (customConfig: CustomConfig, res: express.Response) {
4c1c1709 113 if (isEmailEnabled()) return true
576ad67a
JM
114
115 if (customConfig.signup.requiresEmailVerification === true) {
2d53be02
RK
116 res.status(HttpStatusCode.BAD_REQUEST_400)
117 .send({ error: 'Emailer is disabled but you require signup email verification.' })
118 .end()
576ad67a
JM
119 return false
120 }
121
122 return true
123}
d7a25329
C
124
125function checkInvalidTranscodingConfig (customConfig: CustomConfig, res: express.Response) {
126 if (customConfig.transcoding.enabled === false) return true
127
128 if (customConfig.transcoding.webtorrent.enabled === false && customConfig.transcoding.hls.enabled === false) {
2d53be02 129 res.status(HttpStatusCode.BAD_REQUEST_400)
d7a25329
C
130 .send({ error: 'You need to enable at least webtorrent transcoding or hls transcoding' })
131 .end()
132 return false
133 }
134
135 return true
136}
fb719404
C
137
138function checkInvalidLiveConfig (customConfig: CustomConfig, res: express.Response) {
139 if (customConfig.live.enabled === false) return true
140
141 if (customConfig.live.allowReplay === true && customConfig.transcoding.enabled === false) {
2d53be02 142 res.status(HttpStatusCode.BAD_REQUEST_400)
fb719404
C
143 .send({ error: 'You cannot allow live replay if transcoding is not enabled' })
144 .end()
145 return false
146 }
147
148 return true
149}