aboutsummaryrefslogtreecommitdiffhomepage
path: root/server/lib/plugins/plugin-manager.ts
diff options
context:
space:
mode:
Diffstat (limited to 'server/lib/plugins/plugin-manager.ts')
-rw-r--r--server/lib/plugins/plugin-manager.ts665
1 files changed, 0 insertions, 665 deletions
diff --git a/server/lib/plugins/plugin-manager.ts b/server/lib/plugins/plugin-manager.ts
deleted file mode 100644
index 88c5b60d7..000000000
--- a/server/lib/plugins/plugin-manager.ts
+++ /dev/null
@@ -1,665 +0,0 @@
1import express from 'express'
2import { createReadStream, createWriteStream } from 'fs'
3import { ensureDir, outputFile, readJSON } from 'fs-extra'
4import { Server } from 'http'
5import { basename, join } from 'path'
6import { decachePlugin } from '@server/helpers/decache'
7import { ApplicationModel } from '@server/models/application/application'
8import { MOAuthTokenUser, MUser } from '@server/types/models'
9import { getCompleteLocale } from '@shared/core-utils'
10import {
11 ClientScriptJSON,
12 PluginPackageJSON,
13 PluginTranslation,
14 PluginTranslationPathsJSON,
15 RegisterServerHookOptions
16} from '@shared/models'
17import { getHookType, internalRunHook } from '../../../shared/core-utils/plugins/hooks'
18import { PluginType } from '../../../shared/models/plugins/plugin.type'
19import { ServerHook, ServerHookName } from '../../../shared/models/plugins/server/server-hook.model'
20import { isLibraryCodeValid, isPackageJSONValid } from '../../helpers/custom-validators/plugins'
21import { logger } from '../../helpers/logger'
22import { CONFIG } from '../../initializers/config'
23import { PLUGIN_GLOBAL_CSS_PATH } from '../../initializers/constants'
24import { PluginModel } from '../../models/server/plugin'
25import { PluginLibrary, RegisterServerAuthExternalOptions, RegisterServerAuthPassOptions, RegisterServerOptions } from '../../types/plugins'
26import { ClientHtml } from '../client-html'
27import { RegisterHelpers } from './register-helpers'
28import { installNpmPlugin, installNpmPluginFromDisk, rebuildNativePlugins, removeNpmPlugin } from './yarn'
29
30export interface RegisteredPlugin {
31 npmName: string
32 name: string
33 version: string
34 description: string
35 peertubeEngine: string
36
37 type: PluginType
38
39 path: string
40
41 staticDirs: { [name: string]: string }
42 clientScripts: { [name: string]: ClientScriptJSON }
43
44 css: string[]
45
46 // Only if this is a plugin
47 registerHelpers?: RegisterHelpers
48 unregister?: Function
49}
50
51export interface HookInformationValue {
52 npmName: string
53 pluginName: string
54 handler: Function
55 priority: number
56}
57
58type PluginLocalesTranslations = {
59 [locale: string]: PluginTranslation
60}
61
62export class PluginManager implements ServerHook {
63
64 private static instance: PluginManager
65
66 private registeredPlugins: { [name: string]: RegisteredPlugin } = {}
67
68 private hooks: { [name: string]: HookInformationValue[] } = {}
69 private translations: PluginLocalesTranslations = {}
70
71 private server: Server
72
73 private constructor () {
74 }
75
76 init (server: Server) {
77 this.server = server
78 }
79
80 registerWebSocketRouter () {
81 this.server.on('upgrade', (request, socket, head) => {
82 // Check if it's a plugin websocket connection
83 // No need to destroy the stream when we abort the request
84 // Other handlers in PeerTube will catch this upgrade event too (socket.io, tracker etc)
85
86 const url = request.url
87
88 const matched = url.match(`/plugins/([^/]+)/([^/]+/)?ws(/.*)`)
89 if (!matched) return
90
91 const npmName = PluginModel.buildNpmName(matched[1], PluginType.PLUGIN)
92 const subRoute = matched[3]
93
94 const result = this.getRegisteredPluginOrTheme(npmName)
95 if (!result) return
96
97 const routes = result.registerHelpers.getWebSocketRoutes()
98
99 const wss = routes.find(r => r.route.startsWith(subRoute))
100 if (!wss) return
101
102 try {
103 wss.handler(request, socket, head)
104 } catch (err) {
105 logger.error('Exception in plugin handler ' + npmName, { err })
106 }
107 })
108 }
109
110 // ###################### Getters ######################
111
112 isRegistered (npmName: string) {
113 return !!this.getRegisteredPluginOrTheme(npmName)
114 }
115
116 getRegisteredPluginOrTheme (npmName: string) {
117 return this.registeredPlugins[npmName]
118 }
119
120 getRegisteredPluginByShortName (name: string) {
121 const npmName = PluginModel.buildNpmName(name, PluginType.PLUGIN)
122 const registered = this.getRegisteredPluginOrTheme(npmName)
123
124 if (!registered || registered.type !== PluginType.PLUGIN) return undefined
125
126 return registered
127 }
128
129 getRegisteredThemeByShortName (name: string) {
130 const npmName = PluginModel.buildNpmName(name, PluginType.THEME)
131 const registered = this.getRegisteredPluginOrTheme(npmName)
132
133 if (!registered || registered.type !== PluginType.THEME) return undefined
134
135 return registered
136 }
137
138 getRegisteredPlugins () {
139 return this.getRegisteredPluginsOrThemes(PluginType.PLUGIN)
140 }
141
142 getRegisteredThemes () {
143 return this.getRegisteredPluginsOrThemes(PluginType.THEME)
144 }
145
146 getIdAndPassAuths () {
147 return this.getRegisteredPlugins()
148 .map(p => ({
149 npmName: p.npmName,
150 name: p.name,
151 version: p.version,
152 idAndPassAuths: p.registerHelpers.getIdAndPassAuths()
153 }))
154 .filter(v => v.idAndPassAuths.length !== 0)
155 }
156
157 getExternalAuths () {
158 return this.getRegisteredPlugins()
159 .map(p => ({
160 npmName: p.npmName,
161 name: p.name,
162 version: p.version,
163 externalAuths: p.registerHelpers.getExternalAuths()
164 }))
165 .filter(v => v.externalAuths.length !== 0)
166 }
167
168 getRegisteredSettings (npmName: string) {
169 const result = this.getRegisteredPluginOrTheme(npmName)
170 if (!result || result.type !== PluginType.PLUGIN) return []
171
172 return result.registerHelpers.getSettings()
173 }
174
175 getRouter (npmName: string) {
176 const result = this.getRegisteredPluginOrTheme(npmName)
177 if (!result || result.type !== PluginType.PLUGIN) return null
178
179 return result.registerHelpers.getRouter()
180 }
181
182 getTranslations (locale: string) {
183 return this.translations[locale] || {}
184 }
185
186 async isTokenValid (token: MOAuthTokenUser, type: 'access' | 'refresh') {
187 const auth = this.getAuth(token.User.pluginAuth, token.authName)
188 if (!auth) return true
189
190 if (auth.hookTokenValidity) {
191 try {
192 const { valid } = await auth.hookTokenValidity({ token, type })
193
194 if (valid === false) {
195 logger.info('Rejecting %s token validity from auth %s of plugin %s', type, token.authName, token.User.pluginAuth)
196 }
197
198 return valid
199 } catch (err) {
200 logger.warn('Cannot run check token validity from auth %s of plugin %s.', token.authName, token.User.pluginAuth, { err })
201 return true
202 }
203 }
204
205 return true
206 }
207
208 // ###################### External events ######################
209
210 async onLogout (npmName: string, authName: string, user: MUser, req: express.Request) {
211 const auth = this.getAuth(npmName, authName)
212
213 if (auth?.onLogout) {
214 logger.info('Running onLogout function from auth %s of plugin %s', authName, npmName)
215
216 try {
217 // Force await, in case or onLogout returns a promise
218 const result = await auth.onLogout(user, req)
219
220 return typeof result === 'string'
221 ? result
222 : undefined
223 } catch (err) {
224 logger.warn('Cannot run onLogout function from auth %s of plugin %s.', authName, npmName, { err })
225 }
226 }
227
228 return undefined
229 }
230
231 async onSettingsChanged (name: string, settings: any) {
232 const registered = this.getRegisteredPluginByShortName(name)
233 if (!registered) {
234 logger.error('Cannot find plugin %s to call on settings changed.', name)
235 }
236
237 for (const cb of registered.registerHelpers.getOnSettingsChangedCallbacks()) {
238 try {
239 await cb(settings)
240 } catch (err) {
241 logger.error('Cannot run on settings changed callback for %s.', registered.npmName, { err })
242 }
243 }
244 }
245
246 // ###################### Hooks ######################
247
248 async runHook<T> (hookName: ServerHookName, result?: T, params?: any): Promise<T> {
249 if (!this.hooks[hookName]) return Promise.resolve(result)
250
251 const hookType = getHookType(hookName)
252
253 for (const hook of this.hooks[hookName]) {
254 logger.debug('Running hook %s of plugin %s.', hookName, hook.npmName)
255
256 result = await internalRunHook({
257 handler: hook.handler,
258 hookType,
259 result,
260 params,
261 onError: err => { logger.error('Cannot run hook %s of plugin %s.', hookName, hook.pluginName, { err }) }
262 })
263 }
264
265 return result
266 }
267
268 // ###################### Registration ######################
269
270 async registerPluginsAndThemes () {
271 await this.resetCSSGlobalFile()
272
273 const plugins = await PluginModel.listEnabledPluginsAndThemes()
274
275 for (const plugin of plugins) {
276 try {
277 await this.registerPluginOrTheme(plugin)
278 } catch (err) {
279 // Try to unregister the plugin
280 try {
281 await this.unregister(PluginModel.buildNpmName(plugin.name, plugin.type))
282 } catch {
283 // we don't care if we cannot unregister it
284 }
285
286 logger.error('Cannot register plugin %s, skipping.', plugin.name, { err })
287 }
288 }
289
290 this.sortHooksByPriority()
291 }
292
293 // Don't need the plugin type since themes cannot register server code
294 async unregister (npmName: string) {
295 logger.info('Unregister plugin %s.', npmName)
296
297 const plugin = this.getRegisteredPluginOrTheme(npmName)
298
299 if (!plugin) {
300 throw new Error(`Unknown plugin ${npmName} to unregister`)
301 }
302
303 delete this.registeredPlugins[plugin.npmName]
304
305 this.deleteTranslations(plugin.npmName)
306
307 if (plugin.type === PluginType.PLUGIN) {
308 await plugin.unregister()
309
310 // Remove hooks of this plugin
311 for (const key of Object.keys(this.hooks)) {
312 this.hooks[key] = this.hooks[key].filter(h => h.npmName !== npmName)
313 }
314
315 const store = plugin.registerHelpers
316 store.reinitVideoConstants(plugin.npmName)
317 store.reinitTranscodingProfilesAndEncoders(plugin.npmName)
318
319 logger.info('Regenerating registered plugin CSS to global file.')
320 await this.regeneratePluginGlobalCSS()
321 }
322
323 ClientHtml.invalidCache()
324 }
325
326 // ###################### Installation ######################
327
328 async install (options: {
329 toInstall: string
330 version?: string
331 fromDisk?: boolean // default false
332 register?: boolean // default true
333 }) {
334 const { toInstall, version, fromDisk = false, register = true } = options
335
336 let plugin: PluginModel
337 let npmName: string
338
339 logger.info('Installing plugin %s.', toInstall)
340
341 try {
342 fromDisk
343 ? await installNpmPluginFromDisk(toInstall)
344 : await installNpmPlugin(toInstall, version)
345
346 npmName = fromDisk ? basename(toInstall) : toInstall
347 const pluginType = PluginModel.getTypeFromNpmName(npmName)
348 const pluginName = PluginModel.normalizePluginName(npmName)
349
350 const packageJSON = await this.getPackageJSON(pluginName, pluginType)
351
352 this.sanitizeAndCheckPackageJSONOrThrow(packageJSON, pluginType);
353
354 [ plugin ] = await PluginModel.upsert({
355 name: pluginName,
356 description: packageJSON.description,
357 homepage: packageJSON.homepage,
358 type: pluginType,
359 version: packageJSON.version,
360 enabled: true,
361 uninstalled: false,
362 peertubeEngine: packageJSON.engine.peertube
363 }, { returning: true })
364
365 logger.info('Successful installation of plugin %s.', toInstall)
366
367 if (register) {
368 await this.registerPluginOrTheme(plugin)
369 }
370 } catch (rootErr) {
371 logger.error('Cannot install plugin %s, removing it...', toInstall, { err: rootErr })
372
373 if (npmName) {
374 try {
375 await this.uninstall({ npmName })
376 } catch (err) {
377 logger.error('Cannot uninstall plugin %s after failed installation.', toInstall, { err })
378
379 try {
380 await removeNpmPlugin(npmName)
381 } catch (err) {
382 logger.error('Cannot remove plugin %s after failed installation.', toInstall, { err })
383 }
384 }
385 }
386
387 throw rootErr
388 }
389
390 return plugin
391 }
392
393 async update (toUpdate: string, fromDisk = false) {
394 const npmName = fromDisk ? basename(toUpdate) : toUpdate
395
396 logger.info('Updating plugin %s.', npmName)
397
398 // Use the latest version from DB, to not upgrade to a version that does not support our PeerTube version
399 let version: string
400 if (!fromDisk) {
401 const plugin = await PluginModel.loadByNpmName(toUpdate)
402 version = plugin.latestVersion
403 }
404
405 // Unregister old hooks
406 await this.unregister(npmName)
407
408 return this.install({ toInstall: toUpdate, version, fromDisk })
409 }
410
411 async uninstall (options: {
412 npmName: string
413 unregister?: boolean // default true
414 }) {
415 const { npmName, unregister = true } = options
416
417 logger.info('Uninstalling plugin %s.', npmName)
418
419 if (unregister) {
420 try {
421 await this.unregister(npmName)
422 } catch (err) {
423 logger.warn('Cannot unregister plugin %s.', npmName, { err })
424 }
425 }
426
427 const plugin = await PluginModel.loadByNpmName(npmName)
428 if (!plugin || plugin.uninstalled === true) {
429 logger.error('Cannot uninstall plugin %s: it does not exist or is already uninstalled.', npmName)
430 return
431 }
432
433 plugin.enabled = false
434 plugin.uninstalled = true
435
436 await plugin.save()
437
438 await removeNpmPlugin(npmName)
439
440 logger.info('Plugin %s uninstalled.', npmName)
441 }
442
443 async rebuildNativePluginsIfNeeded () {
444 if (!await ApplicationModel.nodeABIChanged()) return
445
446 return rebuildNativePlugins()
447 }
448
449 // ###################### Private register ######################
450
451 private async registerPluginOrTheme (plugin: PluginModel) {
452 const npmName = PluginModel.buildNpmName(plugin.name, plugin.type)
453
454 logger.info('Registering plugin or theme %s.', npmName)
455
456 const packageJSON = await this.getPackageJSON(plugin.name, plugin.type)
457 const pluginPath = this.getPluginPath(plugin.name, plugin.type)
458
459 this.sanitizeAndCheckPackageJSONOrThrow(packageJSON, plugin.type)
460
461 let library: PluginLibrary
462 let registerHelpers: RegisterHelpers
463 if (plugin.type === PluginType.PLUGIN) {
464 const result = await this.registerPlugin(plugin, pluginPath, packageJSON)
465 library = result.library
466 registerHelpers = result.registerStore
467 }
468
469 const clientScripts: { [id: string]: ClientScriptJSON } = {}
470 for (const c of packageJSON.clientScripts) {
471 clientScripts[c.script] = c
472 }
473
474 this.registeredPlugins[npmName] = {
475 npmName,
476 name: plugin.name,
477 type: plugin.type,
478 version: plugin.version,
479 description: plugin.description,
480 peertubeEngine: plugin.peertubeEngine,
481 path: pluginPath,
482 staticDirs: packageJSON.staticDirs,
483 clientScripts,
484 css: packageJSON.css,
485 registerHelpers: registerHelpers || undefined,
486 unregister: library ? library.unregister : undefined
487 }
488
489 await this.addTranslations(plugin, npmName, packageJSON.translations)
490
491 ClientHtml.invalidCache()
492 }
493
494 private async registerPlugin (plugin: PluginModel, pluginPath: string, packageJSON: PluginPackageJSON) {
495 const npmName = PluginModel.buildNpmName(plugin.name, plugin.type)
496
497 // Delete cache if needed
498 const modulePath = join(pluginPath, packageJSON.library)
499 decachePlugin(modulePath)
500 const library: PluginLibrary = require(modulePath)
501
502 if (!isLibraryCodeValid(library)) {
503 throw new Error('Library code is not valid (miss register or unregister function)')
504 }
505
506 const { registerOptions, registerStore } = this.getRegisterHelpers(npmName, plugin)
507
508 await ensureDir(registerOptions.peertubeHelpers.plugin.getDataDirectoryPath())
509
510 await library.register(registerOptions)
511
512 logger.info('Add plugin %s CSS to global file.', npmName)
513
514 await this.addCSSToGlobalFile(pluginPath, packageJSON.css)
515
516 return { library, registerStore }
517 }
518
519 // ###################### Translations ######################
520
521 private async addTranslations (plugin: PluginModel, npmName: string, translationPaths: PluginTranslationPathsJSON) {
522 for (const locale of Object.keys(translationPaths)) {
523 const path = translationPaths[locale]
524 const json = await readJSON(join(this.getPluginPath(plugin.name, plugin.type), path))
525
526 const completeLocale = getCompleteLocale(locale)
527
528 if (!this.translations[completeLocale]) this.translations[completeLocale] = {}
529 this.translations[completeLocale][npmName] = json
530
531 logger.info('Added locale %s of plugin %s.', completeLocale, npmName)
532 }
533 }
534
535 private deleteTranslations (npmName: string) {
536 for (const locale of Object.keys(this.translations)) {
537 delete this.translations[locale][npmName]
538
539 logger.info('Deleted locale %s of plugin %s.', locale, npmName)
540 }
541 }
542
543 // ###################### CSS ######################
544
545 private resetCSSGlobalFile () {
546 return outputFile(PLUGIN_GLOBAL_CSS_PATH, '')
547 }
548
549 private async addCSSToGlobalFile (pluginPath: string, cssRelativePaths: string[]) {
550 for (const cssPath of cssRelativePaths) {
551 await this.concatFiles(join(pluginPath, cssPath), PLUGIN_GLOBAL_CSS_PATH)
552 }
553 }
554
555 private concatFiles (input: string, output: string) {
556 return new Promise<void>((res, rej) => {
557 const inputStream = createReadStream(input)
558 const outputStream = createWriteStream(output, { flags: 'a' })
559
560 inputStream.pipe(outputStream)
561
562 inputStream.on('end', () => res())
563 inputStream.on('error', err => rej(err))
564 })
565 }
566
567 private async regeneratePluginGlobalCSS () {
568 await this.resetCSSGlobalFile()
569
570 for (const plugin of this.getRegisteredPlugins()) {
571 await this.addCSSToGlobalFile(plugin.path, plugin.css)
572 }
573 }
574
575 // ###################### Utils ######################
576
577 private sortHooksByPriority () {
578 for (const hookName of Object.keys(this.hooks)) {
579 this.hooks[hookName].sort((a, b) => {
580 return b.priority - a.priority
581 })
582 }
583 }
584
585 private getPackageJSON (pluginName: string, pluginType: PluginType) {
586 const pluginPath = join(this.getPluginPath(pluginName, pluginType), 'package.json')
587
588 return readJSON(pluginPath) as Promise<PluginPackageJSON>
589 }
590
591 private getPluginPath (pluginName: string, pluginType: PluginType) {
592 const npmName = PluginModel.buildNpmName(pluginName, pluginType)
593
594 return join(CONFIG.STORAGE.PLUGINS_DIR, 'node_modules', npmName)
595 }
596
597 private getAuth (npmName: string, authName: string) {
598 const plugin = this.getRegisteredPluginOrTheme(npmName)
599 if (!plugin || plugin.type !== PluginType.PLUGIN) return null
600
601 let auths: (RegisterServerAuthPassOptions | RegisterServerAuthExternalOptions)[] = plugin.registerHelpers.getIdAndPassAuths()
602 auths = auths.concat(plugin.registerHelpers.getExternalAuths())
603
604 return auths.find(a => a.authName === authName)
605 }
606
607 // ###################### Private getters ######################
608
609 private getRegisteredPluginsOrThemes (type: PluginType) {
610 const plugins: RegisteredPlugin[] = []
611
612 for (const npmName of Object.keys(this.registeredPlugins)) {
613 const plugin = this.registeredPlugins[npmName]
614 if (plugin.type !== type) continue
615
616 plugins.push(plugin)
617 }
618
619 return plugins
620 }
621
622 // ###################### Generate register helpers ######################
623
624 private getRegisterHelpers (
625 npmName: string,
626 plugin: PluginModel
627 ): { registerStore: RegisterHelpers, registerOptions: RegisterServerOptions } {
628 const onHookAdded = (options: RegisterServerHookOptions) => {
629 if (!this.hooks[options.target]) this.hooks[options.target] = []
630
631 this.hooks[options.target].push({
632 npmName,
633 pluginName: plugin.name,
634 handler: options.handler,
635 priority: options.priority || 0
636 })
637 }
638
639 const registerHelpers = new RegisterHelpers(npmName, plugin, this.server, onHookAdded.bind(this))
640
641 return {
642 registerStore: registerHelpers,
643 registerOptions: registerHelpers.buildRegisterHelpers()
644 }
645 }
646
647 private sanitizeAndCheckPackageJSONOrThrow (packageJSON: PluginPackageJSON, pluginType: PluginType) {
648 if (!packageJSON.staticDirs) packageJSON.staticDirs = {}
649 if (!packageJSON.css) packageJSON.css = []
650 if (!packageJSON.clientScripts) packageJSON.clientScripts = []
651 if (!packageJSON.translations) packageJSON.translations = {}
652
653 const { result: packageJSONValid, badFields } = isPackageJSONValid(packageJSON, pluginType)
654 if (!packageJSONValid) {
655 const formattedFields = badFields.map(f => `"${f}"`)
656 .join(', ')
657
658 throw new Error(`PackageJSON is invalid (invalid fields: ${formattedFields}).`)
659 }
660 }
661
662 static get Instance () {
663 return this.instance || (this.instance = new this())
664 }
665}
generated by cgit v1.2.3 (git 2.25.1) at 2025-04-15 19:47:29 +0000