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, result?: T, params?: any) {
 109     if (!this.hooks[hookName]) return result
 110
 111     const hookType = getHookType(hookName)
 112
 113     for (const hook of this.hooks[hookName]) {
 114       logger.info(`Running hook ${hookName} of plugin ${hook.plugin.name}`)
 115
 116       result = await internalRunHook({
 117         handler: hook.handler,
 118         hookType,
 119         result,
 120         params,
 121         onError: err => {
 122           logger.error(`Cannot run hook ${hookName} of script ${hook.clientScript.script} of plugin ${hook.plugin.name}`, err)
 123         }
 124       })
 125     }
 126
 127     return result
 128   }
 129
 130   ensurePluginsAreLoaded (scope: PluginClientScope) {
 131     this.loadPluginsByScope(scope)
 132
 133     const obs = this.pluginsLoaded[scope].asObservable()
 134                .pipe(first(), shareReplay())
 135
 136     return firstValueFrom(obs)
 137   }
 138
 139   async reloadLoadedScopes () {
 140     for (const scope of this.loadedScopes) {
 141       await this.loadPluginsByScope(scope, true)
 142     }
 143   }
 144
 145   addPlugin (plugin: ServerConfigPlugin, isTheme = false) {
 146     const pathPrefix = PluginsManager.getPluginPathPrefix(isTheme)
 147
 148     for (const key of Object.keys(plugin.clientScripts)) {
 149       const clientScript = plugin.clientScripts[key]
 150
 151       for (const scope of clientScript.scopes) {
 152         if (!this.scopes[scope]) this.scopes[scope] = []
 153
 154         this.scopes[scope].push({
 155           plugin,
 156           clientScript: {
 157             script: `${pathPrefix}/${plugin.name}/${plugin.version}/client-scripts/${clientScript.script}`,
 158             scopes: clientScript.scopes
 159           },
 160           pluginType: isTheme ? PluginType.THEME : PluginType.PLUGIN,
 161           isTheme
 162         })
 163
 164         this.loadedScripts[clientScript.script] = false
 165       }
 166     }
 167   }
 168
 169   removePlugin (plugin: ServerConfigPlugin) {
 170     for (const key of Object.keys(this.scopes)) {
 171       this.scopes[key] = this.scopes[key].filter(o => o.plugin.name !== plugin.name)
 172     }
 173   }
 174
 175   async loadPluginsByScope (scope: PluginClientScope, isReload = false) {
 176     if (this.loadingScopes[scope]) return
 177     if (!isReload && this.loadedScopes.includes(scope)) return
 178
 179     this.loadingScopes[scope] = true
 180
 181     debugLogger('Loading scope %s', scope)
 182
 183     try {
 184       if (!isReload) this.loadedScopes.push(scope)
 185
 186       const toLoad = this.scopes[scope]
 187       if (!Array.isArray(toLoad)) {
 188         this.loadingScopes[scope] = false
 189         this.pluginsLoaded[scope].next(true)
 190
 191         debugLogger('Nothing to load for scope %s', scope)
 192         return
 193       }
 194
 195       const promises: Promise<any>[] = []
 196       for (const pluginInfo of toLoad) {
 197         const clientScript = pluginInfo.clientScript
 198
 199         if (this.loadedScripts[clientScript.script]) continue
 200
 201         promises.push(this.loadPlugin(pluginInfo))
 202
 203         this.loadedScripts[clientScript.script] = true
 204       }
 205
 206       await Promise.all(promises)
 207
 208       this.pluginsLoaded[scope].next(true)
 209       this.loadingScopes[scope] = false
 210
 211       debugLogger('Scope %s loaded', scope)
 212     } catch (err) {
 213       logger.error(`Cannot load plugins by scope ${scope}`, err)
 214     }
 215   }
 216
 217   private loadPlugin (pluginInfo: PluginInfo) {
 218     const { plugin, clientScript } = pluginInfo
 219
 220     const registerHook = (options: RegisterClientHookOptions) => {
 221       if (clientHookObject[options.target] !== true) {
 222         logger.error(`Unknown hook ${options.target} of plugin ${plugin.name}. Skipping.`)
 223         return
 224       }
 225
 226       if (!this.hooks[options.target]) this.hooks[options.target] = []
 227
 228       this.hooks[options.target].push({
 229         plugin,
 230         clientScript,
 231         target: options.target,
 232         handler: options.handler,
 233         priority: options.priority || 0
 234       })
 235     }
 236
 237     const registerVideoField = (commonOptions: RegisterClientFormFieldOptions, videoFormOptions: RegisterClientVideoFieldOptions) => {
 238       if (!this.onFormFields) {
 239         throw new Error('Video field registration is not supported')
 240       }
 241
 242       return this.onFormFields(pluginInfo, commonOptions, videoFormOptions)
 243     }
 244
 245     const registerSettingsScript = (options: RegisterClientSettingsScriptOptions) => {
 246       if (!this.onSettingsScripts) {
 247         throw new Error('Registering settings script is not supported')
 248       }
 249
 250       return this.onSettingsScripts(pluginInfo, options)
 251     }
 252
 253     const registerClientRoute = (options: RegisterClientRouteOptions) => {
 254       if (!this.onClientRoute) {
 255         throw new Error('Registering client route is not supported')
 256       }
 257
 258       return this.onClientRoute(options)
 259     }
 260
 261     const peertubeHelpers = this.peertubeHelpersFactory(pluginInfo)
 262
 263     logger.info(`Loading script ${clientScript.script} of plugin ${plugin.name}`)
 264
 265     const absURL = (environment.apiUrl || window.location.origin) + clientScript.script
 266     return dynamicImport(absURL)
 267       .then((script: ClientScript) => {
 268         return script.register({
 269           registerHook,
 270           registerVideoField,
 271           registerSettingsScript,
 272           registerClientRoute,
 273           peertubeHelpers
 274         })
 275       })
 276       .then(() => this.sortHooksByPriority())
 277       .catch(err => logger.error(`Cannot import or register plugin ${pluginInfo.plugin.name}`, err))
 278   }
 279
 280   private sortHooksByPriority () {
 281     for (const hookName of Object.keys(this.hooks)) {
 282       this.hooks[hookName].sort((a, b) => {
 283         return b.priority - a.priority
 284       })
 285     }
 286   }
 287 }
 288
 289 export {
 290   PluginsManager,
 291
 292   PluginInfo,
 293   PeertubeHelpersFactory,
 294   OnFormFields,
 295   OnSettingsScripts
 296 }
 297
 298 // ---------------------------------------------------------------------------
 299
 300 async function dynamicImport (url: string) {
 301   try {
 302     // eslint-disable-next-line no-new-func
 303     return new Function(`return import('${url}')`)()
 304   } catch {
 305     logger.info('Fallback to import polyfill')
 306
 307     return new Promise((resolve, reject) => {
 308       const vector = '$importModule$' + Math.random().toString(32).slice(2)
 309       const script = document.createElement('script')
 310
 311       const destructor = () => {
 312         delete window[vector]
 313         script.onerror = null
 314         script.onload = null
 315         script.remove()
 316         URL.revokeObjectURL(script.src)
 317         script.src = ''
 318       }
 319
 320       script.defer = true
 321       script.type = 'module'
 322
 323       script.onerror = () => {
 324         reject(new Error(`Failed to import: ${url}`))
 325         destructor()
 326       }
 327       script.onload = () => {
 328         resolve(window[vector])
 329         destructor()
 330       }
 331       const loader = `import * as m from "${url}"; window.${vector} = m;` // export Module
 332       const blob = new Blob([ loader ], { type: 'text/javascript' })
 333       script.src = URL.createObjectURL(blob)
 334
 335       document.head.appendChild(script)
 336     })
 337   }
 338 }