-import { PluginModel } from '../../models/server/plugin'
-import { logger } from '../../helpers/logger'
+import decache from 'decache'
+import * as express from 'express'
+import { createReadStream, createWriteStream } from 'fs'
+import { ensureDir, outputFile, readJSON } from 'fs-extra'
import { basename, join } from 'path'
-import { CONFIG } from '../../initializers/config'
+import { MOAuthTokenUser, MUser } from '@server/types/models'
+import { getCompleteLocale } from '@shared/core-utils'
+import { ClientScript, PluginPackageJson, PluginTranslation, PluginTranslationPaths, 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/server-hook.model'
import { isLibraryCodeValid, isPackageJSONValid } from '../../helpers/custom-validators/plugins'
-import {
- ClientScript,
- PluginPackageJson,
- PluginTranslationPaths as PackagePluginTranslations
-} from '../../../shared/models/plugins/plugin-package-json.model'
-import { createReadStream, createWriteStream } from 'fs'
+import { logger } from '../../helpers/logger'
+import { CONFIG } from '../../initializers/config'
import { PLUGIN_GLOBAL_CSS_PATH } from '../../initializers/constants'
-import { PluginType } from '../../../shared/models/plugins/plugin.type'
-import { installNpmPlugin, installNpmPluginFromDisk, removeNpmPlugin } from './yarn'
-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 { PluginModel } from '../../models/server/plugin'
+import { PluginLibrary, RegisterServerAuthExternalOptions, RegisterServerAuthPassOptions, RegisterServerOptions } from '../../types/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 } from '@server/typings/models'
+import { RegisterHelpers } from './register-helpers'
+import { installNpmPlugin, installNpmPluginFromDisk, removeNpmPlugin } from './yarn'
export interface RegisteredPlugin {
npmName: string
css: string[]
// Only if this is a plugin
- registerHelpersStore?: RegisterHelpersStore
+ registerHelpers?: RegisterHelpers
unregister?: Function
}
getIdAndPassAuths () {
return this.getRegisteredPlugins()
- .map(p => ({ npmName: p.npmName, idAndPassAuths: p.registerHelpersStore.getIdAndPassAuths() }))
+ .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, externalAuths: p.registerHelpersStore.getExternalAuths() }))
- .filter(v => v.externalAuths.length !== 0)
+ .map(p => ({
+ npmName: p.npmName,
+ name: p.name,
+ version: p.version,
+ externalAuths: p.registerHelpers.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()
+ 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) {
return this.translations[locale] || {}
}
- onLogout (npmName: string, authName: string) {
- 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()
- } catch (err) {
- logger.warn('Cannot run onLogout function from auth %s of plugin %s.', authName, npmName, { err })
- }
- }
- }
-
async isTokenValid (token: MOAuthTokenUser, type: 'access' | 'refresh') {
const auth = this.getAuth(token.User.pluginAuth, token.authName)
if (!auth) 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> {
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()
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)
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 } = {}
staticDirs: packageJSON.staticDirs,
clientScripts,
css: packageJSON.css,
- registerHelpersStore: registerHelpersStore || undefined,
+ registerHelpers: registerHelpers || undefined,
unregister: library ? library.unregister : undefined
}
// Delete cache if needed
const modulePath = join(pluginPath, packageJSON.library)
- delete require.cache[modulePath]
+ decache(modulePath)
const library: PluginLibrary = require(modulePath)
if (!isLibraryCodeValid(library)) {
}
const { registerOptions, registerStore } = this.getRegisterHelpers(npmName, plugin)
+
+ await ensureDir(registerOptions.peertubeHelpers.plugin.getDataDirectoryPath())
+
library.register(registerOptions)
.catch(err => logger.error('Cannot register plugin %s.', npmName, { err }))
// ###################### Translations ######################
- private async addTranslations (plugin: PluginModel, npmName: string, translationPaths: PackagePluginTranslations) {
+ private async addTranslations (plugin: PluginModel, npmName: string, translationPaths: PluginTranslationPaths) {
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)
}
}
const plugin = this.getRegisteredPluginOrTheme(npmName)
if (!plugin || plugin.type !== PluginType.PLUGIN) return null
- return plugin.registerHelpersStore.getIdAndPassAuths()
- .find(a => a.authName === authName)
+ let auths: (RegisterServerAuthPassOptions | RegisterServerAuthExternalOptions)[] = plugin.registerHelpers.getIdAndPassAuths()
+ auths = auths.concat(plugin.registerHelpers.getExternalAuths())
+
+ return auths.find(a => a.authName === authName)
}
// ###################### Private getters ######################
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] = []
})
}
- const registerHelpersStore = new RegisterHelpersStore(npmName, plugin, onHookAdded.bind(this))
+ const registerHelpers = new RegisterHelpers(npmName, plugin, onHookAdded.bind(this))
return {
- registerStore: registerHelpersStore,
- registerOptions: registerHelpersStore.buildRegisterHelpers()
+ registerStore: registerHelpers,
+ registerOptions: registerHelpers.buildRegisterHelpers()
}
}
projects / github / Chocobozzz / PeerTube.git / blobdiff