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