X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=client%2Fsrc%2Fapp%2Fcore%2Fplugins%2Fplugin.service.ts;h=3ed23160dfb5d9366108ed263f5fe85a22e25b3c;hb=8c7725dc3c01a73bf56a48c8b192d144bfdc3ffe;hp=7f751f479c7630fa46f2a7c8fe3671027a117577;hpb=7cd4d2ba10106c10602c86f74f55743ded588896;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 7f751f479..3ed23160d 100644
--- a/client/src/app/core/plugins/plugin.service.ts
+++ b/client/src/app/core/plugins/plugin.service.ts
@@ -1,93 +1,226 @@
-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.model'
-import { ReplaySubject } from 'rxjs'
-import { first } 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'
+import { RegisterClientHookOptions } from '@shared/models/plugins/register-client-hook.model'
+import { HttpClient } from '@angular/common/http'
+import { AuthService } from '@app/core/auth'
+import { Notifier } from '@app/core/notification'
+import { RestExtractor } from '@app/shared/rest'
+import { MarkdownService } from '@app/shared/renderer'
+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'
+import { CustomModalComponent } from '@app/modal/custom-modal.component'
 
-interface HookStructValue extends RegisterHookOptions {
+interface HookStructValue extends RegisterClientHookOptions {
   plugin: ServerConfigPlugin
   clientScript: ClientScript
 }
 
+type PluginInfo = {
+  plugin: ServerConfigPlugin
+  clientScript: ClientScript
+  pluginType: PluginType
+  isTheme: boolean
+}
+
 @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'
+
+  pluginsBuilt = new ReplaySubject<boolean>(1)
+
+  pluginsLoaded: { [ scope in PluginClientScope ]: ReplaySubject<boolean> } = {
+    common: new ReplaySubject<boolean>(1),
+    search: new ReplaySubject<boolean>(1),
+    'video-watch': new ReplaySubject<boolean>(1),
+    signup: new ReplaySubject<boolean>(1)
+  }
+
+  translationsObservable: Observable<PluginTranslation>
+
+  customModal: CustomModalComponent
 
   private plugins: ServerConfigPlugin[] = []
-  private scopes: { [ scopeName: string ]: { plugin: ServerConfigPlugin, clientScript: ClientScript }[] } = {}
+  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 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
+    this.server.getConfig()
+      .subscribe(config => {
+        this.plugins = config.plugin.registered
 
         this.buildScopeStruct()
 
-        this.pluginsLoaded.next(true)
+        this.pluginsBuilt.next(true)
       })
   }
 
-  ensurePluginsAreLoaded () {
-    return this.pluginsLoaded.asObservable()
-               .pipe(first())
+  initializeCustomModal (customModal: CustomModalComponent) {
+    this.customModal = customModal
+  }
+
+  ensurePluginsAreBuilt () {
+    return this.pluginsBuilt.asObservable()
+               .pipe(first(), shareReplay())
+               .toPromise()
+  }
+
+  ensurePluginsAreLoaded (scope: PluginClientScope) {
+    this.loadPluginsByScope(scope)
+
+    return this.pluginsLoaded[scope].asObservable()
+               .pipe(first(), shareReplay())
                .toPromise()
   }
 
-  async loadPluginsByScope (scope: PluginScope) {
+  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: environment.apiUrl + `${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)
+    }
+  }
+
+  async reloadLoadedScopes () {
+    for (const scope of this.loadedScopes) {
+      await this.loadPluginsByScope(scope, true)
+    }
+  }
+
+  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<any>[] = []
-      for (const { plugin, clientScript } of toLoad) {
+      for (const pluginInfo of toLoad) {
+        const clientScript = pluginInfo.clientScript
+
         if (this.loadedScripts[ clientScript.script ]) continue
 
-        promises.push(this.loadPlugin(plugin, clientScript))
+        promises.push(this.loadPlugin(pluginInfo))
 
         this.loadedScripts[ clientScript.script ] = true
       }
 
-      return Promise.all(promises)
+      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 <T> (hookName: ClientHookName, result?: T, params?: any): Promise<T> {
+    return this.zone.runOutsideAngular(async () => {
+      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 {
-        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)
+        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
+    })
   }
 
-  private loadPlugin (plugin: ServerConfigPlugin, clientScript: ClientScript) {
-    const registerHook = (options: RegisterHookOptions) => {
+  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: 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({
@@ -99,31 +232,21 @@ export class PluginService {
       })
     }
 
-    console.log('Loading script %s of plugin %s.', clientScript.script, plugin.name)
+    const peertubeHelpers = this.buildPeerTubeHelpers(pluginInfo)
 
-    const url = environment.apiUrl + `/plugins/${plugin.name}/${plugin.version}/client-scripts/${clientScript.script}`
+    console.log('Loading script %s of plugin %s.', clientScript.script, plugin.name)
 
-    return import(/* webpackIgnore: true */ url)
-      .then(script => script.register({ registerHook }))
-      .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 () {
     for (const plugin of this.plugins) {
-      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
-          })
-
-          this.loadedScripts[clientScript.script] = false
-        }
-      }
+      this.addPlugin(plugin)
     }
   }
 
@@ -134,4 +257,79 @@ export class PluginService {
       })
     }
   }
+
+  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<PublicServerSetting>(path)
+                   .pipe(
+                     map(p => p.publicSettings),
+                     catchError(res => this.restExtractor.handleError(res))
+                   )
+                   .toPromise()
+      },
+
+      isLoggedIn: () => {
+        return this.authService.isLoggedIn()
+      },
+
+      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'
+  }
 }