X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Fplugins%2Fplugin-manager.ts;h=cfe63e50d1a681dc1d94028382572a88a0b15cdd;hb=7663e55a2cc46a413bceee2787d48902b15ae642;hp=8cdeff446f0bb4c57f79bb4a72f2bb7ec2be14e3;hpb=dba85a1e9e9f603ba52e1ea42deaf3fdd799b1d8;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/plugins/plugin-manager.ts b/server/lib/plugins/plugin-manager.ts index 8cdeff446..cfe63e50d 100644 --- a/server/lib/plugins/plugin-manager.ts +++ b/server/lib/plugins/plugin-manager.ts @@ -4,17 +4,22 @@ import { basename, join } from 'path' import { CONFIG } from '../../initializers/config' import { isLibraryCodeValid, isPackageJSONValid } from '../../helpers/custom-validators/plugins' import { ClientScript, PluginPackageJson } from '../../../shared/models/plugins/plugin-package-json.model' -import { PluginLibrary } from '../../../shared/models/plugins/plugin-library.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 } from 'fs-extra' +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 @@ -34,12 +39,13 @@ 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 @@ -52,12 +58,17 @@ export class PluginManager { // ###################### Getters ###################### - getRegisteredPluginOrTheme (name: string) { - return this.registeredPlugins[name] + isRegistered (npmName: string) { + return !!this.getRegisteredPluginOrTheme(npmName) + } + + getRegisteredPluginOrTheme (npmName: string) { + return this.registeredPlugins[npmName] } getRegisteredPlugin (name: string) { - const registered = this.getRegisteredPluginOrTheme(name) + const npmName = PluginModel.buildNpmName(name, PluginType.PLUGIN) + const registered = this.getRegisteredPluginOrTheme(npmName) if (!registered || registered.type !== PluginType.PLUGIN) return undefined @@ -65,7 +76,8 @@ export class PluginManager { } getRegisteredTheme (name: string) { - const registered = this.getRegisteredPluginOrTheme(name) + const npmName = PluginModel.buildNpmName(name, PluginType.THEME) + const registered = this.getRegisteredPluginOrTheme(npmName) if (!registered || registered.type !== PluginType.THEME) return undefined @@ -80,29 +92,23 @@ export class PluginManager { return this.getRegisteredPluginsOrThemes(PluginType.THEME) } - getSettings (name: string) { - return this.settings[name] || [] + getRegisteredSettings (npmName: string) { + return this.settings[npmName] || [] } // ###################### Hooks ###################### - async runHook (hookName: string, param?: any) { - let result = param - - if (!this.hooks[hookName]) return result + async runHook (hookName: ServerHookName, result?: T, params?: any): Promise { + if (!this.hooks[hookName]) return Promise.resolve(result) - const wait = hookName.startsWith('static:') + const hookType = getHookType(hookName) for (const hook of this.hooks[hookName]) { - try { - if (wait) { - result = await hook.handler(param) - } else { - result = hook.handler() - } - } catch (err) { + 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 @@ -119,6 +125,13 @@ export class PluginManager { 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 }) } } @@ -126,35 +139,36 @@ export class PluginManager { this.sortHooksByPriority() } - async unregister (name: string) { - const plugin = this.getRegisteredPlugin(name) + // Don't need the plugin type since themes cannot register server code + async unregister (npmName: string) { + logger.info('Unregister plugin %s.', npmName) - if (!plugin) { - throw new Error(`Unknown plugin ${name} to unregister`) - } + const plugin = this.getRegisteredPluginOrTheme(npmName) - if (plugin.type === PluginType.THEME) { - throw new Error(`Cannot unregister ${name}: this is a theme`) + if (!plugin) { + throw new Error(`Unknown plugin ${npmName} to unregister`) } - await plugin.unregister() + delete this.registeredPlugins[plugin.npmName] - // Remove hooks of this plugin - for (const key of Object.keys(this.hooks)) { - this.hooks[key] = this.hooks[key].filter(h => h.pluginName !== name) - } + if (plugin.type === PluginType.PLUGIN) { + await plugin.unregister() - delete this.registeredPlugins[plugin.name] + // 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() + logger.info('Regenerating registered plugin CSS to global file.') + await this.regeneratePluginGlobalCSS() + } } // ###################### Installation ###################### async install (toInstall: string, version?: string, fromDisk = false) { let plugin: PluginModel - let name: string + let npmName: string logger.info('Installing plugin %s.', toInstall) @@ -163,11 +177,11 @@ export class PluginManager { ? await installNpmPluginFromDisk(toInstall) : await installNpmPlugin(toInstall, version) - name = fromDisk ? basename(toInstall) : toInstall - const pluginType = PluginModel.getTypeFromNpmName(name) - const pluginName = PluginModel.normalizePluginName(name) + npmName = fromDisk ? basename(toInstall) : toInstall + const pluginType = PluginModel.getTypeFromNpmName(npmName) + const pluginName = PluginModel.normalizePluginName(npmName) - const packageJSON = this.getPackageJSON(pluginName, pluginType) + const packageJSON = await this.getPackageJSON(pluginName, pluginType) if (!isPackageJSONValid(packageJSON, pluginType)) { throw new Error('PackageJSON is invalid.') } @@ -186,7 +200,7 @@ export class PluginManager { logger.error('Cannot install plugin %s, removing it...', toInstall, { err }) try { - await removeNpmPlugin(name) + await removeNpmPlugin(npmName) } catch (err) { logger.error('Cannot remove plugin %s after failed installation.', toInstall, { err }) } @@ -197,17 +211,28 @@ export class PluginManager { logger.info('Successful installation of plugin %s.', toInstall) await this.registerPluginOrTheme(plugin) + + return plugin + } + + async update (toUpdate: string, version?: string, fromDisk = false) { + const npmName = fromDisk ? basename(toUpdate) : toUpdate + + 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) - const pluginName = PluginModel.normalizePluginName(npmName) - try { - await this.unregister(pluginName) + await this.unregister(npmName) } catch (err) { - logger.warn('Cannot unregister plugin %s.', pluginName, { err }) + logger.warn('Cannot unregister plugin %s.', npmName, { err }) } const plugin = await PluginModel.loadByNpmName(npmName) @@ -229,9 +254,11 @@ export class PluginManager { // ###################### Private register ###################### private async registerPluginOrTheme (plugin: PluginModel) { - logger.info('Registering plugin or theme %s.', plugin.name) + const npmName = PluginModel.buildNpmName(plugin.name, plugin.type) - const packageJSON = this.getPackageJSON(plugin.name, plugin.type) + logger.info('Registering plugin or theme %s.', npmName) + + const packageJSON = await this.getPackageJSON(plugin.name, plugin.type) const pluginPath = this.getPluginPath(plugin.name, plugin.type) if (!isPackageJSONValid(packageJSON, plugin.type)) { @@ -248,7 +275,8 @@ export class PluginManager { clientScripts[c.script] = c } - this.registeredPlugins[ plugin.name ] = { + this.registeredPlugins[ npmName ] = { + npmName, name: plugin.name, type: plugin.type, version: plugin.version, @@ -263,37 +291,22 @@ export class PluginManager { } 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 registerSetting = (options: RegisterSettingOptions) => { - if (!this.settings[plugin.name]) this.settings[plugin.name] = [] + const npmName = PluginModel.buildNpmName(plugin.name, plugin.type) - this.settings[plugin.name].push(options) - } - - const settingsManager: PluginSettingsManager = { - getSetting: (name: string) => PluginModel.getSetting(plugin.name, name), - - setSetting: (name: string, value: string) => PluginModel.setSetting(plugin.name, name, value) - } - - const library: PluginLibrary = require(join(pluginPath, packageJSON.library)) + // Delete cache if needed + const modulePath = join(pluginPath, packageJSON.library) + delete require.cache[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, registerSetting, settingsManager }) + 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) @@ -327,7 +340,7 @@ export class PluginManager { private async regeneratePluginGlobalCSS () { await this.resetCSSGlobalFile() - for (const key of Object.keys(this.registeredPlugins)) { + for (const key of Object.keys(this.getRegisteredPlugins())) { const plugin = this.registeredPlugins[key] await this.addCSSToGlobalFile(plugin.path, plugin.css) @@ -347,13 +360,13 @@ export class PluginManager { 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 } 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', prefix + pluginName) + return join(CONFIG.STORAGE.PLUGINS_DIR, 'node_modules', npmName) } // ###################### Private getters ###################### @@ -361,8 +374,8 @@ export class PluginManager { private getRegisteredPluginsOrThemes (type: PluginType) { const plugins: RegisteredPlugin[] = [] - for (const pluginName of Object.keys(this.registeredPlugins)) { - const plugin = this.registeredPlugins[ pluginName ] + for (const npmName of Object.keys(this.registeredPlugins)) { + const plugin = this.registeredPlugins[ npmName ] if (plugin.type !== type) continue plugins.push(plugin) @@ -371,6 +384,56 @@ export class PluginManager { 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()) }