+import express from 'express'
import { createReadStream, createWriteStream } from 'fs'
-import { outputFile, readJSON } from 'fs-extra'
+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 { RegisterServerHookOptions } from '@shared/models/plugins/register-server-hook.model'
-import { getHookType, internalRunHook } from '../../../shared/core-utils/plugins/hooks'
+import { getCompleteLocale } from '@shared/core-utils'
import {
- ClientScript,
- PluginPackageJson,
- PluginTranslationPaths as PackagePluginTranslations
-} from '../../../shared/models/plugins/plugin-package-json.model'
-import { PluginTranslation } from '../../../shared/models/plugins/plugin-translation.model'
+ ClientScriptJSON,
+ PluginPackageJSON,
+ PluginTranslation,
+ PluginTranslationPathsJSON,
+ RegisterServerHookOptions
+} from '@shared/models'
+import { getHookType, internalRunHook } from '../../../shared/core-utils/plugins/hooks'
import { PluginType } from '../../../shared/models/plugins/plugin.type'
-import { ServerHook, ServerHookName } from '../../../shared/models/plugins/server-hook.model'
+import { ServerHook, ServerHookName } from '../../../shared/models/plugins/server/server-hook.model'
import { isLibraryCodeValid, isPackageJSONValid } from '../../helpers/custom-validators/plugins'
import { logger } from '../../helpers/logger'
import { CONFIG } from '../../initializers/config'
import { PluginModel } from '../../models/server/plugin'
import { PluginLibrary, RegisterServerAuthExternalOptions, RegisterServerAuthPassOptions, RegisterServerOptions } from '../../types/plugins'
import { ClientHtml } from '../client-html'
-import { RegisterHelpersStore } from './register-helpers-store'
-import { installNpmPlugin, installNpmPluginFromDisk, removeNpmPlugin } from './yarn'
+import { RegisterHelpers } from './register-helpers'
+import { installNpmPlugin, installNpmPluginFromDisk, rebuildNativePlugins, removeNpmPlugin } from './yarn'
export interface RegisteredPlugin {
npmName: string
path: string
staticDirs: { [name: string]: string }
- clientScripts: { [name: string]: ClientScript }
+ clientScripts: { [name: string]: ClientScriptJSON }
css: string[]
// Only if this is a plugin
- registerHelpersStore?: RegisterHelpersStore
+ registerHelpers?: RegisterHelpers
unregister?: Function
}
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) {
npmName: p.npmName,
name: p.name,
version: p.version,
- idAndPassAuths: p.registerHelpersStore.getIdAndPassAuths()
+ idAndPassAuths: p.registerHelpers.getIdAndPassAuths()
}))
.filter(v => v.idAndPassAuths.length !== 0)
}
npmName: p.npmName,
name: p.name,
version: p.version,
- externalAuths: p.registerHelpersStore.getExternalAuths()
+ externalAuths: p.registerHelpers.getExternalAuths()
}))
.filter(v => v.externalAuths.length !== 0)
}
const result = this.getRegisteredPluginOrTheme(npmName)
if (!result || result.type !== PluginType.PLUGIN) return []
- return result.registerHelpersStore.getSettings()
+ return result.registerHelpers.getSettings()
}
getRouter (npmName: string) {
const result = this.getRegisteredPluginOrTheme(npmName)
if (!result || result.type !== PluginType.PLUGIN) return null
- return result.registerHelpersStore.getRouter()
+ return result.registerHelpers.getRouter()
}
getTranslations (locale: string) {
// ###################### External events ######################
- onLogout (npmName: string, authName: string, user: MUser) {
+ async onLogout (npmName: string, authName: string, user: MUser, req: express.Request) {
const auth = this.getAuth(npmName, authName)
if (auth?.onLogout) {
logger.info('Running onLogout function from auth %s of plugin %s', authName, npmName)
try {
- auth.onLogout(user)
+ // Force await, in case or onLogout returns a promise
+ const result = await auth.onLogout(user, req)
+
+ return typeof result === 'string'
+ ? result
+ : undefined
} catch (err) {
logger.warn('Cannot run onLogout function from auth %s of plugin %s.', authName, npmName, { err })
}
}
+
+ return undefined
}
- onSettingsChanged (name: string, settings: any) {
+ async 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()) {
+ for (const cb of registered.registerHelpers.getOnSettingsChangedCallbacks()) {
try {
- cb(settings)
+ await cb(settings)
} catch (err) {
logger.error('Cannot run on settings changed callback for %s.', registered.npmName, { err })
}
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 }) }
})
}
this.hooks[key] = this.hooks[key].filter(h => h.npmName !== npmName)
}
- const store = plugin.registerHelpersStore
+ const store = plugin.registerHelpers
store.reinitVideoConstants(plugin.npmName)
+ store.reinitTranscodingProfilesAndEncoders(plugin.npmName)
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
uninstalled: false,
peertubeEngine: packageJSON.engine.peertube
}, { returning: true })
- } catch (err) {
- logger.error('Cannot install plugin %s, removing it...', toInstall, { err })
+
+ logger.info('Successful installation of plugin %s.', toInstall)
+
+ if (register) {
+ await this.registerPluginOrTheme(plugin)
+ }
+ } catch (rootErr) {
+ logger.error('Cannot install plugin %s, removing it...', toInstall, { err: rootErr })
try {
- await removeNpmPlugin(npmName)
+ await this.uninstall({ npmName })
} catch (err) {
- logger.error('Cannot remove plugin %s after failed installation.', toInstall, { err })
+ logger.error('Cannot uninstall plugin %s after failed installation.', toInstall, { err })
+
+ try {
+ await removeNpmPlugin(npmName)
+ } catch (err) {
+ logger.error('Cannot remove plugin %s after failed installation.', toInstall, { err })
+ }
}
- throw err
+ throw rootErr
}
- logger.info('Successful installation of plugin %s.', toInstall)
-
- await this.registerPluginOrTheme(plugin)
-
return plugin
}
- async update (toUpdate: string, version?: string, fromDisk = false) {
+ async update (toUpdate: string, fromDisk = false) {
const npmName = fromDisk ? basename(toUpdate) : toUpdate
logger.info('Updating plugin %s.', npmName)
+ // Use the latest version from DB, to not upgrade to a version that does not support our PeerTube version
+ let version: string
+ if (!fromDisk) {
+ const plugin = await PluginModel.loadByNpmName(toUpdate)
+ version = plugin.latestVersion
+ }
+
// 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)
logger.info('Plugin %s uninstalled.', npmName)
}
+ async rebuildNativePluginsIfNeeded () {
+ if (!await ApplicationModel.nodeABIChanged()) return
+
+ return rebuildNativePlugins()
+ }
+
// ###################### Private register ######################
private async registerPluginOrTheme (plugin: PluginModel) {
this.sanitizeAndCheckPackageJSONOrThrow(packageJSON, plugin.type)
let library: PluginLibrary
- let registerHelpersStore: RegisterHelpersStore
+ let registerHelpers: RegisterHelpers
if (plugin.type === PluginType.PLUGIN) {
const result = await this.registerPlugin(plugin, pluginPath, packageJSON)
library = result.library
- registerHelpersStore = result.registerStore
+ registerHelpers = result.registerStore
}
- const clientScripts: { [id: string]: ClientScript } = {}
+ const clientScripts: { [id: string]: ClientScriptJSON } = {}
for (const c of packageJSON.clientScripts) {
clientScripts[c.script] = c
}
staticDirs: packageJSON.staticDirs,
clientScripts,
css: packageJSON.css,
- registerHelpersStore: registerHelpersStore || undefined,
+ registerHelpers: registerHelpers || undefined,
unregister: library ? library.unregister : undefined
}
await this.addTranslations(plugin, npmName, packageJSON.translations)
+
+ ClientHtml.invalidCache()
}
- private async registerPlugin (plugin: PluginModel, pluginPath: string, packageJSON: PluginPackageJson) {
+ private async registerPlugin (plugin: PluginModel, pluginPath: string, packageJSON: PluginPackageJSON) {
const npmName = PluginModel.buildNpmName(plugin.name, plugin.type)
// Delete cache if needed
const modulePath = join(pluginPath, packageJSON.library)
- delete require.cache[modulePath]
+ decachePlugin(pluginPath, modulePath)
const library: PluginLibrary = require(modulePath)
if (!isLibraryCodeValid(library)) {
}
const { registerOptions, registerStore } = this.getRegisterHelpers(npmName, plugin)
- library.register(registerOptions)
- .catch(err => logger.error('Cannot register plugin %s.', npmName, { err }))
+
+ await ensureDir(registerOptions.peertubeHelpers.plugin.getDataDirectoryPath())
+
+ await library.register(registerOptions)
logger.info('Add plugin %s CSS to global file.', npmName)
// ###################### Translations ######################
- private async addTranslations (plugin: PluginModel, npmName: string, translationPaths: PackagePluginTranslations) {
+ private async addTranslations (plugin: PluginModel, npmName: string, translationPaths: PluginTranslationPathsJSON) {
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
+ const completeLocale = getCompleteLocale(locale)
+
+ if (!this.translations[completeLocale]) this.translations[completeLocale] = {}
+ this.translations[completeLocale][npmName] = json
- logger.info('Added locale %s of plugin %s.', locale, npmName)
+ logger.info('Added locale %s of plugin %s.', completeLocale, 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 getPackageJSON (pluginName: string, pluginType: PluginType) {
const pluginPath = join(this.getPluginPath(pluginName, pluginType), 'package.json')
- return readJSON(pluginPath) as Promise<PluginPackageJson>
+ return readJSON(pluginPath) as Promise<PluginPackageJSON>
}
private getPluginPath (pluginName: string, pluginType: PluginType) {
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())
+ let auths: (RegisterServerAuthPassOptions | RegisterServerAuthExternalOptions)[] = plugin.registerHelpers.getIdAndPassAuths()
+ auths = auths.concat(plugin.registerHelpers.getExternalAuths())
return auths.find(a => a.authName === authName)
}
private getRegisterHelpers (
npmName: string,
plugin: PluginModel
- ): { registerStore: RegisterHelpersStore, registerOptions: RegisterServerOptions } {
+ ): { registerStore: RegisterHelpers, registerOptions: RegisterServerOptions } {
const onHookAdded = (options: RegisterServerHookOptions) => {
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 registerHelpersStore = new RegisterHelpersStore(npmName, plugin, onHookAdded.bind(this))
+ const registerHelpers = new RegisterHelpers(npmName, plugin, this.server, onHookAdded.bind(this))
return {
- registerStore: registerHelpersStore,
- registerOptions: registerHelpersStore.buildRegisterHelpers()
+ registerStore: registerHelpers,
+ registerOptions: registerHelpers.buildRegisterHelpers()
}
}
- private sanitizeAndCheckPackageJSONOrThrow (packageJSON: PluginPackageJson, pluginType: PluginType) {
+ private sanitizeAndCheckPackageJSONOrThrow (packageJSON: PluginPackageJSON, pluginType: PluginType) {
if (!packageJSON.staticDirs) packageJSON.staticDirs = {}
if (!packageJSON.css) packageJSON.css = []
if (!packageJSON.clientScripts) packageJSON.clientScripts = []
projects / github / Chocobozzz / PeerTube.git / blobdiff