PeerTube/server/lib/plugins/plugin-manager.ts

617 lines
19 KiB
TypeScript
Raw Normal View History

import { PluginModel } from '../../models/server/plugin'
import { logger } from '../../helpers/logger'
2019-07-05 15:28:49 +02:00
import { basename, join } from 'path'
import { CONFIG } from '../../initializers/config'
import { isLibraryCodeValid, isPackageJSONValid } from '../../helpers/custom-validators/plugins'
2019-07-26 14:44:50 +02:00
import {
ClientScript,
PluginPackageJson,
PluginTranslationPaths as PackagePluginTranslations
} from '../../../shared/models/plugins/plugin-package-json.model'
import { createReadStream, createWriteStream } from 'fs'
import { PLUGIN_GLOBAL_CSS_PATH, VIDEO_CATEGORIES, VIDEO_LANGUAGES, VIDEO_LICENCES } from '../../initializers/constants'
import { PluginType } from '../../../shared/models/plugins/plugin.type'
2019-07-05 15:28:49 +02:00
import { installNpmPlugin, installNpmPluginFromDisk, removeNpmPlugin } from './yarn'
2019-07-19 14:36:04 +02:00
import { outputFile, readJSON } from 'fs-extra'
import { PluginSettingsManager } from '../../../shared/models/plugins/plugin-settings-manager.model'
2019-07-12 14:06:33 +02:00
import { PluginStorageManager } from '../../../shared/models/plugins/plugin-storage-manager.model'
2019-07-22 16:31:47 +02:00
import { ServerHook, ServerHookName, serverHookObject } from '../../../shared/models/plugins/server-hook.model'
2019-07-18 14:28:37 +02:00
import { getHookType, internalRunHook } from '../../../shared/core-utils/plugins/hooks'
2019-07-24 11:17:42 +02:00
import { RegisterServerOptions } from '../../typings/plugins/register-server-option.model'
2019-07-18 16:43:41 +02:00
import { PluginLibrary } from '../../typings/plugins'
2019-07-23 09:48:48 +02:00
import { ClientHtml } from '../client-html'
2019-07-24 11:17:42 +02:00
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'
2019-07-26 14:44:50 +02:00
import { PluginTranslation } from '../../../shared/models/plugins/plugin-translation.model'
export interface RegisteredPlugin {
2019-07-12 11:39:58 +02:00
npmName: string
name: string
version: string
description: string
peertubeEngine: string
type: PluginType
path: string
staticDirs: { [name: string]: string }
2019-07-08 14:02:03 +02:00
clientScripts: { [name: string]: ClientScript }
css: string[]
// Only if this is a plugin
unregister?: Function
}
export interface HookInformationValue {
2019-07-12 11:39:58 +02:00
npmName: string
pluginName: string
handler: Function
priority: number
}
type AlterableVideoConstant = 'language' | 'licence' | 'category'
2020-01-31 16:56:52 +01:00
type VideoConstant = { [key in number | string]: string }
type UpdatedVideoConstant = {
2020-01-31 16:56:52 +01:00
[name in AlterableVideoConstant]: {
[npmName: string]: {
added: { key: number | string, label: string }[]
deleted: { key: number | string, label: string }[]
}
}
}
2019-07-26 14:44:50 +02:00
type PluginLocalesTranslations = {
2020-01-31 16:56:52 +01:00
[locale: string]: PluginTranslation
2019-07-26 14:44:50 +02:00
}
2019-07-18 14:28:37 +02:00
export class PluginManager implements ServerHook {
private static instance: PluginManager
2020-01-31 16:56:52 +01:00
private registeredPlugins: { [name: string]: RegisteredPlugin } = {}
private settings: { [name: string]: RegisterServerSettingOptions[] } = {}
private hooks: { [name: string]: HookInformationValue[] } = {}
2019-07-26 14:44:50 +02:00
private translations: PluginLocalesTranslations = {}
2020-01-31 16:56:52 +01:00
private readonly updatedVideoConstants: UpdatedVideoConstant = {
language: {},
licence: {},
category: {}
}
private constructor () {
}
// ###################### Getters ######################
isRegistered (npmName: string) {
return !!this.getRegisteredPluginOrTheme(npmName)
}
2019-07-12 11:39:58 +02:00
getRegisteredPluginOrTheme (npmName: string) {
return this.registeredPlugins[npmName]
2019-07-09 11:45:19 +02:00
}
getRegisteredPlugin (name: string) {
2019-07-12 11:39:58 +02:00
const npmName = PluginModel.buildNpmName(name, PluginType.PLUGIN)
const registered = this.getRegisteredPluginOrTheme(npmName)
2019-07-09 11:45:19 +02:00
if (!registered || registered.type !== PluginType.PLUGIN) return undefined
return registered
}
getRegisteredTheme (name: string) {
2019-07-12 11:39:58 +02:00
const npmName = PluginModel.buildNpmName(name, PluginType.THEME)
const registered = this.getRegisteredPluginOrTheme(npmName)
if (!registered || registered.type !== PluginType.THEME) return undefined
return registered
}
2019-07-08 15:54:08 +02:00
getRegisteredPlugins () {
2019-07-09 11:45:19 +02:00
return this.getRegisteredPluginsOrThemes(PluginType.PLUGIN)
}
getRegisteredThemes () {
return this.getRegisteredPluginsOrThemes(PluginType.THEME)
2019-07-08 15:54:08 +02:00
}
2019-07-12 11:39:58 +02:00
getRegisteredSettings (npmName: string) {
return this.settings[npmName] || []
}
2019-07-26 14:44:50 +02:00
getTranslations (locale: string) {
return this.translations[locale] || {}
}
// ###################### Hooks ######################
2020-01-31 16:56:52 +01:00
async runHook<T> (hookName: ServerHookName, result?: T, params?: any): Promise<T> {
2019-07-19 17:30:41 +02:00
if (!this.hooks[hookName]) return Promise.resolve(result)
2019-07-18 14:28:37 +02:00
const hookType = getHookType(hookName)
2019-07-08 15:54:08 +02:00
for (const hook of this.hooks[hookName]) {
2019-07-19 17:30:41 +02:00
logger.debug('Running hook %s of plugin %s.', hookName, hook.npmName)
result = await internalRunHook(hook.handler, hookType, result, params, err => {
2019-07-08 15:54:08 +02:00
logger.error('Cannot run hook %s of plugin %s.', hookName, hook.pluginName, { err })
2019-07-18 14:28:37 +02:00
})
2019-07-08 15:54:08 +02:00
}
return result
}
// ###################### Registration ######################
async registerPluginsAndThemes () {
await this.resetCSSGlobalFile()
const plugins = await PluginModel.listEnabledPluginsAndThemes()
for (const plugin of plugins) {
try {
await this.registerPluginOrTheme(plugin)
} catch (err) {
2019-07-22 11:18:22 +02:00
// 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 })
}
}
this.sortHooksByPriority()
}
2019-07-12 11:39:58 +02:00
// Don't need the plugin type since themes cannot register server code
async unregister (npmName: string) {
logger.info('Unregister plugin %s.', npmName)
const plugin = this.getRegisteredPluginOrTheme(npmName)
if (!plugin) {
2019-07-12 11:39:58 +02:00
throw new Error(`Unknown plugin ${npmName} to unregister`)
}
2019-07-18 15:56:42 +02:00
delete this.registeredPlugins[plugin.npmName]
2019-07-25 19:02:54 +02:00
delete this.settings[plugin.npmName]
2019-07-18 15:56:42 +02:00
2019-07-26 14:44:50 +02:00
this.deleteTranslations(plugin.npmName)
2019-07-12 11:39:58 +02:00
if (plugin.type === PluginType.PLUGIN) {
await plugin.unregister()
2019-07-12 11:39:58 +02:00
// Remove hooks of this plugin
for (const key of Object.keys(this.hooks)) {
this.hooks[key] = this.hooks[key].filter(h => h.npmName !== npmName)
2019-07-12 11:39:58 +02:00
}
2019-07-08 14:02:03 +02:00
this.reinitVideoConstants(plugin.npmName)
2019-07-12 11:39:58 +02:00
logger.info('Regenerating registered plugin CSS to global file.')
await this.regeneratePluginGlobalCSS()
2019-07-08 14:02:03 +02:00
}
}
// ###################### Installation ######################
async install (toInstall: string, version?: string, fromDisk = false) {
2019-07-05 15:28:49 +02:00
let plugin: PluginModel
2019-07-12 11:39:58 +02:00
let npmName: string
2019-07-05 15:28:49 +02:00
logger.info('Installing plugin %s.', toInstall)
try {
fromDisk
? await installNpmPluginFromDisk(toInstall)
: await installNpmPlugin(toInstall, version)
2019-07-12 11:39:58 +02:00
npmName = fromDisk ? basename(toInstall) : toInstall
const pluginType = PluginModel.getTypeFromNpmName(npmName)
const pluginName = PluginModel.normalizePluginName(npmName)
2019-07-05 15:28:49 +02:00
2019-07-19 14:36:04 +02:00
const packageJSON = await this.getPackageJSON(pluginName, pluginType)
this.sanitizeAndCheckPackageJSONOrThrow(packageJSON, pluginType);
2019-07-05 15:28:49 +02:00
[ plugin ] = await PluginModel.upsert({
name: pluginName,
description: packageJSON.description,
homepage: packageJSON.homepage,
2019-07-05 15:28:49 +02:00
type: pluginType,
version: packageJSON.version,
enabled: true,
uninstalled: false,
peertubeEngine: packageJSON.engine.peertube
}, { returning: true })
} catch (err) {
logger.error('Cannot install plugin %s, removing it...', toInstall, { err })
try {
2019-07-12 11:39:58 +02:00
await removeNpmPlugin(npmName)
2019-07-05 15:28:49 +02:00
} catch (err) {
logger.error('Cannot remove plugin %s after failed installation.', toInstall, { err })
}
throw err
}
logger.info('Successful installation of plugin %s.', toInstall)
await this.registerPluginOrTheme(plugin)
2019-07-12 11:39:58 +02:00
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)
2019-07-05 15:28:49 +02:00
}
async uninstall (npmName: string) {
logger.info('Uninstalling plugin %s.', npmName)
2019-07-08 14:02:03 +02:00
try {
2019-07-12 11:39:58 +02:00
await this.unregister(npmName)
2019-07-08 14:02:03 +02:00
} catch (err) {
2019-07-12 11:39:58 +02:00
logger.warn('Cannot unregister plugin %s.', npmName, { err })
2019-07-08 14:02:03 +02:00
}
const plugin = await PluginModel.loadByNpmName(npmName)
2019-07-08 14:02:03 +02:00
if (!plugin || plugin.uninstalled === true) {
logger.error('Cannot uninstall plugin %s: it does not exist or is already uninstalled.', npmName)
2019-07-08 14:02:03 +02:00
return
}
plugin.enabled = false
plugin.uninstalled = true
await plugin.save()
2019-07-05 15:28:49 +02:00
await removeNpmPlugin(npmName)
2019-07-08 14:02:03 +02:00
logger.info('Plugin %s uninstalled.', npmName)
2019-07-05 15:28:49 +02:00
}
// ###################### Private register ######################
private async registerPluginOrTheme (plugin: PluginModel) {
2019-07-12 11:39:58 +02:00
const npmName = PluginModel.buildNpmName(plugin.name, plugin.type)
logger.info('Registering plugin or theme %s.', npmName)
2019-07-19 14:36:04 +02:00
const packageJSON = await this.getPackageJSON(plugin.name, plugin.type)
2019-07-05 15:28:49 +02:00
const pluginPath = this.getPluginPath(plugin.name, plugin.type)
this.sanitizeAndCheckPackageJSONOrThrow(packageJSON, plugin.type)
let library: PluginLibrary
if (plugin.type === PluginType.PLUGIN) {
library = await this.registerPlugin(plugin, pluginPath, packageJSON)
}
2019-07-08 14:02:03 +02:00
const clientScripts: { [id: string]: ClientScript } = {}
for (const c of packageJSON.clientScripts) {
clientScripts[c.script] = c
}
2020-01-31 16:56:52 +01:00
this.registeredPlugins[npmName] = {
2019-07-12 11:39:58 +02:00
npmName,
name: plugin.name,
type: plugin.type,
version: plugin.version,
description: plugin.description,
peertubeEngine: plugin.peertubeEngine,
path: pluginPath,
staticDirs: packageJSON.staticDirs,
2019-07-08 14:02:03 +02:00
clientScripts,
css: packageJSON.css,
unregister: library ? library.unregister : undefined
}
2019-07-26 14:44:50 +02:00
await this.addTranslations(plugin, npmName, packageJSON.translations)
}
private async registerPlugin (plugin: PluginModel, pluginPath: string, packageJSON: PluginPackageJson) {
2019-07-12 11:39:58 +02:00
const npmName = PluginModel.buildNpmName(plugin.name, plugin.type)
2019-07-19 14:36:04 +02:00
// Delete cache if needed
const modulePath = join(pluginPath, packageJSON.library)
delete require.cache[modulePath]
const library: PluginLibrary = require(modulePath)
2019-07-05 15:28:49 +02:00
if (!isLibraryCodeValid(library)) {
throw new Error('Library code is not valid (miss register or unregister function)')
}
2019-07-18 16:43:41 +02:00
const registerHelpers = this.getRegisterHelpers(npmName, plugin)
library.register(registerHelpers)
.catch(err => logger.error('Cannot register plugin %s.', npmName, { err }))
2019-07-12 11:39:58 +02:00
logger.info('Add plugin %s CSS to global file.', npmName)
await this.addCSSToGlobalFile(pluginPath, packageJSON.css)
return library
}
2019-07-26 14:44:50 +02:00
// ###################### 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 ######################
2019-07-08 14:02:03 +02:00
private resetCSSGlobalFile () {
2019-07-23 10:40:39 +02:00
ClientHtml.invalidCache()
2019-07-08 14:02:03 +02:00
return outputFile(PLUGIN_GLOBAL_CSS_PATH, '')
}
private async addCSSToGlobalFile (pluginPath: string, cssRelativePaths: string[]) {
for (const cssPath of cssRelativePaths) {
await this.concatFiles(join(pluginPath, cssPath), PLUGIN_GLOBAL_CSS_PATH)
}
2019-07-23 09:48:48 +02:00
ClientHtml.invalidCache()
}
private concatFiles (input: string, output: string) {
return new Promise<void>((res, rej) => {
2019-07-08 14:02:03 +02:00
const inputStream = createReadStream(input)
const outputStream = createWriteStream(output, { flags: 'a' })
inputStream.pipe(outputStream)
inputStream.on('end', () => res())
inputStream.on('error', err => rej(err))
})
}
private async regeneratePluginGlobalCSS () {
await this.resetCSSGlobalFile()
2019-08-02 10:53:36 +02:00
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
})
}
}
2019-07-05 15:28:49 +02:00
private getPackageJSON (pluginName: string, pluginType: PluginType) {
const pluginPath = join(this.getPluginPath(pluginName, pluginType), 'package.json')
2019-07-19 14:36:04 +02:00
return readJSON(pluginPath) as Promise<PluginPackageJson>
2019-07-05 15:28:49 +02:00
}
private getPluginPath (pluginName: string, pluginType: PluginType) {
2019-07-12 11:39:58 +02:00
const npmName = PluginModel.buildNpmName(pluginName, pluginType)
2019-07-05 15:28:49 +02:00
2019-07-12 11:39:58 +02:00
return join(CONFIG.STORAGE.PLUGINS_DIR, 'node_modules', npmName)
2019-07-05 15:28:49 +02:00
}
// ###################### Private getters ######################
2019-07-08 14:02:03 +02:00
2019-07-09 11:45:19 +02:00
private getRegisteredPluginsOrThemes (type: PluginType) {
const plugins: RegisteredPlugin[] = []
2019-07-12 11:39:58 +02:00
for (const npmName of Object.keys(this.registeredPlugins)) {
2020-01-31 16:56:52 +01:00
const plugin = this.registeredPlugins[npmName]
2019-07-09 11:45:19 +02:00
if (plugin.type !== type) continue
plugins.push(plugin)
}
return plugins
}
2019-07-18 16:43:41 +02:00
// ###################### Generate register helpers ######################
2019-07-24 11:17:42 +02:00
private getRegisterHelpers (npmName: string, plugin: PluginModel): RegisterServerOptions {
const registerHook = (options: RegisterServerHookOptions) => {
2019-07-22 16:31:47 +02:00
if (serverHookObject[options.target] !== true) {
logger.warn('Unknown hook %s of plugin %s. Skipping.', options.target, npmName)
return
}
2019-07-18 16:43:41 +02:00
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
})
}
2019-07-24 11:17:42 +02:00
const registerSetting = (options: RegisterServerSettingOptions) => {
2019-07-18 16:43:41 +02:00
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 })
}
2019-07-26 14:44:50 +02:00
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 })
}
2019-07-18 16:43:41 +02:00
const peertubeHelpers = {
logger
}
return {
registerHook,
registerSetting,
settingsManager,
storageManager,
videoLanguageManager,
videoCategoryManager,
videoLicenceManager,
2019-07-18 16:43:41 +02:00
peertubeHelpers
}
}
2020-01-31 16:56:52 +01:00
private addConstant<T extends string | number> (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
}
2020-01-31 16:56:52 +01:00
private deleteConstant<T extends string | number> (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}"`)
2020-01-31 16:56:52 +01:00
.join(', ')
throw new Error(`PackageJSON is invalid (invalid fields: ${formattedFields}).`)
}
}
static get Instance () {
return this.instance || (this.instance = new this())
}
}