]>
Commit | Line | Data |
---|---|---|
4d4e5cd4 | 1 | import * as express from 'express' |
09209296 | 2 | import { snakeCase } from 'lodash' |
7cd4d2ba | 3 | import { ServerConfig, UserRight } from '../../../shared' |
09cababd C |
4 | import { About } from '../../../shared/models/server/about.model' |
5 | import { CustomConfig } from '../../../shared/models/server/custom-config.model' | |
06215f15 | 6 | import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../helpers/signup' |
ffb321be | 7 | import { CONSTRAINTS_FIELDS, DEFAULT_THEME_NAME } from '../../initializers/constants' |
fd206f0b C |
8 | import { asyncMiddleware, authenticate, ensureUserHasRight } from '../../middlewares' |
9 | import { customConfigUpdateValidator } from '../../middlewares/validators/config' | |
e032aec9 | 10 | import { ClientHtml } from '../../lib/client-html' |
993cef4b | 11 | import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger' |
62689b94 | 12 | import { remove, writeJSON } from 'fs-extra' |
1b5e2d72 | 13 | import { getServerCommit } from '../../helpers/utils' |
3b3b1820 | 14 | import { Emailer } from '../../lib/emailer' |
a4101923 C |
15 | import { isNumeric } from 'validator' |
16 | import { objectConverter } from '../../helpers/core-utils' | |
6dd9de95 | 17 | import { CONFIG, reloadConfig } from '../../initializers/config' |
18a6f04c | 18 | import { PluginManager } from '../../lib/plugins/plugin-manager' |
7cd4d2ba | 19 | import { getThemeOrDefault } from '../../lib/plugins/theme-utils' |
65fcc311 | 20 | |
915c5bbe | 21 | const packageJSON = require('../../../../package.json') |
65fcc311 C |
22 | const configRouter = express.Router() |
23 | ||
80e36cd9 AB |
24 | const auditLogger = auditLoggerFactory('config') |
25 | ||
36f9424f | 26 | configRouter.get('/about', getAbout) |
eb080476 C |
27 | configRouter.get('/', |
28 | asyncMiddleware(getConfig) | |
29 | ) | |
36f9424f | 30 | |
fd206f0b C |
31 | configRouter.get('/custom', |
32 | authenticate, | |
33 | ensureUserHasRight(UserRight.MANAGE_CONFIGURATION), | |
34 | asyncMiddleware(getCustomConfig) | |
35 | ) | |
36 | configRouter.put('/custom', | |
37 | authenticate, | |
38 | ensureUserHasRight(UserRight.MANAGE_CONFIGURATION), | |
39 | asyncMiddleware(customConfigUpdateValidator), | |
40 | asyncMiddleware(updateCustomConfig) | |
41 | ) | |
42 | configRouter.delete('/custom', | |
43 | authenticate, | |
44 | ensureUserHasRight(UserRight.MANAGE_CONFIGURATION), | |
45 | asyncMiddleware(deleteCustomConfig) | |
46 | ) | |
65fcc311 | 47 | |
abb2c792 | 48 | let serverCommit: string |
1b5e2d72 | 49 | async function getConfig (req: express.Request, res: express.Response) { |
eb080476 | 50 | const allowed = await isSignupAllowed() |
ff2c1fe8 | 51 | const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip) |
1b5e2d72 C |
52 | |
53 | if (serverCommit === undefined) serverCommit = await getServerCommit() | |
291e8d3e | 54 | |
eb080476 | 55 | const enabledResolutions = Object.keys(CONFIG.TRANSCODING.RESOLUTIONS) |
465679ca | 56 | .filter(key => CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.RESOLUTIONS[key] === true) |
eb080476 | 57 | .map(r => parseInt(r, 10)) |
6a84aafd | 58 | |
18a6f04c | 59 | const registeredPlugins = PluginManager.Instance.getRegisteredPlugins() |
7cd4d2ba C |
60 | .map(p => ({ |
61 | name: p.name, | |
62 | version: p.version, | |
63 | description: p.description, | |
64 | clientScripts: p.clientScripts | |
65 | })) | |
66 | ||
67 | const registeredThemes = PluginManager.Instance.getRegisteredThemes() | |
68 | .map(t => ({ | |
69 | name: t.name, | |
70 | version: t.version, | |
71 | description: t.description, | |
ffb321be | 72 | css: t.css, |
7cd4d2ba C |
73 | clientScripts: t.clientScripts |
74 | })) | |
75 | ||
ffb321be | 76 | const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME) |
18a6f04c | 77 | |
eb080476 | 78 | const json: ServerConfig = { |
36f9424f | 79 | instance: { |
00b5556c | 80 | name: CONFIG.INSTANCE.NAME, |
2e3a0215 | 81 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, |
901637bb | 82 | defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE, |
f8802489 | 83 | isNSFW: CONFIG.INSTANCE.IS_NSFW, |
0883b324 | 84 | defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, |
00b5556c C |
85 | customizations: { |
86 | javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT, | |
87 | css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS | |
88 | } | |
36f9424f | 89 | }, |
7cd4d2ba C |
90 | plugin: { |
91 | registered: registeredPlugins | |
92 | }, | |
93 | theme: { | |
94 | registered: registeredThemes, | |
95 | default: defaultTheme | |
96 | }, | |
3b3b1820 | 97 | email: { |
d3e56c0c | 98 | enabled: Emailer.isEnabled() |
3b3b1820 | 99 | }, |
a4101923 C |
100 | contactForm: { |
101 | enabled: CONFIG.CONTACT_FORM.ENABLED | |
102 | }, | |
915c5bbe | 103 | serverVersion: packageJSON.version, |
abb2c792 | 104 | serverCommit, |
eb080476 | 105 | signup: { |
ff2c1fe8 | 106 | allowed, |
d9eaee39 JM |
107 | allowedForCurrentIP, |
108 | requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION | |
eb080476 C |
109 | }, |
110 | transcoding: { | |
09209296 C |
111 | hls: { |
112 | enabled: CONFIG.TRANSCODING.HLS.ENABLED | |
113 | }, | |
eb080476 | 114 | enabledResolutions |
01de67b9 | 115 | }, |
5d08a6a7 | 116 | import: { |
b2977eec | 117 | videos: { |
5d08a6a7 C |
118 | http: { |
119 | enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED | |
a84b8fa5 C |
120 | }, |
121 | torrent: { | |
122 | enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED | |
5d08a6a7 C |
123 | } |
124 | } | |
125 | }, | |
7ccddd7b JM |
126 | autoBlacklist: { |
127 | videos: { | |
128 | ofUsers: { | |
129 | enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED | |
130 | } | |
131 | } | |
132 | }, | |
01de67b9 C |
133 | avatar: { |
134 | file: { | |
135 | size: { | |
136 | max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max | |
137 | }, | |
138 | extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME | |
139 | } | |
140 | }, | |
141 | video: { | |
6de36768 C |
142 | image: { |
143 | extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME, | |
144 | size: { | |
145 | max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max | |
146 | } | |
147 | }, | |
01de67b9 C |
148 | file: { |
149 | extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME | |
150 | } | |
1869c875 | 151 | }, |
40e87e9e C |
152 | videoCaption: { |
153 | file: { | |
154 | size: { | |
155 | max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max | |
156 | }, | |
157 | extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME | |
158 | } | |
159 | }, | |
1869c875 | 160 | user: { |
bee0abff FA |
161 | videoQuota: CONFIG.USER.VIDEO_QUOTA, |
162 | videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY | |
9b4b15f9 AB |
163 | }, |
164 | trending: { | |
165 | videos: { | |
166 | intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS | |
167 | } | |
31b6ddf8 C |
168 | }, |
169 | tracker: { | |
170 | enabled: CONFIG.TRACKER.ENABLED | |
65fcc311 | 171 | } |
eb080476 | 172 | } |
6a84aafd | 173 | |
eb080476 | 174 | return res.json(json) |
65fcc311 C |
175 | } |
176 | ||
f8802489 | 177 | function getAbout (req: express.Request, res: express.Response) { |
36f9424f C |
178 | const about: About = { |
179 | instance: { | |
180 | name: CONFIG.INSTANCE.NAME, | |
2e3a0215 | 181 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, |
36f9424f C |
182 | description: CONFIG.INSTANCE.DESCRIPTION, |
183 | terms: CONFIG.INSTANCE.TERMS | |
184 | } | |
185 | } | |
186 | ||
187 | return res.json(about).end() | |
188 | } | |
189 | ||
f8802489 | 190 | async function getCustomConfig (req: express.Request, res: express.Response) { |
fd206f0b C |
191 | const data = customConfig() |
192 | ||
193 | return res.json(data).end() | |
194 | } | |
195 | ||
f8802489 | 196 | async function deleteCustomConfig (req: express.Request, res: express.Response) { |
62689b94 | 197 | await remove(CONFIG.CUSTOM_FILE) |
fd206f0b | 198 | |
993cef4b | 199 | auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig())) |
80e36cd9 | 200 | |
fd206f0b | 201 | reloadConfig() |
e032aec9 | 202 | ClientHtml.invalidCache() |
fd206f0b C |
203 | |
204 | const data = customConfig() | |
205 | ||
206 | return res.json(data).end() | |
207 | } | |
208 | ||
f8802489 | 209 | async function updateCustomConfig (req: express.Request, res: express.Response) { |
80e36cd9 | 210 | const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig()) |
fd206f0b | 211 | |
a4101923 C |
212 | // camelCase to snake_case key + Force number conversion |
213 | const toUpdateJSON = convertCustomConfigBody(req.body) | |
fd206f0b | 214 | |
62689b94 | 215 | await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 }) |
fd206f0b C |
216 | |
217 | reloadConfig() | |
e032aec9 | 218 | ClientHtml.invalidCache() |
fd206f0b C |
219 | |
220 | const data = customConfig() | |
80e36cd9 AB |
221 | |
222 | auditLogger.update( | |
993cef4b | 223 | getAuditIdFromRes(res), |
80e36cd9 AB |
224 | new CustomConfigAuditView(data), |
225 | oldCustomConfigAuditKeys | |
226 | ) | |
227 | ||
fd206f0b C |
228 | return res.json(data).end() |
229 | } | |
230 | ||
65fcc311 C |
231 | // --------------------------------------------------------------------------- |
232 | ||
233 | export { | |
234 | configRouter | |
235 | } | |
fd206f0b C |
236 | |
237 | // --------------------------------------------------------------------------- | |
238 | ||
239 | function customConfig (): CustomConfig { | |
240 | return { | |
66b16caf C |
241 | instance: { |
242 | name: CONFIG.INSTANCE.NAME, | |
2e3a0215 | 243 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, |
66b16caf | 244 | description: CONFIG.INSTANCE.DESCRIPTION, |
00b5556c | 245 | terms: CONFIG.INSTANCE.TERMS, |
f8802489 | 246 | isNSFW: CONFIG.INSTANCE.IS_NSFW, |
901637bb | 247 | defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE, |
0883b324 | 248 | defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, |
00b5556c C |
249 | customizations: { |
250 | css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS, | |
251 | javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT | |
252 | } | |
66b16caf | 253 | }, |
7cd4d2ba C |
254 | theme: { |
255 | default: CONFIG.THEME.DEFAULT | |
256 | }, | |
8be1afa1 C |
257 | services: { |
258 | twitter: { | |
259 | username: CONFIG.SERVICES.TWITTER.USERNAME, | |
260 | whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED | |
261 | } | |
262 | }, | |
fd206f0b C |
263 | cache: { |
264 | previews: { | |
265 | size: CONFIG.CACHE.PREVIEWS.SIZE | |
40e87e9e C |
266 | }, |
267 | captions: { | |
268 | size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE | |
fd206f0b C |
269 | } |
270 | }, | |
271 | signup: { | |
272 | enabled: CONFIG.SIGNUP.ENABLED, | |
d9eaee39 JM |
273 | limit: CONFIG.SIGNUP.LIMIT, |
274 | requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION | |
fd206f0b C |
275 | }, |
276 | admin: { | |
277 | email: CONFIG.ADMIN.EMAIL | |
278 | }, | |
a4101923 C |
279 | contactForm: { |
280 | enabled: CONFIG.CONTACT_FORM.ENABLED | |
281 | }, | |
fd206f0b | 282 | user: { |
bee0abff FA |
283 | videoQuota: CONFIG.USER.VIDEO_QUOTA, |
284 | videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY | |
fd206f0b C |
285 | }, |
286 | transcoding: { | |
287 | enabled: CONFIG.TRANSCODING.ENABLED, | |
14e2014a | 288 | allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS, |
536598cf | 289 | allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES, |
fd206f0b C |
290 | threads: CONFIG.TRANSCODING.THREADS, |
291 | resolutions: { | |
292 | '240p': CONFIG.TRANSCODING.RESOLUTIONS[ '240p' ], | |
293 | '360p': CONFIG.TRANSCODING.RESOLUTIONS[ '360p' ], | |
294 | '480p': CONFIG.TRANSCODING.RESOLUTIONS[ '480p' ], | |
295 | '720p': CONFIG.TRANSCODING.RESOLUTIONS[ '720p' ], | |
00aa1f0d C |
296 | '1080p': CONFIG.TRANSCODING.RESOLUTIONS[ '1080p' ], |
297 | '2160p': CONFIG.TRANSCODING.RESOLUTIONS[ '2160p' ] | |
09209296 C |
298 | }, |
299 | hls: { | |
300 | enabled: CONFIG.TRANSCODING.HLS.ENABLED | |
fd206f0b | 301 | } |
5d08a6a7 C |
302 | }, |
303 | import: { | |
304 | videos: { | |
305 | http: { | |
306 | enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED | |
a84b8fa5 C |
307 | }, |
308 | torrent: { | |
309 | enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED | |
5d08a6a7 C |
310 | } |
311 | } | |
7ccddd7b JM |
312 | }, |
313 | autoBlacklist: { | |
314 | videos: { | |
315 | ofUsers: { | |
316 | enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED | |
317 | } | |
318 | } | |
5b9c965d C |
319 | }, |
320 | followers: { | |
321 | instance: { | |
14893eb7 C |
322 | enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED, |
323 | manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL | |
5b9c965d | 324 | } |
fd206f0b C |
325 | } |
326 | } | |
327 | } | |
a4101923 C |
328 | |
329 | function convertCustomConfigBody (body: CustomConfig) { | |
330 | function keyConverter (k: string) { | |
331 | // Transcoding resolutions exception | |
332 | if (/^\d{3,4}p$/.exec(k)) return k | |
333 | ||
334 | return snakeCase(k) | |
335 | } | |
336 | ||
337 | function valueConverter (v: any) { | |
338 | if (isNumeric(v + '')) return parseInt('' + v, 10) | |
339 | ||
340 | return v | |
341 | } | |
342 | ||
343 | return objectConverter(body, keyConverter, valueConverter) | |
344 | } |