-import { Injectable } from '@angular/core'
-import { Router } from '@angular/router'
-import { ServerConfigPlugin } from '@shared/models'
+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'
+import { AuthService } from '@app/core/auth'
+import { Notifier } from '@app/core/notification'
+import { MarkdownService } from '@app/core/renderer'
+import { RestExtractor } from '@app/core/rest'
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 { getDevLocale, isOnDevLocale } from '@app/helpers'
+import { CustomModalComponent } from '@app/modal/custom-modal.component'
+import { PluginInfo, PluginsManager } from '@root-helpers/plugins-manager'
+import { getKeys } from '@shared/core-utils'
+import { getCompleteLocale, isDefaultLocale, peertubeTranslate } from '@shared/core-utils/i18n'
+import {
+ ClientHook,
+ ClientHookName,
+ PluginClientScope,
+ PluginTranslation,
+ PluginType,
+ PublicServerSetting,
+ RegisterClientFormFieldOptions,
+ RegisterClientRouteOptions,
+ RegisterClientSettingsScriptOptions,
+ RegisterClientVideoFieldOptions,
+ ServerConfigPlugin
+} from '@shared/models'
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 {
- plugin: ServerConfigPlugin
- clientScript: ClientScript
+import { RegisterClientHelpers } from '../../../types/register-client-option.model'
+
+type FormFields = {
+ video: {
+ pluginInfo: PluginInfo
+ commonOptions: RegisterClientFormFieldOptions
+ videoFormOptions: RegisterClientVideoFieldOptions
+ }[]
}
@Injectable()
-export class PluginService {
- pluginsLoaded = new ReplaySubject<boolean>(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'
+
+ translationsObservable: Observable<PluginTranslation>
- private plugins: ServerConfigPlugin[] = []
- private scopes: { [ scopeName: string ]: { plugin: ServerConfigPlugin, clientScript: ClientScript }[] } = {}
- private loadedScripts: { [ script: string ]: boolean } = {}
- private loadedScopes: PluginScope[] = []
+ customModal: CustomModalComponent
- private hooks: { [ name: string ]: HookStructValue[] } = {}
+ private formFields: FormFields = {
+ video: []
+ }
+ private settingsScripts: { [ npmName: string ]: RegisterClientSettingsScriptOptions } = {}
+ private clientRoutes: { [ route: string ]: RegisterClientRouteOptions } = {}
+
+ private pluginsManager: PluginsManager
constructor (
- private router: Router,
- private server: ServerService
+ private authService: AuthService,
+ private notifier: Notifier,
+ private markdownRenderer: MarkdownService,
+ private server: ServerService,
+ private zone: NgZone,
+ private authHttp: HttpClient,
+ private restExtractor: RestExtractor,
+ @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),
+ onClientRoute: this.onClientRoute.bind(this)
+ })
}
initializePlugins () {
- this.server.configLoaded
- .subscribe(() => {
- this.plugins = this.server.getConfig().plugin.registered
-
- this.buildScopeStruct()
+ this.pluginsManager.loadPluginsList(this.server.getHTMLConfig())
- this.pluginsLoaded.next(true)
- })
+ this.pluginsManager.ensurePluginsAreLoaded('common')
}
- ensurePluginsAreLoaded () {
- return this.pluginsLoaded.asObservable()
- .pipe(first(), shareReplay())
- .toPromise()
+ initializeCustomModal (customModal: CustomModalComponent) {
+ this.customModal = customModal
}
- addPlugin (plugin: ServerConfigPlugin, isTheme = false) {
- const pathPrefix = isTheme ? '/themes' : '/plugins'
+ runHook <T> (hookName: ClientHookName, result?: T, params?: any): Promise<T> {
+ return this.zone.runOutsideAngular(() => {
+ return this.pluginsManager.runHook(hookName, result, params)
+ })
+ }
- for (const key of Object.keys(plugin.clientScripts)) {
- const clientScript = plugin.clientScripts[key]
+ ensurePluginsAreLoaded (scope: PluginClientScope) {
+ return this.pluginsManager.ensurePluginsAreLoaded(scope)
+ }
- for (const scope of clientScript.scopes) {
- if (!this.scopes[scope]) this.scopes[scope] = []
+ reloadLoadedScopes () {
+ return this.pluginsManager.reloadLoadedScopes()
+ }
- this.scopes[scope].push({
- plugin,
- clientScript: {
- script: environment.apiUrl + `${pathPrefix}/${plugin.name}/${plugin.version}/client-scripts/${clientScript.script}`,
- scopes: clientScript.scopes
- }
- })
+ getPluginsManager () {
+ return this.pluginsManager
+ }
- this.loadedScripts[clientScript.script] = false
- }
- }
+ addPlugin (plugin: ServerConfigPlugin, isTheme = false) {
+ return this.pluginsManager.addPlugin(plugin, isTheme)
}
removePlugin (plugin: ServerConfigPlugin) {
- for (const key of Object.keys(this.scopes)) {
- this.scopes[key] = this.scopes[key].filter(o => o.plugin.name !== plugin.name)
- }
+ return this.pluginsManager.removePlugin(plugin)
}
- async reloadLoadedScopes () {
- for (const scope of this.loadedScopes) {
- await this.loadPluginsByScope(scope)
- }
+ nameToNpmName (name: string, type: PluginType) {
+ const prefix = type === PluginType.PLUGIN
+ ? 'peertube-plugin-'
+ : 'peertube-theme-'
+
+ return prefix + name
+ }
+
+ getRegisteredVideoFormFields (type: VideoEditType) {
+ return this.formFields.video.filter(f => f.videoFormOptions.type === type)
}
- async loadPluginsByScope (scope: PluginScope) {
- try {
- await this.ensurePluginsAreLoaded()
+ getRegisteredSettingsScript (npmName: string) {
+ return this.settingsScripts[npmName]
+ }
- this.loadedScopes.push(scope)
+ getRegisteredClientRoute (route: string) {
+ return this.clientRoutes[route]
+ }
- const toLoad = this.scopes[ scope ]
- if (!Array.isArray(toLoad)) return
+ getAllRegisteredClientRoutes () {
+ return Object.keys(this.clientRoutes)
+ }
- const promises: Promise<any>[] = []
- for (const { plugin, clientScript } of toLoad) {
- if (this.loadedScripts[ clientScript.script ]) continue
+ async translateSetting (npmName: string, setting: RegisterClientFormFieldOptions) {
+ for (const key of getKeys(setting, [ 'label', 'html', 'descriptionHTML' ])) {
+ if (setting[key]) setting[key] = await this.translateBy(npmName, setting[key])
+ }
- promises.push(this.loadPlugin(plugin, clientScript))
+ if (Array.isArray(setting.options)) {
+ const newOptions = []
- this.loadedScripts[ clientScript.script ] = true
+ for (const o of setting.options) {
+ newOptions.push({
+ value: o.value,
+ label: await this.translateBy(npmName, o.label)
+ })
}
- await Promise.all(promises)
- } catch (err) {
- console.error('Cannot load plugins by scope %s.', scope, err)
+ setting.options = newOptions
}
}
- async runHook (hookName: string, param?: any) {
- let result = param
-
- const wait = hookName.startsWith('static:')
-
- for (const hook of this.hooks[hookName]) {
- try {
- if (wait) result = await hook.handler(param)
- else result = hook.handler()
- } catch (err) {
- console.error('Cannot run hook %s of script %s of plugin %s.', hookName, hook.plugin, hook.clientScript, err)
- }
- }
+ translateBy (npmName: string, toTranslate: string) {
+ const obs = this.translationsObservable
+ .pipe(
+ map(allTranslations => allTranslations[npmName]),
+ map(translations => peertubeTranslate(toTranslate, translations))
+ )
- return result
+ return firstValueFrom(obs)
}
- private loadPlugin (plugin: ServerConfigPlugin, clientScript: ClientScript) {
- const registerHook = (options: RegisterHookOptions) => {
- if (!this.hooks[options.target]) this.hooks[options.target] = []
+ private onFormFields (
+ pluginInfo: PluginInfo,
+ commonOptions: RegisterClientFormFieldOptions,
+ videoFormOptions: RegisterClientVideoFieldOptions
+ ) {
+ this.formFields.video.push({
+ pluginInfo,
+ commonOptions,
+ videoFormOptions
+ })
+ }
- this.hooks[options.target].push({
- plugin,
- clientScript,
- target: options.target,
- handler: options.handler,
- priority: options.priority || 0
- })
- }
+ private onSettingsScripts (pluginInfo: PluginInfo, options: RegisterClientSettingsScriptOptions) {
+ this.settingsScripts[pluginInfo.plugin.npmName] = options
+ }
- console.log('Loading script %s of plugin %s.', clientScript.script, plugin.name)
+ private onClientRoute (options: RegisterClientRouteOptions) {
+ const route = options.route.startsWith('/')
+ ? options.route
+ : `/${options.route}`
- return import(/* webpackIgnore: true */ clientScript.script)
- .then(script => script.register({ registerHook }))
- .then(() => this.sortHooksByPriority())
+ this.clientRoutes[route] = options
}
- private buildScopeStruct () {
- for (const plugin of this.plugins) {
- this.addPlugin(plugin)
+ private buildPeerTubeHelpers (pluginInfo: PluginInfo): RegisterClientHelpers {
+ const { plugin } = pluginInfo
+ const npmName = pluginInfo.plugin.npmName
+
+ return {
+ getBaseStaticRoute: () => {
+ 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`
+ },
+
+ getBaseWebSocketRoute: () => {
+ const pathPrefix = PluginsManager.getPluginPathPrefix(pluginInfo.isTheme)
+ return environment.apiUrl + `${pathPrefix}/${plugin.name}/${plugin.version}/ws`
+ },
+
+ getBasePluginClientPath: () => {
+ return '/p'
+ },
+
+ getSettings: () => {
+ const path = PluginService.BASE_PLUGIN_API_URL + '/' + npmName + '/public-settings'
+
+ const obs = this.authHttp.get<PublicServerSetting>(path)
+ .pipe(
+ map(p => p.publicSettings),
+ catchError(res => this.restExtractor.handleError(res))
+ )
+
+ return firstValueFrom(obs)
+ },
+
+ getServerConfig: () => {
+ const obs = this.server.getConfig()
+ .pipe(catchError(res => this.restExtractor.handleError(res)))
+
+ 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.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 }
+ confirm?: { value: string, action?: () => void }
+ }) => {
+ this.zone.run(() => this.customModal.show(input))
+ },
+
+ markdownRenderer: {
+ textMarkdownToHTML: (textMarkdown: string) => {
+ return this.markdownRenderer.textMarkdownToHTML({ markdown: textMarkdown })
+ },
+
+ enhancedMarkdownToHTML: (enhancedMarkdown: string) => {
+ return this.markdownRenderer.enhancedMarkdownToHTML({ markdown: enhancedMarkdown })
+ }
+ },
+
+ translate: (value: string) => {
+ return this.translateBy(npmName, value)
+ }
}
}
- private sortHooksByPriority () {
- for (const hookName of Object.keys(this.hooks)) {
- this.hooks[hookName].sort((a, b) => {
- return b.priority - a.priority
- })
- }
+ 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<PluginTranslation>(PluginService.BASE_PLUGIN_URL + '/translations/' + completeLocale + '.json')
+ .pipe(shareReplay())
}
}