1 import * as express from 'express'
2 import { snakeCase } from 'lodash'
3 import { ServerConfig, UserRight } from '../../../shared'
4 import { About } from '../../../shared/models/server/about.model'
5 import { CustomConfig } from '../../../shared/models/server/custom-config.model'
6 import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../helpers/signup'
7 import { CONSTRAINTS_FIELDS, DEFAULT_THEME_NAME, PEERTUBE_VERSION } from '../../initializers/constants'
8 import { asyncMiddleware, authenticate, ensureUserHasRight } from '../../middlewares'
9 import { customConfigUpdateValidator } from '../../middlewares/validators/config'
10 import { ClientHtml } from '../../lib/client-html'
11 import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger'
12 import { remove, writeJSON } from 'fs-extra'
13 import { getServerCommit } from '../../helpers/utils'
14 import { Emailer } from '../../lib/emailer'
15 import { isNumeric } from 'validator'
16 import { objectConverter } from '../../helpers/core-utils'
17 import { CONFIG, reloadConfig } from '../../initializers/config'
18 import { PluginManager } from '../../lib/plugins/plugin-manager'
19 import { getThemeOrDefault } from '../../lib/plugins/theme-utils'
21 const configRouter = express.Router()
23 const auditLogger = auditLoggerFactory('config')
25 configRouter.get('/about', getAbout)
27 asyncMiddleware(getConfig)
30 configRouter.get('/custom',
32 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
33 asyncMiddleware(getCustomConfig)
35 configRouter.put('/custom',
37 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
38 asyncMiddleware(customConfigUpdateValidator),
39 asyncMiddleware(updateCustomConfig)
41 configRouter.delete('/custom',
43 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
44 asyncMiddleware(deleteCustomConfig)
47 let serverCommit: string
49 async function getConfig (req: express.Request, res: express.Response) {
50 const allowed = await isSignupAllowed()
51 const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip)
52 const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
54 if (serverCommit === undefined) serverCommit = await getServerCommit()
56 const json: ServerConfig = {
58 name: CONFIG.INSTANCE.NAME,
59 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
60 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
61 isNSFW: CONFIG.INSTANCE.IS_NSFW,
62 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
64 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
65 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
69 registered: getRegisteredPlugins()
72 registered: getRegisteredThemes(),
76 enabled: Emailer.isEnabled()
79 enabled: CONFIG.CONTACT_FORM.ENABLED
81 serverVersion: PEERTUBE_VERSION,
86 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
90 enabled: CONFIG.TRANSCODING.HLS.ENABLED
92 enabledResolutions: getEnabledResolutions()
97 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
100 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
107 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
114 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
116 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
121 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
123 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
127 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
133 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
135 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
139 videoQuota: CONFIG.USER.VIDEO_QUOTA,
140 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
144 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
148 enabled: CONFIG.TRACKER.ENABLED
152 return res.json(json)
155 function getAbout (req: express.Request, res: express.Response) {
156 const about: About = {
158 name: CONFIG.INSTANCE.NAME,
159 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
160 description: CONFIG.INSTANCE.DESCRIPTION,
161 terms: CONFIG.INSTANCE.TERMS
165 return res.json(about).end()
168 async function getCustomConfig (req: express.Request, res: express.Response) {
169 const data = customConfig()
171 return res.json(data).end()
174 async function deleteCustomConfig (req: express.Request, res: express.Response) {
175 await remove(CONFIG.CUSTOM_FILE)
177 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
180 ClientHtml.invalidCache()
182 const data = customConfig()
184 return res.json(data).end()
187 async function updateCustomConfig (req: express.Request, res: express.Response) {
188 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
190 // camelCase to snake_case key + Force number conversion
191 const toUpdateJSON = convertCustomConfigBody(req.body)
193 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
196 ClientHtml.invalidCache()
198 const data = customConfig()
201 getAuditIdFromRes(res),
202 new CustomConfigAuditView(data),
203 oldCustomConfigAuditKeys
206 return res.json(data).end()
209 // ---------------------------------------------------------------------------
215 // ---------------------------------------------------------------------------
217 function customConfig (): CustomConfig {
220 name: CONFIG.INSTANCE.NAME,
221 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
222 description: CONFIG.INSTANCE.DESCRIPTION,
223 terms: CONFIG.INSTANCE.TERMS,
224 isNSFW: CONFIG.INSTANCE.IS_NSFW,
225 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
226 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
228 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
229 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
233 default: CONFIG.THEME.DEFAULT
237 username: CONFIG.SERVICES.TWITTER.USERNAME,
238 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
243 size: CONFIG.CACHE.PREVIEWS.SIZE
246 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
250 enabled: CONFIG.SIGNUP.ENABLED,
251 limit: CONFIG.SIGNUP.LIMIT,
252 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
255 email: CONFIG.ADMIN.EMAIL
258 enabled: CONFIG.CONTACT_FORM.ENABLED
261 videoQuota: CONFIG.USER.VIDEO_QUOTA,
262 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
265 enabled: CONFIG.TRANSCODING.ENABLED,
266 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
267 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
268 threads: CONFIG.TRANSCODING.THREADS,
270 '240p': CONFIG.TRANSCODING.RESOLUTIONS[ '240p' ],
271 '360p': CONFIG.TRANSCODING.RESOLUTIONS[ '360p' ],
272 '480p': CONFIG.TRANSCODING.RESOLUTIONS[ '480p' ],
273 '720p': CONFIG.TRANSCODING.RESOLUTIONS[ '720p' ],
274 '1080p': CONFIG.TRANSCODING.RESOLUTIONS[ '1080p' ],
275 '2160p': CONFIG.TRANSCODING.RESOLUTIONS[ '2160p' ]
278 enabled: CONFIG.TRANSCODING.HLS.ENABLED
284 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
287 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
294 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
300 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
301 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
307 function convertCustomConfigBody (body: CustomConfig) {
308 function keyConverter (k: string) {
309 // Transcoding resolutions exception
310 if (/^\d{3,4}p$/.exec(k)) return k
315 function valueConverter (v: any) {
316 if (isNumeric(v + '')) return parseInt('' + v, 10)
321 return objectConverter(body, keyConverter, valueConverter)
324 function getRegisteredThemes () {
325 return PluginManager.Instance.getRegisteredThemes()
329 description: t.description,
331 clientScripts: t.clientScripts
335 function getEnabledResolutions () {
336 return Object.keys(CONFIG.TRANSCODING.RESOLUTIONS)
337 .filter(key => CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.RESOLUTIONS[ key ] === true)
338 .map(r => parseInt(r, 10))
341 function getRegisteredPlugins () {
342 return PluginManager.Instance.getRegisteredPlugins()
346 description: p.description,
347 clientScripts: p.clientScripts