1 import { RegisterClientHelpers } from 'src/types/register-client-option.model'
2 import { getHookType, internalRunHook } from '@shared/core-utils/plugins/hooks'
3 import { RegisterClientFormFieldOptions, RegisterClientVideoFieldOptions } from '@shared/models/plugins/register-client-form-field.model'
9 RegisterClientHookOptions,
11 RegisterClientSettingsScript
12 } from '../../../shared/models'
13 import { ClientScript as ClientScriptModule } from '../types/client-script.model'
14 import { importModule } from './utils'
16 interface HookStructValue extends RegisterClientHookOptions {
17 plugin: ServerConfigPlugin
18 clientScript: ClientScript
21 type Hooks = { [ name: string ]: HookStructValue[] }
24 plugin: ServerConfigPlugin
25 clientScript: ClientScript
26 pluginType: PluginType
32 commonOptions: RegisterClientFormFieldOptions
33 videoFormOptions: RegisterClientVideoFieldOptions
37 async function runHook<T> (hooks: Hooks, hookName: ClientHookName, result?: T, params?: any) {
38 if (!hooks[hookName]) return result
40 const hookType = getHookType(hookName)
42 for (const hook of hooks[hookName]) {
43 console.log('Running hook %s of plugin %s.', hookName, hook.plugin.name)
45 result = await internalRunHook(hook.handler, hookType, result, params, err => {
46 console.error('Cannot run hook %s of script %s of plugin %s.', hookName, hook.clientScript.script, hook.plugin.name, err)
53 function loadPlugin (options: {
55 pluginInfo: PluginInfo
56 peertubeHelpersFactory: (pluginInfo: PluginInfo) => RegisterClientHelpers
57 formFields?: FormFields
58 onSettingsScripts?: (options: RegisterClientSettingsScript) => void
60 const { hooks, pluginInfo, peertubeHelpersFactory, formFields, onSettingsScripts } = options
61 const { plugin, clientScript } = pluginInfo
63 const registerHook = (options: RegisterClientHookOptions) => {
64 if (clientHookObject[options.target] !== true) {
65 console.error('Unknown hook %s of plugin %s. Skipping.', options.target, plugin.name)
69 if (!hooks[options.target]) hooks[options.target] = []
71 hooks[options.target].push({
74 target: options.target,
75 handler: options.handler,
76 priority: options.priority || 0
80 const registerVideoField = (commonOptions: RegisterClientFormFieldOptions, videoFormOptions: RegisterClientVideoFieldOptions) => {
82 throw new Error('Video field registration is not supported')
85 formFields.video.push({
91 const registerSettingsScript = (options: RegisterClientSettingsScript) => {
92 if (!onSettingsScripts) {
93 throw new Error('Registering settings script is not supported')
96 return onSettingsScripts(options)
99 const peertubeHelpers = peertubeHelpersFactory(pluginInfo)
101 console.log('Loading script %s of plugin %s.', clientScript.script, plugin.name)
103 return importModule(clientScript.script)
104 .then((script: ClientScriptModule) => script.register({ registerHook, registerVideoField, registerSettingsScript, peertubeHelpers }))
105 .then(() => sortHooksByPriority(hooks))
106 .catch(err => console.error('Cannot import or register plugin %s.', pluginInfo.plugin.name, err))
118 function sortHooksByPriority (hooks: Hooks) {
119 for (const hookName of Object.keys(hooks)) {
120 hooks[hookName].sort((a, b) => {
121 return b.priority - a.priority