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