]>
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 { Emailer } from '../../lib/emailer' | |
15 | import { isNumeric } from 'validator' | |
16 | import { objectConverter } from '../../helpers/core-utils' | |
17 | import { CONFIG, reloadConfig } from '../../initializers/config' | |
18 | import { PluginManager } from '../../lib/plugins/plugin-manager' | |
19 | import { getThemeOrDefault } from '../../lib/plugins/theme-utils' | |
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 | 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 | ) | |
46 | ||
47 | let serverCommit: string | |
48 | ||
49 | async function getConfig (req: express.Request, res: express.Response) { | |
50 | const allowed = await isSignupAllowed() | |
51 | const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip) | |
52 | const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME) | |
53 | ||
54 | if (serverCommit === undefined) serverCommit = await getServerCommit() | |
55 | ||
56 | const json: ServerConfig = { | |
57 | instance: { | |
58 | name: CONFIG.INSTANCE.NAME, | |
59 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, | |
60 | defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE, | |
61 | isNSFW: CONFIG.INSTANCE.IS_NSFW, | |
62 | defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, | |
63 | customizations: { | |
64 | javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT, | |
65 | css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS | |
66 | } | |
67 | }, | |
68 | plugin: { | |
69 | registered: getRegisteredPlugins() | |
70 | }, | |
71 | theme: { | |
72 | registered: getRegisteredThemes(), | |
73 | default: defaultTheme | |
74 | }, | |
75 | email: { | |
76 | enabled: Emailer.isEnabled() | |
77 | }, | |
78 | contactForm: { | |
79 | enabled: CONFIG.CONTACT_FORM.ENABLED | |
80 | }, | |
81 | serverVersion: PEERTUBE_VERSION, | |
82 | serverCommit, | |
83 | signup: { | |
84 | allowed, | |
85 | allowedForCurrentIP, | |
86 | requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION | |
87 | }, | |
88 | transcoding: { | |
89 | hls: { | |
90 | enabled: CONFIG.TRANSCODING.HLS.ENABLED | |
91 | }, | |
92 | enabledResolutions: getEnabledResolutions() | |
93 | }, | |
94 | import: { | |
95 | videos: { | |
96 | http: { | |
97 | enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED | |
98 | }, | |
99 | torrent: { | |
100 | enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED | |
101 | } | |
102 | } | |
103 | }, | |
104 | autoBlacklist: { | |
105 | videos: { | |
106 | ofUsers: { | |
107 | enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED | |
108 | } | |
109 | } | |
110 | }, | |
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: { | |
120 | image: { | |
121 | extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME, | |
122 | size: { | |
123 | max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max | |
124 | } | |
125 | }, | |
126 | file: { | |
127 | extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME | |
128 | } | |
129 | }, | |
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 | }, | |
138 | user: { | |
139 | videoQuota: CONFIG.USER.VIDEO_QUOTA, | |
140 | videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY | |
141 | }, | |
142 | trending: { | |
143 | videos: { | |
144 | intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS | |
145 | } | |
146 | }, | |
147 | tracker: { | |
148 | enabled: CONFIG.TRACKER.ENABLED | |
149 | } | |
150 | } | |
151 | ||
152 | return res.json(json) | |
153 | } | |
154 | ||
155 | function getAbout (req: express.Request, res: express.Response) { | |
156 | const about: About = { | |
157 | instance: { | |
158 | name: CONFIG.INSTANCE.NAME, | |
159 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, | |
160 | description: CONFIG.INSTANCE.DESCRIPTION, | |
161 | terms: CONFIG.INSTANCE.TERMS | |
162 | } | |
163 | } | |
164 | ||
165 | return res.json(about).end() | |
166 | } | |
167 | ||
168 | async function getCustomConfig (req: express.Request, res: express.Response) { | |
169 | const data = customConfig() | |
170 | ||
171 | return res.json(data).end() | |
172 | } | |
173 | ||
174 | async function deleteCustomConfig (req: express.Request, res: express.Response) { | |
175 | await remove(CONFIG.CUSTOM_FILE) | |
176 | ||
177 | auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig())) | |
178 | ||
179 | reloadConfig() | |
180 | ClientHtml.invalidCache() | |
181 | ||
182 | const data = customConfig() | |
183 | ||
184 | return res.json(data).end() | |
185 | } | |
186 | ||
187 | async function updateCustomConfig (req: express.Request, res: express.Response) { | |
188 | const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig()) | |
189 | ||
190 | // camelCase to snake_case key + Force number conversion | |
191 | const toUpdateJSON = convertCustomConfigBody(req.body) | |
192 | ||
193 | await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 }) | |
194 | ||
195 | reloadConfig() | |
196 | ClientHtml.invalidCache() | |
197 | ||
198 | const data = customConfig() | |
199 | ||
200 | auditLogger.update( | |
201 | getAuditIdFromRes(res), | |
202 | new CustomConfigAuditView(data), | |
203 | oldCustomConfigAuditKeys | |
204 | ) | |
205 | ||
206 | return res.json(data).end() | |
207 | } | |
208 | ||
209 | // --------------------------------------------------------------------------- | |
210 | ||
211 | export { | |
212 | configRouter | |
213 | } | |
214 | ||
215 | // --------------------------------------------------------------------------- | |
216 | ||
217 | function customConfig (): CustomConfig { | |
218 | return { | |
219 | instance: { | |
220 | name: CONFIG.INSTANCE.NAME, | |
221 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, | |
222 | description: CONFIG.INSTANCE.DESCRIPTION, | |
223 | terms: CONFIG.INSTANCE.TERMS, | |
224 | isNSFW: CONFIG.INSTANCE.IS_NSFW, | |
225 | defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE, | |
226 | defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, | |
227 | customizations: { | |
228 | css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS, | |
229 | javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT | |
230 | } | |
231 | }, | |
232 | theme: { | |
233 | default: CONFIG.THEME.DEFAULT | |
234 | }, | |
235 | services: { | |
236 | twitter: { | |
237 | username: CONFIG.SERVICES.TWITTER.USERNAME, | |
238 | whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED | |
239 | } | |
240 | }, | |
241 | cache: { | |
242 | previews: { | |
243 | size: CONFIG.CACHE.PREVIEWS.SIZE | |
244 | }, | |
245 | captions: { | |
246 | size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE | |
247 | } | |
248 | }, | |
249 | signup: { | |
250 | enabled: CONFIG.SIGNUP.ENABLED, | |
251 | limit: CONFIG.SIGNUP.LIMIT, | |
252 | requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION | |
253 | }, | |
254 | admin: { | |
255 | email: CONFIG.ADMIN.EMAIL | |
256 | }, | |
257 | contactForm: { | |
258 | enabled: CONFIG.CONTACT_FORM.ENABLED | |
259 | }, | |
260 | user: { | |
261 | videoQuota: CONFIG.USER.VIDEO_QUOTA, | |
262 | videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY | |
263 | }, | |
264 | transcoding: { | |
265 | enabled: CONFIG.TRANSCODING.ENABLED, | |
266 | allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS, | |
267 | allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES, | |
268 | threads: CONFIG.TRANSCODING.THREADS, | |
269 | resolutions: { | |
270 | '240p': CONFIG.TRANSCODING.RESOLUTIONS[ '240p' ], | |
271 | '360p': CONFIG.TRANSCODING.RESOLUTIONS[ '360p' ], | |
272 | '480p': CONFIG.TRANSCODING.RESOLUTIONS[ '480p' ], | |
273 | '720p': CONFIG.TRANSCODING.RESOLUTIONS[ '720p' ], | |
274 | '1080p': CONFIG.TRANSCODING.RESOLUTIONS[ '1080p' ], | |
275 | '2160p': CONFIG.TRANSCODING.RESOLUTIONS[ '2160p' ] | |
276 | }, | |
277 | hls: { | |
278 | enabled: CONFIG.TRANSCODING.HLS.ENABLED | |
279 | } | |
280 | }, | |
281 | import: { | |
282 | videos: { | |
283 | http: { | |
284 | enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED | |
285 | }, | |
286 | torrent: { | |
287 | enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED | |
288 | } | |
289 | } | |
290 | }, | |
291 | autoBlacklist: { | |
292 | videos: { | |
293 | ofUsers: { | |
294 | enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED | |
295 | } | |
296 | } | |
297 | }, | |
298 | followers: { | |
299 | instance: { | |
300 | enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED, | |
301 | manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL | |
302 | } | |
303 | } | |
304 | } | |
305 | } | |
306 | ||
307 | function convertCustomConfigBody (body: CustomConfig) { | |
308 | function keyConverter (k: string) { | |
309 | // Transcoding resolutions exception | |
310 | if (/^\d{3,4}p$/.exec(k)) return k | |
311 | ||
312 | return snakeCase(k) | |
313 | } | |
314 | ||
315 | function valueConverter (v: any) { | |
316 | if (isNumeric(v + '')) return parseInt('' + v, 10) | |
317 | ||
318 | return v | |
319 | } | |
320 | ||
321 | return objectConverter(body, keyConverter, valueConverter) | |
322 | } | |
323 | ||
324 | function getRegisteredThemes () { | |
325 | return PluginManager.Instance.getRegisteredThemes() | |
326 | .map(t => ({ | |
327 | name: t.name, | |
328 | version: t.version, | |
329 | description: t.description, | |
330 | css: t.css, | |
331 | clientScripts: t.clientScripts | |
332 | })) | |
333 | } | |
334 | ||
335 | function getEnabledResolutions () { | |
336 | return Object.keys(CONFIG.TRANSCODING.RESOLUTIONS) | |
337 | .filter(key => CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.RESOLUTIONS[ key ] === true) | |
338 | .map(r => parseInt(r, 10)) | |
339 | } | |
340 | ||
341 | function getRegisteredPlugins () { | |
342 | return PluginManager.Instance.getRegisteredPlugins() | |
343 | .map(p => ({ | |
344 | name: p.name, | |
345 | version: p.version, | |
346 | description: p.description, | |
347 | clientScripts: p.clientScripts | |
348 | })) | |
349 | } |