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
82 registered: getRegisteredPlugins(),
83 registeredExternalAuths: getExternalAuthsPlugins(),
84 registeredIdAndPassAuths: getIdAndPassAuthPlugins()
87 registered: getRegisteredThemes(),
91 enabled: isEmailEnabled()
94 enabled: CONFIG.CONTACT_FORM.ENABLED
96 serverVersion: PEERTUBE_VERSION,
101 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
105 enabled: CONFIG.TRANSCODING.HLS.ENABLED
108 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
110 enabledResolutions: getEnabledResolutions()
115 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
118 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
125 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
132 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
134 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
139 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
141 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
145 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
151 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
153 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
157 videoQuota: CONFIG.USER.VIDEO_QUOTA,
158 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
162 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
166 enabled: CONFIG.TRACKER.ENABLED
172 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
178 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
179 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
180 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
181 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
185 return res.json(json)
188 function getAbout (req: express.Request, res: express.Response) {
189 const about: About = {
191 name: CONFIG.INSTANCE.NAME,
192 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
193 description: CONFIG.INSTANCE.DESCRIPTION,
194 terms: CONFIG.INSTANCE.TERMS,
195 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
197 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
199 creationReason: CONFIG.INSTANCE.CREATION_REASON,
200 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
201 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
202 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
203 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
205 languages: CONFIG.INSTANCE.LANGUAGES,
206 categories: CONFIG.INSTANCE.CATEGORIES
210 return res.json(about).end()
213 function getCustomConfig (req: express.Request, res: express.Response) {
214 const data = customConfig()
216 return res.json(data).end()
219 async function deleteCustomConfig (req: express.Request, res: express.Response) {
220 await remove(CONFIG.CUSTOM_FILE)
222 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
225 ClientHtml.invalidCache()
227 const data = customConfig()
229 return res.json(data).end()
232 async function updateCustomConfig (req: express.Request, res: express.Response) {
233 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
235 // camelCase to snake_case key + Force number conversion
236 const toUpdateJSON = convertCustomConfigBody(req.body)
238 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
241 ClientHtml.invalidCache()
243 const data = customConfig()
246 getAuditIdFromRes(res),
247 new CustomConfigAuditView(data),
248 oldCustomConfigAuditKeys
251 return res.json(data).end()
254 function getRegisteredThemes () {
255 return PluginManager.Instance.getRegisteredThemes()
259 description: t.description,
261 clientScripts: t.clientScripts
265 function getEnabledResolutions () {
266 return Object.keys(CONFIG.TRANSCODING.RESOLUTIONS)
267 .filter(key => CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.RESOLUTIONS[key] === true)
268 .map(r => parseInt(r, 10))
271 function getRegisteredPlugins () {
272 return PluginManager.Instance.getRegisteredPlugins()
276 description: p.description,
277 clientScripts: p.clientScripts
281 function getIdAndPassAuthPlugins () {
282 const result: RegisteredIdAndPassAuthConfig[] = []
284 for (const p of PluginManager.Instance.getIdAndPassAuths()) {
285 for (const auth of p.idAndPassAuths) {
290 authName: auth.authName,
291 weight: auth.getWeight()
299 function getExternalAuthsPlugins () {
300 const result: RegisteredExternalAuthConfig[] = []
302 for (const p of PluginManager.Instance.getExternalAuths()) {
303 for (const auth of p.externalAuths) {
308 authName: auth.authName,
309 authDisplayName: auth.authDisplayName()
317 // ---------------------------------------------------------------------------
321 getEnabledResolutions,
322 getRegisteredPlugins,
326 // ---------------------------------------------------------------------------
328 function customConfig (): CustomConfig {
331 name: CONFIG.INSTANCE.NAME,
332 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
333 description: CONFIG.INSTANCE.DESCRIPTION,
334 terms: CONFIG.INSTANCE.TERMS,
335 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
337 creationReason: CONFIG.INSTANCE.CREATION_REASON,
338 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
339 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
340 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
341 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
342 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
344 languages: CONFIG.INSTANCE.LANGUAGES,
345 categories: CONFIG.INSTANCE.CATEGORIES,
347 isNSFW: CONFIG.INSTANCE.IS_NSFW,
348 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
349 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
351 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
352 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
356 default: CONFIG.THEME.DEFAULT
360 username: CONFIG.SERVICES.TWITTER.USERNAME,
361 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
366 size: CONFIG.CACHE.PREVIEWS.SIZE
369 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
373 enabled: CONFIG.SIGNUP.ENABLED,
374 limit: CONFIG.SIGNUP.LIMIT,
375 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
378 email: CONFIG.ADMIN.EMAIL
381 enabled: CONFIG.CONTACT_FORM.ENABLED
384 videoQuota: CONFIG.USER.VIDEO_QUOTA,
385 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
388 enabled: CONFIG.TRANSCODING.ENABLED,
389 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
390 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
391 threads: CONFIG.TRANSCODING.THREADS,
393 '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
394 '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
395 '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
396 '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
397 '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
398 '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
399 '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
402 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
405 enabled: CONFIG.TRANSCODING.HLS.ENABLED
411 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
414 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
421 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
427 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
428 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
434 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
438 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
439 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
444 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
445 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
446 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
447 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
452 function convertCustomConfigBody (body: CustomConfig) {
453 function keyConverter (k: string) {
454 // Transcoding resolutions exception
455 if (/^\d{3,4}p$/.exec(k)) return k
456 if (k === '0p') return k
461 function valueConverter (v: any) {
462 if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
467 return objectConverter(body, keyConverter, valueConverter)