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