1 /* eslint-disable @typescript-eslint/no-implied-eval */
2 import * as debug from 'debug'
3 import { firstValueFrom, ReplaySubject } from 'rxjs'
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'
14 RegisterClientFormFieldOptions,
15 RegisterClientHookOptions,
16 RegisterClientSettingsScript,
17 RegisterClientVideoFieldOptions,
18 RegisteredExternalAuthConfig,
20 } from '../../../shared/models'
21 import { environment } from '../environments/environment'
22 import { ClientScript as ClientScriptModule } from '../types/client-script.model'
24 interface HookStructValue extends RegisterClientHookOptions {
25 plugin: ServerConfigPlugin
26 clientScript: ClientScript
29 type Hooks = { [ name: string ]: HookStructValue[] }
32 plugin: ServerConfigPlugin
33 clientScript: ClientScript
34 pluginType: PluginType
38 type PeertubeHelpersFactory = (pluginInfo: PluginInfo) => RegisterClientHelpers
39 type OnFormFields = (options: RegisterClientFormFieldOptions, videoFormOptions: RegisterClientVideoFieldOptions) => void
40 type OnSettingsScripts = (pluginInfo: PluginInfo, options: RegisterClientSettingsScript) => void
42 const logger = debug('peertube:plugins')
44 class PluginsManager {
45 private hooks: Hooks = {}
47 private scopes: { [ scopeName: string ]: PluginInfo[] } = {}
49 private loadedScripts: { [ script: string ]: boolean } = {}
50 private loadedScopes: PluginClientScope[] = []
51 private loadingScopes: { [id in PluginClientScope]?: boolean } = {}
53 private pluginsLoaded: { [ scope in PluginClientScope ]: ReplaySubject<boolean> } = {
54 common: new ReplaySubject<boolean>(1),
55 'admin-plugin': new ReplaySubject<boolean>(1),
56 search: new ReplaySubject<boolean>(1),
57 'video-watch': new ReplaySubject<boolean>(1),
58 signup: new ReplaySubject<boolean>(1),
59 login: new ReplaySubject<boolean>(1),
60 'video-edit': new ReplaySubject<boolean>(1),
61 embed: new ReplaySubject<boolean>(1)
64 private readonly peertubeHelpersFactory: PeertubeHelpersFactory
65 private readonly onFormFields: OnFormFields
66 private readonly onSettingsScripts: OnSettingsScripts
68 constructor (options: {
69 peertubeHelpersFactory: PeertubeHelpersFactory
70 onFormFields?: OnFormFields
71 onSettingsScripts?: OnSettingsScripts
73 this.peertubeHelpersFactory = options.peertubeHelpersFactory
74 this.onFormFields = options.onFormFields
75 this.onSettingsScripts = options.onSettingsScripts
78 static getPluginPathPrefix (isTheme: boolean) {
79 return isTheme ? '/themes' : '/plugins'
82 static getExternalAuthHref (auth: RegisteredExternalAuthConfig) {
83 return environment.apiUrl + `/plugins/${auth.name}/${auth.version}/auth/${auth.authName}`
87 loadPluginsList (config: HTMLServerConfig) {
88 for (const plugin of config.plugin.registered) {
89 this.addPlugin(plugin)
93 async runHook<T> (hookName: ClientHookName, result?: T, params?: any) {
94 if (!this.hooks[hookName]) return result
96 const hookType = getHookType(hookName)
98 for (const hook of this.hooks[hookName]) {
99 console.log('Running hook %s of plugin %s.', hookName, hook.plugin.name)
101 result = await internalRunHook(hook.handler, hookType, result, params, err => {
102 console.error('Cannot run hook %s of script %s of plugin %s.', hookName, hook.clientScript.script, hook.plugin.name, err)
109 ensurePluginsAreLoaded (scope: PluginClientScope) {
110 this.loadPluginsByScope(scope)
112 const obs = this.pluginsLoaded[scope].asObservable()
113 .pipe(first(), shareReplay())
115 return firstValueFrom(obs)
118 async reloadLoadedScopes () {
119 for (const scope of this.loadedScopes) {
120 await this.loadPluginsByScope(scope, true)
124 addPlugin (plugin: ServerConfigPlugin, isTheme = false) {
125 const pathPrefix = PluginsManager.getPluginPathPrefix(isTheme)
127 for (const key of Object.keys(plugin.clientScripts)) {
128 const clientScript = plugin.clientScripts[key]
130 for (const scope of clientScript.scopes) {
131 if (!this.scopes[scope]) this.scopes[scope] = []
133 this.scopes[scope].push({
136 script: `${pathPrefix}/${plugin.name}/${plugin.version}/client-scripts/${clientScript.script}`,
137 scopes: clientScript.scopes
139 pluginType: isTheme ? PluginType.THEME : PluginType.PLUGIN,
143 this.loadedScripts[clientScript.script] = false
148 removePlugin (plugin: ServerConfigPlugin) {
149 for (const key of Object.keys(this.scopes)) {
150 this.scopes[key] = this.scopes[key].filter(o => o.plugin.name !== plugin.name)
154 async loadPluginsByScope (scope: PluginClientScope, isReload = false) {
155 if (this.loadingScopes[scope]) return
156 if (!isReload && this.loadedScopes.includes(scope)) return
158 this.loadingScopes[scope] = true
160 logger('Loading scope %s', scope)
163 if (!isReload) this.loadedScopes.push(scope)
165 const toLoad = this.scopes[scope]
166 if (!Array.isArray(toLoad)) {
167 this.loadingScopes[scope] = false
168 this.pluginsLoaded[scope].next(true)
170 logger('Nothing to load for scope %s', scope)
174 const promises: Promise<any>[] = []
175 for (const pluginInfo of toLoad) {
176 const clientScript = pluginInfo.clientScript
178 if (this.loadedScripts[clientScript.script]) continue
180 promises.push(this.loadPlugin(pluginInfo))
182 this.loadedScripts[clientScript.script] = true
185 await Promise.all(promises)
187 this.pluginsLoaded[scope].next(true)
188 this.loadingScopes[scope] = false
190 logger('Scope %s loaded', scope)
192 console.error('Cannot load plugins by scope %s.', scope, err)
196 private loadPlugin (pluginInfo: PluginInfo) {
197 const { plugin, clientScript } = pluginInfo
199 const registerHook = (options: RegisterClientHookOptions) => {
200 if (clientHookObject[options.target] !== true) {
201 console.error('Unknown hook %s of plugin %s. Skipping.', options.target, plugin.name)
205 if (!this.hooks[options.target]) this.hooks[options.target] = []
207 this.hooks[options.target].push({
210 target: options.target,
211 handler: options.handler,
212 priority: options.priority || 0
216 const registerVideoField = (commonOptions: RegisterClientFormFieldOptions, videoFormOptions: RegisterClientVideoFieldOptions) => {
217 if (!this.onFormFields) {
218 throw new Error('Video field registration is not supported')
221 return this.onFormFields(commonOptions, videoFormOptions)
224 const registerSettingsScript = (options: RegisterClientSettingsScript) => {
225 if (!this.onSettingsScripts) {
226 throw new Error('Registering settings script is not supported')
229 return this.onSettingsScripts(pluginInfo, options)
232 const peertubeHelpers = this.peertubeHelpersFactory(pluginInfo)
234 console.log('Loading script %s of plugin %s.', clientScript.script, plugin.name)
236 const absURL = (environment.apiUrl || window.location.origin) + clientScript.script
237 return dynamicImport(absURL)
238 .then((script: ClientScriptModule) => script.register({ registerHook, registerVideoField, registerSettingsScript, peertubeHelpers }))
239 .then(() => this.sortHooksByPriority())
240 .catch(err => console.error('Cannot import or register plugin %s.', pluginInfo.plugin.name, err))
243 private sortHooksByPriority () {
244 for (const hookName of Object.keys(this.hooks)) {
245 this.hooks[hookName].sort((a, b) => {
246 return b.priority - a.priority
256 PeertubeHelpersFactory,
261 // ---------------------------------------------------------------------------
263 async function dynamicImport (url: string) {
265 // eslint-disable-next-line no-new-func
266 return new Function(`return import('${url}')`)()
268 console.log('Fallback to import polyfill')
270 return new Promise((resolve, reject) => {
271 const vector = '$importModule$' + Math.random().toString(32).slice(2)
272 const script = document.createElement('script')
274 const destructor = () => {
275 delete window[vector]
276 script.onerror = null
279 URL.revokeObjectURL(script.src)
284 script.type = 'module'
286 script.onerror = () => {
287 reject(new Error(`Failed to import: ${url}`))
290 script.onload = () => {
291 resolve(window[vector])
294 const loader = `import * as m from "${url}"; window.${vector} = m;` // export Module
295 const blob = new Blob([ loader ], { type: 'text/javascript' })
296 script.src = URL.createObjectURL(blob)
298 document.head.appendChild(script)