1 import { Hooks } from '@server/lib/plugins/hooks'
2 import * as express from 'express'
3 import { remove, writeJSON } from 'fs-extra'
4 import { snakeCase } from 'lodash'
5 import validator from 'validator'
6 import { RegisteredExternalAuthConfig, RegisteredIdAndPassAuthConfig, ServerConfig, UserRight } from '../../../shared'
7 import { About } from '../../../shared/models/server/about.model'
8 import { CustomConfig } from '../../../shared/models/server/custom-config.model'
9 import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger'
10 import { objectConverter } from '../../helpers/core-utils'
11 import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../helpers/signup'
12 import { getServerCommit } from '../../helpers/utils'
13 import { CONFIG, isEmailEnabled, reloadConfig } from '../../initializers/config'
14 import { CONSTRAINTS_FIELDS, DEFAULT_THEME_NAME, PEERTUBE_VERSION } from '../../initializers/constants'
15 import { ClientHtml } from '../../lib/client-html'
16 import { PluginManager } from '../../lib/plugins/plugin-manager'
17 import { getThemeOrDefault } from '../../lib/plugins/theme-utils'
18 import { asyncMiddleware, authenticate, ensureUserHasRight } from '../../middlewares'
19 import { customConfigUpdateValidator } from '../../middlewares/validators/config'
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),
35 configRouter.put('/custom',
37 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
38 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 Hooks.wrapPromiseFun(
55 'filter:api.user.signup.allowed.result'
58 const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip)
59 const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
61 if (serverCommit === undefined) serverCommit = await getServerCommit()
63 const json: ServerConfig = {
65 name: CONFIG.INSTANCE.NAME,
66 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
67 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
68 isNSFW: CONFIG.INSTANCE.IS_NSFW,
69 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
71 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
72 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
77 users: CONFIG.SEARCH.REMOTE_URI.USERS,
78 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
81 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
82 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
83 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
84 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
88 registered: getRegisteredPlugins(),
89 registeredExternalAuths: getExternalAuthsPlugins(),
90 registeredIdAndPassAuths: getIdAndPassAuthPlugins()
93 registered: getRegisteredThemes(),
97 enabled: isEmailEnabled()
100 enabled: CONFIG.CONTACT_FORM.ENABLED
102 serverVersion: PEERTUBE_VERSION,
107 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
111 enabled: CONFIG.TRANSCODING.HLS.ENABLED
114 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
116 enabledResolutions: getEnabledResolutions('vod')
119 enabled: CONFIG.LIVE.ENABLED,
121 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
122 maxDuration: CONFIG.LIVE.MAX_DURATION,
123 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
124 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
127 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
128 enabledResolutions: getEnabledResolutions('live')
134 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
137 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
144 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
151 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
153 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
158 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
160 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
164 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
170 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
172 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
176 videoQuota: CONFIG.USER.VIDEO_QUOTA,
177 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
181 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
185 enabled: CONFIG.TRACKER.ENABLED
191 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
197 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
198 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
199 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
200 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
204 return res.json(json)
207 function getAbout (req: express.Request, res: express.Response) {
208 const about: About = {
210 name: CONFIG.INSTANCE.NAME,
211 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
212 description: CONFIG.INSTANCE.DESCRIPTION,
213 terms: CONFIG.INSTANCE.TERMS,
214 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
216 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
218 creationReason: CONFIG.INSTANCE.CREATION_REASON,
219 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
220 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
221 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
222 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
224 languages: CONFIG.INSTANCE.LANGUAGES,
225 categories: CONFIG.INSTANCE.CATEGORIES
229 return res.json(about).end()
232 function getCustomConfig (req: express.Request, res: express.Response) {
233 const data = customConfig()
235 return res.json(data).end()
238 async function deleteCustomConfig (req: express.Request, res: express.Response) {
239 await remove(CONFIG.CUSTOM_FILE)
241 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
244 ClientHtml.invalidCache()
246 const data = customConfig()
248 return res.json(data)
251 async function updateCustomConfig (req: express.Request, res: express.Response) {
252 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
254 // camelCase to snake_case key + Force number conversion
255 const toUpdateJSON = convertCustomConfigBody(req.body)
257 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
260 ClientHtml.invalidCache()
262 const data = customConfig()
265 getAuditIdFromRes(res),
266 new CustomConfigAuditView(data),
267 oldCustomConfigAuditKeys
270 return res.json(data)
273 function getRegisteredThemes () {
274 return PluginManager.Instance.getRegisteredThemes()
278 description: t.description,
280 clientScripts: t.clientScripts
284 function getEnabledResolutions (type: 'vod' | 'live') {
285 const transcoding = type === 'vod'
287 : CONFIG.LIVE.TRANSCODING
289 return Object.keys(transcoding.RESOLUTIONS)
290 .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true)
291 .map(r => parseInt(r, 10))
294 function getRegisteredPlugins () {
295 return PluginManager.Instance.getRegisteredPlugins()
299 description: p.description,
300 clientScripts: p.clientScripts
304 function getIdAndPassAuthPlugins () {
305 const result: RegisteredIdAndPassAuthConfig[] = []
307 for (const p of PluginManager.Instance.getIdAndPassAuths()) {
308 for (const auth of p.idAndPassAuths) {
313 authName: auth.authName,
314 weight: auth.getWeight()
322 function getExternalAuthsPlugins () {
323 const result: RegisteredExternalAuthConfig[] = []
325 for (const p of PluginManager.Instance.getExternalAuths()) {
326 for (const auth of p.externalAuths) {
331 authName: auth.authName,
332 authDisplayName: auth.authDisplayName()
340 // ---------------------------------------------------------------------------
344 getEnabledResolutions,
345 getRegisteredPlugins,
349 // ---------------------------------------------------------------------------
351 function customConfig (): CustomConfig {
354 name: CONFIG.INSTANCE.NAME,
355 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
356 description: CONFIG.INSTANCE.DESCRIPTION,
357 terms: CONFIG.INSTANCE.TERMS,
358 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
360 creationReason: CONFIG.INSTANCE.CREATION_REASON,
361 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
362 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
363 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
364 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
365 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
367 languages: CONFIG.INSTANCE.LANGUAGES,
368 categories: CONFIG.INSTANCE.CATEGORIES,
370 isNSFW: CONFIG.INSTANCE.IS_NSFW,
371 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
372 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
374 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
375 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
379 default: CONFIG.THEME.DEFAULT
383 username: CONFIG.SERVICES.TWITTER.USERNAME,
384 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
389 size: CONFIG.CACHE.PREVIEWS.SIZE
392 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
396 enabled: CONFIG.SIGNUP.ENABLED,
397 limit: CONFIG.SIGNUP.LIMIT,
398 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
401 email: CONFIG.ADMIN.EMAIL
404 enabled: CONFIG.CONTACT_FORM.ENABLED
407 videoQuota: CONFIG.USER.VIDEO_QUOTA,
408 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
411 enabled: CONFIG.TRANSCODING.ENABLED,
412 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
413 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
414 threads: CONFIG.TRANSCODING.THREADS,
416 '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
417 '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
418 '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
419 '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
420 '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
421 '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
422 '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
425 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
428 enabled: CONFIG.TRANSCODING.HLS.ENABLED
432 enabled: CONFIG.LIVE.ENABLED,
433 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
434 maxDuration: CONFIG.LIVE.MAX_DURATION,
435 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
436 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
438 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
439 threads: CONFIG.LIVE.TRANSCODING.THREADS,
441 '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'],
442 '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'],
443 '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'],
444 '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'],
445 '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'],
446 '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p']
453 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
456 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
463 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
469 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
470 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
476 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
480 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
481 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
486 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
487 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
488 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
489 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
493 users: CONFIG.SEARCH.REMOTE_URI.USERS,
494 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
497 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
498 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
499 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
500 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
506 function convertCustomConfigBody (body: CustomConfig) {
507 function keyConverter (k: string) {
508 // Transcoding resolutions exception
509 if (/^\d{3,4}p$/.exec(k)) return k
510 if (k === '0p') return k
515 function valueConverter (v: any) {
516 if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
521 return objectConverter(body, keyConverter, valueConverter)