]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - client/src/app/core/plugins/plugin.service.ts
Lazy load static objects
[github/Chocobozzz/PeerTube.git] / client / src / app / core / plugins / plugin.service.ts
index e4a73de81d2de717f0823b3a60ff7c3a56025bc1..da5114048a994a896c790688ce88a6860dbad27d 100644 (file)
@@ -1,15 +1,25 @@
-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 { ClientScript as ClientScriptModule } from '../../../types/client-script.model'
 import { environment } from '../../../environments/environment'
-import { ReplaySubject } from 'rxjs'
-import { first, shareReplay } 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 { 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
@@ -19,19 +29,26 @@ interface HookStructValue extends RegisterClientHookOptions {
 type PluginInfo = {
   plugin: ServerConfigPlugin
   clientScript: ClientScript
+  pluginType: PluginType
   isTheme: boolean
 }
 
 @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),
     search: new ReplaySubject<boolean>(1),
-    'video-watch': new ReplaySubject<boolean>(1)
+    'video-watch': new ReplaySubject<boolean>(1),
+    signup: new ReplaySubject<boolean>(1)
   }
 
+  translationsObservable: Observable<PluginTranslation>
+
   private plugins: ServerConfigPlugin[] = []
   private scopes: { [ scopeName: string ]: PluginInfo[] } = {}
   private loadedScripts: { [ script: string ]: boolean } = {}
@@ -42,14 +59,20 @@ export class PluginService implements ClientHook {
 
   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 () {
-    this.server.configLoaded
-      .subscribe(() => {
-        this.plugins = this.server.getConfig().plugin.registered
+    this.server.getConfig()
+      .subscribe(config => {
+        this.plugins = config.plugin.registered
 
         this.buildScopeStruct()
 
@@ -86,6 +109,7 @@ export class PluginService implements ClientHook {
             script: environment.apiUrl + `${pathPrefix}/${plugin.name}/${plugin.version}/client-scripts/${clientScript.script}`,
             scopes: clientScript.scopes
           },
+          pluginType: isTheme ? PluginType.THEME : PluginType.PLUGIN,
           isTheme
         })
 
@@ -145,20 +169,36 @@ export class PluginService implements ClientHook {
     }
   }
 
-  async runHook <T> (hookName: ClientHookName, result?: T, params?: any): Promise<T> {
-    if (!this.hooks[hookName]) return Promise.resolve(result)
+  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 hookType = getHookType(hookName)
 
-    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 ]) {
+        console.log('Running hook %s of plugin %s.', hookName, hook.plugin.name)
 
-      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)
-      })
-    }
+        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) {
@@ -185,9 +225,12 @@ export class PluginService implements ClientHook {
 
     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 () {
@@ -204,17 +247,51 @@ export class PluginService implements ClientHook {
     }
   }
 
-  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<PublicServerSetting>(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<PluginTranslation>(PluginService.BASE_PLUGIN_URL + '/translations/' + completeLocale + '.json')
+        .pipe(shareReplay())
+  }
+
   private getPluginPathPrefix (isTheme: boolean) {
     return isTheme ? '/themes' : '/plugins'
   }