]>
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' |
66170ca8 | 7 | import { CONSTRAINTS_FIELDS, DEFAULT_THEME_NAME, PEERTUBE_VERSION } 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' |
7cde3b9c | 15 | import validator from 'validator' |
a4101923 | 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' |
4ce7eb71 | 20 | import { Hooks } from '@server/lib/plugins/hooks' |
65fcc311 C |
21 | |
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), | |
a1587156 | 34 | getCustomConfig |
fd206f0b C |
35 | ) |
36 | configRouter.put('/custom', | |
37 | authenticate, | |
38 | ensureUserHasRight(UserRight.MANAGE_CONFIGURATION), | |
a1587156 | 39 | customConfigUpdateValidator, |
fd206f0b C |
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 |
66170ca8 | 49 | |
1b5e2d72 | 50 | async function getConfig (req: express.Request, res: express.Response) { |
4ce7eb71 C |
51 | const { allowed } = await Hooks.wrapPromiseFun( |
52 | isSignupAllowed, | |
70870adf JL |
53 | { |
54 | ip: req.ip | |
55 | }, | |
4ce7eb71 C |
56 | 'filter:api.user.signup.allowed.result' |
57 | ) | |
58 | ||
ff2c1fe8 | 59 | const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip) |
66170ca8 | 60 | const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME) |
1b5e2d72 C |
61 | |
62 | if (serverCommit === undefined) serverCommit = await getServerCommit() | |
291e8d3e | 63 | |
eb080476 | 64 | const json: ServerConfig = { |
36f9424f | 65 | instance: { |
00b5556c | 66 | name: CONFIG.INSTANCE.NAME, |
2e3a0215 | 67 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, |
901637bb | 68 | defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE, |
f8802489 | 69 | isNSFW: CONFIG.INSTANCE.IS_NSFW, |
0883b324 | 70 | defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, |
00b5556c C |
71 | customizations: { |
72 | javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT, | |
73 | css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS | |
74 | } | |
36f9424f | 75 | }, |
7cd4d2ba | 76 | plugin: { |
66170ca8 | 77 | registered: getRegisteredPlugins() |
7cd4d2ba C |
78 | }, |
79 | theme: { | |
66170ca8 | 80 | registered: getRegisteredThemes(), |
7cd4d2ba C |
81 | default: defaultTheme |
82 | }, | |
3b3b1820 | 83 | email: { |
d3e56c0c | 84 | enabled: Emailer.isEnabled() |
3b3b1820 | 85 | }, |
a4101923 C |
86 | contactForm: { |
87 | enabled: CONFIG.CONTACT_FORM.ENABLED | |
88 | }, | |
66170ca8 | 89 | serverVersion: PEERTUBE_VERSION, |
abb2c792 | 90 | serverCommit, |
eb080476 | 91 | signup: { |
ff2c1fe8 | 92 | allowed, |
d9eaee39 JM |
93 | allowedForCurrentIP, |
94 | requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION | |
eb080476 C |
95 | }, |
96 | transcoding: { | |
09209296 C |
97 | hls: { |
98 | enabled: CONFIG.TRANSCODING.HLS.ENABLED | |
99 | }, | |
d7a25329 C |
100 | webtorrent: { |
101 | enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED | |
102 | }, | |
66170ca8 | 103 | enabledResolutions: getEnabledResolutions() |
01de67b9 | 104 | }, |
5d08a6a7 | 105 | import: { |
b2977eec | 106 | videos: { |
5d08a6a7 C |
107 | http: { |
108 | enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED | |
a84b8fa5 C |
109 | }, |
110 | torrent: { | |
111 | enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED | |
5d08a6a7 C |
112 | } |
113 | } | |
114 | }, | |
7ccddd7b JM |
115 | autoBlacklist: { |
116 | videos: { | |
117 | ofUsers: { | |
118 | enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED | |
119 | } | |
120 | } | |
121 | }, | |
01de67b9 C |
122 | avatar: { |
123 | file: { | |
124 | size: { | |
125 | max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max | |
126 | }, | |
127 | extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME | |
128 | } | |
129 | }, | |
130 | video: { | |
6de36768 C |
131 | image: { |
132 | extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME, | |
133 | size: { | |
134 | max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max | |
135 | } | |
136 | }, | |
01de67b9 C |
137 | file: { |
138 | extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME | |
139 | } | |
1869c875 | 140 | }, |
40e87e9e C |
141 | videoCaption: { |
142 | file: { | |
143 | size: { | |
144 | max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max | |
145 | }, | |
146 | extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME | |
147 | } | |
148 | }, | |
1869c875 | 149 | user: { |
bee0abff FA |
150 | videoQuota: CONFIG.USER.VIDEO_QUOTA, |
151 | videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY | |
9b4b15f9 AB |
152 | }, |
153 | trending: { | |
154 | videos: { | |
155 | intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS | |
156 | } | |
31b6ddf8 C |
157 | }, |
158 | tracker: { | |
159 | enabled: CONFIG.TRACKER.ENABLED | |
000eb0e4 RK |
160 | }, |
161 | ||
162 | followings: { | |
163 | instance: { | |
164 | autoFollowIndex: { | |
165 | indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL | |
166 | } | |
167 | } | |
65fcc311 | 168 | } |
eb080476 | 169 | } |
6a84aafd | 170 | |
eb080476 | 171 | return res.json(json) |
65fcc311 C |
172 | } |
173 | ||
f8802489 | 174 | function getAbout (req: express.Request, res: express.Response) { |
36f9424f C |
175 | const about: About = { |
176 | instance: { | |
177 | name: CONFIG.INSTANCE.NAME, | |
2e3a0215 | 178 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, |
36f9424f | 179 | description: CONFIG.INSTANCE.DESCRIPTION, |
ccc00cb2 C |
180 | terms: CONFIG.INSTANCE.TERMS, |
181 | codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT, | |
182 | ||
be04c6fd C |
183 | hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION, |
184 | ||
8ae03c37 | 185 | creationReason: CONFIG.INSTANCE.CREATION_REASON, |
ccc00cb2 C |
186 | moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION, |
187 | administrator: CONFIG.INSTANCE.ADMINISTRATOR, | |
188 | maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME, | |
189 | businessModel: CONFIG.INSTANCE.BUSINESS_MODEL, | |
190 | ||
191 | languages: CONFIG.INSTANCE.LANGUAGES, | |
192 | categories: CONFIG.INSTANCE.CATEGORIES | |
36f9424f C |
193 | } |
194 | } | |
195 | ||
196 | return res.json(about).end() | |
197 | } | |
198 | ||
a1587156 | 199 | function getCustomConfig (req: express.Request, res: express.Response) { |
fd206f0b C |
200 | const data = customConfig() |
201 | ||
202 | return res.json(data).end() | |
203 | } | |
204 | ||
f8802489 | 205 | async function deleteCustomConfig (req: express.Request, res: express.Response) { |
62689b94 | 206 | await remove(CONFIG.CUSTOM_FILE) |
fd206f0b | 207 | |
993cef4b | 208 | auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig())) |
80e36cd9 | 209 | |
fd206f0b | 210 | reloadConfig() |
e032aec9 | 211 | ClientHtml.invalidCache() |
fd206f0b C |
212 | |
213 | const data = customConfig() | |
214 | ||
215 | return res.json(data).end() | |
216 | } | |
217 | ||
f8802489 | 218 | async function updateCustomConfig (req: express.Request, res: express.Response) { |
80e36cd9 | 219 | const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig()) |
fd206f0b | 220 | |
a4101923 C |
221 | // camelCase to snake_case key + Force number conversion |
222 | const toUpdateJSON = convertCustomConfigBody(req.body) | |
fd206f0b | 223 | |
62689b94 | 224 | await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 }) |
fd206f0b C |
225 | |
226 | reloadConfig() | |
e032aec9 | 227 | ClientHtml.invalidCache() |
fd206f0b C |
228 | |
229 | const data = customConfig() | |
80e36cd9 AB |
230 | |
231 | auditLogger.update( | |
993cef4b | 232 | getAuditIdFromRes(res), |
80e36cd9 AB |
233 | new CustomConfigAuditView(data), |
234 | oldCustomConfigAuditKeys | |
235 | ) | |
236 | ||
fd206f0b C |
237 | return res.json(data).end() |
238 | } | |
239 | ||
174e0855 RK |
240 | function getRegisteredThemes () { |
241 | return PluginManager.Instance.getRegisteredThemes() | |
242 | .map(t => ({ | |
243 | name: t.name, | |
244 | version: t.version, | |
245 | description: t.description, | |
246 | css: t.css, | |
247 | clientScripts: t.clientScripts | |
248 | })) | |
249 | } | |
250 | ||
251 | function getEnabledResolutions () { | |
252 | return Object.keys(CONFIG.TRANSCODING.RESOLUTIONS) | |
a1587156 | 253 | .filter(key => CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.RESOLUTIONS[key] === true) |
174e0855 RK |
254 | .map(r => parseInt(r, 10)) |
255 | } | |
256 | ||
257 | function getRegisteredPlugins () { | |
258 | return PluginManager.Instance.getRegisteredPlugins() | |
259 | .map(p => ({ | |
260 | name: p.name, | |
261 | version: p.version, | |
262 | description: p.description, | |
263 | clientScripts: p.clientScripts | |
264 | })) | |
265 | } | |
266 | ||
65fcc311 C |
267 | // --------------------------------------------------------------------------- |
268 | ||
269 | export { | |
174e0855 RK |
270 | configRouter, |
271 | getEnabledResolutions, | |
272 | getRegisteredPlugins, | |
273 | getRegisteredThemes | |
65fcc311 | 274 | } |
fd206f0b C |
275 | |
276 | // --------------------------------------------------------------------------- | |
277 | ||
278 | function customConfig (): CustomConfig { | |
279 | return { | |
66b16caf C |
280 | instance: { |
281 | name: CONFIG.INSTANCE.NAME, | |
2e3a0215 | 282 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, |
66b16caf | 283 | description: CONFIG.INSTANCE.DESCRIPTION, |
00b5556c | 284 | terms: CONFIG.INSTANCE.TERMS, |
ccc00cb2 C |
285 | codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT, |
286 | ||
8ae03c37 | 287 | creationReason: CONFIG.INSTANCE.CREATION_REASON, |
ccc00cb2 C |
288 | moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION, |
289 | administrator: CONFIG.INSTANCE.ADMINISTRATOR, | |
290 | maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME, | |
291 | businessModel: CONFIG.INSTANCE.BUSINESS_MODEL, | |
be04c6fd | 292 | hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION, |
ccc00cb2 C |
293 | |
294 | languages: CONFIG.INSTANCE.LANGUAGES, | |
295 | categories: CONFIG.INSTANCE.CATEGORIES, | |
296 | ||
f8802489 | 297 | isNSFW: CONFIG.INSTANCE.IS_NSFW, |
901637bb | 298 | defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE, |
0883b324 | 299 | defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, |
00b5556c C |
300 | customizations: { |
301 | css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS, | |
302 | javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT | |
303 | } | |
66b16caf | 304 | }, |
7cd4d2ba C |
305 | theme: { |
306 | default: CONFIG.THEME.DEFAULT | |
307 | }, | |
8be1afa1 C |
308 | services: { |
309 | twitter: { | |
310 | username: CONFIG.SERVICES.TWITTER.USERNAME, | |
311 | whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED | |
312 | } | |
313 | }, | |
fd206f0b C |
314 | cache: { |
315 | previews: { | |
316 | size: CONFIG.CACHE.PREVIEWS.SIZE | |
40e87e9e C |
317 | }, |
318 | captions: { | |
319 | size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE | |
fd206f0b C |
320 | } |
321 | }, | |
322 | signup: { | |
323 | enabled: CONFIG.SIGNUP.ENABLED, | |
d9eaee39 JM |
324 | limit: CONFIG.SIGNUP.LIMIT, |
325 | requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION | |
fd206f0b C |
326 | }, |
327 | admin: { | |
328 | email: CONFIG.ADMIN.EMAIL | |
329 | }, | |
a4101923 C |
330 | contactForm: { |
331 | enabled: CONFIG.CONTACT_FORM.ENABLED | |
332 | }, | |
fd206f0b | 333 | user: { |
bee0abff FA |
334 | videoQuota: CONFIG.USER.VIDEO_QUOTA, |
335 | videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY | |
fd206f0b C |
336 | }, |
337 | transcoding: { | |
338 | enabled: CONFIG.TRANSCODING.ENABLED, | |
14e2014a | 339 | allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS, |
536598cf | 340 | allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES, |
fd206f0b C |
341 | threads: CONFIG.TRANSCODING.THREADS, |
342 | resolutions: { | |
a1587156 C |
343 | '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'], |
344 | '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'], | |
345 | '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'], | |
346 | '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'], | |
347 | '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'], | |
348 | '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'], | |
349 | '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p'] | |
09209296 | 350 | }, |
d7a25329 C |
351 | webtorrent: { |
352 | enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED | |
353 | }, | |
09209296 C |
354 | hls: { |
355 | enabled: CONFIG.TRANSCODING.HLS.ENABLED | |
fd206f0b | 356 | } |
5d08a6a7 C |
357 | }, |
358 | import: { | |
359 | videos: { | |
360 | http: { | |
361 | enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED | |
a84b8fa5 C |
362 | }, |
363 | torrent: { | |
364 | enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED | |
5d08a6a7 C |
365 | } |
366 | } | |
7ccddd7b JM |
367 | }, |
368 | autoBlacklist: { | |
369 | videos: { | |
370 | ofUsers: { | |
371 | enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED | |
372 | } | |
373 | } | |
5b9c965d C |
374 | }, |
375 | followers: { | |
376 | instance: { | |
14893eb7 C |
377 | enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED, |
378 | manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL | |
5b9c965d | 379 | } |
8424c402 C |
380 | }, |
381 | followings: { | |
382 | instance: { | |
383 | autoFollowBack: { | |
384 | enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED | |
385 | }, | |
386 | ||
387 | autoFollowIndex: { | |
388 | enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED, | |
389 | indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL | |
390 | } | |
391 | } | |
fd206f0b C |
392 | } |
393 | } | |
394 | } | |
a4101923 C |
395 | |
396 | function convertCustomConfigBody (body: CustomConfig) { | |
397 | function keyConverter (k: string) { | |
398 | // Transcoding resolutions exception | |
399 | if (/^\d{3,4}p$/.exec(k)) return k | |
3a149e9f | 400 | if (k === '0p') return k |
a4101923 C |
401 | |
402 | return snakeCase(k) | |
403 | } | |
404 | ||
405 | function valueConverter (v: any) { | |
7cde3b9c | 406 | if (validator.isNumeric(v + '')) return parseInt('' + v, 10) |
a4101923 C |
407 | |
408 | return v | |
409 | } | |
410 | ||
411 | return objectConverter(body, keyConverter, valueConverter) | |
412 | } |