1 import { RegisterClientHelpers } from 'src/types/register-client-option.model'
2 import { getHookType, internalRunHook } from '@shared/core-utils/plugins/hooks'
8 RegisterClientFormFieldOptions,
9 RegisterClientHookOptions,
10 RegisterClientSettingsScript,
11 RegisterClientVideoFieldOptions,
13 } from '../../../shared/models'
14 import { ClientScript as ClientScriptModule } from '../types/client-script.model'
15 import { importModule } from './utils'
17 interface HookStructValue extends RegisterClientHookOptions {
18 plugin: ServerConfigPlugin
19 clientScript: ClientScript
22 type Hooks = { [ name: string ]: HookStructValue[] }
25 plugin: ServerConfigPlugin
26 clientScript: ClientScript
27 pluginType: PluginType
33 commonOptions: RegisterClientFormFieldOptions
34 videoFormOptions: RegisterClientVideoFieldOptions
38 async function runHook<T> (hooks: Hooks, hookName: ClientHookName, result?: T, params?: any) {
39 if (!hooks[hookName]) return result
41 const hookType = getHookType(hookName)
43 for (const hook of hooks[hookName]) {
44 console.log('Running hook %s of plugin %s.', hookName, hook.plugin.name)
46 result = await internalRunHook(hook.handler, hookType, result, params, err => {
47 console.error('Cannot run hook %s of script %s of plugin %s.', hookName, hook.clientScript.script, hook.plugin.name, err)
54 function loadPlugin (options: {
56 pluginInfo: PluginInfo
57 peertubeHelpersFactory: (pluginInfo: PluginInfo) => RegisterClientHelpers
58 formFields?: FormFields
59 onSettingsScripts?: (options: RegisterClientSettingsScript) => void
61 const { hooks, pluginInfo, peertubeHelpersFactory, formFields, onSettingsScripts } = options
62 const { plugin, clientScript } = pluginInfo
64 const registerHook = (options: RegisterClientHookOptions) => {
65 if (clientHookObject[options.target] !== true) {
66 console.error('Unknown hook %s of plugin %s. Skipping.', options.target, plugin.name)
70 if (!hooks[options.target]) hooks[options.target] = []
72 hooks[options.target].push({
75 target: options.target,
76 handler: options.handler,
77 priority: options.priority || 0
81 const registerVideoField = (commonOptions: RegisterClientFormFieldOptions, videoFormOptions: RegisterClientVideoFieldOptions) => {
83 throw new Error('Video field registration is not supported')
86 formFields.video.push({
92 const registerSettingsScript = (options: RegisterClientSettingsScript) => {
93 if (!onSettingsScripts) {
94 throw new Error('Registering settings script is not supported')
97 return onSettingsScripts(options)
100 const peertubeHelpers = peertubeHelpersFactory(pluginInfo)
102 console.log('Loading script %s of plugin %s.', clientScript.script, plugin.name)
104 return importModule(clientScript.script)
105 .then((script: ClientScriptModule) => script.register({ registerHook, registerVideoField, registerSettingsScript, peertubeHelpers }))
106 .then(() => sortHooksByPriority(hooks))
107 .catch(err => console.error('Cannot import or register plugin %s.', pluginInfo.plugin.name, err))
119 function sortHooksByPriority (hooks: Hooks) {
120 for (const hookName of Object.keys(hooks)) {
121 hooks[hookName].sort((a, b) => {
122 return b.priority - a.priority