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 { Emailer } from '../../lib/emailer'
15 import validator from 'validator'
16 import { objectConverter } from '../../helpers/core-utils'
17 import { CONFIG, reloadConfig } from '../../initializers/config'
18 import { PluginManager } from '../../lib/plugins/plugin-manager'
19 import { getThemeOrDefault } from '../../lib/plugins/theme-utils'
20 import { Hooks } from '@server/lib/plugins/hooks'
22 const configRouter = express.Router()
24 const auditLogger = auditLoggerFactory('config')
26 configRouter.get('/about', getAbout)
28 asyncMiddleware(getConfig)
31 configRouter.get('/custom',
33 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
36 configRouter.put('/custom',
38 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
39 customConfigUpdateValidator,
40 asyncMiddleware(updateCustomConfig)
42 configRouter.delete('/custom',
44 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
45 asyncMiddleware(deleteCustomConfig)
48 let serverCommit: string
50 async function getConfig (req: express.Request, res: express.Response) {
51 const { allowed } = await Hooks.wrapPromiseFun(
56 'filter:api.user.signup.allowed.result'
59 const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip)
60 const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
62 if (serverCommit === undefined) serverCommit = await getServerCommit()
64 const json: ServerConfig = {
66 name: CONFIG.INSTANCE.NAME,
67 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
68 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
69 isNSFW: CONFIG.INSTANCE.IS_NSFW,
70 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
72 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
73 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
77 registered: getRegisteredPlugins()
80 registered: getRegisteredThemes(),
84 enabled: Emailer.isEnabled()
87 enabled: CONFIG.CONTACT_FORM.ENABLED
89 serverVersion: PEERTUBE_VERSION,
94 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
98 enabled: CONFIG.TRANSCODING.HLS.ENABLED
101 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
103 enabledResolutions: getEnabledResolutions()
108 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
111 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
118 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
125 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
127 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
132 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
134 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
138 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
144 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
146 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
150 videoQuota: CONFIG.USER.VIDEO_QUOTA,
151 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
155 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
159 enabled: CONFIG.TRACKER.ENABLED
165 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
171 return res.json(json)
174 function getAbout (req: express.Request, res: express.Response) {
175 const about: About = {
177 name: CONFIG.INSTANCE.NAME,
178 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
179 description: CONFIG.INSTANCE.DESCRIPTION,
180 terms: CONFIG.INSTANCE.TERMS,
181 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
183 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
185 creationReason: CONFIG.INSTANCE.CREATION_REASON,
186 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
187 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
188 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
189 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
191 languages: CONFIG.INSTANCE.LANGUAGES,
192 categories: CONFIG.INSTANCE.CATEGORIES
196 return res.json(about).end()
199 function getCustomConfig (req: express.Request, res: express.Response) {
200 const data = customConfig()
202 return res.json(data).end()
205 async function deleteCustomConfig (req: express.Request, res: express.Response) {
206 await remove(CONFIG.CUSTOM_FILE)
208 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
211 ClientHtml.invalidCache()
213 const data = customConfig()
215 return res.json(data).end()
218 async function updateCustomConfig (req: express.Request, res: express.Response) {
219 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
221 // camelCase to snake_case key + Force number conversion
222 const toUpdateJSON = convertCustomConfigBody(req.body)
224 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
227 ClientHtml.invalidCache()
229 const data = customConfig()
232 getAuditIdFromRes(res),
233 new CustomConfigAuditView(data),
234 oldCustomConfigAuditKeys
237 return res.json(data).end()
240 function getRegisteredThemes () {
241 return PluginManager.Instance.getRegisteredThemes()
245 description: t.description,
247 clientScripts: t.clientScripts
251 function getEnabledResolutions () {
252 return Object.keys(CONFIG.TRANSCODING.RESOLUTIONS)
253 .filter(key => CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.RESOLUTIONS[key] === true)
254 .map(r => parseInt(r, 10))
257 function getRegisteredPlugins () {
258 return PluginManager.Instance.getRegisteredPlugins()
262 description: p.description,
263 clientScripts: p.clientScripts
267 // ---------------------------------------------------------------------------
271 getEnabledResolutions,
272 getRegisteredPlugins,
276 // ---------------------------------------------------------------------------
278 function customConfig (): CustomConfig {
281 name: CONFIG.INSTANCE.NAME,
282 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
283 description: CONFIG.INSTANCE.DESCRIPTION,
284 terms: CONFIG.INSTANCE.TERMS,
285 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
287 creationReason: CONFIG.INSTANCE.CREATION_REASON,
288 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
289 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
290 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
291 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
292 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
294 languages: CONFIG.INSTANCE.LANGUAGES,
295 categories: CONFIG.INSTANCE.CATEGORIES,
297 isNSFW: CONFIG.INSTANCE.IS_NSFW,
298 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
299 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
301 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
302 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
306 default: CONFIG.THEME.DEFAULT
310 username: CONFIG.SERVICES.TWITTER.USERNAME,
311 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
316 size: CONFIG.CACHE.PREVIEWS.SIZE
319 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
323 enabled: CONFIG.SIGNUP.ENABLED,
324 limit: CONFIG.SIGNUP.LIMIT,
325 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
328 email: CONFIG.ADMIN.EMAIL
331 enabled: CONFIG.CONTACT_FORM.ENABLED
334 videoQuota: CONFIG.USER.VIDEO_QUOTA,
335 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
338 enabled: CONFIG.TRANSCODING.ENABLED,
339 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
340 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
341 threads: CONFIG.TRANSCODING.THREADS,
343 '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
344 '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
345 '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
346 '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
347 '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
348 '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
349 '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
352 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
355 enabled: CONFIG.TRANSCODING.HLS.ENABLED
361 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
364 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
371 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
377 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
378 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
384 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
388 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
389 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
396 function convertCustomConfigBody (body: CustomConfig) {
397 function keyConverter (k: string) {
398 // Transcoding resolutions exception
399 if (/^\d{3,4}p$/.exec(k)) return k
400 if (k === '0p') return k
405 function valueConverter (v: any) {
406 if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
411 return objectConverter(body, keyConverter, valueConverter)