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 RegisterClientRouteOptions,
17 RegisterClientSettingsScriptOptions,
18 RegisterClientVideoFieldOptions,
19 RegisteredExternalAuthConfig,
21 } from '../../../shared/models'
22 import { environment } from '../environments/environment'
23 import { ClientScript as ClientScriptModule } from '../types/client-script.model'
25 interface HookStructValue extends RegisterClientHookOptions {
26 plugin: ServerConfigPlugin
27 clientScript: ClientScript
30 type Hooks = { [ name: string ]: HookStructValue[] }
33 plugin: ServerConfigPlugin
34 clientScript: ClientScript
35 pluginType: PluginType
39 type PeertubeHelpersFactory = (pluginInfo: PluginInfo) => RegisterClientHelpers
40 type OnFormFields = (options: RegisterClientFormFieldOptions, videoFormOptions: RegisterClientVideoFieldOptions) => void
41 type OnSettingsScripts = (pluginInfo: PluginInfo, options: RegisterClientSettingsScriptOptions) => void
42 type OnClientRoute = (options: RegisterClientRouteOptions) => void
44 const logger = debug('peertube:plugins')
46 class PluginsManager {
47 private hooks: Hooks = {}
49 private scopes: { [ scopeName: string ]: PluginInfo[] } = {}
51 private loadedScripts: { [ script: string ]: boolean } = {}
52 private loadedScopes: PluginClientScope[] = []
53 private loadingScopes: { [id in PluginClientScope]?: boolean } = {}
55 private pluginsLoaded: { [ scope in PluginClientScope ]: ReplaySubject<boolean> } = {
56 common: new ReplaySubject<boolean>(1),
57 'admin-plugin': new ReplaySubject<boolean>(1),
58 search: new ReplaySubject<boolean>(1),
59 'video-watch': new ReplaySubject<boolean>(1),
60 signup: new ReplaySubject<boolean>(1),
61 login: new ReplaySubject<boolean>(1),
62 'video-edit': new ReplaySubject<boolean>(1),
63 embed: new ReplaySubject<boolean>(1)
66 private readonly peertubeHelpersFactory: PeertubeHelpersFactory
67 private readonly onFormFields: OnFormFields
68 private readonly onSettingsScripts: OnSettingsScripts
69 private readonly onClientRoute: OnClientRoute
71 constructor (options: {
72 peertubeHelpersFactory: PeertubeHelpersFactory
73 onFormFields?: OnFormFields
74 onSettingsScripts?: OnSettingsScripts
75 onClientRoute?: OnClientRoute
77 this.peertubeHelpersFactory = options.peertubeHelpersFactory
78 this.onFormFields = options.onFormFields
79 this.onSettingsScripts = options.onSettingsScripts
80 this.onClientRoute = options.onClientRoute
83 static getPluginPathPrefix (isTheme: boolean) {
84 return isTheme ? '/themes' : '/plugins'
87 static getExternalAuthHref (auth: RegisteredExternalAuthConfig) {
88 return environment.apiUrl + `/plugins/${auth.name}/${auth.version}/auth/${auth.authName}`
92 loadPluginsList (config: HTMLServerConfig) {
93 for (const plugin of config.plugin.registered) {
94 this.addPlugin(plugin)
98 async runHook<T> (hookName: ClientHookName, result?: T, params?: any) {
99 if (!this.hooks[hookName]) return result
101 const hookType = getHookType(hookName)
103 for (const hook of this.hooks[hookName]) {
104 console.log('Running hook %s of plugin %s.', hookName, hook.plugin.name)
106 result = await internalRunHook(hook.handler, hookType, result, params, err => {
107 console.error('Cannot run hook %s of script %s of plugin %s.', hookName, hook.clientScript.script, hook.plugin.name, err)
114 ensurePluginsAreLoaded (scope: PluginClientScope) {
115 this.loadPluginsByScope(scope)
117 const obs = this.pluginsLoaded[scope].asObservable()
118 .pipe(first(), shareReplay())
120 return firstValueFrom(obs)
123 async reloadLoadedScopes () {
124 for (const scope of this.loadedScopes) {
125 await this.loadPluginsByScope(scope, true)
129 addPlugin (plugin: ServerConfigPlugin, isTheme = false) {
130 const pathPrefix = PluginsManager.getPluginPathPrefix(isTheme)
132 for (const key of Object.keys(plugin.clientScripts)) {
133 const clientScript = plugin.clientScripts[key]
135 for (const scope of clientScript.scopes) {
136 if (!this.scopes[scope]) this.scopes[scope] = []
138 this.scopes[scope].push({
141 script: `${pathPrefix}/${plugin.name}/${plugin.version}/client-scripts/${clientScript.script}`,
142 scopes: clientScript.scopes
144 pluginType: isTheme ? PluginType.THEME : PluginType.PLUGIN,
148 this.loadedScripts[clientScript.script] = false
153 removePlugin (plugin: ServerConfigPlugin) {
154 for (const key of Object.keys(this.scopes)) {
155 this.scopes[key] = this.scopes[key].filter(o => o.plugin.name !== plugin.name)
159 async loadPluginsByScope (scope: PluginClientScope, isReload = false) {
160 if (this.loadingScopes[scope]) return
161 if (!isReload && this.loadedScopes.includes(scope)) return
163 this.loadingScopes[scope] = true
165 logger('Loading scope %s', scope)
168 if (!isReload) this.loadedScopes.push(scope)
170 const toLoad = this.scopes[scope]
171 if (!Array.isArray(toLoad)) {
172 this.loadingScopes[scope] = false
173 this.pluginsLoaded[scope].next(true)
175 logger('Nothing to load for scope %s', scope)
179 const promises: Promise<any>[] = []
180 for (const pluginInfo of toLoad) {
181 const clientScript = pluginInfo.clientScript
183 if (this.loadedScripts[clientScript.script]) continue
185 promises.push(this.loadPlugin(pluginInfo))
187 this.loadedScripts[clientScript.script] = true
190 await Promise.all(promises)
192 this.pluginsLoaded[scope].next(true)
193 this.loadingScopes[scope] = false
195 logger('Scope %s loaded', scope)
197 console.error('Cannot load plugins by scope %s.', scope, err)
201 private loadPlugin (pluginInfo: PluginInfo) {
202 const { plugin, clientScript } = pluginInfo
204 const registerHook = (options: RegisterClientHookOptions) => {
205 if (clientHookObject[options.target] !== true) {
206 console.error('Unknown hook %s of plugin %s. Skipping.', options.target, plugin.name)
210 if (!this.hooks[options.target]) this.hooks[options.target] = []
212 this.hooks[options.target].push({
215 target: options.target,
216 handler: options.handler,
217 priority: options.priority || 0
221 const registerVideoField = (commonOptions: RegisterClientFormFieldOptions, videoFormOptions: RegisterClientVideoFieldOptions) => {
222 if (!this.onFormFields) {
223 throw new Error('Video field registration is not supported')
226 return this.onFormFields(commonOptions, videoFormOptions)
229 const registerSettingsScript = (options: RegisterClientSettingsScriptOptions) => {
230 if (!this.onSettingsScripts) {
231 throw new Error('Registering settings script is not supported')
234 return this.onSettingsScripts(pluginInfo, options)
237 const registerClientRoute = (options: RegisterClientRouteOptions) => {
238 if (!this.onClientRoute) {
239 throw new Error('Registering client route is not supported')
242 return this.onClientRoute(options)
245 const peertubeHelpers = this.peertubeHelpersFactory(pluginInfo)
247 console.log('Loading script %s of plugin %s.', clientScript.script, plugin.name)
249 const absURL = (environment.apiUrl || window.location.origin) + clientScript.script
250 return dynamicImport(absURL)
251 .then((script: ClientScriptModule) => {
252 return script.register({
255 registerSettingsScript,
260 .then(() => this.sortHooksByPriority())
261 .catch(err => console.error('Cannot import or register plugin %s.', pluginInfo.plugin.name, err))
264 private sortHooksByPriority () {
265 for (const hookName of Object.keys(this.hooks)) {
266 this.hooks[hookName].sort((a, b) => {
267 return b.priority - a.priority
277 PeertubeHelpersFactory,
282 // ---------------------------------------------------------------------------
284 async function dynamicImport (url: string) {
286 // eslint-disable-next-line no-new-func
287 return new Function(`return import('${url}')`)()
289 console.log('Fallback to import polyfill')
291 return new Promise((resolve, reject) => {
292 const vector = '$importModule$' + Math.random().toString(32).slice(2)
293 const script = document.createElement('script')
295 const destructor = () => {
296 delete window[vector]
297 script.onerror = null
300 URL.revokeObjectURL(script.src)
305 script.type = 'module'
307 script.onerror = () => {
308 reject(new Error(`Failed to import: ${url}`))
311 script.onload = () => {
312 resolve(window[vector])
315 const loader = `import * as m from "${url}"; window.${vector} = m;` // export Module
316 const blob = new Blob([ loader ], { type: 'text/javascript' })
317 script.src = URL.createObjectURL(blob)
319 document.head.appendChild(script)