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