1 import * as express from 'express'
2 import { remove, writeJSON } from 'fs-extra'
3 import { snakeCase } from 'lodash'
4 import validator from 'validator'
5 import { getServerConfig } from '@server/lib/config'
6 import { UserRight } from '../../../shared'
7 import { About } from '../../../shared/models/server/about.model'
8 import { CustomConfig } from '../../../shared/models/server/custom-config.model'
9 import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger'
10 import { objectConverter } from '../../helpers/core-utils'
11 import { CONFIG, reloadConfig } from '../../initializers/config'
12 import { ClientHtml } from '../../lib/client-html'
13 import { asyncMiddleware, authenticate, ensureUserHasRight } from '../../middlewares'
14 import { customConfigUpdateValidator } from '../../middlewares/validators/config'
16 const configRouter = express.Router()
18 const auditLogger = auditLoggerFactory('config')
20 configRouter.get('/about', getAbout)
23 asyncMiddleware(getConfig)
26 configRouter.get('/custom',
28 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
32 configRouter.put('/custom',
34 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
35 customConfigUpdateValidator,
36 asyncMiddleware(updateCustomConfig)
39 configRouter.delete('/custom',
41 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
42 asyncMiddleware(deleteCustomConfig)
45 async function getConfig (req: express.Request, res: express.Response) {
46 const json = await getServerConfig(req.ip)
51 function getAbout (req: express.Request, res: express.Response) {
52 const about: About = {
54 name: CONFIG.INSTANCE.NAME,
55 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
56 description: CONFIG.INSTANCE.DESCRIPTION,
57 terms: CONFIG.INSTANCE.TERMS,
58 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
60 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
62 creationReason: CONFIG.INSTANCE.CREATION_REASON,
63 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
64 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
65 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
66 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
68 languages: CONFIG.INSTANCE.LANGUAGES,
69 categories: CONFIG.INSTANCE.CATEGORIES
73 return res.json(about)
76 function getCustomConfig (req: express.Request, res: express.Response) {
77 const data = customConfig()
82 async function deleteCustomConfig (req: express.Request, res: express.Response) {
83 await remove(CONFIG.CUSTOM_FILE)
85 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
88 ClientHtml.invalidCache()
90 const data = customConfig()
95 async function updateCustomConfig (req: express.Request, res: express.Response) {
96 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
98 // camelCase to snake_case key + Force number conversion
99 const toUpdateJSON = convertCustomConfigBody(req.body)
101 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
104 ClientHtml.invalidCache()
106 const data = customConfig()
109 getAuditIdFromRes(res),
110 new CustomConfigAuditView(data),
111 oldCustomConfigAuditKeys
114 return res.json(data)
117 // ---------------------------------------------------------------------------
123 // ---------------------------------------------------------------------------
125 function customConfig (): CustomConfig {
128 name: CONFIG.INSTANCE.NAME,
129 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
130 description: CONFIG.INSTANCE.DESCRIPTION,
131 terms: CONFIG.INSTANCE.TERMS,
132 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
134 creationReason: CONFIG.INSTANCE.CREATION_REASON,
135 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
136 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
137 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
138 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
139 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
141 languages: CONFIG.INSTANCE.LANGUAGES,
142 categories: CONFIG.INSTANCE.CATEGORIES,
144 isNSFW: CONFIG.INSTANCE.IS_NSFW,
145 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
147 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
150 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
151 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
155 default: CONFIG.THEME.DEFAULT
159 username: CONFIG.SERVICES.TWITTER.USERNAME,
160 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
165 size: CONFIG.CACHE.PREVIEWS.SIZE
168 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
171 size: CONFIG.CACHE.TORRENTS.SIZE
175 enabled: CONFIG.SIGNUP.ENABLED,
176 limit: CONFIG.SIGNUP.LIMIT,
177 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
180 email: CONFIG.ADMIN.EMAIL
183 enabled: CONFIG.CONTACT_FORM.ENABLED
186 videoQuota: CONFIG.USER.VIDEO_QUOTA,
187 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
190 enabled: CONFIG.TRANSCODING.ENABLED,
191 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
192 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
193 threads: CONFIG.TRANSCODING.THREADS,
194 concurrency: CONFIG.TRANSCODING.CONCURRENCY,
195 profile: CONFIG.TRANSCODING.PROFILE,
197 '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
198 '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
199 '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
200 '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
201 '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
202 '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
203 '1440p': CONFIG.TRANSCODING.RESOLUTIONS['1440p'],
204 '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
207 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
210 enabled: CONFIG.TRANSCODING.HLS.ENABLED
214 enabled: CONFIG.LIVE.ENABLED,
215 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
216 maxDuration: CONFIG.LIVE.MAX_DURATION,
217 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
218 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
220 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
221 threads: CONFIG.LIVE.TRANSCODING.THREADS,
222 profile: CONFIG.LIVE.TRANSCODING.PROFILE,
224 '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'],
225 '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'],
226 '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'],
227 '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'],
228 '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'],
229 '1440p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1440p'],
230 '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p']
236 concurrency: CONFIG.IMPORT.VIDEOS.CONCURRENCY,
238 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
241 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
248 enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
249 default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
256 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
262 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
263 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
269 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
273 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
274 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
279 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
280 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
281 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
282 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
286 users: CONFIG.SEARCH.REMOTE_URI.USERS,
287 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
290 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
291 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
292 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
293 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
299 function convertCustomConfigBody (body: CustomConfig) {
300 function keyConverter (k: string) {
301 // Transcoding resolutions exception
302 if (/^\d{3,4}p$/.exec(k)) return k
303 if (k === '0p') return k
308 function valueConverter (v: any) {
309 if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
314 return objectConverter(body, keyConverter, valueConverter)