X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Fplugins%2Fplugin-manager.ts;h=eab0b39780d9bcc8bc702028c086b3036c602555;hb=b7221c1d94e088231ef28b11d95d45d781fbe41c;hp=39e7f9a5b0eed09b962f46c402e2645a10f646dd;hpb=c3edc5b074aa4bb1861ed0a94d3713808e87170f;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/plugins/plugin-manager.ts b/server/lib/plugins/plugin-manager.ts index 39e7f9a5b..eab0b3978 100644 --- a/server/lib/plugins/plugin-manager.ts +++ b/server/lib/plugins/plugin-manager.ts @@ -1,8 +1,10 @@ import express from 'express' import { createReadStream, createWriteStream } from 'fs' import { ensureDir, outputFile, readJSON } from 'fs-extra' +import { Server } from 'http' import { basename, join } from 'path' import { decachePlugin } from '@server/helpers/decache' +import { ApplicationModel } from '@server/models/application/application' import { MOAuthTokenUser, MUser } from '@server/types/models' import { getCompleteLocale } from '@shared/core-utils' import { @@ -23,7 +25,7 @@ import { PluginModel } from '../../models/server/plugin' import { PluginLibrary, RegisterServerAuthExternalOptions, RegisterServerAuthPassOptions, RegisterServerOptions } from '../../types/plugins' import { ClientHtml } from '../client-html' import { RegisterHelpers } from './register-helpers' -import { installNpmPlugin, installNpmPluginFromDisk, removeNpmPlugin } from './yarn' +import { installNpmPlugin, installNpmPluginFromDisk, rebuildNativePlugins, removeNpmPlugin } from './yarn' export interface RegisteredPlugin { npmName: string @@ -66,9 +68,45 @@ export class PluginManager implements ServerHook { private hooks: { [name: string]: HookInformationValue[] } = {} private translations: PluginLocalesTranslations = {} + private server: Server + private constructor () { } + init (server: Server) { + this.server = server + } + + registerWebSocketRouter () { + this.server.on('upgrade', (request, socket, head) => { + // Check if it's a plugin websocket connection + // No need to destroy the stream when we abort the request + // Other handlers in PeerTube will catch this upgrade event too (socket.io, tracker etc) + + const url = request.url + + const matched = url.match(`/plugins/([^/]+)/([^/]+/)?ws(/.*)`) + if (!matched) return + + const npmName = PluginModel.buildNpmName(matched[1], PluginType.PLUGIN) + const subRoute = matched[3] + + const result = this.getRegisteredPluginOrTheme(npmName) + if (!result) return + + const routes = result.registerHelpers.getWebSocketRoutes() + + const wss = routes.find(r => r.route.startsWith(subRoute)) + if (!wss) return + + try { + wss.handler(request, socket, head) + } catch (err) { + logger.error('Exception in plugin handler ' + npmName, { err }) + } + }) + } + // ###################### Getters ###################### isRegistered (npmName: string) { @@ -215,8 +253,12 @@ export class PluginManager implements ServerHook { 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 }) + result = await internalRunHook({ + handler: hook.handler, + hookType, + result, + params, + onError: err => { logger.error('Cannot run hook %s of plugin %s.', hookName, hook.pluginName, { err }) } }) } @@ -277,11 +319,20 @@ export class PluginManager implements ServerHook { logger.info('Regenerating registered plugin CSS to global file.') await this.regeneratePluginGlobalCSS() } + + ClientHtml.invalidCache() } // ###################### Installation ###################### - async install (toInstall: string, version?: string, fromDisk = false) { + async install (options: { + toInstall: string + version?: string + fromDisk?: boolean // default false + register?: boolean // default true + }) { + const { toInstall, version, fromDisk = false, register = true } = options + let plugin: PluginModel let npmName: string @@ -313,12 +364,14 @@ export class PluginManager implements ServerHook { logger.info('Successful installation of plugin %s.', toInstall) - await this.registerPluginOrTheme(plugin) + if (register) { + await this.registerPluginOrTheme(plugin) + } } catch (rootErr) { logger.error('Cannot install plugin %s, removing it...', toInstall, { err: rootErr }) try { - await this.uninstall(npmName) + await this.uninstall({ npmName }) } catch (err) { logger.error('Cannot uninstall plugin %s after failed installation.', toInstall, { err }) @@ -350,16 +403,23 @@ export class PluginManager implements ServerHook { // Unregister old hooks await this.unregister(npmName) - return this.install(toUpdate, version, fromDisk) + return this.install({ toInstall: toUpdate, version, fromDisk }) } - async uninstall (npmName: string) { + async uninstall (options: { + npmName: string + unregister?: boolean // default true + }) { + const { npmName, unregister = true } = options + logger.info('Uninstalling plugin %s.', npmName) - try { - await this.unregister(npmName) - } catch (err) { - logger.warn('Cannot unregister plugin %s.', npmName, { err }) + if (unregister) { + try { + await this.unregister(npmName) + } catch (err) { + logger.warn('Cannot unregister plugin %s.', npmName, { err }) + } } const plugin = await PluginModel.loadByNpmName(npmName) @@ -378,6 +438,12 @@ export class PluginManager implements ServerHook { logger.info('Plugin %s uninstalled.', npmName) } + async rebuildNativePluginsIfNeeded () { + if (!await ApplicationModel.nodeABIChanged()) return + + return rebuildNativePlugins() + } + // ###################### Private register ###################### private async registerPluginOrTheme (plugin: PluginModel) { @@ -419,6 +485,8 @@ export class PluginManager implements ServerHook { } await this.addTranslations(plugin, npmName, packageJSON.translations) + + ClientHtml.invalidCache() } private async registerPlugin (plugin: PluginModel, pluginPath: string, packageJSON: PluginPackageJSON) { @@ -473,8 +541,6 @@ export class PluginManager implements ServerHook { // ###################### CSS ###################### private resetCSSGlobalFile () { - ClientHtml.invalidCache() - return outputFile(PLUGIN_GLOBAL_CSS_PATH, '') } @@ -482,8 +548,6 @@ 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) { @@ -563,14 +627,14 @@ export class PluginManager implements ServerHook { if (!this.hooks[options.target]) this.hooks[options.target] = [] this.hooks[options.target].push({ - npmName: npmName, + npmName, pluginName: plugin.name, handler: options.handler, priority: options.priority || 0 }) } - const registerHelpers = new RegisterHelpers(npmName, plugin, onHookAdded.bind(this)) + const registerHelpers = new RegisterHelpers(npmName, plugin, this.server, onHookAdded.bind(this)) return { registerStore: registerHelpers,