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