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,
125 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
126 enabledResolutions: getEnabledResolutions('live')
132 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
135 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
142 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
149 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
151 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
156 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
158 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
162 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
168 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
170 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
174 videoQuota: CONFIG.USER.VIDEO_QUOTA,
175 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
179 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
183 enabled: CONFIG.TRACKER.ENABLED
189 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
195 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
196 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
197 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
198 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
202 return res.json(json)
205 function getAbout (req: express.Request, res: express.Response) {
206 const about: About = {
208 name: CONFIG.INSTANCE.NAME,
209 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
210 description: CONFIG.INSTANCE.DESCRIPTION,
211 terms: CONFIG.INSTANCE.TERMS,
212 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
214 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
216 creationReason: CONFIG.INSTANCE.CREATION_REASON,
217 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
218 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
219 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
220 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
222 languages: CONFIG.INSTANCE.LANGUAGES,
223 categories: CONFIG.INSTANCE.CATEGORIES
227 return res.json(about).end()
230 function getCustomConfig (req: express.Request, res: express.Response) {
231 const data = customConfig()
233 return res.json(data).end()
236 async function deleteCustomConfig (req: express.Request, res: express.Response) {
237 await remove(CONFIG.CUSTOM_FILE)
239 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
242 ClientHtml.invalidCache()
244 const data = customConfig()
246 return res.json(data)
249 async function updateCustomConfig (req: express.Request, res: express.Response) {
250 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
252 // camelCase to snake_case key + Force number conversion
253 const toUpdateJSON = convertCustomConfigBody(req.body)
255 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
258 ClientHtml.invalidCache()
260 const data = customConfig()
263 getAuditIdFromRes(res),
264 new CustomConfigAuditView(data),
265 oldCustomConfigAuditKeys
268 return res.json(data)
271 function getRegisteredThemes () {
272 return PluginManager.Instance.getRegisteredThemes()
276 description: t.description,
278 clientScripts: t.clientScripts
282 function getEnabledResolutions (type: 'vod' | 'live') {
283 const transcoding = type === 'vod'
285 : CONFIG.LIVE.TRANSCODING
287 return Object.keys(transcoding.RESOLUTIONS)
288 .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true)
289 .map(r => parseInt(r, 10))
292 function getRegisteredPlugins () {
293 return PluginManager.Instance.getRegisteredPlugins()
297 description: p.description,
298 clientScripts: p.clientScripts
302 function getIdAndPassAuthPlugins () {
303 const result: RegisteredIdAndPassAuthConfig[] = []
305 for (const p of PluginManager.Instance.getIdAndPassAuths()) {
306 for (const auth of p.idAndPassAuths) {
311 authName: auth.authName,
312 weight: auth.getWeight()
320 function getExternalAuthsPlugins () {
321 const result: RegisteredExternalAuthConfig[] = []
323 for (const p of PluginManager.Instance.getExternalAuths()) {
324 for (const auth of p.externalAuths) {
329 authName: auth.authName,
330 authDisplayName: auth.authDisplayName()
338 // ---------------------------------------------------------------------------
342 getEnabledResolutions,
343 getRegisteredPlugins,
347 // ---------------------------------------------------------------------------
349 function customConfig (): CustomConfig {
352 name: CONFIG.INSTANCE.NAME,
353 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
354 description: CONFIG.INSTANCE.DESCRIPTION,
355 terms: CONFIG.INSTANCE.TERMS,
356 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
358 creationReason: CONFIG.INSTANCE.CREATION_REASON,
359 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
360 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
361 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
362 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
363 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
365 languages: CONFIG.INSTANCE.LANGUAGES,
366 categories: CONFIG.INSTANCE.CATEGORIES,
368 isNSFW: CONFIG.INSTANCE.IS_NSFW,
369 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
370 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
372 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
373 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
377 default: CONFIG.THEME.DEFAULT
381 username: CONFIG.SERVICES.TWITTER.USERNAME,
382 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
387 size: CONFIG.CACHE.PREVIEWS.SIZE
390 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
394 enabled: CONFIG.SIGNUP.ENABLED,
395 limit: CONFIG.SIGNUP.LIMIT,
396 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
399 email: CONFIG.ADMIN.EMAIL
402 enabled: CONFIG.CONTACT_FORM.ENABLED
405 videoQuota: CONFIG.USER.VIDEO_QUOTA,
406 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
409 enabled: CONFIG.TRANSCODING.ENABLED,
410 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
411 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
412 threads: CONFIG.TRANSCODING.THREADS,
414 '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
415 '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
416 '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
417 '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
418 '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
419 '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
420 '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
423 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
426 enabled: CONFIG.TRANSCODING.HLS.ENABLED
430 enabled: CONFIG.LIVE.ENABLED,
431 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
432 maxDuration: CONFIG.LIVE.MAX_DURATION,
434 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
435 threads: CONFIG.LIVE.TRANSCODING.THREADS,
437 '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'],
438 '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'],
439 '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'],
440 '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'],
441 '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'],
442 '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p']
449 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
452 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
459 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
465 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
466 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
472 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
476 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
477 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
482 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
483 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
484 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
485 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
489 users: CONFIG.SEARCH.REMOTE_URI.USERS,
490 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
493 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
494 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
495 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
496 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
502 function convertCustomConfigBody (body: CustomConfig) {
503 function keyConverter (k: string) {
504 // Transcoding resolutions exception
505 if (/^\d{3,4}p$/.exec(k)) return k
506 if (k === '0p') return k
511 function valueConverter (v: any) {
512 if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
517 return objectConverter(body, keyConverter, valueConverter)