]>
Commit | Line | Data |
---|---|---|
4d4e5cd4 | 1 | import * as express from 'express' |
09209296 | 2 | import { snakeCase } from 'lodash' |
fd206f0b | 3 | import { ServerConfig, UserRight } from '../../../shared' |
09cababd C |
4 | import { About } from '../../../shared/models/server/about.model' |
5 | import { CustomConfig } from '../../../shared/models/server/custom-config.model' | |
06215f15 | 6 | import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../helpers/signup' |
74dc3bca | 7 | import { CONSTRAINTS_FIELDS } from '../../initializers/constants' |
fd206f0b C |
8 | import { asyncMiddleware, authenticate, ensureUserHasRight } from '../../middlewares' |
9 | import { customConfigUpdateValidator } from '../../middlewares/validators/config' | |
e032aec9 | 10 | import { ClientHtml } from '../../lib/client-html' |
993cef4b | 11 | import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger' |
62689b94 | 12 | import { remove, writeJSON } from 'fs-extra' |
1b5e2d72 | 13 | import { getServerCommit } from '../../helpers/utils' |
3b3b1820 | 14 | import { Emailer } from '../../lib/emailer' |
a4101923 C |
15 | import { isNumeric } from 'validator' |
16 | import { objectConverter } from '../../helpers/core-utils' | |
6dd9de95 | 17 | import { CONFIG, reloadConfig } from '../../initializers/config' |
65fcc311 | 18 | |
915c5bbe | 19 | const packageJSON = require('../../../../package.json') |
65fcc311 C |
20 | const configRouter = express.Router() |
21 | ||
80e36cd9 AB |
22 | const auditLogger = auditLoggerFactory('config') |
23 | ||
36f9424f | 24 | configRouter.get('/about', getAbout) |
eb080476 C |
25 | configRouter.get('/', |
26 | asyncMiddleware(getConfig) | |
27 | ) | |
36f9424f | 28 | |
fd206f0b C |
29 | configRouter.get('/custom', |
30 | authenticate, | |
31 | ensureUserHasRight(UserRight.MANAGE_CONFIGURATION), | |
32 | asyncMiddleware(getCustomConfig) | |
33 | ) | |
34 | configRouter.put('/custom', | |
35 | authenticate, | |
36 | ensureUserHasRight(UserRight.MANAGE_CONFIGURATION), | |
37 | asyncMiddleware(customConfigUpdateValidator), | |
38 | asyncMiddleware(updateCustomConfig) | |
39 | ) | |
40 | configRouter.delete('/custom', | |
41 | authenticate, | |
42 | ensureUserHasRight(UserRight.MANAGE_CONFIGURATION), | |
43 | asyncMiddleware(deleteCustomConfig) | |
44 | ) | |
65fcc311 | 45 | |
abb2c792 | 46 | let serverCommit: string |
1b5e2d72 | 47 | async function getConfig (req: express.Request, res: express.Response) { |
eb080476 | 48 | const allowed = await isSignupAllowed() |
ff2c1fe8 | 49 | const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip) |
1b5e2d72 C |
50 | |
51 | if (serverCommit === undefined) serverCommit = await getServerCommit() | |
291e8d3e | 52 | |
eb080476 | 53 | const enabledResolutions = Object.keys(CONFIG.TRANSCODING.RESOLUTIONS) |
465679ca | 54 | .filter(key => CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.RESOLUTIONS[key] === true) |
eb080476 | 55 | .map(r => parseInt(r, 10)) |
6a84aafd | 56 | |
eb080476 | 57 | const json: ServerConfig = { |
36f9424f | 58 | instance: { |
00b5556c | 59 | name: CONFIG.INSTANCE.NAME, |
2e3a0215 | 60 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, |
901637bb | 61 | defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE, |
f8802489 | 62 | isNSFW: CONFIG.INSTANCE.IS_NSFW, |
0883b324 | 63 | defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, |
00b5556c C |
64 | customizations: { |
65 | javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT, | |
66 | css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS | |
67 | } | |
36f9424f | 68 | }, |
3b3b1820 | 69 | email: { |
d3e56c0c | 70 | enabled: Emailer.isEnabled() |
3b3b1820 | 71 | }, |
a4101923 C |
72 | contactForm: { |
73 | enabled: CONFIG.CONTACT_FORM.ENABLED | |
74 | }, | |
915c5bbe | 75 | serverVersion: packageJSON.version, |
abb2c792 | 76 | serverCommit, |
eb080476 | 77 | signup: { |
ff2c1fe8 | 78 | allowed, |
d9eaee39 JM |
79 | allowedForCurrentIP, |
80 | requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION | |
eb080476 C |
81 | }, |
82 | transcoding: { | |
09209296 C |
83 | hls: { |
84 | enabled: CONFIG.TRANSCODING.HLS.ENABLED | |
85 | }, | |
eb080476 | 86 | enabledResolutions |
01de67b9 | 87 | }, |
5d08a6a7 | 88 | import: { |
b2977eec | 89 | videos: { |
5d08a6a7 C |
90 | http: { |
91 | enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED | |
a84b8fa5 C |
92 | }, |
93 | torrent: { | |
94 | enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED | |
5d08a6a7 C |
95 | } |
96 | } | |
97 | }, | |
7ccddd7b JM |
98 | autoBlacklist: { |
99 | videos: { | |
100 | ofUsers: { | |
101 | enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED | |
102 | } | |
103 | } | |
104 | }, | |
01de67b9 C |
105 | avatar: { |
106 | file: { | |
107 | size: { | |
108 | max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max | |
109 | }, | |
110 | extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME | |
111 | } | |
112 | }, | |
113 | video: { | |
6de36768 C |
114 | image: { |
115 | extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME, | |
116 | size: { | |
117 | max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max | |
118 | } | |
119 | }, | |
01de67b9 C |
120 | file: { |
121 | extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME | |
122 | } | |
1869c875 | 123 | }, |
40e87e9e C |
124 | videoCaption: { |
125 | file: { | |
126 | size: { | |
127 | max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max | |
128 | }, | |
129 | extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME | |
130 | } | |
131 | }, | |
1869c875 | 132 | user: { |
bee0abff FA |
133 | videoQuota: CONFIG.USER.VIDEO_QUOTA, |
134 | videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY | |
9b4b15f9 AB |
135 | }, |
136 | trending: { | |
137 | videos: { | |
138 | intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS | |
139 | } | |
31b6ddf8 C |
140 | }, |
141 | tracker: { | |
142 | enabled: CONFIG.TRACKER.ENABLED | |
65fcc311 | 143 | } |
eb080476 | 144 | } |
6a84aafd | 145 | |
eb080476 | 146 | return res.json(json) |
65fcc311 C |
147 | } |
148 | ||
f8802489 | 149 | function getAbout (req: express.Request, res: express.Response) { |
36f9424f C |
150 | const about: About = { |
151 | instance: { | |
152 | name: CONFIG.INSTANCE.NAME, | |
2e3a0215 | 153 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, |
36f9424f C |
154 | description: CONFIG.INSTANCE.DESCRIPTION, |
155 | terms: CONFIG.INSTANCE.TERMS | |
156 | } | |
157 | } | |
158 | ||
159 | return res.json(about).end() | |
160 | } | |
161 | ||
f8802489 | 162 | async function getCustomConfig (req: express.Request, res: express.Response) { |
fd206f0b C |
163 | const data = customConfig() |
164 | ||
165 | return res.json(data).end() | |
166 | } | |
167 | ||
f8802489 | 168 | async function deleteCustomConfig (req: express.Request, res: express.Response) { |
62689b94 | 169 | await remove(CONFIG.CUSTOM_FILE) |
fd206f0b | 170 | |
993cef4b | 171 | auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig())) |
80e36cd9 | 172 | |
fd206f0b | 173 | reloadConfig() |
e032aec9 | 174 | ClientHtml.invalidCache() |
fd206f0b C |
175 | |
176 | const data = customConfig() | |
177 | ||
178 | return res.json(data).end() | |
179 | } | |
180 | ||
f8802489 | 181 | async function updateCustomConfig (req: express.Request, res: express.Response) { |
80e36cd9 | 182 | const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig()) |
fd206f0b | 183 | |
a4101923 C |
184 | // camelCase to snake_case key + Force number conversion |
185 | const toUpdateJSON = convertCustomConfigBody(req.body) | |
fd206f0b | 186 | |
62689b94 | 187 | await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 }) |
fd206f0b C |
188 | |
189 | reloadConfig() | |
e032aec9 | 190 | ClientHtml.invalidCache() |
fd206f0b C |
191 | |
192 | const data = customConfig() | |
80e36cd9 AB |
193 | |
194 | auditLogger.update( | |
993cef4b | 195 | getAuditIdFromRes(res), |
80e36cd9 AB |
196 | new CustomConfigAuditView(data), |
197 | oldCustomConfigAuditKeys | |
198 | ) | |
199 | ||
fd206f0b C |
200 | return res.json(data).end() |
201 | } | |
202 | ||
65fcc311 C |
203 | // --------------------------------------------------------------------------- |
204 | ||
205 | export { | |
206 | configRouter | |
207 | } | |
fd206f0b C |
208 | |
209 | // --------------------------------------------------------------------------- | |
210 | ||
211 | function customConfig (): CustomConfig { | |
212 | return { | |
66b16caf C |
213 | instance: { |
214 | name: CONFIG.INSTANCE.NAME, | |
2e3a0215 | 215 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, |
66b16caf | 216 | description: CONFIG.INSTANCE.DESCRIPTION, |
00b5556c | 217 | terms: CONFIG.INSTANCE.TERMS, |
f8802489 | 218 | isNSFW: CONFIG.INSTANCE.IS_NSFW, |
901637bb | 219 | defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE, |
0883b324 | 220 | defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, |
00b5556c C |
221 | customizations: { |
222 | css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS, | |
223 | javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT | |
224 | } | |
66b16caf | 225 | }, |
8be1afa1 C |
226 | services: { |
227 | twitter: { | |
228 | username: CONFIG.SERVICES.TWITTER.USERNAME, | |
229 | whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED | |
230 | } | |
231 | }, | |
fd206f0b C |
232 | cache: { |
233 | previews: { | |
234 | size: CONFIG.CACHE.PREVIEWS.SIZE | |
40e87e9e C |
235 | }, |
236 | captions: { | |
237 | size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE | |
fd206f0b C |
238 | } |
239 | }, | |
240 | signup: { | |
241 | enabled: CONFIG.SIGNUP.ENABLED, | |
d9eaee39 JM |
242 | limit: CONFIG.SIGNUP.LIMIT, |
243 | requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION | |
fd206f0b C |
244 | }, |
245 | admin: { | |
246 | email: CONFIG.ADMIN.EMAIL | |
247 | }, | |
a4101923 C |
248 | contactForm: { |
249 | enabled: CONFIG.CONTACT_FORM.ENABLED | |
250 | }, | |
fd206f0b | 251 | user: { |
bee0abff FA |
252 | videoQuota: CONFIG.USER.VIDEO_QUOTA, |
253 | videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY | |
fd206f0b C |
254 | }, |
255 | transcoding: { | |
256 | enabled: CONFIG.TRANSCODING.ENABLED, | |
14e2014a | 257 | allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS, |
536598cf | 258 | allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES, |
fd206f0b C |
259 | threads: CONFIG.TRANSCODING.THREADS, |
260 | resolutions: { | |
261 | '240p': CONFIG.TRANSCODING.RESOLUTIONS[ '240p' ], | |
262 | '360p': CONFIG.TRANSCODING.RESOLUTIONS[ '360p' ], | |
263 | '480p': CONFIG.TRANSCODING.RESOLUTIONS[ '480p' ], | |
264 | '720p': CONFIG.TRANSCODING.RESOLUTIONS[ '720p' ], | |
265 | '1080p': CONFIG.TRANSCODING.RESOLUTIONS[ '1080p' ] | |
09209296 C |
266 | }, |
267 | hls: { | |
268 | enabled: CONFIG.TRANSCODING.HLS.ENABLED | |
fd206f0b | 269 | } |
5d08a6a7 C |
270 | }, |
271 | import: { | |
272 | videos: { | |
273 | http: { | |
274 | enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED | |
a84b8fa5 C |
275 | }, |
276 | torrent: { | |
277 | enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED | |
5d08a6a7 C |
278 | } |
279 | } | |
7ccddd7b JM |
280 | }, |
281 | autoBlacklist: { | |
282 | videos: { | |
283 | ofUsers: { | |
284 | enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED | |
285 | } | |
286 | } | |
5b9c965d C |
287 | }, |
288 | followers: { | |
289 | instance: { | |
14893eb7 C |
290 | enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED, |
291 | manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL | |
5b9c965d | 292 | } |
fd206f0b C |
293 | } |
294 | } | |
295 | } | |
a4101923 C |
296 | |
297 | function convertCustomConfigBody (body: CustomConfig) { | |
298 | function keyConverter (k: string) { | |
299 | // Transcoding resolutions exception | |
300 | if (/^\d{3,4}p$/.exec(k)) return k | |
301 | ||
302 | return snakeCase(k) | |
303 | } | |
304 | ||
305 | function valueConverter (v: any) { | |
306 | if (isNumeric(v + '')) return parseInt('' + v, 10) | |
307 | ||
308 | return v | |
309 | } | |
310 | ||
311 | return objectConverter(body, keyConverter, valueConverter) | |
312 | } |