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,
64 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
72 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
75 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
82 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
84 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
89 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
91 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
95 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
101 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
103 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
107 videoQuota: CONFIG.USER.VIDEO_QUOTA,
108 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
112 return res.json(json)
115 function getAbout (req: express.Request, res: express.Response, next: express.NextFunction) {
116 const about: About = {
118 name: CONFIG.INSTANCE.NAME,
119 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
120 description: CONFIG.INSTANCE.DESCRIPTION,
121 terms: CONFIG.INSTANCE.TERMS
125 return res.json(about).end()
128 async function getCustomConfig (req: express.Request, res: express.Response, next: express.NextFunction) {
129 const data = customConfig()
131 return res.json(data).end()
134 async function deleteCustomConfig (req: express.Request, res: express.Response, next: express.NextFunction) {
135 await remove(CONFIG.CUSTOM_FILE)
138 res.locals.oauth.token.User.Account.Actor.getIdentifier(),
139 new CustomConfigAuditView(customConfig())
143 ClientHtml.invalidCache()
145 const data = customConfig()
147 return res.json(data).end()
150 async function updateCustomConfig (req: express.Request, res: express.Response, next: express.NextFunction) {
151 const toUpdate: CustomConfig = req.body
152 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
154 // Force number conversion
155 toUpdate.cache.previews.size = parseInt('' + toUpdate.cache.previews.size, 10)
156 toUpdate.cache.captions.size = parseInt('' + toUpdate.cache.captions.size, 10)
157 toUpdate.signup.limit = parseInt('' + toUpdate.signup.limit, 10)
158 toUpdate.user.videoQuota = parseInt('' + toUpdate.user.videoQuota, 10)
159 toUpdate.user.videoQuotaDaily = parseInt('' + toUpdate.user.videoQuotaDaily, 10)
160 toUpdate.transcoding.threads = parseInt('' + toUpdate.transcoding.threads, 10)
162 // camelCase to snake_case key
163 const toUpdateJSON = omit(
166 'instance.defaultClientRoute',
167 'instance.shortDescription',
168 'cache.videoCaptions',
169 'signup.requiresEmailVerification'
171 toUpdateJSON.user['video_quota'] = toUpdate.user.videoQuota
172 toUpdateJSON.user['video_quota_daily'] = toUpdate.user.videoQuotaDaily
173 toUpdateJSON.instance['default_client_route'] = toUpdate.instance.defaultClientRoute
174 toUpdateJSON.instance['short_description'] = toUpdate.instance.shortDescription
175 toUpdateJSON.instance['default_nsfw_policy'] = toUpdate.instance.defaultNSFWPolicy
176 toUpdateJSON.signup['requires_email_verification'] = toUpdate.signup.requiresEmailVerification
178 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
181 ClientHtml.invalidCache()
183 const data = customConfig()
186 res.locals.oauth.token.User.Account.Actor.getIdentifier(),
187 new CustomConfigAuditView(data),
188 oldCustomConfigAuditKeys
191 return res.json(data).end()
194 // ---------------------------------------------------------------------------
200 // ---------------------------------------------------------------------------
202 function customConfig (): CustomConfig {
205 name: CONFIG.INSTANCE.NAME,
206 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
207 description: CONFIG.INSTANCE.DESCRIPTION,
208 terms: CONFIG.INSTANCE.TERMS,
209 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
210 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
212 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
213 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
218 username: CONFIG.SERVICES.TWITTER.USERNAME,
219 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
224 size: CONFIG.CACHE.PREVIEWS.SIZE
227 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
231 enabled: CONFIG.SIGNUP.ENABLED,
232 limit: CONFIG.SIGNUP.LIMIT,
233 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
236 email: CONFIG.ADMIN.EMAIL
239 videoQuota: CONFIG.USER.VIDEO_QUOTA,
240 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
243 enabled: CONFIG.TRANSCODING.ENABLED,
244 threads: CONFIG.TRANSCODING.THREADS,
246 '240p': CONFIG.TRANSCODING.RESOLUTIONS[ '240p' ],
247 '360p': CONFIG.TRANSCODING.RESOLUTIONS[ '360p' ],
248 '480p': CONFIG.TRANSCODING.RESOLUTIONS[ '480p' ],
249 '720p': CONFIG.TRANSCODING.RESOLUTIONS[ '720p' ],
250 '1080p': CONFIG.TRANSCODING.RESOLUTIONS[ '1080p' ]
256 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
259 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED