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
78 users: CONFIG.SEARCH.REMOTE_URI.USERS,
79 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
83 registered: getRegisteredPlugins()
86 registered: getRegisteredThemes(),
90 enabled: Emailer.isEnabled()
93 enabled: CONFIG.CONTACT_FORM.ENABLED
95 serverVersion: PEERTUBE_VERSION,
100 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
104 enabled: CONFIG.TRANSCODING.HLS.ENABLED
107 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
109 enabledResolutions: getEnabledResolutions()
114 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
117 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
124 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
131 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
133 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
138 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
140 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
144 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
150 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
152 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
156 videoQuota: CONFIG.USER.VIDEO_QUOTA,
157 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
161 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
165 enabled: CONFIG.TRACKER.ENABLED
171 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
177 return res.json(json)
180 function getAbout (req: express.Request, res: express.Response) {
181 const about: About = {
183 name: CONFIG.INSTANCE.NAME,
184 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
185 description: CONFIG.INSTANCE.DESCRIPTION,
186 terms: CONFIG.INSTANCE.TERMS,
187 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
189 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
191 creationReason: CONFIG.INSTANCE.CREATION_REASON,
192 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
193 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
194 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
195 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
197 languages: CONFIG.INSTANCE.LANGUAGES,
198 categories: CONFIG.INSTANCE.CATEGORIES
202 return res.json(about).end()
205 function getCustomConfig (req: express.Request, res: express.Response) {
206 const data = customConfig()
208 return res.json(data).end()
211 async function deleteCustomConfig (req: express.Request, res: express.Response) {
212 await remove(CONFIG.CUSTOM_FILE)
214 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
217 ClientHtml.invalidCache()
219 const data = customConfig()
221 return res.json(data).end()
224 async function updateCustomConfig (req: express.Request, res: express.Response) {
225 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
227 // camelCase to snake_case key + Force number conversion
228 const toUpdateJSON = convertCustomConfigBody(req.body)
230 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
233 ClientHtml.invalidCache()
235 const data = customConfig()
238 getAuditIdFromRes(res),
239 new CustomConfigAuditView(data),
240 oldCustomConfigAuditKeys
243 return res.json(data).end()
246 function getRegisteredThemes () {
247 return PluginManager.Instance.getRegisteredThemes()
251 description: t.description,
253 clientScripts: t.clientScripts
257 function getEnabledResolutions () {
258 return Object.keys(CONFIG.TRANSCODING.RESOLUTIONS)
259 .filter(key => CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.RESOLUTIONS[key] === true)
260 .map(r => parseInt(r, 10))
263 function getRegisteredPlugins () {
264 return PluginManager.Instance.getRegisteredPlugins()
268 description: p.description,
269 clientScripts: p.clientScripts
273 // ---------------------------------------------------------------------------
277 getEnabledResolutions,
278 getRegisteredPlugins,
282 // ---------------------------------------------------------------------------
284 function customConfig (): CustomConfig {
287 name: CONFIG.INSTANCE.NAME,
288 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
289 description: CONFIG.INSTANCE.DESCRIPTION,
290 terms: CONFIG.INSTANCE.TERMS,
291 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
293 creationReason: CONFIG.INSTANCE.CREATION_REASON,
294 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
295 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
296 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
297 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
298 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
300 languages: CONFIG.INSTANCE.LANGUAGES,
301 categories: CONFIG.INSTANCE.CATEGORIES,
303 isNSFW: CONFIG.INSTANCE.IS_NSFW,
304 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
305 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
307 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
308 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
312 default: CONFIG.THEME.DEFAULT
316 username: CONFIG.SERVICES.TWITTER.USERNAME,
317 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
322 size: CONFIG.CACHE.PREVIEWS.SIZE
325 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
329 enabled: CONFIG.SIGNUP.ENABLED,
330 limit: CONFIG.SIGNUP.LIMIT,
331 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
334 email: CONFIG.ADMIN.EMAIL
337 enabled: CONFIG.CONTACT_FORM.ENABLED
340 videoQuota: CONFIG.USER.VIDEO_QUOTA,
341 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
344 enabled: CONFIG.TRANSCODING.ENABLED,
345 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
346 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
347 threads: CONFIG.TRANSCODING.THREADS,
349 '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
350 '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
351 '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
352 '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
353 '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
354 '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
355 '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
358 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
361 enabled: CONFIG.TRANSCODING.HLS.ENABLED
367 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
370 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
377 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
383 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
384 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
390 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
394 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
395 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
402 function convertCustomConfigBody (body: CustomConfig) {
403 function keyConverter (k: string) {
404 // Transcoding resolutions exception
405 if (/^\d{3,4}p$/.exec(k)) return k
406 if (k === '0p') return k
411 function valueConverter (v: any) {
412 if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
417 return objectConverter(body, keyConverter, valueConverter)