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 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 enabled: Emailer.isEnabled()
72 enabled: CONFIG.CONTACT_FORM.ENABLED
74 serverVersion: packageJSON.version,
79 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
83 enabled: CONFIG.TRANSCODING.HLS.ENABLED
90 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
93 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
100 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
107 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
109 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
114 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
116 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
120 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
126 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
128 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
132 videoQuota: CONFIG.USER.VIDEO_QUOTA,
133 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
137 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
142 return res.json(json)
145 function getAbout (req: express.Request, res: express.Response) {
146 const about: About = {
148 name: CONFIG.INSTANCE.NAME,
149 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
150 description: CONFIG.INSTANCE.DESCRIPTION,
151 terms: CONFIG.INSTANCE.TERMS
155 return res.json(about).end()
158 async function getCustomConfig (req: express.Request, res: express.Response) {
159 const data = customConfig()
161 return res.json(data).end()
164 async function deleteCustomConfig (req: express.Request, res: express.Response) {
165 await remove(CONFIG.CUSTOM_FILE)
167 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
170 ClientHtml.invalidCache()
172 const data = customConfig()
174 return res.json(data).end()
177 async function updateCustomConfig (req: express.Request, res: express.Response) {
178 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
180 // camelCase to snake_case key + Force number conversion
181 const toUpdateJSON = convertCustomConfigBody(req.body)
183 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
186 ClientHtml.invalidCache()
188 const data = customConfig()
191 getAuditIdFromRes(res),
192 new CustomConfigAuditView(data),
193 oldCustomConfigAuditKeys
196 return res.json(data).end()
199 // ---------------------------------------------------------------------------
205 // ---------------------------------------------------------------------------
207 function customConfig (): CustomConfig {
210 name: CONFIG.INSTANCE.NAME,
211 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
212 description: CONFIG.INSTANCE.DESCRIPTION,
213 terms: CONFIG.INSTANCE.TERMS,
214 isNSFW: CONFIG.INSTANCE.IS_NSFW,
215 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
216 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
218 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
219 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
224 username: CONFIG.SERVICES.TWITTER.USERNAME,
225 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
230 size: CONFIG.CACHE.PREVIEWS.SIZE
233 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
237 enabled: CONFIG.SIGNUP.ENABLED,
238 limit: CONFIG.SIGNUP.LIMIT,
239 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
242 email: CONFIG.ADMIN.EMAIL
245 enabled: CONFIG.CONTACT_FORM.ENABLED
248 videoQuota: CONFIG.USER.VIDEO_QUOTA,
249 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
252 enabled: CONFIG.TRANSCODING.ENABLED,
253 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
254 threads: CONFIG.TRANSCODING.THREADS,
256 '240p': CONFIG.TRANSCODING.RESOLUTIONS[ '240p' ],
257 '360p': CONFIG.TRANSCODING.RESOLUTIONS[ '360p' ],
258 '480p': CONFIG.TRANSCODING.RESOLUTIONS[ '480p' ],
259 '720p': CONFIG.TRANSCODING.RESOLUTIONS[ '720p' ],
260 '1080p': CONFIG.TRANSCODING.RESOLUTIONS[ '1080p' ]
263 enabled: CONFIG.TRANSCODING.HLS.ENABLED
269 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
272 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
279 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
285 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
286 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
292 function convertCustomConfigBody (body: CustomConfig) {
293 function keyConverter (k: string) {
294 // Transcoding resolutions exception
295 if (/^\d{3,4}p$/.exec(k)) return k
300 function valueConverter (v: any) {
301 if (isNumeric(v + '')) return parseInt('' + v, 10)
306 return objectConverter(body, keyConverter, valueConverter)