1 import express from 'express'
2 import { remove, writeJSON } from 'fs-extra'
3 import { snakeCase } from 'lodash'
4 import validator from 'validator'
5 import { ServerConfigManager } from '@server/lib/server-config-manager'
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, openapiOperationDoc } from '../../middlewares'
14 import { customConfigUpdateValidator, ensureConfigIsEditable } from '../../middlewares/validators/config'
16 const configRouter = express.Router()
18 const auditLogger = auditLoggerFactory('config')
21 openapiOperationDoc({ operationId: 'getConfig' }),
22 asyncMiddleware(getConfig)
25 configRouter.get('/about',
26 openapiOperationDoc({ operationId: 'getAbout' }),
30 configRouter.get('/custom',
31 openapiOperationDoc({ operationId: 'getCustomConfig' }),
33 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
37 configRouter.put('/custom',
38 openapiOperationDoc({ operationId: 'putCustomConfig' }),
40 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
41 ensureConfigIsEditable,
42 customConfigUpdateValidator,
43 asyncMiddleware(updateCustomConfig)
46 configRouter.delete('/custom',
47 openapiOperationDoc({ operationId: 'delCustomConfig' }),
49 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
50 ensureConfigIsEditable,
51 asyncMiddleware(deleteCustomConfig)
54 async function getConfig (req: express.Request, res: express.Response) {
55 const json = await ServerConfigManager.Instance.getServerConfig(req.ip)
60 function getAbout (req: express.Request, res: express.Response) {
61 const about: About = {
63 name: CONFIG.INSTANCE.NAME,
64 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
65 description: CONFIG.INSTANCE.DESCRIPTION,
66 terms: CONFIG.INSTANCE.TERMS,
67 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
69 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
71 creationReason: CONFIG.INSTANCE.CREATION_REASON,
72 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
73 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
74 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
75 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
77 languages: CONFIG.INSTANCE.LANGUAGES,
78 categories: CONFIG.INSTANCE.CATEGORIES
82 return res.json(about)
85 function getCustomConfig (req: express.Request, res: express.Response) {
86 const data = customConfig()
91 async function deleteCustomConfig (req: express.Request, res: express.Response) {
92 await remove(CONFIG.CUSTOM_FILE)
94 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
97 ClientHtml.invalidCache()
99 const data = customConfig()
101 return res.json(data)
104 async function updateCustomConfig (req: express.Request, res: express.Response) {
105 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
107 // camelCase to snake_case key + Force number conversion
108 const toUpdateJSON = convertCustomConfigBody(req.body)
110 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
113 ClientHtml.invalidCache()
115 const data = customConfig()
118 getAuditIdFromRes(res),
119 new CustomConfigAuditView(data),
120 oldCustomConfigAuditKeys
123 return res.json(data)
126 // ---------------------------------------------------------------------------
132 // ---------------------------------------------------------------------------
134 function customConfig (): CustomConfig {
137 name: CONFIG.INSTANCE.NAME,
138 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
139 description: CONFIG.INSTANCE.DESCRIPTION,
140 terms: CONFIG.INSTANCE.TERMS,
141 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
143 creationReason: CONFIG.INSTANCE.CREATION_REASON,
144 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
145 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
146 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
147 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
148 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
150 languages: CONFIG.INSTANCE.LANGUAGES,
151 categories: CONFIG.INSTANCE.CATEGORIES,
153 isNSFW: CONFIG.INSTANCE.IS_NSFW,
154 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
156 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
159 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
160 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
164 default: CONFIG.THEME.DEFAULT
168 username: CONFIG.SERVICES.TWITTER.USERNAME,
169 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
174 size: CONFIG.CACHE.PREVIEWS.SIZE
177 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
180 size: CONFIG.CACHE.TORRENTS.SIZE
184 enabled: CONFIG.SIGNUP.ENABLED,
185 limit: CONFIG.SIGNUP.LIMIT,
186 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION,
187 minimumAge: CONFIG.SIGNUP.MINIMUM_AGE
190 email: CONFIG.ADMIN.EMAIL
193 enabled: CONFIG.CONTACT_FORM.ENABLED
196 videoQuota: CONFIG.USER.VIDEO_QUOTA,
197 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
200 maxPerUser: CONFIG.VIDEO_CHANNELS.MAX_PER_USER
203 enabled: CONFIG.TRANSCODING.ENABLED,
204 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
205 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
206 threads: CONFIG.TRANSCODING.THREADS,
207 concurrency: CONFIG.TRANSCODING.CONCURRENCY,
208 profile: CONFIG.TRANSCODING.PROFILE,
210 '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
211 '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
212 '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
213 '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
214 '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
215 '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
216 '1440p': CONFIG.TRANSCODING.RESOLUTIONS['1440p'],
217 '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
220 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
223 enabled: CONFIG.TRANSCODING.HLS.ENABLED
227 enabled: CONFIG.LIVE.ENABLED,
228 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
229 maxDuration: CONFIG.LIVE.MAX_DURATION,
230 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
231 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
233 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
234 threads: CONFIG.LIVE.TRANSCODING.THREADS,
235 profile: CONFIG.LIVE.TRANSCODING.PROFILE,
237 '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'],
238 '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'],
239 '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'],
240 '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'],
241 '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'],
242 '1440p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1440p'],
243 '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p']
249 concurrency: CONFIG.IMPORT.VIDEOS.CONCURRENCY,
251 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
254 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
261 enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
262 default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
269 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
275 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
276 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
282 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
286 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
287 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
292 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
293 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
294 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
295 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
299 users: CONFIG.SEARCH.REMOTE_URI.USERS,
300 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
303 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
304 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
305 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
306 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
312 function convertCustomConfigBody (body: CustomConfig) {
313 function keyConverter (k: string) {
314 // Transcoding resolutions exception
315 if (/^\d{3,4}p$/.exec(k)) return k
316 if (k === '0p') return k
321 function valueConverter (v: any) {
322 if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
327 return objectConverter(body, keyConverter, valueConverter)