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