1 import { PluginModel } from '../../models/server/plugin'
2 import { logger } from '../../helpers/logger'
3 import { basename, join } from 'path'
4 import { CONFIG } from '../../initializers/config'
5 import { isLibraryCodeValid, isPackageJSONValid } from '../../helpers/custom-validators/plugins'
9 PluginTranslationPaths as PackagePluginTranslations
10 } from '../../../shared/models/plugins/plugin-package-json.model'
11 import { createReadStream, createWriteStream } from 'fs'
12 import { PLUGIN_GLOBAL_CSS_PATH, VIDEO_CATEGORIES, VIDEO_LANGUAGES, VIDEO_LICENCES } from '../../initializers/constants'
13 import { PluginType } from '../../../shared/models/plugins/plugin.type'
14 import { installNpmPlugin, installNpmPluginFromDisk, removeNpmPlugin } from './yarn'
15 import { outputFile, readJSON } from 'fs-extra'
16 import { PluginSettingsManager } from '../../../shared/models/plugins/plugin-settings-manager.model'
17 import { PluginStorageManager } from '../../../shared/models/plugins/plugin-storage-manager.model'
18 import { ServerHook, ServerHookName, serverHookObject } from '../../../shared/models/plugins/server-hook.model'
19 import { getHookType, internalRunHook } from '../../../shared/core-utils/plugins/hooks'
20 import { RegisterServerOptions } from '../../typings/plugins/register-server-option.model'
21 import { PluginLibrary } from '../../typings/plugins'
22 import { ClientHtml } from '../client-html'
23 import { RegisterServerHookOptions } from '../../../shared/models/plugins/register-server-hook.model'
24 import { RegisterServerSettingOptions } from '../../../shared/models/plugins/register-server-setting.model'
25 import { PluginVideoLanguageManager } from '../../../shared/models/plugins/plugin-video-language-manager.model'
26 import { PluginVideoCategoryManager } from '../../../shared/models/plugins/plugin-video-category-manager.model'
27 import { PluginVideoLicenceManager } from '../../../shared/models/plugins/plugin-video-licence-manager.model'
28 import { PluginTranslation } from '../../../shared/models/plugins/plugin-translation.model'
30 export interface RegisteredPlugin {
35 peertubeEngine: string
41 staticDirs: { [name: string]: string }
42 clientScripts: { [name: string]: ClientScript }
46 // Only if this is a plugin
50 export interface HookInformationValue {
57 type AlterableVideoConstant = 'language' | 'licence' | 'category'
58 type VideoConstant = { [ key in number | string ]: string }
59 type UpdatedVideoConstant = {
60 [ name in AlterableVideoConstant ]: {
61 [ npmName: string ]: {
62 added: { key: number | string, label: string }[],
63 deleted: { key: number | string, label: string }[]
68 type PluginLocalesTranslations = {
69 [ locale: string ]: PluginTranslation
72 export class PluginManager implements ServerHook {
74 private static instance: PluginManager
76 private registeredPlugins: { [ name: string ]: RegisteredPlugin } = {}
77 private settings: { [ name: string ]: RegisterServerSettingOptions[] } = {}
78 private hooks: { [ name: string ]: HookInformationValue[] } = {}
79 private translations: PluginLocalesTranslations = {}
81 private updatedVideoConstants: UpdatedVideoConstant = {
87 private constructor () {
90 // ###################### Getters ######################
92 isRegistered (npmName: string) {
93 return !!this.getRegisteredPluginOrTheme(npmName)
96 getRegisteredPluginOrTheme (npmName: string) {
97 return this.registeredPlugins[npmName]
100 getRegisteredPlugin (name: string) {
101 const npmName = PluginModel.buildNpmName(name, PluginType.PLUGIN)
102 const registered = this.getRegisteredPluginOrTheme(npmName)
104 if (!registered || registered.type !== PluginType.PLUGIN) return undefined
109 getRegisteredTheme (name: string) {
110 const npmName = PluginModel.buildNpmName(name, PluginType.THEME)
111 const registered = this.getRegisteredPluginOrTheme(npmName)
113 if (!registered || registered.type !== PluginType.THEME) return undefined
118 getRegisteredPlugins () {
119 return this.getRegisteredPluginsOrThemes(PluginType.PLUGIN)
122 getRegisteredThemes () {
123 return this.getRegisteredPluginsOrThemes(PluginType.THEME)
126 getRegisteredSettings (npmName: string) {
127 return this.settings[npmName] || []
130 getTranslations (locale: string) {
131 return this.translations[locale] || {}
134 // ###################### Hooks ######################
136 async runHook <T> (hookName: ServerHookName, result?: T, params?: any): Promise<T> {
137 if (!this.hooks[hookName]) return Promise.resolve(result)
139 const hookType = getHookType(hookName)
141 for (const hook of this.hooks[hookName]) {
142 logger.debug('Running hook %s of plugin %s.', hookName, hook.npmName)
144 result = await internalRunHook(hook.handler, hookType, result, params, err => {
145 logger.error('Cannot run hook %s of plugin %s.', hookName, hook.pluginName, { err })
152 // ###################### Registration ######################
154 async registerPluginsAndThemes () {
155 await this.resetCSSGlobalFile()
157 const plugins = await PluginModel.listEnabledPluginsAndThemes()
159 for (const plugin of plugins) {
161 await this.registerPluginOrTheme(plugin)
163 // Try to unregister the plugin
165 await this.unregister(PluginModel.buildNpmName(plugin.name, plugin.type))
167 // we don't care if we cannot unregister it
170 logger.error('Cannot register plugin %s, skipping.', plugin.name, { err })
174 this.sortHooksByPriority()
177 // Don't need the plugin type since themes cannot register server code
178 async unregister (npmName: string) {
179 logger.info('Unregister plugin %s.', npmName)
181 const plugin = this.getRegisteredPluginOrTheme(npmName)
184 throw new Error(`Unknown plugin ${npmName} to unregister`)
187 delete this.registeredPlugins[plugin.npmName]
188 delete this.settings[plugin.npmName]
190 this.deleteTranslations(plugin.npmName)
192 if (plugin.type === PluginType.PLUGIN) {
193 await plugin.unregister()
195 // Remove hooks of this plugin
196 for (const key of Object.keys(this.hooks)) {
197 this.hooks[key] = this.hooks[key].filter(h => h.pluginName !== npmName)
200 this.reinitVideoConstants(plugin.npmName)
202 logger.info('Regenerating registered plugin CSS to global file.')
203 await this.regeneratePluginGlobalCSS()
207 // ###################### Installation ######################
209 async install (toInstall: string, version?: string, fromDisk = false) {
210 let plugin: PluginModel
213 logger.info('Installing plugin %s.', toInstall)
217 ? await installNpmPluginFromDisk(toInstall)
218 : await installNpmPlugin(toInstall, version)
220 npmName = fromDisk ? basename(toInstall) : toInstall
221 const pluginType = PluginModel.getTypeFromNpmName(npmName)
222 const pluginName = PluginModel.normalizePluginName(npmName)
224 const packageJSON = await this.getPackageJSON(pluginName, pluginType)
225 if (!isPackageJSONValid(packageJSON, pluginType)) {
226 throw new Error('PackageJSON is invalid.')
229 [ plugin ] = await PluginModel.upsert({
231 description: packageJSON.description,
232 homepage: packageJSON.homepage,
234 version: packageJSON.version,
237 peertubeEngine: packageJSON.engine.peertube
238 }, { returning: true })
240 logger.error('Cannot install plugin %s, removing it...', toInstall, { err })
243 await removeNpmPlugin(npmName)
245 logger.error('Cannot remove plugin %s after failed installation.', toInstall, { err })
251 logger.info('Successful installation of plugin %s.', toInstall)
253 await this.registerPluginOrTheme(plugin)
258 async update (toUpdate: string, version?: string, fromDisk = false) {
259 const npmName = fromDisk ? basename(toUpdate) : toUpdate
261 logger.info('Updating plugin %s.', npmName)
263 // Unregister old hooks
264 await this.unregister(npmName)
266 return this.install(toUpdate, version, fromDisk)
269 async uninstall (npmName: string) {
270 logger.info('Uninstalling plugin %s.', npmName)
273 await this.unregister(npmName)
275 logger.warn('Cannot unregister plugin %s.', npmName, { err })
278 const plugin = await PluginModel.loadByNpmName(npmName)
279 if (!plugin || plugin.uninstalled === true) {
280 logger.error('Cannot uninstall plugin %s: it does not exist or is already uninstalled.', npmName)
284 plugin.enabled = false
285 plugin.uninstalled = true
289 await removeNpmPlugin(npmName)
291 logger.info('Plugin %s uninstalled.', npmName)
294 // ###################### Private register ######################
296 private async registerPluginOrTheme (plugin: PluginModel) {
297 const npmName = PluginModel.buildNpmName(plugin.name, plugin.type)
299 logger.info('Registering plugin or theme %s.', npmName)
301 const packageJSON = await this.getPackageJSON(plugin.name, plugin.type)
302 const pluginPath = this.getPluginPath(plugin.name, plugin.type)
304 if (!isPackageJSONValid(packageJSON, plugin.type)) {
305 throw new Error('Package.JSON is invalid.')
308 let library: PluginLibrary
309 if (plugin.type === PluginType.PLUGIN) {
310 library = await this.registerPlugin(plugin, pluginPath, packageJSON)
313 const clientScripts: { [id: string]: ClientScript } = {}
314 for (const c of packageJSON.clientScripts) {
315 clientScripts[c.script] = c
318 this.registeredPlugins[ npmName ] = {
322 version: plugin.version,
323 description: plugin.description,
324 peertubeEngine: plugin.peertubeEngine,
326 staticDirs: packageJSON.staticDirs,
328 css: packageJSON.css,
329 unregister: library ? library.unregister : undefined
332 await this.addTranslations(plugin, npmName, packageJSON.translations)
335 private async registerPlugin (plugin: PluginModel, pluginPath: string, packageJSON: PluginPackageJson) {
336 const npmName = PluginModel.buildNpmName(plugin.name, plugin.type)
338 // Delete cache if needed
339 const modulePath = join(pluginPath, packageJSON.library)
340 delete require.cache[modulePath]
341 const library: PluginLibrary = require(modulePath)
343 if (!isLibraryCodeValid(library)) {
344 throw new Error('Library code is not valid (miss register or unregister function)')
347 const registerHelpers = this.getRegisterHelpers(npmName, plugin)
348 library.register(registerHelpers)
349 .catch(err => logger.error('Cannot register plugin %s.', npmName, { err }))
351 logger.info('Add plugin %s CSS to global file.', npmName)
353 await this.addCSSToGlobalFile(pluginPath, packageJSON.css)
358 // ###################### Translations ######################
360 private async addTranslations (plugin: PluginModel, npmName: string, translationPaths: PackagePluginTranslations) {
361 for (const locale of Object.keys(translationPaths)) {
362 const path = translationPaths[locale]
363 const json = await readJSON(join(this.getPluginPath(plugin.name, plugin.type), path))
365 if (!this.translations[locale]) this.translations[locale] = {}
366 this.translations[locale][npmName] = json
368 logger.info('Added locale %s of plugin %s.', locale, npmName)
372 private deleteTranslations (npmName: string) {
373 for (const locale of Object.keys(this.translations)) {
374 delete this.translations[locale][npmName]
376 logger.info('Deleted locale %s of plugin %s.', locale, npmName)
380 // ###################### CSS ######################
382 private resetCSSGlobalFile () {
383 ClientHtml.invalidCache()
385 return outputFile(PLUGIN_GLOBAL_CSS_PATH, '')
388 private async addCSSToGlobalFile (pluginPath: string, cssRelativePaths: string[]) {
389 for (const cssPath of cssRelativePaths) {
390 await this.concatFiles(join(pluginPath, cssPath), PLUGIN_GLOBAL_CSS_PATH)
393 ClientHtml.invalidCache()
396 private concatFiles (input: string, output: string) {
397 return new Promise<void>((res, rej) => {
398 const inputStream = createReadStream(input)
399 const outputStream = createWriteStream(output, { flags: 'a' })
401 inputStream.pipe(outputStream)
403 inputStream.on('end', () => res())
404 inputStream.on('error', err => rej(err))
408 private async regeneratePluginGlobalCSS () {
409 await this.resetCSSGlobalFile()
411 for (const key of Object.keys(this.getRegisteredPlugins())) {
412 const plugin = this.registeredPlugins[key]
414 await this.addCSSToGlobalFile(plugin.path, plugin.css)
418 // ###################### Utils ######################
420 private sortHooksByPriority () {
421 for (const hookName of Object.keys(this.hooks)) {
422 this.hooks[hookName].sort((a, b) => {
423 return b.priority - a.priority
428 private getPackageJSON (pluginName: string, pluginType: PluginType) {
429 const pluginPath = join(this.getPluginPath(pluginName, pluginType), 'package.json')
431 return readJSON(pluginPath) as Promise<PluginPackageJson>
434 private getPluginPath (pluginName: string, pluginType: PluginType) {
435 const npmName = PluginModel.buildNpmName(pluginName, pluginType)
437 return join(CONFIG.STORAGE.PLUGINS_DIR, 'node_modules', npmName)
440 // ###################### Private getters ######################
442 private getRegisteredPluginsOrThemes (type: PluginType) {
443 const plugins: RegisteredPlugin[] = []
445 for (const npmName of Object.keys(this.registeredPlugins)) {
446 const plugin = this.registeredPlugins[ npmName ]
447 if (plugin.type !== type) continue
455 // ###################### Generate register helpers ######################
457 private getRegisterHelpers (npmName: string, plugin: PluginModel): RegisterServerOptions {
458 const registerHook = (options: RegisterServerHookOptions) => {
459 if (serverHookObject[options.target] !== true) {
460 logger.warn('Unknown hook %s of plugin %s. Skipping.', options.target, npmName)
464 if (!this.hooks[options.target]) this.hooks[options.target] = []
466 this.hooks[options.target].push({
468 pluginName: plugin.name,
469 handler: options.handler,
470 priority: options.priority || 0
474 const registerSetting = (options: RegisterServerSettingOptions) => {
475 if (!this.settings[npmName]) this.settings[npmName] = []
477 this.settings[npmName].push(options)
480 const settingsManager: PluginSettingsManager = {
481 getSetting: (name: string) => PluginModel.getSetting(plugin.name, plugin.type, name),
483 setSetting: (name: string, value: string) => PluginModel.setSetting(plugin.name, plugin.type, name, value)
486 const storageManager: PluginStorageManager = {
487 getData: (key: string) => PluginModel.getData(plugin.name, plugin.type, key),
489 storeData: (key: string, data: any) => PluginModel.storeData(plugin.name, plugin.type, key, data)
492 const videoLanguageManager: PluginVideoLanguageManager = {
493 addLanguage: (key: string, label: string) => this.addConstant({ npmName, type: 'language', obj: VIDEO_LANGUAGES, key, label }),
495 deleteLanguage: (key: string) => this.deleteConstant({ npmName, type: 'language', obj: VIDEO_LANGUAGES, key })
498 const videoCategoryManager: PluginVideoCategoryManager = {
499 addCategory: (key: number, label: string) => this.addConstant({ npmName, type: 'category', obj: VIDEO_CATEGORIES, key, label }),
501 deleteCategory: (key: number) => this.deleteConstant({ npmName, type: 'category', obj: VIDEO_CATEGORIES, key })
504 const videoLicenceManager: PluginVideoLicenceManager = {
505 addLicence: (key: number, label: string) => this.addConstant({ npmName, type: 'licence', obj: VIDEO_LICENCES, key, label }),
507 deleteLicence: (key: number) => this.deleteConstant({ npmName, type: 'licence', obj: VIDEO_LICENCES, key })
510 const peertubeHelpers = {
519 videoLanguageManager,
520 videoCategoryManager,
526 private addConstant <T extends string | number> (parameters: {
528 type: AlterableVideoConstant,
533 const { npmName, type, obj, key, label } = parameters
536 logger.warn('Cannot add %s %s by plugin %s: key already exists.', type, npmName, key)
540 if (!this.updatedVideoConstants[type][npmName]) {
541 this.updatedVideoConstants[type][npmName] = {
547 this.updatedVideoConstants[type][npmName].added.push({ key, label })
553 private deleteConstant <T extends string | number> (parameters: {
555 type: AlterableVideoConstant,
559 const { npmName, type, obj, key } = parameters
562 logger.warn('Cannot delete %s %s by plugin %s: key does not exist.', type, npmName, key)
566 if (!this.updatedVideoConstants[type][npmName]) {
567 this.updatedVideoConstants[type][npmName] = {
573 this.updatedVideoConstants[type][npmName].deleted.push({ key, label: obj[key] })
579 private reinitVideoConstants (npmName: string) {
581 language: VIDEO_LANGUAGES,
582 licence: VIDEO_LICENCES,
583 category: VIDEO_CATEGORIES
585 const types: AlterableVideoConstant[] = [ 'language', 'licence', 'category' ]
587 for (const type of types) {
588 const updatedConstants = this.updatedVideoConstants[type][npmName]
589 if (!updatedConstants) continue
591 for (const added of updatedConstants.added) {
592 delete hash[type][added.key]
595 for (const deleted of updatedConstants.deleted) {
596 hash[type][deleted.key] = deleted.label
599 delete this.updatedVideoConstants[type][npmName]
603 static get Instance () {
604 return this.instance || (this.instance = new this())