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 validator from 'validator'
15 import { objectConverter } from '../../helpers/core-utils'
16 import { CONFIG, isEmailEnabled, reloadConfig } from '../../initializers/config'
17 import { PluginManager } from '../../lib/plugins/plugin-manager'
18 import { getThemeOrDefault } from '../../lib/plugins/theme-utils'
19 import { Hooks } from '@server/lib/plugins/hooks'
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()
85 registered: getRegisteredThemes(),
89 enabled: isEmailEnabled()
92 enabled: CONFIG.CONTACT_FORM.ENABLED
94 serverVersion: PEERTUBE_VERSION,
99 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
103 enabled: CONFIG.TRANSCODING.HLS.ENABLED
106 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
108 enabledResolutions: getEnabledResolutions()
113 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
116 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
123 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
130 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
132 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
137 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
139 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
143 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
149 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
151 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
155 videoQuota: CONFIG.USER.VIDEO_QUOTA,
156 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
160 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
164 enabled: CONFIG.TRACKER.ENABLED
170 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
176 return res.json(json)
179 function getAbout (req: express.Request, res: express.Response) {
180 const about: About = {
182 name: CONFIG.INSTANCE.NAME,
183 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
184 description: CONFIG.INSTANCE.DESCRIPTION,
185 terms: CONFIG.INSTANCE.TERMS,
186 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
188 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
190 creationReason: CONFIG.INSTANCE.CREATION_REASON,
191 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
192 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
193 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
194 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
196 languages: CONFIG.INSTANCE.LANGUAGES,
197 categories: CONFIG.INSTANCE.CATEGORIES
201 return res.json(about).end()
204 function getCustomConfig (req: express.Request, res: express.Response) {
205 const data = customConfig()
207 return res.json(data).end()
210 async function deleteCustomConfig (req: express.Request, res: express.Response) {
211 await remove(CONFIG.CUSTOM_FILE)
213 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
216 ClientHtml.invalidCache()
218 const data = customConfig()
220 return res.json(data).end()
223 async function updateCustomConfig (req: express.Request, res: express.Response) {
224 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
226 // camelCase to snake_case key + Force number conversion
227 const toUpdateJSON = convertCustomConfigBody(req.body)
229 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
232 ClientHtml.invalidCache()
234 const data = customConfig()
237 getAuditIdFromRes(res),
238 new CustomConfigAuditView(data),
239 oldCustomConfigAuditKeys
242 return res.json(data).end()
245 function getRegisteredThemes () {
246 return PluginManager.Instance.getRegisteredThemes()
250 description: t.description,
252 clientScripts: t.clientScripts
256 function getEnabledResolutions () {
257 return Object.keys(CONFIG.TRANSCODING.RESOLUTIONS)
258 .filter(key => CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.RESOLUTIONS[key] === true)
259 .map(r => parseInt(r, 10))
262 function getRegisteredPlugins () {
263 return PluginManager.Instance.getRegisteredPlugins()
267 description: p.description,
268 clientScripts: p.clientScripts
272 // ---------------------------------------------------------------------------
276 getEnabledResolutions,
277 getRegisteredPlugins,
281 // ---------------------------------------------------------------------------
283 function customConfig (): CustomConfig {
286 name: CONFIG.INSTANCE.NAME,
287 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
288 description: CONFIG.INSTANCE.DESCRIPTION,
289 terms: CONFIG.INSTANCE.TERMS,
290 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
292 creationReason: CONFIG.INSTANCE.CREATION_REASON,
293 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
294 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
295 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
296 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
297 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
299 languages: CONFIG.INSTANCE.LANGUAGES,
300 categories: CONFIG.INSTANCE.CATEGORIES,
302 isNSFW: CONFIG.INSTANCE.IS_NSFW,
303 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
304 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
306 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
307 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
311 default: CONFIG.THEME.DEFAULT
315 username: CONFIG.SERVICES.TWITTER.USERNAME,
316 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
321 size: CONFIG.CACHE.PREVIEWS.SIZE
324 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
328 enabled: CONFIG.SIGNUP.ENABLED,
329 limit: CONFIG.SIGNUP.LIMIT,
330 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
333 email: CONFIG.ADMIN.EMAIL
336 enabled: CONFIG.CONTACT_FORM.ENABLED
339 videoQuota: CONFIG.USER.VIDEO_QUOTA,
340 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
343 enabled: CONFIG.TRANSCODING.ENABLED,
344 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
345 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
346 threads: CONFIG.TRANSCODING.THREADS,
348 '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
349 '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
350 '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
351 '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
352 '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
353 '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
354 '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
357 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
360 enabled: CONFIG.TRANSCODING.HLS.ENABLED
366 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
369 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
376 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
382 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
383 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
389 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
393 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
394 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
401 function convertCustomConfigBody (body: CustomConfig) {
402 function keyConverter (k: string) {
403 // Transcoding resolutions exception
404 if (/^\d{3,4}p$/.exec(k)) return k
405 if (k === '0p') return k
410 function valueConverter (v: any) {
411 if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
416 return objectConverter(body, keyConverter, valueConverter)