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 } 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 packageJSON = require('../../../../package.json')
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),
34 asyncMiddleware(getCustomConfig)
36 configRouter.put('/custom',
38 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
39 asyncMiddleware(customConfigUpdateValidator),
40 asyncMiddleware(updateCustomConfig)
42 configRouter.delete('/custom',
44 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
45 asyncMiddleware(deleteCustomConfig)
48 let serverCommit: string
49 async function getConfig (req: express.Request, res: express.Response) {
50 const allowed = await isSignupAllowed()
51 const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip)
53 if (serverCommit === undefined) serverCommit = await getServerCommit()
55 const enabledResolutions = Object.keys(CONFIG.TRANSCODING.RESOLUTIONS)
56 .filter(key => CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.RESOLUTIONS[key] === true)
57 .map(r => parseInt(r, 10))
59 const registeredPlugins = PluginManager.Instance.getRegisteredPlugins()
63 description: p.description,
64 clientScripts: p.clientScripts
67 const registeredThemes = PluginManager.Instance.getRegisteredThemes()
71 description: t.description,
73 clientScripts: t.clientScripts
76 const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
78 const json: ServerConfig = {
80 name: CONFIG.INSTANCE.NAME,
81 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
82 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
83 isNSFW: CONFIG.INSTANCE.IS_NSFW,
84 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
86 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
87 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
91 registered: registeredPlugins
94 registered: registeredThemes,
98 enabled: Emailer.isEnabled()
101 enabled: CONFIG.CONTACT_FORM.ENABLED
103 serverVersion: packageJSON.version,
108 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
112 enabled: CONFIG.TRANSCODING.HLS.ENABLED
119 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
122 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
129 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
136 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
138 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
143 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
145 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
149 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
155 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
157 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
161 videoQuota: CONFIG.USER.VIDEO_QUOTA,
162 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
166 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
170 enabled: CONFIG.TRACKER.ENABLED
174 return res.json(json)
177 function getAbout (req: express.Request, res: express.Response) {
178 const about: About = {
180 name: CONFIG.INSTANCE.NAME,
181 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
182 description: CONFIG.INSTANCE.DESCRIPTION,
183 terms: CONFIG.INSTANCE.TERMS
187 return res.json(about).end()
190 async function getCustomConfig (req: express.Request, res: express.Response) {
191 const data = customConfig()
193 return res.json(data).end()
196 async function deleteCustomConfig (req: express.Request, res: express.Response) {
197 await remove(CONFIG.CUSTOM_FILE)
199 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
202 ClientHtml.invalidCache()
204 const data = customConfig()
206 return res.json(data).end()
209 async function updateCustomConfig (req: express.Request, res: express.Response) {
210 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
212 // camelCase to snake_case key + Force number conversion
213 const toUpdateJSON = convertCustomConfigBody(req.body)
215 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
218 ClientHtml.invalidCache()
220 const data = customConfig()
223 getAuditIdFromRes(res),
224 new CustomConfigAuditView(data),
225 oldCustomConfigAuditKeys
228 return res.json(data).end()
231 // ---------------------------------------------------------------------------
237 // ---------------------------------------------------------------------------
239 function customConfig (): CustomConfig {
242 name: CONFIG.INSTANCE.NAME,
243 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
244 description: CONFIG.INSTANCE.DESCRIPTION,
245 terms: CONFIG.INSTANCE.TERMS,
246 isNSFW: CONFIG.INSTANCE.IS_NSFW,
247 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
248 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
250 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
251 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
255 default: CONFIG.THEME.DEFAULT
259 username: CONFIG.SERVICES.TWITTER.USERNAME,
260 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
265 size: CONFIG.CACHE.PREVIEWS.SIZE
268 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
272 enabled: CONFIG.SIGNUP.ENABLED,
273 limit: CONFIG.SIGNUP.LIMIT,
274 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
277 email: CONFIG.ADMIN.EMAIL
280 enabled: CONFIG.CONTACT_FORM.ENABLED
283 videoQuota: CONFIG.USER.VIDEO_QUOTA,
284 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
287 enabled: CONFIG.TRANSCODING.ENABLED,
288 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
289 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
290 threads: CONFIG.TRANSCODING.THREADS,
292 '240p': CONFIG.TRANSCODING.RESOLUTIONS[ '240p' ],
293 '360p': CONFIG.TRANSCODING.RESOLUTIONS[ '360p' ],
294 '480p': CONFIG.TRANSCODING.RESOLUTIONS[ '480p' ],
295 '720p': CONFIG.TRANSCODING.RESOLUTIONS[ '720p' ],
296 '1080p': CONFIG.TRANSCODING.RESOLUTIONS[ '1080p' ],
297 '2160p': CONFIG.TRANSCODING.RESOLUTIONS[ '2160p' ]
300 enabled: CONFIG.TRANSCODING.HLS.ENABLED
306 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
309 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
316 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
322 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
323 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
329 function convertCustomConfigBody (body: CustomConfig) {
330 function keyConverter (k: string) {
331 // Transcoding resolutions exception
332 if (/^\d{3,4}p$/.exec(k)) return k
337 function valueConverter (v: any) {
338 if (isNumeric(v + '')) return parseInt('' + v, 10)
343 return objectConverter(body, keyConverter, valueConverter)