import {
ClientHookName,
clientHookObject,
- ClientScript,
+ ClientScriptJSON,
HTMLServerConfig,
PluginClientScope,
PluginType,
RegisterClientVideoFieldOptions,
RegisteredExternalAuthConfig,
ServerConfigPlugin
-} from '../../../shared/models'
+} from '@shared/models'
import { environment } from '../environments/environment'
-import { ClientScript as ClientScriptModule } from '../types/client-script.model'
+import { ClientScript } from '../types'
+import { logger } from './logger'
interface HookStructValue extends RegisterClientHookOptions {
plugin: ServerConfigPlugin
- clientScript: ClientScript
+ clientScript: ClientScriptJSON
}
type Hooks = { [ name: string ]: HookStructValue[] }
type PluginInfo = {
plugin: ServerConfigPlugin
- clientScript: ClientScript
+ clientScript: ClientScriptJSON
pluginType: PluginType
isTheme: boolean
}
type PeertubeHelpersFactory = (pluginInfo: PluginInfo) => RegisterClientHelpers
-type OnFormFields = (options: RegisterClientFormFieldOptions, videoFormOptions: RegisterClientVideoFieldOptions) => void
+
+type OnFormFields = (
+ pluginInfo: PluginInfo,
+ options: RegisterClientFormFieldOptions,
+ videoFormOptions: RegisterClientVideoFieldOptions
+) => void
+
type OnSettingsScripts = (pluginInfo: PluginInfo, options: RegisterClientSettingsScriptOptions) => void
+
type OnClientRoute = (options: RegisterClientRouteOptions) => void
-const logger = debug('peertube:plugins')
+const debugLogger = debug('peertube:plugins')
class PluginsManager {
private hooks: Hooks = {}
signup: new ReplaySubject<boolean>(1),
login: new ReplaySubject<boolean>(1),
'video-edit': new ReplaySubject<boolean>(1),
- embed: new ReplaySubject<boolean>(1)
+ embed: new ReplaySubject<boolean>(1),
+ 'my-library': new ReplaySubject<boolean>(1),
+ 'video-channel': new ReplaySubject<boolean>(1)
}
private readonly peertubeHelpersFactory: PeertubeHelpersFactory
}
}
- async runHook<T> (hookName: ClientHookName, result?: T, params?: any) {
- if (!this.hooks[hookName]) return result
+ async runHook<T> (hookName: ClientHookName, resultArg?: T | Promise<T>, params?: any) {
+ if (!this.hooks[hookName]) {
+ // eslint-disable-next-line no-return-await
+ return await resultArg
+ }
const hookType = getHookType(hookName)
- for (const hook of this.hooks[hookName]) {
- console.log('Running hook %s of plugin %s.', hookName, hook.plugin.name)
+ let result = await resultArg
- result = await internalRunHook(hook.handler, hookType, result, params, err => {
- console.error('Cannot run hook %s of script %s of plugin %s.', hookName, hook.clientScript.script, hook.plugin.name, err)
+ for (const hook of this.hooks[hookName]) {
+ logger.info(`Running hook ${hookName} of plugin ${hook.plugin.name}`)
+
+ result = await internalRunHook({
+ handler: hook.handler,
+ hookType,
+ result,
+ params,
+ onError: err => {
+ logger.error(`Cannot run hook ${hookName} of script ${hook.clientScript.script} of plugin ${hook.plugin.name}`, err)
+ }
})
}
this.loadingScopes[scope] = true
- logger('Loading scope %s', scope)
+ debugLogger('Loading scope %s', scope)
try {
if (!isReload) this.loadedScopes.push(scope)
this.loadingScopes[scope] = false
this.pluginsLoaded[scope].next(true)
- logger('Nothing to load for scope %s', scope)
+ debugLogger('Nothing to load for scope %s', scope)
return
}
this.pluginsLoaded[scope].next(true)
this.loadingScopes[scope] = false
- logger('Scope %s loaded', scope)
+ debugLogger('Scope %s loaded', scope)
} catch (err) {
- console.error('Cannot load plugins by scope %s.', scope, err)
+ logger.error(`Cannot load plugins by scope ${scope}`, err)
}
}
const registerHook = (options: RegisterClientHookOptions) => {
if (clientHookObject[options.target] !== true) {
- console.error('Unknown hook %s of plugin %s. Skipping.', options.target, plugin.name)
+ logger.error(`Unknown hook ${options.target} of plugin ${plugin.name}. Skipping.`)
return
}
throw new Error('Video field registration is not supported')
}
- return this.onFormFields(commonOptions, videoFormOptions)
+ return this.onFormFields(pluginInfo, commonOptions, videoFormOptions)
}
const registerSettingsScript = (options: RegisterClientSettingsScriptOptions) => {
const peertubeHelpers = this.peertubeHelpersFactory(pluginInfo)
- console.log('Loading script %s of plugin %s.', clientScript.script, plugin.name)
+ logger.info(`Loading script ${clientScript.script} of plugin ${plugin.name}`)
const absURL = (environment.apiUrl || window.location.origin) + clientScript.script
return dynamicImport(absURL)
- .then((script: ClientScriptModule) => {
+ .then((script: ClientScript) => {
return script.register({
registerHook,
registerVideoField,
})
})
.then(() => this.sortHooksByPriority())
- .catch(err => console.error('Cannot import or register plugin %s.', pluginInfo.plugin.name, err))
+ .catch(err => logger.error(`Cannot import or register plugin ${pluginInfo.plugin.name}`, err))
}
private sortHooksByPriority () {
// eslint-disable-next-line no-new-func
return new Function(`return import('${url}')`)()
} catch {
- console.log('Fallback to import polyfill')
+ logger.info('Fallback to import polyfill')
return new Promise((resolve, reject) => {
const vector = '$importModule$' + Math.random().toString(32).slice(2)