X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Fplugins%2Fplugin-manager.ts;h=73f7a71ceafee1627ac2c435d59def472555d059;hb=7024e9120b381b5b3201212f5a18f5cdc14e15ff;hp=b898e64fa2084a16cd7de0809c96cc6e4da7ff89;hpb=2c0539420d77339e6afe8d7920b44af4c0dcb1e6;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/plugins/plugin-manager.ts b/server/lib/plugins/plugin-manager.ts index b898e64fa..73f7a71ce 100644 --- a/server/lib/plugins/plugin-manager.ts +++ b/server/lib/plugins/plugin-manager.ts @@ -1,18 +1,34 @@ import { PluginModel } from '../../models/server/plugin' import { logger } from '../../helpers/logger' -import { RegisterHookOptions } from '../../../shared/models/plugins/register.model' 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 { + 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 { 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, serverHookObject } from '../../../shared/models/plugins/server-hook.model' +import { getHookType, internalRunHook } from '../../../shared/core-utils/plugins/hooks' +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 name: string version: string description: string @@ -32,22 +48,110 @@ export interface RegisteredPlugin { } export interface HookInformationValue { + npmName: string pluginName: string handler: Function priority: number } -export class PluginManager { +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 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 () { } - 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] || [] + } + + getTranslations (locale: string) { + return this.translations[locale] || {} + } + + // ###################### Hooks ###################### + + 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]) { + 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() @@ -56,6 +160,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 }) } } @@ -63,45 +174,41 @@ export class PluginManager { this.sortHooksByPriority() } - getRegisteredPlugin (name: string) { - return this.registeredPlugins[ name ] - } - - getRegisteredTheme (name: string) { - const registered = this.getRegisteredPlugin(name) - - if (!registered || registered.type !== PluginType.THEME) return undefined + // Don't need the plugin type since themes cannot register server code + async unregister (npmName: string) { + logger.info('Unregister plugin %s.', npmName) - return registered - } - - async unregister (name: string) { - const plugin = this.getRegisteredPlugin(name) + const plugin = this.getRegisteredPluginOrTheme(npmName) if (!plugin) { - throw new Error(`Unknown plugin ${name} to unregister`) + throw new Error(`Unknown plugin ${npmName} to unregister`) } - if (plugin.type === PluginType.THEME) { - throw new Error(`Cannot unregister ${name}: this is a theme`) - } + delete this.registeredPlugins[plugin.npmName] + delete this.settings[plugin.npmName] - await plugin.unregister() + this.deleteTranslations(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.npmName !== npmName) + } + + this.reinitVideoConstants(plugin.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() + } } - async install (toInstall: string, version: string, fromDisk = false) { + // ###################### Installation ###################### + + async install (toInstall: string, version?: string, fromDisk = false) { let plugin: PluginModel - let name: string + let npmName: string logger.info('Installing plugin %s.', toInstall) @@ -110,18 +217,18 @@ export class PluginManager { ? await installNpmPluginFromDisk(toInstall) : await installNpmPlugin(toInstall, version) - name = fromDisk ? basename(toInstall) : toInstall - const pluginType = name.startsWith('peertube-theme-') ? PluginType.THEME : PluginType.PLUGIN - const pluginName = this.normalizePluginName(name) + npmName = fromDisk ? basename(toInstall) : toInstall + 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, description: packageJSON.description, + homepage: packageJSON.homepage, type: pluginType, version: packageJSON.version, enabled: true, @@ -132,7 +239,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 }) } @@ -143,22 +250,33 @@ export class PluginManager { logger.info('Successful installation of plugin %s.', toInstall) await this.registerPluginOrTheme(plugin) + + return plugin } - async uninstall (packageName: string) { - logger.info('Uninstalling plugin %s.', packageName) + 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) + } - const pluginName = this.normalizePluginName(packageName) + async uninstall (npmName: string) { + logger.info('Uninstalling plugin %s.', 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.load(pluginName) + 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.', packageName) + logger.error('Cannot uninstall plugin %s: it does not exist or is already uninstalled.', npmName) return } @@ -167,20 +285,22 @@ export class PluginManager { await plugin.save() - await removeNpmPlugin(packageName) + await removeNpmPlugin(npmName) - logger.info('Plugin %s uninstalled.', packageName) + 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 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) { @@ -192,7 +312,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, @@ -204,43 +325,60 @@ export class PluginManager { 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 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 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)') } - 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 - }) + // ###################### 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, '') } @@ -248,6 +386,8 @@ export class PluginManager { for (const cssPath of cssRelativePaths) { await this.concatFiles(join(pluginPath, cssPath), PLUGIN_GLOBAL_CSS_PATH) } + + ClientHtml.invalidCache() } private concatFiles (input: string, output: string) { @@ -262,29 +402,211 @@ export class PluginManager { }) } + private async regeneratePluginGlobalCSS () { + await this.resetCSSGlobalFile() + + for (const plugin of this.getRegisteredPlugins()) { + 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 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 normalizePluginName (name: string) { - return name.replace(/^peertube-((theme)|(plugin))-/, '') + // ###################### 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 } - private async regeneratePluginGlobalCSS () { - await this.resetCSSGlobalFile() + // ###################### Generate register helpers ###################### - for (const key of Object.keys(this.registeredPlugins)) { - const plugin = this.registeredPlugins[key] + 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 + } - await this.addCSSToGlobalFile(plugin.path, plugin.css) + 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: RegisterServerSettingOptions) => { + 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 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 + } + + return { + registerHook, + 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}).`) } }