import { Inject, Injectable, LOCALE_ID, NgZone } from '@angular/core' import { Router } from '@angular/router' import { getCompleteLocale, isDefaultLocale, peertubeTranslate, ServerConfigPlugin } from '@shared/models' import { ServerService } from '@app/core/server/server.service' import { ClientScript } from '@shared/models/plugins/plugin-package-json.model' import { ClientScript as ClientScriptModule } from '../../../types/client-script.model' import { environment } from '../../../environments/environment' import { Observable, of, ReplaySubject } from 'rxjs' import { catchError, first, map, shareReplay } from 'rxjs/operators' import { getHookType, internalRunHook } from '@shared/core-utils/plugins/hooks' import { ClientHook, ClientHookName, clientHookObject } from '@shared/models/plugins/client-hook.model' import { PluginClientScope } from '@shared/models/plugins/plugin-client-scope.type' import { RegisterClientHookOptions } from '@shared/models/plugins/register-client-hook.model' import { HttpClient } from '@angular/common/http' import { AuthService, Notifier } from '@app/core' import { RestExtractor } from '@app/shared/rest' import { PluginType } from '@shared/models/plugins/plugin.type' import { PublicServerSetting } from '@shared/models/plugins/public-server.setting' import { getDevLocale, isOnDevLocale } from '@app/shared/i18n/i18n-utils' import { RegisterClientHelpers } from '../../../types/register-client-option.model' import { PluginTranslation } from '@shared/models/plugins/plugin-translation.model' import { importModule } from '@app/shared/misc/utils' interface HookStructValue extends RegisterClientHookOptions { plugin: ServerConfigPlugin clientScript: ClientScript } type PluginInfo = { plugin: ServerConfigPlugin clientScript: ClientScript pluginType: PluginType isTheme: boolean } @Injectable() export class PluginService implements ClientHook { private static BASE_PLUGIN_API_URL = environment.apiUrl + '/api/v1/plugins' private static BASE_PLUGIN_URL = environment.apiUrl + '/plugins' pluginsBuilt = new ReplaySubject(1) pluginsLoaded: { [ scope in PluginClientScope ]: ReplaySubject } = { common: new ReplaySubject(1), search: new ReplaySubject(1), 'video-watch': new ReplaySubject(1), signup: new ReplaySubject(1) } translationsObservable: Observable private plugins: ServerConfigPlugin[] = [] private scopes: { [ scopeName: string ]: PluginInfo[] } = {} private loadedScripts: { [ script: string ]: boolean } = {} private loadedScopes: PluginClientScope[] = [] private loadingScopes: { [id in PluginClientScope]?: boolean } = {} private hooks: { [ name: string ]: HookStructValue[] } = {} constructor ( private router: Router, private authService: AuthService, private notifier: Notifier, private server: ServerService, private zone: NgZone, private authHttp: HttpClient, private restExtractor: RestExtractor, @Inject(LOCALE_ID) private localeId: string ) { this.loadTranslations() } initializePlugins () { this.server.getConfig() .subscribe(config => { this.plugins = config.plugin.registered this.buildScopeStruct() this.pluginsBuilt.next(true) }) } ensurePluginsAreBuilt () { return this.pluginsBuilt.asObservable() .pipe(first(), shareReplay()) .toPromise() } ensurePluginsAreLoaded (scope: PluginClientScope) { this.loadPluginsByScope(scope) return this.pluginsLoaded[scope].asObservable() .pipe(first(), shareReplay()) .toPromise() } addPlugin (plugin: ServerConfigPlugin, isTheme = false) { const pathPrefix = this.getPluginPathPrefix(isTheme) for (const key of Object.keys(plugin.clientScripts)) { const clientScript = plugin.clientScripts[key] for (const scope of clientScript.scopes) { if (!this.scopes[scope]) this.scopes[scope] = [] this.scopes[scope].push({ plugin, clientScript: { script: environment.apiUrl + `${pathPrefix}/${plugin.name}/${plugin.version}/client-scripts/${clientScript.script}`, scopes: clientScript.scopes }, pluginType: isTheme ? PluginType.THEME : PluginType.PLUGIN, isTheme }) this.loadedScripts[clientScript.script] = false } } } removePlugin (plugin: ServerConfigPlugin) { for (const key of Object.keys(this.scopes)) { this.scopes[key] = this.scopes[key].filter(o => o.plugin.name !== plugin.name) } } async reloadLoadedScopes () { for (const scope of this.loadedScopes) { await this.loadPluginsByScope(scope, true) } } async loadPluginsByScope (scope: PluginClientScope, isReload = false) { if (this.loadingScopes[scope]) return if (!isReload && this.loadedScopes.includes(scope)) return this.loadingScopes[scope] = true try { await this.ensurePluginsAreBuilt() if (!isReload) this.loadedScopes.push(scope) const toLoad = this.scopes[ scope ] if (!Array.isArray(toLoad)) { this.loadingScopes[scope] = false this.pluginsLoaded[scope].next(true) return } const promises: Promise[] = [] for (const pluginInfo of toLoad) { const clientScript = pluginInfo.clientScript if (this.loadedScripts[ clientScript.script ]) continue promises.push(this.loadPlugin(pluginInfo)) this.loadedScripts[ clientScript.script ] = true } await Promise.all(promises) this.pluginsLoaded[scope].next(true) this.loadingScopes[scope] = false } catch (err) { console.error('Cannot load plugins by scope %s.', scope, err) } } runHook (hookName: ClientHookName, result?: T, params?: any): Promise { return this.zone.runOutsideAngular(async () => { if (!this.hooks[ hookName ]) return result const hookType = getHookType(hookName) for (const hook of this.hooks[ hookName ]) { console.log('Running hook %s of plugin %s.', hookName, hook.plugin.name) result = await internalRunHook(hook.handler, hookType, result, params, err => { console.error('Cannot run hook %s of script %s of plugin %s.', hookName, hook.clientScript.script, hook.plugin.name, err) }) } return result }) } nameToNpmName (name: string, type: PluginType) { const prefix = type === PluginType.PLUGIN ? 'peertube-plugin-' : 'peertube-theme-' return prefix + name } pluginTypeFromNpmName (npmName: string) { return npmName.startsWith('peertube-plugin-') ? PluginType.PLUGIN : PluginType.THEME } private loadPlugin (pluginInfo: PluginInfo) { const { plugin, clientScript } = pluginInfo const registerHook = (options: RegisterClientHookOptions) => { if (clientHookObject[options.target] !== true) { console.error('Unknown hook %s of plugin %s. Skipping.', options.target, plugin.name) return } if (!this.hooks[options.target]) this.hooks[options.target] = [] this.hooks[options.target].push({ plugin, clientScript, target: options.target, handler: options.handler, priority: options.priority || 0 }) } const peertubeHelpers = this.buildPeerTubeHelpers(pluginInfo) console.log('Loading script %s of plugin %s.', clientScript.script, plugin.name) return this.zone.runOutsideAngular(() => { return importModule(clientScript.script) .then((script: ClientScriptModule) => script.register({ registerHook, peertubeHelpers })) .then(() => this.sortHooksByPriority()) .catch(err => console.error('Cannot import or register plugin %s.', pluginInfo.plugin.name, err)) }) } private buildScopeStruct () { for (const plugin of this.plugins) { this.addPlugin(plugin) } } private sortHooksByPriority () { for (const hookName of Object.keys(this.hooks)) { this.hooks[hookName].sort((a, b) => { return b.priority - a.priority }) } } private buildPeerTubeHelpers (pluginInfo: PluginInfo): RegisterClientHelpers { const { plugin } = pluginInfo const npmName = this.nameToNpmName(pluginInfo.plugin.name, pluginInfo.pluginType) return { getBaseStaticRoute: () => { const pathPrefix = this.getPluginPathPrefix(pluginInfo.isTheme) return environment.apiUrl + `${pathPrefix}/${plugin.name}/${plugin.version}/static` }, getSettings: () => { const path = PluginService.BASE_PLUGIN_API_URL + '/' + npmName + '/public-settings' return this.authHttp.get(path) .pipe( map(p => p.publicSettings), catchError(res => this.restExtractor.handleError(res)) ) .toPromise() }, isLoggedIn: () => { return this.authService.isLoggedIn() }, notifier: this.notifier, translate: (value: string) => { return this.translationsObservable .pipe(map(allTranslations => allTranslations[npmName])) .pipe(map(translations => peertubeTranslate(value, translations))) .toPromise() } } } private loadTranslations () { const completeLocale = isOnDevLocale() ? getDevLocale() : getCompleteLocale(this.localeId) // Default locale, nothing to translate if (isDefaultLocale(completeLocale)) this.translationsObservable = of({}).pipe(shareReplay()) this.translationsObservable = this.authHttp .get(PluginService.BASE_PLUGIN_URL + '/translations/' + completeLocale + '.json') .pipe(shareReplay()) } private getPluginPathPrefix (isTheme: boolean) { return isTheme ? '/themes' : '/plugins' } }