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