1 import * as express from 'express'
2 import { omit, 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
86 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
89 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
96 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
98 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
103 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
105 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
109 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
115 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
117 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
121 videoQuota: CONFIG.USER.VIDEO_QUOTA,
122 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
126 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
131 return res.json(json)
134 function getAbout (req: express.Request, res: express.Response, next: express.NextFunction) {
135 const about: About = {
137 name: CONFIG.INSTANCE.NAME,
138 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
139 description: CONFIG.INSTANCE.DESCRIPTION,
140 terms: CONFIG.INSTANCE.TERMS
144 return res.json(about).end()
147 async function getCustomConfig (req: express.Request, res: express.Response, next: express.NextFunction) {
148 const data = customConfig()
150 return res.json(data).end()
153 async function deleteCustomConfig (req: express.Request, res: express.Response, next: express.NextFunction) {
154 await remove(CONFIG.CUSTOM_FILE)
156 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
159 ClientHtml.invalidCache()
161 const data = customConfig()
163 return res.json(data).end()
166 async function updateCustomConfig (req: express.Request, res: express.Response, next: express.NextFunction) {
167 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
169 // camelCase to snake_case key + Force number conversion
170 const toUpdateJSON = convertCustomConfigBody(req.body)
172 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
175 ClientHtml.invalidCache()
177 const data = customConfig()
180 getAuditIdFromRes(res),
181 new CustomConfigAuditView(data),
182 oldCustomConfigAuditKeys
185 return res.json(data).end()
188 // ---------------------------------------------------------------------------
194 // ---------------------------------------------------------------------------
196 function customConfig (): CustomConfig {
199 name: CONFIG.INSTANCE.NAME,
200 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
201 description: CONFIG.INSTANCE.DESCRIPTION,
202 terms: CONFIG.INSTANCE.TERMS,
203 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
204 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
206 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
207 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
212 username: CONFIG.SERVICES.TWITTER.USERNAME,
213 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
218 size: CONFIG.CACHE.PREVIEWS.SIZE
221 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
225 enabled: CONFIG.SIGNUP.ENABLED,
226 limit: CONFIG.SIGNUP.LIMIT,
227 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
230 email: CONFIG.ADMIN.EMAIL
233 enabled: CONFIG.CONTACT_FORM.ENABLED
236 videoQuota: CONFIG.USER.VIDEO_QUOTA,
237 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
240 enabled: CONFIG.TRANSCODING.ENABLED,
241 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
242 threads: CONFIG.TRANSCODING.THREADS,
244 '240p': CONFIG.TRANSCODING.RESOLUTIONS[ '240p' ],
245 '360p': CONFIG.TRANSCODING.RESOLUTIONS[ '360p' ],
246 '480p': CONFIG.TRANSCODING.RESOLUTIONS[ '480p' ],
247 '720p': CONFIG.TRANSCODING.RESOLUTIONS[ '720p' ],
248 '1080p': CONFIG.TRANSCODING.RESOLUTIONS[ '1080p' ]
254 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
257 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
264 function convertCustomConfigBody (body: CustomConfig) {
265 function keyConverter (k: string) {
266 // Transcoding resolutions exception
267 if (/^\d{3,4}p$/.exec(k)) return k
272 function valueConverter (v: any) {
273 if (isNumeric(v + '')) return parseInt('' + v, 10)
278 return objectConverter(body, keyConverter, valueConverter)