]>
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 C |
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 { | |
7399a79f | 45 | client: { |
46 | videos: { | |
47 | miniature: { | |
80dea8f4 | 48 | preferAuthorDisplayName: CONFIG.CLIENT.VIDEOS.MINIATURE.PREFER_AUTHOR_DISPLAY_NAME |
7399a79f | 49 | } |
50 | } | |
51 | }, | |
cf0c8ee5 C |
52 | |
53 | webadmin: { | |
54 | configuration: { | |
55 | edition: { | |
56 | allowed: CONFIG.WEBADMIN.CONFIGURATION.EDITION.ALLOWED | |
57 | } | |
58 | } | |
59 | }, | |
60 | ||
2539932e C |
61 | instance: { |
62 | name: CONFIG.INSTANCE.NAME, | |
63 | shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION, | |
64 | isNSFW: CONFIG.INSTANCE.IS_NSFW, | |
65 | defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, | |
66 | defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE, | |
67 | customizations: { | |
68 | javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT, | |
69 | css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS | |
70 | } | |
71 | }, | |
72 | search: { | |
73 | remoteUri: { | |
74 | users: CONFIG.SEARCH.REMOTE_URI.USERS, | |
75 | anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS | |
76 | }, | |
77 | searchIndex: { | |
78 | enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED, | |
79 | url: CONFIG.SEARCH.SEARCH_INDEX.URL, | |
80 | disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH, | |
81 | isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH | |
82 | } | |
83 | }, | |
84 | plugin: { | |
85 | registered: this.getRegisteredPlugins(), | |
86 | registeredExternalAuths: this.getExternalAuthsPlugins(), | |
87 | registeredIdAndPassAuths: this.getIdAndPassAuthPlugins() | |
88 | }, | |
89 | theme: { | |
90 | registered: this.getRegisteredThemes(), | |
91 | default: defaultTheme | |
92 | }, | |
93 | email: { | |
94 | enabled: isEmailEnabled() | |
95 | }, | |
96 | contactForm: { | |
97 | enabled: CONFIG.CONTACT_FORM.ENABLED | |
98 | }, | |
99 | serverVersion: PEERTUBE_VERSION, | |
100 | serverCommit: this.serverCommit, | |
101 | transcoding: { | |
102 | hls: { | |
103 | enabled: CONFIG.TRANSCODING.HLS.ENABLED | |
104 | }, | |
105 | webtorrent: { | |
106 | enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED | |
107 | }, | |
108 | enabledResolutions: this.getEnabledResolutions('vod'), | |
109 | profile: CONFIG.TRANSCODING.PROFILE, | |
110 | availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('vod') | |
111 | }, | |
112 | live: { | |
113 | enabled: CONFIG.LIVE.ENABLED, | |
114 | ||
115 | allowReplay: CONFIG.LIVE.ALLOW_REPLAY, | |
116 | maxDuration: CONFIG.LIVE.MAX_DURATION, | |
117 | maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES, | |
118 | maxUserLives: CONFIG.LIVE.MAX_USER_LIVES, | |
119 | ||
120 | transcoding: { | |
121 | enabled: CONFIG.LIVE.TRANSCODING.ENABLED, | |
122 | enabledResolutions: this.getEnabledResolutions('live'), | |
123 | profile: CONFIG.LIVE.TRANSCODING.PROFILE, | |
124 | availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('live') | |
125 | }, | |
126 | ||
127 | rtmp: { | |
128 | port: CONFIG.LIVE.RTMP.PORT | |
129 | } | |
130 | }, | |
131 | import: { | |
132 | videos: { | |
133 | http: { | |
134 | enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED | |
135 | }, | |
136 | torrent: { | |
137 | enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED | |
138 | } | |
139 | } | |
140 | }, | |
141 | autoBlacklist: { | |
142 | videos: { | |
143 | ofUsers: { | |
144 | enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED | |
145 | } | |
146 | } | |
147 | }, | |
148 | avatar: { | |
149 | file: { | |
150 | size: { | |
151 | max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max | |
152 | }, | |
153 | extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME | |
154 | } | |
155 | }, | |
156 | banner: { | |
157 | file: { | |
158 | size: { | |
159 | max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max | |
160 | }, | |
161 | extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME | |
162 | } | |
163 | }, | |
164 | video: { | |
165 | image: { | |
166 | extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME, | |
167 | size: { | |
168 | max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max | |
169 | } | |
170 | }, | |
171 | file: { | |
172 | extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME | |
173 | } | |
174 | }, | |
175 | videoCaption: { | |
176 | file: { | |
177 | size: { | |
178 | max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max | |
179 | }, | |
180 | extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME | |
181 | } | |
182 | }, | |
183 | user: { | |
184 | videoQuota: CONFIG.USER.VIDEO_QUOTA, | |
185 | videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY | |
186 | }, | |
754b6f5f FC |
187 | videoChannels: { |
188 | maxPerUser: CONFIG.VIDEO_CHANNELS.MAX_PER_USER | |
189 | }, | |
2539932e C |
190 | trending: { |
191 | videos: { | |
192 | intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS, | |
193 | algorithms: { | |
194 | enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED, | |
195 | default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT | |
196 | } | |
197 | } | |
198 | }, | |
199 | tracker: { | |
200 | enabled: CONFIG.TRACKER.ENABLED | |
201 | }, | |
202 | ||
203 | followings: { | |
204 | instance: { | |
205 | autoFollowIndex: { | |
206 | indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL | |
207 | } | |
208 | } | |
209 | }, | |
210 | ||
211 | broadcastMessage: { | |
212 | enabled: CONFIG.BROADCAST_MESSAGE.ENABLED, | |
213 | message: CONFIG.BROADCAST_MESSAGE.MESSAGE, | |
214 | level: CONFIG.BROADCAST_MESSAGE.LEVEL, | |
215 | dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE | |
216 | }, | |
217 | ||
218 | homepage: { | |
219 | enabled: this.homepageEnabled | |
220 | } | |
221 | } | |
222 | } | |
223 | ||
224 | async getServerConfig (ip?: string): Promise<ServerConfig> { | |
225 | const { allowed } = await Hooks.wrapPromiseFun( | |
226 | isSignupAllowed, | |
227 | { | |
228 | ip | |
229 | }, | |
230 | 'filter:api.user.signup.allowed.result' | |
231 | ) | |
232 | ||
233 | const allowedForCurrentIP = isSignupAllowedForCurrentIP(ip) | |
234 | ||
235 | const signup = { | |
236 | allowed, | |
237 | allowedForCurrentIP, | |
1f256e7d | 238 | minimumAge: CONFIG.SIGNUP.MINIMUM_AGE, |
2539932e C |
239 | requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION |
240 | } | |
241 | ||
242 | const htmlConfig = await this.getHTMLServerConfig() | |
243 | ||
244 | return { ...htmlConfig, signup } | |
245 | } | |
246 | ||
247 | getRegisteredThemes () { | |
248 | return PluginManager.Instance.getRegisteredThemes() | |
249 | .map(t => ({ | |
250 | name: t.name, | |
251 | version: t.version, | |
252 | description: t.description, | |
253 | css: t.css, | |
254 | clientScripts: t.clientScripts | |
255 | })) | |
256 | } | |
257 | ||
258 | getRegisteredPlugins () { | |
259 | return PluginManager.Instance.getRegisteredPlugins() | |
260 | .map(p => ({ | |
261 | name: p.name, | |
262 | version: p.version, | |
263 | description: p.description, | |
264 | clientScripts: p.clientScripts | |
265 | })) | |
266 | } | |
267 | ||
268 | getEnabledResolutions (type: 'vod' | 'live') { | |
269 | const transcoding = type === 'vod' | |
270 | ? CONFIG.TRANSCODING | |
271 | : CONFIG.LIVE.TRANSCODING | |
272 | ||
273 | return Object.keys(transcoding.RESOLUTIONS) | |
274 | .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true) | |
275 | .map(r => parseInt(r, 10)) | |
276 | } | |
277 | ||
278 | private getIdAndPassAuthPlugins () { | |
279 | const result: RegisteredIdAndPassAuthConfig[] = [] | |
280 | ||
281 | for (const p of PluginManager.Instance.getIdAndPassAuths()) { | |
282 | for (const auth of p.idAndPassAuths) { | |
283 | result.push({ | |
284 | npmName: p.npmName, | |
285 | name: p.name, | |
286 | version: p.version, | |
287 | authName: auth.authName, | |
288 | weight: auth.getWeight() | |
289 | }) | |
290 | } | |
291 | } | |
292 | ||
293 | return result | |
294 | } | |
295 | ||
296 | private getExternalAuthsPlugins () { | |
297 | const result: RegisteredExternalAuthConfig[] = [] | |
298 | ||
299 | for (const p of PluginManager.Instance.getExternalAuths()) { | |
300 | for (const auth of p.externalAuths) { | |
301 | result.push({ | |
302 | npmName: p.npmName, | |
303 | name: p.name, | |
304 | version: p.version, | |
305 | authName: auth.authName, | |
306 | authDisplayName: auth.authDisplayName() | |
307 | }) | |
308 | } | |
309 | } | |
310 | ||
311 | return result | |
312 | } | |
313 | ||
314 | static get Instance () { | |
315 | return this.instance || (this.instance = new this()) | |
316 | } | |
317 | } | |
318 | ||
319 | // --------------------------------------------------------------------------- | |
320 | ||
321 | export { | |
322 | ServerConfigManager | |
323 | } |