X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=sidebyside;f=client%2Fsrc%2Fapp%2Fcore%2Fplugins%2Fplugin.service.ts;h=89391c2c5d0eda2f915fb5c4124764c1073105a0;hb=9df52d660feb722404be00a50f3c8a612bec1c15;hp=c2dcf9fefd26d62e77ed6abd241e0d5945c1527b;hpb=c713017f3cd2d617da22c24c579342ec4121cfcd;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 c2dcf9fef..89391c2c5 100644 --- a/client/src/app/core/plugins/plugin.service.ts +++ b/client/src/app/core/plugins/plugin.service.ts @@ -1,5 +1,5 @@ -import { Observable, of, ReplaySubject } from 'rxjs' -import { catchError, first, map, shareReplay } from 'rxjs/operators' +import { firstValueFrom, Observable, of } from 'rxjs' +import { catchError, map, shareReplay } from 'rxjs/operators' import { HttpClient } from '@angular/common/http' import { Inject, Injectable, LOCALE_ID, NgZone } from '@angular/core' import { VideoEditType } from '@app/+videos/+video-edit/shared/video-edit.type' @@ -10,7 +10,7 @@ import { RestExtractor } from '@app/core/rest' import { ServerService } from '@app/core/server/server.service' import { getDevLocale, isOnDevLocale } from '@app/helpers' import { CustomModalComponent } from '@app/modal/custom-modal.component' -import { FormFields, Hooks, loadPlugin, PluginInfo, runHook } from '@root-helpers/plugins' +import { PluginInfo, PluginsManager } from '@root-helpers/plugins-manager' import { getCompleteLocale, isDefaultLocale, peertubeTranslate } from '@shared/core-utils/i18n' import { ClientHook, @@ -19,45 +19,38 @@ import { PluginTranslation, PluginType, PublicServerSetting, + RegisterClientFormFieldOptions, + RegisterClientSettingsScript, + RegisterClientVideoFieldOptions, ServerConfigPlugin } from '@shared/models' import { environment } from '../../../environments/environment' import { RegisterClientHelpers } from '../../../types/register-client-option.model' +type FormFields = { + video: { + commonOptions: RegisterClientFormFieldOptions + videoFormOptions: RegisterClientVideoFieldOptions + }[] +} + @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), - login: new ReplaySubject(1), - 'video-edit': new ReplaySubject(1), - embed: new ReplaySubject(1) - } - translationsObservable: Observable customModal: CustomModalComponent - private plugins: ServerConfigPlugin[] = [] private helpers: { [ npmName: string ]: RegisterClientHelpers } = {} - private scopes: { [ scopeName: string ]: PluginInfo[] } = {} - - private loadedScripts: { [ script: string ]: boolean } = {} - private loadedScopes: PluginClientScope[] = [] - private loadingScopes: { [id in PluginClientScope]?: boolean } = {} - - private hooks: Hooks = {} private formFields: FormFields = { video: [] } + private settingsScripts: { [ npmName: string ]: RegisterClientSettingsScript } = {} + + private pluginsManager: PluginsManager constructor ( private authService: AuthService, @@ -70,116 +63,48 @@ export class PluginService implements ClientHook { @Inject(LOCALE_ID) private localeId: string ) { this.loadTranslations() + + this.pluginsManager = new PluginsManager({ + peertubeHelpersFactory: this.buildPeerTubeHelpers.bind(this), + onFormFields: this.onFormFields.bind(this), + onSettingsScripts: this.onSettingsScripts.bind(this) + }) } initializePlugins () { - this.server.getConfig() - .subscribe(config => { - this.plugins = config.plugin.registered - - this.buildScopeStruct() + this.pluginsManager.loadPluginsList(this.server.getHTMLConfig()) - this.pluginsBuilt.next(true) - }) + this.pluginsManager.ensurePluginsAreLoaded('common') } initializeCustomModal (customModal: CustomModalComponent) { this.customModal = customModal } - ensurePluginsAreBuilt () { - return this.pluginsBuilt.asObservable() - .pipe(first(), shareReplay()) - .toPromise() + runHook (hookName: ClientHookName, result?: T, params?: any): Promise { + return this.zone.runOutsideAngular(() => { + return this.pluginsManager.runHook(hookName, result, params) + }) } ensurePluginsAreLoaded (scope: PluginClientScope) { - this.loadPluginsByScope(scope) - - return this.pluginsLoaded[scope].asObservable() - .pipe(first(), shareReplay()) - .toPromise() + return this.pluginsManager.ensurePluginsAreLoaded(scope) } - 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: `${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) - } + reloadLoadedScopes () { + return this.pluginsManager.reloadLoadedScopes() } - async reloadLoadedScopes () { - for (const scope of this.loadedScopes) { - await this.loadPluginsByScope(scope, true) - } + getPluginsManager () { + return this.pluginsManager } - 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) - } + addPlugin (plugin: ServerConfigPlugin, isTheme = false) { + return this.pluginsManager.addPlugin(plugin, isTheme) } - runHook (hookName: ClientHookName, result?: T, params?: any): Promise { - return this.zone.runOutsideAngular(() => { - return runHook(this.hooks, hookName, result, params) - }) + removePlugin (plugin: ServerConfigPlugin) { + return this.pluginsManager.removePlugin(plugin) } nameToNpmName (name: string, type: PluginType) { @@ -190,16 +115,14 @@ export class PluginService implements ClientHook { return prefix + name } - pluginTypeFromNpmName (npmName: string) { - return npmName.startsWith('peertube-plugin-') - ? PluginType.PLUGIN - : PluginType.THEME - } - getRegisteredVideoFormFields (type: VideoEditType) { return this.formFields.video.filter(f => f.videoFormOptions.type === type) } + getRegisteredSettingsScript (npmName: string) { + return this.settingsScripts[npmName] + } + translateBy (npmName: string, toTranslate: string) { const helpers = this.helpers[npmName] if (!helpers) { @@ -210,26 +133,17 @@ export class PluginService implements ClientHook { return helpers.translate(toTranslate) } - private loadPlugin (pluginInfo: PluginInfo) { - return this.zone.runOutsideAngular(() => { - const npmName = this.nameToNpmName(pluginInfo.plugin.name, pluginInfo.pluginType) - - const helpers = this.buildPeerTubeHelpers(pluginInfo) - this.helpers[npmName] = helpers - - return loadPlugin({ - hooks: this.hooks, - formFields: this.formFields, - pluginInfo, - peertubeHelpersFactory: () => helpers - }) + private onFormFields (commonOptions: RegisterClientFormFieldOptions, videoFormOptions: RegisterClientVideoFieldOptions) { + this.formFields.video.push({ + commonOptions, + videoFormOptions }) } - private buildScopeStruct () { - for (const plugin of this.plugins) { - this.addPlugin(plugin) - } + private onSettingsScripts (pluginInfo: PluginInfo, options: RegisterClientSettingsScript) { + const npmName = this.nameToNpmName(pluginInfo.plugin.name, pluginInfo.pluginType) + + this.settingsScripts[npmName] = options } private buildPeerTubeHelpers (pluginInfo: PluginInfo): RegisterClientHelpers { @@ -238,45 +152,59 @@ export class PluginService implements ClientHook { return { getBaseStaticRoute: () => { - const pathPrefix = this.getPluginPathPrefix(pluginInfo.isTheme) + const pathPrefix = PluginsManager.getPluginPathPrefix(pluginInfo.isTheme) return environment.apiUrl + `${pathPrefix}/${plugin.name}/${plugin.version}/static` }, + getBaseRouterRoute: () => { + const pathPrefix = PluginsManager.getPluginPathPrefix(pluginInfo.isTheme) + return environment.apiUrl + `${pathPrefix}/${plugin.name}/${plugin.version}/router` + }, + getSettings: () => { const path = PluginService.BASE_PLUGIN_API_URL + '/' + npmName + '/public-settings' - return this.authHttp.get(path) + const obs = this.authHttp.get(path) .pipe( map(p => p.publicSettings), catchError(res => this.restExtractor.handleError(res)) ) - .toPromise() + + return firstValueFrom(obs) }, getServerConfig: () => { - return this.server.getConfig() + const obs = this.server.getConfig() .pipe(catchError(res => this.restExtractor.handleError(res))) - .toPromise() + + return firstValueFrom(obs) }, isLoggedIn: () => { return this.authService.isLoggedIn() }, + getAuthHeader: () => { + if (!this.authService.isLoggedIn()) return undefined + + const value = this.authService.getRequestHeaderValue() + return { Authorization: value } + }, + notifier: { - info: (text: string, title?: string, timeout?: number) => this.notifier.info(text, title, timeout), - error: (text: string, title?: string, timeout?: number) => this.notifier.error(text, title, timeout), - success: (text: string, title?: string, timeout?: number) => this.notifier.success(text, title, timeout) + info: (text: string, title?: string, timeout?: number) => this.zone.run(() => this.notifier.info(text, title, timeout)), + error: (text: string, title?: string, timeout?: number) => this.zone.run(() => this.notifier.error(text, title, timeout)), + success: (text: string, title?: string, timeout?: number) => this.zone.run(() => this.notifier.success(text, title, timeout)) }, showModal: (input: { - title: string, - content: string, - close?: boolean, - cancel?: { value: string, action?: () => void }, + title: string + content: string + close?: boolean + cancel?: { value: string, action?: () => void } confirm?: { value: string, action?: () => void } }) => { - this.customModal.show(input) + this.zone.run(() => this.customModal.show(input)) }, markdownRenderer: { @@ -290,10 +218,11 @@ export class PluginService implements ClientHook { }, translate: (value: string) => { - return this.translationsObservable + const obs = this.translationsObservable .pipe(map(allTranslations => allTranslations[npmName])) .pipe(map(translations => peertubeTranslate(value, translations))) - .toPromise() + + return firstValueFrom(obs) } } } @@ -308,8 +237,4 @@ export class PluginService implements ClientHook { .get(PluginService.BASE_PLUGIN_URL + '/translations/' + completeLocale + '.json') .pipe(shareReplay()) } - - private getPluginPathPrefix (isTheme: boolean) { - return isTheme ? '/themes' : '/plugins' - } }