X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Fplugins%2Fplugin-manager.ts;h=73f7a71ceafee1627ac2c435d59def472555d059;hb=7024e9120b381b5b3201212f5a18f5cdc14e15ff;hp=ac31b06dc1a3593f930541dfbecbea6bb1ad33dc;hpb=32fe00138990627749da58ff9f845584013aa219;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/plugins/plugin-manager.ts b/server/lib/plugins/plugin-manager.ts index ac31b06dc..73f7a71ce 100644 --- a/server/lib/plugins/plugin-manager.ts +++ b/server/lib/plugins/plugin-manager.ts @@ -3,20 +3,29 @@ import { logger } from '../../helpers/logger' 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 { + ClientScript, + PluginPackageJson, + PluginTranslationPaths as PackagePluginTranslations +} from '../../../shared/models/plugins/plugin-package-json.model' import { createReadStream, createWriteStream } from 'fs' -import { PLUGIN_GLOBAL_CSS_PATH } from '../../initializers/constants' +import { PLUGIN_GLOBAL_CSS_PATH, VIDEO_CATEGORIES, VIDEO_LANGUAGES, VIDEO_LICENCES } from '../../initializers/constants' import { PluginType } from '../../../shared/models/plugins/plugin.type' import { installNpmPlugin, installNpmPluginFromDisk, removeNpmPlugin } from './yarn' -import { outputFile } from 'fs-extra' -import { RegisterSettingOptions } from '../../../shared/models/plugins/register-setting.model' -import { RegisterHookOptions } from '../../../shared/models/plugins/register-hook.model' +import { outputFile, readJSON } from 'fs-extra' import { PluginSettingsManager } from '../../../shared/models/plugins/plugin-settings-manager.model' import { PluginStorageManager } from '../../../shared/models/plugins/plugin-storage-manager.model' -import { ServerHook, ServerHookName } from '../../../shared/models/plugins/server-hook.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 { RegisterServerOptions } from '../../typings/plugins/register-server-option.model' import { PluginLibrary } from '../../typings/plugins' +import { ClientHtml } from '../client-html' +import { RegisterServerHookOptions } from '../../../shared/models/plugins/register-server-hook.model' +import { RegisterServerSettingOptions } from '../../../shared/models/plugins/register-server-setting.model' +import { PluginVideoLanguageManager } from '../../../shared/models/plugins/plugin-video-language-manager.model' +import { PluginVideoCategoryManager } from '../../../shared/models/plugins/plugin-video-category-manager.model' +import { PluginVideoLicenceManager } from '../../../shared/models/plugins/plugin-video-licence-manager.model' +import { PluginTranslation } from '../../../shared/models/plugins/plugin-translation.model' export interface RegisteredPlugin { npmName: string @@ -45,13 +54,35 @@ export interface HookInformationValue { priority: number } +type AlterableVideoConstant = 'language' | 'licence' | 'category' +type VideoConstant = { [key in number | string]: string } +type UpdatedVideoConstant = { + [name in AlterableVideoConstant]: { + [npmName: string]: { + added: { key: number | string, label: string }[] + deleted: { key: number | string, label: string }[] + } + } +} + +type PluginLocalesTranslations = { + [locale: string]: PluginTranslation +} + 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 registeredPlugins: { [name: string]: RegisteredPlugin } = {} + private settings: { [name: string]: RegisterServerSettingOptions[] } = {} + private hooks: { [name: string]: HookInformationValue[] } = {} + private translations: PluginLocalesTranslations = {} + + private readonly updatedVideoConstants: UpdatedVideoConstant = { + language: {}, + licence: {}, + category: {} + } private constructor () { } @@ -96,17 +127,21 @@ export class PluginManager implements ServerHook { return this.settings[npmName] || [] } - // ###################### Hooks ###################### + getTranslations (locale: string) { + return this.translations[locale] || {} + } - async runHook (hookName: ServerHookName, param?: any) { - let result = param + // ###################### Hooks ###################### - 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 }) }) } @@ -125,6 +160,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 }) } } @@ -143,15 +185,20 @@ export class PluginManager implements ServerHook { } delete this.registeredPlugins[plugin.npmName] + delete this.settings[plugin.npmName] + + this.deleteTranslations(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) + this.hooks[key] = this.hooks[key].filter(h => h.npmName !== npmName) } + this.reinitVideoConstants(plugin.npmName) + logger.info('Regenerating registered plugin CSS to global file.') await this.regeneratePluginGlobalCSS() } @@ -174,10 +221,9 @@ export class PluginManager implements ServerHook { 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, @@ -251,12 +297,10 @@ 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)) { - throw new Error('Package.JSON is invalid.') - } + this.sanitizeAndCheckPackageJSONOrThrow(packageJSON, plugin.type) let library: PluginLibrary if (plugin.type === PluginType.PLUGIN) { @@ -268,7 +312,7 @@ export class PluginManager implements ServerHook { clientScripts[c.script] = c } - this.registeredPlugins[ npmName ] = { + this.registeredPlugins[npmName] = { npmName, name: plugin.name, type: plugin.type, @@ -281,12 +325,17 @@ export class PluginManager implements ServerHook { css: packageJSON.css, unregister: library ? library.unregister : undefined } + + await this.addTranslations(plugin, npmName, packageJSON.translations) } private async registerPlugin (plugin: PluginModel, pluginPath: string, packageJSON: PluginPackageJson) { 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) + 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)') @@ -303,9 +352,33 @@ export class PluginManager implements ServerHook { return library } + // ###################### Translations ###################### + + private async addTranslations (plugin: PluginModel, npmName: string, translationPaths: PackagePluginTranslations) { + for (const locale of Object.keys(translationPaths)) { + const path = translationPaths[locale] + const json = await readJSON(join(this.getPluginPath(plugin.name, plugin.type), path)) + + if (!this.translations[locale]) this.translations[locale] = {} + this.translations[locale][npmName] = json + + logger.info('Added locale %s of plugin %s.', locale, 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, '') } @@ -313,6 +386,8 @@ export class PluginManager implements ServerHook { for (const cssPath of cssRelativePaths) { await this.concatFiles(join(pluginPath, cssPath), PLUGIN_GLOBAL_CSS_PATH) } + + ClientHtml.invalidCache() } private concatFiles (input: string, output: string) { @@ -330,9 +405,7 @@ export class PluginManager implements ServerHook { private async regeneratePluginGlobalCSS () { await this.resetCSSGlobalFile() - for (const key of Object.keys(this.getRegisteredPlugins())) { - const plugin = this.registeredPlugins[key] - + for (const plugin of this.getRegisteredPlugins()) { await this.addCSSToGlobalFile(plugin.path, plugin.css) } } @@ -350,7 +423,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) { @@ -365,7 +438,7 @@ export class PluginManager implements ServerHook { const plugins: RegisteredPlugin[] = [] for (const npmName of Object.keys(this.registeredPlugins)) { - const plugin = this.registeredPlugins[ npmName ] + const plugin = this.registeredPlugins[npmName] if (plugin.type !== type) continue plugins.push(plugin) @@ -376,8 +449,13 @@ export class PluginManager implements ServerHook { // ###################### Generate register helpers ###################### - private getRegisterHelpers (npmName: string, plugin: PluginModel): RegisterOptions { - const registerHook = (options: RegisterHookOptions) => { + private getRegisterHelpers (npmName: string, plugin: PluginModel): RegisterServerOptions { + const registerHook = (options: RegisterServerHookOptions) => { + 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({ @@ -388,7 +466,7 @@ export class PluginManager implements ServerHook { }) } - const registerSetting = (options: RegisterSettingOptions) => { + const registerSetting = (options: RegisterServerSettingOptions) => { if (!this.settings[npmName]) this.settings[npmName] = [] this.settings[npmName].push(options) @@ -406,6 +484,24 @@ export class PluginManager implements ServerHook { storeData: (key: string, data: any) => PluginModel.storeData(plugin.name, plugin.type, key, data) } + const videoLanguageManager: PluginVideoLanguageManager = { + addLanguage: (key: string, label: string) => this.addConstant({ npmName, type: 'language', obj: VIDEO_LANGUAGES, key, label }), + + deleteLanguage: (key: string) => this.deleteConstant({ npmName, type: 'language', obj: VIDEO_LANGUAGES, key }) + } + + const videoCategoryManager: PluginVideoCategoryManager = { + addCategory: (key: number, label: string) => this.addConstant({ npmName, type: 'category', obj: VIDEO_CATEGORIES, key, label }), + + deleteCategory: (key: number) => this.deleteConstant({ npmName, type: 'category', obj: VIDEO_CATEGORIES, key }) + } + + const videoLicenceManager: PluginVideoLicenceManager = { + addLicence: (key: number, label: string) => this.addConstant({ npmName, type: 'licence', obj: VIDEO_LICENCES, key, label }), + + deleteLicence: (key: number) => this.deleteConstant({ npmName, type: 'licence', obj: VIDEO_LICENCES, key }) + } + const peertubeHelpers = { logger } @@ -415,10 +511,105 @@ export class PluginManager implements ServerHook { registerSetting, settingsManager, storageManager, + videoLanguageManager, + videoCategoryManager, + videoLicenceManager, peertubeHelpers } } + private addConstant (parameters: { + npmName: string + type: AlterableVideoConstant + obj: VideoConstant + key: T + label: string + }) { + const { npmName, type, obj, key, label } = parameters + + if (obj[key]) { + logger.warn('Cannot add %s %s by plugin %s: key already exists.', type, npmName, key) + return false + } + + if (!this.updatedVideoConstants[type][npmName]) { + this.updatedVideoConstants[type][npmName] = { + added: [], + deleted: [] + } + } + + this.updatedVideoConstants[type][npmName].added.push({ key, label }) + obj[key] = label + + return true + } + + private deleteConstant (parameters: { + npmName: string + type: AlterableVideoConstant + obj: VideoConstant + key: T + }) { + const { npmName, type, obj, key } = parameters + + if (!obj[key]) { + logger.warn('Cannot delete %s %s by plugin %s: key does not exist.', type, npmName, key) + return false + } + + if (!this.updatedVideoConstants[type][npmName]) { + this.updatedVideoConstants[type][npmName] = { + added: [], + deleted: [] + } + } + + this.updatedVideoConstants[type][npmName].deleted.push({ key, label: obj[key] }) + delete obj[key] + + return true + } + + private reinitVideoConstants (npmName: string) { + const hash = { + language: VIDEO_LANGUAGES, + licence: VIDEO_LICENCES, + category: VIDEO_CATEGORIES + } + const types: AlterableVideoConstant[] = [ 'language', 'licence', 'category' ] + + for (const type of types) { + const updatedConstants = this.updatedVideoConstants[type][npmName] + if (!updatedConstants) continue + + for (const added of updatedConstants.added) { + delete hash[type][added.key] + } + + for (const deleted of updatedConstants.deleted) { + hash[type][deleted.key] = deleted.label + } + + delete this.updatedVideoConstants[type][npmName] + } + } + + 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 () { return this.instance || (this.instance = new this()) }