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