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