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 { isNumeric } 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'
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),
33 asyncMiddleware(getCustomConfig)
35 configRouter.put('/custom',
37 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
38 asyncMiddleware(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 isSignupAllowed()
51 const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip)
52 const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
54 if (serverCommit === undefined) serverCommit = await getServerCommit()
56 const json: ServerConfig = {
58 name: CONFIG.INSTANCE.NAME,
59 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
60 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
61 isNSFW: CONFIG.INSTANCE.IS_NSFW,
62 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
64 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
65 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
69 registered: getRegisteredPlugins()
72 registered: getRegisteredThemes(),
76 enabled: Emailer.isEnabled()
79 enabled: CONFIG.CONTACT_FORM.ENABLED
81 serverVersion: PEERTUBE_VERSION,
86 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
90 enabled: CONFIG.TRANSCODING.HLS.ENABLED
92 enabledResolutions: getEnabledResolutions()
97 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
100 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
107 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
114 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
116 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
121 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
123 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
127 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
133 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
135 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
139 videoQuota: CONFIG.USER.VIDEO_QUOTA,
140 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
144 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
148 enabled: CONFIG.TRACKER.ENABLED
152 return res.json(json)
155 function getAbout (req: express.Request, res: express.Response) {
156 const about: About = {
158 name: CONFIG.INSTANCE.NAME,
159 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
160 description: CONFIG.INSTANCE.DESCRIPTION,
161 terms: CONFIG.INSTANCE.TERMS,
162 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
164 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
165 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
166 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
167 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
169 languages: CONFIG.INSTANCE.LANGUAGES,
170 categories: CONFIG.INSTANCE.CATEGORIES
174 return res.json(about).end()
177 async function getCustomConfig (req: express.Request, res: express.Response) {
178 const data = customConfig()
180 return res.json(data).end()
183 async function deleteCustomConfig (req: express.Request, res: express.Response) {
184 await remove(CONFIG.CUSTOM_FILE)
186 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
189 ClientHtml.invalidCache()
191 const data = customConfig()
193 return res.json(data).end()
196 async function updateCustomConfig (req: express.Request, res: express.Response) {
197 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
199 // camelCase to snake_case key + Force number conversion
200 const toUpdateJSON = convertCustomConfigBody(req.body)
202 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
205 ClientHtml.invalidCache()
207 const data = customConfig()
210 getAuditIdFromRes(res),
211 new CustomConfigAuditView(data),
212 oldCustomConfigAuditKeys
215 return res.json(data).end()
218 // ---------------------------------------------------------------------------
224 // ---------------------------------------------------------------------------
226 function customConfig (): CustomConfig {
229 name: CONFIG.INSTANCE.NAME,
230 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
231 description: CONFIG.INSTANCE.DESCRIPTION,
232 terms: CONFIG.INSTANCE.TERMS,
233 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
235 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
236 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
237 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
238 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
240 languages: CONFIG.INSTANCE.LANGUAGES,
241 categories: CONFIG.INSTANCE.CATEGORIES,
243 isNSFW: CONFIG.INSTANCE.IS_NSFW,
244 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
245 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
247 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
248 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
252 default: CONFIG.THEME.DEFAULT
256 username: CONFIG.SERVICES.TWITTER.USERNAME,
257 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
262 size: CONFIG.CACHE.PREVIEWS.SIZE
265 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
269 enabled: CONFIG.SIGNUP.ENABLED,
270 limit: CONFIG.SIGNUP.LIMIT,
271 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
274 email: CONFIG.ADMIN.EMAIL
277 enabled: CONFIG.CONTACT_FORM.ENABLED
280 videoQuota: CONFIG.USER.VIDEO_QUOTA,
281 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
284 enabled: CONFIG.TRANSCODING.ENABLED,
285 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
286 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
287 threads: CONFIG.TRANSCODING.THREADS,
289 '240p': CONFIG.TRANSCODING.RESOLUTIONS[ '240p' ],
290 '360p': CONFIG.TRANSCODING.RESOLUTIONS[ '360p' ],
291 '480p': CONFIG.TRANSCODING.RESOLUTIONS[ '480p' ],
292 '720p': CONFIG.TRANSCODING.RESOLUTIONS[ '720p' ],
293 '1080p': CONFIG.TRANSCODING.RESOLUTIONS[ '1080p' ],
294 '2160p': CONFIG.TRANSCODING.RESOLUTIONS[ '2160p' ]
297 enabled: CONFIG.TRANSCODING.HLS.ENABLED
303 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
306 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
313 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
319 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
320 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
326 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
330 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
331 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
338 function convertCustomConfigBody (body: CustomConfig) {
339 function keyConverter (k: string) {
340 // Transcoding resolutions exception
341 if (/^\d{3,4}p$/.exec(k)) return k
346 function valueConverter (v: any) {
347 if (isNumeric(v + '')) return parseInt('' + v, 10)
352 return objectConverter(body, keyConverter, valueConverter)
355 function getRegisteredThemes () {
356 return PluginManager.Instance.getRegisteredThemes()
360 description: t.description,
362 clientScripts: t.clientScripts
366 function getEnabledResolutions () {
367 return Object.keys(CONFIG.TRANSCODING.RESOLUTIONS)
368 .filter(key => CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.RESOLUTIONS[ key ] === true)
369 .map(r => parseInt(r, 10))
372 function getRegisteredPlugins () {
373 return PluginManager.Instance.getRegisteredPlugins()
377 description: p.description,
378 clientScripts: p.clientScripts