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