X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Fplugins%2Fplugin-manager.ts;h=cfe63e50d1a681dc1d94028382572a88a0b15cdd;hb=7663e55a2cc46a413bceee2787d48902b15ae642;hp=b48ecc991793f04e1a3cf78f63b9bbd9fa762ebc;hpb=345da516fae80f24c90c2196e96393b489af2243;p=github%2FChocobozzz%2FPeerTube.git

diff --git a/server/lib/plugins/plugin-manager.ts b/server/lib/plugins/plugin-manager.ts
index b48ecc991..cfe63e50d 100644
--- a/server/lib/plugins/plugin-manager.ts
+++ b/server/lib/plugins/plugin-manager.ts
@@ -1,16 +1,25 @@
 import { PluginModel } from '../../models/server/plugin'
 import { logger } from '../../helpers/logger'
-import { RegisterHookOptions } from '../../../shared/models/plugins/register.model'
-import { join } from 'path'
+import { basename, join } from 'path'
 import { CONFIG } from '../../initializers/config'
 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 { ClientScript, PluginPackageJson } from '../../../shared/models/plugins/plugin-package-json.model'
 import { createReadStream, createWriteStream } from 'fs'
 import { PLUGIN_GLOBAL_CSS_PATH } from '../../initializers/constants'
 import { PluginType } from '../../../shared/models/plugins/plugin.type'
+import { installNpmPlugin, installNpmPluginFromDisk, removeNpmPlugin } from './yarn'
+import { outputFile, readJSON } from 'fs-extra'
+import { RegisterSettingOptions } from '../../../shared/models/plugins/register-setting.model'
+import { RegisterHookOptions } from '../../../shared/models/plugins/register-hook.model'
+import { PluginSettingsManager } from '../../../shared/models/plugins/plugin-settings-manager.model'
+import { PluginStorageManager } from '../../../shared/models/plugins/plugin-storage-manager.model'
+import { ServerHook, ServerHookName, serverHookObject } from '../../../shared/models/plugins/server-hook.model'
+import { getHookType, internalRunHook } from '../../../shared/core-utils/plugins/hooks'
+import { RegisterOptions } from '../../typings/plugins/register-options.model'
+import { PluginLibrary } from '../../typings/plugins'
 
 export interface RegisteredPlugin {
+  npmName: string
   name: string
   version: string
   description: string
@@ -21,6 +30,7 @@ export interface RegisteredPlugin {
   path: string
 
   staticDirs: { [name: string]: string }
+  clientScripts: { [name: string]: ClientScript }
 
   css: string[]
 
@@ -29,28 +39,99 @@ export interface RegisteredPlugin {
 }
 
 export interface HookInformationValue {
+  npmName: string
   pluginName: string
   handler: Function
   priority: number
 }
 
-export class PluginManager {
+export class PluginManager implements ServerHook {
 
   private static instance: PluginManager
 
   private registeredPlugins: { [ name: string ]: RegisteredPlugin } = {}
+  private settings: { [ name: string ]: RegisterSettingOptions[] } = {}
   private hooks: { [ name: string ]: HookInformationValue[] } = {}
 
   private constructor () {
   }
 
-  async registerPlugins () {
+  // ###################### Getters ######################
+
+  isRegistered (npmName: string) {
+    return !!this.getRegisteredPluginOrTheme(npmName)
+  }
+
+  getRegisteredPluginOrTheme (npmName: string) {
+    return this.registeredPlugins[npmName]
+  }
+
+  getRegisteredPlugin (name: string) {
+    const npmName = PluginModel.buildNpmName(name, PluginType.PLUGIN)
+    const registered = this.getRegisteredPluginOrTheme(npmName)
+
+    if (!registered || registered.type !== PluginType.PLUGIN) return undefined
+
+    return registered
+  }
+
+  getRegisteredTheme (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)
+  }
+
+  getRegisteredSettings (npmName: string) {
+    return this.settings[npmName] || []
+  }
+
+  // ###################### 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 })
       }
     }
@@ -58,37 +139,127 @@ 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)
+
+    const plugin = this.getRegisteredPluginOrTheme(npmName)
+
+    if (!plugin) {
+      throw new Error(`Unknown plugin ${npmName} to unregister`)
+    }
+
+    delete this.registeredPlugins[plugin.npmName]
+
+    if (plugin.type === PluginType.PLUGIN) {
+      await plugin.unregister()
+
+      // Remove hooks of this plugin
+      for (const key of Object.keys(this.hooks)) {
+        this.hooks[key] = this.hooks[key].filter(h => h.pluginName !== npmName)
+      }
+
+      logger.info('Regenerating registered plugin CSS to global file.')
+      await this.regeneratePluginGlobalCSS()
+    }
   }
 
-  getRegisteredTheme (name: string) {
-    const registered = this.getRegisteredPlugin(name)
+  // ###################### Installation ######################
 
-    if (!registered || registered.type !== PluginType.THEME) return undefined
+  async install (toInstall: string, version?: string, fromDisk = false) {
+    let plugin: PluginModel
+    let npmName: string
 
-    return registered
+    logger.info('Installing plugin %s.', toInstall)
+
+    try {
+      fromDisk
+        ? await installNpmPluginFromDisk(toInstall)
+        : await installNpmPlugin(toInstall, version)
+
+      npmName = fromDisk ? basename(toInstall) : toInstall
+      const pluginType = PluginModel.getTypeFromNpmName(npmName)
+      const pluginName = PluginModel.normalizePluginName(npmName)
+
+      const packageJSON = await this.getPackageJSON(pluginName, pluginType)
+      if (!isPackageJSONValid(packageJSON, pluginType)) {
+        throw new Error('PackageJSON is invalid.')
+      }
+
+      [ 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 })
+
+      try {
+        await removeNpmPlugin(npmName)
+      } catch (err) {
+        logger.error('Cannot remove plugin %s after failed installation.', toInstall, { err })
+      }
+
+      throw err
+    }
+
+    logger.info('Successful installation of plugin %s.', toInstall)
+
+    await this.registerPluginOrTheme(plugin)
+
+    return plugin
   }
 
-  async unregister (name: string) {
-    const plugin = this.getRegisteredPlugin(name)
+  async update (toUpdate: string, version?: string, fromDisk = false) {
+    const npmName = fromDisk ? basename(toUpdate) : toUpdate
 
-    if (!plugin) {
-      throw new Error(`Unknown plugin ${name} to unregister`)
+    logger.info('Updating plugin %s.', npmName)
+
+    // Unregister old hooks
+    await this.unregister(npmName)
+
+    return this.install(toUpdate, version, fromDisk)
+  }
+
+  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 })
     }
 
-    if (plugin.type === PluginType.THEME) {
-      throw new Error(`Cannot unregister ${name}: this is a theme`)
+    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
     }
 
-    await plugin.unregister()
+    plugin.enabled = false
+    plugin.uninstalled = true
+
+    await plugin.save()
+
+    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 pluginPath = join(CONFIG.STORAGE.PLUGINS_DIR, plugin.name, plugin.version)
-    const packageJSON: PluginPackageJson = require(join(pluginPath, 'package.json'))
+    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.')
@@ -99,7 +270,13 @@ export class PluginManager {
       library = await this.registerPlugin(plugin, pluginPath, packageJSON)
     }
 
-    this.registeredPlugins[ plugin.name ] = {
+    const clientScripts: { [id: string]: ClientScript } = {}
+    for (const c of packageJSON.clientScripts) {
+      clientScripts[c.script] = c
+    }
+
+    this.registeredPlugins[ npmName ] = {
+      npmName,
       name: plugin.name,
       type: plugin.type,
       version: plugin.version,
@@ -107,42 +284,39 @@ export class PluginManager {
       peertubeEngine: plugin.peertubeEngine,
       path: pluginPath,
       staticDirs: packageJSON.staticDirs,
+      clientScripts,
       css: packageJSON.css,
       unregister: library ? library.unregister : undefined
     }
   }
 
   private async registerPlugin (plugin: PluginModel, pluginPath: string, packageJSON: PluginPackageJson) {
-    const registerHook = (options: RegisterHookOptions) => {
-      if (!this.hooks[options.target]) this.hooks[options.target] = []
+    const npmName = PluginModel.buildNpmName(plugin.name, plugin.type)
 
-      this.hooks[options.target].push({
-        pluginName: plugin.name,
-        handler: options.handler,
-        priority: options.priority || 0
-      })
-    }
+    // Delete cache if needed
+    const modulePath = join(pluginPath, packageJSON.library)
+    delete require.cache[modulePath]
+    const library: PluginLibrary = require(modulePath)
 
-    const library: PluginLibrary = require(join(pluginPath, packageJSON.library))
     if (!isLibraryCodeValid(library)) {
       throw new Error('Library code is not valid (miss register or unregister function)')
     }
 
-    library.register({ registerHook })
+    const registerHelpers = this.getRegisterHelpers(npmName, plugin)
+    library.register(registerHelpers)
+           .catch(err => logger.error('Cannot register plugin %s.', npmName, { err }))
 
-    logger.info('Add plugin %s CSS to global file.', plugin.name)
+    logger.info('Add plugin %s CSS to global file.', npmName)
 
     await this.addCSSToGlobalFile(pluginPath, packageJSON.css)
 
     return library
   }
 
-  private sortHooksByPriority () {
-    for (const hookName of Object.keys(this.hooks)) {
-      this.hooks[hookName].sort((a, b) => {
-        return b.priority - a.priority
-      })
-    }
+  // ###################### CSS ######################
+
+  private resetCSSGlobalFile () {
+    return outputFile(PLUGIN_GLOBAL_CSS_PATH, '')
   }
 
   private async addCSSToGlobalFile (pluginPath: string, cssRelativePaths: string[]) {
@@ -153,8 +327,8 @@ export class PluginManager {
 
   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)
 
@@ -163,6 +337,103 @@ export class PluginManager {
     })
   }
 
+  private async regeneratePluginGlobalCSS () {
+    await this.resetCSSGlobalFile()
+
+    for (const key of Object.keys(this.getRegisteredPlugins())) {
+      const plugin = this.registeredPlugins[key]
+
+      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 readJSON(pluginPath) as Promise<PluginPackageJson>
+  }
+
+  private getPluginPath (pluginName: string, pluginType: PluginType) {
+    const npmName = PluginModel.buildNpmName(pluginName, pluginType)
+
+    return join(CONFIG.STORAGE.PLUGINS_DIR, 'node_modules', npmName)
+  }
+
+  // ###################### 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): RegisterOptions {
+    const registerHook = (options: RegisterHookOptions) => {
+      if (serverHookObject[options.target] !== true) {
+        logger.warn('Unknown hook %s of plugin %s. Skipping.', options.target, npmName)
+        return
+      }
+
+      if (!this.hooks[options.target]) this.hooks[options.target] = []
+
+      this.hooks[options.target].push({
+        npmName,
+        pluginName: plugin.name,
+        handler: options.handler,
+        priority: options.priority || 0
+      })
+    }
+
+    const registerSetting = (options: RegisterSettingOptions) => {
+      if (!this.settings[npmName]) this.settings[npmName] = []
+
+      this.settings[npmName].push(options)
+    }
+
+    const settingsManager: PluginSettingsManager = {
+      getSetting: (name: string) => PluginModel.getSetting(plugin.name, plugin.type, name),
+
+      setSetting: (name: string, value: string) => PluginModel.setSetting(plugin.name, plugin.type, name, value)
+    }
+
+    const storageManager: PluginStorageManager = {
+      getData: (key: string) => PluginModel.getData(plugin.name, plugin.type, key),
+
+      storeData: (key: string, data: any) => PluginModel.storeData(plugin.name, plugin.type, key, data)
+    }
+
+    const peertubeHelpers = {
+      logger
+    }
+
+    return {
+      registerHook,
+      registerSetting,
+      settingsManager,
+      storageManager,
+      peertubeHelpers
+    }
+  }
+
   static get Instance () {
     return this.instance || (this.instance = new this())
   }