]>
Commit | Line | Data |
---|---|---|
1 | import * as express from 'express' | |
2 | import { snakeCase } from 'lodash' | |
3 | import { ServerConfig, UserRight } from '../../../shared' | |
4 | import { About } from '../../../shared/models/server/about.model' | |
5 | import { CustomConfig } from '../../../shared/models/server/custom-config.model' | |
6 | import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../helpers/signup' | |
7 | import { CONSTRAINTS_FIELDS, DEFAULT_THEME_NAME, PEERTUBE_VERSION } from '../../initializers/constants' | |
8 | import { asyncMiddleware, authenticate, ensureUserHasRight } from '../../middlewares' | |
9 | import { customConfigUpdateValidator } from '../../middlewares/validators/config' | |
10 | import { ClientHtml } from '../../lib/client-html' | |
11 | import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger' | |
12 | import { remove, writeJSON } from 'fs-extra' | |
13 | import { getServerCommit } from '../../helpers/utils' | |
14 | import validator from 'validator' | |
15 | import { objectConverter } from '../../helpers/core-utils' | |
16 | import { CONFIG, isEmailEnabled, reloadConfig } from '../../initializers/config' | |
17 | import { PluginManager } from '../../lib/plugins/plugin-manager' | |
18 | import { getThemeOrDefault } from '../../lib/plugins/theme-utils' | |
19 | import { Hooks } from '@server/lib/plugins/hooks' | |
20 | ||
21 | const configRouter = express.Router() | |
22 | ||
23 | const auditLogger = auditLoggerFactory('config') | |
24 | ||
25 | configRouter.get('/about', getAbout) | |
26 | configRouter.get('/', | |
27 | asyncMiddleware(getConfig) | |
28 | ) | |
29 | ||
30 | configRouter.get('/custom', | |
31 | authenticate, | |
32 | ensureUserHasRight(UserRight.MANAGE_CONFIGURATION), | |
33 | getCustomConfig | |
34 | ) | |
35 | configRouter.put('/custom', | |
36 | authenticate, | |
37 | ensureUserHasRight(UserRight.MANAGE_CONFIGURATION), | |
38 | customConfigUpdateValidator, | |
39 | asyncMiddleware(updateCustomConfig) | |
40 | ) | |
41 | configRouter.delete('/custom', | |
42 | authenticate, | |
43 | ensureUserHasRight(UserRight.MANAGE_CONFIGURATION), | |
44 | asyncMiddleware(deleteCustomConfig) | |
45 | ) | |
46 | ||
47 | let serverCommit: string | |
48 | ||
49 | async function getConfig (req: express.Request, res: express.Response) { | |
50 | const { allowed } = await Hooks.wrapPromiseFun( | |
51 | isSignupAllowed, | |
52 | { | |
53 | ip: req.ip | |
54 | }, | |
55 | 'filter:api.user.signup.allowed.result' | |
56 | ) | |
57 | ||
58 | const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip) | |
59 | const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME) | |
60 | ||
61 | if (serverCommit === undefined) serverCommit = await getServerCommit() | |
62 | ||
63 | const json: ServerConfig = { | |
64 | instance: { | |
65 | name: CONFIG.INSTANCE.NAME, | |
66 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, | |
67 | defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE, | |
68 | isNSFW: CONFIG.INSTANCE.IS_NSFW, | |
69 | defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, | |
70 | customizations: { | |
71 | javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT, | |
72 | css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS | |
73 | } | |
74 | }, | |
75 | search: { | |
76 | remoteUri: { | |
77 | users: CONFIG.SEARCH.REMOTE_URI.USERS, | |
78 | anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS | |
79 | } | |
80 | }, | |
81 | plugin: { | |
82 | registered: getRegisteredPlugins() | |
83 | }, | |
84 | theme: { | |
85 | registered: getRegisteredThemes(), | |
86 | default: defaultTheme | |
87 | }, | |
88 | email: { | |
89 | enabled: isEmailEnabled() | |
90 | }, | |
91 | contactForm: { | |
92 | enabled: CONFIG.CONTACT_FORM.ENABLED | |
93 | }, | |
94 | serverVersion: PEERTUBE_VERSION, | |
95 | serverCommit, | |
96 | signup: { | |
97 | allowed, | |
98 | allowedForCurrentIP, | |
99 | requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION | |
100 | }, | |
101 | transcoding: { | |
102 | hls: { | |
103 | enabled: CONFIG.TRANSCODING.HLS.ENABLED | |
104 | }, | |
105 | webtorrent: { | |
106 | enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED | |
107 | }, | |
108 | enabledResolutions: getEnabledResolutions() | |
109 | }, | |
110 | import: { | |
111 | videos: { | |
112 | http: { | |
113 | enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED | |
114 | }, | |
115 | torrent: { | |
116 | enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED | |
117 | } | |
118 | } | |
119 | }, | |
120 | autoBlacklist: { | |
121 | videos: { | |
122 | ofUsers: { | |
123 | enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED | |
124 | } | |
125 | } | |
126 | }, | |
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: { | |
136 | image: { | |
137 | extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME, | |
138 | size: { | |
139 | max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max | |
140 | } | |
141 | }, | |
142 | file: { | |
143 | extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME | |
144 | } | |
145 | }, | |
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 | }, | |
154 | user: { | |
155 | videoQuota: CONFIG.USER.VIDEO_QUOTA, | |
156 | videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY | |
157 | }, | |
158 | trending: { | |
159 | videos: { | |
160 | intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS | |
161 | } | |
162 | }, | |
163 | tracker: { | |
164 | enabled: CONFIG.TRACKER.ENABLED | |
165 | }, | |
166 | ||
167 | followings: { | |
168 | instance: { | |
169 | autoFollowIndex: { | |
170 | indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL | |
171 | } | |
172 | } | |
173 | } | |
174 | } | |
175 | ||
176 | return res.json(json) | |
177 | } | |
178 | ||
179 | function getAbout (req: express.Request, res: express.Response) { | |
180 | const about: About = { | |
181 | instance: { | |
182 | name: CONFIG.INSTANCE.NAME, | |
183 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, | |
184 | description: CONFIG.INSTANCE.DESCRIPTION, | |
185 | terms: CONFIG.INSTANCE.TERMS, | |
186 | codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT, | |
187 | ||
188 | hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION, | |
189 | ||
190 | creationReason: CONFIG.INSTANCE.CREATION_REASON, | |
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 | |
198 | } | |
199 | } | |
200 | ||
201 | return res.json(about).end() | |
202 | } | |
203 | ||
204 | function getCustomConfig (req: express.Request, res: express.Response) { | |
205 | const data = customConfig() | |
206 | ||
207 | return res.json(data).end() | |
208 | } | |
209 | ||
210 | async function deleteCustomConfig (req: express.Request, res: express.Response) { | |
211 | await remove(CONFIG.CUSTOM_FILE) | |
212 | ||
213 | auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig())) | |
214 | ||
215 | reloadConfig() | |
216 | ClientHtml.invalidCache() | |
217 | ||
218 | const data = customConfig() | |
219 | ||
220 | return res.json(data).end() | |
221 | } | |
222 | ||
223 | async function updateCustomConfig (req: express.Request, res: express.Response) { | |
224 | const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig()) | |
225 | ||
226 | // camelCase to snake_case key + Force number conversion | |
227 | const toUpdateJSON = convertCustomConfigBody(req.body) | |
228 | ||
229 | await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 }) | |
230 | ||
231 | reloadConfig() | |
232 | ClientHtml.invalidCache() | |
233 | ||
234 | const data = customConfig() | |
235 | ||
236 | auditLogger.update( | |
237 | getAuditIdFromRes(res), | |
238 | new CustomConfigAuditView(data), | |
239 | oldCustomConfigAuditKeys | |
240 | ) | |
241 | ||
242 | return res.json(data).end() | |
243 | } | |
244 | ||
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) | |
258 | .filter(key => CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.RESOLUTIONS[key] === true) | |
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 | ||
272 | // --------------------------------------------------------------------------- | |
273 | ||
274 | export { | |
275 | configRouter, | |
276 | getEnabledResolutions, | |
277 | getRegisteredPlugins, | |
278 | getRegisteredThemes | |
279 | } | |
280 | ||
281 | // --------------------------------------------------------------------------- | |
282 | ||
283 | function customConfig (): CustomConfig { | |
284 | return { | |
285 | instance: { | |
286 | name: CONFIG.INSTANCE.NAME, | |
287 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, | |
288 | description: CONFIG.INSTANCE.DESCRIPTION, | |
289 | terms: CONFIG.INSTANCE.TERMS, | |
290 | codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT, | |
291 | ||
292 | creationReason: CONFIG.INSTANCE.CREATION_REASON, | |
293 | moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION, | |
294 | administrator: CONFIG.INSTANCE.ADMINISTRATOR, | |
295 | maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME, | |
296 | businessModel: CONFIG.INSTANCE.BUSINESS_MODEL, | |
297 | hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION, | |
298 | ||
299 | languages: CONFIG.INSTANCE.LANGUAGES, | |
300 | categories: CONFIG.INSTANCE.CATEGORIES, | |
301 | ||
302 | isNSFW: CONFIG.INSTANCE.IS_NSFW, | |
303 | defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE, | |
304 | defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, | |
305 | customizations: { | |
306 | css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS, | |
307 | javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT | |
308 | } | |
309 | }, | |
310 | theme: { | |
311 | default: CONFIG.THEME.DEFAULT | |
312 | }, | |
313 | services: { | |
314 | twitter: { | |
315 | username: CONFIG.SERVICES.TWITTER.USERNAME, | |
316 | whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED | |
317 | } | |
318 | }, | |
319 | cache: { | |
320 | previews: { | |
321 | size: CONFIG.CACHE.PREVIEWS.SIZE | |
322 | }, | |
323 | captions: { | |
324 | size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE | |
325 | } | |
326 | }, | |
327 | signup: { | |
328 | enabled: CONFIG.SIGNUP.ENABLED, | |
329 | limit: CONFIG.SIGNUP.LIMIT, | |
330 | requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION | |
331 | }, | |
332 | admin: { | |
333 | email: CONFIG.ADMIN.EMAIL | |
334 | }, | |
335 | contactForm: { | |
336 | enabled: CONFIG.CONTACT_FORM.ENABLED | |
337 | }, | |
338 | user: { | |
339 | videoQuota: CONFIG.USER.VIDEO_QUOTA, | |
340 | videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY | |
341 | }, | |
342 | transcoding: { | |
343 | enabled: CONFIG.TRANSCODING.ENABLED, | |
344 | allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS, | |
345 | allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES, | |
346 | threads: CONFIG.TRANSCODING.THREADS, | |
347 | resolutions: { | |
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'] | |
355 | }, | |
356 | webtorrent: { | |
357 | enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED | |
358 | }, | |
359 | hls: { | |
360 | enabled: CONFIG.TRANSCODING.HLS.ENABLED | |
361 | } | |
362 | }, | |
363 | import: { | |
364 | videos: { | |
365 | http: { | |
366 | enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED | |
367 | }, | |
368 | torrent: { | |
369 | enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED | |
370 | } | |
371 | } | |
372 | }, | |
373 | autoBlacklist: { | |
374 | videos: { | |
375 | ofUsers: { | |
376 | enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED | |
377 | } | |
378 | } | |
379 | }, | |
380 | followers: { | |
381 | instance: { | |
382 | enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED, | |
383 | manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL | |
384 | } | |
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 | } | |
397 | } | |
398 | } | |
399 | } | |
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 | |
405 | if (k === '0p') return k | |
406 | ||
407 | return snakeCase(k) | |
408 | } | |
409 | ||
410 | function valueConverter (v: any) { | |
411 | if (validator.isNumeric(v + '')) return parseInt('' + v, 10) | |
412 | ||
413 | return v | |
414 | } | |
415 | ||
416 | return objectConverter(body, keyConverter, valueConverter) | |
417 | } |