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