127 lines
3.7 KiB
TypeScript
127 lines
3.7 KiB
TypeScript
import { RegisterClientHelpers } from 'src/types/register-client-option.model'
|
|
import { getHookType, internalRunHook } from '@shared/core-utils/plugins/hooks'
|
|
import {
|
|
ClientHookName,
|
|
clientHookObject,
|
|
ClientScript,
|
|
PluginType,
|
|
RegisterClientFormFieldOptions,
|
|
RegisterClientHookOptions,
|
|
RegisterClientSettingsScript,
|
|
RegisterClientVideoFieldOptions,
|
|
ServerConfigPlugin
|
|
} from '../../../shared/models'
|
|
import { environment } from '../environments/environment'
|
|
import { ClientScript as ClientScriptModule } from '../types/client-script.model'
|
|
|
|
interface HookStructValue extends RegisterClientHookOptions {
|
|
plugin: ServerConfigPlugin
|
|
clientScript: ClientScript
|
|
}
|
|
|
|
type Hooks = { [ name: string ]: HookStructValue[] }
|
|
|
|
type PluginInfo = {
|
|
plugin: ServerConfigPlugin
|
|
clientScript: ClientScript
|
|
pluginType: PluginType
|
|
isTheme: boolean
|
|
}
|
|
|
|
type FormFields = {
|
|
video: {
|
|
commonOptions: RegisterClientFormFieldOptions
|
|
videoFormOptions: RegisterClientVideoFieldOptions
|
|
}[]
|
|
}
|
|
|
|
async function runHook<T> (hooks: Hooks, hookName: ClientHookName, result?: T, params?: any) {
|
|
if (!hooks[hookName]) return result
|
|
|
|
const hookType = getHookType(hookName)
|
|
|
|
for (const hook of hooks[hookName]) {
|
|
console.log('Running hook %s of plugin %s.', hookName, hook.plugin.name)
|
|
|
|
result = await internalRunHook(hook.handler, hookType, result, params, err => {
|
|
console.error('Cannot run hook %s of script %s of plugin %s.', hookName, hook.clientScript.script, hook.plugin.name, err)
|
|
})
|
|
}
|
|
|
|
return result
|
|
}
|
|
|
|
function loadPlugin (options: {
|
|
hooks: Hooks
|
|
pluginInfo: PluginInfo
|
|
peertubeHelpersFactory: (pluginInfo: PluginInfo) => RegisterClientHelpers
|
|
formFields?: FormFields
|
|
onSettingsScripts?: (options: RegisterClientSettingsScript) => void
|
|
}) {
|
|
const { hooks, pluginInfo, peertubeHelpersFactory, formFields, onSettingsScripts } = options
|
|
const { plugin, clientScript } = pluginInfo
|
|
|
|
const registerHook = (options: RegisterClientHookOptions) => {
|
|
if (clientHookObject[options.target] !== true) {
|
|
console.error('Unknown hook %s of plugin %s. Skipping.', options.target, plugin.name)
|
|
return
|
|
}
|
|
|
|
if (!hooks[options.target]) hooks[options.target] = []
|
|
|
|
hooks[options.target].push({
|
|
plugin,
|
|
clientScript,
|
|
target: options.target,
|
|
handler: options.handler,
|
|
priority: options.priority || 0
|
|
})
|
|
}
|
|
|
|
const registerVideoField = (commonOptions: RegisterClientFormFieldOptions, videoFormOptions: RegisterClientVideoFieldOptions) => {
|
|
if (!formFields) {
|
|
throw new Error('Video field registration is not supported')
|
|
}
|
|
|
|
formFields.video.push({
|
|
commonOptions,
|
|
videoFormOptions
|
|
})
|
|
}
|
|
|
|
const registerSettingsScript = (options: RegisterClientSettingsScript) => {
|
|
if (!onSettingsScripts) {
|
|
throw new Error('Registering settings script is not supported')
|
|
}
|
|
|
|
return onSettingsScripts(options)
|
|
}
|
|
|
|
const peertubeHelpers = peertubeHelpersFactory(pluginInfo)
|
|
|
|
console.log('Loading script %s of plugin %s.', clientScript.script, plugin.name)
|
|
|
|
const absURL = (environment.apiUrl || window.location.origin) + clientScript.script
|
|
return import(/* webpackIgnore: true */ absURL)
|
|
.then((script: ClientScriptModule) => script.register({ registerHook, registerVideoField, registerSettingsScript, peertubeHelpers }))
|
|
.then(() => sortHooksByPriority(hooks))
|
|
.catch(err => console.error('Cannot import or register plugin %s.', pluginInfo.plugin.name, err))
|
|
}
|
|
|
|
export {
|
|
HookStructValue,
|
|
Hooks,
|
|
PluginInfo,
|
|
FormFields,
|
|
loadPlugin,
|
|
runHook
|
|
}
|
|
|
|
function sortHooksByPriority (hooks: Hooks) {
|
|
for (const hookName of Object.keys(hooks)) {
|
|
hooks[hookName].sort((a, b) => {
|
|
return b.priority - a.priority
|
|
})
|
|
}
|
|
}
|