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, DEFAULT_THEME_NAME, PEERTUBE_VERSION } 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 validator from 'validator'
16 import { objectConverter } from '../../helpers/core-utils'
17 import { CONFIG, reloadConfig } from '../../initializers/config'
18 import { PluginManager } from '../../lib/plugins/plugin-manager'
19 import { getThemeOrDefault } from '../../lib/plugins/theme-utils'
20 import { Hooks } from '@server/lib/plugins/hooks'
22 const configRouter = express.Router()
24 const auditLogger = auditLoggerFactory('config')
26 configRouter.get('/about', getAbout)
28 asyncMiddleware(getConfig)
31 configRouter.get('/custom',
33 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
34 asyncMiddleware(getCustomConfig)
36 configRouter.put('/custom',
38 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
39 asyncMiddleware(customConfigUpdateValidator),
40 asyncMiddleware(updateCustomConfig)
42 configRouter.delete('/custom',
44 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
45 asyncMiddleware(deleteCustomConfig)
48 let serverCommit: string
50 async function getConfig (req: express.Request, res: express.Response) {
51 const { allowed } = await Hooks.wrapPromiseFun(
54 'filter:api.user.signup.allowed.result'
57 const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip)
58 const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
60 if (serverCommit === undefined) serverCommit = await getServerCommit()
62 const json: ServerConfig = {
64 name: CONFIG.INSTANCE.NAME,
65 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
66 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
67 isNSFW: CONFIG.INSTANCE.IS_NSFW,
68 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
70 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
71 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
75 registered: getRegisteredPlugins()
78 registered: getRegisteredThemes(),
82 enabled: Emailer.isEnabled()
85 enabled: CONFIG.CONTACT_FORM.ENABLED
87 serverVersion: PEERTUBE_VERSION,
92 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
96 enabled: CONFIG.TRANSCODING.HLS.ENABLED
99 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
101 enabledResolutions: getEnabledResolutions()
106 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
109 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
116 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
123 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
125 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
130 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
132 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
136 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
142 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
144 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
148 videoQuota: CONFIG.USER.VIDEO_QUOTA,
149 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
153 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
157 enabled: CONFIG.TRACKER.ENABLED
161 return res.json(json)
164 function getAbout (req: express.Request, res: express.Response) {
165 const about: About = {
167 name: CONFIG.INSTANCE.NAME,
168 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
169 description: CONFIG.INSTANCE.DESCRIPTION,
170 terms: CONFIG.INSTANCE.TERMS,
171 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
173 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
175 creationReason: CONFIG.INSTANCE.CREATION_REASON,
176 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
177 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
178 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
179 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
181 languages: CONFIG.INSTANCE.LANGUAGES,
182 categories: CONFIG.INSTANCE.CATEGORIES
186 return res.json(about).end()
189 async function getCustomConfig (req: express.Request, res: express.Response) {
190 const data = customConfig()
192 return res.json(data).end()
195 async function deleteCustomConfig (req: express.Request, res: express.Response) {
196 await remove(CONFIG.CUSTOM_FILE)
198 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
201 ClientHtml.invalidCache()
203 const data = customConfig()
205 return res.json(data).end()
208 async function updateCustomConfig (req: express.Request, res: express.Response) {
209 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
211 // camelCase to snake_case key + Force number conversion
212 const toUpdateJSON = convertCustomConfigBody(req.body)
214 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
217 ClientHtml.invalidCache()
219 const data = customConfig()
222 getAuditIdFromRes(res),
223 new CustomConfigAuditView(data),
224 oldCustomConfigAuditKeys
227 return res.json(data).end()
230 function getRegisteredThemes () {
231 return PluginManager.Instance.getRegisteredThemes()
235 description: t.description,
237 clientScripts: t.clientScripts
241 function getEnabledResolutions () {
242 return Object.keys(CONFIG.TRANSCODING.RESOLUTIONS)
243 .filter(key => CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.RESOLUTIONS[ key ] === true)
244 .map(r => parseInt(r, 10))
247 function getRegisteredPlugins () {
248 return PluginManager.Instance.getRegisteredPlugins()
252 description: p.description,
253 clientScripts: p.clientScripts
257 // ---------------------------------------------------------------------------
261 getEnabledResolutions,
262 getRegisteredPlugins,
266 // ---------------------------------------------------------------------------
268 function customConfig (): CustomConfig {
271 name: CONFIG.INSTANCE.NAME,
272 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
273 description: CONFIG.INSTANCE.DESCRIPTION,
274 terms: CONFIG.INSTANCE.TERMS,
275 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
277 creationReason: CONFIG.INSTANCE.CREATION_REASON,
278 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
279 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
280 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
281 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
282 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
284 languages: CONFIG.INSTANCE.LANGUAGES,
285 categories: CONFIG.INSTANCE.CATEGORIES,
287 isNSFW: CONFIG.INSTANCE.IS_NSFW,
288 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
289 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
291 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
292 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
296 default: CONFIG.THEME.DEFAULT
300 username: CONFIG.SERVICES.TWITTER.USERNAME,
301 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
306 size: CONFIG.CACHE.PREVIEWS.SIZE
309 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
313 enabled: CONFIG.SIGNUP.ENABLED,
314 limit: CONFIG.SIGNUP.LIMIT,
315 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
318 email: CONFIG.ADMIN.EMAIL
321 enabled: CONFIG.CONTACT_FORM.ENABLED
324 videoQuota: CONFIG.USER.VIDEO_QUOTA,
325 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
328 enabled: CONFIG.TRANSCODING.ENABLED,
329 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
330 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
331 threads: CONFIG.TRANSCODING.THREADS,
333 '0p': CONFIG.TRANSCODING.RESOLUTIONS[ '0p' ],
334 '240p': CONFIG.TRANSCODING.RESOLUTIONS[ '240p' ],
335 '360p': CONFIG.TRANSCODING.RESOLUTIONS[ '360p' ],
336 '480p': CONFIG.TRANSCODING.RESOLUTIONS[ '480p' ],
337 '720p': CONFIG.TRANSCODING.RESOLUTIONS[ '720p' ],
338 '1080p': CONFIG.TRANSCODING.RESOLUTIONS[ '1080p' ],
339 '2160p': CONFIG.TRANSCODING.RESOLUTIONS[ '2160p' ]
342 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
345 enabled: CONFIG.TRANSCODING.HLS.ENABLED
351 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
354 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
361 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
367 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
368 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
374 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
378 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
379 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
386 function convertCustomConfigBody (body: CustomConfig) {
387 function keyConverter (k: string) {
388 // Transcoding resolutions exception
389 if (/^\d{3,4}p$/.exec(k)) return k
390 if (k === '0p') return k
395 function valueConverter (v: any) {
396 if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
401 return objectConverter(body, keyConverter, valueConverter)