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()
121 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
124 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
131 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
138 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
140 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
145 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
147 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
151 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
157 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
159 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
163 videoQuota: CONFIG.USER.VIDEO_QUOTA,
164 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
168 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
172 enabled: CONFIG.TRACKER.ENABLED
178 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
184 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
185 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
186 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
187 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
191 return res.json(json)
194 function getAbout (req: express.Request, res: express.Response) {
195 const about: About = {
197 name: CONFIG.INSTANCE.NAME,
198 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
199 description: CONFIG.INSTANCE.DESCRIPTION,
200 terms: CONFIG.INSTANCE.TERMS,
201 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
203 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
205 creationReason: CONFIG.INSTANCE.CREATION_REASON,
206 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
207 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
208 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
209 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
211 languages: CONFIG.INSTANCE.LANGUAGES,
212 categories: CONFIG.INSTANCE.CATEGORIES
216 return res.json(about).end()
219 function getCustomConfig (req: express.Request, res: express.Response) {
220 const data = customConfig()
222 return res.json(data).end()
225 async function deleteCustomConfig (req: express.Request, res: express.Response) {
226 await remove(CONFIG.CUSTOM_FILE)
228 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
231 ClientHtml.invalidCache()
233 const data = customConfig()
235 return res.json(data).end()
238 async function updateCustomConfig (req: express.Request, res: express.Response) {
239 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
241 // camelCase to snake_case key + Force number conversion
242 const toUpdateJSON = convertCustomConfigBody(req.body)
244 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
247 ClientHtml.invalidCache()
249 const data = customConfig()
252 getAuditIdFromRes(res),
253 new CustomConfigAuditView(data),
254 oldCustomConfigAuditKeys
257 return res.json(data).end()
260 function getRegisteredThemes () {
261 return PluginManager.Instance.getRegisteredThemes()
265 description: t.description,
267 clientScripts: t.clientScripts
271 function getEnabledResolutions () {
272 return Object.keys(CONFIG.TRANSCODING.RESOLUTIONS)
273 .filter(key => CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.RESOLUTIONS[key] === true)
274 .map(r => parseInt(r, 10))
277 function getRegisteredPlugins () {
278 return PluginManager.Instance.getRegisteredPlugins()
282 description: p.description,
283 clientScripts: p.clientScripts
287 function getIdAndPassAuthPlugins () {
288 const result: RegisteredIdAndPassAuthConfig[] = []
290 for (const p of PluginManager.Instance.getIdAndPassAuths()) {
291 for (const auth of p.idAndPassAuths) {
296 authName: auth.authName,
297 weight: auth.getWeight()
305 function getExternalAuthsPlugins () {
306 const result: RegisteredExternalAuthConfig[] = []
308 for (const p of PluginManager.Instance.getExternalAuths()) {
309 for (const auth of p.externalAuths) {
314 authName: auth.authName,
315 authDisplayName: auth.authDisplayName()
323 // ---------------------------------------------------------------------------
327 getEnabledResolutions,
328 getRegisteredPlugins,
332 // ---------------------------------------------------------------------------
334 function customConfig (): CustomConfig {
337 name: CONFIG.INSTANCE.NAME,
338 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
339 description: CONFIG.INSTANCE.DESCRIPTION,
340 terms: CONFIG.INSTANCE.TERMS,
341 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
343 creationReason: CONFIG.INSTANCE.CREATION_REASON,
344 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
345 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
346 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
347 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
348 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
350 languages: CONFIG.INSTANCE.LANGUAGES,
351 categories: CONFIG.INSTANCE.CATEGORIES,
353 isNSFW: CONFIG.INSTANCE.IS_NSFW,
354 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
355 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
357 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
358 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
362 default: CONFIG.THEME.DEFAULT
366 username: CONFIG.SERVICES.TWITTER.USERNAME,
367 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
372 size: CONFIG.CACHE.PREVIEWS.SIZE
375 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
379 enabled: CONFIG.SIGNUP.ENABLED,
380 limit: CONFIG.SIGNUP.LIMIT,
381 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
384 email: CONFIG.ADMIN.EMAIL
387 enabled: CONFIG.CONTACT_FORM.ENABLED
390 videoQuota: CONFIG.USER.VIDEO_QUOTA,
391 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
394 enabled: CONFIG.TRANSCODING.ENABLED,
395 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
396 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
397 threads: CONFIG.TRANSCODING.THREADS,
399 '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
400 '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
401 '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
402 '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
403 '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
404 '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
405 '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
408 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
411 enabled: CONFIG.TRANSCODING.HLS.ENABLED
417 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
420 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
427 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
433 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
434 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
440 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
444 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
445 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
450 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
451 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
452 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
453 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
457 users: CONFIG.SEARCH.REMOTE_URI.USERS,
458 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
461 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
462 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
463 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
464 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
470 function convertCustomConfigBody (body: CustomConfig) {
471 function keyConverter (k: string) {
472 // Transcoding resolutions exception
473 if (/^\d{3,4}p$/.exec(k)) return k
474 if (k === '0p') return k
479 function valueConverter (v: any) {
480 if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
485 return objectConverter(body, keyConverter, valueConverter)