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