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