1 import * as express from 'express'
2 import { omit } 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 } from '../../helpers/audit-logger'
12 import { remove, writeJSON } from 'fs-extra'
14 const packageJSON = require('../../../../package.json')
15 const configRouter = express.Router()
17 const auditLogger = auditLoggerFactory('config')
19 configRouter.get('/about', getAbout)
21 asyncMiddleware(getConfig)
24 configRouter.get('/custom',
26 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
27 asyncMiddleware(getCustomConfig)
29 configRouter.put('/custom',
31 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
32 asyncMiddleware(customConfigUpdateValidator),
33 asyncMiddleware(updateCustomConfig)
35 configRouter.delete('/custom',
37 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
38 asyncMiddleware(deleteCustomConfig)
41 async function getConfig (req: express.Request, res: express.Response, next: express.NextFunction) {
42 const allowed = await isSignupAllowed()
43 const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip)
45 const enabledResolutions = Object.keys(CONFIG.TRANSCODING.RESOLUTIONS)
46 .filter(key => CONFIG.TRANSCODING.ENABLED === CONFIG.TRANSCODING.RESOLUTIONS[key] === true)
47 .map(r => parseInt(r, 10))
49 const json: ServerConfig = {
51 name: CONFIG.INSTANCE.NAME,
52 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
53 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
54 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
56 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
57 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
60 serverVersion: packageJSON.version,
71 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
74 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
81 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
83 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
88 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
90 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
94 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
100 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
102 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
106 videoQuota: CONFIG.USER.VIDEO_QUOTA,
107 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
111 return res.json(json)
114 function getAbout (req: express.Request, res: express.Response, next: express.NextFunction) {
115 const about: About = {
117 name: CONFIG.INSTANCE.NAME,
118 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
119 description: CONFIG.INSTANCE.DESCRIPTION,
120 terms: CONFIG.INSTANCE.TERMS
124 return res.json(about).end()
127 async function getCustomConfig (req: express.Request, res: express.Response, next: express.NextFunction) {
128 const data = customConfig()
130 return res.json(data).end()
133 async function deleteCustomConfig (req: express.Request, res: express.Response, next: express.NextFunction) {
134 await remove(CONFIG.CUSTOM_FILE)
137 res.locals.oauth.token.User.Account.Actor.getIdentifier(),
138 new CustomConfigAuditView(customConfig())
142 ClientHtml.invalidCache()
144 const data = customConfig()
146 return res.json(data).end()
149 async function updateCustomConfig (req: express.Request, res: express.Response, next: express.NextFunction) {
150 const toUpdate: CustomConfig = req.body
151 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
153 // Force number conversion
154 toUpdate.cache.previews.size = parseInt('' + toUpdate.cache.previews.size, 10)
155 toUpdate.cache.captions.size = parseInt('' + toUpdate.cache.captions.size, 10)
156 toUpdate.signup.limit = parseInt('' + toUpdate.signup.limit, 10)
157 toUpdate.user.videoQuota = parseInt('' + toUpdate.user.videoQuota, 10)
158 toUpdate.user.videoQuotaDaily = parseInt('' + toUpdate.user.videoQuotaDaily, 10)
159 toUpdate.transcoding.threads = parseInt('' + toUpdate.transcoding.threads, 10)
161 // camelCase to snake_case key
162 const toUpdateJSON = omit(toUpdate, 'user.videoQuota', 'instance.defaultClientRoute', 'instance.shortDescription', 'cache.videoCaptions')
163 toUpdateJSON.user['video_quota'] = toUpdate.user.videoQuota
164 toUpdateJSON.user['video_quota_daily'] = toUpdate.user.videoQuotaDaily
165 toUpdateJSON.instance['default_client_route'] = toUpdate.instance.defaultClientRoute
166 toUpdateJSON.instance['short_description'] = toUpdate.instance.shortDescription
167 toUpdateJSON.instance['default_nsfw_policy'] = toUpdate.instance.defaultNSFWPolicy
169 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
172 ClientHtml.invalidCache()
174 const data = customConfig()
177 res.locals.oauth.token.User.Account.Actor.getIdentifier(),
178 new CustomConfigAuditView(data),
179 oldCustomConfigAuditKeys
182 return res.json(data).end()
185 // ---------------------------------------------------------------------------
191 // ---------------------------------------------------------------------------
193 function customConfig (): CustomConfig {
196 name: CONFIG.INSTANCE.NAME,
197 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
198 description: CONFIG.INSTANCE.DESCRIPTION,
199 terms: CONFIG.INSTANCE.TERMS,
200 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
201 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
203 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
204 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
209 username: CONFIG.SERVICES.TWITTER.USERNAME,
210 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
215 size: CONFIG.CACHE.PREVIEWS.SIZE
218 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
222 enabled: CONFIG.SIGNUP.ENABLED,
223 limit: CONFIG.SIGNUP.LIMIT
226 email: CONFIG.ADMIN.EMAIL
229 videoQuota: CONFIG.USER.VIDEO_QUOTA,
230 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
233 enabled: CONFIG.TRANSCODING.ENABLED,
234 threads: CONFIG.TRANSCODING.THREADS,
236 '240p': CONFIG.TRANSCODING.RESOLUTIONS[ '240p' ],
237 '360p': CONFIG.TRANSCODING.RESOLUTIONS[ '360p' ],
238 '480p': CONFIG.TRANSCODING.RESOLUTIONS[ '480p' ],
239 '720p': CONFIG.TRANSCODING.RESOLUTIONS[ '720p' ],
240 '1080p': CONFIG.TRANSCODING.RESOLUTIONS[ '1080p' ]
246 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
249 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED