]>
Commit | Line | Data |
---|---|---|
1 | import * as express from 'express' | |
2 | import { remove, writeJSON } from 'fs-extra' | |
3 | import { snakeCase } from 'lodash' | |
4 | import validator from 'validator' | |
5 | import { getServerConfig } from '@server/lib/config' | |
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 | configRouter.get('/', | |
22 | asyncMiddleware(getConfig) | |
23 | ) | |
24 | ||
25 | configRouter.get('/custom', | |
26 | authenticate, | |
27 | ensureUserHasRight(UserRight.MANAGE_CONFIGURATION), | |
28 | getCustomConfig | |
29 | ) | |
30 | configRouter.put('/custom', | |
31 | authenticate, | |
32 | ensureUserHasRight(UserRight.MANAGE_CONFIGURATION), | |
33 | customConfigUpdateValidator, | |
34 | asyncMiddleware(updateCustomConfig) | |
35 | ) | |
36 | configRouter.delete('/custom', | |
37 | authenticate, | |
38 | ensureUserHasRight(UserRight.MANAGE_CONFIGURATION), | |
39 | asyncMiddleware(deleteCustomConfig) | |
40 | ) | |
41 | ||
42 | async function getConfig (req: express.Request, res: express.Response) { | |
43 | const json = await getServerConfig(req.ip) | |
44 | ||
45 | return res.json(json) | |
46 | } | |
47 | ||
48 | function getAbout (req: express.Request, res: express.Response) { | |
49 | const about: About = { | |
50 | instance: { | |
51 | name: CONFIG.INSTANCE.NAME, | |
52 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, | |
53 | description: CONFIG.INSTANCE.DESCRIPTION, | |
54 | terms: CONFIG.INSTANCE.TERMS, | |
55 | codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT, | |
56 | ||
57 | hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION, | |
58 | ||
59 | creationReason: CONFIG.INSTANCE.CREATION_REASON, | |
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 | |
67 | } | |
68 | } | |
69 | ||
70 | return res.json(about).end() | |
71 | } | |
72 | ||
73 | function getCustomConfig (req: express.Request, res: express.Response) { | |
74 | const data = customConfig() | |
75 | ||
76 | return res.json(data).end() | |
77 | } | |
78 | ||
79 | async function deleteCustomConfig (req: express.Request, res: express.Response) { | |
80 | await remove(CONFIG.CUSTOM_FILE) | |
81 | ||
82 | auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig())) | |
83 | ||
84 | reloadConfig() | |
85 | ClientHtml.invalidCache() | |
86 | ||
87 | const data = customConfig() | |
88 | ||
89 | return res.json(data) | |
90 | } | |
91 | ||
92 | async function updateCustomConfig (req: express.Request, res: express.Response) { | |
93 | const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig()) | |
94 | ||
95 | // camelCase to snake_case key + Force number conversion | |
96 | const toUpdateJSON = convertCustomConfigBody(req.body) | |
97 | ||
98 | await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 }) | |
99 | ||
100 | reloadConfig() | |
101 | ClientHtml.invalidCache() | |
102 | ||
103 | const data = customConfig() | |
104 | ||
105 | auditLogger.update( | |
106 | getAuditIdFromRes(res), | |
107 | new CustomConfigAuditView(data), | |
108 | oldCustomConfigAuditKeys | |
109 | ) | |
110 | ||
111 | return res.json(data) | |
112 | } | |
113 | ||
114 | // --------------------------------------------------------------------------- | |
115 | ||
116 | export { | |
117 | configRouter | |
118 | } | |
119 | ||
120 | // --------------------------------------------------------------------------- | |
121 | ||
122 | function customConfig (): CustomConfig { | |
123 | return { | |
124 | instance: { | |
125 | name: CONFIG.INSTANCE.NAME, | |
126 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, | |
127 | description: CONFIG.INSTANCE.DESCRIPTION, | |
128 | terms: CONFIG.INSTANCE.TERMS, | |
129 | codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT, | |
130 | ||
131 | creationReason: CONFIG.INSTANCE.CREATION_REASON, | |
132 | moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION, | |
133 | administrator: CONFIG.INSTANCE.ADMINISTRATOR, | |
134 | maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME, | |
135 | businessModel: CONFIG.INSTANCE.BUSINESS_MODEL, | |
136 | hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION, | |
137 | ||
138 | languages: CONFIG.INSTANCE.LANGUAGES, | |
139 | categories: CONFIG.INSTANCE.CATEGORIES, | |
140 | ||
141 | isNSFW: CONFIG.INSTANCE.IS_NSFW, | |
142 | defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, | |
143 | ||
144 | defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE, | |
145 | ||
146 | customizations: { | |
147 | css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS, | |
148 | javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT | |
149 | } | |
150 | }, | |
151 | theme: { | |
152 | default: CONFIG.THEME.DEFAULT | |
153 | }, | |
154 | services: { | |
155 | twitter: { | |
156 | username: CONFIG.SERVICES.TWITTER.USERNAME, | |
157 | whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED | |
158 | } | |
159 | }, | |
160 | cache: { | |
161 | previews: { | |
162 | size: CONFIG.CACHE.PREVIEWS.SIZE | |
163 | }, | |
164 | captions: { | |
165 | size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE | |
166 | }, | |
167 | torrents: { | |
168 | size: CONFIG.CACHE.TORRENTS.SIZE | |
169 | } | |
170 | }, | |
171 | signup: { | |
172 | enabled: CONFIG.SIGNUP.ENABLED, | |
173 | limit: CONFIG.SIGNUP.LIMIT, | |
174 | requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION | |
175 | }, | |
176 | admin: { | |
177 | email: CONFIG.ADMIN.EMAIL | |
178 | }, | |
179 | contactForm: { | |
180 | enabled: CONFIG.CONTACT_FORM.ENABLED | |
181 | }, | |
182 | user: { | |
183 | videoQuota: CONFIG.USER.VIDEO_QUOTA, | |
184 | videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY | |
185 | }, | |
186 | transcoding: { | |
187 | enabled: CONFIG.TRANSCODING.ENABLED, | |
188 | allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS, | |
189 | allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES, | |
190 | threads: CONFIG.TRANSCODING.THREADS, | |
191 | concurrency: CONFIG.TRANSCODING.CONCURRENCY, | |
192 | profile: CONFIG.TRANSCODING.PROFILE, | |
193 | resolutions: { | |
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'], | |
200 | '1440p': CONFIG.TRANSCODING.RESOLUTIONS['1440p'], | |
201 | '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p'] | |
202 | }, | |
203 | webtorrent: { | |
204 | enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED | |
205 | }, | |
206 | hls: { | |
207 | enabled: CONFIG.TRANSCODING.HLS.ENABLED | |
208 | } | |
209 | }, | |
210 | live: { | |
211 | enabled: CONFIG.LIVE.ENABLED, | |
212 | allowReplay: CONFIG.LIVE.ALLOW_REPLAY, | |
213 | maxDuration: CONFIG.LIVE.MAX_DURATION, | |
214 | maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES, | |
215 | maxUserLives: CONFIG.LIVE.MAX_USER_LIVES, | |
216 | transcoding: { | |
217 | enabled: CONFIG.LIVE.TRANSCODING.ENABLED, | |
218 | threads: CONFIG.LIVE.TRANSCODING.THREADS, | |
219 | profile: CONFIG.LIVE.TRANSCODING.PROFILE, | |
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'], | |
226 | '1440p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1440p'], | |
227 | '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p'] | |
228 | } | |
229 | } | |
230 | }, | |
231 | import: { | |
232 | videos: { | |
233 | concurrency: CONFIG.IMPORT.VIDEOS.CONCURRENCY, | |
234 | http: { | |
235 | enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED | |
236 | }, | |
237 | torrent: { | |
238 | enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED | |
239 | } | |
240 | } | |
241 | }, | |
242 | trending: { | |
243 | videos: { | |
244 | algorithms: { | |
245 | enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED, | |
246 | default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT | |
247 | } | |
248 | } | |
249 | }, | |
250 | autoBlacklist: { | |
251 | videos: { | |
252 | ofUsers: { | |
253 | enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED | |
254 | } | |
255 | } | |
256 | }, | |
257 | followers: { | |
258 | instance: { | |
259 | enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED, | |
260 | manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL | |
261 | } | |
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 | } | |
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 | |
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 | } | |
292 | } | |
293 | } | |
294 | } | |
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 | |
300 | if (k === '0p') return k | |
301 | ||
302 | return snakeCase(k) | |
303 | } | |
304 | ||
305 | function valueConverter (v: any) { | |
306 | if (validator.isNumeric(v + '')) return parseInt('' + v, 10) | |
307 | ||
308 | return v | |
309 | } | |
310 | ||
311 | return objectConverter(body, keyConverter, valueConverter) | |
312 | } |