X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=client%2Fsrc%2Fapp%2Fcore%2Fplugins%2Fplugin.service.ts;h=e24468da553f12c653ad6b2a6fa9270df8934355;hb=5dfb7c1dec8222b0bbccac5b56ad46da1438747e;hp=af330c2eb204f617448074a10d163e3a75b058e7;hpb=9fa6ca160a9dda057c3980c6ee19f0ee426fd0a0;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 af330c2eb..e24468da5 100644 --- a/client/src/app/core/plugins/plugin.service.ts +++ b/client/src/app/core/plugins/plugin.service.ts @@ -1,15 +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 { PluginScope } from '@shared/models/plugins/plugin-scope.type' +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' - -interface HookStructValue extends RegisterHookOptions { +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 } from '@app/core/auth' +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 } @@ -17,25 +29,44 @@ interface HookStructValue extends RegisterHookOptions { type PluginInfo = { plugin: ServerConfigPlugin clientScript: ClientScript + pluginType: PluginType isTheme: boolean } @Injectable() -export class PluginService { - pluginsLoaded = new ReplaySubject(1) +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 loadedPlugins: { [ name: string ]: boolean } = {} private loadedScripts: { [ script: string ]: boolean } = {} - private loadedScopes: PluginScope[] = [] + 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 server: ServerService, + private zone: NgZone, + private authHttp: HttpClient, + private restExtractor: RestExtractor, + @Inject(LOCALE_ID) private localeId: string ) { + this.loadTranslations() } initializePlugins () { @@ -45,12 +76,20 @@ export class PluginService { this.buildScopeStruct() - this.pluginsLoaded.next(true) + this.pluginsBuilt.next(true) }) } - ensurePluginsAreLoaded () { - return this.pluginsLoaded.asObservable() + ensurePluginsAreBuilt () { + return this.pluginsBuilt.asObservable() + .pipe(first(), shareReplay()) + .toPromise() + } + + ensurePluginsAreLoaded (scope: PluginClientScope) { + this.loadPluginsByScope(scope) + + return this.pluginsLoaded[scope].asObservable() .pipe(first(), shareReplay()) .toPromise() } @@ -70,6 +109,7 @@ export class PluginService { script: environment.apiUrl + `${pathPrefix}/${plugin.name}/${plugin.version}/client-scripts/${clientScript.script}`, scopes: clientScript.scopes }, + pluginType: isTheme ? PluginType.THEME : PluginType.PLUGIN, isTheme }) @@ -90,14 +130,24 @@ export class PluginService { } } - async loadPluginsByScope (scope: PluginScope, isReload = false) { + 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.ensurePluginsAreLoaded() + await this.ensurePluginsAreBuilt() if (!isReload) this.loadedScopes.push(scope) const toLoad = this.scopes[ scope ] - if (!Array.isArray(toLoad)) return + if (!Array.isArray(toLoad)) { + this.loadingScopes[scope] = false + this.pluginsLoaded[scope].next(true) + + return + } const promises: Promise[] = [] for (const pluginInfo of toLoad) { @@ -111,41 +161,55 @@ export class PluginService { } 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: string, param?: any) { - let result = param + runHook (hookName: ClientHookName, result?: T, params?: any): Promise { + return this.zone.runOutsideAngular(async () => { + if (!this.hooks[ hookName ]) return result - if (!this.hooks[hookName]) return result + const hookType = getHookType(hookName) - const wait = hookName.startsWith('static:') + 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]) { - try { - const p = hook.handler(param) - - if (wait) { - result = await p - } else if (p.catch) { - p.catch((err: Error) => { - console.error('Cannot run hook %s of script %s of plugin %s.', hookName, hook.plugin, hook.clientScript, err) - }) - } - } catch (err) { - console.error('Cannot run hook %s of script %s of plugin %s.', hookName, hook.plugin, hook.clientScript, 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 + } + if (!this.hooks[options.target]) this.hooks[options.target] = [] this.hooks[options.target].push({ @@ -161,9 +225,12 @@ export class PluginService { 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 () { @@ -180,17 +247,51 @@ export class PluginService { } } - 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() + }, + + 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' }