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 } 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'
19 const packageJSON = require('../../../../package.json')
20 const configRouter = express.Router()
22 const auditLogger = auditLoggerFactory('config')
24 configRouter.get('/about', getAbout)
26 asyncMiddleware(getConfig)
29 configRouter.get('/custom',
31 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
32 asyncMiddleware(getCustomConfig)
34 configRouter.put('/custom',
36 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
37 asyncMiddleware(customConfigUpdateValidator),
38 asyncMiddleware(updateCustomConfig)
40 configRouter.delete('/custom',
42 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
43 asyncMiddleware(deleteCustomConfig)
46 let serverCommit: string
47 async function getConfig (req: express.Request, res: express.Response) {
48 const allowed = await isSignupAllowed()
49 const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip)
51 if (serverCommit === undefined) serverCommit = await getServerCommit()
53 const enabledResolutions = Object.keys(CONFIG.TRANSCODING.RESOLUTIONS)
54 .filter(key => CONFIG.TRANSCODING.ENABLED === CONFIG.TRANSCODING.RESOLUTIONS[key] === true)
55 .map(r => parseInt(r, 10))
57 const json: ServerConfig = {
59 name: CONFIG.INSTANCE.NAME,
60 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
61 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
62 isNSFW: CONFIG.INSTANCE.IS_NSFW,
63 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
65 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
66 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
70 enabled: Emailer.isEnabled()
73 enabled: CONFIG.CONTACT_FORM.ENABLED
75 serverVersion: packageJSON.version,
80 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
84 enabled: CONFIG.TRANSCODING.HLS.ENABLED
91 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
94 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
101 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
108 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
110 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
115 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
117 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
121 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
127 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
129 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
133 videoQuota: CONFIG.USER.VIDEO_QUOTA,
134 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
138 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
142 enabled: CONFIG.TRACKER.ENABLED
146 return res.json(json)
149 function getAbout (req: express.Request, res: express.Response) {
150 const about: About = {
152 name: CONFIG.INSTANCE.NAME,
153 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
154 description: CONFIG.INSTANCE.DESCRIPTION,
155 terms: CONFIG.INSTANCE.TERMS
159 return res.json(about).end()
162 async function getCustomConfig (req: express.Request, res: express.Response) {
163 const data = customConfig()
165 return res.json(data).end()
168 async function deleteCustomConfig (req: express.Request, res: express.Response) {
169 await remove(CONFIG.CUSTOM_FILE)
171 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
174 ClientHtml.invalidCache()
176 const data = customConfig()
178 return res.json(data).end()
181 async function updateCustomConfig (req: express.Request, res: express.Response) {
182 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
184 // camelCase to snake_case key + Force number conversion
185 const toUpdateJSON = convertCustomConfigBody(req.body)
187 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
190 ClientHtml.invalidCache()
192 const data = customConfig()
195 getAuditIdFromRes(res),
196 new CustomConfigAuditView(data),
197 oldCustomConfigAuditKeys
200 return res.json(data).end()
203 // ---------------------------------------------------------------------------
209 // ---------------------------------------------------------------------------
211 function customConfig (): CustomConfig {
214 name: CONFIG.INSTANCE.NAME,
215 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
216 description: CONFIG.INSTANCE.DESCRIPTION,
217 terms: CONFIG.INSTANCE.TERMS,
218 isNSFW: CONFIG.INSTANCE.IS_NSFW,
219 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
220 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
222 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
223 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
228 username: CONFIG.SERVICES.TWITTER.USERNAME,
229 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
234 size: CONFIG.CACHE.PREVIEWS.SIZE
237 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
241 enabled: CONFIG.SIGNUP.ENABLED,
242 limit: CONFIG.SIGNUP.LIMIT,
243 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
246 email: CONFIG.ADMIN.EMAIL
249 enabled: CONFIG.CONTACT_FORM.ENABLED
252 videoQuota: CONFIG.USER.VIDEO_QUOTA,
253 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
256 enabled: CONFIG.TRANSCODING.ENABLED,
257 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
258 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
259 threads: CONFIG.TRANSCODING.THREADS,
261 '240p': CONFIG.TRANSCODING.RESOLUTIONS[ '240p' ],
262 '360p': CONFIG.TRANSCODING.RESOLUTIONS[ '360p' ],
263 '480p': CONFIG.TRANSCODING.RESOLUTIONS[ '480p' ],
264 '720p': CONFIG.TRANSCODING.RESOLUTIONS[ '720p' ],
265 '1080p': CONFIG.TRANSCODING.RESOLUTIONS[ '1080p' ]
268 enabled: CONFIG.TRANSCODING.HLS.ENABLED
274 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
277 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
284 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
290 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
291 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
297 function convertCustomConfigBody (body: CustomConfig) {
298 function keyConverter (k: string) {
299 // Transcoding resolutions exception
300 if (/^\d{3,4}p$/.exec(k)) return k
305 function valueConverter (v: any) {
306 if (isNumeric(v + '')) return parseInt('' + v, 10)
311 return objectConverter(body, keyConverter, valueConverter)