]>
Commit | Line | Data |
---|---|---|
41fb13c3 | 1 | import express from 'express' |
4a8d113b | 2 | import { remove, writeJSON } from 'fs-extra' |
09209296 | 3 | import { snakeCase } from 'lodash' |
4a8d113b | 4 | import validator from 'validator' |
4c7e60bc | 5 | import { ServerConfigManager } from '@server/lib/server-config-manager' |
d17c7b4e | 6 | import { About, CustomConfig, UserRight } from '@shared/models' |
993cef4b | 7 | import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger' |
a4101923 | 8 | import { objectConverter } from '../../helpers/core-utils' |
22820226 | 9 | import { CONFIG, reloadConfig } from '../../initializers/config' |
4a8d113b | 10 | import { ClientHtml } from '../../lib/client-html' |
1333ab1f | 11 | import { asyncMiddleware, authenticate, ensureUserHasRight, openapiOperationDoc } from '../../middlewares' |
8d8a037e | 12 | import { customConfigUpdateValidator, ensureConfigIsEditable } from '../../middlewares/validators/config' |
65fcc311 C |
13 | |
14 | const configRouter = express.Router() | |
15 | ||
80e36cd9 AB |
16 | const auditLogger = auditLoggerFactory('config') |
17 | ||
eb080476 | 18 | configRouter.get('/', |
1333ab1f | 19 | openapiOperationDoc({ operationId: 'getConfig' }), |
eb080476 C |
20 | asyncMiddleware(getConfig) |
21 | ) | |
36f9424f | 22 | |
1333ab1f RK |
23 | configRouter.get('/about', |
24 | openapiOperationDoc({ operationId: 'getAbout' }), | |
25 | getAbout | |
26 | ) | |
27 | ||
fd206f0b | 28 | configRouter.get('/custom', |
1333ab1f | 29 | openapiOperationDoc({ operationId: 'getCustomConfig' }), |
fd206f0b C |
30 | authenticate, |
31 | ensureUserHasRight(UserRight.MANAGE_CONFIGURATION), | |
a1587156 | 32 | getCustomConfig |
fd206f0b | 33 | ) |
c158a5fa | 34 | |
fd206f0b | 35 | configRouter.put('/custom', |
1333ab1f | 36 | openapiOperationDoc({ operationId: 'putCustomConfig' }), |
fd206f0b C |
37 | authenticate, |
38 | ensureUserHasRight(UserRight.MANAGE_CONFIGURATION), | |
8d8a037e | 39 | ensureConfigIsEditable, |
a1587156 | 40 | customConfigUpdateValidator, |
fd206f0b C |
41 | asyncMiddleware(updateCustomConfig) |
42 | ) | |
c158a5fa | 43 | |
fd206f0b | 44 | configRouter.delete('/custom', |
1333ab1f | 45 | openapiOperationDoc({ operationId: 'delCustomConfig' }), |
fd206f0b C |
46 | authenticate, |
47 | ensureUserHasRight(UserRight.MANAGE_CONFIGURATION), | |
8d8a037e | 48 | ensureConfigIsEditable, |
fd206f0b C |
49 | asyncMiddleware(deleteCustomConfig) |
50 | ) | |
65fcc311 | 51 | |
1b5e2d72 | 52 | async function getConfig (req: express.Request, res: express.Response) { |
2539932e | 53 | const json = await ServerConfigManager.Instance.getServerConfig(req.ip) |
6a84aafd | 54 | |
eb080476 | 55 | return res.json(json) |
65fcc311 C |
56 | } |
57 | ||
f8802489 | 58 | function getAbout (req: express.Request, res: express.Response) { |
36f9424f C |
59 | const about: About = { |
60 | instance: { | |
61 | name: CONFIG.INSTANCE.NAME, | |
2e3a0215 | 62 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, |
36f9424f | 63 | description: CONFIG.INSTANCE.DESCRIPTION, |
ccc00cb2 C |
64 | terms: CONFIG.INSTANCE.TERMS, |
65 | codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT, | |
66 | ||
be04c6fd C |
67 | hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION, |
68 | ||
8ae03c37 | 69 | creationReason: CONFIG.INSTANCE.CREATION_REASON, |
ccc00cb2 C |
70 | moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION, |
71 | administrator: CONFIG.INSTANCE.ADMINISTRATOR, | |
72 | maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME, | |
73 | businessModel: CONFIG.INSTANCE.BUSINESS_MODEL, | |
74 | ||
75 | languages: CONFIG.INSTANCE.LANGUAGES, | |
76 | categories: CONFIG.INSTANCE.CATEGORIES | |
36f9424f C |
77 | } |
78 | } | |
79 | ||
c158a5fa | 80 | return res.json(about) |
36f9424f C |
81 | } |
82 | ||
a1587156 | 83 | function getCustomConfig (req: express.Request, res: express.Response) { |
fd206f0b C |
84 | const data = customConfig() |
85 | ||
c158a5fa | 86 | return res.json(data) |
fd206f0b C |
87 | } |
88 | ||
f8802489 | 89 | async function deleteCustomConfig (req: express.Request, res: express.Response) { |
62689b94 | 90 | await remove(CONFIG.CUSTOM_FILE) |
fd206f0b | 91 | |
993cef4b | 92 | auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig())) |
80e36cd9 | 93 | |
fd206f0b | 94 | reloadConfig() |
e032aec9 | 95 | ClientHtml.invalidCache() |
fd206f0b C |
96 | |
97 | const data = customConfig() | |
98 | ||
c6c0fa6c | 99 | return res.json(data) |
fd206f0b C |
100 | } |
101 | ||
f8802489 | 102 | async function updateCustomConfig (req: express.Request, res: express.Response) { |
80e36cd9 | 103 | const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig()) |
fd206f0b | 104 | |
a4101923 C |
105 | // camelCase to snake_case key + Force number conversion |
106 | const toUpdateJSON = convertCustomConfigBody(req.body) | |
fd206f0b | 107 | |
62689b94 | 108 | await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 }) |
fd206f0b C |
109 | |
110 | reloadConfig() | |
e032aec9 | 111 | ClientHtml.invalidCache() |
fd206f0b C |
112 | |
113 | const data = customConfig() | |
80e36cd9 AB |
114 | |
115 | auditLogger.update( | |
993cef4b | 116 | getAuditIdFromRes(res), |
80e36cd9 AB |
117 | new CustomConfigAuditView(data), |
118 | oldCustomConfigAuditKeys | |
119 | ) | |
120 | ||
c6c0fa6c | 121 | return res.json(data) |
fd206f0b C |
122 | } |
123 | ||
65fcc311 C |
124 | // --------------------------------------------------------------------------- |
125 | ||
126 | export { | |
22820226 | 127 | configRouter |
65fcc311 | 128 | } |
fd206f0b C |
129 | |
130 | // --------------------------------------------------------------------------- | |
131 | ||
132 | function customConfig (): CustomConfig { | |
133 | return { | |
66b16caf C |
134 | instance: { |
135 | name: CONFIG.INSTANCE.NAME, | |
2e3a0215 | 136 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, |
66b16caf | 137 | description: CONFIG.INSTANCE.DESCRIPTION, |
00b5556c | 138 | terms: CONFIG.INSTANCE.TERMS, |
ccc00cb2 C |
139 | codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT, |
140 | ||
8ae03c37 | 141 | creationReason: CONFIG.INSTANCE.CREATION_REASON, |
ccc00cb2 C |
142 | moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION, |
143 | administrator: CONFIG.INSTANCE.ADMINISTRATOR, | |
144 | maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME, | |
145 | businessModel: CONFIG.INSTANCE.BUSINESS_MODEL, | |
be04c6fd | 146 | hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION, |
ccc00cb2 C |
147 | |
148 | languages: CONFIG.INSTANCE.LANGUAGES, | |
149 | categories: CONFIG.INSTANCE.CATEGORIES, | |
150 | ||
f8802489 | 151 | isNSFW: CONFIG.INSTANCE.IS_NSFW, |
0883b324 | 152 | defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, |
3da68f0a RK |
153 | |
154 | defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE, | |
3da68f0a | 155 | |
00b5556c C |
156 | customizations: { |
157 | css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS, | |
158 | javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT | |
159 | } | |
66b16caf | 160 | }, |
7cd4d2ba C |
161 | theme: { |
162 | default: CONFIG.THEME.DEFAULT | |
163 | }, | |
8be1afa1 C |
164 | services: { |
165 | twitter: { | |
166 | username: CONFIG.SERVICES.TWITTER.USERNAME, | |
167 | whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED | |
168 | } | |
169 | }, | |
0bc53e20 C |
170 | client: { |
171 | videos: { | |
172 | miniature: { | |
173 | preferAuthorDisplayName: CONFIG.CLIENT.VIDEOS.MINIATURE.PREFER_AUTHOR_DISPLAY_NAME | |
174 | } | |
175 | }, | |
176 | menu: { | |
177 | login: { | |
178 | redirectOnSingleExternalAuth: CONFIG.CLIENT.MENU.LOGIN.REDIRECT_ON_SINGLE_EXTERNAL_AUTH | |
179 | } | |
180 | } | |
181 | }, | |
fd206f0b C |
182 | cache: { |
183 | previews: { | |
184 | size: CONFIG.CACHE.PREVIEWS.SIZE | |
40e87e9e C |
185 | }, |
186 | captions: { | |
187 | size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE | |
b3d5cb92 C |
188 | }, |
189 | torrents: { | |
190 | size: CONFIG.CACHE.TORRENTS.SIZE | |
fd206f0b C |
191 | } |
192 | }, | |
193 | signup: { | |
194 | enabled: CONFIG.SIGNUP.ENABLED, | |
d9eaee39 | 195 | limit: CONFIG.SIGNUP.LIMIT, |
1f256e7d P |
196 | requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION, |
197 | minimumAge: CONFIG.SIGNUP.MINIMUM_AGE | |
fd206f0b C |
198 | }, |
199 | admin: { | |
200 | email: CONFIG.ADMIN.EMAIL | |
201 | }, | |
a4101923 C |
202 | contactForm: { |
203 | enabled: CONFIG.CONTACT_FORM.ENABLED | |
204 | }, | |
fd206f0b | 205 | user: { |
bee0abff FA |
206 | videoQuota: CONFIG.USER.VIDEO_QUOTA, |
207 | videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY | |
fd206f0b | 208 | }, |
754b6f5f FC |
209 | videoChannels: { |
210 | maxPerUser: CONFIG.VIDEO_CHANNELS.MAX_PER_USER | |
211 | }, | |
fd206f0b C |
212 | transcoding: { |
213 | enabled: CONFIG.TRANSCODING.ENABLED, | |
14e2014a | 214 | allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS, |
536598cf | 215 | allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES, |
fd206f0b | 216 | threads: CONFIG.TRANSCODING.THREADS, |
9129b769 | 217 | concurrency: CONFIG.TRANSCODING.CONCURRENCY, |
1896bca0 | 218 | profile: CONFIG.TRANSCODING.PROFILE, |
fd206f0b | 219 | resolutions: { |
a1587156 | 220 | '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'], |
8dd754c7 | 221 | '144p': CONFIG.TRANSCODING.RESOLUTIONS['144p'], |
a1587156 C |
222 | '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'], |
223 | '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'], | |
224 | '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'], | |
225 | '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'], | |
226 | '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'], | |
b7085c71 | 227 | '1440p': CONFIG.TRANSCODING.RESOLUTIONS['1440p'], |
a1587156 | 228 | '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p'] |
09209296 | 229 | }, |
d7a25329 C |
230 | webtorrent: { |
231 | enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED | |
232 | }, | |
09209296 C |
233 | hls: { |
234 | enabled: CONFIG.TRANSCODING.HLS.ENABLED | |
fd206f0b | 235 | } |
5d08a6a7 | 236 | }, |
c6c0fa6c C |
237 | live: { |
238 | enabled: CONFIG.LIVE.ENABLED, | |
fb719404 | 239 | allowReplay: CONFIG.LIVE.ALLOW_REPLAY, |
f443a746 C |
240 | latencySetting: { |
241 | enabled: CONFIG.LIVE.LATENCY_SETTING.ENABLED | |
242 | }, | |
fb719404 | 243 | maxDuration: CONFIG.LIVE.MAX_DURATION, |
a056ca48 C |
244 | maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES, |
245 | maxUserLives: CONFIG.LIVE.MAX_USER_LIVES, | |
c6c0fa6c C |
246 | transcoding: { |
247 | enabled: CONFIG.LIVE.TRANSCODING.ENABLED, | |
248 | threads: CONFIG.LIVE.TRANSCODING.THREADS, | |
1896bca0 | 249 | profile: CONFIG.LIVE.TRANSCODING.PROFILE, |
c6c0fa6c | 250 | resolutions: { |
8dd754c7 | 251 | '144p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['144p'], |
c6c0fa6c C |
252 | '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'], |
253 | '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'], | |
254 | '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'], | |
255 | '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'], | |
256 | '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'], | |
b7085c71 | 257 | '1440p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1440p'], |
c6c0fa6c C |
258 | '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p'] |
259 | } | |
260 | } | |
261 | }, | |
92e66e04 C |
262 | videoStudio: { |
263 | enabled: CONFIG.VIDEO_STUDIO.ENABLED | |
c729caf6 | 264 | }, |
5d08a6a7 C |
265 | import: { |
266 | videos: { | |
9129b769 | 267 | concurrency: CONFIG.IMPORT.VIDEOS.CONCURRENCY, |
5d08a6a7 C |
268 | http: { |
269 | enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED | |
a84b8fa5 C |
270 | }, |
271 | torrent: { | |
272 | enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED | |
5d08a6a7 C |
273 | } |
274 | } | |
7ccddd7b | 275 | }, |
ba5d4a84 RK |
276 | trending: { |
277 | videos: { | |
278 | algorithms: { | |
279 | enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED, | |
280 | default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT | |
281 | } | |
282 | } | |
283 | }, | |
7ccddd7b JM |
284 | autoBlacklist: { |
285 | videos: { | |
286 | ofUsers: { | |
287 | enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED | |
288 | } | |
289 | } | |
5b9c965d C |
290 | }, |
291 | followers: { | |
292 | instance: { | |
14893eb7 C |
293 | enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED, |
294 | manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL | |
5b9c965d | 295 | } |
8424c402 C |
296 | }, |
297 | followings: { | |
298 | instance: { | |
299 | autoFollowBack: { | |
300 | enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED | |
301 | }, | |
302 | ||
303 | autoFollowIndex: { | |
304 | enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED, | |
305 | indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL | |
306 | } | |
307 | } | |
72c33e71 C |
308 | }, |
309 | broadcastMessage: { | |
310 | enabled: CONFIG.BROADCAST_MESSAGE.ENABLED, | |
311 | message: CONFIG.BROADCAST_MESSAGE.MESSAGE, | |
312 | level: CONFIG.BROADCAST_MESSAGE.LEVEL, | |
313 | dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE | |
5fb2e288 C |
314 | }, |
315 | search: { | |
316 | remoteUri: { | |
317 | users: CONFIG.SEARCH.REMOTE_URI.USERS, | |
318 | anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS | |
319 | }, | |
320 | searchIndex: { | |
321 | enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED, | |
322 | url: CONFIG.SEARCH.SEARCH_INDEX.URL, | |
323 | disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH, | |
324 | isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH | |
325 | } | |
3521ab8f | 326 | } |
fd206f0b C |
327 | } |
328 | } | |
a4101923 C |
329 | |
330 | function convertCustomConfigBody (body: CustomConfig) { | |
331 | function keyConverter (k: string) { | |
332 | // Transcoding resolutions exception | |
333 | if (/^\d{3,4}p$/.exec(k)) return k | |
3a149e9f | 334 | if (k === '0p') return k |
a4101923 C |
335 | |
336 | return snakeCase(k) | |
337 | } | |
338 | ||
339 | function valueConverter (v: any) { | |
7cde3b9c | 340 | if (validator.isNumeric(v + '')) return parseInt('' + v, 10) |
a4101923 C |
341 | |
342 | return v | |
343 | } | |
344 | ||
345 | return objectConverter(body, keyConverter, valueConverter) | |
346 | } |