]>
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 | ||
8ae03c37 | 164 | creationReason: CONFIG.INSTANCE.CREATION_REASON, |
ccc00cb2 C |
165 | moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION, |
166 | administrator: CONFIG.INSTANCE.ADMINISTRATOR, | |
167 | maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME, | |
168 | businessModel: CONFIG.INSTANCE.BUSINESS_MODEL, | |
169 | ||
170 | languages: CONFIG.INSTANCE.LANGUAGES, | |
171 | categories: CONFIG.INSTANCE.CATEGORIES | |
36f9424f C |
172 | } |
173 | } | |
174 | ||
175 | return res.json(about).end() | |
176 | } | |
177 | ||
f8802489 | 178 | async function getCustomConfig (req: express.Request, res: express.Response) { |
fd206f0b C |
179 | const data = customConfig() |
180 | ||
181 | return res.json(data).end() | |
182 | } | |
183 | ||
f8802489 | 184 | async function deleteCustomConfig (req: express.Request, res: express.Response) { |
62689b94 | 185 | await remove(CONFIG.CUSTOM_FILE) |
fd206f0b | 186 | |
993cef4b | 187 | auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig())) |
80e36cd9 | 188 | |
fd206f0b | 189 | reloadConfig() |
e032aec9 | 190 | ClientHtml.invalidCache() |
fd206f0b C |
191 | |
192 | const data = customConfig() | |
193 | ||
194 | return res.json(data).end() | |
195 | } | |
196 | ||
f8802489 | 197 | async function updateCustomConfig (req: express.Request, res: express.Response) { |
80e36cd9 | 198 | const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig()) |
fd206f0b | 199 | |
a4101923 C |
200 | // camelCase to snake_case key + Force number conversion |
201 | const toUpdateJSON = convertCustomConfigBody(req.body) | |
fd206f0b | 202 | |
62689b94 | 203 | await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 }) |
fd206f0b C |
204 | |
205 | reloadConfig() | |
e032aec9 | 206 | ClientHtml.invalidCache() |
fd206f0b C |
207 | |
208 | const data = customConfig() | |
80e36cd9 AB |
209 | |
210 | auditLogger.update( | |
993cef4b | 211 | getAuditIdFromRes(res), |
80e36cd9 AB |
212 | new CustomConfigAuditView(data), |
213 | oldCustomConfigAuditKeys | |
214 | ) | |
215 | ||
fd206f0b C |
216 | return res.json(data).end() |
217 | } | |
218 | ||
65fcc311 C |
219 | // --------------------------------------------------------------------------- |
220 | ||
221 | export { | |
222 | configRouter | |
223 | } | |
fd206f0b C |
224 | |
225 | // --------------------------------------------------------------------------- | |
226 | ||
227 | function customConfig (): CustomConfig { | |
228 | return { | |
66b16caf C |
229 | instance: { |
230 | name: CONFIG.INSTANCE.NAME, | |
2e3a0215 | 231 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, |
66b16caf | 232 | description: CONFIG.INSTANCE.DESCRIPTION, |
00b5556c | 233 | terms: CONFIG.INSTANCE.TERMS, |
ccc00cb2 C |
234 | codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT, |
235 | ||
8ae03c37 | 236 | creationReason: CONFIG.INSTANCE.CREATION_REASON, |
ccc00cb2 C |
237 | moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION, |
238 | administrator: CONFIG.INSTANCE.ADMINISTRATOR, | |
239 | maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME, | |
240 | businessModel: CONFIG.INSTANCE.BUSINESS_MODEL, | |
241 | ||
242 | languages: CONFIG.INSTANCE.LANGUAGES, | |
243 | categories: CONFIG.INSTANCE.CATEGORIES, | |
244 | ||
f8802489 | 245 | isNSFW: CONFIG.INSTANCE.IS_NSFW, |
901637bb | 246 | defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE, |
0883b324 | 247 | defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, |
00b5556c C |
248 | customizations: { |
249 | css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS, | |
250 | javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT | |
251 | } | |
66b16caf | 252 | }, |
7cd4d2ba C |
253 | theme: { |
254 | default: CONFIG.THEME.DEFAULT | |
255 | }, | |
8be1afa1 C |
256 | services: { |
257 | twitter: { | |
258 | username: CONFIG.SERVICES.TWITTER.USERNAME, | |
259 | whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED | |
260 | } | |
261 | }, | |
fd206f0b C |
262 | cache: { |
263 | previews: { | |
264 | size: CONFIG.CACHE.PREVIEWS.SIZE | |
40e87e9e C |
265 | }, |
266 | captions: { | |
267 | size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE | |
fd206f0b C |
268 | } |
269 | }, | |
270 | signup: { | |
271 | enabled: CONFIG.SIGNUP.ENABLED, | |
d9eaee39 JM |
272 | limit: CONFIG.SIGNUP.LIMIT, |
273 | requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION | |
fd206f0b C |
274 | }, |
275 | admin: { | |
276 | email: CONFIG.ADMIN.EMAIL | |
277 | }, | |
a4101923 C |
278 | contactForm: { |
279 | enabled: CONFIG.CONTACT_FORM.ENABLED | |
280 | }, | |
fd206f0b | 281 | user: { |
bee0abff FA |
282 | videoQuota: CONFIG.USER.VIDEO_QUOTA, |
283 | videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY | |
fd206f0b C |
284 | }, |
285 | transcoding: { | |
286 | enabled: CONFIG.TRANSCODING.ENABLED, | |
14e2014a | 287 | allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS, |
536598cf | 288 | allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES, |
fd206f0b C |
289 | threads: CONFIG.TRANSCODING.THREADS, |
290 | resolutions: { | |
291 | '240p': CONFIG.TRANSCODING.RESOLUTIONS[ '240p' ], | |
292 | '360p': CONFIG.TRANSCODING.RESOLUTIONS[ '360p' ], | |
293 | '480p': CONFIG.TRANSCODING.RESOLUTIONS[ '480p' ], | |
294 | '720p': CONFIG.TRANSCODING.RESOLUTIONS[ '720p' ], | |
00aa1f0d C |
295 | '1080p': CONFIG.TRANSCODING.RESOLUTIONS[ '1080p' ], |
296 | '2160p': CONFIG.TRANSCODING.RESOLUTIONS[ '2160p' ] | |
09209296 C |
297 | }, |
298 | hls: { | |
299 | enabled: CONFIG.TRANSCODING.HLS.ENABLED | |
fd206f0b | 300 | } |
5d08a6a7 C |
301 | }, |
302 | import: { | |
303 | videos: { | |
304 | http: { | |
305 | enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED | |
a84b8fa5 C |
306 | }, |
307 | torrent: { | |
308 | enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED | |
5d08a6a7 C |
309 | } |
310 | } | |
7ccddd7b JM |
311 | }, |
312 | autoBlacklist: { | |
313 | videos: { | |
314 | ofUsers: { | |
315 | enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED | |
316 | } | |
317 | } | |
5b9c965d C |
318 | }, |
319 | followers: { | |
320 | instance: { | |
14893eb7 C |
321 | enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED, |
322 | manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL | |
5b9c965d | 323 | } |
8424c402 C |
324 | }, |
325 | followings: { | |
326 | instance: { | |
327 | autoFollowBack: { | |
328 | enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED | |
329 | }, | |
330 | ||
331 | autoFollowIndex: { | |
332 | enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED, | |
333 | indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL | |
334 | } | |
335 | } | |
fd206f0b C |
336 | } |
337 | } | |
338 | } | |
a4101923 C |
339 | |
340 | function convertCustomConfigBody (body: CustomConfig) { | |
341 | function keyConverter (k: string) { | |
342 | // Transcoding resolutions exception | |
343 | if (/^\d{3,4}p$/.exec(k)) return k | |
344 | ||
345 | return snakeCase(k) | |
346 | } | |
347 | ||
348 | function valueConverter (v: any) { | |
349 | if (isNumeric(v + '')) return parseInt('' + v, 10) | |
350 | ||
351 | return v | |
352 | } | |
353 | ||
354 | return objectConverter(body, keyConverter, valueConverter) | |
355 | } | |
66170ca8 C |
356 | |
357 | function getRegisteredThemes () { | |
358 | return PluginManager.Instance.getRegisteredThemes() | |
359 | .map(t => ({ | |
360 | name: t.name, | |
361 | version: t.version, | |
362 | description: t.description, | |
363 | css: t.css, | |
364 | clientScripts: t.clientScripts | |
365 | })) | |
366 | } | |
367 | ||
368 | function getEnabledResolutions () { | |
369 | return Object.keys(CONFIG.TRANSCODING.RESOLUTIONS) | |
370 | .filter(key => CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.RESOLUTIONS[ key ] === true) | |
371 | .map(r => parseInt(r, 10)) | |
372 | } | |
373 | ||
374 | function getRegisteredPlugins () { | |
375 | return PluginManager.Instance.getRegisteredPlugins() | |
376 | .map(p => ({ | |
377 | name: p.name, | |
378 | version: p.version, | |
379 | description: p.description, | |
380 | clientScripts: p.clientScripts | |
381 | })) | |
382 | } |