-import { PluginModel } from '../../models/server/plugin'
-import { logger } from '../../helpers/logger'
+import { createReadStream, createWriteStream } from 'fs'
+import { outputFile, readJSON } from 'fs-extra'
import { basename, join } from 'path'
-import { CONFIG } from '../../initializers/config'
-import { isLibraryCodeValid, isPackageJSONValid } from '../../helpers/custom-validators/plugins'
+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 {
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 { PluginTranslation } from '../../../shared/models/plugins/plugin-translation.model'
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 { 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 { 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 { installNpmPlugin, installNpmPluginFromDisk, removeNpmPlugin } from './yarn'
export interface RegisteredPlugin {
npmName: string
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.registerHelpersStore.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.registerHelpersStore.getExternalAuths()
+ }))
+ .filter(v => v.externalAuths.length !== 0)
}
getRegisteredSettings (npmName: 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 ######################
+
+ onLogout (npmName: string, authName: string, user: MUser) {
+ 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)
+ } catch (err) {
+ logger.warn('Cannot run onLogout function from auth %s of plugin %s.', authName, npmName, { err })
+ }
+ }
+ }
+
+ 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 })
+ }
+ }
+ }
+
// ###################### Hooks ######################
async runHook<T> (hookName: ServerHookName, result?: T, params?: any): Promise<T> {
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.registerHelpersStore.getIdAndPassAuths()
+ auths = auths.concat(plugin.registerHelpersStore.getExternalAuths())
+
+ return auths.find(a => a.authName === authName)
}
// ###################### Private getters ######################