aboutsummaryrefslogtreecommitdiffhomepage
path: root/client/src/root-helpers
diff options
context:
space:
mode:
Diffstat (limited to 'client/src/root-helpers')
-rw-r--r--client/src/root-helpers/plugins.ts114
-rw-r--r--client/src/root-helpers/utils.ts38
2 files changed, 152 insertions, 0 deletions
diff --git a/client/src/root-helpers/plugins.ts b/client/src/root-helpers/plugins.ts
new file mode 100644
index 000000000..4bc2c8eb2
--- /dev/null
+++ b/client/src/root-helpers/plugins.ts
@@ -0,0 +1,114 @@
1import { RegisterClientHelpers } from 'src/types/register-client-option.model'
2import { getHookType, internalRunHook } from '@shared/core-utils/plugins/hooks'
3import { RegisterClientFormFieldOptions, RegisterClientVideoFieldOptions } from '@shared/models/plugins/register-client-form-field.model'
4import {
5 ClientHookName,
6 clientHookObject,
7 ClientScript,
8 PluginType,
9 RegisterClientHookOptions,
10 ServerConfigPlugin
11} from '../../../shared/models'
12import { ClientScript as ClientScriptModule } from '../types/client-script.model'
13import { importModule } from './utils'
14
15interface HookStructValue extends RegisterClientHookOptions {
16 plugin: ServerConfigPlugin
17 clientScript: ClientScript
18}
19
20type Hooks = { [ name: string ]: HookStructValue[] }
21
22type PluginInfo = {
23 plugin: ServerConfigPlugin
24 clientScript: ClientScript
25 pluginType: PluginType
26 isTheme: boolean
27}
28
29type FormFields = {
30 video: {
31 commonOptions: RegisterClientFormFieldOptions
32 videoFormOptions: RegisterClientVideoFieldOptions
33 }[]
34}
35
36async function runHook<T> (hooks: Hooks, hookName: ClientHookName, result?: T, params?: any) {
37 if (!hooks[hookName]) return result
38
39 const hookType = getHookType(hookName)
40
41 for (const hook of hooks[hookName]) {
42 console.log('Running hook %s of plugin %s.', hookName, hook.plugin.name)
43
44 result = await internalRunHook(hook.handler, hookType, result, params, err => {
45 console.error('Cannot run hook %s of script %s of plugin %s.', hookName, hook.clientScript.script, hook.plugin.name, err)
46 })
47 }
48
49 return result
50}
51
52function loadPlugin (options: {
53 hooks: Hooks
54 pluginInfo: PluginInfo
55 peertubeHelpersFactory: (pluginInfo: PluginInfo) => RegisterClientHelpers
56 formFields?: FormFields
57}) {
58 const { hooks, pluginInfo, peertubeHelpersFactory, formFields } = options
59 const { plugin, clientScript } = pluginInfo
60
61 const registerHook = (options: RegisterClientHookOptions) => {
62 if (clientHookObject[options.target] !== true) {
63 console.error('Unknown hook %s of plugin %s. Skipping.', options.target, plugin.name)
64 return
65 }
66
67 if (!hooks[options.target]) hooks[options.target] = []
68
69 hooks[options.target].push({
70 plugin,
71 clientScript,
72 target: options.target,
73 handler: options.handler,
74 priority: options.priority || 0
75 })
76 }
77
78 const registerVideoField = (commonOptions: RegisterClientFormFieldOptions, videoFormOptions: RegisterClientVideoFieldOptions) => {
79 if (!formFields) {
80 throw new Error('Video field registration is not supported')
81 }
82
83 formFields.video.push({
84 commonOptions,
85 videoFormOptions
86 })
87 }
88
89 const peertubeHelpers = peertubeHelpersFactory(pluginInfo)
90
91 console.log('Loading script %s of plugin %s.', clientScript.script, plugin.name)
92
93 return importModule(clientScript.script)
94 .then((script: ClientScriptModule) => script.register({ registerHook, registerVideoField, peertubeHelpers }))
95 .then(() => sortHooksByPriority(hooks))
96 .catch(err => console.error('Cannot import or register plugin %s.', pluginInfo.plugin.name, err))
97}
98
99export {
100 HookStructValue,
101 Hooks,
102 PluginInfo,
103 FormFields,
104 loadPlugin,
105 runHook
106}
107
108function sortHooksByPriority (hooks: Hooks) {
109 for (const hookName of Object.keys(hooks)) {
110 hooks[hookName].sort((a, b) => {
111 return b.priority - a.priority
112 })
113 }
114}
diff --git a/client/src/root-helpers/utils.ts b/client/src/root-helpers/utils.ts
index acfb565a3..6df151ad9 100644
--- a/client/src/root-helpers/utils.ts
+++ b/client/src/root-helpers/utils.ts
@@ -1,3 +1,5 @@
1import { environment } from '../environments/environment'
2
1function objectToUrlEncoded (obj: any) { 3function objectToUrlEncoded (obj: any) {
2 const str: string[] = [] 4 const str: string[] = []
3 for (const key of Object.keys(obj)) { 5 for (const key of Object.keys(obj)) {
@@ -7,6 +9,42 @@ function objectToUrlEncoded (obj: any) {
7 return str.join('&') 9 return str.join('&')
8} 10}
9 11
12// Thanks: https://github.com/uupaa/dynamic-import-polyfill
13function importModule (path: string) {
14 return new Promise((resolve, reject) => {
15 const vector = '$importModule$' + Math.random().toString(32).slice(2)
16 const script = document.createElement('script')
17
18 const destructor = () => {
19 delete window[ vector ]
20 script.onerror = null
21 script.onload = null
22 script.remove()
23 URL.revokeObjectURL(script.src)
24 script.src = ''
25 }
26
27 script.defer = true
28 script.type = 'module'
29
30 script.onerror = () => {
31 reject(new Error(`Failed to import: ${path}`))
32 destructor()
33 }
34 script.onload = () => {
35 resolve(window[ vector ])
36 destructor()
37 }
38 const absURL = (environment.apiUrl || window.location.origin) + path
39 const loader = `import * as m from "${absURL}"; window.${vector} = m;` // export Module
40 const blob = new Blob([ loader ], { type: 'text/javascript' })
41 script.src = URL.createObjectURL(blob)
42
43 document.head.appendChild(script)
44 })
45}
46
10export { 47export {
48 importModule,
11 objectToUrlEncoded 49 objectToUrlEncoded
12} 50}