-import { Injectable } from '@angular/core'
-import { Router } from '@angular/router'
-import { ServerConfigPlugin } from '@shared/models'
+import { Observable, of, ReplaySubject } from 'rxjs'
+import { catchError, first, 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 { getDevLocale, isOnDevLocale } from '@app/helpers'
+import { CustomModalComponent } from '@app/modal/custom-modal.component'
+import { FormFields, Hooks, loadPlugin, PluginInfo, runHook } from '@root-helpers/plugins'
+import { getCompleteLocale, isDefaultLocale, peertubeTranslate } from '@shared/core-utils/i18n'
+import {
+ ClientHook,
+ ClientHookName,
+ PluginClientScope,
+ PluginTranslation,
+ PluginType,
+ PublicServerSetting,
+ RegisterClientSettingsScript,
+ 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'
-import { getHookType, internalRunHook } from '@shared/core-utils/plugins/hooks'
-import { ClientHook, ClientHookName } from '@shared/models/plugins/client-hook.model'
-import { PluginClientScope } from '@shared/models/plugins/plugin-client-scope.type'
-
-interface HookStructValue extends RegisterHookOptions {
- plugin: ServerConfigPlugin
- clientScript: ClientScript
-}
+import { RegisterClientHelpers } from '../../../types/register-client-option.model'
+import * as debug from 'debug'
-type PluginInfo = {
- plugin: ServerConfigPlugin
- clientScript: ClientScript
- isTheme: boolean
-}
+const logger = debug('peertube:plugins')
@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<boolean>(1)
pluginsLoaded: { [ scope in PluginClientScope ]: ReplaySubject<boolean> } = {
common: new ReplaySubject<boolean>(1),
+ 'admin-plugin': new ReplaySubject<boolean>(1),
search: new ReplaySubject<boolean>(1),
- 'video-watch': new ReplaySubject<boolean>(1)
+ 'video-watch': new ReplaySubject<boolean>(1),
+ signup: new ReplaySubject<boolean>(1),
+ login: new ReplaySubject<boolean>(1),
+ 'video-edit': new ReplaySubject<boolean>(1),
+ embed: new ReplaySubject<boolean>(1)
}
+ translationsObservable: Observable<PluginTranslation>
+
+ 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: { [ name: string ]: HookStructValue[] } = {}
+ private hooks: Hooks = {}
+ private formFields: FormFields = {
+ video: []
+ }
+ private settingsScripts: { [ npmName: string ]: RegisterClientSettingsScript } = {}
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()
}
initializePlugins () {
- this.server.configLoaded
- .subscribe(() => {
- this.plugins = this.server.getConfig().plugin.registered
+ logger('Building plugin configuration')
+
+ this.server.getConfig()
+ .subscribe(config => {
+ this.plugins = config.plugin.registered
this.buildScopeStruct()
this.pluginsBuilt.next(true)
+
+ logger('Plugin configuration built')
})
}
+ initializeCustomModal (customModal: CustomModalComponent) {
+ this.customModal = customModal
+ }
+
ensurePluginsAreBuilt () {
return this.pluginsBuilt.asObservable()
.pipe(first(), shareReplay())
}
ensurePluginsAreLoaded (scope: PluginClientScope) {
+ this.loadPluginsByScope(scope)
+
return this.pluginsLoaded[scope].asObservable()
.pipe(first(), shareReplay())
.toPromise()
this.scopes[scope].push({
plugin,
clientScript: {
- script: environment.apiUrl + `${pathPrefix}/${plugin.name}/${plugin.version}/client-scripts/${clientScript.script}`,
+ script: `${pathPrefix}/${plugin.name}/${plugin.version}/client-scripts/${clientScript.script}`,
scopes: clientScript.scopes
},
+ pluginType: isTheme ? PluginType.THEME : PluginType.PLUGIN,
isTheme
})
}
async loadPluginsByScope (scope: PluginClientScope, isReload = false) {
+ if (this.loadingScopes[scope]) return
+ if (!isReload && this.loadedScopes.includes(scope)) return
+
+ this.loadingScopes[scope] = true
+
+ logger('Loading scope %s', scope)
+
try {
await this.ensurePluginsAreBuilt()
const toLoad = this.scopes[ scope ]
if (!Array.isArray(toLoad)) {
+ this.loadingScopes[scope] = false
this.pluginsLoaded[scope].next(true)
+ logger('Nothing to load for scope %s', scope)
return
}
await Promise.all(promises)
this.pluginsLoaded[scope].next(true)
+ this.loadingScopes[scope] = false
+
+ logger('Scope %s loaded', scope)
} catch (err) {
console.error('Cannot load plugins by scope %s.', scope, err)
}
}
- async runHook <T> (hookName: ClientHookName, result?: T, params?: any): Promise<T> {
- if (!this.hooks[hookName]) return Promise.resolve(result)
-
- const hookType = getHookType(hookName)
+ runHook <T> (hookName: ClientHookName, result?: T, params?: any): Promise<T> {
+ return this.zone.runOutsideAngular(() => {
+ return runHook(this.hooks, hookName, result, params)
+ })
+ }
- for (const hook of this.hooks[hookName]) {
- console.log('Running hook %s of plugin %s.', hookName, hook.plugin.name)
+ nameToNpmName (name: string, type: PluginType) {
+ const prefix = type === PluginType.PLUGIN
+ ? 'peertube-plugin-'
+ : 'peertube-theme-'
- 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 prefix + name
+ }
- return result
+ pluginTypeFromNpmName (npmName: string) {
+ return npmName.startsWith('peertube-plugin-')
+ ? PluginType.PLUGIN
+ : PluginType.THEME
}
- private loadPlugin (pluginInfo: PluginInfo) {
- const { plugin, clientScript } = pluginInfo
+ getRegisteredVideoFormFields (type: VideoEditType) {
+ return this.formFields.video.filter(f => f.videoFormOptions.type === type)
+ }
- const registerHook = (options: RegisterHookOptions) => {
- if (!this.hooks[options.target]) this.hooks[options.target] = []
+ getRegisteredSettingsScript (npmName: string) {
+ return this.settingsScripts[npmName]
+ }
- this.hooks[options.target].push({
- plugin,
- clientScript,
- target: options.target,
- handler: options.handler,
- priority: options.priority || 0
- })
+ translateBy (npmName: string, toTranslate: string) {
+ const helpers = this.helpers[npmName]
+ if (!helpers) {
+ console.error('Unknown helpers to translate %s from %s.', toTranslate, npmName)
+ return toTranslate
}
- const peertubeHelpers = this.buildPeerTubeHelpers(pluginInfo)
-
- console.log('Loading script %s of plugin %s.', clientScript.script, plugin.name)
+ return helpers.translate(toTranslate)
+ }
- return import(/* webpackIgnore: true */ clientScript.script)
- .then(script => script.register({ registerHook, peertubeHelpers }))
- .then(() => this.sortHooksByPriority())
+ 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,
+ onSettingsScripts: options => this.settingsScripts[npmName] = options,
+ pluginInfo,
+ peertubeHelpersFactory: () => helpers
+ })
+ })
}
private buildScopeStruct () {
}
}
- 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) {
+ 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`
+ },
+
+ getBaseRouterRoute: () => {
+ const pathPrefix = this.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<PublicServerSetting>(path)
+ .pipe(
+ map(p => p.publicSettings),
+ catchError(res => this.restExtractor.handleError(res))
+ )
+ .toPromise()
+ },
+
+ getServerConfig: () => {
+ return this.server.getConfig()
+ .pipe(catchError(res => this.restExtractor.handleError(res)))
+ .toPromise()
+ },
+
+ 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)
+ },
+
+ showModal: (input: {
+ title: string,
+ content: string,
+ close?: boolean,
+ cancel?: { value: string, action?: () => void },
+ confirm?: { value: string, action?: () => void }
+ }) => {
+ this.customModal.show(input)
+ },
+
+ markdownRenderer: {
+ textMarkdownToHTML: (textMarkdown: string) => {
+ return this.markdownRenderer.textMarkdownToHTML(textMarkdown)
+ },
+
+ enhancedMarkdownToHTML: (enhancedMarkdown: string) => {
+ return this.markdownRenderer.enhancedMarkdownToHTML(enhancedMarkdown)
+ }
+ },
+
+ 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<PluginTranslation>(PluginService.BASE_PLUGIN_URL + '/translations/' + completeLocale + '.json')
+ .pipe(shareReplay())
+ }
+
private getPluginPathPrefix (isTheme: boolean) {
return isTheme ? '/themes' : '/plugins'
}