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 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
102 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
107 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
109 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
113 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
119 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
121 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
125 videoQuota: CONFIG.USER.VIDEO_QUOTA,
126 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
130 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
135 return res.json(json)
138 function getAbout (req: express.Request, res: express.Response) {
139 const about: About = {
141 name: CONFIG.INSTANCE.NAME,
142 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
143 description: CONFIG.INSTANCE.DESCRIPTION,
144 terms: CONFIG.INSTANCE.TERMS
148 return res.json(about).end()
151 async function getCustomConfig (req: express.Request, res: express.Response) {
152 const data = customConfig()
154 return res.json(data).end()
157 async function deleteCustomConfig (req: express.Request, res: express.Response) {
158 await remove(CONFIG.CUSTOM_FILE)
160 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
163 ClientHtml.invalidCache()
165 const data = customConfig()
167 return res.json(data).end()
170 async function updateCustomConfig (req: express.Request, res: express.Response) {
171 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
173 // camelCase to snake_case key + Force number conversion
174 const toUpdateJSON = convertCustomConfigBody(req.body)
176 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
179 ClientHtml.invalidCache()
181 const data = customConfig()
184 getAuditIdFromRes(res),
185 new CustomConfigAuditView(data),
186 oldCustomConfigAuditKeys
189 return res.json(data).end()
192 // ---------------------------------------------------------------------------
198 // ---------------------------------------------------------------------------
200 function customConfig (): CustomConfig {
203 name: CONFIG.INSTANCE.NAME,
204 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
205 description: CONFIG.INSTANCE.DESCRIPTION,
206 terms: CONFIG.INSTANCE.TERMS,
207 isNSFW: CONFIG.INSTANCE.IS_NSFW,
208 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
209 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
211 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
212 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
217 username: CONFIG.SERVICES.TWITTER.USERNAME,
218 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
223 size: CONFIG.CACHE.PREVIEWS.SIZE
226 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
230 enabled: CONFIG.SIGNUP.ENABLED,
231 limit: CONFIG.SIGNUP.LIMIT,
232 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
235 email: CONFIG.ADMIN.EMAIL
238 enabled: CONFIG.CONTACT_FORM.ENABLED
241 videoQuota: CONFIG.USER.VIDEO_QUOTA,
242 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
245 enabled: CONFIG.TRANSCODING.ENABLED,
246 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
247 threads: CONFIG.TRANSCODING.THREADS,
249 '240p': CONFIG.TRANSCODING.RESOLUTIONS[ '240p' ],
250 '360p': CONFIG.TRANSCODING.RESOLUTIONS[ '360p' ],
251 '480p': CONFIG.TRANSCODING.RESOLUTIONS[ '480p' ],
252 '720p': CONFIG.TRANSCODING.RESOLUTIONS[ '720p' ],
253 '1080p': CONFIG.TRANSCODING.RESOLUTIONS[ '1080p' ]
256 enabled: CONFIG.TRANSCODING.HLS.ENABLED
262 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
265 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
272 function convertCustomConfigBody (body: CustomConfig) {
273 function keyConverter (k: string) {
274 // Transcoding resolutions exception
275 if (/^\d{3,4}p$/.exec(k)) return k
280 function valueConverter (v: any) {
281 if (isNumeric(v + '')) return parseInt('' + v, 10)
286 return objectConverter(body, keyConverter, valueConverter)