X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Fplugins%2Fplugin-manager.ts;h=6599bcccaf28f95f70eb936a88a66a7c4e8e2bb4;hb=679c12e69c9f3a2d003ee3abe8b8da49f25b2bd3;hp=533ed4391335905643a22065a5ae3a786440a142;hpb=f023a19c3eeeea2b014b47fae522a62eab320048;p=github%2FChocobozzz%2FPeerTube.git

diff --git a/server/lib/plugins/plugin-manager.ts b/server/lib/plugins/plugin-manager.ts
index 533ed4391..6599bccca 100644
--- a/server/lib/plugins/plugin-manager.ts
+++ b/server/lib/plugins/plugin-manager.ts
@@ -1,17 +1,26 @@
-import { PluginModel } from '../../models/server/plugin'
-import { logger } from '../../helpers/logger'
-import { RegisterHookOptions } from '../../../shared/models/plugins/register.model'
+import decache from 'decache'
+import * as express from 'express'
+import { createReadStream, createWriteStream } from 'fs'
+import { ensureDir, outputFile, readJSON } from 'fs-extra'
 import { basename, join } from 'path'
-import { CONFIG } from '../../initializers/config'
+import { MOAuthTokenUser, MUser } from '@server/types/models'
+import { getCompleteLocale } from '@shared/core-utils'
+import { ClientScript, PluginPackageJson, PluginTranslation, PluginTranslationPaths, RegisterServerHookOptions } from '@shared/models'
+import { getHookType, internalRunHook } from '../../../shared/core-utils/plugins/hooks'
+import { PluginType } from '../../../shared/models/plugins/plugin.type'
+import { ServerHook, ServerHookName } from '../../../shared/models/plugins/server/server-hook.model'
 import { isLibraryCodeValid, isPackageJSONValid } from '../../helpers/custom-validators/plugins'
-import { PluginPackageJson } from '../../../shared/models/plugins/plugin-package-json.model'
-import { PluginLibrary } from '../../../shared/models/plugins/plugin-library.model'
-import { createReadStream, createWriteStream } from 'fs'
+import { logger } from '../../helpers/logger'
+import { CONFIG } from '../../initializers/config'
 import { PLUGIN_GLOBAL_CSS_PATH } from '../../initializers/constants'
-import { PluginType } from '../../../shared/models/plugins/plugin.type'
+import { PluginModel } from '../../models/server/plugin'
+import { PluginLibrary, RegisterServerAuthExternalOptions, RegisterServerAuthPassOptions, RegisterServerOptions } from '../../types/plugins'
+import { ClientHtml } from '../client-html'
+import { RegisterHelpers } from './register-helpers'
 import { installNpmPlugin, installNpmPluginFromDisk, removeNpmPlugin } from './yarn'
 
 export interface RegisteredPlugin {
+  npmName: string
   name: string
   version: string
   description: string
@@ -22,36 +31,210 @@ export interface RegisteredPlugin {
   path: string
 
   staticDirs: { [name: string]: string }
+  clientScripts: { [name: string]: ClientScript }
 
   css: string[]
 
   // Only if this is a plugin
+  registerHelpers?: RegisterHelpers
   unregister?: Function
 }
 
 export interface HookInformationValue {
+  npmName: string
   pluginName: string
   handler: Function
   priority: number
 }
 
-export class PluginManager {
+type PluginLocalesTranslations = {
+  [locale: string]: PluginTranslation
+}
+
+export class PluginManager implements ServerHook {
 
   private static instance: PluginManager
 
-  private registeredPlugins: { [ name: string ]: RegisteredPlugin } = {}
-  private hooks: { [ name: string ]: HookInformationValue[] } = {}
+  private registeredPlugins: { [name: string]: RegisteredPlugin } = {}
+
+  private hooks: { [name: string]: HookInformationValue[] } = {}
+  private translations: PluginLocalesTranslations = {}
 
   private constructor () {
   }
 
-  async registerPlugins () {
+  // ###################### Getters ######################
+
+  isRegistered (npmName: string) {
+    return !!this.getRegisteredPluginOrTheme(npmName)
+  }
+
+  getRegisteredPluginOrTheme (npmName: string) {
+    return this.registeredPlugins[npmName]
+  }
+
+  getRegisteredPluginByShortName (name: string) {
+    const npmName = PluginModel.buildNpmName(name, PluginType.PLUGIN)
+    const registered = this.getRegisteredPluginOrTheme(npmName)
+
+    if (!registered || registered.type !== PluginType.PLUGIN) return undefined
+
+    return registered
+  }
+
+  getRegisteredThemeByShortName (name: string) {
+    const npmName = PluginModel.buildNpmName(name, PluginType.THEME)
+    const registered = this.getRegisteredPluginOrTheme(npmName)
+
+    if (!registered || registered.type !== PluginType.THEME) return undefined
+
+    return registered
+  }
+
+  getRegisteredPlugins () {
+    return this.getRegisteredPluginsOrThemes(PluginType.PLUGIN)
+  }
+
+  getRegisteredThemes () {
+    return this.getRegisteredPluginsOrThemes(PluginType.THEME)
+  }
+
+  getIdAndPassAuths () {
+    return this.getRegisteredPlugins()
+      .map(p => ({
+        npmName: p.npmName,
+        name: p.name,
+        version: p.version,
+        idAndPassAuths: p.registerHelpers.getIdAndPassAuths()
+      }))
+      .filter(v => v.idAndPassAuths.length !== 0)
+  }
+
+  getExternalAuths () {
+    return this.getRegisteredPlugins()
+      .map(p => ({
+        npmName: p.npmName,
+        name: p.name,
+        version: p.version,
+        externalAuths: p.registerHelpers.getExternalAuths()
+      }))
+      .filter(v => v.externalAuths.length !== 0)
+  }
+
+  getRegisteredSettings (npmName: string) {
+    const result = this.getRegisteredPluginOrTheme(npmName)
+    if (!result || result.type !== PluginType.PLUGIN) return []
+
+    return result.registerHelpers.getSettings()
+  }
+
+  getRouter (npmName: string) {
+    const result = this.getRegisteredPluginOrTheme(npmName)
+    if (!result || result.type !== PluginType.PLUGIN) return null
+
+    return result.registerHelpers.getRouter()
+  }
+
+  getTranslations (locale: string) {
+    return this.translations[locale] || {}
+  }
+
+  async isTokenValid (token: MOAuthTokenUser, type: 'access' | 'refresh') {
+    const auth = this.getAuth(token.User.pluginAuth, token.authName)
+    if (!auth) return true
+
+    if (auth.hookTokenValidity) {
+      try {
+        const { valid } = await auth.hookTokenValidity({ token, type })
+
+        if (valid === false) {
+          logger.info('Rejecting %s token validity from auth %s of plugin %s', type, token.authName, token.User.pluginAuth)
+        }
+
+        return valid
+      } catch (err) {
+        logger.warn('Cannot run check token validity from auth %s of plugin %s.', token.authName, token.User.pluginAuth, { err })
+        return true
+      }
+    }
+
+    return true
+  }
+
+  // ###################### External events ######################
+
+  async onLogout (npmName: string, authName: string, user: MUser, req: express.Request) {
+    const auth = this.getAuth(npmName, authName)
+
+    if (auth?.onLogout) {
+      logger.info('Running onLogout function from auth %s of plugin %s', authName, npmName)
+
+      try {
+        // Force await, in case or onLogout returns a promise
+        const result = await auth.onLogout(user, req)
+
+        return typeof result === 'string'
+          ? result
+          : undefined
+      } catch (err) {
+        logger.warn('Cannot run onLogout function from auth %s of plugin %s.', authName, npmName, { err })
+      }
+    }
+
+    return undefined
+  }
+
+  async onSettingsChanged (name: string, settings: any) {
+    const registered = this.getRegisteredPluginByShortName(name)
+    if (!registered) {
+      logger.error('Cannot find plugin %s to call on settings changed.', name)
+    }
+
+    for (const cb of registered.registerHelpers.getOnSettingsChangedCallbacks()) {
+      try {
+        await cb(settings)
+      } catch (err) {
+        logger.error('Cannot run on settings changed callback for %s.', registered.npmName, { err })
+      }
+    }
+  }
+
+  // ###################### Hooks ######################
+
+  async runHook<T> (hookName: ServerHookName, result?: T, params?: any): Promise<T> {
+    if (!this.hooks[hookName]) return Promise.resolve(result)
+
+    const hookType = getHookType(hookName)
+
+    for (const hook of this.hooks[hookName]) {
+      logger.debug('Running hook %s of plugin %s.', hookName, hook.npmName)
+
+      result = await internalRunHook(hook.handler, hookType, result, params, err => {
+        logger.error('Cannot run hook %s of plugin %s.', hookName, hook.pluginName, { err })
+      })
+    }
+
+    return result
+  }
+
+  // ###################### Registration ######################
+
+  async registerPluginsAndThemes () {
+    await this.resetCSSGlobalFile()
+
     const plugins = await PluginModel.listEnabledPluginsAndThemes()
 
     for (const plugin of plugins) {
       try {
         await this.registerPluginOrTheme(plugin)
       } catch (err) {
+        // Try to unregister the plugin
+        try {
+          await this.unregister(PluginModel.buildNpmName(plugin.name, plugin.type))
+        } catch {
+          // we don't care if we cannot unregister it
+        }
+
         logger.error('Cannot register plugin %s, skipping.', plugin.name, { err })
       }
     }
@@ -59,35 +242,42 @@ export class PluginManager {
     this.sortHooksByPriority()
   }
 
-  getRegisteredPlugin (name: string) {
-    return this.registeredPlugins[ name ]
-  }
+  // Don't need the plugin type since themes cannot register server code
+  async unregister (npmName: string) {
+    logger.info('Unregister plugin %s.', npmName)
 
-  getRegisteredTheme (name: string) {
-    const registered = this.getRegisteredPlugin(name)
+    const plugin = this.getRegisteredPluginOrTheme(npmName)
 
-    if (!registered || registered.type !== PluginType.THEME) return undefined
+    if (!plugin) {
+      throw new Error(`Unknown plugin ${npmName} to unregister`)
+    }
 
-    return registered
-  }
+    delete this.registeredPlugins[plugin.npmName]
 
-  async unregister (name: string) {
-    const plugin = this.getRegisteredPlugin(name)
+    this.deleteTranslations(plugin.npmName)
 
-    if (!plugin) {
-      throw new Error(`Unknown plugin ${name} to unregister`)
-    }
+    if (plugin.type === PluginType.PLUGIN) {
+      await plugin.unregister()
 
-    if (plugin.type === PluginType.THEME) {
-      throw new Error(`Cannot unregister ${name}: this is a theme`)
-    }
+      // Remove hooks of this plugin
+      for (const key of Object.keys(this.hooks)) {
+        this.hooks[key] = this.hooks[key].filter(h => h.npmName !== npmName)
+      }
+
+      const store = plugin.registerHelpers
+      store.reinitVideoConstants(plugin.npmName)
+      store.reinitTranscodingProfilesAndEncoders(plugin.npmName)
 
-    await plugin.unregister()
+      logger.info('Regenerating registered plugin CSS to global file.')
+      await this.regeneratePluginGlobalCSS()
+    }
   }
 
-  async install (toInstall: string, version: string, fromDisk = false) {
+  // ###################### Installation ######################
+
+  async install (toInstall: string, version?: string, fromDisk = false) {
     let plugin: PluginModel
-    let name: string
+    let npmName: string
 
     logger.info('Installing plugin %s.', toInstall)
 
@@ -96,63 +286,119 @@ export class PluginManager {
         ? await installNpmPluginFromDisk(toInstall)
         : await installNpmPlugin(toInstall, version)
 
-      name = fromDisk ? basename(toInstall) : toInstall
-      const pluginType = name.startsWith('peertube-theme-') ? PluginType.THEME : PluginType.PLUGIN
-      const pluginName = this.normalizePluginName(name)
+      npmName = fromDisk ? basename(toInstall) : toInstall
+      const pluginType = PluginModel.getTypeFromNpmName(npmName)
+      const pluginName = PluginModel.normalizePluginName(npmName)
 
-      const packageJSON = this.getPackageJSON(pluginName, pluginType)
-      if (!isPackageJSONValid(packageJSON, pluginType)) {
-        throw new Error('PackageJSON is invalid.')
-      }
+      const packageJSON = await this.getPackageJSON(pluginName, pluginType)
+
+      this.sanitizeAndCheckPackageJSONOrThrow(packageJSON, pluginType);
 
       [ plugin ] = await PluginModel.upsert({
         name: pluginName,
         description: packageJSON.description,
+        homepage: packageJSON.homepage,
         type: pluginType,
         version: packageJSON.version,
         enabled: true,
         uninstalled: false,
         peertubeEngine: packageJSON.engine.peertube
       }, { returning: true })
-    } catch (err) {
-      logger.error('Cannot install plugin %s, removing it...', toInstall, { err })
+
+      logger.info('Successful installation of plugin %s.', toInstall)
+
+      await this.registerPluginOrTheme(plugin)
+    } catch (rootErr) {
+      logger.error('Cannot install plugin %s, removing it...', toInstall, { err: rootErr })
 
       try {
-        await removeNpmPlugin(name)
+        await this.uninstall(npmName)
       } catch (err) {
-        logger.error('Cannot remove plugin %s after failed installation.', toInstall, { err })
+        logger.error('Cannot uninstall plugin %s after failed installation.', toInstall, { err })
+
+        try {
+          await removeNpmPlugin(npmName)
+        } catch (err) {
+          logger.error('Cannot remove plugin %s after failed installation.', toInstall, { err })
+        }
       }
 
-      throw err
+      throw rootErr
     }
 
-    logger.info('Successful installation of plugin %s.', toInstall)
+    return plugin
+  }
+
+  async update (toUpdate: string, fromDisk = false) {
+    const npmName = fromDisk ? basename(toUpdate) : toUpdate
+
+    logger.info('Updating plugin %s.', npmName)
+
+    // Use the latest version from DB, to not upgrade to a version that does not support our PeerTube version
+    let version: string
+    if (!fromDisk) {
+      const plugin = await PluginModel.loadByNpmName(toUpdate)
+      version = plugin.latestVersion
+    }
 
-    await this.registerPluginOrTheme(plugin)
+    // Unregister old hooks
+    await this.unregister(npmName)
+
+    return this.install(toUpdate, version, fromDisk)
   }
 
-  async uninstall (packageName: string) {
-    await PluginModel.uninstall(this.normalizePluginName(packageName))
+  async uninstall (npmName: string) {
+    logger.info('Uninstalling plugin %s.', npmName)
+
+    try {
+      await this.unregister(npmName)
+    } catch (err) {
+      logger.warn('Cannot unregister plugin %s.', npmName, { err })
+    }
+
+    const plugin = await PluginModel.loadByNpmName(npmName)
+    if (!plugin || plugin.uninstalled === true) {
+      logger.error('Cannot uninstall plugin %s: it does not exist or is already uninstalled.', npmName)
+      return
+    }
+
+    plugin.enabled = false
+    plugin.uninstalled = true
+
+    await plugin.save()
 
-    await removeNpmPlugin(packageName)
+    await removeNpmPlugin(npmName)
+
+    logger.info('Plugin %s uninstalled.', npmName)
   }
 
+  // ###################### Private register ######################
+
   private async registerPluginOrTheme (plugin: PluginModel) {
-    logger.info('Registering plugin or theme %s.', plugin.name)
+    const npmName = PluginModel.buildNpmName(plugin.name, plugin.type)
+
+    logger.info('Registering plugin or theme %s.', npmName)
 
-    const packageJSON = this.getPackageJSON(plugin.name, plugin.type)
+    const packageJSON = await this.getPackageJSON(plugin.name, plugin.type)
     const pluginPath = this.getPluginPath(plugin.name, plugin.type)
 
-    if (!isPackageJSONValid(packageJSON, plugin.type)) {
-      throw new Error('Package.JSON is invalid.')
-    }
+    this.sanitizeAndCheckPackageJSONOrThrow(packageJSON, plugin.type)
 
     let library: PluginLibrary
+    let registerHelpers: RegisterHelpers
     if (plugin.type === PluginType.PLUGIN) {
-      library = await this.registerPlugin(plugin, pluginPath, packageJSON)
+      const result = await this.registerPlugin(plugin, pluginPath, packageJSON)
+      library = result.library
+      registerHelpers = result.registerStore
+    }
+
+    const clientScripts: { [id: string]: ClientScript } = {}
+    for (const c of packageJSON.clientScripts) {
+      clientScripts[c.script] = c
     }
 
-    this.registeredPlugins[ plugin.name ] = {
+    this.registeredPlugins[npmName] = {
+      npmName,
       name: plugin.name,
       type: plugin.type,
       version: plugin.version,
@@ -160,55 +406,84 @@ export class PluginManager {
       peertubeEngine: plugin.peertubeEngine,
       path: pluginPath,
       staticDirs: packageJSON.staticDirs,
+      clientScripts,
       css: packageJSON.css,
+      registerHelpers: registerHelpers || undefined,
       unregister: library ? library.unregister : undefined
     }
+
+    await this.addTranslations(plugin, npmName, packageJSON.translations)
   }
 
   private async registerPlugin (plugin: PluginModel, pluginPath: string, packageJSON: PluginPackageJson) {
-    const registerHook = (options: RegisterHookOptions) => {
-      if (!this.hooks[options.target]) this.hooks[options.target] = []
-
-      this.hooks[options.target].push({
-        pluginName: plugin.name,
-        handler: options.handler,
-        priority: options.priority || 0
-      })
-    }
+    const npmName = PluginModel.buildNpmName(plugin.name, plugin.type)
 
-    const library: PluginLibrary = require(join(pluginPath, packageJSON.library))
+    // Delete cache if needed
+    const modulePath = join(pluginPath, packageJSON.library)
+    decache(modulePath)
+    const library: PluginLibrary = require(modulePath)
 
     if (!isLibraryCodeValid(library)) {
       throw new Error('Library code is not valid (miss register or unregister function)')
     }
 
-    library.register({ registerHook })
+    const { registerOptions, registerStore } = this.getRegisterHelpers(npmName, plugin)
 
-    logger.info('Add plugin %s CSS to global file.', plugin.name)
+    await ensureDir(registerOptions.peertubeHelpers.plugin.getDataDirectoryPath())
+
+    await library.register(registerOptions)
+
+    logger.info('Add plugin %s CSS to global file.', npmName)
 
     await this.addCSSToGlobalFile(pluginPath, packageJSON.css)
 
-    return library
+    return { library, registerStore }
   }
 
-  private sortHooksByPriority () {
-    for (const hookName of Object.keys(this.hooks)) {
-      this.hooks[hookName].sort((a, b) => {
-        return b.priority - a.priority
-      })
+  // ###################### Translations ######################
+
+  private async addTranslations (plugin: PluginModel, npmName: string, translationPaths: PluginTranslationPaths) {
+    for (const locale of Object.keys(translationPaths)) {
+      const path = translationPaths[locale]
+      const json = await readJSON(join(this.getPluginPath(plugin.name, plugin.type), path))
+
+      const completeLocale = getCompleteLocale(locale)
+
+      if (!this.translations[completeLocale]) this.translations[completeLocale] = {}
+      this.translations[completeLocale][npmName] = json
+
+      logger.info('Added locale %s of plugin %s.', completeLocale, npmName)
+    }
+  }
+
+  private deleteTranslations (npmName: string) {
+    for (const locale of Object.keys(this.translations)) {
+      delete this.translations[locale][npmName]
+
+      logger.info('Deleted locale %s of plugin %s.', locale, npmName)
     }
   }
 
+  // ###################### CSS ######################
+
+  private resetCSSGlobalFile () {
+    ClientHtml.invalidCache()
+
+    return outputFile(PLUGIN_GLOBAL_CSS_PATH, '')
+  }
+
   private async addCSSToGlobalFile (pluginPath: string, cssRelativePaths: string[]) {
     for (const cssPath of cssRelativePaths) {
       await this.concatFiles(join(pluginPath, cssPath), PLUGIN_GLOBAL_CSS_PATH)
     }
+
+    ClientHtml.invalidCache()
   }
 
   private concatFiles (input: string, output: string) {
     return new Promise<void>((res, rej) => {
-      const outputStream = createWriteStream(input)
-      const inputStream = createReadStream(output)
+      const inputStream = createReadStream(input)
+      const outputStream = createWriteStream(output, { flags: 'a' })
 
       inputStream.pipe(outputStream)
 
@@ -217,20 +492,99 @@ export class PluginManager {
     })
   }
 
+  private async regeneratePluginGlobalCSS () {
+    await this.resetCSSGlobalFile()
+
+    for (const plugin of this.getRegisteredPlugins()) {
+      await this.addCSSToGlobalFile(plugin.path, plugin.css)
+    }
+  }
+
+  // ###################### Utils ######################
+
+  private sortHooksByPriority () {
+    for (const hookName of Object.keys(this.hooks)) {
+      this.hooks[hookName].sort((a, b) => {
+        return b.priority - a.priority
+      })
+    }
+  }
+
   private getPackageJSON (pluginName: string, pluginType: PluginType) {
     const pluginPath = join(this.getPluginPath(pluginName, pluginType), 'package.json')
 
-    return require(pluginPath) as PluginPackageJson
+    return readJSON(pluginPath) as Promise<PluginPackageJson>
   }
 
   private getPluginPath (pluginName: string, pluginType: PluginType) {
-    const prefix = pluginType === PluginType.PLUGIN ? 'peertube-plugin-' : 'peertube-theme-'
+    const npmName = PluginModel.buildNpmName(pluginName, pluginType)
+
+    return join(CONFIG.STORAGE.PLUGINS_DIR, 'node_modules', npmName)
+  }
+
+  private getAuth (npmName: string, authName: string) {
+    const plugin = this.getRegisteredPluginOrTheme(npmName)
+    if (!plugin || plugin.type !== PluginType.PLUGIN) return null
+
+    let auths: (RegisterServerAuthPassOptions | RegisterServerAuthExternalOptions)[] = plugin.registerHelpers.getIdAndPassAuths()
+    auths = auths.concat(plugin.registerHelpers.getExternalAuths())
 
-    return join(CONFIG.STORAGE.PLUGINS_DIR, 'node_modules', prefix + pluginName)
+    return auths.find(a => a.authName === authName)
   }
 
-  private normalizePluginName (name: string) {
-    return name.replace(/^peertube-((theme)|(plugin))-/, '')
+  // ###################### Private getters ######################
+
+  private getRegisteredPluginsOrThemes (type: PluginType) {
+    const plugins: RegisteredPlugin[] = []
+
+    for (const npmName of Object.keys(this.registeredPlugins)) {
+      const plugin = this.registeredPlugins[npmName]
+      if (plugin.type !== type) continue
+
+      plugins.push(plugin)
+    }
+
+    return plugins
+  }
+
+  // ###################### Generate register helpers ######################
+
+  private getRegisterHelpers (
+    npmName: string,
+    plugin: PluginModel
+  ): { registerStore: RegisterHelpers, registerOptions: RegisterServerOptions } {
+    const onHookAdded = (options: RegisterServerHookOptions) => {
+      if (!this.hooks[options.target]) this.hooks[options.target] = []
+
+      this.hooks[options.target].push({
+        npmName: npmName,
+        pluginName: plugin.name,
+        handler: options.handler,
+        priority: options.priority || 0
+      })
+    }
+
+    const registerHelpers = new RegisterHelpers(npmName, plugin, onHookAdded.bind(this))
+
+    return {
+      registerStore: registerHelpers,
+      registerOptions: registerHelpers.buildRegisterHelpers()
+    }
+  }
+
+  private sanitizeAndCheckPackageJSONOrThrow (packageJSON: PluginPackageJson, pluginType: PluginType) {
+    if (!packageJSON.staticDirs) packageJSON.staticDirs = {}
+    if (!packageJSON.css) packageJSON.css = []
+    if (!packageJSON.clientScripts) packageJSON.clientScripts = []
+    if (!packageJSON.translations) packageJSON.translations = {}
+
+    const { result: packageJSONValid, badFields } = isPackageJSONValid(packageJSON, pluginType)
+    if (!packageJSONValid) {
+      const formattedFields = badFields.map(f => `"${f}"`)
+                                       .join(', ')
+
+      throw new Error(`PackageJSON is invalid (invalid fields: ${formattedFields}).`)
+    }
   }
 
   static get Instance () {