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