]>
Commit | Line | Data |
---|---|---|
2b36e477 | 1 | /* eslint-disable @typescript-eslint/no-implied-eval */ |
72f611ca | 2 | import * as debug from 'debug' |
1378c0d3 | 3 | import { firstValueFrom, ReplaySubject } from 'rxjs' |
72f611ca | 4 | import { first, shareReplay } from 'rxjs/operators' |
5 | import { RegisterClientHelpers } from 'src/types/register-client-option.model' | |
6 | import { getHookType, internalRunHook } from '@shared/core-utils/plugins/hooks' | |
7 | import { | |
8 | ClientHookName, | |
9 | clientHookObject, | |
c7cdac44 | 10 | ClientScriptJSON, |
72f611ca | 11 | HTMLServerConfig, |
12 | PluginClientScope, | |
13 | PluginType, | |
14 | RegisterClientFormFieldOptions, | |
15 | RegisterClientHookOptions, | |
d63e6d46 C |
16 | RegisterClientRouteOptions, |
17 | RegisterClientSettingsScriptOptions, | |
72f611ca | 18 | RegisterClientVideoFieldOptions, |
0bc53e20 | 19 | RegisteredExternalAuthConfig, |
72f611ca | 20 | ServerConfigPlugin |
c7cdac44 | 21 | } from '@shared/models' |
72f611ca | 22 | import { environment } from '../environments/environment' |
c7cdac44 | 23 | import { ClientScript } from '../types' |
42b40636 | 24 | import { logger } from './logger' |
72f611ca | 25 | |
26 | interface HookStructValue extends RegisterClientHookOptions { | |
27 | plugin: ServerConfigPlugin | |
c7cdac44 | 28 | clientScript: ClientScriptJSON |
72f611ca | 29 | } |
30 | ||
31 | type Hooks = { [ name: string ]: HookStructValue[] } | |
32 | ||
33 | type PluginInfo = { | |
34 | plugin: ServerConfigPlugin | |
c7cdac44 | 35 | clientScript: ClientScriptJSON |
72f611ca | 36 | pluginType: PluginType |
37 | isTheme: boolean | |
38 | } | |
39 | ||
40 | type PeertubeHelpersFactory = (pluginInfo: PluginInfo) => RegisterClientHelpers | |
fb3c9e2b C |
41 | |
42 | type OnFormFields = ( | |
43 | pluginInfo: PluginInfo, | |
44 | options: RegisterClientFormFieldOptions, | |
45 | videoFormOptions: RegisterClientVideoFieldOptions | |
46 | ) => void | |
47 | ||
d63e6d46 | 48 | type OnSettingsScripts = (pluginInfo: PluginInfo, options: RegisterClientSettingsScriptOptions) => void |
fb3c9e2b | 49 | |
d63e6d46 | 50 | type OnClientRoute = (options: RegisterClientRouteOptions) => void |
72f611ca | 51 | |
42b40636 | 52 | const debugLogger = debug('peertube:plugins') |
72f611ca | 53 | |
54 | class PluginsManager { | |
55 | private hooks: Hooks = {} | |
56 | ||
57 | private scopes: { [ scopeName: string ]: PluginInfo[] } = {} | |
58 | ||
59 | private loadedScripts: { [ script: string ]: boolean } = {} | |
60 | private loadedScopes: PluginClientScope[] = [] | |
61 | private loadingScopes: { [id in PluginClientScope]?: boolean } = {} | |
62 | ||
63 | private pluginsLoaded: { [ scope in PluginClientScope ]: ReplaySubject<boolean> } = { | |
64 | common: new ReplaySubject<boolean>(1), | |
65 | 'admin-plugin': new ReplaySubject<boolean>(1), | |
66 | search: new ReplaySubject<boolean>(1), | |
67 | 'video-watch': new ReplaySubject<boolean>(1), | |
68 | signup: new ReplaySubject<boolean>(1), | |
69 | login: new ReplaySubject<boolean>(1), | |
70 | 'video-edit': new ReplaySubject<boolean>(1), | |
f8b4a71d | 71 | embed: new ReplaySubject<boolean>(1), |
72 | 'my-library': new ReplaySubject<boolean>(1) | |
72f611ca | 73 | } |
74 | ||
75 | private readonly peertubeHelpersFactory: PeertubeHelpersFactory | |
76 | private readonly onFormFields: OnFormFields | |
77 | private readonly onSettingsScripts: OnSettingsScripts | |
d63e6d46 | 78 | private readonly onClientRoute: OnClientRoute |
72f611ca | 79 | |
80 | constructor (options: { | |
81 | peertubeHelpersFactory: PeertubeHelpersFactory | |
82 | onFormFields?: OnFormFields | |
83 | onSettingsScripts?: OnSettingsScripts | |
d63e6d46 | 84 | onClientRoute?: OnClientRoute |
72f611ca | 85 | }) { |
86 | this.peertubeHelpersFactory = options.peertubeHelpersFactory | |
87 | this.onFormFields = options.onFormFields | |
88 | this.onSettingsScripts = options.onSettingsScripts | |
d63e6d46 | 89 | this.onClientRoute = options.onClientRoute |
72f611ca | 90 | } |
91 | ||
92 | static getPluginPathPrefix (isTheme: boolean) { | |
93 | return isTheme ? '/themes' : '/plugins' | |
94 | } | |
95 | ||
0bc53e20 C |
96 | static getExternalAuthHref (auth: RegisteredExternalAuthConfig) { |
97 | return environment.apiUrl + `/plugins/${auth.name}/${auth.version}/auth/${auth.authName}` | |
98 | ||
99 | } | |
100 | ||
72f611ca | 101 | loadPluginsList (config: HTMLServerConfig) { |
102 | for (const plugin of config.plugin.registered) { | |
103 | this.addPlugin(plugin) | |
104 | } | |
105 | } | |
106 | ||
107 | async runHook<T> (hookName: ClientHookName, result?: T, params?: any) { | |
108 | if (!this.hooks[hookName]) return result | |
109 | ||
110 | const hookType = getHookType(hookName) | |
111 | ||
112 | for (const hook of this.hooks[hookName]) { | |
42b40636 | 113 | logger.info(`Running hook ${hookName} of plugin ${hook.plugin.name}`) |
72f611ca | 114 | |
22df69fd C |
115 | result = await internalRunHook({ |
116 | handler: hook.handler, | |
117 | hookType, | |
118 | result, | |
119 | params, | |
120 | onError: err => { | |
121 | logger.error(`Cannot run hook ${hookName} of script ${hook.clientScript.script} of plugin ${hook.plugin.name}`, err) | |
122 | } | |
72f611ca | 123 | }) |
124 | } | |
125 | ||
126 | return result | |
127 | } | |
128 | ||
129 | ensurePluginsAreLoaded (scope: PluginClientScope) { | |
130 | this.loadPluginsByScope(scope) | |
131 | ||
1378c0d3 | 132 | const obs = this.pluginsLoaded[scope].asObservable() |
72f611ca | 133 | .pipe(first(), shareReplay()) |
1378c0d3 C |
134 | |
135 | return firstValueFrom(obs) | |
72f611ca | 136 | } |
137 | ||
138 | async reloadLoadedScopes () { | |
139 | for (const scope of this.loadedScopes) { | |
140 | await this.loadPluginsByScope(scope, true) | |
141 | } | |
142 | } | |
143 | ||
144 | addPlugin (plugin: ServerConfigPlugin, isTheme = false) { | |
145 | const pathPrefix = PluginsManager.getPluginPathPrefix(isTheme) | |
146 | ||
147 | for (const key of Object.keys(plugin.clientScripts)) { | |
148 | const clientScript = plugin.clientScripts[key] | |
149 | ||
150 | for (const scope of clientScript.scopes) { | |
151 | if (!this.scopes[scope]) this.scopes[scope] = [] | |
152 | ||
153 | this.scopes[scope].push({ | |
154 | plugin, | |
155 | clientScript: { | |
156 | script: `${pathPrefix}/${plugin.name}/${plugin.version}/client-scripts/${clientScript.script}`, | |
157 | scopes: clientScript.scopes | |
158 | }, | |
159 | pluginType: isTheme ? PluginType.THEME : PluginType.PLUGIN, | |
160 | isTheme | |
161 | }) | |
162 | ||
163 | this.loadedScripts[clientScript.script] = false | |
164 | } | |
165 | } | |
166 | } | |
167 | ||
168 | removePlugin (plugin: ServerConfigPlugin) { | |
169 | for (const key of Object.keys(this.scopes)) { | |
170 | this.scopes[key] = this.scopes[key].filter(o => o.plugin.name !== plugin.name) | |
171 | } | |
172 | } | |
173 | ||
174 | async loadPluginsByScope (scope: PluginClientScope, isReload = false) { | |
175 | if (this.loadingScopes[scope]) return | |
176 | if (!isReload && this.loadedScopes.includes(scope)) return | |
177 | ||
178 | this.loadingScopes[scope] = true | |
179 | ||
42b40636 | 180 | debugLogger('Loading scope %s', scope) |
72f611ca | 181 | |
182 | try { | |
183 | if (!isReload) this.loadedScopes.push(scope) | |
184 | ||
9df52d66 | 185 | const toLoad = this.scopes[scope] |
72f611ca | 186 | if (!Array.isArray(toLoad)) { |
187 | this.loadingScopes[scope] = false | |
188 | this.pluginsLoaded[scope].next(true) | |
189 | ||
42b40636 | 190 | debugLogger('Nothing to load for scope %s', scope) |
72f611ca | 191 | return |
192 | } | |
193 | ||
194 | const promises: Promise<any>[] = [] | |
195 | for (const pluginInfo of toLoad) { | |
196 | const clientScript = pluginInfo.clientScript | |
197 | ||
9df52d66 | 198 | if (this.loadedScripts[clientScript.script]) continue |
72f611ca | 199 | |
200 | promises.push(this.loadPlugin(pluginInfo)) | |
201 | ||
9df52d66 | 202 | this.loadedScripts[clientScript.script] = true |
72f611ca | 203 | } |
204 | ||
205 | await Promise.all(promises) | |
206 | ||
207 | this.pluginsLoaded[scope].next(true) | |
208 | this.loadingScopes[scope] = false | |
209 | ||
42b40636 | 210 | debugLogger('Scope %s loaded', scope) |
72f611ca | 211 | } catch (err) { |
42b40636 | 212 | logger.error(`Cannot load plugins by scope ${scope}`, err) |
72f611ca | 213 | } |
214 | } | |
215 | ||
216 | private loadPlugin (pluginInfo: PluginInfo) { | |
217 | const { plugin, clientScript } = pluginInfo | |
218 | ||
219 | const registerHook = (options: RegisterClientHookOptions) => { | |
220 | if (clientHookObject[options.target] !== true) { | |
42b40636 | 221 | logger.error(`Unknown hook ${options.target} of plugin ${plugin.name}. Skipping.`) |
72f611ca | 222 | return |
223 | } | |
224 | ||
225 | if (!this.hooks[options.target]) this.hooks[options.target] = [] | |
226 | ||
227 | this.hooks[options.target].push({ | |
228 | plugin, | |
229 | clientScript, | |
230 | target: options.target, | |
231 | handler: options.handler, | |
232 | priority: options.priority || 0 | |
233 | }) | |
234 | } | |
235 | ||
236 | const registerVideoField = (commonOptions: RegisterClientFormFieldOptions, videoFormOptions: RegisterClientVideoFieldOptions) => { | |
237 | if (!this.onFormFields) { | |
238 | throw new Error('Video field registration is not supported') | |
239 | } | |
240 | ||
fb3c9e2b | 241 | return this.onFormFields(pluginInfo, commonOptions, videoFormOptions) |
72f611ca | 242 | } |
243 | ||
d63e6d46 | 244 | const registerSettingsScript = (options: RegisterClientSettingsScriptOptions) => { |
72f611ca | 245 | if (!this.onSettingsScripts) { |
246 | throw new Error('Registering settings script is not supported') | |
247 | } | |
248 | ||
249 | return this.onSettingsScripts(pluginInfo, options) | |
250 | } | |
251 | ||
d63e6d46 C |
252 | const registerClientRoute = (options: RegisterClientRouteOptions) => { |
253 | if (!this.onClientRoute) { | |
254 | throw new Error('Registering client route is not supported') | |
255 | } | |
256 | ||
257 | return this.onClientRoute(options) | |
258 | } | |
259 | ||
72f611ca | 260 | const peertubeHelpers = this.peertubeHelpersFactory(pluginInfo) |
261 | ||
42b40636 | 262 | logger.info(`Loading script ${clientScript.script} of plugin ${plugin.name}`) |
72f611ca | 263 | |
264 | const absURL = (environment.apiUrl || window.location.origin) + clientScript.script | |
2b36e477 | 265 | return dynamicImport(absURL) |
c7cdac44 | 266 | .then((script: ClientScript) => { |
d63e6d46 C |
267 | return script.register({ |
268 | registerHook, | |
269 | registerVideoField, | |
270 | registerSettingsScript, | |
271 | registerClientRoute, | |
272 | peertubeHelpers | |
273 | }) | |
274 | }) | |
72f611ca | 275 | .then(() => this.sortHooksByPriority()) |
42b40636 | 276 | .catch(err => logger.error(`Cannot import or register plugin ${pluginInfo.plugin.name}`, err)) |
72f611ca | 277 | } |
278 | ||
279 | private sortHooksByPriority () { | |
280 | for (const hookName of Object.keys(this.hooks)) { | |
281 | this.hooks[hookName].sort((a, b) => { | |
282 | return b.priority - a.priority | |
283 | }) | |
284 | } | |
285 | } | |
286 | } | |
287 | ||
288 | export { | |
289 | PluginsManager, | |
290 | ||
291 | PluginInfo, | |
292 | PeertubeHelpersFactory, | |
293 | OnFormFields, | |
294 | OnSettingsScripts | |
295 | } | |
2b36e477 C |
296 | |
297 | // --------------------------------------------------------------------------- | |
298 | ||
299 | async function dynamicImport (url: string) { | |
300 | try { | |
301 | // eslint-disable-next-line no-new-func | |
302 | return new Function(`return import('${url}')`)() | |
303 | } catch { | |
42b40636 | 304 | logger.info('Fallback to import polyfill') |
2b36e477 C |
305 | |
306 | return new Promise((resolve, reject) => { | |
307 | const vector = '$importModule$' + Math.random().toString(32).slice(2) | |
308 | const script = document.createElement('script') | |
309 | ||
310 | const destructor = () => { | |
311 | delete window[vector] | |
312 | script.onerror = null | |
313 | script.onload = null | |
314 | script.remove() | |
315 | URL.revokeObjectURL(script.src) | |
316 | script.src = '' | |
317 | } | |
318 | ||
319 | script.defer = true | |
320 | script.type = 'module' | |
321 | ||
322 | script.onerror = () => { | |
323 | reject(new Error(`Failed to import: ${url}`)) | |
324 | destructor() | |
325 | } | |
326 | script.onload = () => { | |
327 | resolve(window[vector]) | |
328 | destructor() | |
329 | } | |
330 | const loader = `import * as m from "${url}"; window.${vector} = m;` // export Module | |
331 | const blob = new Blob([ loader ], { type: 'text/javascript' }) | |
332 | script.src = URL.createObjectURL(blob) | |
333 | ||
334 | document.head.appendChild(script) | |
335 | }) | |
336 | } | |
337 | } |