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