]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blob - server/lib/plugins/plugin-manager.ts
f7b84b1ff1b7013d5e89651e5107bc69ba8f059d
[github/Chocobozzz/PeerTube.git] / server / lib / plugins / plugin-manager.ts
1 import { PluginModel } from '../../models/server/plugin'
2 import { logger } from '../../helpers/logger'
3 import { basename, join } from 'path'
4 import { CONFIG } from '../../initializers/config'
5 import { isLibraryCodeValid, isPackageJSONValid } from '../../helpers/custom-validators/plugins'
6 import {
7 ClientScript,
8 PluginPackageJson,
9 PluginTranslationPaths as PackagePluginTranslations
10 } from '../../../shared/models/plugins/plugin-package-json.model'
11 import { createReadStream, createWriteStream } from 'fs'
12 import { PLUGIN_GLOBAL_CSS_PATH } from '../../initializers/constants'
13 import { PluginType } from '../../../shared/models/plugins/plugin.type'
14 import { installNpmPlugin, installNpmPluginFromDisk, removeNpmPlugin } from './yarn'
15 import { outputFile, readJSON } from 'fs-extra'
16 import { ServerHook, ServerHookName } from '../../../shared/models/plugins/server-hook.model'
17 import { getHookType, internalRunHook } from '../../../shared/core-utils/plugins/hooks'
18 import { RegisterServerOptions } from '../../typings/plugins/register-server-option.model'
19 import { PluginLibrary } from '../../typings/plugins'
20 import { ClientHtml } from '../client-html'
21 import { PluginTranslation } from '../../../shared/models/plugins/plugin-translation.model'
22 import { RegisterHelpersStore } from './register-helpers-store'
23 import { RegisterServerHookOptions } from '@shared/models/plugins/register-server-hook.model'
24 import { MOAuthTokenUser, MUser } from '@server/typings/models'
25 import { RegisterServerAuthPassOptions, RegisterServerAuthExternalOptions } from '@shared/models/plugins/register-server-auth.model'
26
27 export interface RegisteredPlugin {
28 npmName: string
29 name: string
30 version: string
31 description: string
32 peertubeEngine: string
33
34 type: PluginType
35
36 path: string
37
38 staticDirs: { [name: string]: string }
39 clientScripts: { [name: string]: ClientScript }
40
41 css: string[]
42
43 // Only if this is a plugin
44 registerHelpersStore?: RegisterHelpersStore
45 unregister?: Function
46 }
47
48 export interface HookInformationValue {
49 npmName: string
50 pluginName: string
51 handler: Function
52 priority: number
53 }
54
55 type PluginLocalesTranslations = {
56 [locale: string]: PluginTranslation
57 }
58
59 export class PluginManager implements ServerHook {
60
61 private static instance: PluginManager
62
63 private registeredPlugins: { [name: string]: RegisteredPlugin } = {}
64
65 private hooks: { [name: string]: HookInformationValue[] } = {}
66 private translations: PluginLocalesTranslations = {}
67
68 private constructor () {
69 }
70
71 // ###################### Getters ######################
72
73 isRegistered (npmName: string) {
74 return !!this.getRegisteredPluginOrTheme(npmName)
75 }
76
77 getRegisteredPluginOrTheme (npmName: string) {
78 return this.registeredPlugins[npmName]
79 }
80
81 getRegisteredPluginByShortName (name: string) {
82 const npmName = PluginModel.buildNpmName(name, PluginType.PLUGIN)
83 const registered = this.getRegisteredPluginOrTheme(npmName)
84
85 if (!registered || registered.type !== PluginType.PLUGIN) return undefined
86
87 return registered
88 }
89
90 getRegisteredThemeByShortName (name: string) {
91 const npmName = PluginModel.buildNpmName(name, PluginType.THEME)
92 const registered = this.getRegisteredPluginOrTheme(npmName)
93
94 if (!registered || registered.type !== PluginType.THEME) return undefined
95
96 return registered
97 }
98
99 getRegisteredPlugins () {
100 return this.getRegisteredPluginsOrThemes(PluginType.PLUGIN)
101 }
102
103 getRegisteredThemes () {
104 return this.getRegisteredPluginsOrThemes(PluginType.THEME)
105 }
106
107 getIdAndPassAuths () {
108 return this.getRegisteredPlugins()
109 .map(p => ({
110 npmName: p.npmName,
111 name: p.name,
112 version: p.version,
113 idAndPassAuths: p.registerHelpersStore.getIdAndPassAuths()
114 }))
115 .filter(v => v.idAndPassAuths.length !== 0)
116 }
117
118 getExternalAuths () {
119 return this.getRegisteredPlugins()
120 .map(p => ({
121 npmName: p.npmName,
122 name: p.name,
123 version: p.version,
124 externalAuths: p.registerHelpersStore.getExternalAuths()
125 }))
126 .filter(v => v.externalAuths.length !== 0)
127 }
128
129 getRegisteredSettings (npmName: string) {
130 const result = this.getRegisteredPluginOrTheme(npmName)
131 if (!result || result.type !== PluginType.PLUGIN) return []
132
133 return result.registerHelpersStore.getSettings()
134 }
135
136 getRouter (npmName: string) {
137 const result = this.getRegisteredPluginOrTheme(npmName)
138 if (!result || result.type !== PluginType.PLUGIN) return null
139
140 return result.registerHelpersStore.getRouter()
141 }
142
143 getTranslations (locale: string) {
144 return this.translations[locale] || {}
145 }
146
147 onLogout (npmName: string, authName: string, user: MUser) {
148 const auth = this.getAuth(npmName, authName)
149
150 if (auth?.onLogout) {
151 logger.info('Running onLogout function from auth %s of plugin %s', authName, npmName)
152
153 try {
154 auth.onLogout(user)
155 } catch (err) {
156 logger.warn('Cannot run onLogout function from auth %s of plugin %s.', authName, npmName, { err })
157 }
158 }
159 }
160
161 async isTokenValid (token: MOAuthTokenUser, type: 'access' | 'refresh') {
162 const auth = this.getAuth(token.User.pluginAuth, token.authName)
163 if (!auth) return true
164
165 if (auth.hookTokenValidity) {
166 try {
167 const { valid } = await auth.hookTokenValidity({ token, type })
168
169 if (valid === false) {
170 logger.info('Rejecting %s token validity from auth %s of plugin %s', type, token.authName, token.User.pluginAuth)
171 }
172
173 return valid
174 } catch (err) {
175 logger.warn('Cannot run check token validity from auth %s of plugin %s.', token.authName, token.User.pluginAuth, { err })
176 return true
177 }
178 }
179
180 return true
181 }
182
183 // ###################### Hooks ######################
184
185 async runHook<T> (hookName: ServerHookName, result?: T, params?: any): Promise<T> {
186 if (!this.hooks[hookName]) return Promise.resolve(result)
187
188 const hookType = getHookType(hookName)
189
190 for (const hook of this.hooks[hookName]) {
191 logger.debug('Running hook %s of plugin %s.', hookName, hook.npmName)
192
193 result = await internalRunHook(hook.handler, hookType, result, params, err => {
194 logger.error('Cannot run hook %s of plugin %s.', hookName, hook.pluginName, { err })
195 })
196 }
197
198 return result
199 }
200
201 // ###################### Registration ######################
202
203 async registerPluginsAndThemes () {
204 await this.resetCSSGlobalFile()
205
206 const plugins = await PluginModel.listEnabledPluginsAndThemes()
207
208 for (const plugin of plugins) {
209 try {
210 await this.registerPluginOrTheme(plugin)
211 } catch (err) {
212 // Try to unregister the plugin
213 try {
214 await this.unregister(PluginModel.buildNpmName(plugin.name, plugin.type))
215 } catch {
216 // we don't care if we cannot unregister it
217 }
218
219 logger.error('Cannot register plugin %s, skipping.', plugin.name, { err })
220 }
221 }
222
223 this.sortHooksByPriority()
224 }
225
226 // Don't need the plugin type since themes cannot register server code
227 async unregister (npmName: string) {
228 logger.info('Unregister plugin %s.', npmName)
229
230 const plugin = this.getRegisteredPluginOrTheme(npmName)
231
232 if (!plugin) {
233 throw new Error(`Unknown plugin ${npmName} to unregister`)
234 }
235
236 delete this.registeredPlugins[plugin.npmName]
237
238 this.deleteTranslations(plugin.npmName)
239
240 if (plugin.type === PluginType.PLUGIN) {
241 await plugin.unregister()
242
243 // Remove hooks of this plugin
244 for (const key of Object.keys(this.hooks)) {
245 this.hooks[key] = this.hooks[key].filter(h => h.npmName !== npmName)
246 }
247
248 const store = plugin.registerHelpersStore
249 store.reinitVideoConstants(plugin.npmName)
250
251 logger.info('Regenerating registered plugin CSS to global file.')
252 await this.regeneratePluginGlobalCSS()
253 }
254 }
255
256 // ###################### Installation ######################
257
258 async install (toInstall: string, version?: string, fromDisk = false) {
259 let plugin: PluginModel
260 let npmName: string
261
262 logger.info('Installing plugin %s.', toInstall)
263
264 try {
265 fromDisk
266 ? await installNpmPluginFromDisk(toInstall)
267 : await installNpmPlugin(toInstall, version)
268
269 npmName = fromDisk ? basename(toInstall) : toInstall
270 const pluginType = PluginModel.getTypeFromNpmName(npmName)
271 const pluginName = PluginModel.normalizePluginName(npmName)
272
273 const packageJSON = await this.getPackageJSON(pluginName, pluginType)
274
275 this.sanitizeAndCheckPackageJSONOrThrow(packageJSON, pluginType);
276
277 [ plugin ] = await PluginModel.upsert({
278 name: pluginName,
279 description: packageJSON.description,
280 homepage: packageJSON.homepage,
281 type: pluginType,
282 version: packageJSON.version,
283 enabled: true,
284 uninstalled: false,
285 peertubeEngine: packageJSON.engine.peertube
286 }, { returning: true })
287 } catch (err) {
288 logger.error('Cannot install plugin %s, removing it...', toInstall, { err })
289
290 try {
291 await removeNpmPlugin(npmName)
292 } catch (err) {
293 logger.error('Cannot remove plugin %s after failed installation.', toInstall, { err })
294 }
295
296 throw err
297 }
298
299 logger.info('Successful installation of plugin %s.', toInstall)
300
301 await this.registerPluginOrTheme(plugin)
302
303 return plugin
304 }
305
306 async update (toUpdate: string, version?: string, fromDisk = false) {
307 const npmName = fromDisk ? basename(toUpdate) : toUpdate
308
309 logger.info('Updating plugin %s.', npmName)
310
311 // Unregister old hooks
312 await this.unregister(npmName)
313
314 return this.install(toUpdate, version, fromDisk)
315 }
316
317 async uninstall (npmName: string) {
318 logger.info('Uninstalling plugin %s.', npmName)
319
320 try {
321 await this.unregister(npmName)
322 } catch (err) {
323 logger.warn('Cannot unregister plugin %s.', npmName, { err })
324 }
325
326 const plugin = await PluginModel.loadByNpmName(npmName)
327 if (!plugin || plugin.uninstalled === true) {
328 logger.error('Cannot uninstall plugin %s: it does not exist or is already uninstalled.', npmName)
329 return
330 }
331
332 plugin.enabled = false
333 plugin.uninstalled = true
334
335 await plugin.save()
336
337 await removeNpmPlugin(npmName)
338
339 logger.info('Plugin %s uninstalled.', npmName)
340 }
341
342 // ###################### Private register ######################
343
344 private async registerPluginOrTheme (plugin: PluginModel) {
345 const npmName = PluginModel.buildNpmName(plugin.name, plugin.type)
346
347 logger.info('Registering plugin or theme %s.', npmName)
348
349 const packageJSON = await this.getPackageJSON(plugin.name, plugin.type)
350 const pluginPath = this.getPluginPath(plugin.name, plugin.type)
351
352 this.sanitizeAndCheckPackageJSONOrThrow(packageJSON, plugin.type)
353
354 let library: PluginLibrary
355 let registerHelpersStore: RegisterHelpersStore
356 if (plugin.type === PluginType.PLUGIN) {
357 const result = await this.registerPlugin(plugin, pluginPath, packageJSON)
358 library = result.library
359 registerHelpersStore = result.registerStore
360 }
361
362 const clientScripts: { [id: string]: ClientScript } = {}
363 for (const c of packageJSON.clientScripts) {
364 clientScripts[c.script] = c
365 }
366
367 this.registeredPlugins[npmName] = {
368 npmName,
369 name: plugin.name,
370 type: plugin.type,
371 version: plugin.version,
372 description: plugin.description,
373 peertubeEngine: plugin.peertubeEngine,
374 path: pluginPath,
375 staticDirs: packageJSON.staticDirs,
376 clientScripts,
377 css: packageJSON.css,
378 registerHelpersStore: registerHelpersStore || undefined,
379 unregister: library ? library.unregister : undefined
380 }
381
382 await this.addTranslations(plugin, npmName, packageJSON.translations)
383 }
384
385 private async registerPlugin (plugin: PluginModel, pluginPath: string, packageJSON: PluginPackageJson) {
386 const npmName = PluginModel.buildNpmName(plugin.name, plugin.type)
387
388 // Delete cache if needed
389 const modulePath = join(pluginPath, packageJSON.library)
390 delete require.cache[modulePath]
391 const library: PluginLibrary = require(modulePath)
392
393 if (!isLibraryCodeValid(library)) {
394 throw new Error('Library code is not valid (miss register or unregister function)')
395 }
396
397 const { registerOptions, registerStore } = this.getRegisterHelpers(npmName, plugin)
398 library.register(registerOptions)
399 .catch(err => logger.error('Cannot register plugin %s.', npmName, { err }))
400
401 logger.info('Add plugin %s CSS to global file.', npmName)
402
403 await this.addCSSToGlobalFile(pluginPath, packageJSON.css)
404
405 return { library, registerStore }
406 }
407
408 // ###################### Translations ######################
409
410 private async addTranslations (plugin: PluginModel, npmName: string, translationPaths: PackagePluginTranslations) {
411 for (const locale of Object.keys(translationPaths)) {
412 const path = translationPaths[locale]
413 const json = await readJSON(join(this.getPluginPath(plugin.name, plugin.type), path))
414
415 if (!this.translations[locale]) this.translations[locale] = {}
416 this.translations[locale][npmName] = json
417
418 logger.info('Added locale %s of plugin %s.', locale, npmName)
419 }
420 }
421
422 private deleteTranslations (npmName: string) {
423 for (const locale of Object.keys(this.translations)) {
424 delete this.translations[locale][npmName]
425
426 logger.info('Deleted locale %s of plugin %s.', locale, npmName)
427 }
428 }
429
430 // ###################### CSS ######################
431
432 private resetCSSGlobalFile () {
433 ClientHtml.invalidCache()
434
435 return outputFile(PLUGIN_GLOBAL_CSS_PATH, '')
436 }
437
438 private async addCSSToGlobalFile (pluginPath: string, cssRelativePaths: string[]) {
439 for (const cssPath of cssRelativePaths) {
440 await this.concatFiles(join(pluginPath, cssPath), PLUGIN_GLOBAL_CSS_PATH)
441 }
442
443 ClientHtml.invalidCache()
444 }
445
446 private concatFiles (input: string, output: string) {
447 return new Promise<void>((res, rej) => {
448 const inputStream = createReadStream(input)
449 const outputStream = createWriteStream(output, { flags: 'a' })
450
451 inputStream.pipe(outputStream)
452
453 inputStream.on('end', () => res())
454 inputStream.on('error', err => rej(err))
455 })
456 }
457
458 private async regeneratePluginGlobalCSS () {
459 await this.resetCSSGlobalFile()
460
461 for (const plugin of this.getRegisteredPlugins()) {
462 await this.addCSSToGlobalFile(plugin.path, plugin.css)
463 }
464 }
465
466 // ###################### Utils ######################
467
468 private sortHooksByPriority () {
469 for (const hookName of Object.keys(this.hooks)) {
470 this.hooks[hookName].sort((a, b) => {
471 return b.priority - a.priority
472 })
473 }
474 }
475
476 private getPackageJSON (pluginName: string, pluginType: PluginType) {
477 const pluginPath = join(this.getPluginPath(pluginName, pluginType), 'package.json')
478
479 return readJSON(pluginPath) as Promise<PluginPackageJson>
480 }
481
482 private getPluginPath (pluginName: string, pluginType: PluginType) {
483 const npmName = PluginModel.buildNpmName(pluginName, pluginType)
484
485 return join(CONFIG.STORAGE.PLUGINS_DIR, 'node_modules', npmName)
486 }
487
488 private getAuth (npmName: string, authName: string) {
489 const plugin = this.getRegisteredPluginOrTheme(npmName)
490 if (!plugin || plugin.type !== PluginType.PLUGIN) return null
491
492 let auths: (RegisterServerAuthPassOptions | RegisterServerAuthExternalOptions)[] = plugin.registerHelpersStore.getIdAndPassAuths()
493 auths = auths.concat(plugin.registerHelpersStore.getExternalAuths())
494
495 return auths.find(a => a.authName === authName)
496 }
497
498 // ###################### Private getters ######################
499
500 private getRegisteredPluginsOrThemes (type: PluginType) {
501 const plugins: RegisteredPlugin[] = []
502
503 for (const npmName of Object.keys(this.registeredPlugins)) {
504 const plugin = this.registeredPlugins[npmName]
505 if (plugin.type !== type) continue
506
507 plugins.push(plugin)
508 }
509
510 return plugins
511 }
512
513 // ###################### Generate register helpers ######################
514
515 private getRegisterHelpers (
516 npmName: string,
517 plugin: PluginModel
518 ): { registerStore: RegisterHelpersStore, registerOptions: RegisterServerOptions } {
519 const onHookAdded = (options: RegisterServerHookOptions) => {
520 if (!this.hooks[options.target]) this.hooks[options.target] = []
521
522 this.hooks[options.target].push({
523 npmName: npmName,
524 pluginName: plugin.name,
525 handler: options.handler,
526 priority: options.priority || 0
527 })
528 }
529
530 const registerHelpersStore = new RegisterHelpersStore(npmName, plugin, onHookAdded.bind(this))
531
532 return {
533 registerStore: registerHelpersStore,
534 registerOptions: registerHelpersStore.buildRegisterHelpers()
535 }
536 }
537
538 private sanitizeAndCheckPackageJSONOrThrow (packageJSON: PluginPackageJson, pluginType: PluginType) {
539 if (!packageJSON.staticDirs) packageJSON.staticDirs = {}
540 if (!packageJSON.css) packageJSON.css = []
541 if (!packageJSON.clientScripts) packageJSON.clientScripts = []
542 if (!packageJSON.translations) packageJSON.translations = {}
543
544 const { result: packageJSONValid, badFields } = isPackageJSONValid(packageJSON, pluginType)
545 if (!packageJSONValid) {
546 const formattedFields = badFields.map(f => `"${f}"`)
547 .join(', ')
548
549 throw new Error(`PackageJSON is invalid (invalid fields: ${formattedFields}).`)
550 }
551 }
552
553 static get Instance () {
554 return this.instance || (this.instance = new this())
555 }
556 }