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 { 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 { ServerHook, ServerHookName } 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 { PluginTranslation } from '../../../shared/models/plugins/plugin-translation.model'
+import { RegisterHelpersStore } from './register-helpers-store'
+import { RegisterServerHookOptions } from '@shared/models/plugins/register-server-hook.model'
+import { MOAuthTokenUser, MUser } from '@server/types/models'
+import { RegisterServerAuthPassOptions, RegisterServerAuthExternalOptions } from '@shared/models/plugins/register-server-auth.model'
export interface RegisteredPlugin {
+ npmName: string
name: string
version: string
description: string
css: string[]
// Only if this is a plugin
+ registerHelpersStore?: RegisterHelpersStore
unregister?: Function
}
export interface HookInformationValue {
+ npmName: string
pluginName: string
handler: Function
priority: number
}
-export class PluginManager {
+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 hooks: { [name: string]: HookInformationValue[] } = {}
+ private translations: PluginLocalesTranslations = {}
private constructor () {
}
- async registerPlugins () {
- await this.resetCSSGlobalFile()
+ // ###################### Getters ######################
- const plugins = await PluginModel.listEnabledPluginsAndThemes()
+ isRegistered (npmName: string) {
+ return !!this.getRegisteredPluginOrTheme(npmName)
+ }
- for (const plugin of plugins) {
+ getRegisteredPluginOrTheme (npmName: string) {
+ return this.registeredPlugins[npmName]
+ }
+
+ getRegisteredPluginByShortName (name: string) {
+ const npmName = PluginModel.buildNpmName(name, PluginType.PLUGIN)
+ const registered = this.getRegisteredPluginOrTheme(npmName)
+
+ if (!registered || registered.type !== PluginType.PLUGIN) return undefined
+
+ return registered
+ }
+
+ getRegisteredThemeByShortName (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)
+ }
+
+ getIdAndPassAuths () {
+ return this.getRegisteredPlugins()
+ .map(p => ({
+ npmName: p.npmName,
+ name: p.name,
+ version: p.version,
+ idAndPassAuths: p.registerHelpersStore.getIdAndPassAuths()
+ }))
+ .filter(v => v.idAndPassAuths.length !== 0)
+ }
+
+ getExternalAuths () {
+ return this.getRegisteredPlugins()
+ .map(p => ({
+ npmName: p.npmName,
+ name: p.name,
+ version: p.version,
+ externalAuths: p.registerHelpersStore.getExternalAuths()
+ }))
+ .filter(v => v.externalAuths.length !== 0)
+ }
+
+ getRegisteredSettings (npmName: string) {
+ const result = this.getRegisteredPluginOrTheme(npmName)
+ if (!result || result.type !== PluginType.PLUGIN) return []
+
+ return result.registerHelpersStore.getSettings()
+ }
+
+ getRouter (npmName: string) {
+ const result = this.getRegisteredPluginOrTheme(npmName)
+ if (!result || result.type !== PluginType.PLUGIN) return null
+
+ return result.registerHelpersStore.getRouter()
+ }
+
+ getTranslations (locale: string) {
+ return this.translations[locale] || {}
+ }
+
+ async isTokenValid (token: MOAuthTokenUser, type: 'access' | 'refresh') {
+ const auth = this.getAuth(token.User.pluginAuth, token.authName)
+ if (!auth) return true
+
+ if (auth.hookTokenValidity) {
try {
- await this.registerPluginOrTheme(plugin)
+ const { valid } = await auth.hookTokenValidity({ token, type })
+
+ if (valid === false) {
+ logger.info('Rejecting %s token validity from auth %s of plugin %s', type, token.authName, token.User.pluginAuth)
+ }
+
+ return valid
} catch (err) {
- logger.error('Cannot register plugin %s, skipping.', plugin.name, { err })
+ logger.warn('Cannot run check token validity from auth %s of plugin %s.', token.authName, token.User.pluginAuth, { err })
+ return true
}
}
- this.sortHooksByPriority()
+ return true
}
- getRegisteredPlugin (name: string) {
- return this.registeredPlugins[ name ]
- }
+ // ###################### External events ######################
- getRegisteredTheme (name: string) {
- const registered = this.getRegisteredPlugin(name)
+ onLogout (npmName: string, authName: string, user: MUser) {
+ const auth = this.getAuth(npmName, authName)
- if (!registered || registered.type !== PluginType.THEME) return undefined
+ if (auth?.onLogout) {
+ logger.info('Running onLogout function from auth %s of plugin %s', authName, npmName)
- return registered
+ try {
+ auth.onLogout(user)
+ } catch (err) {
+ logger.warn('Cannot run onLogout function from auth %s of plugin %s.', authName, npmName, { err })
+ }
+ }
}
- getRegisteredPlugins () {
- return this.registeredPlugins
+ onSettingsChanged (name: string, settings: any) {
+ const registered = this.getRegisteredPluginByShortName(name)
+ if (!registered) {
+ logger.error('Cannot find plugin %s to call on settings changed.', name)
+ }
+
+ for (const cb of registered.registerHelpersStore.getOnSettingsChangedCallbacks()) {
+ try {
+ cb(settings)
+ } catch (err) {
+ logger.error('Cannot run on settings changed callback for %s.', registered.npmName, { err })
+ }
+ }
}
- async runHook (hookName: string, param?: any) {
- let result = param
+ // ###################### Hooks ######################
+
+ 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]) {
+ 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()
+
+ for (const plugin of plugins) {
try {
- if (wait) result = await hook.handler(param)
- else result = hook.handler()
+ await this.registerPluginOrTheme(plugin)
} catch (err) {
- logger.error('Cannot run hook %s of plugin %s.', hookName, hook.pluginName, { 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 })
}
}
- return result
+ this.sortHooksByPriority()
}
- async unregister (name: string) {
- const plugin = this.getRegisteredPlugin(name)
+ // 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) {
- 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]
- 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()
+
+ // Remove hooks of this plugin
+ for (const key of Object.keys(this.hooks)) {
+ this.hooks[key] = this.hooks[key].filter(h => h.npmName !== npmName)
+ }
- delete this.registeredPlugins[plugin.name]
+ const store = plugin.registerHelpersStore
+ store.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)
? 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,
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 })
}
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)
- const pluginName = this.normalizePluginName(packageName)
+ // Unregister old hooks
+ await this.unregister(npmName)
+
+ return this.install(toUpdate, version, fromDisk)
+ }
+
+ 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
}
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
+ let registerHelpersStore: RegisterHelpersStore
if (plugin.type === PluginType.PLUGIN) {
- library = await this.registerPlugin(plugin, pluginPath, packageJSON)
+ const result = await this.registerPlugin(plugin, pluginPath, packageJSON)
+ library = result.library
+ registerHelpersStore = result.registerStore
}
const clientScripts: { [id: string]: ClientScript } = {}
clientScripts[c.script] = c
}
- this.registeredPlugins[ plugin.name ] = {
+ this.registeredPlugins[npmName] = {
+ npmName,
name: plugin.name,
type: plugin.type,
version: plugin.version,
staticDirs: packageJSON.staticDirs,
clientScripts,
css: packageJSON.css,
+ registerHelpersStore: registerHelpersStore || undefined,
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] = []
+ const npmName = PluginModel.buildNpmName(plugin.name, plugin.type)
- this.hooks[options.target].push({
- pluginName: plugin.name,
- handler: options.handler,
- priority: options.priority || 0
- })
- }
-
- 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 { registerOptions, registerStore } = this.getRegisterHelpers(npmName, plugin)
+ library.register(registerOptions)
+ .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
+ return { library, registerStore }
}
- 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, '')
}
for (const cssPath of cssRelativePaths) {
await this.concatFiles(join(pluginPath, cssPath), PLUGIN_GLOBAL_CSS_PATH)
}
+
+ ClientHtml.invalidCache()
}
private concatFiles (input: string, output: string) {
})
}
+ 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<PluginPackageJson>
}
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 getAuth (npmName: string, authName: string) {
+ const plugin = this.getRegisteredPluginOrTheme(npmName)
+ if (!plugin || plugin.type !== PluginType.PLUGIN) return null
+
+ let auths: (RegisterServerAuthPassOptions | RegisterServerAuthExternalOptions)[] = plugin.registerHelpersStore.getIdAndPassAuths()
+ auths = auths.concat(plugin.registerHelpersStore.getExternalAuths())
+
+ return auths.find(a => a.authName === authName)
}
- private async regeneratePluginGlobalCSS () {
- await this.resetCSSGlobalFile()
+ // ###################### Private getters ######################
- for (const key of Object.keys(this.registeredPlugins)) {
- const plugin = this.registeredPlugins[key]
+ private getRegisteredPluginsOrThemes (type: PluginType) {
+ const plugins: RegisteredPlugin[] = []
- await this.addCSSToGlobalFile(plugin.path, plugin.css)
+ for (const npmName of Object.keys(this.registeredPlugins)) {
+ const plugin = this.registeredPlugins[npmName]
+ if (plugin.type !== type) continue
+
+ plugins.push(plugin)
+ }
+
+ return plugins
+ }
+
+ // ###################### Generate register helpers ######################
+
+ private getRegisterHelpers (
+ npmName: string,
+ plugin: PluginModel
+ ): { registerStore: RegisterHelpersStore, registerOptions: RegisterServerOptions } {
+ const onHookAdded = (options: RegisterServerHookOptions) => {
+ if (!this.hooks[options.target]) this.hooks[options.target] = []
+
+ this.hooks[options.target].push({
+ npmName: npmName,
+ pluginName: plugin.name,
+ handler: options.handler,
+ priority: options.priority || 0
+ })
+ }
+
+ const registerHelpersStore = new RegisterHelpersStore(npmName, plugin, onHookAdded.bind(this))
+
+ return {
+ registerStore: registerHelpersStore,
+ registerOptions: registerHelpersStore.buildRegisterHelpers()
+ }
+ }
+
+ 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}).`)
}
}
projects / oweals / peertube.git / blobdiff