X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Fplugins%2Fplugin-manager.ts;h=cfe63e50d1a681dc1d94028382572a88a0b15cdd;hb=7663e55a2cc46a413bceee2787d48902b15ae642;hp=e76dbb53e00a8a5e8590206319aa7df9af480fd3;hpb=60cfd4cb54138e7da76054aa163b33b3223b17ef;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/plugins/plugin-manager.ts b/server/lib/plugins/plugin-manager.ts index e76dbb53e..cfe63e50d 100644 --- a/server/lib/plugins/plugin-manager.ts +++ b/server/lib/plugins/plugin-manager.ts @@ -4,20 +4,19 @@ 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 { ServerHookName, ServerHook } from '../../../shared/models/plugins/server-hook.model' -import { isCatchable, isPromise } from '../../../shared/core-utils/miscs/miscs' +import { ServerHook, ServerHookName, serverHookObject } from '../../../shared/models/plugins/server-hook.model' import { getHookType, internalRunHook } from '../../../shared/core-utils/plugins/hooks' -import { HookType } from '../../../shared/models/plugins/hook-type.enum' +import { RegisterOptions } from '../../typings/plugins/register-options.model' +import { PluginLibrary } from '../../typings/plugins' export interface RegisteredPlugin { npmName: string @@ -99,15 +98,15 @@ export class PluginManager implements ServerHook { // ###################### Hooks ###################### - async runHook (hookName: ServerHookName, 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 hookType = getHookType(hookName) for (const hook of this.hooks[hookName]) { - result = await internalRunHook(hook.handler, hookType, param, 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 }) }) } @@ -126,6 +125,13 @@ export class PluginManager implements ServerHook { 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 }) } } @@ -175,7 +181,7 @@ export class PluginManager implements ServerHook { 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.') } @@ -252,7 +258,7 @@ export class PluginManager implements ServerHook { 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)) { @@ -287,47 +293,18 @@ export class PluginManager implements ServerHook { private async registerPlugin (plugin: PluginModel, pluginPath: string, packageJSON: PluginPackageJson) { const npmName = PluginModel.buildNpmName(plugin.name, plugin.type) - const registerHook = (options: RegisterHookOptions) => { - 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 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, - storageManager - }).catch(err => logger.error('Cannot register plugin %s.', npmName, { err })) + 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.', npmName) @@ -383,7 +360,7 @@ export class PluginManager implements ServerHook { 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) { @@ -407,6 +384,56 @@ export class PluginManager implements ServerHook { 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()) }