-import { PluginModel } from '../../models/server/plugin'
-import { logger } from '../../helpers/logger'
+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 { CONFIG } from '../../initializers/config'
-import { isLibraryCodeValid, isPackageJSONValid } from '../../helpers/custom-validators/plugins'
+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 {
- 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'
-import { installNpmPlugin, installNpmPluginFromDisk, removeNpmPlugin } from './yarn'
-import { outputFile, readJSON } from 'fs-extra'
-import { PluginSettingsManager } from '../../../shared/models/plugins/plugin-settings-manager.model'
-import { PluginStorageManager } from '../../../shared/models/plugins/plugin-storage-manager.model'
-import { ServerHook, ServerHookName, serverHookObject } from '../../../shared/models/plugins/server-hook.model'
+ ClientScriptJSON,
+ PluginPackageJSON,
+ PluginTranslation,
+ PluginTranslationPathsJSON,
+ RegisterServerHookOptions
+} from '@shared/models'
import { getHookType, internalRunHook } from '../../../shared/core-utils/plugins/hooks'
-import { RegisterServerOptions } from '../../typings/plugins/register-server-option.model'
-import { PluginLibrary } from '../../typings/plugins'
+import { PluginType } from '../../../shared/models/plugins/plugin.type'
+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 { PLUGIN_GLOBAL_CSS_PATH } from '../../initializers/constants'
+import { PluginModel } from '../../models/server/plugin'
+import { PluginLibrary, RegisterServerAuthExternalOptions, RegisterServerAuthPassOptions, RegisterServerOptions } from '../../types/plugins'
import { ClientHtml } from '../client-html'
-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'
-import { PluginTranslation } from '../../../shared/models/plugins/plugin-translation.model'
+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
+ registerHelpers?: RegisterHelpers
unregister?: Function
}
priority: number
}
-type AlterableVideoConstant = 'language' | 'licence' | 'category'
-type VideoConstant = { [key in number | string]: string }
-type UpdatedVideoConstant = {
- [name in AlterableVideoConstant]: {
- [npmName: string]: {
- added: { key: number | string, label: string }[]
- deleted: { key: number | string, label: string }[]
- }
- }
-}
-
type PluginLocalesTranslations = {
[locale: string]: PluginTranslation
}
private static instance: PluginManager
private registeredPlugins: { [name: string]: RegisteredPlugin } = {}
- private settings: { [name: string]: RegisterServerSettingOptions[] } = {}
+
private hooks: { [name: string]: HookInformationValue[] } = {}
private translations: PluginLocalesTranslations = {}
- private readonly updatedVideoConstants: UpdatedVideoConstant = {
- language: {},
- licence: {},
- category: {}
- }
+ private server: Server
private constructor () {
}
+ init (server: Server) {
+ this.server = server
+ }
+
+ registerWebSocketRouter () {
+ this.server.on('upgrade', (request, socket, head) => {
+ 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
+
+ wss.handler(request, socket, head)
+ })
+ }
+
// ###################### Getters ######################
isRegistered (npmName: string) {
return this.registeredPlugins[npmName]
}
- getRegisteredPlugin (name: string) {
+ getRegisteredPluginByShortName (name: string) {
const npmName = PluginModel.buildNpmName(name, PluginType.PLUGIN)
const registered = this.getRegisteredPluginOrTheme(npmName)
return registered
}
- getRegisteredTheme (name: string) {
+ getRegisteredThemeByShortName (name: string) {
const npmName = PluginModel.buildNpmName(name, PluginType.THEME)
const registered = this.getRegisteredPluginOrTheme(npmName)
return this.getRegisteredPluginsOrThemes(PluginType.THEME)
}
+ getIdAndPassAuths () {
+ return this.getRegisteredPlugins()
+ .map(p => ({
+ npmName: p.npmName,
+ name: p.name,
+ version: p.version,
+ idAndPassAuths: p.registerHelpers.getIdAndPassAuths()
+ }))
+ .filter(v => v.idAndPassAuths.length !== 0)
+ }
+
+ getExternalAuths () {
+ return this.getRegisteredPlugins()
+ .map(p => ({
+ npmName: p.npmName,
+ name: p.name,
+ version: p.version,
+ externalAuths: p.registerHelpers.getExternalAuths()
+ }))
+ .filter(v => v.externalAuths.length !== 0)
+ }
+
getRegisteredSettings (npmName: string) {
- return this.settings[npmName] || []
+ const result = this.getRegisteredPluginOrTheme(npmName)
+ if (!result || result.type !== PluginType.PLUGIN) return []
+
+ return result.registerHelpers.getSettings()
+ }
+
+ getRouter (npmName: string) {
+ const result = this.getRegisteredPluginOrTheme(npmName)
+ if (!result || result.type !== PluginType.PLUGIN) return null
+
+ return result.registerHelpers.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 {
+ 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.warn('Cannot run check token validity from auth %s of plugin %s.', token.authName, token.User.pluginAuth, { err })
+ return true
+ }
+ }
+
+ return true
+ }
+
+ // ###################### External events ######################
+
+ 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 {
+ // 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
+ }
+
+ 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.registerHelpers.getOnSettingsChangedCallbacks()) {
+ try {
+ await cb(settings)
+ } catch (err) {
+ logger.error('Cannot run on settings changed callback for %s.', registered.npmName, { err })
+ }
+ }
+ }
+
// ###################### Hooks ######################
async runHook<T> (hookName: ServerHookName, result?: T, params?: any): Promise<T> {
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 }) }
})
}
}
delete this.registeredPlugins[plugin.npmName]
- delete this.settings[plugin.npmName]
this.deleteTranslations(plugin.npmName)
this.hooks[key] = this.hooks[key].filter(h => h.npmName !== npmName)
}
- this.reinitVideoConstants(plugin.npmName)
+ 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 ######################
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)
+
+ 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)
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 registerHelpers: RegisterHelpers
if (plugin.type === PluginType.PLUGIN) {
- library = await this.registerPlugin(plugin, pluginPath, packageJSON)
+ const result = await this.registerPlugin(plugin, pluginPath, packageJSON)
+ library = result.library
+ 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,
+ 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)) {
throw new Error('Library code is not valid (miss register or unregister function)')
}
- const registerHelpers = this.getRegisterHelpers(npmName, plugin)
- library.register(registerHelpers)
- .catch(err => logger.error('Cannot register plugin %s.', npmName, { err }))
+ const { registerOptions, registerStore } = this.getRegisterHelpers(npmName, plugin)
+
+ await ensureDir(registerOptions.peertubeHelpers.plugin.getDataDirectoryPath())
+
+ await library.register(registerOptions)
logger.info('Add plugin %s CSS to global file.', npmName)
await this.addCSSToGlobalFile(pluginPath, packageJSON.css)
- return library
+ return { library, registerStore }
}
// ###################### 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)
- logger.info('Added locale %s of plugin %s.', locale, npmName)
+ if (!this.translations[completeLocale]) this.translations[completeLocale] = {}
+ this.translations[completeLocale][npmName] = json
+
+ 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) {
return join(CONFIG.STORAGE.PLUGINS_DIR, 'node_modules', npmName)
}
+ private getAuth (npmName: string, authName: string) {
+ const plugin = this.getRegisteredPluginOrTheme(npmName)
+ if (!plugin || plugin.type !== PluginType.PLUGIN) return null
+
+ let auths: (RegisterServerAuthPassOptions | RegisterServerAuthExternalOptions)[] = plugin.registerHelpers.getIdAndPassAuths()
+ auths = auths.concat(plugin.registerHelpers.getExternalAuths())
+
+ return auths.find(a => a.authName === authName)
+ }
+
// ###################### Private getters ######################
private getRegisteredPluginsOrThemes (type: PluginType) {
// ###################### Generate register helpers ######################
- private getRegisterHelpers (npmName: string, plugin: PluginModel): RegisterServerOptions {
- const registerHook = (options: RegisterServerHookOptions) => {
- if (serverHookObject[options.target] !== true) {
- logger.warn('Unknown hook %s of plugin %s. Skipping.', options.target, npmName)
- return
- }
-
+ private getRegisterHelpers (
+ npmName: string,
+ plugin: PluginModel
+ ): { registerStore: RegisterHelpers, registerOptions: RegisterServerOptions } {
+ const onHookAdded = (options: RegisterServerHookOptions) => {
if (!this.hooks[options.target]) this.hooks[options.target] = []
this.hooks[options.target].push({
})
}
- const registerSetting = (options: RegisterServerSettingOptions) => {
- 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 })
- }
-
- 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 })
- }
-
- const peertubeHelpers = {
- logger
- }
+ const registerHelpers = new RegisterHelpers(npmName, plugin, this.server, onHookAdded.bind(this))
return {
- registerHook,
- registerSetting,
- settingsManager,
- storageManager,
- videoLanguageManager,
- videoCategoryManager,
- videoLicenceManager,
- peertubeHelpers
- }
- }
-
- 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
- }
-
- 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]
+ 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