1 import * as debug from 'debug'
2 import { firstValueFrom, ReplaySubject } from 'rxjs'
3 import { first, shareReplay } from 'rxjs/operators'
4 import { RegisterClientHelpers } from 'src/types/register-client-option.model'
5 import { getHookType, internalRunHook } from '@shared/core-utils/plugins/hooks'
13 RegisterClientFormFieldOptions,
14 RegisterClientHookOptions,
15 RegisterClientSettingsScript,
16 RegisterClientVideoFieldOptions,
18 } from '../../../shared/models'
19 import { environment } from '../environments/environment'
20 import { ClientScript as ClientScriptModule } from '../types/client-script.model'
22 interface HookStructValue extends RegisterClientHookOptions {
23 plugin: ServerConfigPlugin
24 clientScript: ClientScript
27 type Hooks = { [ name: string ]: HookStructValue[] }
30 plugin: ServerConfigPlugin
31 clientScript: ClientScript
32 pluginType: PluginType
36 type PeertubeHelpersFactory = (pluginInfo: PluginInfo) => RegisterClientHelpers
37 type OnFormFields = (options: RegisterClientFormFieldOptions, videoFormOptions: RegisterClientVideoFieldOptions) => void
38 type OnSettingsScripts = (pluginInfo: PluginInfo, options: RegisterClientSettingsScript) => void
40 const logger = debug('peertube:plugins')
42 class PluginsManager {
43 private hooks: Hooks = {}
45 private scopes: { [ scopeName: string ]: PluginInfo[] } = {}
47 private loadedScripts: { [ script: string ]: boolean } = {}
48 private loadedScopes: PluginClientScope[] = []
49 private loadingScopes: { [id in PluginClientScope]?: boolean } = {}
51 private pluginsLoaded: { [ scope in PluginClientScope ]: ReplaySubject<boolean> } = {
52 common: new ReplaySubject<boolean>(1),
53 'admin-plugin': new ReplaySubject<boolean>(1),
54 search: new ReplaySubject<boolean>(1),
55 'video-watch': new ReplaySubject<boolean>(1),
56 signup: new ReplaySubject<boolean>(1),
57 login: new ReplaySubject<boolean>(1),
58 'video-edit': new ReplaySubject<boolean>(1),
59 embed: new ReplaySubject<boolean>(1)
62 private readonly peertubeHelpersFactory: PeertubeHelpersFactory
63 private readonly onFormFields: OnFormFields
64 private readonly onSettingsScripts: OnSettingsScripts
66 constructor (options: {
67 peertubeHelpersFactory: PeertubeHelpersFactory
68 onFormFields?: OnFormFields
69 onSettingsScripts?: OnSettingsScripts
71 this.peertubeHelpersFactory = options.peertubeHelpersFactory
72 this.onFormFields = options.onFormFields
73 this.onSettingsScripts = options.onSettingsScripts
76 static getPluginPathPrefix (isTheme: boolean) {
77 return isTheme ? '/themes' : '/plugins'
80 loadPluginsList (config: HTMLServerConfig) {
81 for (const plugin of config.plugin.registered) {
82 this.addPlugin(plugin)
86 async runHook<T> (hookName: ClientHookName, result?: T, params?: any) {
87 if (!this.hooks[hookName]) return result
89 const hookType = getHookType(hookName)
91 for (const hook of this.hooks[hookName]) {
92 console.log('Running hook %s of plugin %s.', hookName, hook.plugin.name)
94 result = await internalRunHook(hook.handler, hookType, result, params, err => {
95 console.error('Cannot run hook %s of script %s of plugin %s.', hookName, hook.clientScript.script, hook.plugin.name, err)
102 ensurePluginsAreLoaded (scope: PluginClientScope) {
103 this.loadPluginsByScope(scope)
105 const obs = this.pluginsLoaded[scope].asObservable()
106 .pipe(first(), shareReplay())
108 return firstValueFrom(obs)
111 async reloadLoadedScopes () {
112 for (const scope of this.loadedScopes) {
113 await this.loadPluginsByScope(scope, true)
117 addPlugin (plugin: ServerConfigPlugin, isTheme = false) {
118 const pathPrefix = PluginsManager.getPluginPathPrefix(isTheme)
120 for (const key of Object.keys(plugin.clientScripts)) {
121 const clientScript = plugin.clientScripts[key]
123 for (const scope of clientScript.scopes) {
124 if (!this.scopes[scope]) this.scopes[scope] = []
126 this.scopes[scope].push({
129 script: `${pathPrefix}/${plugin.name}/${plugin.version}/client-scripts/${clientScript.script}`,
130 scopes: clientScript.scopes
132 pluginType: isTheme ? PluginType.THEME : PluginType.PLUGIN,
136 this.loadedScripts[clientScript.script] = false
141 removePlugin (plugin: ServerConfigPlugin) {
142 for (const key of Object.keys(this.scopes)) {
143 this.scopes[key] = this.scopes[key].filter(o => o.plugin.name !== plugin.name)
147 async loadPluginsByScope (scope: PluginClientScope, isReload = false) {
148 if (this.loadingScopes[scope]) return
149 if (!isReload && this.loadedScopes.includes(scope)) return
151 this.loadingScopes[scope] = true
153 logger('Loading scope %s', scope)
156 if (!isReload) this.loadedScopes.push(scope)
158 const toLoad = this.scopes[scope]
159 if (!Array.isArray(toLoad)) {
160 this.loadingScopes[scope] = false
161 this.pluginsLoaded[scope].next(true)
163 logger('Nothing to load for scope %s', scope)
167 const promises: Promise<any>[] = []
168 for (const pluginInfo of toLoad) {
169 const clientScript = pluginInfo.clientScript
171 if (this.loadedScripts[clientScript.script]) continue
173 promises.push(this.loadPlugin(pluginInfo))
175 this.loadedScripts[clientScript.script] = true
178 await Promise.all(promises)
180 this.pluginsLoaded[scope].next(true)
181 this.loadingScopes[scope] = false
183 logger('Scope %s loaded', scope)
185 console.error('Cannot load plugins by scope %s.', scope, err)
189 private loadPlugin (pluginInfo: PluginInfo) {
190 const { plugin, clientScript } = pluginInfo
192 const registerHook = (options: RegisterClientHookOptions) => {
193 if (clientHookObject[options.target] !== true) {
194 console.error('Unknown hook %s of plugin %s. Skipping.', options.target, plugin.name)
198 if (!this.hooks[options.target]) this.hooks[options.target] = []
200 this.hooks[options.target].push({
203 target: options.target,
204 handler: options.handler,
205 priority: options.priority || 0
209 const registerVideoField = (commonOptions: RegisterClientFormFieldOptions, videoFormOptions: RegisterClientVideoFieldOptions) => {
210 if (!this.onFormFields) {
211 throw new Error('Video field registration is not supported')
214 return this.onFormFields(commonOptions, videoFormOptions)
217 const registerSettingsScript = (options: RegisterClientSettingsScript) => {
218 if (!this.onSettingsScripts) {
219 throw new Error('Registering settings script is not supported')
222 return this.onSettingsScripts(pluginInfo, options)
225 const peertubeHelpers = this.peertubeHelpersFactory(pluginInfo)
227 console.log('Loading script %s of plugin %s.', clientScript.script, plugin.name)
229 const absURL = (environment.apiUrl || window.location.origin) + clientScript.script
230 return import(/* webpackIgnore: true */ absURL)
231 .then((script: ClientScriptModule) => script.register({ registerHook, registerVideoField, registerSettingsScript, peertubeHelpers }))
232 .then(() => this.sortHooksByPriority())
233 .catch(err => console.error('Cannot import or register plugin %s.', pluginInfo.plugin.name, err))
236 private sortHooksByPriority () {
237 for (const hookName of Object.keys(this.hooks)) {
238 this.hooks[hookName].sort((a, b) => {
239 return b.priority - a.priority
249 PeertubeHelpersFactory,