]>
Commit | Line | Data |
---|---|---|
1 | import { getServerCommit } from '@server/helpers/utils' | |
2 | import { CONFIG, isEmailEnabled } from '@server/initializers/config' | |
3 | import { CONSTRAINTS_FIELDS, DEFAULT_THEME_NAME, PEERTUBE_VERSION } from '@server/initializers/constants' | |
4 | import { isSignupAllowed, isSignupAllowedForCurrentIP } from '@server/lib/signup' | |
5 | import { ActorCustomPageModel } from '@server/models/account/actor-custom-page' | |
6 | import { HTMLServerConfig, RegisteredExternalAuthConfig, RegisteredIdAndPassAuthConfig, ServerConfig } from '@shared/models' | |
7 | import { Hooks } from './plugins/hooks' | |
8 | import { PluginManager } from './plugins/plugin-manager' | |
9 | import { getThemeOrDefault } from './plugins/theme-utils' | |
10 | import { VideoTranscodingProfilesManager } from './transcoding/video-transcoding-profiles' | |
11 | ||
12 | /** | |
13 | * | |
14 | * Used to send the server config to clients (using REST/API or plugins API) | |
15 | * We need a singleton class to manage config state depending on external events (to build menu entries etc) | |
16 | * | |
17 | */ | |
18 | ||
19 | class ServerConfigManager { | |
20 | ||
21 | private static instance: ServerConfigManager | |
22 | ||
23 | private serverCommit: string | |
24 | ||
25 | private homepageEnabled = false | |
26 | ||
27 | private constructor () {} | |
28 | ||
29 | async init () { | |
30 | const instanceHomepage = await ActorCustomPageModel.loadInstanceHomepage() | |
31 | ||
32 | this.updateHomepageState(instanceHomepage?.content) | |
33 | } | |
34 | ||
35 | updateHomepageState (content: string) { | |
36 | this.homepageEnabled = !!content | |
37 | } | |
38 | ||
39 | async getHTMLServerConfig (): Promise<HTMLServerConfig> { | |
40 | if (this.serverCommit === undefined) this.serverCommit = await getServerCommit() | |
41 | ||
42 | const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME) | |
43 | ||
44 | return { | |
45 | client: { | |
46 | videos: { | |
47 | miniature: { | |
48 | preferAuthorDisplayName: CONFIG.CLIENT.VIDEOS.MINIATURE.PREFER_AUTHOR_DISPLAY_NAME | |
49 | } | |
50 | }, | |
51 | menu: { | |
52 | login: { | |
53 | redirectOnSingleExternalAuth: CONFIG.CLIENT.MENU.LOGIN.REDIRECT_ON_SINGLE_EXTERNAL_AUTH | |
54 | } | |
55 | } | |
56 | }, | |
57 | ||
58 | defaults: { | |
59 | publish: { | |
60 | downloadEnabled: CONFIG.DEFAULTS.PUBLISH.DOWNLOAD_ENABLED, | |
61 | commentsEnabled: CONFIG.DEFAULTS.PUBLISH.COMMENTS_ENABLED, | |
62 | privacy: CONFIG.DEFAULTS.PUBLISH.PRIVACY, | |
63 | licence: CONFIG.DEFAULTS.PUBLISH.LICENCE | |
64 | }, | |
65 | p2p: { | |
66 | enabled: CONFIG.DEFAULTS.P2P.ENABLED | |
67 | } | |
68 | }, | |
69 | ||
70 | webadmin: { | |
71 | configuration: { | |
72 | edition: { | |
73 | allowed: CONFIG.WEBADMIN.CONFIGURATION.EDITION.ALLOWED | |
74 | } | |
75 | } | |
76 | }, | |
77 | ||
78 | instance: { | |
79 | name: CONFIG.INSTANCE.NAME, | |
80 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, | |
81 | isNSFW: CONFIG.INSTANCE.IS_NSFW, | |
82 | defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, | |
83 | defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE, | |
84 | customizations: { | |
85 | javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT, | |
86 | css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS | |
87 | } | |
88 | }, | |
89 | search: { | |
90 | remoteUri: { | |
91 | users: CONFIG.SEARCH.REMOTE_URI.USERS, | |
92 | anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS | |
93 | }, | |
94 | searchIndex: { | |
95 | enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED, | |
96 | url: CONFIG.SEARCH.SEARCH_INDEX.URL, | |
97 | disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH, | |
98 | isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH | |
99 | } | |
100 | }, | |
101 | plugin: { | |
102 | registered: this.getRegisteredPlugins(), | |
103 | registeredExternalAuths: this.getExternalAuthsPlugins(), | |
104 | registeredIdAndPassAuths: this.getIdAndPassAuthPlugins() | |
105 | }, | |
106 | theme: { | |
107 | registered: this.getRegisteredThemes(), | |
108 | default: defaultTheme | |
109 | }, | |
110 | email: { | |
111 | enabled: isEmailEnabled() | |
112 | }, | |
113 | contactForm: { | |
114 | enabled: CONFIG.CONTACT_FORM.ENABLED | |
115 | }, | |
116 | serverVersion: PEERTUBE_VERSION, | |
117 | serverCommit: this.serverCommit, | |
118 | transcoding: { | |
119 | hls: { | |
120 | enabled: CONFIG.TRANSCODING.HLS.ENABLED | |
121 | }, | |
122 | webtorrent: { | |
123 | enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED | |
124 | }, | |
125 | enabledResolutions: this.getEnabledResolutions('vod'), | |
126 | profile: CONFIG.TRANSCODING.PROFILE, | |
127 | availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('vod') | |
128 | }, | |
129 | live: { | |
130 | enabled: CONFIG.LIVE.ENABLED, | |
131 | ||
132 | allowReplay: CONFIG.LIVE.ALLOW_REPLAY, | |
133 | maxDuration: CONFIG.LIVE.MAX_DURATION, | |
134 | maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES, | |
135 | maxUserLives: CONFIG.LIVE.MAX_USER_LIVES, | |
136 | ||
137 | transcoding: { | |
138 | enabled: CONFIG.LIVE.TRANSCODING.ENABLED, | |
139 | enabledResolutions: this.getEnabledResolutions('live'), | |
140 | profile: CONFIG.LIVE.TRANSCODING.PROFILE, | |
141 | availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('live') | |
142 | }, | |
143 | ||
144 | rtmp: { | |
145 | port: CONFIG.LIVE.RTMP.PORT | |
146 | } | |
147 | }, | |
148 | import: { | |
149 | videos: { | |
150 | http: { | |
151 | enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED | |
152 | }, | |
153 | torrent: { | |
154 | enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED | |
155 | } | |
156 | } | |
157 | }, | |
158 | autoBlacklist: { | |
159 | videos: { | |
160 | ofUsers: { | |
161 | enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED | |
162 | } | |
163 | } | |
164 | }, | |
165 | avatar: { | |
166 | file: { | |
167 | size: { | |
168 | max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max | |
169 | }, | |
170 | extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME | |
171 | } | |
172 | }, | |
173 | banner: { | |
174 | file: { | |
175 | size: { | |
176 | max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max | |
177 | }, | |
178 | extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME | |
179 | } | |
180 | }, | |
181 | video: { | |
182 | image: { | |
183 | extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME, | |
184 | size: { | |
185 | max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max | |
186 | } | |
187 | }, | |
188 | file: { | |
189 | extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME | |
190 | } | |
191 | }, | |
192 | videoCaption: { | |
193 | file: { | |
194 | size: { | |
195 | max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max | |
196 | }, | |
197 | extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME | |
198 | } | |
199 | }, | |
200 | user: { | |
201 | videoQuota: CONFIG.USER.VIDEO_QUOTA, | |
202 | videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY | |
203 | }, | |
204 | videoChannels: { | |
205 | maxPerUser: CONFIG.VIDEO_CHANNELS.MAX_PER_USER | |
206 | }, | |
207 | trending: { | |
208 | videos: { | |
209 | intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS, | |
210 | algorithms: { | |
211 | enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED, | |
212 | default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT | |
213 | } | |
214 | } | |
215 | }, | |
216 | tracker: { | |
217 | enabled: CONFIG.TRACKER.ENABLED | |
218 | }, | |
219 | ||
220 | followings: { | |
221 | instance: { | |
222 | autoFollowIndex: { | |
223 | indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL | |
224 | } | |
225 | } | |
226 | }, | |
227 | ||
228 | broadcastMessage: { | |
229 | enabled: CONFIG.BROADCAST_MESSAGE.ENABLED, | |
230 | message: CONFIG.BROADCAST_MESSAGE.MESSAGE, | |
231 | level: CONFIG.BROADCAST_MESSAGE.LEVEL, | |
232 | dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE | |
233 | }, | |
234 | ||
235 | homepage: { | |
236 | enabled: this.homepageEnabled | |
237 | } | |
238 | } | |
239 | } | |
240 | ||
241 | async getServerConfig (ip?: string): Promise<ServerConfig> { | |
242 | const { allowed } = await Hooks.wrapPromiseFun( | |
243 | isSignupAllowed, | |
244 | { | |
245 | ip | |
246 | }, | |
247 | 'filter:api.user.signup.allowed.result' | |
248 | ) | |
249 | ||
250 | const allowedForCurrentIP = isSignupAllowedForCurrentIP(ip) | |
251 | ||
252 | const signup = { | |
253 | allowed, | |
254 | allowedForCurrentIP, | |
255 | minimumAge: CONFIG.SIGNUP.MINIMUM_AGE, | |
256 | requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION | |
257 | } | |
258 | ||
259 | const htmlConfig = await this.getHTMLServerConfig() | |
260 | ||
261 | return { ...htmlConfig, signup } | |
262 | } | |
263 | ||
264 | getRegisteredThemes () { | |
265 | return PluginManager.Instance.getRegisteredThemes() | |
266 | .map(t => ({ | |
267 | name: t.name, | |
268 | version: t.version, | |
269 | description: t.description, | |
270 | css: t.css, | |
271 | clientScripts: t.clientScripts | |
272 | })) | |
273 | } | |
274 | ||
275 | getRegisteredPlugins () { | |
276 | return PluginManager.Instance.getRegisteredPlugins() | |
277 | .map(p => ({ | |
278 | name: p.name, | |
279 | version: p.version, | |
280 | description: p.description, | |
281 | clientScripts: p.clientScripts | |
282 | })) | |
283 | } | |
284 | ||
285 | getEnabledResolutions (type: 'vod' | 'live') { | |
286 | const transcoding = type === 'vod' | |
287 | ? CONFIG.TRANSCODING | |
288 | : CONFIG.LIVE.TRANSCODING | |
289 | ||
290 | return Object.keys(transcoding.RESOLUTIONS) | |
291 | .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true) | |
292 | .map(r => parseInt(r, 10)) | |
293 | } | |
294 | ||
295 | private getIdAndPassAuthPlugins () { | |
296 | const result: RegisteredIdAndPassAuthConfig[] = [] | |
297 | ||
298 | for (const p of PluginManager.Instance.getIdAndPassAuths()) { | |
299 | for (const auth of p.idAndPassAuths) { | |
300 | result.push({ | |
301 | npmName: p.npmName, | |
302 | name: p.name, | |
303 | version: p.version, | |
304 | authName: auth.authName, | |
305 | weight: auth.getWeight() | |
306 | }) | |
307 | } | |
308 | } | |
309 | ||
310 | return result | |
311 | } | |
312 | ||
313 | private getExternalAuthsPlugins () { | |
314 | const result: RegisteredExternalAuthConfig[] = [] | |
315 | ||
316 | for (const p of PluginManager.Instance.getExternalAuths()) { | |
317 | for (const auth of p.externalAuths) { | |
318 | result.push({ | |
319 | npmName: p.npmName, | |
320 | name: p.name, | |
321 | version: p.version, | |
322 | authName: auth.authName, | |
323 | authDisplayName: auth.authDisplayName() | |
324 | }) | |
325 | } | |
326 | } | |
327 | ||
328 | return result | |
329 | } | |
330 | ||
331 | static get Instance () { | |
332 | return this.instance || (this.instance = new this()) | |
333 | } | |
334 | } | |
335 | ||
336 | // --------------------------------------------------------------------------- | |
337 | ||
338 | export { | |
339 | ServerConfigManager | |
340 | } |