]>
Commit | Line | Data |
---|---|---|
1 | import express from 'express' | |
2 | import { remove, writeJSON } from 'fs-extra' | |
3 | import { snakeCase } from 'lodash' | |
4 | import validator from 'validator' | |
5 | import { ServerConfigManager } from '@server/lib/server-config-manager' | |
6 | import { About, CustomConfig, UserRight } from '@shared/models' | |
7 | import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger' | |
8 | import { objectConverter } from '../../helpers/core-utils' | |
9 | import { CONFIG, reloadConfig } from '../../initializers/config' | |
10 | import { ClientHtml } from '../../lib/client-html' | |
11 | import { asyncMiddleware, authenticate, ensureUserHasRight, openapiOperationDoc } from '../../middlewares' | |
12 | import { customConfigUpdateValidator, ensureConfigIsEditable } from '../../middlewares/validators/config' | |
13 | ||
14 | const configRouter = express.Router() | |
15 | ||
16 | const auditLogger = auditLoggerFactory('config') | |
17 | ||
18 | configRouter.get('/', | |
19 | openapiOperationDoc({ operationId: 'getConfig' }), | |
20 | asyncMiddleware(getConfig) | |
21 | ) | |
22 | ||
23 | configRouter.get('/about', | |
24 | openapiOperationDoc({ operationId: 'getAbout' }), | |
25 | getAbout | |
26 | ) | |
27 | ||
28 | configRouter.get('/custom', | |
29 | openapiOperationDoc({ operationId: 'getCustomConfig' }), | |
30 | authenticate, | |
31 | ensureUserHasRight(UserRight.MANAGE_CONFIGURATION), | |
32 | getCustomConfig | |
33 | ) | |
34 | ||
35 | configRouter.put('/custom', | |
36 | openapiOperationDoc({ operationId: 'putCustomConfig' }), | |
37 | authenticate, | |
38 | ensureUserHasRight(UserRight.MANAGE_CONFIGURATION), | |
39 | ensureConfigIsEditable, | |
40 | customConfigUpdateValidator, | |
41 | asyncMiddleware(updateCustomConfig) | |
42 | ) | |
43 | ||
44 | configRouter.delete('/custom', | |
45 | openapiOperationDoc({ operationId: 'delCustomConfig' }), | |
46 | authenticate, | |
47 | ensureUserHasRight(UserRight.MANAGE_CONFIGURATION), | |
48 | ensureConfigIsEditable, | |
49 | asyncMiddleware(deleteCustomConfig) | |
50 | ) | |
51 | ||
52 | async function getConfig (req: express.Request, res: express.Response) { | |
53 | const json = await ServerConfigManager.Instance.getServerConfig(req.ip) | |
54 | ||
55 | return res.json(json) | |
56 | } | |
57 | ||
58 | function getAbout (req: express.Request, res: express.Response) { | |
59 | const about: About = { | |
60 | instance: { | |
61 | name: CONFIG.INSTANCE.NAME, | |
62 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, | |
63 | description: CONFIG.INSTANCE.DESCRIPTION, | |
64 | terms: CONFIG.INSTANCE.TERMS, | |
65 | codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT, | |
66 | ||
67 | hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION, | |
68 | ||
69 | creationReason: CONFIG.INSTANCE.CREATION_REASON, | |
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 | |
77 | } | |
78 | } | |
79 | ||
80 | return res.json(about) | |
81 | } | |
82 | ||
83 | function getCustomConfig (req: express.Request, res: express.Response) { | |
84 | const data = customConfig() | |
85 | ||
86 | return res.json(data) | |
87 | } | |
88 | ||
89 | async function deleteCustomConfig (req: express.Request, res: express.Response) { | |
90 | await remove(CONFIG.CUSTOM_FILE) | |
91 | ||
92 | auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig())) | |
93 | ||
94 | reloadConfig() | |
95 | ClientHtml.invalidCache() | |
96 | ||
97 | const data = customConfig() | |
98 | ||
99 | return res.json(data) | |
100 | } | |
101 | ||
102 | async function updateCustomConfig (req: express.Request, res: express.Response) { | |
103 | const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig()) | |
104 | ||
105 | // camelCase to snake_case key + Force number conversion | |
106 | const toUpdateJSON = convertCustomConfigBody(req.body) | |
107 | ||
108 | await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 }) | |
109 | ||
110 | reloadConfig() | |
111 | ClientHtml.invalidCache() | |
112 | ||
113 | const data = customConfig() | |
114 | ||
115 | auditLogger.update( | |
116 | getAuditIdFromRes(res), | |
117 | new CustomConfigAuditView(data), | |
118 | oldCustomConfigAuditKeys | |
119 | ) | |
120 | ||
121 | return res.json(data) | |
122 | } | |
123 | ||
124 | // --------------------------------------------------------------------------- | |
125 | ||
126 | export { | |
127 | configRouter | |
128 | } | |
129 | ||
130 | // --------------------------------------------------------------------------- | |
131 | ||
132 | function customConfig (): CustomConfig { | |
133 | return { | |
134 | instance: { | |
135 | name: CONFIG.INSTANCE.NAME, | |
136 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, | |
137 | description: CONFIG.INSTANCE.DESCRIPTION, | |
138 | terms: CONFIG.INSTANCE.TERMS, | |
139 | codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT, | |
140 | ||
141 | creationReason: CONFIG.INSTANCE.CREATION_REASON, | |
142 | moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION, | |
143 | administrator: CONFIG.INSTANCE.ADMINISTRATOR, | |
144 | maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME, | |
145 | businessModel: CONFIG.INSTANCE.BUSINESS_MODEL, | |
146 | hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION, | |
147 | ||
148 | languages: CONFIG.INSTANCE.LANGUAGES, | |
149 | categories: CONFIG.INSTANCE.CATEGORIES, | |
150 | ||
151 | isNSFW: CONFIG.INSTANCE.IS_NSFW, | |
152 | defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, | |
153 | ||
154 | defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE, | |
155 | ||
156 | customizations: { | |
157 | css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS, | |
158 | javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT | |
159 | } | |
160 | }, | |
161 | theme: { | |
162 | default: CONFIG.THEME.DEFAULT | |
163 | }, | |
164 | services: { | |
165 | twitter: { | |
166 | username: CONFIG.SERVICES.TWITTER.USERNAME, | |
167 | whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED | |
168 | } | |
169 | }, | |
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 | }, | |
182 | cache: { | |
183 | previews: { | |
184 | size: CONFIG.CACHE.PREVIEWS.SIZE | |
185 | }, | |
186 | captions: { | |
187 | size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE | |
188 | }, | |
189 | torrents: { | |
190 | size: CONFIG.CACHE.TORRENTS.SIZE | |
191 | } | |
192 | }, | |
193 | signup: { | |
194 | enabled: CONFIG.SIGNUP.ENABLED, | |
195 | limit: CONFIG.SIGNUP.LIMIT, | |
196 | requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION, | |
197 | minimumAge: CONFIG.SIGNUP.MINIMUM_AGE | |
198 | }, | |
199 | admin: { | |
200 | email: CONFIG.ADMIN.EMAIL | |
201 | }, | |
202 | contactForm: { | |
203 | enabled: CONFIG.CONTACT_FORM.ENABLED | |
204 | }, | |
205 | user: { | |
206 | videoQuota: CONFIG.USER.VIDEO_QUOTA, | |
207 | videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY | |
208 | }, | |
209 | videoChannels: { | |
210 | maxPerUser: CONFIG.VIDEO_CHANNELS.MAX_PER_USER | |
211 | }, | |
212 | transcoding: { | |
213 | enabled: CONFIG.TRANSCODING.ENABLED, | |
214 | allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS, | |
215 | allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES, | |
216 | threads: CONFIG.TRANSCODING.THREADS, | |
217 | concurrency: CONFIG.TRANSCODING.CONCURRENCY, | |
218 | profile: CONFIG.TRANSCODING.PROFILE, | |
219 | resolutions: { | |
220 | '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'], | |
221 | '144p': CONFIG.TRANSCODING.RESOLUTIONS['144p'], | |
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'], | |
227 | '1440p': CONFIG.TRANSCODING.RESOLUTIONS['1440p'], | |
228 | '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p'] | |
229 | }, | |
230 | webtorrent: { | |
231 | enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED | |
232 | }, | |
233 | hls: { | |
234 | enabled: CONFIG.TRANSCODING.HLS.ENABLED | |
235 | } | |
236 | }, | |
237 | live: { | |
238 | enabled: CONFIG.LIVE.ENABLED, | |
239 | allowReplay: CONFIG.LIVE.ALLOW_REPLAY, | |
240 | latencySetting: { | |
241 | enabled: CONFIG.LIVE.LATENCY_SETTING.ENABLED | |
242 | }, | |
243 | maxDuration: CONFIG.LIVE.MAX_DURATION, | |
244 | maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES, | |
245 | maxUserLives: CONFIG.LIVE.MAX_USER_LIVES, | |
246 | transcoding: { | |
247 | enabled: CONFIG.LIVE.TRANSCODING.ENABLED, | |
248 | threads: CONFIG.LIVE.TRANSCODING.THREADS, | |
249 | profile: CONFIG.LIVE.TRANSCODING.PROFILE, | |
250 | resolutions: { | |
251 | '144p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['144p'], | |
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'], | |
257 | '1440p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1440p'], | |
258 | '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p'] | |
259 | } | |
260 | } | |
261 | }, | |
262 | videoStudio: { | |
263 | enabled: CONFIG.VIDEO_STUDIO.ENABLED | |
264 | }, | |
265 | import: { | |
266 | videos: { | |
267 | concurrency: CONFIG.IMPORT.VIDEOS.CONCURRENCY, | |
268 | http: { | |
269 | enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED | |
270 | }, | |
271 | torrent: { | |
272 | enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED | |
273 | } | |
274 | } | |
275 | }, | |
276 | trending: { | |
277 | videos: { | |
278 | algorithms: { | |
279 | enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED, | |
280 | default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT | |
281 | } | |
282 | } | |
283 | }, | |
284 | autoBlacklist: { | |
285 | videos: { | |
286 | ofUsers: { | |
287 | enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED | |
288 | } | |
289 | } | |
290 | }, | |
291 | followers: { | |
292 | instance: { | |
293 | enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED, | |
294 | manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL | |
295 | } | |
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 | } | |
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 | |
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 | } | |
326 | } | |
327 | } | |
328 | } | |
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 | |
334 | if (k === '0p') return k | |
335 | ||
336 | return snakeCase(k) | |
337 | } | |
338 | ||
339 | function valueConverter (v: any) { | |
340 | if (validator.isNumeric(v + '')) return parseInt('' + v, 10) | |
341 | ||
342 | return v | |
343 | } | |
344 | ||
345 | return objectConverter(body, keyConverter, valueConverter) | |
346 | } |