X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=client%2Fsrc%2Fapp%2Fcore%2Fplugins%2Fplugin.service.ts;h=b9d55a7e49ef7fb3c5bd4786f3d2547030c298ba;hb=74c2dece42d387506421623fbfadc83da811ebcd;hp=90ebe56690923b618743f7c8dbe85212119ee924;hpb=7663e55a2cc46a413bceee2787d48902b15ae642;p=github%2FChocobozzz%2FPeerTube.git diff --git a/client/src/app/core/plugins/plugin.service.ts b/client/src/app/core/plugins/plugin.service.ts index 90ebe5669..b9d55a7e4 100644 --- a/client/src/app/core/plugins/plugin.service.ts +++ b/client/src/app/core/plugins/plugin.service.ts @@ -1,17 +1,27 @@ -import { Injectable } from '@angular/core' +import { Inject, Injectable, LOCALE_ID, NgZone } from '@angular/core' import { Router } from '@angular/router' -import { ServerConfigPlugin } from '@shared/models' +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 { RegisterHookOptions } from '@shared/models/plugins/register-hook.model' -import { ReplaySubject } from 'rxjs' -import { first, shareReplay } from 'rxjs/operators' +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' - -interface HookStructValue extends RegisterHookOptions { +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 } @@ -19,36 +29,51 @@ interface HookStructValue extends RegisterHookOptions { 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) + '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 server: ServerService + 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.configLoaded - .subscribe(() => { - this.plugins = this.server.getConfig().plugin.registered + this.server.getConfig() + .subscribe(config => { + this.plugins = config.plugin.registered this.buildScopeStruct() @@ -63,6 +88,8 @@ export class PluginService implements ClientHook { } ensurePluginsAreLoaded (scope: PluginClientScope) { + this.loadPluginsByScope(scope) + return this.pluginsLoaded[scope].asObservable() .pipe(first(), shareReplay()) .toPromise() @@ -83,6 +110,7 @@ export class PluginService implements ClientHook { script: environment.apiUrl + `${pathPrefix}/${plugin.name}/${plugin.version}/client-scripts/${clientScript.script}`, scopes: clientScript.scopes }, + pluginType: isTheme ? PluginType.THEME : PluginType.PLUGIN, isTheme }) @@ -104,6 +132,11 @@ export class PluginService implements ClientHook { } 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() @@ -111,6 +144,7 @@ export class PluginService implements ClientHook { const toLoad = this.scopes[ scope ] if (!Array.isArray(toLoad)) { + this.loadingScopes[scope] = false this.pluginsLoaded[scope].next(true) return @@ -130,31 +164,48 @@ export class PluginService implements ClientHook { 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) } } - async runHook (hookName: ClientHookName, result?: T, params?: any): Promise { - if (!this.hooks[hookName]) return Promise.resolve(result) + runHook (hookName: ClientHookName, result?: T, params?: any): Promise { + return this.zone.runOutsideAngular(async () => { + if (!this.hooks[ hookName ]) return result - const hookType = getHookType(hookName) + const hookType = getHookType(hookName) - for (const hook of this.hooks[hookName]) { - console.log('Running hook %s of plugin %s.', hookName, hook.plugin.name) + 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) - }) - } + 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 + 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: RegisterHookOptions) => { + const registerHook = (options: RegisterClientHookOptions) => { if (clientHookObject[options.target] !== true) { console.error('Unknown hook %s of plugin %s. Skipping.', options.target, plugin.name) return @@ -175,9 +226,12 @@ export class PluginService implements ClientHook { console.log('Loading script %s of plugin %s.', clientScript.script, plugin.name) - return import(/* webpackIgnore: true */ clientScript.script) - .then(script => script.register({ registerHook, peertubeHelpers })) - .then(() => this.sortHooksByPriority()) + 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 () { @@ -194,17 +248,53 @@ export class PluginService implements ClientHook { } } - private buildPeerTubeHelpers (pluginInfo: PluginInfo) { + 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' }