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
priority: number
}
-export class PluginManager {
+export class PluginManager implements ServerHook {
private static instance: PluginManager
// ###################### Getters ######################
+ isRegistered (npmName: string) {
+ return !!this.getRegisteredPluginOrTheme(npmName)
+ }
+
getRegisteredPluginOrTheme (npmName: string) {
return this.registeredPlugins[npmName]
}
// ###################### Hooks ######################
- async runHook (hookName: string, param?: any) {
- let result = param
-
- if (!this.hooks[hookName]) return result
+ async runHook <T> (hookName: ServerHookName, result?: T, params?: any): Promise<T> {
+ 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
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 })
}
}
throw new Error(`Unknown plugin ${npmName} to unregister`)
}
+ delete this.registeredPlugins[plugin.npmName]
+
if (plugin.type === PluginType.PLUGIN) {
await plugin.unregister()
logger.info('Regenerating registered plugin CSS to global file.')
await this.regeneratePluginGlobalCSS()
}
-
- delete this.registeredPlugins[plugin.npmName]
}
// ###################### Installation ######################
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.')
}
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)) {
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
- })
+ 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)
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)
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) {
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())
}