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 { CONFIG, CONSTRAINTS_FIELDS, reloadConfig } from '../../initializers'
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'
18 const packageJSON = require('../../../../package.json')
19 const configRouter = express.Router()
21 const auditLogger = auditLoggerFactory('config')
23 configRouter.get('/about', getAbout)
25 asyncMiddleware(getConfig)
28 configRouter.get('/custom',
30 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
31 asyncMiddleware(getCustomConfig)
33 configRouter.put('/custom',
35 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
36 asyncMiddleware(customConfigUpdateValidator),
37 asyncMiddleware(updateCustomConfig)
39 configRouter.delete('/custom',
41 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
42 asyncMiddleware(deleteCustomConfig)
45 let serverCommit: string
46 async function getConfig (req: express.Request, res: express.Response) {
47 const allowed = await isSignupAllowed()
48 const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip)
50 if (serverCommit === undefined) serverCommit = await getServerCommit()
52 const enabledResolutions = Object.keys(CONFIG.TRANSCODING.RESOLUTIONS)
53 .filter(key => CONFIG.TRANSCODING.ENABLED === CONFIG.TRANSCODING.RESOLUTIONS[key] === true)
54 .map(r => parseInt(r, 10))
56 const json: ServerConfig = {
58 name: CONFIG.INSTANCE.NAME,
59 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
60 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
61 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
63 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
64 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
68 enabled: Emailer.isEnabled()
71 enabled: CONFIG.CONTACT_FORM.ENABLED
73 serverVersion: packageJSON.version,
78 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
82 enabled: CONFIG.TRANSCODING.HLS.ENABLED
89 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
92 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
99 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
101 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
106 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
108 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
112 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
118 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
120 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
124 videoQuota: CONFIG.USER.VIDEO_QUOTA,
125 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
129 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
134 return res.json(json)
137 function getAbout (req: express.Request, res: express.Response, next: express.NextFunction) {
138 const about: About = {
140 name: CONFIG.INSTANCE.NAME,
141 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
142 description: CONFIG.INSTANCE.DESCRIPTION,
143 terms: CONFIG.INSTANCE.TERMS
147 return res.json(about).end()
150 async function getCustomConfig (req: express.Request, res: express.Response, next: express.NextFunction) {
151 const data = customConfig()
153 return res.json(data).end()
156 async function deleteCustomConfig (req: express.Request, res: express.Response, next: express.NextFunction) {
157 await remove(CONFIG.CUSTOM_FILE)
159 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
162 ClientHtml.invalidCache()
164 const data = customConfig()
166 return res.json(data).end()
169 async function updateCustomConfig (req: express.Request, res: express.Response, next: express.NextFunction) {
170 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
172 // camelCase to snake_case key + Force number conversion
173 const toUpdateJSON = convertCustomConfigBody(req.body)
175 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
178 ClientHtml.invalidCache()
180 const data = customConfig()
183 getAuditIdFromRes(res),
184 new CustomConfigAuditView(data),
185 oldCustomConfigAuditKeys
188 return res.json(data).end()
191 // ---------------------------------------------------------------------------
197 // ---------------------------------------------------------------------------
199 function customConfig (): CustomConfig {
202 name: CONFIG.INSTANCE.NAME,
203 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
204 description: CONFIG.INSTANCE.DESCRIPTION,
205 terms: CONFIG.INSTANCE.TERMS,
206 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
207 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
209 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
210 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
215 username: CONFIG.SERVICES.TWITTER.USERNAME,
216 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
221 size: CONFIG.CACHE.PREVIEWS.SIZE
224 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
228 enabled: CONFIG.SIGNUP.ENABLED,
229 limit: CONFIG.SIGNUP.LIMIT,
230 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
233 email: CONFIG.ADMIN.EMAIL
236 enabled: CONFIG.CONTACT_FORM.ENABLED
239 videoQuota: CONFIG.USER.VIDEO_QUOTA,
240 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
243 enabled: CONFIG.TRANSCODING.ENABLED,
244 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
245 threads: CONFIG.TRANSCODING.THREADS,
247 '240p': CONFIG.TRANSCODING.RESOLUTIONS[ '240p' ],
248 '360p': CONFIG.TRANSCODING.RESOLUTIONS[ '360p' ],
249 '480p': CONFIG.TRANSCODING.RESOLUTIONS[ '480p' ],
250 '720p': CONFIG.TRANSCODING.RESOLUTIONS[ '720p' ],
251 '1080p': CONFIG.TRANSCODING.RESOLUTIONS[ '1080p' ]
254 enabled: CONFIG.TRANSCODING.HLS.ENABLED
260 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
263 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
270 function convertCustomConfigBody (body: CustomConfig) {
271 function keyConverter (k: string) {
272 // Transcoding resolutions exception
273 if (/^\d{3,4}p$/.exec(k)) return k
278 function valueConverter (v: any) {
279 if (isNumeric(v + '')) return parseInt('' + v, 10)
284 return objectConverter(body, keyConverter, valueConverter)