client/src/app/core/plugins/plugin.service.ts

   1 import { Injectable, NgZone } from '@angular/core'
   2 import { Router } from '@angular/router'
   3 import { ServerConfigPlugin } from '@shared/models'
   4 import { ServerService } from '@app/core/server/server.service'
   5 import { ClientScript } from '@shared/models/plugins/plugin-package-json.model'
   6 import { ClientScript as ClientScriptModule } from '../../../types/client-script.model'
   7 import { environment } from '../../../environments/environment'
   8 import { ReplaySubject } from 'rxjs'
   9 import { catchError, first, map, shareReplay } from 'rxjs/operators'
  10 import { getHookType, internalRunHook } from '@shared/core-utils/plugins/hooks'
  11 import { ClientHook, ClientHookName, clientHookObject } from '@shared/models/plugins/client-hook.model'
  12 import { PluginClientScope } from '@shared/models/plugins/plugin-client-scope.type'
  13 import { RegisterClientHookOptions } from '@shared/models/plugins/register-client-hook.model'
  14 import { HttpClient } from '@angular/common/http'
  15 import { RestExtractor } from '@app/shared/rest'
  16 import { PluginType } from '@shared/models/plugins/plugin.type'
  17 import { PublicServerSetting } from '@shared/models/plugins/public-server.setting'
  18
  19 interface HookStructValue extends RegisterClientHookOptions {
  20   plugin: ServerConfigPlugin
  21   clientScript: ClientScript
  22 }
  23
  24 type PluginInfo = {
  25   plugin: ServerConfigPlugin
  26   clientScript: ClientScript
  27   pluginType: PluginType
  28   isTheme: boolean
  29 }
  30
  31 @Injectable()
  32 export class PluginService implements ClientHook {
  33   private static BASE_PLUGIN_URL = environment.apiUrl + '/api/v1/plugins'
  34
  35   pluginsBuilt = new ReplaySubject<boolean>(1)
  36
  37   pluginsLoaded: { [ scope in PluginClientScope ]: ReplaySubject<boolean> } = {
  38     common: new ReplaySubject<boolean>(1),
  39     search: new ReplaySubject<boolean>(1),
  40     'video-watch': new ReplaySubject<boolean>(1)
  41   }
  42
  43   private plugins: ServerConfigPlugin[] = []
  44   private scopes: { [ scopeName: string ]: PluginInfo[] } = {}
  45   private loadedScripts: { [ script: string ]: boolean } = {}
  46   private loadedScopes: PluginClientScope[] = []
  47   private loadingScopes: { [id in PluginClientScope]?: boolean } = {}
  48
  49   private hooks: { [ name: string ]: HookStructValue[] } = {}
  50
  51   constructor (
  52     private router: Router,
  53     private server: ServerService,
  54     private zone: NgZone,
  55     private authHttp: HttpClient,
  56     private restExtractor: RestExtractor
  57   ) {
  58   }
  59
  60   initializePlugins () {
  61     this.server.configLoaded
  62       .subscribe(() => {
  63         this.plugins = this.server.getConfig().plugin.registered
  64
  65         this.buildScopeStruct()
  66
  67         this.pluginsBuilt.next(true)
  68       })
  69   }
  70
  71   ensurePluginsAreBuilt () {
  72     return this.pluginsBuilt.asObservable()
  73                .pipe(first(), shareReplay())
  74                .toPromise()
  75   }
  76
  77   ensurePluginsAreLoaded (scope: PluginClientScope) {
  78     this.loadPluginsByScope(scope)
  79
  80     return this.pluginsLoaded[scope].asObservable()
  81                .pipe(first(), shareReplay())
  82                .toPromise()
  83   }
  84
  85   addPlugin (plugin: ServerConfigPlugin, isTheme = false) {
  86     const pathPrefix = this.getPluginPathPrefix(isTheme)
  87
  88     for (const key of Object.keys(plugin.clientScripts)) {
  89       const clientScript = plugin.clientScripts[key]
  90
  91       for (const scope of clientScript.scopes) {
  92         if (!this.scopes[scope]) this.scopes[scope] = []
  93
  94         this.scopes[scope].push({
  95           plugin,
  96           clientScript: {
  97             script: environment.apiUrl + `${pathPrefix}/${plugin.name}/${plugin.version}/client-scripts/${clientScript.script}`,
  98             scopes: clientScript.scopes
  99           },
 100           pluginType: isTheme ? PluginType.THEME : PluginType.PLUGIN,
 101           isTheme
 102         })
 103
 104         this.loadedScripts[clientScript.script] = false
 105       }
 106     }
 107   }
 108
 109   removePlugin (plugin: ServerConfigPlugin) {
 110     for (const key of Object.keys(this.scopes)) {
 111       this.scopes[key] = this.scopes[key].filter(o => o.plugin.name !== plugin.name)
 112     }
 113   }
 114
 115   async reloadLoadedScopes () {
 116     for (const scope of this.loadedScopes) {
 117       await this.loadPluginsByScope(scope, true)
 118     }
 119   }
 120
 121   async loadPluginsByScope (scope: PluginClientScope, isReload = false) {
 122     if (this.loadingScopes[scope]) return
 123     if (!isReload && this.loadedScopes.includes(scope)) return
 124
 125     this.loadingScopes[scope] = true
 126
 127     try {
 128       await this.ensurePluginsAreBuilt()
 129
 130       if (!isReload) this.loadedScopes.push(scope)
 131
 132       const toLoad = this.scopes[ scope ]
 133       if (!Array.isArray(toLoad)) {
 134         this.loadingScopes[scope] = false
 135         this.pluginsLoaded[scope].next(true)
 136
 137         return
 138       }
 139
 140       const promises: Promise<any>[] = []
 141       for (const pluginInfo of toLoad) {
 142         const clientScript = pluginInfo.clientScript
 143
 144         if (this.loadedScripts[ clientScript.script ]) continue
 145
 146         promises.push(this.loadPlugin(pluginInfo))
 147
 148         this.loadedScripts[ clientScript.script ] = true
 149       }
 150
 151       await Promise.all(promises)
 152
 153       this.pluginsLoaded[scope].next(true)
 154       this.loadingScopes[scope] = false
 155     } catch (err) {
 156       console.error('Cannot load plugins by scope %s.', scope, err)
 157     }
 158   }
 159
 160   runHook <T> (hookName: ClientHookName, result?: T, params?: any): Promise<T> {
 161     return this.zone.runOutsideAngular(async () => {
 162       if (!this.hooks[ hookName ]) return result
 163
 164       const hookType = getHookType(hookName)
 165
 166       for (const hook of this.hooks[ hookName ]) {
 167         console.log('Running hook %s of plugin %s.', hookName, hook.plugin.name)
 168
 169         result = await internalRunHook(hook.handler, hookType, result, params, err => {
 170           console.error('Cannot run hook %s of script %s of plugin %s.', hookName, hook.clientScript.script, hook.plugin.name, err)
 171         })
 172       }
 173
 174       return result
 175     })
 176   }
 177
 178   nameToNpmName (name: string, type: PluginType) {
 179     const prefix = type === PluginType.PLUGIN
 180       ? 'peertube-plugin-'
 181       : 'peertube-theme-'
 182
 183     return prefix + name
 184   }
 185
 186   pluginTypeFromNpmName (npmName: string) {
 187     return npmName.startsWith('peertube-plugin-')
 188       ? PluginType.PLUGIN
 189       : PluginType.THEME
 190   }
 191
 192   private loadPlugin (pluginInfo: PluginInfo) {
 193     const { plugin, clientScript } = pluginInfo
 194
 195     const registerHook = (options: RegisterClientHookOptions) => {
 196       if (clientHookObject[options.target] !== true) {
 197         console.error('Unknown hook %s of plugin %s. Skipping.', options.target, plugin.name)
 198         return
 199       }
 200
 201       if (!this.hooks[options.target]) this.hooks[options.target] = []
 202
 203       this.hooks[options.target].push({
 204         plugin,
 205         clientScript,
 206         target: options.target,
 207         handler: options.handler,
 208         priority: options.priority || 0
 209       })
 210     }
 211
 212     const peertubeHelpers = this.buildPeerTubeHelpers(pluginInfo)
 213
 214     console.log('Loading script %s of plugin %s.', clientScript.script, plugin.name)
 215
 216     return this.zone.runOutsideAngular(() => {
 217       return import(/* webpackIgnore: true */ clientScript.script)
 218         .then((script: ClientScriptModule) => script.register({ registerHook, peertubeHelpers }))
 219         .then(() => this.sortHooksByPriority())
 220         .catch(err => console.error('Cannot import or register plugin %s.', pluginInfo.plugin.name, err))
 221     })
 222   }
 223
 224   private buildScopeStruct () {
 225     for (const plugin of this.plugins) {
 226       this.addPlugin(plugin)
 227     }
 228   }
 229
 230   private sortHooksByPriority () {
 231     for (const hookName of Object.keys(this.hooks)) {
 232       this.hooks[hookName].sort((a, b) => {
 233         return b.priority - a.priority
 234       })
 235     }
 236   }
 237
 238   private buildPeerTubeHelpers (pluginInfo: PluginInfo) {
 239     const { plugin } = pluginInfo
 240
 241     return {
 242       getBaseStaticRoute: () => {
 243         const pathPrefix = this.getPluginPathPrefix(pluginInfo.isTheme)
 244         return environment.apiUrl + `${pathPrefix}/${plugin.name}/${plugin.version}/static`
 245       },
 246
 247       getSettings: () => {
 248         const npmName = this.nameToNpmName(pluginInfo.plugin.name, pluginInfo.pluginType)
 249         const path = PluginService.BASE_PLUGIN_URL + '/' + npmName + '/public-settings'
 250
 251         return this.authHttp.get<PublicServerSetting>(path)
 252                    .pipe(
 253                      map(p => p.publicSettings),
 254                      catchError(res => this.restExtractor.handleError(res))
 255                    )
 256                    .toPromise()
 257       }
 258     }
 259   }
 260
 261   private getPluginPathPrefix (isTheme: boolean) {
 262     return isTheme ? '/themes' : '/plugins'
 263   }
 264 }