client/src/root-helpers/plugins-manager.ts

   1 /* eslint-disable @typescript-eslint/no-implied-eval */
   2 import * as debug from 'debug'
   3 import { firstValueFrom, ReplaySubject } from 'rxjs'
   4 import { first, shareReplay } from 'rxjs/operators'
   5 import { RegisterClientHelpers } from 'src/types/register-client-option.model'
   6 import { getHookType, internalRunHook } from '@shared/core-utils/plugins/hooks'
   7 import {
   8   ClientHookName,
   9   clientHookObject,
  10   ClientScriptJSON,
  11   HTMLServerConfig,
  12   PluginClientScope,
  13   PluginType,
  14   RegisterClientFormFieldOptions,
  15   RegisterClientHookOptions,
  16   RegisterClientRouteOptions,
  17   RegisterClientSettingsScriptOptions,
  18   RegisterClientVideoFieldOptions,
  19   RegisteredExternalAuthConfig,
  20   ServerConfigPlugin
  21 } from '@shared/models'
  22 import { environment } from '../environments/environment'
  23 import { ClientScript } from '../types'
  24
  25 interface HookStructValue extends RegisterClientHookOptions {
  26   plugin: ServerConfigPlugin
  27   clientScript: ClientScriptJSON
  28 }
  29
  30 type Hooks = { [ name: string ]: HookStructValue[] }
  31
  32 type PluginInfo = {
  33   plugin: ServerConfigPlugin
  34   clientScript: ClientScriptJSON
  35   pluginType: PluginType
  36   isTheme: boolean
  37 }
  38
  39 type PeertubeHelpersFactory = (pluginInfo: PluginInfo) => RegisterClientHelpers
  40
  41 type OnFormFields = (
  42   pluginInfo: PluginInfo,
  43   options: RegisterClientFormFieldOptions,
  44   videoFormOptions: RegisterClientVideoFieldOptions
  45 ) => void
  46
  47 type OnSettingsScripts = (pluginInfo: PluginInfo, options: RegisterClientSettingsScriptOptions) => void
  48
  49 type OnClientRoute = (options: RegisterClientRouteOptions) => void
  50
  51 const logger = debug('peertube:plugins')
  52
  53 class PluginsManager {
  54   private hooks: Hooks = {}
  55
  56   private scopes: { [ scopeName: string ]: PluginInfo[] } = {}
  57
  58   private loadedScripts: { [ script: string ]: boolean } = {}
  59   private loadedScopes: PluginClientScope[] = []
  60   private loadingScopes: { [id in PluginClientScope]?: boolean } = {}
  61
  62   private pluginsLoaded: { [ scope in PluginClientScope ]: ReplaySubject<boolean> } = {
  63     common: new ReplaySubject<boolean>(1),
  64     'admin-plugin': new ReplaySubject<boolean>(1),
  65     search: new ReplaySubject<boolean>(1),
  66     'video-watch': new ReplaySubject<boolean>(1),
  67     signup: new ReplaySubject<boolean>(1),
  68     login: new ReplaySubject<boolean>(1),
  69     'video-edit': new ReplaySubject<boolean>(1),
  70     embed: new ReplaySubject<boolean>(1)
  71   }
  72
  73   private readonly peertubeHelpersFactory: PeertubeHelpersFactory
  74   private readonly onFormFields: OnFormFields
  75   private readonly onSettingsScripts: OnSettingsScripts
  76   private readonly onClientRoute: OnClientRoute
  77
  78   constructor (options: {
  79     peertubeHelpersFactory: PeertubeHelpersFactory
  80     onFormFields?: OnFormFields
  81     onSettingsScripts?: OnSettingsScripts
  82     onClientRoute?: OnClientRoute
  83   }) {
  84     this.peertubeHelpersFactory = options.peertubeHelpersFactory
  85     this.onFormFields = options.onFormFields
  86     this.onSettingsScripts = options.onSettingsScripts
  87     this.onClientRoute = options.onClientRoute
  88   }
  89
  90   static getPluginPathPrefix (isTheme: boolean) {
  91     return isTheme ? '/themes' : '/plugins'
  92   }
  93
  94   static getExternalAuthHref (auth: RegisteredExternalAuthConfig) {
  95     return environment.apiUrl + `/plugins/${auth.name}/${auth.version}/auth/${auth.authName}`
  96
  97   }
  98
  99   loadPluginsList (config: HTMLServerConfig) {
 100     for (const plugin of config.plugin.registered) {
 101       this.addPlugin(plugin)
 102     }
 103   }
 104
 105   async runHook<T> (hookName: ClientHookName, result?: T, params?: any) {
 106     if (!this.hooks[hookName]) return result
 107
 108     const hookType = getHookType(hookName)
 109
 110     for (const hook of this.hooks[hookName]) {
 111       console.log('Running hook %s of plugin %s.', hookName, hook.plugin.name)
 112
 113       result = await internalRunHook(hook.handler, hookType, result, params, err => {
 114         console.error('Cannot run hook %s of script %s of plugin %s.', hookName, hook.clientScript.script, hook.plugin.name, err)
 115       })
 116     }
 117
 118     return result
 119   }
 120
 121   ensurePluginsAreLoaded (scope: PluginClientScope) {
 122     this.loadPluginsByScope(scope)
 123
 124     const obs = this.pluginsLoaded[scope].asObservable()
 125                .pipe(first(), shareReplay())
 126
 127     return firstValueFrom(obs)
 128   }
 129
 130   async reloadLoadedScopes () {
 131     for (const scope of this.loadedScopes) {
 132       await this.loadPluginsByScope(scope, true)
 133     }
 134   }
 135
 136   addPlugin (plugin: ServerConfigPlugin, isTheme = false) {
 137     const pathPrefix = PluginsManager.getPluginPathPrefix(isTheme)
 138
 139     for (const key of Object.keys(plugin.clientScripts)) {
 140       const clientScript = plugin.clientScripts[key]
 141
 142       for (const scope of clientScript.scopes) {
 143         if (!this.scopes[scope]) this.scopes[scope] = []
 144
 145         this.scopes[scope].push({
 146           plugin,
 147           clientScript: {
 148             script: `${pathPrefix}/${plugin.name}/${plugin.version}/client-scripts/${clientScript.script}`,
 149             scopes: clientScript.scopes
 150           },
 151           pluginType: isTheme ? PluginType.THEME : PluginType.PLUGIN,
 152           isTheme
 153         })
 154
 155         this.loadedScripts[clientScript.script] = false
 156       }
 157     }
 158   }
 159
 160   removePlugin (plugin: ServerConfigPlugin) {
 161     for (const key of Object.keys(this.scopes)) {
 162       this.scopes[key] = this.scopes[key].filter(o => o.plugin.name !== plugin.name)
 163     }
 164   }
 165
 166   async loadPluginsByScope (scope: PluginClientScope, isReload = false) {
 167     if (this.loadingScopes[scope]) return
 168     if (!isReload && this.loadedScopes.includes(scope)) return
 169
 170     this.loadingScopes[scope] = true
 171
 172     logger('Loading scope %s', scope)
 173
 174     try {
 175       if (!isReload) this.loadedScopes.push(scope)
 176
 177       const toLoad = this.scopes[scope]
 178       if (!Array.isArray(toLoad)) {
 179         this.loadingScopes[scope] = false
 180         this.pluginsLoaded[scope].next(true)
 181
 182         logger('Nothing to load for scope %s', scope)
 183         return
 184       }
 185
 186       const promises: Promise<any>[] = []
 187       for (const pluginInfo of toLoad) {
 188         const clientScript = pluginInfo.clientScript
 189
 190         if (this.loadedScripts[clientScript.script]) continue
 191
 192         promises.push(this.loadPlugin(pluginInfo))
 193
 194         this.loadedScripts[clientScript.script] = true
 195       }
 196
 197       await Promise.all(promises)
 198
 199       this.pluginsLoaded[scope].next(true)
 200       this.loadingScopes[scope] = false
 201
 202       logger('Scope %s loaded', scope)
 203     } catch (err) {
 204       console.error('Cannot load plugins by scope %s.', scope, err)
 205     }
 206   }
 207
 208   private loadPlugin (pluginInfo: PluginInfo) {
 209     const { plugin, clientScript } = pluginInfo
 210
 211     const registerHook = (options: RegisterClientHookOptions) => {
 212       if (clientHookObject[options.target] !== true) {
 213         console.error('Unknown hook %s of plugin %s. Skipping.', options.target, plugin.name)
 214         return
 215       }
 216
 217       if (!this.hooks[options.target]) this.hooks[options.target] = []
 218
 219       this.hooks[options.target].push({
 220         plugin,
 221         clientScript,
 222         target: options.target,
 223         handler: options.handler,
 224         priority: options.priority || 0
 225       })
 226     }
 227
 228     const registerVideoField = (commonOptions: RegisterClientFormFieldOptions, videoFormOptions: RegisterClientVideoFieldOptions) => {
 229       if (!this.onFormFields) {
 230         throw new Error('Video field registration is not supported')
 231       }
 232
 233       return this.onFormFields(pluginInfo, commonOptions, videoFormOptions)
 234     }
 235
 236     const registerSettingsScript = (options: RegisterClientSettingsScriptOptions) => {
 237       if (!this.onSettingsScripts) {
 238         throw new Error('Registering settings script is not supported')
 239       }
 240
 241       return this.onSettingsScripts(pluginInfo, options)
 242     }
 243
 244     const registerClientRoute = (options: RegisterClientRouteOptions) => {
 245       if (!this.onClientRoute) {
 246         throw new Error('Registering client route is not supported')
 247       }
 248
 249       return this.onClientRoute(options)
 250     }
 251
 252     const peertubeHelpers = this.peertubeHelpersFactory(pluginInfo)
 253
 254     console.log('Loading script %s of plugin %s.', clientScript.script, plugin.name)
 255
 256     const absURL = (environment.apiUrl || window.location.origin) + clientScript.script
 257     return dynamicImport(absURL)
 258       .then((script: ClientScript) => {
 259         return script.register({
 260           registerHook,
 261           registerVideoField,
 262           registerSettingsScript,
 263           registerClientRoute,
 264           peertubeHelpers
 265         })
 266       })
 267       .then(() => this.sortHooksByPriority())
 268       .catch(err => console.error('Cannot import or register plugin %s.', pluginInfo.plugin.name, err))
 269   }
 270
 271   private sortHooksByPriority () {
 272     for (const hookName of Object.keys(this.hooks)) {
 273       this.hooks[hookName].sort((a, b) => {
 274         return b.priority - a.priority
 275       })
 276     }
 277   }
 278 }
 279
 280 export {
 281   PluginsManager,
 282
 283   PluginInfo,
 284   PeertubeHelpersFactory,
 285   OnFormFields,
 286   OnSettingsScripts
 287 }
 288
 289 // ---------------------------------------------------------------------------
 290
 291 async function dynamicImport (url: string) {
 292   try {
 293     // eslint-disable-next-line no-new-func
 294     return new Function(`return import('${url}')`)()
 295   } catch {
 296     console.log('Fallback to import polyfill')
 297
 298     return new Promise((resolve, reject) => {
 299       const vector = '$importModule$' + Math.random().toString(32).slice(2)
 300       const script = document.createElement('script')
 301
 302       const destructor = () => {
 303         delete window[vector]
 304         script.onerror = null
 305         script.onload = null
 306         script.remove()
 307         URL.revokeObjectURL(script.src)
 308         script.src = ''
 309       }
 310
 311       script.defer = true
 312       script.type = 'module'
 313
 314       script.onerror = () => {
 315         reject(new Error(`Failed to import: ${url}`))
 316         destructor()
 317       }
 318       script.onload = () => {
 319         resolve(window[vector])
 320         destructor()
 321       }
 322       const loader = `import * as m from "${url}"; window.${vector} = m;` // export Module
 323       const blob = new Blob([ loader ], { type: 'text/javascript' })
 324       script.src = URL.createObjectURL(blob)
 325
 326       document.head.appendChild(script)
 327     })
 328   }
 329 }